Add WSL2 setup tutorial [Docs]#661
Conversation
✅ Deploy Preview for urunc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
cmainas
left a comment
cmainas
left a comment
There was a problem hiding this comment.
Hello @abhaygoudannavar ,
thank you for the PR. The tutorial looks good. I have left some comments.
|
|
||
| ### Verify KVM support | ||
|
|
||
| `urunc` requires KVM for hardware-accelerated virtualization. On WSL2, |
There was a problem hiding this comment.
We should change this to: "Some of urunc supported monitors require KVM" or something similar.
| lsmod | grep dm_thin | ||
| ``` | ||
|
|
||
| If the output is empty, you must use the `overlayfs` snapshotter |
There was a problem hiding this comment.
I think the blockfile snapshotter should work as well.
|
|
||
| ## Using `nerdctl` instead of Docker | ||
|
|
||
| On WSL2, **Docker Desktop** manages its own containerd instance, which |
There was a problem hiding this comment.
Instead of docker desktop, an installation of docker inside ubuntu should work fine.
| Install `nerdctl` and the required CNI plugins by following the official | ||
| [nerdctl documentation](https://github.com/containerd/nerdctl#install). | ||
|
|
||
| Make sure the CNI plugins (`bridge`, `portmap`, etc.) are installed |
There was a problem hiding this comment.
We do not have to be that pedantic with the checks.
| # Running `urunc` on WSL2 | ||
|
|
||
| In this tutorial, we describe how to set up and run `urunc` on | ||
| **Windows Subsystem for Linux 2 (WSL2)** using **QEMU** as the |
There was a problem hiding this comment.
I do not see any reason for other monitors not to work.
abhaygoudannavar
force-pushed
the
docs/wsl2-tutorial
branch
from
738064c to
cbff3ef
Compare
|
@cmainas i have made some changes. |
|
Thank you @abhaygoudannavar for the changes. Have you verified that blockfile works as expected? |
|
@cmainas I tested the blockfile snapshotter on WSL2. As shown in the screenshot, containerd skips loading the blockfile plugin (skip status), and running a container with --snapshotter blockfile fails with snapshotter not loaded: blockfile: invalid argument. i have updated the tutorial to only recommend overlayfs as the alternative snapshotter and remove the blockfile reference. |
Add a tutorial describing how to set up and run urunc on WSL2, covering KVM verification, snapshotter configuration (overlayfs), and nerdctl/Docker usage. The blockfile snapshotter was tested and confirmed not to work on WSL2 (containerd skips it with 'no scratch file generator' error), so only overlayfs is recommended. Refs: urunc-dev#643 Signed-off-by: Abhay Goudannavar <abhaysgoudnvr@gmail.com>
abhaygoudannavar
force-pushed
the
docs/wsl2-tutorial
branch
from
0acd6c4 to
72ee084
Compare
2 participants
Add a tutorial describing how to set up and run urunc on WSL2, covering KVM verification, snapshotter configuration (overlayfs vs devmapper), and nerdctl usage.
Refs: #643
Description
Add a new tutorial (
docs/tutorials/Running-urunc-on-wsl2.md) that guides Windows/WSL2 users through running urunc on their environment. The tutorial covers:nerdctlis recommended over Docker Desktop on WSL2overlayfssnapshotter since WSL2 lacks thedm_thin_poolkernel moduleThe tutorial links back to the main installation guide for standard steps to avoid documentation drift, as discussed in #643.
Also updates
docs/tutorials/index.mdto list the new tutorial.Related issues
How was this tested?
Verified the tutorial steps manually on a WSL2 (Ubuntu) instance running on Windows 11 with KVM enabled. Confirmed that the markdown renders correctly and all links resolve properly.
LLM usage
no LLM usage.
Checklist
make lint).make test_ctr,make test_nerdctl,make test_docker,make test_crictl).