Index of every page on this site: llms.txt
All skills
microsoft avatar

/nvx-run-microvm

@fef56ac
by microsoftmicrosoft/nvx857 stars
66
Run it yourself

Boot an NVX microVM with nvx on Linux/KVM, Linux/MSHV, or Windows/WHP, exercise the guest, and debug failed boots. Use for boot smoke tests, guest shell sessions, virtio-fs mounts, networking, kernel command lines, missing boot markers, OpenVMM errors, guest hangs, and benchmark acceptance failures.

  • 1 file
  • 4.3 KB
  • Updated 4 days ago
  • GitHub
Use this Skill: https://skilld.dev/gh/microsoft/nvx/nvx-run-microvm

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈79 tokens for metadata: the name and description. ≈998 when used: this file.

Description uses 4.0% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈318 characters, or 4.0%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Run And Debug An NVX MicroVM

Prepare the host with nvx-prepare-host first, and reuse its host, checkout, backend, revision, and artifacts. Run the commands below from that checkout in an interactive terminal, locally or in ssh -tt <ssh_target> on a remote host. They read the same in bash and PowerShell, except where noted; use python instead of python3 on Windows.

Run

  1. Assemble the run with only the options that the task needs, and check it:

    nvx/target/release/nvx run --hypervisor BACKEND --dry-run

    Usage documents the options, such as --memory-mib, --net 10.0.0.2/24 --network-profile portable, --cmdline "quiet loglevel=0", and --mount "/mnt/host,HOST_PATH,ro", whose guest path is absolute and whose mode follows the last comma, so the host path may hold commas. Mount ro unless the guest must write.

  2. From the checkout that holds this skill, since the prepared one may predate the probe, check that no OpenVMM process runs, with python3 scripts/nvx_hosts.py probe HOST --cwd CHECKOUT --no-verify on a remote host, or python3 scripts/host_probe.py --repo CHECKOUT --no-verify locally. Start a competing VM only when the user confirms that the existing one is expected and that the host has room for both.

  3. Run the same command without --dry-run, with standard input attached to the guest; never pipe it through a logger.

  4. Success is the guest's NVX-GUEST-BOOT-OK: <guest> marker, such as NVX-GUEST-BOOT-OK: alpine for the default guest, and a responsive root shell. Exercise the request, exit with /sbin/nvx-exit 0 in the guest, and record the host's exit status. When the guest hangs, interrupt only the command that this terminal started; never run a host-wide killall or an unscoped Stop-Process.

Debug A Failure

  1. Before retrying, keep the baseline: local or SSH execution, the host, backend, platform, commit, dirty state, artifact source, Python version, the --dry-run output, the exact command, its exit status and complete error, and any OpenVMM process left behind.
  2. Change one variable at a time. Rerun the same command with OpenVMM logging, export OPENVMM_LOG=debug in bash or $env:OPENVMM_LOG = 'debug' in PowerShell, and use trace only when debug does not show the failing component. The terminal transcript is the record.
  3. Run the OpenVMM command that --dry-run prints directly only for options that nvx lacks, and record every deviation.
  4. Reduce a benchmark acceptance failure to one run before changing the measured suite: python3 scripts/nvx.py benchmark --suite e2e --backend BACKEND --warmups 1 --runs 1 --skip-build --output <fresh file>. The benchmark suppresses most OpenVMM logging to protect its measurements, so reproduce the boot through run for traces.
Failure Action
SSH authentication or host key Stop; the user repairs trust or credentials
Missing or inaccessible hypervisor device Report the probe's check; do not elevate
WHP unavailable Report it; enabling WHP needs an administrator and a reboot
Dirty or wrong revision Stop changing it; use a temporary worktree or ask
Missing artifacts download or build them, by the provenance that the task needs
Boot marker timeout Trace the same backend and command before widening the scope
SSH disconnect Look for the original process and its output before another run

Report

Report local or SSH execution, the host, backend, commit, dirty state, artifact source, exact command, boot marker, guest checks, and the host's exit status. For a failure, add the smallest reproduction, the observed against the expected behavior, the relevant trace lines, the layer that appears to control the failure, the next discriminating check, every changed option, and any privilege or transport limitation.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at fef56ac. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 7 hours ago.

Activeupdated 4 days ago
argument-hint
[local|host-profile] [kvm|mshv|whp] [run options or failure]

README badge

README badge for microsoft/nvx/nvx-run-microvm