Documentation
¶
Overview ¶
Package microvmrun is the presentation half of the Dev VM targets: it drives internal/microvm and formats what that package returns for a terminal.
It is separate from internal/microvm because that package has a second consumer, the e2e cluster suite, which wants the fleet and not a status table. Keeping the printing here leaves the mage targets as thin as magefiles/AGENTS.md asks, without pushing terminal formatting into a package the test suite imports.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Image ¶
Image fetches and verifies base images without starting anything.
It fetches only what was asked for, because the images are several hundred megabytes each and a Rocky-only fleet has no use for Ubuntu's.
Types ¶
type Options ¶
type Options struct {
// Controllers, Workers and Infra are how many of each group to create. Infra nodes join
// as workers under a profile of their own.
Controllers int
Workers int
Infra int
// UbuntuControllers and UbuntuWorkers run Ubuntu instead of Rocky. Both opt in.
UbuntuControllers int
UbuntuWorkers int
// Distro is the engine the fleet is prepared for, k3s or rke2.
Distro string
// MemoryMiB and CPUs are per node. Zero means the package default, which is what makes
// the refusal a big fleet hits actionable: the guard says to lower the per-node memory,
// and these are how.
MemoryMiB int
CPUs int
}
Options is what dev:vmUp was asked for, after its flag defaults have been applied.