Jon Chery
85963dc320
REQ-043: install.sh pulls release binary from public Gitea URL. User-level default (~/.local/bin/orca), --system for system-level (/usr/local/bin/orca). Defaults to latest release; --version pins. Env-overridable GITEA_URL/OWNER/REPO for testability. REQ-044: in-place update detects existing binary, reads version via 'orca version --json', prints update message, overwrites binary, preserves namespace dir (config/db/certs). Idempotent re-install. REQ-016 (completion): README quickstart now documents the 1-liner install + --system variant + update-in-place pattern. Tests: 8/8 pass in scripts/install_test.sh (real public Gitea releases, no mock server; timeout-guarded to prevent hangs). Docs: docs/install.md covers user/system install, version pinning, in-place update, uninstall, troubleshooting. ---ci--- project: orca phase: 2 milestone: v0.5 status: verify ---/ci---
87 lines
2.6 KiB
Markdown
87 lines
2.6 KiB
Markdown
# Orca
|
|
|
|
Offline/CLI-first orchestration engine inspired by HashiCorp Nomad, far simpler than Kubernetes.
|
|
|
|
## Status
|
|
|
|
**v0.1: Foundation** — see [.ciagent/ROADMAP.md](.ciagent/ROADMAP.md) for the 6-phase plan.
|
|
|
|
## Pillars
|
|
|
|
- **Simplicity** — single binary, minimal dependencies
|
|
- **AI-first** — CLI designed for both humans and AI agents
|
|
- **Offline-first** — no cloud dependencies
|
|
- **CLI-first** — primary interface is the command line
|
|
- **Security before features** — NFRs ship before new functionality
|
|
- **Bug fixes before features** — stability is paramount
|
|
- **NFRs before features** — observability and auditability first
|
|
|
|
## Quickstart
|
|
|
|
### Install (1-liner)
|
|
|
|
```bash
|
|
# User-level install (binary at ~/.local/bin/orca, state at ~/.orca)
|
|
curl -fsSL https://git.cloudinit.dev/coreci/orca/raw/branch/main/scripts/install.sh | bash
|
|
|
|
# System-level install (binary at /usr/local/bin/orca, state at /root/.orca)
|
|
curl -fsSL https://git.cloudinit.dev/coreci/orca/raw/branch/main/scripts/install.sh | sudo bash -s -- --system
|
|
|
|
# Pin a specific version
|
|
curl -fsSL https://git.cloudinit.dev/coreci/orca/raw/branch/main/scripts/install.sh | bash -s -- --version v0.4.2
|
|
```
|
|
|
|
Then initialize local state and verify:
|
|
|
|
```bash
|
|
orca init # creates ~/.orca/ (or /root/.orca with --system)
|
|
orca version # prints version info
|
|
orca --help # show all subcommands
|
|
```
|
|
|
|
### Build from source
|
|
|
|
```bash
|
|
make build # Build binary to ./bin/orca
|
|
./bin/orca init # Initialize local state
|
|
./bin/orca version # Verify
|
|
```
|
|
|
|
### Update in place
|
|
|
|
Re-running the installer updates the binary while preserving your
|
|
config, database, and certificates in the namespace dir:
|
|
|
|
```bash
|
|
curl -fsSL https://git.cloudinit.dev/coreci/orca/raw/branch/main/scripts/install.sh | bash
|
|
# → "updated orca from v0.4.1 to v0.4.2"
|
|
```
|
|
|
|
## Subcommands
|
|
|
|
| Command | Description | Status |
|
|
|---------|-------------|--------|
|
|
| `orca version` | Print version info | ✅ Phase 1 |
|
|
| `orca init` | Initialize local orca state | ✅ Phase 1 (stub) |
|
|
| `orca status` | Show orca daemon status | ✅ Phase 1 (stub) |
|
|
| `orca node` | Node management (`join`, `leave`, `list`) | Phase 2 |
|
|
| `orca job` | Job management (`run`, `list`, `stop`, `logs`) | Phase 3 |
|
|
|
|
## Development
|
|
|
|
```bash
|
|
make build # Build binary to ./bin/orca
|
|
make test # Run tests with race detection
|
|
make lint # Run golangci-lint
|
|
make fmt # Format code
|
|
make release # Build + create Gitea release (Phase 6)
|
|
```
|
|
|
|
## Architecture
|
|
|
|
See [.ciagent/ARCHITECTURE.md](.ciagent/ARCHITECTURE.md) for full architecture details.
|
|
|
|
## License
|
|
|
|
MIT — see [LICENSE](LICENSE).
|