docker plugin ls コマンドを使ってプラグインを一覧表示する方法

はじめに

この実験では、docker plugin ls コマンドを使用して Docker プラグインを管理および表示する方法を学びます。インストールされているすべてのプラグインを一覧表示する基本的な手順、有効化されている状態に基づいてリストをフィルタリングする方法、およびプラグインの機能に基づいて出力をさらに絞り込む方法を説明します。最後に、Go テンプレートを使用してプラグインの出力をカスタマイズした表示形式に整形する方法を学びます。この実践的な体験を通じて、環境内の Docker プラグインを効果的に調査および管理するスキルを身につけることができます。

Skills Graph

インストールされているすべてのプラグインを一覧表示する

このステップでは、システムにインストールされているすべての Docker プラグインを一覧表示する方法を学びます。Docker プラグインは Docker の機能を拡張し、ボリューム管理、ネットワーキング、ロギングなどの機能を提供します。

インストールされているプラグインを一覧表示するには、docker plugin ls コマンドを使用できます。このコマンドは、インストールされている各プラグインに関する情報（ID、名前、説明、有効化状態など）が記載された表を表示します。

インストールされているプラグインを確認するために、コマンドを実行してみましょう。

docker plugin ls

次のような出力が表示されるはずです（正確な出力は環境によって異なります）。

ID    NAME    DESCRIPTION    ENABLED

デフォルトの LabEx 環境では、デフォルトでプラグインがインストールされていない場合があります。上記の出力は空のリストを示しており、現在プラグインがインストールされていないことを意味します。プラグインがインストールされている場合は、ここに一覧表示されます。

有効化状態に基づいてプラグインをフィルタリングする

このステップでは、Docker プラグインのリストを有効化状態に基づいてフィルタリングする方法を学びます。現在アクティブまたは非アクティブなプラグインのみを表示したい場合に便利です。

docker plugin ls コマンドに --filter フラグを使用することで、出力をフィルタリングできます。有効化状態のフィルタキーは enabled です。値を true に設定すると有効化されたプラグインのみを表示し、false に設定すると無効化されたプラグインのみを表示します。

この環境ではデフォルトでプラグインがインストールされていないため、有効化状態でフィルタリングしても空のリストになります。ただし、コマンドの構造を紹介しましょう。

有効化されたプラグインのみを一覧表示するには、次のコマンドを使用します。

docker plugin ls --filter enabled=true

出力は次のようになります。

ID    NAME    DESCRIPTION    ENABLED

無効化されたプラグインのみを一覧表示するには、次のコマンドを使用します。

docker plugin ls --filter enabled=false

出力も同様に次のようになります。

ID    NAME    DESCRIPTION    ENABLED

この環境では出力が空ですが、--filter enabled= フラグの使い方を理解することは、プラグインがインストールされている環境でのプラグイン管理に重要です。

機能 (capability) に基づいてプラグインをフィルタリングする

このステップでは、Docker プラグインをその機能 (capability) に基づいてフィルタリングする方法を探ります。プラグインは、ボリューム管理用の volumedriver、ネットワーキング用の networkdriver、ロギング用の logdriver など、さまざまな機能を持つことができます。機能でフィルタリングすることで、特定の機能を提供するプラグインを見つけることができます。

有効化状態でのフィルタリングと同様に、docker plugin ls コマンドに --filter フラグを使用します。機能のフィルタキーは capability です。値として希望する機能を指定できます。

この環境にはプラグインがインストールされていないため、機能でフィルタリングしても空のリストになります。ただし、コマンドの構造を見てみましょう。

volumedriver 機能を持つプラグインを一覧表示するには、次のコマンドを使用します。

docker plugin ls --filter capability=volumedriver

出力は次のようになります。

ID    NAME    DESCRIPTION    ENABLED

networkdriver 機能を持つプラグインを一覧表示するには、次のコマンドを使用します。

docker plugin ls --filter capability=networkdriver

出力も同様に次のようになります。

ID    NAME    DESCRIPTION    ENABLED

機能でフィルタリングする方法を理解することは、Docker 環境の特定の要件を満たすプラグインを特定するのに役立ちます。

テンプレートを使用してプラグインの出力をフォーマットする

このステップでは、Go テンプレートを使用して docker plugin ls コマンドの出力をフォーマットする方法を学びます。これにより、必要な情報のみを特定の形式で表示するように出力をカスタマイズできます。

--format フラグを使用してテンプレートを指定します。.ID、.Name、.Description、.Enabled などのプレースホルダーを使用して、各プラグインのさまざまなフィールドにアクセスできます。

出力をフォーマットして、コロンで区切られたプラグイン名とその有効化状態のみを表示することを試してみましょう。

docker plugin ls --format "{{.Name}}: {{.Enabled}}"

プラグインがインストールされていないため、出力は空になります。ただし、プラグインがある場合、出力は次のようになります。

my-plugin: true
another-plugin: false

他の情報を含めたり、出力を別の形式で表示したりするために、より複雑なテンプレートを作成することもできます。たとえば、ID と説明を表示するには、次のようにします。

docker plugin ls --format "ID: {{.ID}}, Description: {{.Description}}"

再び、この環境では出力は空になります。

--format フラグを使用することは、Docker コマンドの出力を特定のニーズに合わせる強力な方法であり、情報の解析と処理が容易になります。

まとめ

この実験では、docker plugin ls コマンドを使用して Docker プラグインを管理する方法を学びました。まず、インストールされているすべてのプラグインを一覧表示し、デフォルトの環境では事前にインストールされたプラグインがない可能性があることを理解しました。次に、--filter enabled= フラグを使用して、プラグインの有効化状態に基づいてプラグインのリストをフィルタリングする方法を調べました。これにより、インストールされたプラグインがない環境でも、有効または無効なプラグインのみを表示する方法を実証しました。