Ghaf as a Library

Ghaf is a framework for creating virtualized edge devices. Downstream projects import it as a flake input and declare a derived system on top of it, rather than forking the tree.

Ghaf Usage Overview

The Ghaf Platform repository provides declarative modules and reference implementations. External repositories supply hardware options, image generators and reference board-support packages.

To create, build and update a project, follow Downstream Project Setup; the builder arguments it uses are listed in Builder Functions.

This section documents the module and option API those projects consume:

Global Config — settings propagated from the host into every VM
Module Options — the generated ghaf.* option reference
VM Helpers — lib.ghaf.vm.*
Features API
Profiles API