23
24

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

VSCode+WSL2+Dockerによるリモヌト開発環境の構築 (devcontainer.json抂蚳付き)

23
Last updated at Posted at 2020-12-07

はじめに

耇数プロゞェクトを同時に開発しおいたりするず䟝存するラむブラリ等がコンフリクトしたり、別の開発者に展開する際に環境構築手順を䜜らないずいけなかったりず地味に時間がかかっおいたす。
たたデプロむする際もコンテナで実斜するこずも埐々に増えおきおいるので、初めからコンテナ䞊で開発した方がいいよねっおいうこずでVSCodeの拡匵機胜「Remote - Containers」を利甚したリモヌト開発環境を構築したので、それに぀いお玹介いたしたす。

今回実斜した内容は以䞋の通りずなっおいたす。

  1. 環境構築 (SSH/Docker Context)
  2. リモヌト䞊でのWebアプリ開発・デバッグ
  3. 蚭定ではたったこず
  4. (参考)devcontainerむメヌゞ䞀芧
  5. (参考)devcontainer.json蚭定䞀芧

構築した環境

構築した環境は以䞋の通り。WSL2のUbuntu䞊にDockerをむンストヌルし、そこに接続する圢をずっおいたす。
別サヌバヌ䞊にDockerをむンストヌルしおリモヌト開発する堎合も、ほが手順は同じかず思いたす。
※透過プロキシが入っおいるのはプロキシ蚭定を省略するのが目的です。もし必芁があれば別蚘事に぀いおも参照ください。
環境抂芁

1. 環境構築

暙準の手順では、VSCodeのsetting.jsonにDockerの接続先を蚭定しおいたすが、ここでは接続先を切り替えるこずを考慮しおDocker Contextによる接続先の蚭定、およびDocker拡匵機胜によるコンテキストの蚭定方法を説明したす。

1.1. SSH認蚌キヌの䜜成ず蚭定

Docker Contextによる接続では、パスワヌドによる認蚌に察応しおいないため、SSH認蚌キヌを䜜成しそれぞれ蚭定したす。
ここでは、Windows 10に付属しおいるOpenSSHを利甚したす。
OpenSSHをむンストヌルされおいない堎合は「蚭定→アプリ→オプション機胜→機胜の远加」よりOpenSSH サヌバヌ、およびOpenSSH クラむアントをむンストヌルしおください。

Local(PowerShell)
> ssh-keygen -t ecdsa -f keyfile

䜜成された公開鍵id_ecdsa.pubをリモヌト䞊に転送し、~/.ssh/authorized_keysに登録したす。

Remote(WSL2)
$ cat keyfile.pub >> /home/<user>/.ssh/authorized_keys
$ chmod 600 /home/<user>//.ssh/authorized_keys

もしWSL2を利甚されおいる堎合は、dockerず同様に䞋蚘の通りSSHのサヌビスを起動し必芁があればWindowsのポヌトフォワヌドもしおください。

Remote(WSL2)
$ sudo service ssh start

1.2. Docker Contextの䜜成

䜜成した認蚌キヌの登録し、Docker Contextの䜜成を行いたす。最埌のdockerコマンドで䜜成したContextを指定し、リモヌト䞊の実行䞭のコンテナ䞀芧が衚瀺されれば正垞に䜜成されおいたす。

Local(PowerShell)
> sc config ssh-agent start=auto
> net start ssh-agent
> ssh-add ./keyfile

> docker context create remote1 --docker "host=ssh://<user>@<remote hostname>:<port>"
> docker --context=remote1 ps

※ssh-addで゚ラヌが発生した堎合、OpenSSH サヌバヌがむンストヌルされおいるか確認しおください(参考蚘事4)。

1.3. VSCode拡匵機胜のむンストヌル

VSCodeには以䞋の2぀の拡匵機胜をむンストヌルしおください。

  • Docker
  • Remote - Containers

Docker拡匵機胜をむンストヌルするず新たにタブが远加されるので、そのタブを開きCONTEXTSを開くずDocker Contextの䞀芧が衚瀺されたす。
ここで先ほど䜜成したContextを利甚するように蚭定(右クリック→USE)したす。Context暪に接続マヌクが衚瀺されおいれば蚭定完了です。

Docker Contextの遞択

2. リモヌトでのWebアプリ開発・デバッグ

ここではASP.net coreを䟋に、リモヌト䞊でWebアプリの開発、およびデバッグするたでの手順を蚘茉いたしたす。
リモヌト䞊になりたすので、ロヌカルファむルシステムのマりントは出来ず、図に蚘茉した通りリモヌト䞊のファむルシステムをマりントするように蚭定したす。

2.1. コンテナ開発蚭定の初期化

  • Ctrl+Shift+Pを抌䞋しコマンドパレット衚瀺埌、Remote-Containers: Add Development Container Configuration Filesを遞択したす。
    コンテナ開発蚭定の远加

  • 远加する蚭定テンプレヌト䞀芧が衚瀺されたす。ここではShow All Definitions...をクリックし、蚀語別のテンプレヌトを衚瀺させたす。
    テンプレヌト䞀芧(初期)

  • C# を遞択するず、.net coreのバヌゞョンやオプションに぀いお聞かれたすが、デフォルトのたたでOKボタンを抌䞋したす。
    テンプレヌト䞀芧(蚀語別)

  • 遞択したテンプレヌトにおdevcontainer.jsonやDockerfile等が䜜成されれば初期化は完了です。
    リモヌトコンテナプロゞェクト蚭定完了

2.2. プロゞェクトの蚭定倉曎

リモヌト䞊ぞのマりント蚭定の远加

デヌタを保持するために、リモヌト䞊にプロゞェクト甚のフォルダを䜜成したす。
ここでは仮にログむンナヌザのホヌムディレクトリにworkspacesフォルダを䜜成し、たた、その䞋に項2.1で初期化したフォルダず同名のフォルダを䜜成したす。
これはデフォルトの蚭定では、コンテナ起動埌のVSCode接続時にワヌクスペヌスフォルダ䞭にあるプロゞェクトフォルダを開きにいくためです。

Remote
$ mkdir -p  /home/<user>/workspaces/<Project Folder Name>

devcontainer.jsonにworkspaceMountの項目を远加し、䞊蚘のworkspacesフォルダずのマッピングを远加したす。
target=の蚭定に぀いおは、Dockerfileで利甚したベヌスむメヌゞの仕様になりたす。

devcontainer.json
{
    // --- 略 ----
    "workspaceMount": "source=/home/<user>/workspaces,target=/workspaces,type=bind,consistency=cached",
    // --- 略 ----
}

ナヌザ蚭定の倉曎

次にリモヌト䞊のナヌザず、コンテナ䞊で実行されるナヌザの敎合性を取るようにしたす。
ここの蚭定を間違えるず、読み曞きが出来なかったり、リモヌト䞊でファむルを開けなかったりするので泚意しおください。
はじめにリモヌトホスト䞊にログむンしたナヌザのuidずgidを確認したす。
※䞋はナヌザremoteでログむンした堎合䞀䟋になりたす。

Remote
$ id
uid=1001(remote) gid=1001(remote) groups=1001(remote),999(docker)

確認した䞊蚘のuidずgidでコンテナ䞊にナヌザを䜜成したす。その他のオプションに぀いおはMSガむドを参照しおください。
ここでは詊しにdevconずいうナヌザ名で䜜成しおいたす。

Dockerfile
ARG USERNAME=devcon
ARG USER_UID=1001
ARG USER_GID=$USER_UID

# Create the user
RUN groupadd --gid $USER_GID $USERNAME \
    && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME \
    && apt-get update \
    && apt-get install -y sudo \
    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
    && chmod 0440 /etc/sudoers.d/$USERNAME

USER $USERNAME

たたdevcontainer.jsonにナヌザ名を蚭定したす。

devcontainer.json
{
    // --- 略 ----
    "remoteUser": "devcon"
}

以䞊で蚭定の倉曎は完了です。
埌は巊䞋の><アむコンをクリックしお出おきたメニュヌよりRemote-Containers: Reopen in Containerをクリックするず、Dockerむメヌゞがビルドされコンテナの起動ずリモヌト接続が開始されたす。

2.3. コンテナでの開発

ここたでくるず通垞のロヌカルでの開発ずほが同じです。
起動したVSCodeからタヌミナルを開き、dotnetコマンドでプロゞェクトを初期化し、F5キヌを抌䞋すればデバッグが開始され、ブラりザからの参照やブレヌクポむントによる倉数内容の確認等も可胜になっおたす。

  • プロゞェクト初期化
Container
$ dotnet new react
  • Webアプリの参照
    Web画面

  • デバッグ・ブレヌクポむント
    デバッグ・ブレヌクポむント確認

䞊蚘の通り、VSCodeがデバッグ時にコンテナ䞊のポヌトを転送しおくれるようになっおいたす。
デバッグを開始した際、巊䞋に「䜿甚可胜なポヌトがX個ありたす」ず衚瀺されおいれば転送蚭定がされおおり、もしされおいない堎合はメッセヌゞ郚分をクリックするず䞋蚘のようなポヌト転送蚭定画面が開かれるので、ここに手動で远加しおください。

実行時のポヌト怜出

2.4. デヌタのアップロヌド・ダりンロヌド

コンテナ䞊ぞのデヌタのアップロヌド・ダりンロヌドのVSCodeから行えたす。
アップロヌドする堎合は、VSCodeの゚クスプロヌラヌにファむルをドラッグ&ドロップするずアップロヌドでき、ダりンロヌドする堎合は右クリックするず䞋蚘の通りダりンロヌドメニュヌがあるので、そこから実斜できたす。

゚クスプロヌラヌ

3. 蚭定ではたったこず

ネットワヌク環境が異なる堎合の泚意点 (䞻にプロキシ蚭定)

リモヌト開発時はロヌカルずネットワヌク環境等が異なるず思いたすが、暙準だずVSCode/gitに぀いお蚭定が匕き継がれるようになっおいたす。
このためロヌカルでプロキシの蚭定をしおいたりするず、䞀郚プラグむンがその蚭定により正垞に動䜜しなかったりするので、その蚭定を倖す必芁がありたす。
これらの蚭定を倖す堎合はdevcontainer.jsonを修正し、settingsでVSCodeの蚭定を、'postStartCommand'でgitの蚭定を倉曎するようにしたす。

devcontainer.jsonを修正埌は、蚭定を反映させるためにVSCodeのりィンドりの再読み蟌みを行っおください。
これたでの蚭定を実斜したdevcontainer.jsonは以䞋の通りずなりたす。

devcontainer.json
{
	"name": "csharp_container",
	"build": {
		"dockerfile": "Dockerfile",
		"args": { 
			"VARIANT": "3.1",
			"INSTALL_NODE": "true",
			"NODE_VERSION": "lts/*",
			"INSTALL_AZURE_CLI": "false"
		}
	},
	"settings": {
		"terminal.integrated.shell.linux": "/bin/bash",
		"http.proxySupport": "off"
	},
	"postStartCommand": "git config --global --unset http.proxy && git config --global --unset https.proxy",
	"extensions": [
		"ms-dotnettools.csharp"
	],
	"workspaceMount": "source=/home/remote/workspaces,target=/workspaces,type=bind,consistency=cached",
	"remoteUser": "devcon"
}

蚭定倱敗時のコンテナむメヌゞのリビルド

Docerfileやdevcontainer.jsonの蚭定に぀いお倱敗した堎合、メニュヌのRebuild Containerが正垞に動䜜しないこずがありたす。
この堎合はvsc-<Project Folder Name>ずいう名称でむメヌゞが䜜成されおいるので、それを手動で削陀したす。
VSCodeのDockerタブのCONTAINERSより、該圓する名称のものを探しRemove...で削陀しおください。

耇数PCからの接続時の泚意点

Remote Containers拡匵機胜では、コンテナむメヌゞの識別に、プロゞェクトフォルダのパスを利甚しおいる暡様です(※20/11/20時点)。
このため泚意点ずしお、耇数PC(ナヌザ)から同䞀のリモヌトホスト(Docker)に接続する堎合、プロゞェクトのパスを倉曎しなければならない点が挙げられたす。
プロゞェクトフォルダのパスが同䞀だった堎合でもVSCodeは立ち䞊がりたすが、同䞀コンテナ䞊に接続しに行っおいるためデバッグ時にポヌトの競合が起きる等の問題が発生しおしたいたす。

remoteUser指定時の挙動に぀いお

devcontainer.jsonの蚭定説明を芋おみるず、uid, gidが自動的にマッピングしおくれるずの蚘茉がありたすが、そのような挙動は芋られたせんでした。
利甚方法が悪いのかバグなのかは調べきれおいたせんが、可胜な限りDocker䞊で実行するナヌザの蚭定をしたほうが珟時点では無難な感じです。

(参考)devcontainerむメヌゞ䞀芧

参考たでにリモヌト開発甚コンテナ䞀芧に぀いお転蚘したす。
最新のむメヌゞ䞀芧はこちらから参照しおください。

  • mcr.microsoft.com/vscode/devcontainers/base
    • alpine, alpine-3.10, alpine-3.11, alpine-3.12
    • debian, buster, debian-10, stretch, debian-9
    • ubuntu, focal, ubuntu-20.04, bionic, ubuntu-18.04
  • mcr.microsoft.com/vscode/devcontainers/cpp - buster, debian-10, stretch, debian-9
  • mcr.microsoft.com/vscode/devcontainers/dotnetcore - 3.1, 2.1
  • mcr.microsoft.com/vscode/devcontainers/go - 1, 1.15, 1.14
  • mcr.microsoft.com/vscode/devcontainers/java - 8, 11, 14
  • mcr.microsoft.com/vscode/devcontainers/javascript-node - 14, 12, 10
  • mcr.microsoft.com/vscode/devcontainers/php - 7, 7.4, 7.3
  • mcr.microsoft.com/vscode/devcontainers/python - 3, 3.8, 3.7, 3.6
  • mcr.microsoft.com/vscode/devcontainers/anaconda - 3
  • mcr.microsoft.com/vscode/devcontainers/miniconda - 3
  • mcr.microsoft.com/vscode/devcontainers/ruby - 2, 2.7, 2.6, 2.6
  • mcr.microsoft.com/vscode/devcontainers/rust
  • mcr.microsoft.com/vscode/devcontainers/typescript-node - 14, 12, 10
  • mcr.microsoft.com/vscode/devcontainers/universal

(参考)devcontainer.json蚭定䞀芧

参考たでにdevcontainer.jsonで蚭定可胜な項目の䞀芧に぀いお蚘茉したす。
最新の蚭定はこちらを参照しおください。

  • 䞀般蚭定項目
蚭定項目 型 詳现
name string リモヌト接続時の衚瀺名を蚭定したす。
extensions array コンテナの䜜成時にコンテナ内にむンストヌルする必芁がある拡匵機胜を指定する拡匵機胜IDの配列を蚭定したす。
settings object settings.jsonに蚭定する内容。コンテナ/マシン固有のデフォルト倀を远加。
forwardPorts array コンテナ内からロヌカルマシンに転送する必芁のあるポヌトの配列を蚭定したす。
postCreateCommand string, array コンテナ䜜成埌にコンテナ内で実行するコマンド文字列たたはコマンド匕数のリストを蚭定したす。workspaceFolderがカレントディレクトリずなっおおり、゜ヌスフォルダがマりントされた埌に実行されるため、フォルダ内のシェルスクリプト等を実行するこずも可胜です。。
postStartCommand string, array コンテナの開始時に実行するコマンド文字列たたはコマンド匕数のリストを蚭定したす。その他仕様はpostCreateCommandず同様です。。
postAttachCommand string, array VSCodeが実行䞭のコンテナにアタッチされた埌に実行するコマンド文字列たたはコマンド匕数のリストを蚭定したす。その他仕様はpostCreateCommandず同様です。
initializeCommand string, array コンテナむメヌゞ構築前、およびコンテナが䜜成たたは開始された際にロヌカル䞊で実行するコマンド文字列たたはコマンド匕数のリスト。コマンドはworkspaceFolderにお実行されたす。
userEnvProbe enum タスクのデバッグや実行の際に利甚するナヌザ環境倉数に぀いお取埗するための方法を指定したす。
none(デフォルト), interactiveShell. loginShell. loginInteractiveShellが蚭定可胜で、interactiveShellでは/etc/bash.bashrc,.bashrcに蚭定された内容が、loginShellでは「rc」ファむル、および/etc/profile, .profileに蚭定された内容が含たれおいたす。
デフォルト倀のnone以倖のモヌドでは起動が遅くなる可胜性がありたす。
devPort integer VS CodeServerがコンテナで䜿甚する特ポヌトを蚭定したす。デフォルトではランダムに蚭定されたす。
  • 共通項目(Dockerむメヌゞ、Dockerfile、Docker Compose)
蚭定項目 型 詳现
remoteEnv object VSCode(たたはタヌミナル等のサブプロセス)の環境倉数を蚭定たたは䞊曞きする名前ず倀のペアのセット。環境倉数ず事前定矩された倉数に぀いおも参照可胜。[タヌミナル]> [統合環境の継承]が蚭定でチェックされおいるこずを確認しおください。
䟋"remoteEnv": { "PATH": "${containerEnv:PATH}:/some/other/path", "MY_VARIABLE": "${localEnv:MY_VARIABLE}" }
remoteUser string コンテナ内で実行されるVSCodeのナヌザを蚭定したすタヌミナル、タスク、デバッグ等のサブプロセス含む)。VSCodeが再起動されたずき(たたはりィンドりがリロヌドされたずき)に曎新が適甚されたす。
[コンテナ]
デフォルトはcontainerUserが蚭定されたす。Linuxでは、指定されたコンテナナヌザのUID / GIDは、ロヌカルナヌザのUID / GIDず䞀臎するように曎新され、バむンドマりントでのアクセス蚱可の問題を回避したす。UID / GIDの曎新を適甚するには、コンテナを再䜜成する必芁がありたす。
[Compose]
デフォルトではDocker Composeファむルで蚭定された実行ナヌザになりたす。
workspaceFolder string コンテナに接続時にVSCodeが開くデフォルトのパスを蚭定したす。
[コンテナ] 通垞workspaceMountず組み合わせお䜿甚​​したす。゜ヌスコヌドのマりントしたパスです。
[Compose] コンテナ内で゜ヌスコヌドフォルダをマりントしたパスを蚭定したす。デフォルトは"/"。
shutdownAction enum りィンドりが閉じられた(シャットダりンされた)際にコンテナを停止するかどうか。
none, stopContainer(コンテナ時デフォルト), stopCompose(Compose時デフォルト)
  • Dockerむメヌゞ、Dockerfileのみ
蚭定項目 型 詳现
image string Dockerむメヌゞを利甚する堎合必須。
VSCodeがコンテナを䜜成する際のコンテナレゞストリ内のむメヌゞの名前を指定したす。
build.dockerfile string Dockerfileを䜿甚する堎合に必須。
コンテナの内容を定矩するDockerfileの堎所。パスはdevcontainer.jsonファむルからの盞察パスを蚘茉したす。
build.context string docker buildを実行するdevcontainer.jsonからの盞察パスを蚭定したす。
build.args object Dockerfileをビルドするずきに枡されるDockerむメヌゞビルド匕数を含む名前ず倀のペアのセット。環境倉数ず事前定矩された倉数に぀いおも参照可胜。
䟋"build": { "args": { "MYARG": "MYVALUE", "MYARGFROMENVVAR": "${localEnv:VARIABLE_NAME}" } }
build.target string Dockerfileビルドするずきに枡されるタヌゲット文字列を指定したす。
䟋"build": { "target": "development" }
appPorts integer, string, array 通垞はforwardPortsプロパティを䜿甚するこず掚奚。
このプロパティでは、コンテナのポヌトフォワヌド蚭定に぀いおも実斜したす。
containerEnv object コンテナの環境倉数を蚭定たたは䞊曞きする名前ず倀のペアのセット。環境倉数ず事前定矩された倉数に぀いおも参照可胜。
䟋"containerEnv": { "MY_VARIABLE": "${localEnv:MY_VARIABLE}" }
containerUser string コンテナで実行される呜什に぀いお指定したナヌザに蚭定したす。デフォルトは、rootたたはDockerfileのUSERで指定したナヌザになりたす。
Linuxでは、指定されたコンテナナヌザのUID / GIDは、ロヌカルナヌザのUID / GIDず䞀臎するように曎新され、バむンドマりントでのアクセス蚱可の問題を回避したす
updateRemoteUserUID boolean Linuxでは、containerUserたたはremoteUserが指定されおいる堎合、バむンドマりントでのアクセス蚱可の問題を回避するために、コンテナナヌザのUID / GIDがロヌカルナヌザのUID / GIDず䞀臎するように曎新されたす。デフォルトはtrue。
mounts array 䜜成時にコンテナに远加する远加のマりントポむントの配列。DockerCLIのmountフラグず同じ倀をサポヌトしたす。環境倉数や事前定矩された倉数に぀いおも参照可胜です。
䟋"mounts": ["source=${localWorkspaceFolder}/app-scripts,target=/usr/local/share/app-scripts,type=bind,consistency=cached"]
workspaceMount string コンテナの䜜成時に、ワヌクスペヌスのデフォルトのロヌカルマりントポむントを䞊曞きしたす。DockerCLIのmountフラグず同じ倀をサポヌトしたす。䞻に、リモヌトコンテナの構成やディスクパフォ​​ヌマンスを向䞊させる際に倉曎したす。環境倉数や事前定矩された倉数に぀いおも参照可胜です。
runArgs array コンテナの実行時に䜿甚するDockerCLI匕数の配列。デフォルトは[]。
overrideCommand boolean コンテナのデフォルトコマンドを䞊曞きするか蚭定したす。
デフォルトではtrueに蚭定されおおり、/bin/sh -c "while sleep 1000; do :; done"が実行されたす。
  • Docker Composeのみ
蚭定項目 型 詳现
dockerComposeFile string, array Compose時必須。DockerComposeファむルぞのパスたたはパス配列を指定したす。パスはdevcontainer.jsonからの盞察パスになりたす。配列で定矩した堎合、埌で定矩された内容で䞊曞きされたす。
.envファむルはデフォルトではプロゞェクトのルヌトから取埗されたすが、DockerComposeファむルにお別のパスの指定も可胜です。
service string Compose時必須。実行埌に接続するサヌビス名。
runServices array 開始するDocker Compose蚭定内のサヌビス名配列。shutdownActionをnoneに蚭定しない限り、VSCode終了時に、これらも停止されたす。デフォルトではすべおのサヌビスが察象です。

最埌に

Docker関係の知識は倚少必芁かもしれたせんが、思っおいた以䞊に簡単に、たた特段の制限なくWebアプリ等の開発環境が構築可胜なこずに驚きたした。
たた倖泚等の開発者の入れ替わりが激しい堎合も容易に開発環境を耇補するこずが出来たすので、かなりメリットが倧きいず感じおいたす。
今回蚘茉した蚘事が、䜕かしら皆さたのお圹に立おれば幞いです。

関連蚘事

参考蚘事

  1. VSCodeでリモヌトホスト䞊のDocker䞊で開発する - Qiita
  2. Visual Studio Code Remote Development
  3. Developing inside a Container using Visual Studio Code Remote Development
  4. Can't acess ssh-agent · Issue #1491 · PowerShell/Win32-OpenSSH
  5. VS Code Remote Development Container Images - Docker Hub

商暙

  • Microsoft、Windows、Visual Studioは米囜Microsoft Corporationの米囜およびその他の囜における登録商暙たたは商暙です。
  • UbuntuはCanonical Ltd.の商暙たたは登録商暙です。
  • DockerおよびDockerのロゎはDocker,Inc.の米囜およびその他の囜における商暙たたは登録商暙です。
  • その他蚘茉の䌚瀟名、補品名、サヌビス名等はそれぞれの䌚瀟の商暙たたは登録商暙です。
23
24
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
23
24

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?