You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-4
Original file line number
Diff line number
Diff line change
@@ -25,9 +25,9 @@ We recommend using Windows Terminal for the best experience:
25
25
- Download the `.wsl` file from the [releases page](https://github.com/kaelemc/wsl-clab/releases/latest).
26
26
- Double click the `.wsl` file to install.
27
27
- Open 'Containerlab' from the start menu, or execute `wsl -d Containerlab`
28
-
- Complete the interactive shell selection.
28
+
- Complete the interactive shell selection. (if you plan to use [DevPod](#devpod), select `y` for SSH key copy).
29
29
- If you have Docker Desktop installed. See [Docker Desktop](#docker-desktop).
30
-
- Done! you can start labbing.
30
+
- Done! you can start labbing. (see [DevPod](#devpod) for a great way to lab).
31
31
32
32
>[!NOTE]
33
33
> Default credentials are `clab:clab`
@@ -51,7 +51,7 @@ Restart your PC, and WSL2 should be installed.
51
51
### Windows 10
52
52
53
53
>[!TIP]
54
-
> Newer versions of Windows 10 allow to use`wsl --install` just like with Windows 11.
54
+
> Newer versions of Windows 10 allow usage of`wsl --install`, just like with Windows 11.
55
55
56
56
**Instructions are from ['Manual installation steps for older versions of WSL'.](https://learn.microsoft.com/en-us/windows/wsl/install-manual)**
57
57
@@ -115,7 +115,11 @@ Windows version: 10.0.19044.5131
115
115
116
116
You will also be presented with the choice to have the Fira Code [nerd font](https://www.nerdfonts.com/font-downloads) automatically installed on your system. **We recommend you install this font (especially if using `zsh` as your shell of choice)**.
117
117
118
-
To run the setup again and change prompts, execute `/etc/oobe.sh` inside Containerlab WSL.
118
+
Finally you'll be asked if you want to copy your Windows SSH keys into WSL Containerlab, this is to enable passwordless SSH access. This is an integral step for [DevPod](#devpod) usage, while the default might be **not** to, we recommed you enter `y` (Yes).
119
+
120
+
If no SSH keys are found on your machine, an RSA keypair will be automatically generated.
121
+
122
+
To run the setup again, execute `/etc/oobe.sh` inside Containerlab WSL.
119
123
120
124
> [!IMPORTANT]
121
125
> After installation, close and reopen Windows Terminal to ensure
@@ -173,6 +177,34 @@ If you have Docker desktop installed. You **must** ensure the integration with t
173
177
174
178

175
179
180
+
# DevPod
181
+
182
+
[DevPod](https://devpod.sh/) is an awesome tool which can let us easily run labs which take advantage of Devcontainers, which overall can give a 'one-click' lab experience. It's like running the codespaces labs but on your local machine.
183
+
184
+
Check out [this video](https://www.youtube.com/watch?v=ceDrFx2K3jE) for more info.
185
+
186
+
Containerlab WSL was designed to support this lab experience out of the box. Just remember the following considerations.
187
+
188
+
- At the Containerlab WSL setup prompt, make sure you select `Y` to copy your Windows SSH keys into WSL. If you don't have SSH keys, they will be automatically generated for you.
189
+
190
+
> [!TIP]
191
+
> If you are already past setup, and have selected `N`, Don't worry. From inside Containerlab WSL execute `/etc/oobe.sh` and you can follow the interactive prompts again. It is not recommended to change your shell selection.
192
+
193
+
- When using DevPod, ensure Containerlab WSL is started (it does **not** automatically launch on Windows startup), you should leave the terminal window with Containerlab WSL open in the background.
194
+
195
+
A one-time configuration step is required. You must setup a provider in DevPod. For Containerlab WSL, create the **SSH** provider with the following values:
196
+
197
+
| Field | Value |
198
+
|-------|------------------|
199
+
| Host | `clab@localhost` |
200
+
| Port | `2222` |
201
+
202
+
You can leave the other settings as the default values. See the screenshot below.
203
+
204
+
After configuring the provider, you are done! You can now use one-click labs you see with the DevPod button, or configure the lab workspaces yourself.
205
+
206
+

207
+
176
208
# Developers
177
209
178
210
Development should be performed from another WSL distribution.
0 commit comments