はじめに

チーム内活動でコンテナを使用して開発を進めることになったので、コンテナ開発の環境を構築してみました。元々はDocker Desktopを利用していましたが、2021/8/31からDocker Desktopの組織利用（条件あり）が有料化されたため、WSL2にDocker Engineをインストールしてコンテナを構築するようにしました。

VSCode Remote-Containersとは

VSCode Remote-Containersとは、コンテナベース（Docker利用）での開発を可能とするVSCodeの拡張プラグインです。コンテナベースでの開発のメリットは様々で、例えば以下のようなものがあります。

ローカルマシンに変更を加えずに開発環境を構築できる

ちょっとした技術検証で「ローカルに余計なものを入れたくない」、「変更を加えすぎて何が必要だったかが分からない」、「変なものを入れてしまったかもしれない」というのはよくあることだと思います。コンテナを利用すればすべてコンテナ内で完結するので、クリティカルな変更も気軽に試すことができます。

独立した複数の開発環境を１台のマシンで保持することができる

複数のコンテナを用意すれば複数の開発環境を１台のマシンで保持することができます。また、各コンテナ間の切り替えも簡単かつスピーディに行うことができます。

開発環境を第三者に正確かつ容易に展開することができる

複雑なプロジェクトでは環境構築の手順が煩雑になりがちです。DockerfileやDockerイメージを用いればどのPCにも同じ環境を自動で構築することができます。

環境及びツール

Windows 10 バージョン 2004 以降 (ビルド 19041 以降) または Windows 11
VSCode

Dockerの構築

1.WSLのインストール

WSLとはWindows Subsystem for Linuxの略称で、インストールすることでWindowsをLinuxのように扱うことができます。Linuxコマンドで操作できるようになるのはもちろんのこと、各種aptパッケージをインストールして利用することも可能です。実行画面は以下のようになります。

インストール手順はとても簡単です。PowerShellを起動して下記コマンドを実行するだけです。ディストリビューションにはubuntuなどを指定することもできます。

wsl --install -d debian

Dockerを実行するにはWSLのバージョン2が必要なので、インストール完了後にWSLバージョンを2に設定します。

wsl --set-version debian 2

2.Docker Engineのインストール

WSL下でのDockerインストール手順はLinuxと同じです。公式サイトに手順が掲載されているので、そちらに従ってインストールします。

Install Docker Engine on Debian | Docker Documentation
https://docs.docker.com/engine/install/debian/

インストール後にDocker Daemonを起動します。これでDocker環境の構築及び実行は完了です。

sudo service docker start

VSCode Remote-Containers環境の構築

拡張プラグインのインストール

最初にVSCodeプラグインをインストールします。必要なのは下記の二つです。

Remote - Containers
Remote - WSL

プロジェクトフォルダ及びコンテナ定義ファイルの用意

次にプロジェクトフォルダとコンテナ定義ファイルを用意します。WSL下での開発となるため、プロジェクトフォルダをLinuxディレクトリに配置する必要があります。エクスプローラーのアドレスバーに"\wsl$"と入力すればLinuxディレクトリにアクセスすることができます。下記の通り、~/project/Testをプロジェクトフォルダとして作成します。（WSL上からLinuxコマンドで作成することもできます。）

コンテナ定義ファイルはMicrosoft公式githubアカウントから取得できます。Pythonを使いたいので、Python用の定義ファイルをダウンロードします。

必要なファイルはDockerfileとdevcontainer.jsonです。それぞれ見ていきます。

Dockerfile

Dockerイメージをビルドするための定義ファイルです。VSCode Remote-Containersの場合はDockerfileを指定するだけでDockerイメージのビルドからコンテナの立ち上げまで自動で行われます。

Dockerファイルについて詳しく知りたい場合はDocker公式サイトをご参照ください。
Dockerfile reference | Docker Documentation
https://docs.docker.com/engine/reference/builder/

devcontainer.json

devcontainer.jsonはコンテナの設定ファイルです。VSCodeやコンテナの細かい設定まで記載できるので使い慣れると非常に便利です。

{
    //VSCode上で表示されるコンテナ名
    "name": "Python 3", 
    //Dockerイメージビルド時の設定
    "build": {
        //Dockerfileの指定
        "dockerfile": "Dockerfile",
        //ビルドの実行パス（devcontainer.jsonからの相対パス）
        "context": "..",
        //Dockerfileで定義した引数の指定
        "args": { 
            // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9
            "VARIANT": "3",
            // Options
            "NODE_VERSION": "lts/*"
        }
    },

    //コンテナ作成完了時に適用するデフォルトの設定
    "settings": { 
        "python.pythonPath": "/usr/local/bin/python",
        "python.languageServer": "Pylance",
        "python.linting.enabled": true,
        "python.linting.pylintEnabled": true,
        "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
        "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
        "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
        "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
        "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
        "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
        "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
        "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
        "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
    },

    //コンテナ作成完了時に自動でインストールするVSCodeの拡張プラグイン
    "extensions": [
        "ms-python.python",
        "ms-python.vscode-pylance"
    ],

    //ローカルマシンに転送するコンテナのポート番号リスト
    // "forwardPorts": [],

    //コンテナ作成完了時に自動で実行するコマンド
    // "postCreateCommand": "pip3 install --user -r requirements.txt",

    //コンテナにログインするユーザ
    "remoteUser": "vscode"
}

上記以外にも様々なフィールドがあり、公式ドキュメントで詳しく説明されています。

devcontainer.json reference
https://code.visualstudio.com/docs/remote/devcontainerjson-reference

準備ができたら~/project/Testの下に.devcontainerという名のフォルダを作成して上記ファイルを格納します。

Remote-Containerの実行

いよいよRemote-Containerを実行します。WSLを起動して下記コマンドで先ほど作成したプロジェクトフォルダに移動します。

cd ~/project/Test

その後、下記コマンドを実行してVSCodeを起動します。

code .

初回実行の場合はVSCodeのアップデート確認が行われますが、問題なく完了すればVSCodeが立ち上がります。ステータスバーの一番左には「WSL:Debian」と表示されており、WSL下でフォルダを開いていることを表しています。

「F1」ボタンを押してコマンドパレットを開きます。表示された画面で「>Remote-Containers: Reopen in Container」と入力して実行します。

しばらく待てばDockerイメージのビルド及びコンテナの作成が完了します。ステータスバーで先ほど「WSL:Debian」と表示されている部分を確認すると表示が「Dev Container: Python 3」に変わっているので、コンテナ内でフォルダを開いていることが分かります。

拡張プラグインもインストールされています。

ターミナル画面でPythonコマンドを実行したら無事表示されました。

これでRemote-Containersの環境が構築できました。