Skip to content

Latest commit

 

History

History
112 lines (77 loc) · 2.98 KB

armada-space.md

File metadata and controls

112 lines (77 loc) · 2.98 KB

armada space

All commands

Spaces hold apps, jobs, secrets, domains, and volumes (ADR 0026). Names only need to be unique within a space. Every cluster has the space default, which holds everything deployed without --space.

Commands work in the space armada space use saved, or the one --space (or ARMADA_SPACE) names, else default. An app of another space can also be named NAME.SPACE, which is how events and the internal host name (NAME.SPACE.internal) show it. Lists take -A for every space.

On a cluster with a cluster network, containers reach other apps only through their internal names, resolve only their own space's names, and the containers of every space but default are kept away from the nodes, the private network, and the cloud's metadata service (network isolation; for default, turn it on with armada space update default --network-isolation).

Also: spaces.

Command What it does
armada space create Create a space
armada space delete Delete an empty space
armada space list List spaces
armada space show Show a space's settings
armada space update Change a space's settings
armada space use Work in a space: commands without --space use it

armada space create

Create a space.

armada space create NAME

armada space delete

Delete a space. It must be empty: delete its apps, jobs, secrets, and volumes first. The default space cannot be deleted.

armada space delete NAME

Also: rm.

armada space list

List spaces.

armada space list [flags]

Also: ls.

Flags:

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

armada space show

Show a space's settings.

armada space show NAME [flags]

Flags:

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

armada space update

Change a space's settings (cluster-admin only).

--network-isolation keeps the space's containers away from the nodes, the control plane, the private network, and the cloud's metadata service: they reach the internet, their node's DNS server, and internal and public ingress (ADR 0026). Every space but default always has it; turn it on for default once its apps no longer need the private network. It needs the cluster network.

armada space update SPACE --network-isolation[=false] [flags]

Flags:

Flag Meaning
--network-isolation keep the space's containers away from the platform and the private network

armada space use

Save NAME in the client config (--config) as the space commands work in when neither --space nor ARMADA_SPACE names one. armada space use default goes back to the default space.

armada space use NAME