docker desktop engine ls コマンドで利用可能なエンジンを一覧表示する方法

はじめに

この実験では、利用可能な Docker エンジンを一覧表示するdocker desktop engine lsコマンドの使用方法を学びます。まず、このコマンドの目的と、クラウド VM 環境内で Docker デーモンとどのように連携するかを理解します。

導入に続いて、docker desktop engine lsコマンドのさまざまな出力形式を探索します。デフォルトのテーブル形式、構造化データ用の JSON 形式、可読性を高めた pretty 形式を使用して利用可能なエンジンを一覧表示する方法を学びます。この実験を通じて、docker desktop CLI を使用して Docker エンジンを効果的に検査・管理するスキルを習得できます。

Skills Graph

docker desktop engine ls コマンドの目的を理解する

このステップでは、docker desktop engine lsコマンドの目的を理解します。LabEx 環境はクラウド VM でありデスクトップ環境ではありませんが、docker desktopコマンドは依然として利用可能で、Docker エンジンの管理に使用できます。

docker desktop engine lsコマンドは、Docker Desktop が認識している利用可能な Docker エンジンを一覧表示するために使用されます。通常の Docker Desktop インストールでは、デフォルトエンジンや設定した他のエンジンが表示される可能性があります。LabEx VM 環境では、このコマンドは VM 上で動作している Docker デーモンと連携します。

実際にコマンドを実行して出力を確認しましょう。~/projectディレクトリでターミナルを開いてください。

docker desktop engine ls

以下のような出力が表示され、デフォルトエンジンが確認できるはずです：

NAME    STATUS    BUILTIN
default running   true

この出力から、エンジン名 (default)、現在の状態 (running)、組み込みエンジンかどうか (true) がわかります。このコマンドを理解することは、docker desktop CLI を使用して Docker エンジンを管理する最初のステップです。

デフォルト形式で利用可能なエンジンを一覧表示する

前のステップでは、特定のフォーマットオプションを指定せずにdocker desktop engine lsコマンドを使用しました。このコマンドはデフォルトで、Docker エンジンに関する情報を標準的なテーブル形式で表示します。このデフォルト形式は通常読みやすく、重要な詳細を一目で把握できます。

デフォルトの出力形式を確認するため、再度コマンドを実行しましょう。ターミナルで~/projectディレクトリにいることを確認してください。

docker desktop engine ls

出力は以下のようになります：

NAME    STATUS    BUILTIN
default running   true

これがデフォルト形式です。データはNAME、STATUS、BUILTINというヘッダー付きの列で表示されます。この形式は簡単な確認や人間が読むのに適しています。次のステップでは、スクリプト作成時や異なるデータ構造が必要な場合に有用な他のフォーマットオプションを探求します。

JSON 形式で利用可能なエンジンを一覧表示する

このステップでは、利用可能な Docker エンジンを JSON 形式で一覧表示する方法を学びます。JSON 形式は、スクリプト内での処理や他のツールとの連携など、プログラムで出力を処理する必要がある場合に特に有用です。

JSON 形式で出力を取得するには、--formatフラグにjsonという値を指定します。

~/projectディレクトリで以下のコマンドを実行してください：

docker desktop engine ls --format json

出力は、各 Docker エンジンを表すオブジェクトを含む JSON 配列になります。以下のような形式になります：

[
  {
    "Name": "default",
    "Status": "running",
    "Builtin": true
  }
]

ご覧の通り、情報は配列内の JSON オブジェクトとして構造化されており、"Name"、"Status"、"Builtin"などのキーが含まれています。この形式は機械可読性が高く、様々なプログラミング言語やツールで簡単に解析できます。

pretty 形式で利用可能なエンジンを一覧表示する

このステップでは、docker desktop engine lsコマンドのもう一つの便利なフォーマットオプションであるpretty形式について説明します。pretty形式では、Go テンプレート構文を使用して出力をカスタマイズでき、表示するフィールドやその表示方法を細かく制御できます。

pretty形式を使用するには、--formatフラグに Go テンプレート文字列を指定します。例えば、エンジン名とステータスを表示するには、{{.Name}}\t{{.Status}}というテンプレートを使用します。.は現在のオブジェクト（エンジン）を参照し、.Nameと.Statusはそれぞれのフィールドにアクセスします。\tは列を区切るためのタブ文字です。

pretty形式を使用してエンジン名とステータスを一覧表示してみましょう。~/projectディレクトリで以下のコマンドを実行してください：

docker desktop engine ls --format "{{.Name}}\t{{.Status}}"

出力には、タブで区切られたエンジン名とステータスが表示されます：

default running

pretty 形式にはヘッダーを含めることもできます。ヘッダーを追加するには、テンプレート文字列に含めます。例えば、"ENGINE NAME"と"STATUS"のヘッダーを追加する場合：

docker desktop engine ls --format "ENGINE NAME\tSTATUS\n{{.Name}}\t{{.Status}}"

これで出力にヘッダーが含まれます：

ENGINE NAME	STATUS
default	running

\nはヘッダー行の後に改行を挿入します。pretty形式は非常に柔軟で、特定のニーズに合わせて出力を調整できるため、人間が読む場合や JSON が過剰な簡単なスクリプトタスクに有用です。

まとめ

この実験では、docker desktop engine lsコマンドを使用して利用可能な Docker エンジンを一覧表示する方法を学びました。まず、このコマンドの目的を理解しました。このコマンドは、LabEx のようなクラウド VM 環境であっても、Docker Desktop が認識している Docker エンジンに関する情報を表示するものです。その後、デフォルトの出力形式を使用して利用可能なエンジンを一覧表示する練習を行いました。この形式では、エンジン名、ステータス、および組み込みかどうかが明確で読みやすい表形式で表示されます。

さらに、docker desktop engine lsコマンドの柔軟性を探求し、プログラム処理に有用な JSON 形式と、より人間にとって読みやすいフォーマットされた出力を提供する pretty 形式を使用して利用可能なエンジンを一覧表示しました。これらのステップを通じて、さまざまな出力形式を使用して Docker エンジン情報を表示する実践的な経験を得ました。