Users are people. Each has a certificate of their own and holds roles:
viewer, deployer, or admin in a space (viewer also over the whole cluster),
space-creator, or cluster-admin. Only cluster-admin manages access;
armada role list shows the roles and who holds them.
Also: users.
| Command | What it does |
|---|---|
armada user create |
Create a user with a certificate of their own |
armada user credentials |
Write a new client config for a user, revoking their older certificates |
armada user delete |
Delete a user and revoke every certificate of it |
armada user list |
List users and their roles |
armada user renew |
Renew the user certificate in your client config |
armada user show |
Show a user's roles and allowed node labels |
armada user update |
Replace the node labels a user's apps may require |
Create a user and write their client config to FILE: a certificate under
their own name (one year) for a key made here. Give them FILE privately; they
keep it as ~/.armada/config, mode 0600. --role gives a first role (in
--space for viewer, deployer, and admin); give more with
armada role grant. A user with no role can only renew.
armada user create NAME -o FILE [--role ROLE [--space P]] [--allow-label KEY=VALUE]... [flags]
Examples:
armada user create ana -o ana.config --role deployer --space shop
armada user create ops -o ops.config --role cluster-admin
armada user create ops -o ops.config --role cluster-admin --ssh ops@bastion.example.comFlags:
| Flag | Meaning |
|---|---|
--allow-label stringArray |
a node label KEY=VALUE its apps' placement may require (repeat for more) |
-o, --output string |
client config file to create |
--role string |
a first role: viewer, deployer, admin (with --space), space-creator, or cluster-admin |
--ssh ssh -W |
reach the servers through this SSH host ([user@]host or a ~/.ssh/config alias): ssh -W to their private addresses, mTLS inside |
Make a key here and a new certificate for user NAME (one year), and write their client config to FILE. Certificates the user was given before stop working: use it when a key is lost or leaked.
armada user credentials NAME -o FILE [flags]
Flags:
| Flag | Meaning |
|---|---|
-o, --output string |
client config file to create |
--ssh ssh -W |
reach the servers through this SSH host ([user@]host or a ~/.ssh/config alias): ssh -W to their private addresses, mTLS inside |
Revoke every certificate of the user, at once and on every server, and take its roles back. You cannot delete yourself.
armada user delete NAME --yes [flags]
Also: rm.
Flags:
| Flag | Meaning |
|---|---|
--yes |
confirm deleting |
List users and their roles.
armada user list [flags]
Also: ls.
Flags:
| Flag | Meaning |
|---|---|
-o, --output string |
output format: text or json (default text) |
Get a new one-year certificate for a new key, under the same name, and
rewrite the client config (--config, default ~/.armada/config, else
/etc/armada/admin.config, which needs sudo). Run it before the current
certificate expires: an expired one cannot renew. armadad doctor warns 30
days ahead. The old certificate stays valid until it expires. For one that
has expired, run armadad user renew as root on a server.
armada user renew
Show a user's roles and allowed node labels.
armada user show NAME [flags]
Flags:
| Flag | Meaning |
|---|---|
-o, --output string |
output format: text or json (default text) |
Replace the node label values the apps a user deploys may name in
placement.require (armada.* labels are always allowed): restricted nodes
can be kept for some spaces. Roles change with armada role grant and armada role revoke.
armada user update NAME (--allow-label KEY=VALUE... | --clear-labels) [flags]
Flags:
| Flag | Meaning |
|---|---|
--allow-label stringArray |
a node label KEY=VALUE its apps' placement may require (repeat for more) |
--clear-labels |
allow no node labels |