IF Commons GitHub

governance/profile

Written to: 3 requirements: 3 proved, 0 partly, 0 failing, 0 with no test recorded. 0005-netboot-profiles FR-001, 0005-netboot-profiles FR-002, 0005-netboot-profiles FR-003

A boot profile: what one distribution needs from a network boot, as data. The server, the menus and the arming are the same for every distribution; a profile says which files are served and how each is pinned (BootPins), what the kernel is told on its command line, and which file under the install's URL is the install document the installer reads (the autoinstall's user-data, a Debian preseed.cfg, and so on). A boot server serves one profile at a time, because the names of the boot files (linux, initrd) are the same in every distribution.

The command line is a template: {base} is the boot server's URL (ending in a slash), {install} is the install's own URL (ending in a slash, with the host, the token and the MAC in it), {iso} is the URL of the installer image, and {mac} is what GRUB fills in as the MAC it booted from.

import { profileById } from "./profile.ts";
profileById("debian-13")?.document; // "preseed.cfg"

Source: commons/netboot/src/governance/profile.ts

6 of 20 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

governance.INSTALL_DOCUMENTSconstno test imports it
const INSTALL_DOCUMENTS: readonly ["user-data", "preseed.cfg", "ks.cfg", "autoinst.xml"]

The files an install may ask the server for as its install document.

governance.InstallDocumenttypeno test imports it
type InstallDocument = (typeof INSTALL_DOCUMENTS)[number];

The name of an install document.

governance.BootProfiletypeno test imports it
type BootProfile = { /** The profile's name, as a person selects it: the distribution and its release. */ readonly i… (1180 characters)
type BootProfile = {
  /** The profile's name, as a person selects it: the distribution and its release. */
  readonly id: string;
  /** The family the platform model gives the distribution, so that the install is rendered for the right installer. */
  readonly family: "debian" | "redhat" | "suse" | "arch";
  /** The distribution and release as the menu says them. */
  readonly title: string;
  readonly pins: BootPins;
  /** The name of the kernel among the pinned files. */
  readonly kernel: string;
  /** The name of the initial ramdisk among the pinned files. */
  readonly initrd: string;
  /** The kernel's command line, with the placeholders of the header. */
  readonly cmdline: string;
  /** The install document the installer reads from the install's URL. */
  readonly document: InstallDocument;
  /** The content type the install document is served with. */
  readonly documentType: string;
  /** Whether the installer can run the blank-disk guard before it touches a disk. Where it cannot, the install erases the disk it picks and an asset may be armed for it only with the owner's say-so that it may erase one (`confirmDestroy`). */
  readonly guard: boolean;
};

What one distribution needs from a network boot.

governance.UBUNTU_26_04_PROFILEconstno test imports it
const UBUNTU_26_04_PROFILE: BootProfile

Ubuntu 26.04.1: the live server's autoinstall, fed by cloud-init's NoCloud from the install's URL.

governance.DEBIAN_13constno test imports it
const DEBIAN_13: BootPins

Debian 13 (trixie): the netboot installer, which fetches its packages from the mirror, so there is no image. The files are those of the installer's current folder, pinned by the SHA-256 of its SHA256SUMS of 2026-11-21 (the files of a point release are replaced in place, so a new point release is adopted by changing these pins in a reviewed commit; a file that does not match its pin is not served).

governance.DEBIAN_13_PROFILEconstno test imports it
const DEBIAN_13_PROFILE: BootProfile

Debian 13: the installer is told where its preseed is, and runs with no question that the preseed answers.

governance.ROCKY_9constno test imports it
const ROCKY_9: BootPins

Rocky Linux 9.9: the installer's kernel and ramdisk and the network boot loader, pinned by the SHA-256 of the installer's .treeinfo of 2026-11-21 (and checked against the files themselves). The files of the tree are replaced in place by a point release, so a new one is adopted by changing these pins in a reviewed commit. The installer fetches its packages from the repository named on its command line.

governance.ROCKY_9_PROFILEconstno test imports it
const ROCKY_9_PROFILE: BootProfile

Rocky Linux 9: Anaconda is told where its Kickstart is and where the packages are.

governance.PROFILESconstno test imports it
const PROFILES: readonly BootProfile[]

Every profile there is.

governance.profileByIdfunctionno test imports it
function profileById(id: string): BootProfile | undefined

The profile of a name, if there is one.

INSTALL_DOCUMENTSconstno test imports it
const INSTALL_DOCUMENTS: readonly ["user-data", "preseed.cfg", "ks.cfg", "autoinst.xml"]

The files an install may ask the server for as its install document.

InstallDocumenttypeno test imports it
type InstallDocument = (typeof INSTALL_DOCUMENTS)[number];

The name of an install document.

BootProfiletype
type BootProfile = { /** The profile's name, as a person selects it: the distribution and its release. */ readonly i… (1180 characters)
type BootProfile = {
  /** The profile's name, as a person selects it: the distribution and its release. */
  readonly id: string;
  /** The family the platform model gives the distribution, so that the install is rendered for the right installer. */
  readonly family: "debian" | "redhat" | "suse" | "arch";
  /** The distribution and release as the menu says them. */
  readonly title: string;
  readonly pins: BootPins;
  /** The name of the kernel among the pinned files. */
  readonly kernel: string;
  /** The name of the initial ramdisk among the pinned files. */
  readonly initrd: string;
  /** The kernel's command line, with the placeholders of the header. */
  readonly cmdline: string;
  /** The install document the installer reads from the install's URL. */
  readonly document: InstallDocument;
  /** The content type the install document is served with. */
  readonly documentType: string;
  /** Whether the installer can run the blank-disk guard before it touches a disk. Where it cannot, the install erases the disk it picks and an asset may be armed for it only with the owner's say-so that it may erase one (`confirmDestroy`). */
  readonly guard: boolean;
};

What one distribution needs from a network boot.

Imported by 18 tests of the run (18 passed, 0 failed): the library's results

UBUNTU_26_04_PROFILEconst
const UBUNTU_26_04_PROFILE: BootProfile

Ubuntu 26.04.1: the live server's autoinstall, fed by cloud-init's NoCloud from the install's URL.

Imported by 18 tests of the run (18 passed, 0 failed): the library's results

DEBIAN_13constno test imports it
const DEBIAN_13: BootPins

Debian 13 (trixie): the netboot installer, which fetches its packages from the mirror, so there is no image. The files are those of the installer's current folder, pinned by the SHA-256 of its SHA256SUMS of 2026-11-21 (the files of a point release are replaced in place, so a new point release is adopted by changing these pins in a reviewed commit; a file that does not match its pin is not served).

DEBIAN_13_PROFILEconst
const DEBIAN_13_PROFILE: BootProfile

Debian 13: the installer is told where its preseed is, and runs with no question that the preseed answers.

Imported by 18 tests of the run (18 passed, 0 failed): the library's results

ROCKY_9constno test imports it
const ROCKY_9: BootPins

Rocky Linux 9.9: the installer's kernel and ramdisk and the network boot loader, pinned by the SHA-256 of the installer's .treeinfo of 2026-11-21 (and checked against the files themselves). The files of the tree are replaced in place by a point release, so a new one is adopted by changing these pins in a reviewed commit. The installer fetches its packages from the repository named on its command line.

ROCKY_9_PROFILEconst
const ROCKY_9_PROFILE: BootProfile

Rocky Linux 9: Anaconda is told where its Kickstart is and where the packages are.

Imported by 18 tests of the run (18 passed, 0 failed): the library's results

PROFILESconst
const PROFILES: readonly BootProfile[]

Every profile there is.

Imported by 18 tests of the run (18 passed, 0 failed): the library's results

profileByIdfunction
function profileById(id: string): BootProfile | undefined

The profile of a name, if there is one.

Imported by 18 tests of the run (18 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.