Container Tools 拡張機能をカスタマイズする

Container Tools 拡張機能には、Docker のビルドおよび実行の動作を制御し、デバッグのためのコンテナー起動の基礎を形成するいくつかの Visual Studio Code タスクが含まれています。

これらのタスクは、非常に多くの制御とカスタマイズを可能にします。最終的な構成は、一般的なデフォルト、プラットフォーム固有のデフォルト (Node.js、Python、.NET など)、およびユーザー入力の組み合わせです。ユーザー入力は、デフォルトと競合する場合に優先されます。

Visual Studio Code タスクのすべての共通機能 (たとえば、タスクを複合タスクにグループ化するなど) は、Container Tools 拡張機能のタスクでサポートされています。一般的なタスクの機能とプロパティの詳細については、Visual Studio Code のカスタム タスクのドキュメントを参照してください。

Docker ビルド タスク

docker-build タスクは、Docker コマンドライン (CLI) を使用してイメージをビルドします。このタスクは単独で使用することも、コンテナー内でアプリケーションを実行および/またはデバッグするためのタスクチェーンの一部として使用することもできます。

docker-build タスクの最も重要な設定は dockerBuild と platform です。

• dockerBuild オブジェクトは、Docker ビルド コマンドのパラメーターを指定します。このオブジェクトで指定された値は、Docker ビルド CLI の呼び出しに直接適用されます。
• platform プロパティは、docker-build タスクが Docker ビルドのデフォルトをどのように決定するかを変更するヒントです。

すべてのタスク プロパティの完全なリストについては、プロパティ リファレンスを参照してください。

プラットフォームサポート

tasks.json の docker-build タスクは任意のイメージをビルドするために使用できますが、この拡張機能は Node.js、Python、.NET Core を明示的にサポートしており (構成も簡素化されています)。

Node.js (docker-build)

デフォルトを使用した最小構成

特定のプラットフォーム オプションがない Node.js ベースのイメージは、platform プロパティを node に設定するだけで済みます。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Build Node Image",
      "type": "docker-build",
      "platform": "node"
    }
  ]
}

プラットフォームのデフォルト

Node.js ベースのイメージの場合、docker-build タスクは次のオプションを推論します。

Python (docker-build)

デフォルトを使用した最小構成

特定のプラットフォーム オプションがない Python ベースのイメージは、platform プロパティを python に設定するだけで済みます。

{
  "tasks": [
    {
      "type": "docker-build",
      "label": "docker-build",
      "platform": "python"
    }
  ]
}

プラットフォームのデフォルト

Python ベースのイメージの場合、docker-build タスクは次のオプションを推論します。

.NET (docker-build)

デフォルトを使用した最小構成

.NET ベースのイメージをビルドする場合、platform プロパティを省略し、netCore オブジェクトを設定するだけで済みます (netCore オブジェクトが存在する場合、platform は暗黙的に netcore に設定されます)。appProject は必須プロパティです。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Build Node Image",
      "type": "docker-build",
      "netCore": {
        "appProject": "${workspaceFolder}/project.csproj"
      }
    }
  ]
}

プラットフォームのデフォルト

.NET ベースのイメージの場合、docker-build タスクは次のオプションを推論します。

ビルド タスク リファレンス

docker-build タスクを構成するために使用できるすべてのプロパティを次に示します。特に明記しない限り、すべてのプロパティはオプションです。

dockerBuild オブジェクト プロパティ

node オブジェクト プロパティ (docker-build タスク)

netCore オブジェクト プロパティ (docker-build タスク)

Docker 実行タスク

tasks.json の docker-run タスクは、Docker コマンドライン (CLI) を使用してコンテナーを作成し、起動します。このタスクは単独で使用することも、コンテナー内でアプリケーションをデバッグするためのタスクチェーンの一部として使用することもできます。

docker-run タスクの最も重要な設定は dockerRun と platform です。

• dockerRun オブジェクトは、Docker 実行コマンドのパラメーターを指定します。このオブジェクトで指定された値は、Docker 実行 CLI の呼び出しに直接適用されます。
• platform プロパティは、docker-run タスクが Docker 実行のデフォルトをどのように決定するかを変更するヒントです。

すべてのタスク プロパティの完全なリストについては、プロパティ リファレンスを参照してください。

Docker 実行プラットフォーム サポート

docker-run タスクは任意の Docker イメージを実行するために使用できますが、この拡張機能は Node.js、Python、.NET を明示的にサポートしており (構成も簡素化されています)。

Node.js (docker-run)

デフォルトを使用した最小構成

特定のプラットフォーム オプションがない Node.js ベースのイメージは、platform プロパティを node に設定するだけで済みます。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run Node Image",
      "node": "docker-run",
      "platform": "node"
    }
  ]
}

プラットフォームのデフォルト

Node.js ベースのイメージの場合、docker-run タスクは次のオプションを推論します。

Python (docker-run)

Python ベースのイメージをビルドする場合、platform プロパティを省略し、python オブジェクトを設定するだけで済みます (python オブジェクトが存在する場合、platform は暗黙的に python に設定されます)。

Django アプリケーションの最小構成

{
  "type": "docker-run",
  "label": "docker-run: debug",
  "dependsOn": ["docker-build"],
  "python": {
    "args": ["runserver", "0.0.0.0:8000", "--nothreading", "--noreload"],
    "file": "path_to/manage.py"
  }
}

Flask アプリケーションの最小構成

{
  "type": "docker-run",
  "label": "docker-run: debug",
  "dependsOn": ["docker-build"],
  "dockerRun": {
    "env": {
      "FLASK_APP": "path_to/flask_entry_point.py"
    }
  },
  "python": {
    "args": ["run", "--no-debugger", "--no-reload", "--host", "0.0.0.0", "--port", "5000"],
    "module": "flask"
  }
}

一般的なアプリケーションの最小構成

{
  "type": "docker-run",
  "label": "docker-run: debug",
  "dependsOn": ["docker-build"],
  "python": {
    "file": "path_to/app_entry_point.py"
  }
}

プラットフォームのデフォルト

Python ベースのイメージの場合、docker-run タスクは次のオプションを推論します。

.NET (docker-run)

デフォルトを使用した最小構成

.NET ベースのイメージをビルドする場合、platform プロパティを省略し、netCore オブジェクトを設定するだけで済みます (netCore オブジェクトが存在する場合、platform は暗黙的に netcore に設定されます)。appProject は必須プロパティです。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run .NET Core Image",
      "type": "docker-run",
      "netCore": {
        "appProject": "${workspaceFolder}/project.csproj"
      }
    }
  ]
}

プラットフォームのデフォルト

.NET ベースのイメージの場合、docker-run タスクは次のオプションを推論します。

実行タスク リファレンス

docker-run タスクを構成するために使用できるすべてのプロパティを次に示します。特に明記しない限り、すべてのプロパティはオプションです。

dockerRun オブジェクト プロパティ

ports オブジェクト プロパティ

extraHosts オブジェクト プロパティ

volumes オブジェクト プロパティ

node オブジェクト プロパティ (docker-run タスク)

python オブジェクト プロパティ (docker-run タスク)

netCore オブジェクト プロパティ (docker-run タスク)

Docker Compose タスク

tasks.json の docker-compose タスクは、Docker Compose コマンドライン (CLI) を使用してコンテナーを作成し、起動します。このタスクは単独で使用することも、コンテナー内でアプリケーションをデバッグするためのタスクチェーンの一部として使用することもできます。

docker-compose タスクの最も重要な設定は dockerCompose です。

• dockerCompose オブジェクトは、Docker Compose コマンドのパラメーターを指定します。このオブジェクトで指定された値は、Docker Compose CLI の呼び出しに直接適用されます。

すべてのタスク プロパティの完全なリストについては、プロパティ リファレンスを参照してください。

構成例

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run docker-compose up",
      "type": "docker-compose",
      "dockerCompose": {
        "up": {
          "detached": true,
          "build": true,
          "services": ["myservice"]
        },
        "files": [
          "${workspaceFolder}/docker-compose.yml",
          "${workspaceFolder}/docker-compose.debug.yml"
        ]
      }
    }
  ]
}

Compose タスク リファレンス

docker-compose タスクを構成するために使用できるすべてのプロパティを次に示します。特に明記しない限り、すべてのプロパティはオプションです。

dockerCompose オブジェクト プロパティ

up オブジェクト プロパティ

down オブジェクト プロパティ

コマンドのカスタマイズ

Container Tools 拡張機能は、イメージのビルド、コンテナーの実行、コンテナーへのアタッチ、コンテナー ログの表示など、さまざまな操作を実行するときに多数の Docker CLI コマンドを実行します。これらのコマンドの中には、非常に特定のシナリオでよく使用される多数のオプション引数を持つものもあります。上記の Visual Studio Code タスクの代替として、タスクが使用されていない場合にいくつかのコマンドをカスタマイズできます。

たとえば、Compose Up コマンドの ${serviceList} および ${profileList} トークンを使用すると、Docker Compose YAML ファイル内のサービスの一部を簡単に起動できます。

これらのカスタマイズ可能な Docker コマンドごとに、実行するテンプレートを設定するための構成設定が利用可能です。または、必要に応じて正規表現を持つ複数のテンプレートを定義できます。これにより、テンプレートが使用されるべきコンテキストが一致した場合に示唆されます。テンプレートは、launch.json および tasks.json と同様のいくつかのトークン、たとえば ${workspaceFolder} をサポートしています。

設定 JSON スキーマ

各テンプレート (以下にリスト) を構成するには、2 つのオプションがあります。最初のオプションは、デフォルトの動作をオーバーライドする単一のテンプレートです。

{
  "containers.commands.build": "docker build --rm -f \"${dockerfile}\" -t ${tag} \"${context}\""
}

2 番目のオプションは、match 正規表現とユーザー入力に基づいて選択される複数のテンプレートです。

たとえば、次の例では 3 つのテンプレートが示されています。

{
  "containers.commands.build": [
    {
      "label": "Default build command",
      "template": "docker build --rm -f \"${dockerfile}\" -t ${tag} \"${context}\""
    },
    {
      "label": "Alpine-specific build command",
      "template": "docker build -p 1234:1234 -f \"${dockerfile}\" -t ${tag} \"${context}\"",
      "match": "alpine"
    }
  ]
}

選択動作

実行するコマンド テンプレートは、次のルールに基づいて選択されます。

1. 設定が構成されていない場合は、デフォルトのコマンド テンプレートが選択されます。
2. 単一のテンプレートのみが構成されている場合 (上記の最初の例)、そのテンプレートが選択されます。
3. 複数のテンプレートが構成されている場合
   1. 制約付きテンプレートがチェックされます。制約付きテンプレートには match があります。match 正規表現は、コンテキスト ヒント (たとえば、イメージ名、コンテナー名など) と比較されます。
   2. 複数の制約付きテンプレートが適用される場合、ユーザーは選択を促されます。1 つだけが適用される場合、ユーザーは促されません。
   3. 適用可能な制約付きテンプレートがない場合、制約なしテンプレートがチェックされます。制約なしテンプレートには match がなく、したがって常に適用可能です。
   4. 複数の制約なしテンプレートが適用される場合、ユーザーは選択を促されます。1 つだけが適用される場合、ユーザーは促されません。

Docker ビルド

サポートされているトークン

注: containers.commands.build 設定に ${tag} トークンが含まれていない場合、ユーザーはタグの入力/確認を促されません。

注: match 正規表現は、選択された Dockerfile 名とワークスペース フォルダー名と比較されます。

Docker 実行

サポートされているトークン

注: match 正規表現は、選択したイメージの完全なタグと比較されます。

コンテナー アタッチ

サポートされているトークン

注: match 正規表現は、コンテナー名とコンテナー イメージの完全なタグと比較されます。

コンテナー ログ

サポートされているトークン

注: match 正規表現は、コンテナー名とコンテナー イメージの完全なタグと比較されます。

Docker Compose Up

サポートされているトークン

Docker Compose Down

サポートされているトークン

追加のサポートされているトークン

コマンド固有のサポートされているトークンに加えて、次のトークンはすべてのコマンド テンプレートでサポートされています。