コンテナで開発環境作りたいけど、Dockerfile書くのがどうにも面倒で踏ん切りつかないことがよくあります。
DevContainer を使えば、コンテナを使ったポータビリティの高い開発環境を簡単に定義・構築できます。びっくりするくらい簡単に始めてみましょう。
いいところ
ポータビリティの高い開発環境が作れる
コンテナ自体のポータビリティを生かして、devcontainerが動く環境さえ整っていれば誰でも同じ環境を再現できます。devcontainer.json をコードと一緒に置いておけば配布やバージョン管理も容易です。
Dockerを意識しなくて良い
docker build docker run を叩いたりする必要がないので強力にオペミスを防止できます。初学者にも優しいですね。
エコシステムが整っている
今回のようにVSCodeのGUIから扱えるほか、DevContainer CLI、GitHub CodeSpaces など、誰でも・どこでも・簡単に利用できる仕組みが整ってきています。
悪いところ
激しいメモリ消費...
Get Started !
前提
-
VSCode に Remote Development 拡張機能を導入して使います
https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack -
Docker が動くようにしておきます。DesktopでもCEでも構いません。
はじめかた
-
適当なディレクトリで コマンドパレット(
Fn+F1) > "Add Dev Container Configuration Files" を選択します
-
お好みのベースイメージを選択します。
-
お好みのFeatureを選びます。開発に必要なツールがあれば選択してください。
-
.DevContainer/ディレクトリとdevcontainer.jsonが生成されます。
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
{
"name": "Ubuntu",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/base:jammy",
"features": {
"ghcr.io/devcontainers/features/aws-cli:1": {},
"ghcr.io/devcontainers/features/docker-in-docker:2": {},
"ghcr.io/devcontainers/features/python:1": {}
}
...
}
-
コマンドパレット > "Open Folder in Container..." を選択して、
.DevContainer/の存在するディレクトリを指定します。
-
しばらく待って...無事ビルドが完了し、コンテナに接続されました。
仕組み
VSCode Server: (VSCodeのバックエンドだけを切り出したもの)をコンテナ内で動作させることで、ローカルのエディタ環境を汚さない仕組みです。
さらにローカルにあるプロジェクトディレクトリをマウントしていて、データは手元に置きつつ実行環境はスクラップ&ビルドが容易なコンテナ内に置いておくといったことを実現しています。
(画像: https://code.visualstudio.com/docs/devcontainers/containers)
Discussion