bicep 用 dev contaner
最近、bicep を触ることが多く。また、開発環境の再現性やポータビリティが気になることがママある。VSCode dev container[1]がなかなか便利だったので、bicep 用 dev contanerを作成した。[2]
作成に当たっては、下記の２つのレポジトリを参考にした。
- dev containers のレポジトリhttps://github.com/microsoft/vscode-dev-containers
- 各言語向けのdev containers 例：golanghttps://github.com/microsoft/vscode-remote-try-go
概要
大まかな流れととしては、下記の3段階となる。docker 絡みは、普通にDockerfileを書くのとほぼ同じだ。
- bicep dev containers 用のベースとなるDocker Image の作成
- dev containers の プレースホルダー用 Dockerfile の作成
- devcontainer.json の 作成
1. ベースとなるDocker Image の作成
大枠は、テンプレートvscode-dev-containers/container-templates/があるので、持ってくる。
mkdir vscode-dev-containers-bicep
cd vscode-dev-containers-bicep
cp -r ../vscode-dev-containers/container-templates/dockerfile/. .
今回は、ベースイメージを作成するDockerfileをbase.Dockerfileとして追加した。
script-libraryによく使われるパッケージのインストール用のスクリプトが用意されているので必要なのを持ってくる。ドキュメントは、この辺にある。ここでは、az cliとpowershellを入れる。手間をかけたくなければ、現状ではdebian/busterを baseのOSとして選ぶのが良い。
echo -n "common-debian.sh powershell-debian.sh azcli-debian.sh" | \
xargs -t -d ' ' -I {} cp ../vscode-dev-containers/script-library/{} .devcontainer/library-scripts/
bicep 用のインストールスクリプトを作る。bicep-debian.sh。やってることは、bicep本体のインストールと、vscode plugin のダウンロード。あと普段使いのツールもおまけで入れてる。bicep の vscode plugin は、まだmarket place に出てないので、ローカルにダウンロードして、devcontainer.jsonでフルパス指定で入れている。
作成した、bicep-debian.sh は、こんな感じで、主要部分は割りとシンプル。
... snip ...
# Install the Bicep CLI
# https://github.com/Azure/bicep/blob/master/docs/installing.md#install-the-bicep-cli
curl -Lo bicep https://github.com/Azure/bicep/releases/latest/download/bicep-linux-x64
chmod +x ./bicep
mv ./bicep /usr/local/bin/bicep
bicep --help
# Fetch the latest Bicep VSCode extension
curl -Lo vscode-bicep.vsix https://github.com/Azure/bicep/releases/latest/download/vscode-bicep.vsix
持ってきた、スクリプトと、bicep のインストール[3]をbase.Dockerfileに追加する。
作成したDockerfileを抜粋
... snip ...
RUN bash /tmp/library-scripts/common-debian.sh "${INSTALL_ZSH}" "${USERNAME}" "${USER_UID}" "${USER_GID}" "${UPGRADE_PACKAGES}" \
# Install the Azure CLI
&& bash /tmp/library-scripts/azcli-debian.sh \
# Install the powershell
&& bash /tmp/library-scripts/powershell-debian.sh \
# Install the bicep
&& bash /tmp/library-scripts/bicep-debian.sh \
# Clean up
&& apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts
Makefileを作ってあるので、下記のように実行するとbuildしてpushされる。[4]
make build push
2. Dockerfile を作る
Dockerfileで、先程作った、base.Dockerfile のイメージを利用する。このDockerfileは、プレースホルダーで、非常に簡単な感じになった。専用のイメージを作るべきか、どこまで入れるかはケースバイケースではある。
# See here for image contents: base.Dockerfile
ARG VARIANT="latest"
FROM takekazuomi/devcontainers-bicep:${VARIANT}
3. devcontainer.json を作成
ちょっと長いが、devcontainer.jsonを下記に全文引用。ポイントは、”extensions” で、docker image にダウンロードされてる、vscode-bicep.vsix をフルパス指定していること。フルパスで書くと、ローカルからロードしてくれる[#r5]_
{
"name": "Bicep",
"build": {
"dockerfile": "Dockerfile",
"args": {
"VARIANT": "latest"
}
},
"runArgs": [
"--cap-add=SYS_PTRACE",
"--security-opt",
"seccomp=unconfined"
],
// Set *default* container specific settings.json values on container create.
"settings": {
"terminal.integrated.shell.linux": "/bin/zsh"
},
// Add the IDs of extensions you want installed when the container is created.
"extensions": [
"ms-azuretools.vscode-docker",
"ms-vscode.azure-account",
"davidanson.vscode-markdownlint",
"ms-vscode.powershell",
"dandric.vscode-jq",
"redhat.vscode-yaml",
"dotjoshjohnson.xml",
"timonwong.shellcheck",
"editorconfig.editorconfig",
"/tmp/vscode-bicep.vsix"
],
// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "vscode"
}
最後に
dev container は割と簡単に作れるしカスタマイズも容易で利便性が高い。開発環境は、少し使っていると魔窟化してしまい再現性やポータビリティが無くなり、チーム開発などで環境を揃えたい場合に問題になりやすい。
その点Windows も問題だが、Linuxだとディストーションの違いや、パッケージのレポジトリを追加したり、細かいカスタマイズが効いたりなどの自由度の高さに起因して、更に問題が深刻化してしまうことがある。
dev container を使うとクリアな開発環境を維持しやすくなり問題のかなりの部分が解決できるのではないかと期待している。贅沢を言うと、VS Code だけでなく、他のエディターでも使ると嬉しいところではある。vimとかemacsとか。
参照
| [1] | Developing inside a Container |
| [2] | このBlogは、tinkererで書いてるのだが、 Windows + python だとなにかと辛く。python 環境をvenvから docker に移し、さらに dev container を使っうようにしたら。複数のライティング環境を維持しやすくなり苦しみが無くなった、素晴らしい。 |
| [3] | 最近、なんだかんだ言って task runner とての make は優秀だと思い直している。その昔、make の複雑さが嫌になって、ant にしたのだが、20年経って戻ってきたことになる |
| [4] | Build and image generation for vscode-dev-containers |
| [5] | vscode plugin をローカルからロードのにフルパスで書く方法がどこかに書いてあったと思うのだが原典が見つからない。見つかったら更新する |