docker stack ls
Description
List stacks
API 1.25+
The client and daemon API must both be at least
1.25
to use this command. Use the docker version
command on the client to check
your client and daemon API versions.
Usage
$ docker stack ls [OPTIONS]
Extended description
Lists the stacks.
Note
This is a cluster management command, and must be executed on a swarm manager node. To learn about managers and workers, refer to the Swarm mode section in the documentation.
For example uses of this command, refer to the examples section below.
Options
Name, shorthand | Default | Description |
--all-namespaces |
Kubernetes List stacks from all Kubernetes namespaces |
|
--format |
Pretty-print stacks using a Go template | |
--namespace |
Kubernetes Kubernetes namespaces to use |
|
--kubeconfig |
Kubernetes Kubernetes config file |
|
--orchestrator |
Orchestrator to use (swarm|kubernetes|all) |
Examples
The following command shows all stacks and some additional information:
$ docker stack ls
ID SERVICES ORCHESTRATOR
myapp 2 Kubernetes
vossibility-stack 6 Swarm
Formatting
The formatting option (--format
) pretty-prints stacks using a Go template.
Valid placeholders for the Go template are listed below:
Placeholder | Description |
---|---|
.Name |
Stack name |
.Services |
Number of services |
.Orchestrator |
Orchestrator name |
.Namespace |
Namespace |
When using the --format
option, the stack ls
command either outputs
the data exactly as the template declares or, when using the
table
directive, includes column headers as well.
The following example uses a template without headers and outputs the
Name
and Services
entries separated by a colon (:
) for all stacks:
$ docker stack ls --format "{{.Name}}: {{.Services}}"
web-server: 1
web-cache: 4
Parent command
Command | Description |
---|---|
docker stack | Manage Docker stacks |
Related commands
Command | Description |
docker stack deploy | Deploy a new stack or update an existing stack |
docker stack ls | List stacks |
docker stack ps | List the tasks in the stack |
docker stack rm | Remove one or more stacks |
docker stack services | List the services in the stack |