🔖

Wslconfigを使用したWSL2の設定

2021/06/05に公開

概要

WSL2 の設定について調べた備忘録です。
今回の記事についてはMicrosoft ドキュメントをメインに引用しております。
https://docs.microsoft.com/en-us/windows/wsl/wsl-config#configure-global-options-with-wslconfig

設定

使用可能な環境

Windows ビルド19041以降で使用可能です。
コマンドの実行はコマンドプロンプトもしくは PowerShell で行ってください。

設定ファイル

C:\Users\<yourUserName>\.wslconfigファイルを作成し、そのファイルに設定を書き込んでいきます。

サンプルは以下です。

[wsl2]
kernel=C:\\temp\\myCustomKernel
memory=2GB
processors=1

WSL2 の設定

セクションラベルは[wsl2]です。
wslconfigファイルにはKey=Valueの形で記載していきます。

Key Value default 備考
kernel string Microsoft が提供するカーネル Windows 上にてカスタム Linux カーネルへの絶対パスを指定する。
memory size Windows 上の合計の 50%か 8GB のいずれか少ない方。ビルド20175以前は Windows の合計メモリの 80%。 WSL2 VM に割り当てるメモリ量。
processors number Windows 上と同じ数のプロセッサ数。 WSL2 VM に割り当てるプロセッサ数。
localhostForwarding boolean true WSL 2 VM のワイルドカードまたはlocalhostにバインドされたポートがlocalhost:portを介してホストから接続可能である必要があるかどうかを指定するブール値。
kernelCommandLine string なし 追加のカーネルコマンドライン引数。
swap size Windows 上のメモリサイズの 25%に最も近い GB に切り上げられた単位値。 WSL 2 VM に追加するスワップ領域の大きさ。スワップファイルがない場合は 0。
swapFile string %USERPROFILE%\AppData\Local\Temp\swap.vhdx Windows 上でのスワップバーチャルハードディスクへの絶対パス。

pathを指定する場合はエスケープされた円記号を含む Windows パスである必要があります。
sizeを指定する場合はサイズの後に単位が続く必要があります(例: 8GB, 256MB)。

変更の有効化

変更を有効にするためにはwsl --shutdownコマンドにて WSL2 VM を再起動する必要があります。

参考文献

https://docs.microsoft.com/en-us/windows/wsl/wsl-config#configure-global-options-with-wslconfig
https://roy-n-roy.github.io/Windows/WSL&コンテナ/wslconfig/
https://ascii.jp/elem/000/004/044/4044122/

Discussion