docker config ls

読む時間の目安: 3 分

説明

config の一覧を表示します。

API 1.30 以上このコマンドを利用するには、クライアントとデーモンの API はともに、最低でも 1.30 である必要があります。クライアント上においてdocker versionコマンドを実行して、クライアントとデーモンの API バージョンを確認してください。

Swarm このコマンドは Swarm オーケストレーターにおいて動作します。

利用方法

$ docker config ls [オプション]

追加説明

このコマンドをマネージャーノード上から実行して Swarm 内の config を一覧表示します。

config 利用の詳細については Docker configs を利用した設定データの保存を参照してください。

メモ

これはクラスター管理コマンドです。したがって Swarm 上のマネージャーノードにおいて実行する必要があります。マネージャーノードやワーカーノードについては、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）の指定書式は「キー=値」とペアです。複数のフィルターが必要な場合は、フラグを複数指定します。（たとえば--filter "foo=bar" --filter "bif=baz"など。）

現在サポートされているフィルターは以下のとおりです。

id （config の ID）
label （label=<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とその値が存在する config を検索します。

以下の例では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という値を持つ config が抽出されます。

$ docker service ls --filter label=project=test

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

name フィルター

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）は以下のとおりです。

プレースホルダー	内容説明
`.ID`	config の ID。
`.Name`	config 名。
`.CreatedAt`	config 生成時刻。
`.UpdatedAt`	config 更新時刻。
`.Labels`	config に割り当てられているラベルすべて。
`.Label`	config に対する指定ラベルの値。たとえば`{{.Label "my-label"}}`

--formatオプションを利用するとconfig lsコマンドは、テンプレートが定めるデータを直接出力します。またtableディレクティブを利用すると、カラムヘッダーも同時に出力されます。

以下は、ヘッダーを含めずにテンプレートを利用する例です。すべての config におけるID、Nameの各項目がコロン（:）で区切られて表示されます。

$ 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 config を管理します。

コマンド	説明
docker config create	ファイルまたは標準入力から config を生成します。
docker config inspect	1 つまたは複数の Config についての詳細情報を表示します。
docker config ls	config の一覧を表示します。
docker config rm	1 つまたは複数の Config を削除します。