Win11 WSL2/DevContainer

2024-12-042024
92.4% (338.3/366)
December
10.7% (3.3/31)
Week 49
33.5% (2.3/7)
Day 04 Wed
34.7% (8.3/24)

訪問者

total: 2635
today: 1
yesterday: 1
now: 1

↑

更新

MenuBar

Microsoft 提供の DevContainer ひな形の取得
Python3を起動してみる
DevContaierの中身を見てみる
最小構成の DevContainer を作ってみる
docker-compose 版
参考文献

調査中

Microsoft 提供の DevContainer ひな形の取得 †

WSL2/Ubuntu 側の ~/docker にひな形を取得する。main そのままでもいいけど、とりあえず最新の Tag のものを使う

$ git clone https://github.com/microsoft/vscode-dev-containers.git
$ cd vscode-dev-containers/
$ git checkout v0.245.2
$ git branch

* (HEAD detached at v0.245.2)
  main

リファレンスマニュアル : https://containers.dev/implementors/json_reference/

↑

Python3を起動してみる †

ひな形をコピーして、VSCode (WSL) から開く

$ cp -R vscode-dev-containers/containers/python-3 python-3

F1 - Dev Containers : Open in Container で、Docker Container を起動する
しばらく時間がかかる...それにしても Core i7 Gen 12 コア数多いな...あと plan9 って何?
Dockerで起動された Container 上で VSCode が開きなおされる
- WSL2/Ubuntu22 上から開かれた Docker/Debian11 上で VSCode が開かれている
- これのすごいところは、カレントディレクトが、もとの Dev Container ディレクトリなこと
- ホスト側のディレクトリをコンテナにマウントするとかは不要
Python3 コンテナ上で動く VSCode には Python plugin がインストールされている
内部的には Port 35247 でつながっているらしい。必要ならほかにも Port Forward できるみたい
Dev Container を終了させる場合は、F1 - Dev Containers : Reopen Folder in WSL を選ぶ

↑

DevContaier?の中身を見てみる †

ファイル構成

最低限こういう構成にすればいいようだ

.
├── .devcontainer
│   ├── Dockerfile
│   └── devcontainer.json
└── .vscode
     └── launch.json

Dockerfile

最低限 vscode というユーザを作ればよさそうだ
UID/PID は、このディレクトリの持ち主と同じにする (WSL2の場合 UID=1000, PID=1000)

Bing Chat に作ってもらった

FROM ubuntu:latest

RUN apt-get update && \
    apt-get upgrade -y && \
    apt-get clean && \
    rm -rf /var/lib/apt/lists/*

RUN groupadd -g 1000 vscode && \
    useradd -m -s /bin/bash -u 1000 -g 1000 vscode

devcontainer.json

{
	"name": "Python 3",
	"build": {
		"dockerfile": "Dockerfile",
		"context": "..",
		"args": { 
                  // Dockerfile に渡す変数
		}
	},

	"customizations": {
		"vscode": {
			"settings": { 
				"python.defaultInterpreterPath": "/usr/local/bin/python",
				"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"
			},
			
			"extensions": [
				"ms-python.python",
				"ms-python.vscode-pylance"
			]
		}
	},
	"remoteUser": "vscode"
}

なるほど、customizations 以下に、コンテナ上で起動する VSCode の設定をするのか
- settings に vscode の設定
- extensions に plugin の設定
こいつらは、.vscode/settings.json で行ってもいいらしい
当然 python や pylint なんかが必要。Dockerfile に追加した

.vscode/launch.json には、VSCode起動時に実行されるコマンドを定義できるようだ。いらないかな

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python (Integrated Terminal)",
            "type": "python",
            "request": "launch",
            "program": "${workspaceFolder}/test-project/hello.py",
            "console": "integratedTerminal"
        }
    ]
}

↑

最小構成の DevContainer を作ってみる †

Dockerfile

https://raw.githubusercontent.com/kagyuu/Python3-devcontainer/main/.devcontainer/Dockerfile

FROM ubuntu:latest

ARG DEBIAN_FRONTEND=noninteractive
ENV TZ=Asia/Tokyo

# update the ubuntu os image and install mandatory libs.
RUN apt-get update && apt-get upgrade -y && \
    apt-get install -y build-essential libbz2-dev libdb-dev \
        libreadline-dev libffi-dev libgdbm-dev liblzma-dev \
        libncursesw5-dev libsqlite3-dev libssl-dev \
        zlib1g-dev uuid-dev tk-dev \
        sudo wget curl apt-utils locales lsb-release bash-completion && \
    apt-get clean && \
    rm -rf /var/lib/apt/lists/*

ARG PYTHON_VERSION
ARG PYTHON_REVISION
RUN wget https://www.python.org/ftp/python/${PYTHON_VERSION}.${PYTHON_REVISION}/Python-${PYTHON_VERSION}.${PYTHON_REVISION}.tgz && \
    tar -xf Python-${PYTHON_VERSION}.${PYTHON_REVISION}.tgz && \
    cd Python-${PYTHON_VERSION}.${PYTHON_REVISION} && \
    ./configure --enable-optimizations && \
    make -j $(nproc) | tee build.log && \
    sudo make altinstall

RUN /usr/local/bin/pip${PYTHON_VERSION} install --upgrade pip && \
    /usr/local/bin/pip${PYTHON_VERSION} install autopep8 black yapf bandit flake8 mypy pycodestyle pydocstyle pylint

# Options
RUN apt-get update && \
    apt-get install -y \
        git vim tree htop iputils-ping iproute2 \
        intel-mkl \
        postgresql-client && \
    apt-get clean && \
    rm -rf /var/lib/apt/lists/*

# for the numpy/scipy running on the intel processors.
RUN update-alternatives --set libblas.so.3-x86_64-linux-gnu /usr/lib/x86_64-linux-gnu/libmkl_rt.so && \
    update-alternatives --set libblas.so-x86_64-linux-gnu /usr/lib/x86_64-linux-gnu/libmkl_rt.so

# create vscode user
ARG USERNAME=vscode
ARG GROUPNAME=vscode
ARG USER_UID=1000
ARG USER_GID=$USER_UID

RUN groupadd -g 1000 ${GROUPNAME} && \
    useradd -m -s /bin/bash -u ${USER_UID} -g ${USER_GID} ${USERNAME} && \
    echo ${USERNAME} ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/${USERNAME} && \
    chmod 0440 /etc/sudoers.d/${USERNAME} && \
    localedef -f UTF-8 -i ja_JP ja_JP.UTF-8

# install poerty for vscode user
USER vscode
ARG WORKDIR
RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py | python${PYTHON_VERSION} -
RUN echo "export PATH=/home/vscode/.local/bin:$PATH" >> /home/vscode/.bashrc
RUN /home/vscode/.local/bin/poetry completions bash | sudo tee /etc/bash_completion.d/poerty.bash-completion > /dev/null
RUN /home/vscode/.local/bin/poetry config cache-dir /workspaces/${WORKDIR}/.cache

apt-get update して、もろもろ必要なライブラリやコマンドをインストール
python3.11 をソースコードからインストール
- OSが /usr/bin/python3 を使っていて、これはあんまり変えたくない
- ソースからコンパイルした /usr/local/bin/python3.11 を使う
- VSCode には、python コンパイラにこれを登録する

まずは、Dockerfile を試す

~/docker/Python3-devcontainer/.devcontainer$ docker build --build-arg WORKDIR='Python3-devcontainer' --build-arg PYTHON_VERSION='3.11' --build-arg PYTHON_REVISION='3' .

~/docker/Python3-devcontainer/.devcontainer$ docker images
REPOSITORY                                                                              TAG                       IMAGE ID       CREATED          SIZE
<none>                                                                                  <none>                    5f977a6bc71a   27 minutes ago   1.59GB
vsc-gpu-python-3-f89df00ce212f1edea4a2842bdfdc32a4605ac994cfe3e7b43ae00c8b9ba94c4-uid   latest                    065e9f88a9f2   31 hours ago     1.57GB
vsc-gpu-python-3-f89df00ce212f1edea4a2842bdfdc32a4605ac994cfe3e7b43ae00c8b9ba94c4       latest                    2b55e70ce9d8   31 hours ago     1.57GB
vsc-python-3-7f7cf5bbb705da52cb06e373f5fd909d4cf3f9a244afc89dd274870056220d35-uid       latest                    f6601e4d73ea   8 days ago       1.56GB
vsc-python-3-7f7cf5bbb705da52cb06e373f5fd909d4cf3f9a244afc89dd274870056220d35           latest                    a9d8df6a52d0   8 days ago       1.56GB
hello-world                                                                             latest                    9c7a54a9a43c   2 weeks ago      13.3kB
nvidia/cuda                                                                             11.6.2-base-ubuntu20.04   1aa90fd39a71   5 months ago     154MB

~/docker/Python3-devcontainer/.devcontainer$ docker run -it 5f977 /bin/bash
root@87851d9bfa78:/# python3
python3            python3.10         python3.11         python3.11-config  
root@87851d9bfa78:/# which python3.10    
/usr/bin/python3.10
root@87851d9bfa78:/# which python3.11
/usr/local/bin/python3.11

devcontainer.json

https://raw.githubusercontent.com/kagyuu/Python3-devcontainer/main/.devcontainer/devcontainer.json

{
	"name": "Python 3",
	"build": {
		"dockerfile": "Dockerfile",
		"context": "..",
		"args": {
			"WORKDIR" : "Python3-devcontainer",
			"PYTHON_VERSION" : "3.11",
			"PYTHON_REVISION" : "3"
		}
	},

	// Configure tool-specific properties.
	"customizations": {
		// Configure properties specific to VS Code.
		"vscode": {
			// Set *default* container specific settings.json values on container create.
			"settings": { 
				"python.defaultInterpreterPath": "/usr/local/bin/python3.11",
				"python.linting.enabled": true,
				"python.linting.pylintEnabled": true,
				"python.formatting.autopep8Path": "/usr/local/bin/autopep8",
				"python.formatting.blackPath": "/usr/local/bin/black",
				"python.formatting.yapfPath": "/usr/local/bin/yapf",
				"python.linting.banditPath": "/usr/local/bin/bandit",
				"python.linting.flake8Path": "/usr/local/bin/flake8",
				"python.linting.mypyPath": "/usr/local/bin/mypy",
				"python.linting.pycodestylePath": "/usr/local/bin/pycodestyle",
				"python.linting.pydocstylePath": "/usr/local/bin/pydocstyle",
				"python.linting.pylintPath": "/usr/local/bin/pylint"
			},
			
			// Add the IDs of extensions you want installed when the container is created.
			"extensions": [
				"ms-python.python",
				"ms-python.vscode-pylance",
				"ms-azuretools.vscode-docker", // To avoid the vscode on the devcontaier recommends it.
				"oderwat.indent-rainbow"
			]
		}
	},

	"runArgs" : ["--add-host=host.docker.internal:host-gateway"],

	// Use 'forwardPorts' to make a list of ports inside the container available locally.
	// 8888 : jupyter notebook
	"forwardPorts": [8888],

	// Use 'postCreateCommand' to run commands after the container is created.
	// "postCreateCommand": "pip3 install --user -r requirements.txt",

	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
	"remoteUser": "vscode"
}

forwardPortsで 8888 を公開する (jupyter を公開する)
runArgs で docker run コマンドの引数を指定する。ここでは host.docker.internal でホストの IP アドレスを参照できるようにする (/etc/hosts にエントリーが追加される。host-gateway は docker の予約語でホストのIPアドレスを示す

F1 - Dev Containers : Open in Container で、Docker Container を起動する
良かろうと思います

↑

docker-compose 版 †

やっぱり docker-compose じゃなきゃと思ってた
- docker-compose を使うと、コンテナ同士で Port-forward できる
- でも、devcontainer も Port-forward できる
- Database を使いたいのであれば、ホストで Database を立ち上げて、コンテナ内からはマシン名 host.docker.internal で参照したほうが取り回しが楽だと思う
docker-compose.yml
```
version: "3"

services:
    workspace:
        build:
            context: .
            dockerfile: Dockerfile
        volumes:
            - ..:/workspace:cached       
        command: sleep infinity
        ports: 
            - 8888:8888
        extra_hosts:
          - host.docker.internal:host-gateway
```
- volume でカレントディレクトリを /workspace にマウントする
- command でプロセスが終わらないようにする
- portsで 8888 を公開する (jupyter を公開する)
- extra_hostsで host.docker.internal でホストの IP アドレスを参照できるようにする (/etc/hosts にエントリーが追加される。host-gateway は docker の予約語でホストのIPアドレスを示す

devcontainer.json

{
	"name": "Python 3",
	// "build": {
	// 	"dockerfile": "Dockerfile",
	// 	"context": "..",
	// 	"args": { 
	// 	}
	// },

	"dockerComposeFile": "docker-compose.yml",
	"service": "workspace",
	"workspaceFolder": "/workspace",	
	"shutdownAction": "stopCompose",

	// Configure tool-specific properties.
	"customizations": {
		// Configure properties specific to VS Code.
		"vscode": {
			// Set *default* container specific settings.json values on container create.
			"settings": { 
				"python.defaultInterpreterPath": "/usr/local/bin/python3.11",
				"python.linting.enabled": true,
				"python.linting.pylintEnabled": true,
				"python.formatting.autopep8Path": "/usr/local/bin/autopep8",
				"python.formatting.blackPath": "/usr/local/bin/black",
				"python.formatting.yapfPath": "/usr/local/bin/yapf",
				"python.linting.banditPath": "/usr/local/bin/bandit",
				"python.linting.flake8Path": "/usr/local/bin/flake8",
				"python.linting.mypyPath": "/usr/local/bin/mypy",
				"python.linting.pycodestylePath": "/usr/local/bin/pycodestyle",
				"python.linting.pydocstylePath": "/usr/local/bin/pydocstyle",
				"python.linting.pylintPath": "/usr/local/bin/pylint"
			},
			
			// Add the IDs of extensions you want installed when the container is created.
			"extensions": [
				"ms-python.python",
				"ms-python.vscode-pylance",
				"ms-azuretools.vscode-docker", // To avoid the vscode on the devcontaier recommends it.
				"oderwat.indent-rainbow"
			]
		}
	},

	// Use 'forwardPorts' to make a list of ports inside the container available locally.
	// "forwardPorts": [],

	// Use 'postCreateCommand' to run commands after the container is created.
	// "postCreateCommand": "pip3 install --user -r requirements.txt",

	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
	"remoteUser": "vscode"
}

生Docker版では、build に Dockerfile を指定していたが、docker-compose では、dockerComposeFile? を指定する
dockerComposeFile? : docker-compose.yml を指定する
service : docker-compose で立ち上げるコンテナのうち、どのサービスを VSCode devcontainer からアタッチするか
workspaceFolder : workspace。docker-compose で指定した volume
shutdownAction : stopCompose 固定

↑

参考文献 †

Microsoft 提供の DevContainer ひな形, https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers
WSL2にDocker環境を構築してVSCodeのRemote-Containersを使ってみた, @GiantPanda?, Qiita, 2022, https://qiita.com/GiantPanda/items/39bb844d130d210026c7
VSCode+Dev Container+Docker+docker-composeの複数コンテナ開発環境構築, @ttnt1006, Qiita, 2022, https://qiita.com/ttnt1006/items/0b7cbbba401a61c54945

Windows11

Win11 WSL2/DevContainer

目次

訪問者

更新

最新の10件

人気の10件

MenuBar

Microsoft 提供の DevContainer ひな形の取得 †

Python3を起動してみる †

DevContaier?の中身を見てみる †

最小構成の DevContainer を作ってみる †

https://raw.githubusercontent.com/kagyuu/Python3-devcontainer/main/.devcontainer/Dockerfile

https://raw.githubusercontent.com/kagyuu/Python3-devcontainer/main/.devcontainer/devcontainer.json

docker-compose 版 †

参考文献 †