Skip to content

Commit 70a2f4c

Browse files
authored
Lint long MD lines in README.md
1 parent 4b64492 commit 70a2f4c

File tree

1 file changed

+65
-30
lines changed

1 file changed

+65
-30
lines changed

README.md

Lines changed: 65 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,11 @@ We recommend using Windows Terminal for the best experience:
3434
3535
# WSL Installation
3636

37-
This distro makes use of WSL2, which requires that virtualization is enabled in your UEFI/BIOS.
37+
This distro makes use of WSL2, which requires that virtualization is enabled in
38+
your UEFI/BIOS.
3839

39-
This may appear as something called 'SVM (AMD-V)' or 'Intel VT-x' depending on your processor.
40+
This may appear as something called 'SVM (AMD-V)' or 'Intel VT-x' depending on
41+
your processor.
4042

4143
### Windows 11
4244

@@ -63,9 +65,11 @@ dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux
6365
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
6466
```
6567

66-
At this point restart your computer. After it has rebooted download the latest WSL2 kernel. [Download link](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi).
68+
At this point restart your computer. After it has rebooted download the latest
69+
WSL2 kernel. [Download link](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi).
6770

68-
Follow the installation wizard. After completion finally set WSL2 as the default version of WSL.
71+
Follow the installation wizard. After completion finally set WSL2 as the default
72+
version of WSL.
6973

7074
In PowerShell or command prompt paste the following:
7175

@@ -75,7 +79,8 @@ wsl --set-default-version 2
7579

7680
## Version Check
7781

78-
Run `wsl --version` in PowerShell or command prompt to ensure WSL2 is enabled. The WSL version number should be 2.4.4.0 or higher.
82+
Run `wsl --version` in PowerShell or command prompt to ensure WSL2 is enabled.
83+
The WSL version number should be 2.4.4.0 or higher.
7984

8085
```powershell
8186
PS C:\Users\Kaelem> wsl --version
@@ -90,7 +95,8 @@ Windows version: 10.0.19044.5131
9095

9196
# Distro Installation
9297

93-
**Ensure WSL is enabled and you have WSL 2.4.4 or newer. See the [version check](#version-check) instructions.**
98+
**Ensure WSL is enabled and you have WSL 2.4.4 or newer. See the
99+
[version check](#version-check) instructions.**
94100

95101

96102
1. Download the `.wsl` file from the [latest release](https://github.com/kaelemc/wsl-clab/releases/latest).
@@ -101,24 +107,32 @@ Windows version: 10.0.19044.5131
101107
> If you see an error that nested virtualization is not supported, see the
102108
> [vrnetlab](#vrnetlab-nested-virtualization) section below.
103109
104-
3. From the start menu you can launch the distribution from a new 'Containerlab' shortcut which has been added.
110+
3. From the start menu you can launch the distribution from a new 'Containerlab'
111+
shortcut which has been added.
105112

106113
or in PowerShell/cmd you can execute:
107114

108115
```powershell
109116
wsl -d Containerlab
110117
```
111118
112-
4. On first launch you will be presented with an interactive menu to select what shell and prompt you would like.
119+
4. On first launch you will be presented with an interactive menu to select what
120+
shell and prompt you would like.
113121
114-
This menu will give you options of `zsh`, `bash` (with a fancy two-line prompt) or `bash` with the default prompt.
122+
This menu will give you options of `zsh`, `bash` (with a fancy two-line prompt)
123+
or `bash` with the default prompt.
115124
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.
117-
**We recommend you install this font (especially if using `zsh` as your shell of choice)**.
125+
You will also be presented with the choice to have the Fira Code
126+
[nerd font](https://www.nerdfonts.com/font-downloads) automatically installed on
127+
your system. **We recommend you install this font (especially if using `zsh` as
128+
your shell of choice).**
118129
119-
Finally at the end SSH keys will be copied from your Windows host into Containerlab WSL to enable passwordless SSH. This is an integral step for [DevPod](#devpod) usage.
130+
Finally at the end SSH keys will be copied from your Windows host into
131+
Containerlab WSL to enable passwordless SSH. This is an integral step for
132+
[DevPod](#devpod) usage.
120133
121-
If no SSH keys are found on your machine, an RSA keypair will be automatically generated.
134+
If no SSH keys are found on your machine, an RSA keypair will be automatically
135+
generated.
122136
123137
To run the setup again, execute `/etc/oobe.sh` inside Containerlab WSL.
124138
@@ -146,18 +160,23 @@ Windows version: 10.0.19044.5131
146160
> [!IMPORTANT]
147161
> This feature is only supported on Windows 11.
148162
149-
You can run [vrnetlab (VM-based)](https://github.com/hellt/vrnetlab) nodes on top of WSL2 and use them in containerlab. Containerlab WSL is already configured so that nested virtualization is enabled on the distro side.
163+
You can run [vrnetlab (VM-based)](https://github.com/hellt/vrnetlab) nodes on
164+
top of WSL2 and use them in containerlab. Containerlab WSL is already configured
165+
so that nested virtualization is enabled on the distro side.
150166
151-
To use vrnetlab nodes on Containerlab WSL you must <u>ensure that nested virtualization is enabled globally in WSL</u>.
167+
To use vrnetlab nodes on Containerlab WSL you must <u>ensure that nested
168+
virtualization is enabled globally in WSL</u>.
152169
153-
- You can do this by opening the *'WSL Settings'* app, going to the *'Optional features'* tab and ensuring *'Enable nested virtualization'* is enabled.
170+
- You can do this by opening the *'WSL Settings'* app, going to the *'Optional
171+
features'* tab and ensuring *'Enable nested virtualization'* is enabled.
154172
155173
> [!NOTE]
156174
> You should be good to go if you don't get any errors during installation or
157175
> distro bootup saying that *'Nested virtualization is not supported on this
158176
> machine.'*
159177
160-
See the [containerlab user manual](https://containerlab.dev/manual/vrnetlab/) for more information about vrnetlab.
178+
See the [containerlab user manual](https://containerlab.dev/manual/vrnetlab/)
179+
for more information about vrnetlab.
161180
162181
# Performance Tuning
163182
@@ -169,11 +188,14 @@ WSL2 runs as a VM. By default allocated resources are:
169188
| RAM | 50% of system memory | If you have 32Gb of RAM on your system, WSL will allocate 16Gb to the WSL VM. |
170189
| Disk | 1Tb | Regardless of disk size, the WSL VM will have a VHD with a maximum size of 1Tb. The disk is thin/sparse provisioned. |
171190
172-
Despite the fairly generous resource allocation by default. WSL2 will not use 100% of the assigned resources.
191+
Despite the fairly generous resource allocation by default. WSL2 will not use
192+
100% of the assigned resources.
173193
174194
# Docker Desktop
175195
176-
If you have Docker desktop installed. You **must** ensure the integration with the Containerlab WSL distro is disabled, otherwise Containerlab will not work inside Containerlab WSL.
196+
If you have Docker desktop installed. You **must** ensure the integration with
197+
the Containerlab WSL distro is disabled, otherwise Containerlab will not work
198+
inside Containerlab WSL.
177199
178200
1. Open Docker Desktop window and go to settings (gear icon on the title bar)
179201
1. Under the 'Resources tab, enter the 'WSL integration' page
@@ -183,38 +205,49 @@ If you have Docker desktop installed. You **must** ensure the integration with t
183205
184206
# DevPod
185207
186-
[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.
208+
[DevPod](https://devpod.sh/) is an awesome tool which can let us easily run labs
209+
which take advantage of Devcontainers, which overall can give a 'one-click' lab
210+
experience. It's like running the codespaces labs but on your local machine.
187211
188-
Check out [this video](https://www.youtube.com/watch?v=ceDrFx2K3jE) for more info.
212+
Check out [this video](https://www.youtube.com/watch?v=ceDrFx2K3jE) for more
213+
info.
189214
190-
Containerlab WSL was designed to support this lab experience out of the box. Just remember the following consideration:
215+
Containerlab WSL was designed to support this lab experience out of the box.
216+
Just remember the following consideration:
191217
192-
- 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.
218+
- When using DevPod, ensure Containerlab WSL is started (it does **not**
219+
automatically launch on Windows startup), you should leave the terminal window
220+
with Containerlab WSL open in the background.
193221
194-
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:
222+
A one-time configuration step is required. You must setup a provider in DevPod.
223+
For Containerlab WSL, create the **SSH** provider with the following values:
195224
196225
| Field | Value |
197226
|-------|------------------|
198227
| Host | `clab@localhost` |
199228
| Port | `2222` |
200229
201-
You can leave the other settings as the default values. See the screenshot below.
230+
You can leave the other settings as the default values. See the screenshot
231+
below.
202232
203-
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.
233+
After configuring the provider, you are done! You can now use one-click labs you
234+
see with the DevPod button, or configure the lab workspaces yourself.
204235
205236
![DevPod settings screenshot](./images/devpod_settings.png)
206237
207238
# Developers
208239
209240
Development should be performed from another WSL distribution.
210241
211-
Clone the repository and build using the build script (you may have to `chmod +x` the script)
242+
Clone the repository and build using the build script (you may have to
243+
`chmod +x` the script)
212244
213245
```bash
214246
./build.sh
215247
```
216248

217-
This will place `clab.wsl` in `C:\temp`. Doubleclick to install the distribution.
249+
This will place `clab.wsl` in `C:\temp`. Doubleclick to install the
250+
distribution.
218251

219252
## Manual Steps
220253

@@ -242,15 +275,17 @@ This will place `clab.wsl` in `C:\temp`. Doubleclick to install the distribution
242275
243276
4. Use it
244277
245-
In your windows filesystem at `C:\temp` should be a file `clab.wsl`, double click to install. or use:
278+
In your windows filesystem at `C:\temp` should be a file `clab.wsl`, double
279+
click to install. or use:
246280
247281
```powershell
248282
wsl --install --from-file clab.wsl
249283
```
250284
251285
# Uninstallation
252286
253-
Uninstall Containerlab WSL using the following command in PowerShell/command prompt:
287+
Uninstall Containerlab WSL using the following command in PowerShell/command
288+
prompt:
254289
255290
```powershell
256291
wsl --unregister Containerlab

0 commit comments

Comments
 (0)