컨테이너 도구 확장 사용자 지정

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에 대한 명시적 지원(및 간소화된 구성)을 제공합니다.

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)

기본값을 사용한 최소 구성

When you build a .NET-based image, you can omit the platform property and just set the netCore object (platform is implicitly set to netcore when netCore object is present). Note that appProject is a required property

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

플랫폼 기본값

.NET 기반 이미지의 경우 docker-build 작업은 다음 옵션을 추론합니다.

빌드 작업 참조

Here are all properties available for configuring docker-build task. All properties are optional unless indicated otherwise.

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 개체만 설정할 수 있습니다(platform은 python 개체가 있을 때 암시적으로 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)

기본값을 사용한 최소 구성

When you build a .NET-based image, you can omit the platform property and just set the netCore object (platform is implicitly set to netcore when netCore object is present). Note that appProject is a required property

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

플랫폼 기본값

.NET 기반 이미지의 경우 docker-run 작업은 다음 옵션을 추론합니다.

실행 작업 참조

Here are all properties available for configuring docker-run task. All properties are optional unless indicated otherwise.

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 작업 참조

Here are all properties available for configuring docker-compose task. All properties are optional unless indicated otherwise.

dockerCompose 개체 속성

up 개체 속성

down 개체 속성

명령 사용자 지정

컨테이너 도구 확장은 이미지를 빌드하고, 컨테이너를 실행하고, 컨테이너에 연결하고, 컨테이너 로그를 보는 등의 작업을 수행할 때 여러 Docker CLI 명령을 실행합니다. 이러한 명령 중 일부는 많은 선택적 인수를 가지고 있으며, 종종 매우 특정 시나리오에서 사용됩니다. 위의 Visual Studio Code 작업 대신, 작업이 사용되지 않을 때 여러 명령을 사용자 지정할 수 있습니다.

예를 들어, Compose Up 명령의 ${serviceList} 및 ${profileList} 토큰을 사용하면 Docker Compose YAML 파일의 하위 집합 서비스를 쉽게 시작할 수 있습니다.

이러한 사용자 지정 가능한 Docker 명령 각각에 대해, 실행할 템플릿을 설정하는 구성 설정이 있습니다. 또는 여러 템플릿을 정의할 수 있으며, 선택적으로 정규식을 사용하여 템플릿이 사용되어야 하는 컨텍스트를 힌트합니다. 템플릿은 launch.json 및 tasks.json과 유사한 일부 토큰을 지원합니다. 예를 들어, ${workspaceFolder}입니다.

설정 JSON 스키마

템플릿(아래에 나열됨) 각각을 구성하는 두 가지 옵션이 있습니다. 첫 번째 옵션은 기본 동작을 재정의하는 단일 템플릿입니다.

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

두 번째 옵션은 match 정규식뿐만 아니라 사용자 입력에 따라 선택되는 여러 템플릿입니다.

예를 들어, 다음 예제에서는 세 개의 템플릿이 표시됩니다.

{
  "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. 여러 제한된 템플릿이 적용되는 경우 사용자에게 선택하라는 메시지가 표시됩니다. 하나만 적용되는 경우 사용자에게 메시지가 표시되지 않습니다.
   3. 적용 가능한 제한된 템플릿이 없는 경우, 제한되지 않은 템플릿을 확인합니다. 제한되지 않은 템플릿에는 match가 없으므로 항상 적용 가능합니다.
   4. 여러 제한되지 않은 템플릿이 적용되는 경우 사용자에게 선택하라는 메시지가 표시됩니다. 하나만 적용되는 경우 사용자에게 메시지가 표시되지 않습니다.

Docker 빌드

지원되는 토큰

참고: containers.commands.build 설정에 ${tag} 토큰이 포함되지 않은 경우 사용자에게 태그를 입력/확인하라는 메시지가 표시되지 않습니다.

참고: match 정규식은 선택한 Dockerfile 이름과 작업 영역 폴더 이름과 비교됩니다.

Docker 실행

지원되는 토큰

참고: match 정규식은 선택한 이미지의 전체 태그와 비교됩니다.

컨테이너 연결

지원되는 토큰

참고: match 정규식은 컨테이너 이름 및 컨테이너 이미지의 전체 태그와 비교됩니다.

컨테이너 로그

지원되는 토큰

참고: match 정규식은 컨테이너 이름 및 컨테이너 이미지의 전체 태그와 비교됩니다.

Docker Compose Up

지원되는 토큰

Docker Compose Down

지원되는 토큰

추가 지원 토큰

명령별 지원 토큰 외에도 다음 토큰이 모든 명령 템플릿에서 지원됩니다.