docker plugin inspect コマンドを使ってプラグインの詳細を表示する方法

はじめに

この実験では、docker plugin inspect コマンドを使用して Docker プラグインの詳細情報を表示する方法を学びます。まず、特定のプラグインを調査して、デフォルトの JSON 出力を確認します。この出力には、プラグインの構成と状態に関する包括的な詳細が含まれています。

その後、--format フラグと Go の text/template パッケージを使用して、docker plugin inspect コマンドの出力を整形する方法を学びます。これにより、プラグインの詳細情報から特定の情報を抽出し、より読みやすくカスタマイズした形式で表示することができます。

Skills Graph

特定のプラグインを調査する

このステップでは、特定の Docker プラグインを調査する方法を学びます。docker plugin inspect コマンドを使用すると、プラグインの構成、設定、状態など、詳細な情報を表示できます。

まず、調査できるプラグインを確認するために、利用可能なプラグインのリストを表示しましょう。これには docker plugin ls コマンドを使用できます。

docker plugin ls

インストールされているプラグインのリストが表示されるはずです。この例では、vieux/sshfs:latest プラグインを調査します。このプラグインがリストに表示されない場合は、まず docker plugin install vieux/sshfs:latest を使用してインストールできます。

では、docker plugin inspect コマンドにプラグイン名を続けて、vieux/sshfs:latest プラグインを調査しましょう。

docker plugin inspect vieux/sshfs:latest

このコマンドは、vieux/sshfs:latest プラグインに関するすべての詳細を含む大きな JSON オブジェクトを出力します。この出力には、プラグイン ID、名前、有効状態、構成などの情報が含まれます。

プラグイン調査の出力を整形する

前のステップで、docker plugin inspect のデフォルト出力が大きな JSON オブジェクトであることを確認しました。これは詳細な分析には便利ですが、すぐに読むのは難しい場合があります。Docker は --format フラグを提供しており、Go の text/template パッケージを使用して出力を整形することができます。これは非常に強力で、特定の情報を抽出したり、出力をカスタム形式で表示したりすることができます。

--format フラグを使用して、プラグインの ID と名前だけを抽出してみましょう。JSON 出力からこれらのプロパティにアクセスするために、{{.ID}} と {{.Name}} のテンプレートフィールドを使用します。

docker plugin inspect --format 'ID: {{.ID}}, Name: {{.Name}}' vieux/sshfs:latest

このコマンドは、ID: <plugin_id>, Name: vieux/sshfs:latest のような文字列を出力します。ここで <plugin_id> はプラグインの実際の ID です。特定の情報だけが必要な場合、これははるかに簡潔で読みやすくなります。

--format フラグを使用して、より複雑な出力を作成することもできます。たとえば、プラグインの名前と有効状態を表示してみましょう。有効状態はブール値であり、{{.Enabled}} を使用してアクセスできます。

docker plugin inspect --format 'Plugin: {{.Name}}, Enabled: {{.Enabled}}' vieux/sshfs:latest

これにより、プラグインの状態に応じて、Plugin: vieux/sshfs:latest, Enabled: true または Plugin: vieux/sshfs:latest, Enabled: false のような出力が表示されます。

--format フラグは、Docker コマンドの出力をカスタマイズするための非常に柔軟なツールです。デフォルトの inspect コマンドからの JSON 出力の構造を調べることで、整形した出力に含めたい他のフィールドを見つけることができます。

まとめ

この実験では、docker plugin inspect コマンドを使用して Docker プラグインの詳細情報を表示する方法を学びました。まず、このコマンドのデフォルト出力を調べました。この出力は、ID、名前、構成などの様々なプラグインの詳細を含む包括的な JSON オブジェクトを提供します。

次に、--format フラグと Go の text/template パッケージを使用して、docker plugin inspect の出力を整形する方法を学びました。この強力な機能により、プラグインの ID や名前などの特定の情報を抽出し、より読みやすくカスタマイズした形式で表示することができ、目的の詳細情報をすぐに取得することが容易になります。