docker config inspect コマンドで設定詳細を確認する方法

はじめに

この実験では、Docker config（設定）の詳細情報を確認するためにdocker config inspectコマンドを使用する方法を学びます。まず、ファイルから Docker config を作成します。これは Docker swarm 内で非機密な設定データを管理するための基本的な手順です。

作成後、作成した config を名前と一意の ID の両方を使用して検査する方法を探求し、設定の詳細にアクセスするさまざまな方法を実証します。最後に、docker config inspectコマンドの出力を--formatフラグを使用してフォーマットし、表示される情報をカスタマイズする方法を学びます。

Skills Graph

Docker config の作成

このステップでは、Docker config を作成する方法を学びます。Docker config は、swarm 内のサービスからアクセス可能な設定ファイルなどの非機密情報を保存するために使用されます。

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

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

次に、docker config create コマンドを使用してこのファイルから Docker config を作成します。基本的な構文は docker config create <config_name> <file_path> です。

docker config create my_config ~/project/my_config.txt

新しく作成された config の ID がコンソールに表示されるはずです。これは config が正常に作成されたことを示しています。

config が作成されたことを確認するには、docker config ls コマンドを使用してすべての Docker config を一覧表示できます。

docker config ls

出力には my_config とその ID、作成時刻が表示されるはずです。

名前で config を確認する

このステップでは、Docker config を名前を使って確認する方法を学びます。docker config inspectコマンドを使用すると、特定の config の詳細情報を表示できます。

前のステップで作成したmy_configを確認するには、docker config inspectコマンドの後に config 名を指定します。

docker config inspect my_config

このコマンドは、my_configに関する様々な詳細情報（ID、作成時刻、設定データの内容など）を含む JSON オブジェクトを出力します。

出力には config のプロパティが包括的に表示されます。ID、CreatedAt、UpdatedAt、Spec、Versionフィールドを確認できます。Specフィールドには、base64 エンコードされた実際の設定データが含まれています。

ID で config を確認する

このステップでは、Docker config を ID を使って確認する方法を学びます。名前で確認する方法は便利ですが、ID を使用することも可能で、特定のシナリオで有用です。

まず、前に作成したmy_configの ID を取得しましょう。docker config lsコマンドの出力から ID を取得できます。

docker config ls

出力のmy_configエントリにあるID列を探し、この ID をコピーしてください。

次に、コピーした config ID を指定してdocker config inspectコマンドを実行します。<config_id>を実際の ID に置き換えてください。

docker config inspect <config_id>

例えば、ID がabc123def456の場合、コマンドは次のようになります：

docker config inspect abc123def456

このコマンドは、名前で確認した場合と同じ詳細な JSON 出力を生成し、config のプロパティに関する情報を提供します。

ID による確認は、類似した名前の複数の config がある場合や、config ID に依存するスクリプトを操作する場合に特に有用です。

--format を使用した出力のフォーマット

このステップでは、docker config inspectコマンドの出力を--formatフラグを使用してフォーマットする方法を学びます。これは JSON 出力から特定の情報をより読みやすい形式で抽出したい場合に便利です。

--formatフラグは Go の text/template パッケージを使用します。表示したいフィールドとそのフォーマット方法を指定できます。

my_configの ID と作成時刻のみを表示してみましょう。フォーマット文字列として{{.ID}} {{.CreatedAt}}を使用します。

docker config inspect --format '{{.ID}} {{.CreatedAt}}' my_config

このコマンドは、my_configの ID と作成時刻をスペース区切りで出力します。

JSON 出力内のネストされたフィールドにもアクセスできます。例えば、Spec.Name配下にある config の名前にアクセスするには、{{.Spec.Name}}を使用します。

config の名前と base64 エンコードされたデータを表示してみましょう。

docker config inspect --format 'Name: {{.Spec.Name}}, Data: {{.Spec.Data}}' my_config

このコマンドは、config の名前と base64 エンコードされたデータをより構造化された形式で出力します。

--formatフラグは、Docker コマンドの出力をカスタマイズし、必要な情報を抽出するための強力なツールです。

まとめ

この実験では、docker config createコマンドを使用してファイルから Docker config を作成し、docker config lsで作成を確認する方法を学びました。その後、docker config inspectコマンドを使用して Docker config の詳細情報を表示する方法を確認し、config 名を指定して確認する方法を実践しました。