Skip to content

satl swarm

Manage the swarm. satl cluster is an accepted alias: the docker verb is kept for compatibility, the alias reads better in SatL's own docs

Alias

satl swarm is also spelled satl cluster. Both are the same command; this reference documents the canonical spelling.

$ satl swarm [OPTIONS] <COMMAND>

satl swarm is a group: it always takes one of the subcommands below.

satl swarm init

Initialize a swarm

$ satl swarm init [OPTIONS]

Options

Option Description
--advertise-addr <ADDR> Advertised address (format: <ip\|interface>[:port])
--listen-addr <ADDR> Listen address (format: <ip\|interface>[:port])
--force-new-cluster Force create a new cluster from the current state
--autolock Lock the managers' keys behind an unlock key, shown once

satl swarm join

Join a swarm as a node and/or manager

$ satl swarm join [OPTIONS] --token <TOKEN> <HOST:PORT>

Arguments

Argument Description
<HOST:PORT> Address of an existing manager (<ip>:<port>)

Options

Option Description
--token <TOKEN> Token for entry into the swarm
--advertise-addr <ADDR> Advertised address (format: <ip\|interface>[:port])
--listen-addr <ADDR> Listen address (format: <ip\|interface>[:port])

satl swarm leave

Leave the swarm

$ satl swarm leave [OPTIONS]

Options

Option Description
-f, --force Force this node to leave the swarm, ignoring warnings

satl swarm update

Update swarm settings

$ satl swarm update [OPTIONS]

Options

Option Description
--autolock <true|false> Turn manager autolock on or off (--autolock=true\|false)
Values: true, false

satl swarm join-token

Manage join tokens

$ satl swarm join-token [OPTIONS] <worker|manager>

Arguments

Argument Description
<worker|manager> Which token to show
Values: worker, manager

Options

Option Description
--rotate Rotate the join token
-q, --quiet Only display the token

satl swarm unlock

Unlock a locked manager

$ satl swarm unlock [OPTIONS]

Options

Option Description
--key <KEY> The unlock key, base64. Without the flag, one line is read from stdin (pipe it, or type it in)

satl swarm unlock-key

Display or rotate the manager unlock key

$ satl swarm unlock-key [OPTIONS]

Options

Option Description
--rotate Rotate the unlock key; every manager reseals
-q, --quiet Only display the key

Global options

Accepted by every satl command.

Option Description
--host <URL> Daemon socket to connect to (docker-style URL)
Default: unix:///var/run/satl.sock
Environment: DOCKER_HOST
-h, --help Print help
-V, --version Print version

Generated from satl 0.1.0 by make gen. Change it in the SatL source or in overlay/cli.yml, never here.