IF Commons GitHub

dialect

Written to: 2 requirements: 2 proved, 0 partly, 0 failing, 0 with no test recorded. 0002-cloud-init-dialect FR-001, 0002-cloud-init-dialect FR-007

The dialect of Archon for the install of a machine from nothing: it renders an order to the autoinstall user-data and meta-data of one machine and gives no step, because the installer carries it out at the machine's first boot, not an executor. It carries the kinds that an install can state (the administrator, the administrator's keys, the time zone, the locale, the keyboard layout and the packages) and refuses what it cannot. What the machine becomes after it boots is the Ansible dialect's render, which the machine pulls from its signed repository.

import { cloudInit, KINDS_CARRIED } from "./dialect.ts";
KINDS_CARRIED.includes("user"); // true

Source: commons/archon-dialect-cloud-init/src/dialect.ts

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

DIALECT_IDconst
const DIALECT_ID: "cloud-init"

The id of the dialect.

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

KINDS_CARRIEDconst
const KINDS_CARRIED: readonly ["user", "ssh-authorized-key", "system-setting", "package"]

The kinds of resource an install can state.

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

CloudInitOptionstype
type CloudInitOptions = {
  readonly fleet: string;
  readonly repository: InstallSpec["repository"];
  readonly allowedSigners: string;
  /** The boot server's URL for this host, ending in a slash. */
  readonly base: string;
  readonly mac?: string;
  readonly disk?: DiskSpec;
  readonly proxy?: string;
};

What the dialect is given besides the order: the facts of the install that are not requirements.

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

installSpecOffunction
function installSpecOf(order: Order, o: CloudInitOptions): Result<InstallSpec, readonly string[]>

The facts of an install from an order, or every reason there are not enough.

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

cloudInitfunction
function cloudInit(o: CloudInitOptions): Dialect

The dialect, as the port of Archon takes it.

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

carriesfunctionno test imports it
function carries(r: Requirement): boolean

Whether a requirement is one this dialect states.

PRESEED_DIALECT_IDconst
const PRESEED_DIALECT_ID: "preseed"

The id of the dialect of Debian's installer.

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

debianPreseedfunction
function debianPreseed(o: CloudInitOptions): Dialect

The dialect of Debian's installer: the same facts as the autoinstall (CloudInitOptions), rendered as a preseed. It has no step, and it cannot lay a disk out as ZFS.

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

KICKSTART_DIALECT_IDconst
const KICKSTART_DIALECT_ID: "kickstart"

The id of the dialect of the Red Hat family's installer.

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

redhatKickstartfunction
function redhatKickstart(o: CloudInitOptions): Dialect

The dialect of Anaconda, the installer of the Red Hat family: the same facts as the autoinstall (CloudInitOptions), rendered as a Kickstart. It has no step, and it cannot lay a disk out as ZFS.

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

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