docker config ls
| 内容説明 | config を一覧表示します。 |
|---|---|
| 利用方法 | docker config ls [OPTIONS] |
| エイリアス | docker config list |
Swarm このコマンドは Swarm オーケストレーターにおいて動作します。
内容説明
このコマンドをマネージャーノード上から実行して Swarm 内の config を一覧表示します。
config 利用の詳細については Docker configs を利用した設定データの保存 を参照してください。
メモ
これはクラスター管理コマンドであるため、Swarm のマネージャーノード上で実行する必要があります。 マネージャーノードとワーカーノードについては、本ドキュメントの Swarm モード を参照してください。
オプション
| オプション | デフォルト | 内容説明 |
|---|---|---|
-f, --filter | 指定された条件に基づいてフィルター検索を行います。 | |
--format | カスタムテンプレートを使って出力をフォーマットします。 'table': カラムヘッダー付きの表形式により出力します。(デフォルト) 'table TEMPLATE': 指定された Go テンプレートを使って表形式により出力します。 'json': JSON 書式により出力します。 'TEMPLATE': 指定された Go テンプレートを使って出力します。 テンプレートを使ったフォーマット出力の詳細は https://matsuand.github.io/docker.docs-ja/engine/cli/formatting/ を参照してください。 | |
-q, --quiet | 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)
フィルターフラグ (-f or --filter) の書式は key=value ペアとして指定します。
フィルターが複数必要な場合は、フラグを複数回指定します (たとえば --filter "foo=bar" --filter "bif=baz" とします)。
現在サポートされているフィルターは以下のとおりです。
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 のみが存在する config か、あるいは 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)
フォーマットオプション (--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