コンテナツール拡張機能をカスタマイズする

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オブジェクトプロパティ

コマンドのカスタマイズ

コンテナツール拡張機能は、イメージのビルド、コンテナの実行、コンテナへのアタッチ、コンテナログの表示など、さまざまな操作を実行する際に多数の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 Build

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

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

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

Docker Run

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

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

Container Attach

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

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

Container Logs

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

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

Docker Compose Up

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

Docker Compose Down

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

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

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