Skip to content

Dev environment try-it section contradicts metal3-dev-env readme #569

@4t1l4

Description

@4t1l4

The try-it section of the book states these pre-reqs:

  • System with CentOS 9 Stream or Ubuntu 22.04
  • Bare metal preferred, as we will be creating VMs to emulate bare metal hosts [emphasis mine]
  • Run as a user with passwordless sudo access
  • Minimum resource requirements for the host machine: 4C CPUs, 16 GB RAM memory

While the metal3-dev-env readme says:

Note: These scripts are invasive and will reconfigure part of the host OS in addition to package installation, and hence it is recommended to run dev-env in a VM. Please read the scripts to understand what they do before running them on your machine.

Following the book page, it's quite unlikely one will see that note before running make a few times.

More than the contradiction between documents or the do your homework disclaimer, what would have helped me immensely would have been to know beforehand that I could just give it a try in a VM with the supported OS instead of working out how to run the target in my non supported OS. Maybe how to run the dev env in a VM is something worth adding to the book documentation as an option?

Metadata

Metadata

Assignees

Labels

kind/documentationCategorizes issue or PR as related to documentation.triage/acceptedIndicates an issue is ready to be actively worked on.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions