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

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

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

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

Docker buildタスク

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

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

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

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

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

tasks.jsonのdocker-buildタスクは、任意のDockerイメージをビルドするために使用できますが、拡張機能はNode.js、Python、および.NET Coreに対して明示的なサポート（および簡略化された構成）を備えています。

Node.js (docker-build)

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

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

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

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

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

Python (docker-build)

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

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

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

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

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

.NET (docker-build)

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

.NETベースのDockerイメージをビルドする場合、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タスクは次のオプションを推測します。

Buildタスクリファレンス

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

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

nodeオブジェクトのプロパティ（docker-buildタスク）

netCoreオブジェクトのプロパティ（docker-buildタスク）

Docker runタスク

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

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

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

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

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

docker-runタスクは、任意のDockerイメージを実行するために使用できますが、拡張機能はNode.js、Python、および.NETに対して明示的なサポート（および簡略化された構成）を備えています。

Node.js (docker-run)

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

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

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

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

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

Python (docker-run)

PythonベースのDockerイメージをビルドする場合、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イメージの場合、docker-runタスクは次のオプションを推測します。

.NET (docker-run)

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

.NETベースのDockerイメージをビルドする場合、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タスクは次のオプションを推測します。

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コンテナを作成および起動します。このタスクは、単独で使用することも、Dockerコンテナ内でアプリケーションをデバッグするための一連のタスクの一部として使用することもできます。

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

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

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

設定JSONスキーマ

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

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

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

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

{
  "docker.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

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

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

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

Docker Run

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

注：match正規表現は、選択されたイメージのフルタグに対して比較されます。

Docker Attach

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

注：match正規表現は、コンテナ名とコンテナイメージのフルタグに対して比較されます。

Docker Logs

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

注：match正規表現は、コンテナ名とコンテナイメージのフルタグに対して比較されます。

Docker Compose Up

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

Docker Compose Down

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

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

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