docker stack ls
読む時間の目安: 2 分
説明
Stack の一覧を表示します。
API 1.25 以上
このコマンドを利用するには、クライアントとデーモンの API はともに、最低でも
1.25
である必要があります。
クライアント上においてdocker version
コマンドを実行して、クライアントとデーモンの API バージョンを確認してください。
利用方法
$ docker stack ls [OPTIONS]
追加説明
stack の一覧を表示します。
メモ
これはクラスター管理コマンドです。 したがって Swarm 上のマネージャーノードにおいて実行する必要があります。 マネージャーノードやワーカーノードについては、Swarm モード を参照してください。
本コマンドの利用例については、以下に示す 利用例の節 を参照してください。
オプション
名前/省略形 | デフォルト | 説明 |
--all-namespaces |
deprecatedKubernetes Kubernetes 名前空間のすべてから Stack を一覧表示します。 |
|
--format |
Go 言語テンプレートを使って出力をフォーマットします。 | |
--namespace |
deprecatedKubernetes 対象とする Kubernetes 名前空間を指定します。 |
|
--kubeconfig |
deprecatedKubernetes Kubernetes 設定ファイルを指定します。 |
|
--orchestrator |
deprecated 利用するオーケストレーターを指定します。(swarm|kubernetes|all) |
利用例
以下のコマンドは、すべての Stack と追加情報を表示します。
$ docker stack ls
ID SERVICES ORCHESTRATOR
myapp 2 Kubernetes
vossibility-stack 6 Swarm
フォーマット設定
フォーマット設定オプション(--format
)により Go 言語のテンプレートを利用して、Stack をわかりやすく出力することができます。
Go 言語テンプレートによるプレースホルダー(placeholder)は以下のとおりです。
プレースホルダー | 内容説明 |
---|---|
.Name |
Stack 名 |
.Services |
サービス数 |
.Orchestrator |
オーケストレーター名 |
.Namespace |
名前空間 |
--format
オプションを利用するとstack ls
コマンドは、テンプレートが定めるデータを直接出力します。
またtable
ディレクティブを利用すると、カラムヘッダーも同時に出力されます。
以下は、ヘッダーを含めずにテンプレートを利用する例であり、すべての Stack におけるName
、Services
の各項目がコロン(:
)で区切って表示されます。
$ docker stack ls --format "{{.Name}}: {{.Services}}"
web-server: 1
web-cache: 4
上位コマンド
コマンド | 説明 |
---|---|
docker stack | Docker Stack を管理します。 |
関連コマンド
コマンド | 説明 |
docker stack deploy | 新規 Stack のデプロイ、または既存 Stack の更新を行います。 |
docker stack ls | Stack の一覧を表示します。 |
docker stack ps | Stack 内のタスク一覧を表示します。 |
docker stack rm | Stack を削除します。 |
docker stack services | Stack 内のサービスを一覧表示します。 |