Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 2.86 KB

armada-server.md

File metadata and controls

84 lines (58 loc) · 2.86 KB

armada server

All commands

List and delete control plane servers, and create tokens that add them. A server runs on its machine with armadad server, and joins with armadad server join.

Also: servers.

Command What it does
armada server delete Delete a control plane server
armada server join-token Create a single-use token that adds a control plane server, and print the join command
armada server list List control plane servers and update the client config with them

armada server delete

Delete a control plane server from the cluster. Stop armadad server on it first. Its agent stays a node; delete that with armada node delete. The leader cannot delete itself: stop it, and run this once another server leads.

A removed server still holds copies of the cluster CA key and master key: wipe its data directory.

armada server delete NAME

Also: rm.

armada server join-token

Create a single-use join token and print the command to run on the new node.

The token is a credential: anyone holding it before it expires can add a node. Send it over a trusted channel. Only a hash is stored on the server.

In a mesh cluster (armadad init --network mesh), and for a machine of another site than the leader's (--site, ADR 0050), the join listener faces the public on the leader's endpoint, open only while such a token is unused and unexpired: these tokens last 10 minutes by default and at most an hour, and --from makes the listener answer only the address the machine joins from.

A server token hands the new server the cluster CA key and the secrets master key: it lasts 15 minutes by default (10 over the leader's public address) and at most an hour.

A server may join another site than the leader's (--site): its etcd member and API are reached over WireGuard between the sites. Every write waits for a majority of servers, so keep the servers in one site, or in sites close together.

armada server join-token [flags]

Flags:

Flag Meaning
--from string joins over the leader's public address (mesh clusters, other sites): the IP address the machine joins from; the join listener answers no other
--label stringArray label KEY=VALUE for the node that joins with the token (repeatable)
--site string the site the machine joins (ADR 0050); default: the cluster's first site
--ttl duration token lifetime (1m to 1h; default 15m, 10m over the leader's public address)

armada server list

List control plane servers and update the client config with them.

armada server list [flags]

Also: ls.

Flags:

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