Résumé des procédures de développement dans un conteneur Docker avec VS Code

introduction

Je ne peux pas nier ce sentiment maintenant, mais j'oublie souvent comment écrire devcontainer.json, donc je vais le laisser dans l'article comme un mémorandum pour moi-même.

Procédure d'installation

Ajout d'une extension à VS Code

Pour vous connecter à l'environnement de développement à l'intérieur du conteneur Docker avec VSCode, l'extension Développement à distance Vous en aurez besoin, alors installons-le.

vscode.png)

Ajouter devcontainer.json

Après avoir ajouté l'extension, préparons le fichier de configuration devcontainer.json et le dossier de stockage.

/ProjectRoot
  └ .devcontainer
      └　devcontainer.json

Créez un dossier .devcontainer sous le dossier racine du projet que vous souhaitez utiliser pour le développement à distance, et créez-y devcontainer.json.

Dans devcontainer.json, décrivez la définition du conteneur Docker à développer comme indiqué ci-dessous ( docker-compose.yml dans l'exemple ci-dessous), l'extension VSCode que vous souhaitez utiliser, les paramètres de transfert de port, etc. Aller.

{
    "name": "sample_project",
    "dockerComposeFile": "../docker-compose.yml",
    "service": "web",
    "extensions": [
        "mhutchie.git-graph",
    ],
    "forwardPorts": [
        8080
    ],
    "workspaceFolder": "/app",
}

Pour plus de détails sur la façon de le configurer, veuillez lire le document officiel référence devcontainer.json, mais il a été traduit en japonais. En outre, il existe de nombreux éléments de réglage, donc j'ai choisi les éléments de réglage que j'utilise souvent et les ai résumés.

image

Un seul conteneur Docker utilisé pour le développement est Docker Hub, [Azure Container Registry](https://azure.microsoft.com/ja-jp/services/container- Défini lors du référencement à partir du registre /). (Les deux nécessitent une connexion, vous devez donc avoir un compte à l'avance)

dockerFile

Configurez un seul conteneur Docker pour le développement lors de l'utilisation d'un Dockerfile local.

dockerComposeFile

Définissez plusieurs conteneurs Docker utilisés pour le développement lors de l'utilisation du fichier docker-compose.yml local. (Il est nécessaire de définir le `service 'décrit plus tard et de définir de manière unique le conteneur pour qu'il embarque réellement.)

Veuillez noter que le chemin d'accès au fichier docker-compose.yml spécifié doit être relatif à devcontainer.json. (S'il se trouve sous la racine du projet, ce sera ../ docker-compose.yml.)

service

Cet élément est requis lors de l'utilisation de dockerComposeFile et définit le nom de service du conteneur qui est réellement chargé lors du développement à partir de la définition de docker-compose.yml. (Dans le cas des services Web, je pense que ce sera généralement un conteneur pour le serveur d'application)