Sebastiaan van Stijn f30bde6adb
remove unneeded comment from reference files
these markdown files are not consumed directly in the docs,
but only their content is included through the YAML does,
so there's no need to have these comments in them

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-19 15:15:23 +01:00

2.0 KiB

title, description, keywords
title description keywords
stack ls The stack ls command description and usage stack, ls

stack ls

Usage:	docker stack ls [OPTIONS]

List stacks

Aliases:
  ls, list

Options:
      --help                  Print usage
      --format string         Pretty-print stacks using a Go template
      --kubeconfig string     Kubernetes config file
      --namespace string      Kubernetes namespace to use
      --orchestrator string   Orchestrator to use (swarm|kubernetes|all)

Description

Lists the stacks.

Note

: This is a cluster management command. When using swarm as an orchestrator, this command must be executed on a swarm manager node. To learn about managers and workers, refer to the Swarm mode section in the documentation.

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