docker config ls コマンドで設定を一覧表示する方法

はじめに

この実験では、Docker の設定を管理するためにdocker config lsコマンドを効果的に使用する方法を学びます。まず、利用可能なすべての設定を一覧表示し、それらを作成して表示する方法を理解します。

さらに、--filterフラグを使用した強力なフィルタリング技術を探求し、名前やラベルで特定の設定を検索します。最後に、docker config lsコマンドの出力をフォーマットして、ニーズに最適な方法で情報を表示する方法を学びます。

Skills Graph

すべての設定を一覧表示

このステップでは、docker config lsコマンドを使用してすべての Docker 設定を一覧表示する方法を学びます。Docker 設定は、サービスからアクセス可能な機密データや設定ファイルを保存するために使用されます。

まず、簡単な設定を作成しましょう。ホームディレクトリにmy_config.txtという名前のファイルを作成し、サンプルコンテンツを追加します。

echo "This is a sample configuration." > ~/my_config.txt

次に、このファイルから Docker 設定を作成します。

docker config create my_config ~/my_config.txt

作成された設定の ID が出力として表示されるはずです。

これで、docker config lsコマンドを使用して利用可能なすべての Docker 設定を一覧表示できます。

docker config ls

このコマンドは、設定に関する情報（ID、Name、CreatedAt タイムスタンプなど）を含むテーブルを表示します。先ほど作成したmy_configがリストに表示されるはずです。

名前で設定をフィルタリング

このステップでは、docker config lsコマンドで--filterフラグとnameキーを使用して、Docker 設定を名前でフィルタリングする方法を学びます。これは多くの設定があり、特定の設定を見つけたい場合に便利です。

前のステップで、my_configという名前の設定を作成しました。フィルタリングを実演するためにもう 1 つ設定を作成しましょう。

まず、ホームディレクトリにanother_config.txtという新しいファイルを作成します。

echo "This is another configuration." > ~/another_config.txt

次に、このファイルから Docker 設定を作成します。

docker config create another_config ~/another_config.txt

新しく作成された設定の ID が表示されるはずです。

では、両方の設定を確認するため、すべての設定を再度一覧表示しましょう。

docker config ls

出力にはmy_configとanother_configの両方が表示されるはずです。

設定をフィルタリングしてmy_configという名前のものだけを表示するには、--filter name=my_configオプションを使用します。

docker config ls --filter name=my_config

このコマンドはmy_configという名前の設定のみを表示します。

同様に、another_configだけを表示するには次のコマンドを使用します：

docker config ls --filter name=another_config

これで、nameフィルターを使用して特定の設定を見つける方法が確認できました。

ラベルで設定をフィルタリング

このステップでは、docker config lsコマンドで--filterフラグとlabelキーを使用して、Docker 設定をラベルでフィルタリングする方法を学びます。ラベルは Docker オブジェクトに付与できるキーと値のペアで、オブジェクトを整理・分類するために使用されます。

まず、新しい設定を作成し、ラベルを追加しましょう。ホームディレクトリにlabeled_config.txtというファイルを作成します。

echo "This config has a label." > ~/labeled_config.txt

次に、このファイルから Docker 設定を作成し、--labelフラグを使用してenv=productionラベルを追加します。

docker config create --label env=production labeled_config ~/labeled_config.txt

作成された設定の ID が表示されるはずです。

別のラベルを持つ設定をもう 1 つ作成しましょう。another_labeled_config.txtというファイルを作成します。

echo "This config has a different label." > ~/another_labeled_config.txt

次に、env=developmentラベルを付けた Docker 設定を作成します。

docker config create --label env=development another_labeled_config ~/another_labeled_config.txt

では、新しく作成したラベル付きの設定を確認するため、すべての設定を一覧表示しましょう。

docker config ls

リストにlabeled_configとanother_labeled_configが表示されるはずです。

ラベルで設定をフィルタリングするには、--filter label=<キー>=<値>の形式を使用します。例えば、env=productionラベルを持つ設定を表示するには：

docker config ls --filter label=env=production

このコマンドはlabeled_configのみを表示します。

env=developmentラベルを持つ設定を表示するには：

docker config ls --filter label=env=development

これによりanother_labeled_configが表示されます。

また、値に関係なくラベルキーのみでフィルタリングすることも可能です。例えば、envラベルを持つすべての設定を表示するには：

docker config ls --filter label=env

これによりlabeled_configとanother_labeled_configの両方が表示されます。

設定リストの出力をフォーマットする

このステップでは、docker config lsコマンドの出力を--formatフラグを使用してフォーマットする方法を学びます。これにより、必要な情報のみを表示したり、JSON などの特定の形式で出力したりすることが可能になります。

デフォルトでは、docker config lsは表形式で出力します。

docker config ls

--formatフラグを使用して Go テンプレートを指定し、出力をフォーマットできます。例えば、設定の ID と名前のみを表示するには次のフォーマットを使用します：

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

このコマンドは各設定の ID と名前をタブ区切りで出力します。

JSON 形式でデータを出力することも可能で、スクリプト作成や他のツールとの連携に便利です。

docker config ls --format json

これにより、各要素が設定を表す JSON 配列が出力されます。

名前と作成時刻を表示する別のフォーマットも試してみましょう。

docker config ls --format "Config Name: {{.Name}}, Created At: {{.CreatedAt}}"

このコマンドは各設定に対して、名前と作成タイムスタンプを表示するカスタム文字列を出力します。

フォーマットに含めることができる他の利用可能なフィールドは、docker config inspect <config_id>で設定を検査することで確認できます。

例えば、my_configを検査して詳細を確認してみましょう。<config_id>はdocker config lsの出力から取得したmy_configの実際の ID に置き換えてください。

docker config inspect my_config

出力にはID、Name、CreatedAt、UpdatedAt、Spec、Versionなどの様々なフィールドが表示されます。これらのフィールド名を--format文字列で使用できます。

必要に応じて出力をカスタマイズするため、さまざまなフォーマット文字列を試してみてください。

まとめ

この実験では、docker config lsコマンドを使用して Docker 設定を一覧表示する方法を学びました。まずdocker config createでサンプル設定を作成し、docker config lsを使用して利用可能なすべての設定を表示し、ID、Name、CreatedAt タイムスタンプを確認しました。

さらに、--filterフラグを使用して一覧表示された設定をフィルタリングする方法を探求しました。特定の名前と一致する設定のみを表示するために--filter name=<config_name>で名前によるフィルタリングを行う方法を学びました。