Compare commits

...

5 Commits

Author SHA1 Message Date
Jon Chery 4e019ab51e verify(P02): 4-layer PASS — REQ-091, REQ-092, REQ-093; gate C-22 cleared
---ci---
project: orca
phase: 2
milestone: v0.10
status: verify
---/ci---
2026-08-05 20:57:16 +00:00
Jon Chery 289e5cf6e1 docs(P02): CLI reference + jobspec reference + ingress guide
P02 — operator-facing documentation (REQ-091, REQ-092, REQ-093; gate C-22).

docs/cli.md (REQ-091):
- Full CLI command/flag reference: every command/subcommand with synopsis,
  flag tables (name/type/default/description), one-line examples.
- Global flags (--json, --system, --config, --no-deprecation-warnings).
- Output modes (text/json/watch), env vars, exit codes.
- Deprecated surface callout boxes (daemon, cert, node-join-mTLS, HCL
  jobspec) pointing to v0.11 removal.

docs/jobspec.md (REQ-092):
- Markdown frontmatter schema reference: all top-level keys, block
  reference (runtime/ports/env-secrets/volumes/restart/update/service/
  health/lifecycle/constraints/affinity/tasks), kinds matrix
  (Job/Service/DaemonSet required vs allowed), CEL subset grammar, body
  byte-exact preservation (R-015), deprecated HCL callout.

docs/ingress.md (REQ-093):
- Traefik ingress reference: service->Traefik mapping (D-175), R-007
  socket-vs-TCP-bind semantics, generated YAML shape (routers/services/
  healthCheck), atomic reload (C-10), drain (weight:0), TLS (certResolver,
  trust domain, step-ca), worked-example pointer to examples/full-stack/,
  v0.11 forward limitations.

All factual claims grounded in live codebase (gate C-22). Cross-links
verified to resolve.

---ci---
project: orca
phase: 2
milestone: v0.10
status: execute
---/ci---
2026-08-05 20:57:05 +00:00
Jon Chery cfec794bb7 verify(P01): 4-layer PASS — REQ-097, REQ-098; gate C-21 cleared
---ci---
project: orca
phase: 1
milestone: v0.10
status: verify
---/ci---
2026-08-05 20:52:43 +00:00
Jon Chery eadd28fac0 fix(P01): release.sh cross-build amd64 + asset verification; install.sh fallback walk + --check
P01 — release/install pipeline fix (REQ-097, REQ-098; gate C-21).

release.sh (REQ-097):
- Cross-build linux-amd64 regardless of host arch (GOOS=linux GOARCH=amd64
  go build, CGO_ENABLED=0). D-193: the host-arch build produced the wrong
  tarball when cut from arm64 — root cause of the v0.8.x asset-less
  releases.
- Hardcode tarball name to orca-${VERSION}-linux-amd64.tar.gz (not
  host-arch-dependent).
- Post-create asset verification (C-21): after tea releases create, query
  the Gitea API and assert the tarball appears in attachments. Retry once
  via tea release edit if missing. Fail loudly if still missing. This
  catches the tea CLI bug where create exits 0 without attaching the asset.

install.sh (REQ-098):
- Asset fallback walk: if the resolved release (latest or --version) lacks
  the matching tarball, query /releases?limit=50, extract all
  browser_download_urls from the list response (assets are inline), find
  the newest release with a matching orca-*-linux-amd64.tar.gz asset, print
  a WARNING, and use that release. Fixes the v0.4.5 install incident where
  v0.8.15 had no asset and install.sh errored out with no fallback.
- --check dry-run mode (D-194): prints version + asset URL + install path
  + current version without writing anything.

Tests (scripts/tests/):
- install_test.bash: 5 tests (--help, --check happy path, --check fallback
  walk, unknown arg rejection, --system root check).
- release_test.bash: 5 tests (script exists, syntax valid, cross-build
  command present, amd64 tarball name hardcoded, asset verification present).

All 30 bats tests pass. make lint clean (no new warnings).

---ci---
project: orca
phase: 1
milestone: v0.10
status: execute
---/ci---
2026-08-05 20:52:25 +00:00
Jon Chery 3b6241e5c9 docs(P00): ship complete — v0.9.0 tagged, release created, phase branch deleted 2026-08-05 20:48:32 +00:00
8 changed files with 1394 additions and 26 deletions
+11 -7
View File
@@ -1,20 +1,24 @@
{
"phase": 0,
"stage": "plan",
"phase": 2,
"stage": "verify",
"milestone": "v0.10",
"milestone_slug": "docs-cli-examples",
"phase_role": "pre_execution",
"phase_role": "execution",
"attempts": 0,
"updated_at": "2026-08-05T20:00:00Z",
"updated_at": "2026-08-05T20:45:00Z",
"milestone_complete": false,
"ship": {
"tag": null,
"tag": "v0.9.1",
"merged_to_main": false,
"milestone_branch_deleted": false,
"all_phase_branches_deleted": false
"all_phase_branches_deleted": true
},
"requirements": {
"covered": [],
"covered": ["REQ-097", "REQ-098"],
"partial": []
},
"gates": {
"cleared": ["C-21"],
"pending": ["C-20", "C-22"]
}
}
+522
View File
@@ -0,0 +1,522 @@
# Orca CLI Reference
This document is the complete reference for the `orca` command-line
interface. Every command, subcommand, and flag is documented here.
> **Canonical path (v0.9)**: The v0.9 re-architecture introduced the
> SSH-push deployment model, markdown jobspec, multi-namespace layout,
> and CLI-side scheduler. Commands marked **deprecated** below are from
> the v0.8 daemon/mTLS model and will be removed in v0.11. Use the
> v0.9 canonical path for all new work.
## Global flags
These flags are available on every `orca` command.
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--json` | bool | `false` | Output in JSON format (machine-readable) |
| `--system` | bool | `false` | Use system-level namespace root (`/root/.orca`) instead of user-level (`~/.orca`). Errors if `ORCA_HOME` is already set to a conflicting value. |
| `--config` | string | `""` | Path to config file (overrides `~/.orca/config.hcl`). Supports `.hcl` (legacy) and `.md` (v0.9 canonical) formats. |
| `--no-deprecation-warnings` | bool | `false` | Suppress v0.9 deprecation warnings. Use during `orca upgrade` migrations. |
### Output modes
- **Text** (default): human-readable tables and messages.
- **JSON** (`--json`): structured JSON output for machine consumption
and AI agents.
- **Watch** (`--watch` on list commands): table refresh (text default)
or NDJSON streaming (`--json`), one line per event until Ctrl-C.
### Environment variables
| Variable | Description |
|----------|-------------|
| `ORCA_HOME` | Namespace root directory (default `~/.orca`). Overrides all on-disk paths. |
| `ORCA_DB` | Fine-grained database path override. |
| `ORCA_PROXMOX_PASSWORD` | SSH password for `orca node join --type proxmox` (never persisted). |
| `ORCA_LISTEN_ADDR` | Daemon listen address (deprecated). |
| `ORCA_CA_PATH` | CA certificate path override. |
| `ORCA_SERVER_CERT_PATH` | Server certificate path override. |
| `ORCA_SERVER_KEY_PATH` | Server key path override. |
| `ORCA_NODE_CPU` | Node CPU capacity override (millicores). |
| `ORCA_NODE_MEMORY_MB` | Node memory capacity override (MiB). |
### Exit codes
| Code | Meaning |
|------|---------|
| `0` | Success |
| `1` | Error (printed to stderr) |
---
## `orca init`
Initialize local orca state with full bootstrap.
```
orca init
```
Performs a 6-step idempotent bootstrap:
1. Create the namespace directory (honors `$ORCA_HOME`; defaults to `~/.orca`)
2. Open and migrate the SQLite database (migrations 00010006)
3. Bootstrap the internal CA (`ca.crt` + `ca.key`) if not already present
4. Generate the server cert (`server.crt` + `server.key`) if not already present
5. Auto-detect the local OS via `/etc/os-release`
6. Register a localhost node (kind=localhost, os=\<detected\>)
Re-running `orca init` is safe — it refreshes `last_seen` and `os` on
the localhost node without regenerating certs or changing the node ID.
**Flags**: none.
**Example**:
```bash
orca init
orca --system init # system-level bootstrap at /root/.orca
```
---
## `orca job`
Manage orca jobs — run, list, stop, and inspect.
### `orca job run`
Run a job from a spec file.
```
orca job run <spec> [flags]
```
Dispatches by file extension:
- `.md` → Markdown frontmatter parser (v0.9 canonical)
- `.yaml` / `.yml` → YAML frontmatter parser
- `.hcl` → Legacy HCL adapter (deprecated, see callout below)
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--target` | string | `""` | Pin job to a specific node ID (overrides bin-packing scheduler) |
| `--idempotency-key` | string | `""` | Idempotency key for cross-node dispatch dedupe |
**Examples**:
```bash
orca job run web-app.md
orca job run api.yaml --target node-abc-123
orca job run worker.md --idempotency-key deploy-2026-08-05
```
> **Deprecated**: `orca job run <spec.hcl>` (legacy HCL jobspec) still
> works via the adapter but emits a deprecation warning. Migrate `.hcl`
> specs to `.md` (see [docs/jobspec.md](jobspec.md)). Removed in v0.11.
### `orca job list`
List all jobs.
```
orca job list [flags]
```
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--watch` | bool | `false` | Stream jobs until Ctrl-C (table refresh or `--json` per-event) |
**Output columns**: `ID NAME STATUS EXIT`
**Examples**:
```bash
orca job list
orca job list --watch # table refresh
orca job list --watch --json # NDJSON: {"event":"update","job":{...}}
```
### `orca job stop`
Stop a running job (soft stop).
```
orca job stop [job-id] [flags]
```
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--id` | string | `""` | Job ID (alternative to positional argument) |
**Example**:
```bash
orca job stop abc-123-def
orca job stop --id abc-123-def
```
### `orca job logs`
Show task output for a job.
```
orca job logs [job-id] [flags]
```
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--id` | string | `""` | Job ID (alternative to positional argument) |
**Example**:
```bash
orca job logs abc-123-def
```
---
## `orca node`
Manage orca nodes — join, leave, or list nodes in the registry.
### `orca node join`
Join a node to the orca registry.
```
orca node join [flags]
```
Node types (via `--type`):
- `localhost` (default): register a local or Linux node
- `proxmox`: SSH-bootstrap a remote Proxmox VE 8/9 host (deploys orca
pubkey, creates orca user + PVE role + sudoers allowlist; requires
`--host` + `--password`)
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--name` | string | `""` | Node name (required for `--type localhost`) |
| `--addr` | string | `""` | Node address (default `localhost:8443`) |
| `--ca-fingerprint` | string | `""` | Pin CA cert SHA-256 (fails if on-disk CA doesn't match) |
| `--type` | string | `"localhost"` | Node type: `localhost` or `proxmox` |
| `--host` | string | `""` | Proxmox host address (IP/hostname; required for `--type proxmox`) |
| `--ssh-user` | string | `"root"` | SSH username for proxmox bootstrap |
| `--password` | string | `""` | SSH password for proxmox bootstrap (never persisted; prefer `$ORCA_PROXMOX_PASSWORD`) |
| `--ssh-port` | int | `22` | SSH port for proxmox bootstrap |
| `--proxmox-user` | string | `"orca"` | Linux system user to create on the proxmox host |
| `--proxmox-role` | string | `"OrcaOperator"` | PVE custom role to create |
| `--host-key-fingerprint` | string | `""` | SSH host key `SHA256:base64` fingerprint (pre-pin; supersedes TOFU for `--type proxmox`) |
**Examples**:
```bash
# Localhost (deprecated mTLS path)
orca node join --name my-node
# Proxmox (v0.9 canonical SSH-push path)
orca node join --type proxmox --host 192.168.1.100 --ssh-user root
ORCA_PROXMOX_PASSWORD=secret orca node join --type proxmox --host 192.168.1.100
# Proxmox with pre-pinned host key
orca node join --type proxmox --host 192.168.1.100 --host-key-fingerprint SHA256:abc123...
```
> **Deprecated**: `orca node join` without `--type proxmox` (the
> localhost mTLS join path) is deprecated in v0.9. The v0.9 canonical
> path is SSH-push (`--type proxmox`) or local execution (no join
> needed). Removed in v0.11.
### `orca node leave`
Remove a node from the orca registry.
```
orca node leave [node-id] [flags]
```
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--id` | string | `""` | Node ID (alternative to positional argument) |
### `orca node list`
List all nodes in the orca registry.
```
orca node list [flags]
```
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--watch` | bool | `false` | Stream nodes until Ctrl-C (table refresh or `--json` per-event) |
**Output columns**: `ID NAME ADDRESS STATE`
### `orca node key-reset`
Reset the SSH known_hosts entry for a node.
```
orca node key-reset <node>
```
Removes the pinned SSH host key for `<node>` from the local
`known_hosts` file. The next connect re-pins the key via TOFU or
`--host-key-fingerprint`. Local only — does not touch the remote
host's `authorized_keys`.
`<node>` is the node name (for proxmox nodes, this is the host address).
**Example**:
```bash
orca node key-reset 192.168.1.100
```
### `orca node capacity`
Manage node capacity declarations (bin-packing scheduler input).
```
orca node capacity <subcommand>
```
#### `orca node capacity show`
Show capacity for a node (defaults to `self`).
```
orca node capacity show [node-id] [flags]
```
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--node` | string | `""` | Node ID (defaults to `self`) |
**Output**: `Node:`, `CPU:` (millicores), `Memory:` (MiB), `Disk:` (MiB), `Updated:`
#### `orca node capacity set`
Declare capacity for a node.
```
orca node capacity set [flags]
```
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--cpu` | int64 | `0` | CPU capacity in millicores (1000 = 1 vCPU) |
| `--memory` | int64 | `0` | Memory capacity in MiB |
| `--disk` | int64 | `0` | Disk capacity in MiB |
| `--node` | string | `""` | Node ID (defaults to `self`) |
**Example**:
```bash
orca node capacity set --cpu 4000 --memory 8192 --disk 100000
orca node capacity set --cpu 2000 --memory 4096 --node web-1
```
#### `orca node capacity list`
List all node capacity declarations.
```
orca node capacity list
```
**Output columns**: `NODE CPU(mc) MEM(MiB) DISK(MiB) UPDATED`
---
## `orca ns`
Manage orca namespaces under `ORCA_HOME` (R-002).
Each namespace is a directory with `ns.md`, `.env`, `.env.secrets`,
`db/`, `jobs/`, `alloc/`. The implicit root namespace `_defaults`
always exists; every namespace inherits from `_defaults` and cannot
opt out.
### `orca ns list`
List all namespaces under `ORCA_HOME`.
```
orca ns list
```
**Output columns**: `NAME DEFAULT PATH` (`_defaults` marked `*`)
### `orca ns create`
Create a namespace directory + `ns.md`.
```
orca ns create <name> [flags]
```
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--parent` | string | `""` | Parent namespace (default `_defaults`; implicit root always appended last) |
| `--inherits-env` | bool | `true` | Inherit env from parents |
| `--inherits-secrets` | bool | `true` | Inherit secrets from parents |
**Example**:
```bash
orca ns create prod --parent _defaults
orca ns create staging --parent prod
```
### `orca ns delete`
Remove an empty namespace directory.
```
orca ns delete <name>
```
Refuses if `jobs/` or `alloc/` contain files. The implicit root
`_defaults` cannot be deleted.
### `orca ns inspect`
Print the effective inheritance chain, merged env, and constraints.
```
orca ns inspect <name>
```
**Output**: `Namespace:`, `Chain:` (e.g., `prod -> _defaults`), `Env:`
(sorted keys), `Constraints:` (unioned CEL expressions).
### `orca ns validate`
Run cycle + missing-parent + schema checks on a namespace.
```
orca ns validate <name>
```
Exits 0 if valid, 1 on error. Runs over ALL namespaces under
`ORCA_HOME` (parsing + resolving validates cycles and missing parents
across the set).
---
## `orca doctor`
Run self-checks on the orca installation.
```
orca doctor [subcommand]
```
Without a subcommand, runs all checks and prints a PASS/WARN/FAIL
report per check.
### Subcommands
| Command | Description |
|---------|-------------|
| `orca doctor cert` | CA, server cert, expiry, fingerprint checks |
| `orca doctor network` | Network reachability via mTLS `/healthz` probe |
| `orca doctor db` | Database integrity (`PRAGMA integrity_check` + migration version) |
| `orca doctor os` | OS detection self-check (verifies `/etc/os-release` matches stored node) |
| `orca doctor proxmox` | Proxmox node reachability via SSH `pveversion`/`pvecmd status` probe |
**Example**:
```bash
orca doctor
orca doctor cert
orca doctor proxmox --json
```
---
## `orca audit`
View orca audit log (security-first observability).
### `orca audit list`
List recent audit log entries.
```
orca audit list [flags]
```
| Flag | Type | Default | Description |
|------|------|---------|-------------|
| `--limit` | int | `50` | Max entries to show |
**Output columns**: `TIMESTAMP ACTOR ACTION RESOURCE RESULT`
---
## `orca version`
Print version information.
```
orca version
```
**Output**:
```
orca version v0.9.1
git commit: abc1234
build time: 2026-08-05T20:30:00Z
```
---
## `orca status`
Show orca daemon status.
```
orca status
```
> **Deprecated**: The daemon model is deprecated in v0.9 (replaced by
> SSH-push, R-001). This command returns a stub status. Removed in
> v0.11.
---
## Deprecated commands
The following commands are from the v0.8 daemon/mTLS model and are
**deprecated in v0.9**. They still work during the dual-write window
but emit `slog.Warn` deprecation warnings. They will be **removed in
v0.11**.
> **`orca daemon`** — Run the orca daemon (HTTP API + health checks).
> The v0.9 re-architecture replaces the daemon with SSH-push (R-001).
> The daemon is repurposed to `drain-and-stop` in v0.11-P05 and deleted
> in v0.11-P14. Flags: `--addr` (default `:8080`), `--pprof` (pprof
> endpoint, default disabled).
> **`orca cert`** — Manage orca certificates (CA, server, rotation).
> The v0.9 re-architecture replaces the internal CA with step-ca
> (D-101). Subcommands: `ca-init`, `gen`, `show`, `renew`,
> `fingerprint`. Removed in v0.11.
> **`orca node join` (mTLS path)** — The localhost mTLS join path
> (without `--type proxmox`) is deprecated. The v0.9 canonical path is
> SSH-push (`--type proxmox`) or local execution (no join needed).
> **`orca job run <spec.hcl>`** — Legacy HCL jobspec. Migrate to `.md`
> (see [docs/jobspec.md](jobspec.md)). The HCL adapter preserves
> `orca job run old-spec.hcl` during the migration window.
To suppress deprecation warnings during migration, use
`--no-deprecation-warnings`:
```bash
orca --no-deprecation-warnings daemon
```
---
## See also
- [docs/jobspec.md](jobspec.md) — Markdown frontmatter jobspec reference
- [docs/ingress.md](ingress.md) — Traefik ingress configuration guide
- [docs/namespace.md](namespace.md) — Namespace and path layout
- [docs/install.md](install.md) — Installation guide
- [examples/full-stack/](../examples/full-stack/) — Full-stack example with ingress
+209
View File
@@ -0,0 +1,209 @@
# Orca Ingress & Traefik Guide
This document explains how Orca configures ingress via Traefik dynamic
configuration. It covers the service→Traefik mapping, the R-007
socket-vs-TCP-bind model, atomic reload, drain, TLS, and a worked
example.
> **Canonical path (v0.9)**: Orca generates Traefik dynamic
> configuration files via the `TraefikEmitter`. The `kind: Service`
> workload implies a Traefik route. The emitter renders one YAML file
> per Service; Traefik watches the dynamic config directory and reloads
> atomically on change.
## The model
A `kind: Service` jobspec **implies** a Traefik route (D-175). `Job`
and `DaemonSet` do **not** carry a Traefik route by default — a
`service:` block on a `Job` is rejected by the validator.
When `orca job run` submits a `kind: Service` workload, the
`TraefikEmitter` renders a Traefik dynamic config file at:
```
/etc/traefik/dynamic/orca-<service-name>.yaml
```
This file contains:
- One **router** (`orca-<name>`) with a `PathPrefix` rule and TLS config.
- One **service** (`orca-<name>`) as a `loadBalancer` with one **server**
per port, pointing at the workload's Unix socket (or TCP port).
- A **healthCheck** stanza when the `health:` block is present.
Traefik watches `/etc/traefik/dynamic/` via `fsnotify` and reloads
whenever a file changes. Orca writes config atomically (write-tmp +
rename) so Traefik sees a single `IN_MOVED_TO` event and never observes
a half-written file.
## R-007: socket vs TCP bind
Orca workloads bind to a **Unix socket** by default, not a TCP port.
This is the R-007 security model: loopback-only by default, no network
exposure.
### Default: Unix socket
When `service.bind` is empty (default), the workload binds a Unix
socket at:
```
/run/orca/alloc-<alloc-id>/port-<port-name>.sock
```
systemd creates `/run/orca/alloc-<alloc-id>/` via
`RuntimeDirectory=orca/alloc-<alloc-id>` (mode 0750, owned by
`orca:orca`). The Traefik backend server URL is:
```yaml
servers:
- url: "unix:///run/orca/alloc-<alloc-id>/port-<port-name>.sock"
```
### TCP opt-in: `service.bind: 127.0.0.1`
When `service.bind: 127.0.0.1` is set, the workload binds a TCP port
directly (loopback only). The emitter adds an `ExecStartPre` marker to
the systemd unit so the bind mode is visible:
```ini
ExecStartPre=/bin/echo orca: bind 127.0.0.1 port <name> (tcp, R-007 opt-in)
```
`service.bind` must be a valid IP address. Empty (socket default) or
`127.0.0.1` (TCP opt-in) are the documented values; any other valid IP
is accepted but the bind happens in the process, not the emitter.
## Generated Traefik YAML
For a Service named `web` with port `http`:
```yaml
http:
routers:
orca-web:
rule: PathPrefix("/web")
service: orca-web
tls:
certResolver: orca
domains:
- main: "cluster.orca.local"
services:
orca-web:
loadBalancer:
servers:
- url: "unix:///run/orca/alloc-<alloc-id>/port-http.sock"
healthCheck:
path: /healthz
interval: 5s
timeout: 1s
```
- One router per Service, named `orca-<service-name>`.
- Router rule: `PathPrefix("/<service-name>")`.
- TLS: `certResolver: orca`, trust domain `cluster.orca.local`
(placeholder; step-ca provisioner overrides in v0.11).
- One service per Service, named `orca-<service-name>`.
- One server per port, URL is `unix://<socket-path>`.
- `healthCheck` stanza present when `health:` block is set (required
for Service). Path is `/healthz`; interval and timeout come from the
`health:` block.
## Atomic reload (gate C-10)
Orca writes Traefik config atomically to avoid Traefik observing a
half-written file:
1. Write to `<path>.tmp` via `WriteFileIdempotent` (write + fsync).
2. `mv -f <path>.tmp <path>` (atomic POSIX rename).
Traefik's `fsnotify` watcher sees a single `IN_MOVED_TO` event and
reloads. If the new config is malformed, Traefik logs an error and
**holds last-good config** — the cluster keeps serving traffic on the
previous config.
## Drain
`RenderDrain` produces the same Traefik YAML with `weight: 0` on every
server in the load balancer:
```yaml
servers:
- url: "unix:///run/orca/alloc-<alloc-id>/port-http.sock"
weight: 0
```
Traefik stops sending traffic to the drained backend. The workload
keeps running; drain is reversible (re-submit the normal config to
restore traffic).
## TLS
- **certResolver**: `orca` (references the Traefik ACME/step-ca
certificate resolver configured in Traefik's static config).
- **Trust domain**: `cluster.orca.local` (placeholder in v0.9; step-ca
provisioner in v0.11 overrides with the real cluster trust domain).
- **SPIFFE SVIDs**: workload identity via SPIFFE SVIDs minted at submit
time via step-ca (v0.11-P01.5, gate C-08). The SVID is a URI SAN in
the workload's X.509 cert.
## Health checks
The `health:` block (required for `Service`) maps to the Traefik
`healthCheck` stanza:
```yaml
health:
check_type: http
interval: 5s
timeout: 1s
unhealthy_threshold: 2
```
```yaml
healthCheck:
path: /healthz
interval: 5s
timeout: 1s
```
Traefik polls each backend's `/healthz` at the configured interval. An
unhealthy backend is removed from the load balancer pool until it
passes the health check again.
## Worked example
See [examples/full-stack/](../examples/full-stack/) for a complete
multi-service stack with ingress configured:
- `web-app.md` — frontend Service (socket bind, PathPrefix route)
- `api.md` — backend API Service (TCP opt-in, `127.0.0.1` bind)
- `examples/full-stack/rendered/traefik-dynamic-web-app.yaml` — the
Traefik config Orca generates
## v0.11 forward (limitations)
The following are not yet implemented in v0.9 and will land in v0.11:
- **`service.host` / `service.route_id`**: stored on the `ServiceBlock`
but not yet consumed by the `TraefikEmitter`. The router rule is
hardcoded `PathPrefix("/<name>")`. Custom host-based routing lands in
v0.11.
- **Socket activation**: real socket-activation (socket unit files, fd
passing) lands in v0.11-P08. The current emitter renders the
`RuntimeDirectory` + socket path comments but does not create socket
units.
- **Transactional update execution**: the `update:` block's rolling/
canary/blue-green plan is computed by the emitter but not yet
executed transactionally. Transactional execution lands in
v0.11-P10.
- **SPIFFE SVID minting**: workload identity via step-ca SVIDs lands in
v0.11-P01.5 (gate C-08).
- **Secrets in env**: `env: { KEY: { from: "secret:..." } }` resolution
to `EnvironmentFile=`/`LoadCredential=` lands in v0.11-P03.
## See also
- [docs/cli.md](cli.md) — CLI reference
- [docs/jobspec.md](jobspec.md) — Jobspec reference (`service:`, `health:`, `ports:` blocks)
- [examples/full-stack/](../examples/full-stack/) — Full-stack example with ingress
+442
View File
@@ -0,0 +1,442 @@
# Orca Jobspec Reference
This document is the complete reference for the Orca jobspec format —
the Markdown-with-frontmatter specification that describes workloads.
> **Canonical format (v0.9)**: Orca uses Markdown with YAML frontmatter
> as the canonical jobspec format (R-013/R-014). The legacy HCL format
> is supported via an adapter during the migration window but is
> deprecated (see [HCL jobspec](#deprecated-hcl-jobspec) below).
## File formats
The `orca job run` command dispatches by file extension:
| Extension | Parser | Body |
|-----------|--------|------|
| `.md` | `ParseMarkdown` (canonical) | Verbatim after closing `---` (R-015 byte-exact) |
| `.yaml` / `.yml` | `parseYAMLFile` | Whole file as frontmatter; body empty |
| `.hcl` | `ParseHCL` (legacy adapter) | Empty (deprecated) |
## Minimal example
```yaml
---
kind: Job
name: my-job
runtime:
one_of: process
command: /bin/echo hello
---
# My Job
This body is preserved byte-exact and carried to the target node.
```
## Top-level keys
| Key | Type | Default | Required | Notes |
|-----|------|---------|----------|-------|
| `orca-spec-version` | string | `""` | no | Free-form version tag (e.g. `"1"`) |
| `kind` | enum | — | **yes** | One of `Job`, `Service`, `DaemonSet` |
| `name` | string | — | **yes** | Workload name (trimmed, non-empty) |
| `count` | int | `1` | no | Job: must be 1; Service: ≥1; DaemonSet: not allowed |
| `runtime` | block | nil | see kinds | Runtime block (or per-task runtimes in a task group) |
| `ports` | block list | nil | Service: **yes** | Array of port mappings |
| `env` | block map | nil | no | Environment variables |
| `secrets` | inline/block list | nil | no | Secret names (resolution in v0.11) |
| `volumes` | block list | nil | no | Volume mounts |
| `restart` | block | nil | Service/DaemonSet: **yes** | Restart policy |
| `update` | block | nil | Service: **yes** | Update strategy |
| `service` | block | nil | no | Traefik route definition (implied for Service; not allowed for Job/DaemonSet) |
| `health` | block | nil | Service: **yes** | Health check |
| `lifecycle` | block | nil | no | Pre-stop / post-start hooks |
| `constraints` | list | nil | no | CEL expressions (node selection) |
| `affinity` | block list | nil | no | Co-location / anti-affinity rules |
| `tasks` | block list | nil | no | Task group (multi-process alloc) |
| `timeout` | duration string | `""` | no | Job timeout |
| `schedule` | block | nil | DaemonSet: **yes** | Schedule mode |
## Kinds
### `Job`
A one-shot batch task. Runs once and exits.
- `count` must be 1 (or unset). Use `Service` for replicas.
- `service` block is **not allowed** (no Traefik route for Jobs).
- `restart` optional (defaults to `never` / `on-failure`).
- `timeout` optional.
**Example**:
```yaml
---
kind: Job
name: data-migration
runtime:
one_of: process
command: /usr/bin/python3 migrate.py
timeout: 300s
env:
DB_URL: postgres://localhost/mydb
---
```
### `Service`
A long-running, load-balanced workload with a Traefik route.
- `count` ≥ 1 (number of replicas).
- `ports` required (at least one).
- `restart` required; `mode` one of `service`, `on-failure`, `never`.
- `update` required; `strategy` one of `rolling`, `canary`, `blue-green`.
- `runtime` required (or a task group with per-task runtimes).
- `health` required (Traefik routing requires health checks).
- `service` block optional (implied for Service; use for `bind` override).
- `service.bind` if present must be a valid IP (`127.0.0.1` = TCP opt-in;
default = Unix socket).
**Example**:
```yaml
---
kind: Service
name: web
count: 3
runtime:
one_of: process
command: /usr/bin/httpd
ports:
- name: http
port: 8080
restart:
mode: service
attempts: 5
delay: 2s
update:
strategy: rolling
max_parallel: 1
health:
check_type: http
interval: 5s
timeout: 1s
unhealthy_threshold: 2
constraints:
- node.role == "web"
---
```
### `DaemonSet`
A workload that runs on every matching node.
- `schedule` required; `mode` one of `every-node`, `matching`, `mandatory`.
- `ports` **not allowed** (no Traefik route by default).
- `count` **not allowed** (implicit = matching nodes).
- `restart` required.
**Example**:
```yaml
---
kind: DaemonSet
name: log-shipper
schedule:
mode: every-node
runtime:
one_of: process
command: /usr/bin/fluent-bit
restart:
mode: service
---
```
## Block reference
### `runtime`
The runtime backend for the workload.
| Field | Key | Type | Default | Notes |
|-------|-----|------|---------|-------|
| `one_of` | `one_of` | string | — | Runtime type (see below) |
| `image` | `image` | string | `""` | Container image (for `podman`) |
| `command` | `command` | string | — | ExecStart command |
**Supported runtime types** (`one_of`):
| Type | Description | Requires |
|------|-------------|----------|
| `process` | Direct process execution via systemd (default) | systemd on target |
| `wasm` / `wasmtime` | WASM via wasmtime CLI (apt-installed on peer, SSH exec) | wasmtime on target |
| `podman` | Container via podman | podman on target |
| `pve-vm` | Proxmox VM via `qm` | Proxmox node |
| `pve-ct` | Proxmox container via `pct` | Proxmox node |
| `proxmox` | Alias for Proxmox runtime | Proxmox node |
An empty/missing `Runtime` or `OneOf` is runtime-agnostic (always fits
the runtime axis in the scheduler).
### `ports`
Array of port mappings. Required for `Service`.
| Field | Key | Type | Default | Notes |
|-------|-----|------|---------|-------|
| `name` | `name` | string | — | Port name (used in socket path) |
| `port` | `port` | int | — | Container port |
| `host_port` | `host_port` | int | `0` | Host port |
| `protocol` | `protocol` | string | `""` | Protocol (e.g. `tcp`) |
| `host_ip` | `host_ip` | string | `""` | Host IP |
**Example**:
```yaml
ports:
- name: http
port: 8080
host_port: 80
protocol: tcp
- name: https
port: 8443
host_port: 443
```
### `env`
Environment variables. Scalar values or secret references.
```yaml
env:
FOO: bar
BAZ: "qux"
SECRET_REF:
from: "secret:db-password"
INLINE: {from: "secret:token"}
```
> Secret resolution (`from: "secret:..."`) lands in v0.11-P03. The
> parser stores the reference; the emitter will emit
> `EnvironmentFile=`/`LoadCredential=` in v0.11.
### `secrets`
List of secret names. Inline array or block list.
```yaml
secrets: ["db-password", "api-token"]
# or
secrets:
- db-password
- api-token
```
### `volumes`
Array of volume mounts.
| Field | Key | Type | Default | Notes |
|-------|-----|------|---------|-------|
| `name` | `name` | string | — | Volume name |
| `type` | `type` | string | — | Volume type (e.g. `host`) |
| `source` | `source` | string | — | Source path (or `replicate:<peer>,<peer>` for Syncthing) |
| `target` | `target` | string | — | Mount target |
| `read_only` | `read_only` | bool | `false` | Read-only mount (`true`/`yes`/`on`/`1`) |
**Example**:
```yaml
volumes:
- name: data
type: host
source: /data
target: /data
read_only: true
```
### `restart`
Restart policy.
| Field | Key | Type | Default | Notes |
|-------|-----|------|---------|-------|
| `mode` | `mode` | enum | — | `never`, `on-failure`, `service` |
| `attempts` / `max_retries` | `attempts` or `max_retries` | int | `0` | Max retries (both keys accepted) |
| `delay` | `delay` | duration string | `""` | Retry delay (e.g. `2s`) |
### `update`
Update strategy. Required for `Service`.
| Field | Key | Type | Default | Notes |
|-------|-----|------|---------|-------|
| `strategy` | `strategy` | enum | — | `rolling`, `canary`, `blue-green` |
| `max_surge` | `max_surge` | int | `0` | Max surge |
| `max_parallel` | `max_parallel` | int | `1` (clamped to `count`) | Max parallel updates |
| `min_healthy_time` | `min_healthy_time` | duration | `""` | Min time healthy before next batch |
| `healthy_deadline` | `healthy_deadline` | duration | `""` | Deadline for health |
| `canary` | `canary` | int or `"<n>%"` | — | Canary size (int count or percentage) |
| `auto_promote` | `auto_promote` | bool | `false` | Auto-promote canary (`true`/`yes`/`on`/`1`) |
**Strategies**:
- **rolling**: batches of `max_parallel`, each batch waits for healthy.
- **canary**: canary batch first, then `promote` (manual or `auto_promote`), then remaining in `max_parallel` batches.
- **blue-green**: all new allocs start in parallel, wait healthy, then `cutover`.
> Transactional update execution lands in v0.11-P10. The current
> emitter computes the plan; execution is a v0.11 deliverable.
### `service`
Traefik route definition. Implied for `Service`; not allowed for
`Job`/`DaemonSet`. See [docs/ingress.md](ingress.md) for details.
| Field | Key | Type | Default | Notes |
|-------|-----|------|---------|-------|
| `name` | `name` | string | — | Service name |
| `port` | `port` | int | — | Service port |
| `bind` | `bind` | string (IP) | `""` | Bind mode: empty = Unix socket (default); `127.0.0.1` = TCP opt-in (R-007) |
| `host` | `host` | string | `""` | Host (stored, not yet consumed by emitter) |
| `route_id` | `route_id` | string | `""` | Route ID (stored, not yet consumed by emitter) |
### `health`
Health check. Required for `Service`.
| Field | Key | Type | Default | Notes |
|-------|-----|------|---------|-------|
| `check_type` | `check_type` | string | — | Check type (e.g. `http`) |
| `interval` | `interval` | duration string | — | Check interval (e.g. `5s`) |
| `timeout` | `timeout` | duration string | — | Check timeout |
| `unhealthy_threshold` | `unhealthy_threshold` | int | `0` | Failures before unhealthy |
Maps to Traefik `healthCheck` stanza (`path: /healthz`).
### `lifecycle`
Lifecycle hooks. Maps to systemd `ExecStartPost` / `ExecStop`.
| Field | Key | Type | Default | systemd mapping |
|-------|-----|------|---------|-----------------|
| `post_start` | `post_start` | string list | nil | `ExecStartPost=` (runs after main starts) |
| `pre_stop` | `pre_stop` | string list | nil | `ExecStop=` (runs before kill) |
**Example**:
```yaml
lifecycle:
pre_stop:
- /bin/sh -c 'sleep 5'
- /usr/local/bin/drain.sh
post_start:
- /usr/local/bin/warm-cache.sh
```
### `constraints`
CEL-subset expressions for node selection. Inline array or block list.
```yaml
constraints:
- node.role == "web"
- region == "us"
# or inline
constraints: ['node.role == "web"', 'region == "us"']
```
**CEL subset grammar** (hand-rolled, no CEL dependency):
- Node attributes: `node.hostname`, `node.kind`, `node.cpus`,
`node.memory`, `node.tags`, `node.runtimes`
- Bare identifiers: equivalent to `node.<name>`
- Literals: string (`"..."`), int
- Comparisons: `==`, `!=`, `>=`, `<=`, `>`, `<`
- Membership: `in`, `not in`
- Boolean: `and`, `or`, `not`, parentheses
- Anything outside the subset returns an error (node skipped, not
silently mis-evaluated)
### `affinity`
Co-location / anti-affinity rules.
```yaml
affinity:
- target: zone == "a"
weight: 80
- target: web
weight: -50 # anti-affinity (negative weight)
```
- `target`: CEL expression or bare workload name (for name-based
co-location).
- `weight`: positive = co-locate, negative = anti-affinity.
- Affinity is a **hint** (not a gate); evaluation failures are ignored.
### `tasks` (task group)
Multi-process alloc (P06). When `tasks` is non-empty, the alloc runs
multiple processes, each as its own systemd unit, grouped under a
systemd target.
```yaml
tasks:
- name: app
runtime:
one_of: process
command: /usr/bin/httpd -f
env:
LOG_LEVEL: debug
- name: sidecar
runtime:
one_of: wasm
command: /bin/wasm-runner sidecar.wasm
```
- A task with no `runtime:` inherits the top-level `spec.Runtime`.
- Each task can have its own `env:` overlay.
- `command` falls back: `task.Command``task.Runtime.Command`
`spec.Runtime.Command`.
- Task names must be unique within the group.
## Kinds matrix
| Feature | Job | Service | DaemonSet |
|---------|-----|---------|-----------|
| `count` | must be 1 | ≥ 1 | not allowed |
| `ports` | optional | **required** | not allowed |
| `service` block | not allowed | optional (implied) | not allowed |
| `restart` | optional | **required** | **required** |
| `update` | optional | **required** | optional |
| `health` | optional | **required** | optional |
| `runtime` | optional | **required** (or task group) | optional |
| `schedule` | optional | optional | **required** |
| `tasks` | optional | optional | optional |
| Traefik route | no | yes (implied) | no (by default) |
## Body semantics
The body after the closing `---` is preserved **byte-exact** (R-015) —
including trailing newlines, CRLF, BOM in body, and `---` inside code
fences. The body is carried verbatim to the target node. It is not
interpreted as commands/scripts by the parser today.
## Deprecated: HCL jobspec
The legacy HCL jobspec format is supported via an adapter during the
migration window. It is deprecated in v0.9 and will be removed in
v0.11.
```hcl
job "hello-orca" {
}
task "greet" {
command = "/bin/echo"
args = ["hello", "from", "orca"]
}
```
The adapter converts this to a `*WorkloadSpec{Kind: "Job", Name:
"hello-orca", Count: 1, Runtime: {OneOf: "process", Command:
"/bin/echo"}}`. Use `.md` for all new jobspecs.
## See also
- [docs/cli.md](cli.md) — CLI reference (including `orca job run`)
- [docs/ingress.md](ingress.md) — Traefik ingress configuration
- [examples/full-stack/](../examples/full-stack/) — Full-stack example jobspecs
+61 -7
View File
@@ -9,11 +9,16 @@
# Options:
# --system Install at system level (/usr/local/bin/orca, namespace /root/.orca). Requires root.
# --version <tag> Pin a specific version (e.g. v0.4.2). Default: latest release.
# --check Dry-run: print the version + asset URL + install path without writing.
# --help, -h Show this help.
#
# Behavior:
# - Downloads the release tarball from the public Gitea release URL.
# - Extracts the orca binary to the install path.
# - If the resolved release (latest or pinned) has no matching binary
# asset, walks backward through recent releases to find one that does,
# and prints a warning. (REQ-098 — the v0.8.x releases shipped with
# zero binary assets, causing install to resolve to v0.4.5.)
# - If an existing orca binary is found, reads its version and prints
# "updated from X to Y" (in-place update; preserves config/db/certs).
# - Idempotent: re-running with the same version reinstalls the binary.
@@ -27,6 +32,7 @@ GITEA_REPO="${GITEA_REPO:-orca}"
SYSTEM=false
VERSION=""
CHECK=false
INSTALL_BIN=""
NAMESPACE_DIR=""
@@ -45,6 +51,7 @@ while [ $# -gt 0 ]; do
--system) SYSTEM=true; shift ;;
--version) VERSION="${2:-}"; shift 2 ;;
--version=*) VERSION="${1#*=}"; shift ;;
--check) CHECK=true; shift ;;
--help|-h) usage ;;
*) err "unknown argument: $1 (try --help)" ;;
esac
@@ -91,16 +98,46 @@ esac
OS="$(uname -s | tr '[:upper:]' '[:lower:]')"
TARBALL="orca-${VERSION}-${OS}-${ARCH}.tar.gz"
# --- find asset download URL ----------------------------------------------
# --- find asset download URL (with fallback walk — REQ-098) --------------
#
# The v0.8.x releases shipped with zero binary assets attached, causing
# install to error out on the latest release. If the resolved release
# (latest or --version) lacks the matching tarball, walk backward through
# recent releases to find one that carries it, and print a warning.
info "locating asset ${TARBALL}..."
ASSET_URL="$(curl -fsSL "${GITEA_URL}/api/v1/repos/${GITEA_OWNER}/${GITEA_REPO}/releases/tags/${VERSION}" \
| sed -n 's/.*"browser_download_url"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' \
| grep "/${TARBALL}\$" \
| head -1)"
find_asset_url() {
# $1 = tag. Prints the browser_download_url for the matching tarball, or empty.
# The `|| true` prevents set -e + pipefail from exiting the script when
# grep finds no match (exit 1) — an empty result is a valid outcome.
local tag="$1"
curl -fsSL "${GITEA_URL}/api/v1/repos/${GITEA_OWNER}/${GITEA_REPO}/releases/tags/${tag}" \
| sed -n 's/.*"browser_download_url"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' \
| grep "/${TARBALL}\$" \
| head -1 || true
}
info "locating asset ${TARBALL} in release ${VERSION}..."
ASSET_URL="$(find_asset_url "$VERSION")"
if [ -z "$ASSET_URL" ]; then
err "could not find asset ${TARBALL} in release ${VERSION}. Check that the release exists and has a linux-${ARCH} tarball."
info "WARNING: release ${VERSION} has no ${TARBALL} asset. Walking back through recent releases..."
# The /releases list endpoint returns assets inline (browser_download_url
# appears within each release's assets array). Extract all download URLs
# from the list response and find the first (newest) one matching our
# OS+arch tarball pattern (any version). This avoids per-release API calls.
ASSET_URL="$(curl -fsSL "${GITEA_URL}/api/v1/repos/${GITEA_OWNER}/${GITEA_REPO}/releases?limit=50" \
| grep -oE '"browser_download_url"[[:space:]]*:[[:space:]]*"[^"]*"' \
| sed -n 's/.*"browser_download_url"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' \
| grep -E "/orca-[^/]*-${OS}-${ARCH}\.tar\.gz$" \
| head -1 || true)"
if [ -n "$ASSET_URL" ]; then
# Extract the version from the URL (e.g. .../download/v0.4.5/orca-...)
FALLBACK_VERSION="$(echo "$ASSET_URL" | sed -n 's|.*/download/\([^/]*\)/.*|\1|p')"
info "WARNING: latest release ${VERSION} has no binary asset; falling back to ${FALLBACK_VERSION} which has orca-${FALLBACK_VERSION}-${OS}-${ARCH}.tar.gz."
VERSION="$FALLBACK_VERSION"
else
err "could not find any release with a ${OS}-${ARCH} tarball in the last 50 releases. Check that a release exists with a linux-${ARCH} binary."
fi
fi
info "asset: ${ASSET_URL}"
@@ -111,6 +148,23 @@ if [ -x "$INSTALL_BIN" ]; then
OLD_VERSION="$("$INSTALL_BIN" version --json 2>/dev/null | sed -n 's/.*"version"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' | head -1 || echo "")"
fi
# --- --check dry-run (D-194) ---------------------------------------------
# Print what would be installed without writing anything.
if [ "$CHECK" = "true" ]; then
info "dry-run (--check): no files will be written"
info " would install: orca ${VERSION}"
info " asset: ${ASSET_URL}"
info " binary path: ${INSTALL_BIN}"
info " namespace root: ${NAMESPACE_DIR}"
if [ -n "$OLD_VERSION" ]; then
info " current: ${OLD_VERSION} (would update to ${VERSION})"
else
info " current: (not installed)"
fi
exit 0
fi
# --- download + extract ---------------------------------------------------
TMPDIR="$(mktemp -d)"
+43 -12
View File
@@ -75,26 +75,26 @@ info "version: $VERSION"
info "building..."
# --- build with version injection ----------------------------------------
# Cross-build linux-amd64 regardless of host arch (D-193). The install.sh
# user base is amd64; the .coreci.yml release step hardcodes the amd64
# tarball name. Building for the host arch produced the wrong tarball when
# the release was cut from an arm64 dev machine — the root cause of the
# v0.4.5 install incident (REQ-097).
GIT_COMMIT="$(git rev-parse --short HEAD)"
BUILD_TIME="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
LDFLAGS="-s -w -X git.cloudinit.dev/coreci/orca/internal/cli.version=$VERSION -X git.cloudinit.dev/coreci/orca/internal/cli.gitCommit=$GIT_COMMIT -X git.cloudinit.dev/coreci/orca/internal/cli.buildTime=$BUILD_TIME"
mkdir -p bin
go build -trimpath -ldflags="$LDFLAGS" -o bin/orca ./cmd/orca
info "built: bin/orca"
info "building orca-${VERSION}-linux-amd64 (cross-compile, CGO_ENABLED=0)..."
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -trimpath -ldflags="$LDFLAGS" -o bin/orca ./cmd/orca
info "built: bin/orca (linux-amd64)"
# --- tarball --------------------------------------------------------------
# Always produce the linux-amd64 tarball name that install.sh looks for.
# (D-193: arm64 is a separate enhancement; this milestone ships amd64 only.)
OS="$(uname -s | tr '[:upper:]' '[:lower:]')"
ARCH="$(uname -m)"
case "$ARCH" in
x86_64) ARCH=amd64 ;;
aarch64) ARCH=arm64 ;;
armv7l) ARCH=armv7 ;;
esac
TARBALL="orca-${VERSION}-${OS}-${ARCH}.tar.gz"
TARBALL="orca-${VERSION}-linux-amd64.tar.gz"
tar -czf "$TARBALL" -C bin orca
info "packaged: $TARBALL ($(du -h "$TARBALL" | cut -f1))"
@@ -135,7 +135,38 @@ tea releases create "$VERSION" \
--note-file "$NOTES_FILE" \
--asset "$TARBALL"
info "✓ release $VERSION published"
# --- post-create asset verification (REQ-097, gate C-21) ------------------
# tea releases create has been observed to exit 0 without attaching the
# asset in some versions. Verify the asset actually appears in the release
# via the Gitea API; retry once if missing; fail loudly if still missing.
# This is the root-cause fix for the v0.8.x releases that shipped with zero
# binary assets.
verify_asset() {
local tag="$1" want="$2"
curl -fsSL "${GITEA_URL:-https://git.cloudinit.dev}/api/v1/repos/${GITEA_OWNER:-coreci}/${GITEA_REPO:-orca}/releases/tags/${tag}" \
| sed -n 's/.*"name"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' \
| grep -qx "$want"
}
info "verifying asset ${TARBALL} attached to release ${VERSION}..."
if verify_asset "$VERSION" "$TARBALL"; then
info "✓ asset verified: ${TARBALL}"
else
info "asset missing after tea releases create; retrying upload..."
# Retry: re-add the asset via tea releases edit
tea release edit "$VERSION" --repo "$REPO" --asset "$TARBALL" 2>/dev/null \
|| tea releases edit "$VERSION" --repo "$REPO" --asset "$TARBALL" 2>/dev/null \
|| true
sleep 2
if verify_asset "$VERSION" "$TARBALL"; then
info "✓ asset verified on retry: ${TARBALL}"
else
err "asset ${TARBALL} NOT attached to release ${VERSION} after retry — the release exists but has no binary. Run 'tea releases edit ${VERSION} --repo $REPO --asset $TARBALL' manually. (REQ-097, C-21)"
fi
fi
info "✓ release $VERSION published with binary asset"
# --- publish container image to gitea registry (REQ-046) ------------------
# Skipped gracefully if docker is not on PATH (e.g. local dev without docker).
+62
View File
@@ -0,0 +1,62 @@
#!/usr/bin/env bats
# Tests for scripts/install.sh (REQ-098: fallback walk + --check dry-run).
# Hermetic: tests the argument parsing, arch detection, and --check
# output formatting without hitting the Gitea API. The network-dependent
# fallback walk is tested via a mock curl in a separate test.
load test_helper
@test "install.sh --help exits 0 and shows usage" {
run "$SCRIPTS_DIR/install.sh" --help
assert_status 0 "$status"
assert_contains "$output" "--system"
assert_contains "$output" "--version"
assert_contains "$output" "--check"
assert_contains "$output" "--help"
}
@test "install.sh --check flag is parsed without error" {
# --check with a pinned version that exists (v0.4.5) should succeed
# and print the dry-run block. This is a live integration test against
# the public Gitea API; skip if network is unavailable.
skip_if_no_network
run "$SCRIPTS_DIR/install.sh" --check --version v0.4.5
assert_status 0 "$status"
assert_contains "$output" "dry-run (--check)"
assert_contains "$output" "would install: orca v0.4.5"
assert_contains "$output" "no files will be written"
}
@test "install.sh --check falls back when latest release has no asset" {
# v0.9.0 is a pre-execution release with no binary asset. --check
# should walk back and find v0.4.5 (which has an asset), printing
# a warning. This is a live integration test; skip if no network.
skip_if_no_network
run timeout 60 "$SCRIPTS_DIR/install.sh" --check --version v0.9.0
assert_status 0 "$status"
assert_contains "$output" "WARNING"
assert_contains "$output" "falling back"
assert_contains "$output" "dry-run (--check)"
}
@test "install.sh rejects unknown arguments" {
run "$SCRIPTS_DIR/install.sh" --bogus-flag
[ "$status" -ne 0 ]
assert_contains "$output" "unknown argument"
}
@test "install.sh --system requires root" {
# Only test the root check if we're NOT root (CI may run as root).
if [ "$(id -u)" -eq 0 ]; then
skip "running as root; --system root check not testable"
fi
run "$SCRIPTS_DIR/install.sh" --system --version v0.4.5 --check
[ "$status" -ne 0 ]
assert_contains "$output" "--system requires root"
}
# Helper: skip if the Gitea instance is unreachable.
skip_if_no_network() {
curl -fsSL --max-time 5 "https://git.cloudinit.dev/api/v1/repos/coreci/orca/releases/tags/v0.4.5" >/dev/null 2>&1 \
|| skip "Gitea API unreachable — network-dependent test skipped"
}
+44
View File
@@ -0,0 +1,44 @@
#!/usr/bin/env bats
# Tests for scripts/release.sh (REQ-097: cross-build amd64, asset verification).
# Hermetic: tests the tarball naming and cross-build logic without
# publishing a release. The full release flow requires GITEA_TOKEN + tea
# and is tested in CI.
load test_helper
@test "release.sh exists and is executable" {
[ -f "$SCRIPTS_DIR/release.sh" ]
[ -x "$SCRIPTS_DIR/release.sh" ]
}
@test "release.sh --help or usage shows required tools" {
# release.sh doesn't have a --help flag; the header comment is the
# usage. Verify the script is syntactically valid.
run bash -n "$SCRIPTS_DIR/release.sh"
assert_status 0 "$status"
}
@test "release.sh cross-builds linux-amd64 regardless of host arch" {
# Verify the script contains the cross-build command (D-193, REQ-097).
# We check the source rather than running it (which requires go + tea).
run grep -c "GOOS=linux GOARCH=amd64" "$SCRIPTS_DIR/release.sh"
[ "$status" -eq 0 ]
[ "$output" -ge 1 ]
}
@test "release.sh hardcodes linux-amd64 tarball name" {
# The tarball name must be linux-amd64 (not host-arch-dependent).
run grep -c "orca-\${VERSION}-linux-amd64.tar.gz" "$SCRIPTS_DIR/release.sh"
[ "$status" -eq 0 ]
[ "$output" -ge 1 ]
}
@test "release.sh has post-create asset verification (C-21)" {
# Verify the script contains the asset verification logic.
run grep -c "verifying asset" "$SCRIPTS_DIR/release.sh"
[ "$status" -eq 0 ]
[ "$output" -ge 1 ]
run grep -c "verify_asset" "$SCRIPTS_DIR/release.sh"
[ "$status" -eq 0 ]
[ "$output" -ge 1 ]
}