Windows10 2004でWSL2を設定してVSCodeからDockerに接続する

Windows10のバージョン2004から正式にWSL2が利用可能になりました。WSLとWSL2の大きな違いの一つとして、Dockerの利用可否があげられます。
WSLではLinuxシステムコールをWindowsカーネルのものに変換する、という仕組みだったのに対し、WSL2では軽量のLinux VMを動作させる仕組みに変わったので、WSLでは実現できなかったDockerの利用が可能になりました。
WSL2を利用する主目的が、開発環境構築のためのDockerの利用という人も多いんじゃないかなぁ、と思いますので、今回はWSL2の導入からWSL2上へのDockerの導入、更にWindows側のVSCodeからWSL2上で動かしているDockerコンテナへリモート接続するところまでを試してみます。

Windows 10のバージョンを2004以降に上げる

現在のバージョンは Windowsの設定 > システム > バージョン情報 > Windowsの仕様 > バージョン に記載されております。

ここが2004以降でない場合、WSL2の利用にはバージョンアップが必要です。
Windows10ダウンロードサイトの「今すぐアップデート」を押下して、アップデートファイルを入手して実行することでアップデートします。

CPUの仮想化支援機能の有効化

WSL2の動作には、CPUの仮想化支援機能(Intel VT-X/AMD-V)が有効になっていることが必要です。
そのため、
①CPUが仮想化支援機能に対応していること
②BIOSで仮想化支援機能が有効になっていること
が必要です。

①に関してはよほど古いCPUでない限り対応しています。
②も、デフォルトで有効になっているPCやマザーボードが多いですが、こちらは無効になっていることがあり得ますので、確認が必要です。

自分の環境で仮想化支援機能が有効かどうかは、タスクマネージャーから確認できます。
タスクマネージャー > パフォーマンス > CPU > 仮想化 が「有効」ならば、仮想化支援機能が有効になっています。

「無効」だった場合は、BIOSから設定を有効にする必要があります。設定はPCやマザーボードによって異なるため、ググったりメーカーに問い合わせたりしてご確認ください。

※ちなみに筆者の私用PCのマザーボード、X470 AORUS ULTRA GAMINGでは、UEFI BIOSの以下の項目でした。
M.I.T > Advanced Frequency Settings > Advanced CPU Core Settings > SVM Mode の "Disabled"を"Enabled"に変更

WSLの有効化

1. コントロールパネルの「Windows の機能の有効化または無効化」を開きます。Windowsの設定の検索バーに「Windowsの機能」まで入力すれば出てきます。
   
2. 「Linux用Windowsサブシステム」と「仮想マシンプラットフォーム」にチェックを入れ、OKを押下します。
   
   再起動を促されるので再起動します。

※なお、WSL2の利用では「Hyper-V」や「Windowsハイパーバイザ―プラットフォーム」にはチェックを入れる必要はありません。
Hyper-Vで予約されているポートをWSLから利用したい場合などに面倒なようなので、Hyper-Vと併用の必要がなければチェックを外しておいたほうがよさそうです。
「Windowsハイパーバイザ―プラットフォーム」についてはこちらが詳しいです。

Linuxディストリビューションのインストール時に、WSL2が既定になるように設定する

PowerShellを管理者権限で実行し、以下のコマンドを実行します。

wsl --set-default-version 2

これにより、LinuxディストリビューションがWSL2としてインストールされるようになります。

カーネルコンポーネントの更新

WSL2向けにLinuxカーネルを更新します。
https://docs.microsoft.com/ja-jp/windows/wsl/wsl2-kernel
に従い、カーネル更新プログラムを適用します。

Linuxのインストール

Microsoft StoreからLinuxディストリビューションをインストールします。
https://www.microsoft.com/ja-jp/search/shop/apps?q=linux
からお好みのディストリビューションを選択して「入手」を押下します。特に拘りがない場合はUbuntuを選んでおけばいいでしょう。
Microsoft Store上でインストールが完了したら「起動」を押下します。

起動したら、コンソール画面が開き、ユーザー名とパスワードを設定するよう要求されます。
設定が完了したらそのまま、コンソール画面内にLinuxのCLIが起動します。

一旦exitと入力し、Linuxを終了します。

LinuxのWSLバージョンの確認/WSL1からWSL2への変換

powershellより以下のコマンドで、現在インストールされているディストリビューションの一覧を表示することができます。

wsl --list -v

VERSION部分がWSLのバージョンになります。また、デフォルト設定(コンソール上でただwslやbashコマンドを実行した際に起動するディストリビューション)のディストリビューションには左にスターがついています。
wsl --set-default-version 2を行った後にLinuxをインストールした場合、最初からWSL2としてインストールされているはずです。
一方、既にWSL1で利用していた環境がある場合(VERSION部分が1のもの)、その環境をWSL2に変換することもできます。以下のコマンドを利用してください。

wsl --set-version ${ディストリビューション名} 2
例: wsl --set-version Ubuntu-20.04 2

ここまででWSL2のLinux環境の設定は完了です。

Docker Desktopのインストール

ここからはDockerの設定に入ります。今回の記事ではDockerの設定にDocker Desktopを利用します。
WSL2のLinux内でDockerの設定を行ってもいいのですが、Docker Desktopを利用することで、以下のメリットが得られます。

• Dockerのセットアップをインストーラで容易に完了できる
• Windows側(PowerShell)とLinux側(WSL2)の両方からコンテナを操作できる

Docker Desktopのインストールは以下の手順で行います。

1. https://www.docker.com/products/docker-desktop の、"Download for Windows(stable)"からインストーラをダウンロードし、インストーラを実行。

2. "Configuration"で、"Enable WSL 2 Windows Features"にチェックが入った状態でOkを押下。

3. "Installation succeeded"で"Close and log out"を押下すると、インストーラのウィンドウが閉じ、サインアウトされる。そのままWindowsを再起動する。

4. Windowsにログイン後、少し待つと、デスクトップ右下のインジケータ内にDocker Desktopのアイコンが立ち上がる。"Docker Desktop is running"になるまで待つ。
   
   runningになったら、アイコンをクリックし、メニュー内の"Settings"をクリックする。

5. Settings画面で以下の項目を実施する。

• General > Use the WSL 2 based engine にチェックが入っていることを確認
• Resource > WSL INTEGRATION を設定し、"Apply & Restart"
  • WSLでデフォルト設定されたディストリビューションでDockerコンテナを起動したい場合は"Enable integration with my default WSL distro"にチェック
  • デフォルト設定でないディストリビューションでDockerコンテナを起動したい場合は、"Enable integration with additional distros:"の該当のディストリビューションのトグルをONにする
    

Dockerコンテナの作成/起動

Docker Desktopの設定が完了すれば、dockerコマンドでコンテナの操作が可能になっているはずです。試しに公式のgolangコンテナを起動してみます。
docker runコマンドでコンテナの作成と起動を一度に行えます。powershellからやってみます。(先述したように、WSL内から実行することも可能です。)

docker run -it golang

コンテナが起動します。

VSCodeにRemote Development Extensionをインストール

起動中のコンテナにVSCodeから接続してみましょう。そのためにはRemote Development Extensionが必要です。
https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack
のInstallからVSCodeにExtensionをインストールします。

VSCodeからWSL2内で実行中のDockerコンテナに接続

ここまでくればあともう一息です。VSCode上でコマンドパレットを開き(キーバインドを変更していなければCtrl+Shift+P)、"remote"と入力します。
候補が出てくるので、その中の"Remote-Containers: Attach to Running Container..."を選択します。

すると、実行中のWSL2内で実行中のDockerコンテナが一覧でリストされるため、VSCodeで開きたいコンテナを選択します。

VSCodeが別ウィンドウで起動し、ワークスペースとしてDockerコンテナを開きます。左下に接続中のコンテナが表示されています。

コンテナ内のファイルをVSCode上で閲覧/編集するためには、エクスプローラの「フォルダーを開く」からコンテナ内のディレクトリを指定して"ok"を押下します。

これで、VSCode上から、WSL2上のDockerコンテナ内のファイルを操作しての開発が可能になりました。

参考

https://qiita.com/kikiki/items/df9874bae23f3c271ea2
https://qiita.com/matarillo/items/ca1eecf8f9a3cd76f9ce
https://qiita.com/iridon0920/items/005a9224343413b74f78
https://qiita.com/yito/items/1edd82414dfc2ab2a7bc
https://support.bluestacks.com/hc/ja/articles/115003174386-PCでバーチャライゼーション-VT-を作動させるには-
https://dev.to/birdsea/windows-subsystem-for-linux-2-docker-for-wsl2-3dpm
https://docs.microsoft.com/ja-jp/windows/wsl/wsl2-kernel
https://docs.microsoft.com/ja-jp/windows/wsl/install-win10