Skip to content

satl stack

Manage stacks — Docker's docker stack verbs on SatL's compose machinery (a stack is one compose file's services and networks)

$ satl stack [OPTIONS] <COMMAND>

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

satl stack deploy

Deploy a Compose file as a stack (or update the one running)

$ satl stack deploy [OPTIONS] <STACK>

Arguments

Argument Description
<STACK> The stack name

Options

Option Description
-c, --compose-file <FILE> Compose file to deploy (default: discovered walking up from the working directory)
--prune Prune services that are no longer in the file. Default true, as Docker's stack deploy — unlike satl compose up, where pruning is the explicit --remove-orphans

satl stack ls

List the stacks running on the cluster

$ satl stack ls [OPTIONS]

Takes no arguments or options of its own.

satl stack services

List the services of a stack

$ satl stack services [OPTIONS] <STACK>

Arguments

Argument Description
<STACK> The stack name

satl stack ps

List the tasks of a stack

$ satl stack ps [OPTIONS] <STACK>

Arguments

Argument Description
<STACK> The stack name

Options

Option Description
--no-trunc Don't truncate output
-q, --quiet Only display task IDs

satl stack rm

Remove one or more stacks

$ satl stack rm [OPTIONS] <STACK>...

Arguments

Argument Description
<STACK>... The stacks to remove

satl stack config

Print what deploy would create, without creating it

$ satl stack config [OPTIONS]

Options

Option Description
-c, --compose-file <FILE> Compose file to read (default: discovered walking up)

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.