docker config ls

説明

1つもしくは複数の設定情報を詳細に表示します。

  • 【API 1.30+】このコマンドを使うには、クライアントとデーモン API の両方が、少なくとも 1.30 の必要があります。
  • 【Swarm】このコマンドは Swarm オーケストレータと動作します。

使い方

$ docker config ls [OPTIONS]

補足説明

swarm の設定一覧を表示するために、manager ノード上でこのコマンドを実行します。

設定を使うための詳細情報は、 Docker Config を使って設定データを保管 を参照ください。

注釈

これはクラスタ管理コマンドであり、 swarm manager ノードで実行する必要があります。manager と worker について学ぶには、ドキュメント内の Swarm モードのセクション を参照ください。

コマンドの使用例は、以下の 使用例のセクション をご覧ください。

オプション

名前, 省略形 デフォルト 説明
--filter , -f   指定した状態に基づき出力をフィルタ
--format   指定した Go テンプレートで出力
--quiet, -q   ID のみ表示

使用例

$ docker config ls

ID                          NAME                        CREATED             UPDATED
6697bflskwj1998km1gnnjr38   q5s5570vtvnimefos1fyeo2u2   6 weeks ago         6 weeks ago
9u9hk4br2ej0wgngkga6rp4hq   my_config                   5 weeks ago         5 weeks ago
mem02h8n73mybpgqjf0kfi1n0   test_config                 3 seconds ago       3 seconds ago

フィルタリング

フィルタリングのフラグ( -f, --filter )形式は、 key=value のペアです。複数のフィルタを使いたいバイアは、複数のフラグを使います(例: --filter "foo=bar" --filter "bif=baz" )。

現在は以下のフィルタをサポートしています。

  • id (config の ID)
  • labellabel=<key> または label=<key>=<value>
  • name (config の名前)

id

id は、config の ID の前方もしくは全てに一致するフィルタをします。

$ docker config ls -f "id=6697bflskwj1998km1gnnjr38"

ID                          NAME                        CREATED             UPDATED
6697bflskwj1998km1gnnjr38   q5s5570vtvnimefos1fyeo2u2   6 weeks ago         6 weeks ago

label

label では、 label 単独の存在、もしくは label と値に基づいてフィルタします。

以下は、ラベルの値にかかわらず、 project ラベルに一致する全ての config をフィルタします。

$ docker config ls --filter label=project

ID                          NAME                        CREATED             UPDATED
mem02h8n73mybpgqjf0kfi1n0   test_config                 About an hour ago   About an hour ago

以下のフィルタに一致するのは、 ラベルが project で値が project-a のサービスのみです。

$ docker service ls --filter label=project=test
ID                          NAME                        CREATED             UPDATED
mem02h8n73mybpgqjf0kfi1n0   test_config                 About an hour ago   About an hour ago

name では、config 名の前方もしくは全体に一致するフィルタをします。

以下のフィルタは test で始まる名前の config にマッチします。

$ docker config ls --filter name=test_config

ID                          NAME                        CREATED             UPDATED
mem02h8n73mybpgqjf0kfi1n0   test_config                 About an hour ago   About an hour ago

出力形式

出力形式のオプション( --format )は Go テンプレートを用いて出力を調整し、表示を整えます。

有効な Go テンプレートの placeholder は以下の通りです。

placeholder 説明
.ID config ID
.Name config 名
.CreateAt config が作成された時間
.UpdateAt config が更新された時間
.Labels config に割り当てられた全てのラベル
.Label この config に対する特定のラベル値。例 {{.Label "my-label"}}

--format オプションを使うと、 config ls コマンドはテンプレート宣言通りに正確にデータを出力するか、 table ディレクティブによってヘッダ列も同様に表示するかのいずれかです。

以下の例では、ヘッダのないテンプレートを使いますが、全てのイメージに対して IDName の項目をコロン : で分けて表示します。

$ docker config ls --format "{{.ID}}: {{.Name}}"

77af4d6b9913: config-1
b6fa739cedf5: config-2
78a85c484f71: config-3

全ての config に対する名前と作成日を表形式で表示するには、次のようにします。

$ docker config ls --format "table {{.ID}}\t{{.Name}}\t{{.CreatedAt}}"

ID                  NAME                      CREATED
77af4d6b9913        config-1                  5 minutes ago
b6fa739cedf5        config-2                  3 hours ago
78a85c484f71        config-3                  10 days ago

親コマンド

コマンド 説明
docker config Docker 設定を管理

関連コマンド

コマンド 説明
docker compose ファイルか STDIN から設定を作成
docker compose 1つもしくは複数の設定情報を詳細表示
docker compose 設定一覧
docker compose 1つもしくは複数の設定を削除