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

サポートされるトークン

その他サポートされているトークン

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