Repository navigation
doc: name every guest the validation suites boot - #472
Merged
Merged
Conversation
The NVX-owned microVM suite boots Alpine, Ubuntu, or Azure Linux, and the management-RPC test that test-openvmm runs uses NVX's Alpine initramfs. Say so, and point to the scenarios each workload guest rejects and to the guest chapters that list what CI runs on them. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Pedro Henrique Penna (ppenna)
added
the
documentation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation accurately matches the implementation and existing validation references.
0 open findings
What changed in this PR
Clarifies which guest initramfs each validation layer boots.
Changes:
- Identifies Alpine as the management-RPC test guest.
- Adds Azure Linux to NVX process-test coverage and links guest-specific validation details.
| File | Description |
|---|---|
doc/design/validation.md |
Documents guest selection and scenario support. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Validation chapter said the NVX-owned microVM suite boots the "Alpine or Ubuntu" initramfs. It now also supports Azure Linux. The chapter also left out which initramfs the management-RPC test under
test-openvmmuses. This PR names the guests at both test levels and links to the existing per-guest coverage instead of repeating it.Changes
doc/design/validation.mdonly:run_openvmm_testsinscripts/nvx_tools/ci.pysetsOPENVMM_MICROVM_TEST_INITRDtoAlpineBuildConstants.INITRAMFS_NAME. This matches the existing wording indoc/contribute.md#test-ownership.python scripts/nvx.py test-microvm --helpoffers--guest {alpine,ubuntu,azurelinux}..github/workflows/run-nvx-microvm-tests.ymlrunstest-microvm --guest azurelinuxon every backend.scripts/nvx_tools/guests.pysetssandbox_control=Trueonly for Alpine.run_microvm_testsinscripts/nvx_tools/microvm_tests.pyremoves scenarios only for Ubuntu (UBUNTU_UNSUPPORTED_SCENARIOS) and for guests without sandbox control (SANDBOX_CONTROL_SCENARIOS).test-microvmlists, and their guest chapters list what CI runsdoc/usage.md#test-microvm,doc/guests/ubuntu-guest.md#validation, anddoc/guests/azurelinux-guest.md#validation. Each matches the scenario lists inrun-nvx-microvm-tests.yml.I also checked the rest of the chapter against source, and those statements hold:
openvmm/vmm_tests/vmm_tests/tests/tests/x86_64/microvm.rs).openvmm/vmm_tests/vmm_tests/tests/tests/ttrpc/microvm.rs).scripts/nvx_tools/microvm_tests.py).OpenVMM SHA (pinned submodule, unchanged):
7bf0ee28b826374a2d386067df0456b81bcae818, ondevate054b2af7249f0533bdb5b88968324dc779dcc22.I took the conservative option on scope:
doc/ci.md,doc/setup.md,doc/usage.md,doc/run.md,doc/benchmarks.md, and several design chapters, so I left all of those unchanged.Follow-ups
scripts/setup/README.mdis contributor documentation outsidedoc/. Moving it means editing its links indoc/ci.mdanddoc/setup.md(both touched by open PRs) and the path check inscripts/test_nvx_tools.py. Leave it until those PRs land.doc/openvmm-upstream-roadmap.mdis a dated plan for fork tip2728f33ea. The pinned OpenVMM is now7bf0ee28b. It needs a deliberate refresh by its owner.unittest_results.txtis a 50-KB unittest log tracked at the repository root since the initial commit. It looks accidental.nvx.py --helpdescribesinitas "initialize the private submodule", butopenvmm/is the publicnanvix/openvmm.Validation
python -m unittest scripts.test_nvx_tools.CliTests scripts.test_performance.PerformanceTests: Ran 110 tests, OK (skipped=1).doc/design/validation.mdand the 2 files that link to it, every relative link and anchor resolves. It also confirmed one H1 and balanced fences in the changed file, and thatdoc/design.mdlinks every chapter indoc/design/. Result: OK.git diff --check: clean.python scripts/nvx.py verify: source tree and submodule metadata are consistent.^(doc/|.*\.md$), so CI treats this PR as documentation-only.