Skip to content

Commit a49a4b2

Browse files
Merge pull request #674 from acheampongmaa/docs/clarify-vm-usage
docs(developer_environment): clarify VM usage and remove bare metal preference
2 parents 3c9664e + 991e1b8 commit a49a4b2

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

  • docs/user-guide/src/developer_environment

docs/user-guide/src/developer_environment/tryit.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,17 @@
3232
### 1.1. Prerequisites
3333

3434
- System with CentOS 9 Stream or Ubuntu 22.04
35-
- Bare metal preferred, as we will be creating VMs to emulate bare metal hosts
35+
- A hosting operating system with QEMU/KVM is required,
36+
as this development environment uses VMs to emulate bare metal hosts
3637
- Run as a user with passwordless sudo access
3738
- Minimum resource requirements for the host machine: 4C CPUs, 16 GB RAM memory
3839

40+
> **Note:**
41+
> The `metal3-dev-env` scripts modify parts of the host system,
42+
> including networking and installed packages.
43+
> It is strongly recommended to run them in a virtual machine or
44+
> a dedicated environment to avoid unintended changes to your primary system.
45+
3946
For execution with VMs
4047

4148
- Setup passwordless sudo access
@@ -44,8 +51,8 @@ For execution with VMs
4451
sudo visudo
4552
```
4653

47-
- Include this line at the end of the sudoers file (replace 'username' with the actual
48-
account name for passwordless sudo access)
54+
- Include this line at the end of the sudoers file (replace 'username' with the
55+
actual account name for passwordless sudo access)
4956

5057
```console
5158
username ALL=(ALL) NOPASSWD: ALL
@@ -154,8 +161,8 @@ configured.
154161
155162
> **_info:_** "Environment variables"
156163
> More information about the specific environment variables used to set up
157-
> metal3-dev-env can be found
158-
> [here](https://github.com/metal3-io/metal3-dev-env/blob/main/vars.md).
164+
> metal3-dev-env can be found in the
165+
> [metal3-dev-env documentation](https://github.com/metal3-io/metal3-dev-env/blob/main/vars.md).
159166
160167
To set environment variables persistently, export them from the configuration
161168
file used by metal3-dev-env scripts:

0 commit comments

Comments
 (0)