Docs: rec* Tooling Overview

Documentation

rec* Tooling Overview

Inventory of the rec* tools: what each one does and where it runs.

Context

The install tools (recpart, recstrap, recfstab, recsetup, recchroot) are the manual install path, and the backends of the install screen's step apps. recab manages the two roots of an A/B installation. The rest build the boot artifacts and drive the test VMs.

Tool Matrix

Ordered canonically by tool name.

ToolSurfacePrimary UseRuns On
recabCLIThe two A/B roots: locked booted root, unlocked other rootInstalled system
recchrootCLIChroot with bind mountsLive ISO
recfstabCLIGenerate fstab entriesLive ISO
recinitCLI + libraryInitramfs builderBuild host
recisoCLI + libraryUEFI ISO builderBuild host
recpartCLI + backendDisk inspect/plan/apply backendLive ISO
recqemuLibraryScenario VMs as libvirt domains, serial consoleBuild host
recsetupCLI + backendConfigure and boot the installed systemLive ISO
recshuttleLibrarySSH transport to scenario VMsBuild host
recstrapCLIExtract the system imageLive ISO and installed system

Boundaries

  • Installer-facing: recstrap, recfstab, recchroot, recsetup
  • Partition backend: recpart (inspect/plan/apply and handoff only)
  • Build pipeline: recinit, reciso
  • Test VMs: recqemu, recshuttle
  • A/B roots: recab; Recipe writes system software into the unlocked other root

See Also