Skip to content

Latest commit

 

History

History
274 lines (209 loc) · 11 KB

armada-app.md

File metadata and controls

274 lines (209 loc) · 11 KB

armada app

All commands

Apps are long-running containers with replicas, rolling updates, and ingress. Deploy one from flags or a spec file; armada app show NAME -o yaml prints the spec it runs, ready for armada app deploy --file on any cluster.

Also: apps.

Command What it does
armada app delete Stop an app's replicas and delete it with its revisions and secrets
armada app deploy Create or change an app from flags or a spec file
armada app events Show what happened to apps: crashes, rollouts, placement
armada app exec Run a command in one of an app's replicas
armada app list List apps
armada app logs Print logs from an app's replicas
armada app rollback Roll an app back to an earlier revision
armada app show Show an app: its revision, replicas, and URLs
armada app top Show the CPU and memory apps and their replicas use
armada app traffic Split an app's requests between revisions until the next update

armada app delete

Stops serving the app, drains its replicas, and deletes it with its revisions and secrets. This cannot be undone. Its volumes and their data stay until armada volume delete, and creating the same name again finds them.

armada app delete APP --yes [flags]

Also: rm.

Flags:

Flag Meaning
--yes confirm deleting the app

armada app deploy

Create an app, or change one as a new revision rolled out like every change.

With flags, only what they name changes in the spec the app runs, and the deploy is refused when another change landed since that spec was read; a new app needs --image. With --file (- for stdin), the file replaces the whole spec. --new refuses an app that exists; --diff prints what would change and changes nothing. Flags cover what is changed often; the rest of the spec (custom probes, routes, secret files, volumes, init containers, sidecars, placement, traffic splitting) is written in a file.

armada app deploy APP [flags] | --file FILE

Examples:

armada app deploy hello --image traefik/whoami:v1.10 --port 80 --ingress external --min 2
armada app deploy web --image ghcr.io/acme/web:1.4.3 --wait
armada app deploy web --env LOG_LEVEL=debug --remove-env DEBUG
armada app deploy --file web.yaml --var TAG=1.4.2 --diff

Flags:

Flag Meaning
--args stringArray argument of the command: one per flag, kept as written (repeat it; "" clears)
--command stringArray command, replacing the image's entrypoint: one word per flag, kept as written (repeat it; "" clears)
--cors-origin stringArray origin browsers may call the app from, such as https://app.example.com, or * (repeatable; replaces the origins; methods, headers, and the rest in the spec file)
--cpu string CPU reserved and its limit, e.g. 250m or 1
--diff print what would change and change nothing
--dns-token-secret string app secret holding a Cloudflare API token: the custom domains get certificates through DNS-01 with it instead of HTTP-01
--domain stringArray custom domain (repeatable)
--env stringArray environment variable NAME=VALUE (repeatable)
--env-from stringArray give every key of a secret of the space as a variable (repeatable; replaces the list; "" clears)
--env-from-secrets give every key of the app's own secret as a variable (database-url becomes DATABASE_URL)
-f, --file string spec file, or - for stdin
--health-path string HTTP path that answers when the app is ready (empty to clear)
--idle-after duration with --min 0: stop the last replica after this long without a request, 1m to 24h (0 for the default, 15m)
--image string container image
--ingress string who reaches the app: external, internal, or none
--ip-allow stringArray RANGE[,name=NAME][,description=TEXT]: only clients from this address or prefix reach the app from outside (repeatable; replaces the list)
--ip-deny stringArray RANGE[,name=NAME][,description=TEXT]: clients from this address or prefix cannot reach the app from outside (repeatable; replaces the list)
--max int most replicas, with a --scale rule
--memory string memory limit, e.g. 256Mi
--min int replicas to run: a fixed count, or the fewest with a --scale rule
--new refuse a app that exists
--no-autoscale stop autoscaling: drop the scale rules and run --min (or the current minimum) replicas
--no-cors remove the app's CORS policy
--no-dns custom domains get certificates through HTTP-01 again
--no-ip-rules let every client reach the app again
--port int port the app listens on
--protocol string http (default) or tcp: a tcp app is internal only, reached by apps of its space at .internal:
--registry-secret string secret holding the private registry's password
--registry-user string user name for a private registry (the image's)
--remove-domain stringArray remove a custom domain (repeatable)
--remove-env stringArray remove an environment variable (repeatable)
--scale-cpu int autoscale to this percent of reserved CPU
--scale-http int autoscale to this many concurrent requests per replica
--scale-memory int autoscale to this percent of the memory limit
--secret-env stringArray environment variable from a secret: NAME=SECRET/KEY, or NAME=KEY of the app's own secret (repeatable)
--sticky keep each client on the replica that answered it first (--sticky=false to stop)
--timeout duration how long --wait waits (default 15m0s)
--var stringArray with --file: NAME=VALUE for ${NAME} in the spec (repeatable; wins over --vars)
--vars string with --file: file of NAME=VALUE lines for ${NAME} in the spec
--wait wait until the rollout completes; fail if it is aborted

armada app events

Show events from the last hour (or --since, at most 24h), oldest first: replicas scheduled, started, crashed, moved, or removed; rollouts started, completed, failed, or rolled back; apps that cannot be placed. Without APP, the events of the space's apps (every space's with -A). An event that repeats within 10 minutes is counted rather than shown again.

armada app events [APP] [flags]

Flags:

Flag Meaning
-f, --follow keep printing new events
-o, --output string output format: text or json (one event per line) (default text)
--since duration how far back to start (at most 24h) (default 1h0m0s)

armada app exec

Run a command in one of an app's replicas and exit with its exit code.

Without --replica, Armada picks a running, ready replica of the serving revision. -i passes standard input; -t allocates a terminal, so "armada app exec web -it -- sh" opens a shell. The command runs with the container's own user and security settings. --container NAME runs it in one of the replica's sidecars instead.

Exec is for diagnosis: changes made inside a container are lost when its replica is replaced. Each session is recorded in the audit log with the command's name, not its arguments.

armada app exec APP [--replica ID] [--container NAME] [-i] [-t] -- COMMAND [ARG...] [flags]

Flags:

Flag Meaning
--container string run in this sidecar instead of the app's own container
--replica string run in this replica
-i, --stdin pass standard input to the command
-t, --tty allocate a terminal

armada app list

List apps.

armada app list [flags]

Also: ls.

Flags:

Flag Meaning
-o, --output string output format: text or json (default text)

armada app logs

Print logs from an app's replicas.

armada app logs APP [flags]

Flags:

Flag Meaning
--container string show an init container or sidecar instead of the app's own container
-f, --follow stream new log lines, also from replicas that start later
--grep string only lines containing this text, ignoring case (plain text, not a pattern); also while following
--limit int with --since: the newest lines to show (default 500, at most 5000)
--replica string only show this replica
--since string search the log history from this long ago (2h, 3d) or this time (RFC 3339), across every node, including replicas that are gone
--tail int lines per replica to show (default 100)
--timestamps show when each line was written
--until string with --since: up to this long ago or this time (default now)

armada app rollback

Roll an app back to an earlier revision with a rolling update.

Without --to, a rollout in progress is cancelled; otherwise the app returns to the revision before the active one. Revisions keep their pinned image digest, so a rollback runs exactly the image that ran before. REVISION is a full name (web--r3) or its number (r3).

armada app rollback APP [--to REVISION] [flags]

Flags:

Flag Meaning
--timeout duration how long --wait waits (default 15m0s)
--to string the revision to return to (default: the one before the active one)
--wait wait until the rollout completes; fail if it is aborted

armada app show

Show an app: its revision, image, replicas, and URLs. -o yaml prints the spec it runs as a file holds it, ready for create --file or update --file.

armada app show APP [flags]

Flags:

Flag Meaning
-o, --output string output format: text, json, or yaml (the spec, as a file holds it) (default text)

armada app top

Show the CPU and memory replicas use, from samples their nodes take every 10 seconds.

Without arguments it lists the space's apps (every space's with -A); with APP, that app's replicas; with --spaces, every space, with the requests it received and the bytes it sent since the control plane's leader started counting. CPU is shown as used/reserved and memory as used/limit; "-" means no recent sample (the replica is not running, or its node's runtime cannot measure containers).

armada app top [APP] [flags]

Flags:

Flag Meaning
-o, --output string output format: text or json (default text)
--spaces list spaces instead of apps

armada app traffic

Split the requests of an app in multiple revision mode (revisions.mode: multiple) between its revisions until its next update. Weights are percent and add up to 100; a revision left out stops serving, and one with weight 0 is reached only through its label. Labels stay as the spec set them. REVISION is a full name (web--r3) or its number (r3).

armada app traffic APP REVISION=WEIGHT...

Examples:

armada app traffic web web--r3=90 web--r4=10
armada app traffic web r4=100