Reference¶
These pages are for operators, image authors and contributors who look up an exact name, field, default or port while they work with chalkos. Each page opens with who uses it and closes with the sources its facts come from.
Commands¶
chalkctl installs and operates a cluster, chalklab runs its nodes as virtual machines, chalkbuild prepares its images and chalkcfg prints a node's config documents on the node.
Config¶
These pages list what an operator writes in a node's config, and what chalkos's own modules check and do with it.
Images¶
These pages list how an image is built, what it holds and how a node boots it.
-
mkImages
The arguments of
chalkos.lib.mkImagesand what it returns. -
Image options
The options of chalkos's node modules that an image's NixOS modules set.
-
Extension API
The options and
chalkosLibhelpers an extension declares kinds, facts, outputs and effects with. -
Extension runtime
What an extension's rules, templates and programs read and call, and the limits they run within.
-
Image and partition layout
The partitions of an installed node and the files of an image.
-
Boot and the image
How systemd-boot orders a node's entries, the units that run at every boot, and what an image fixes.
-
os-release fields
The fields chalkos adds to
/etc/os-releaseand the UKI's os-release, and what reads them.
Node¶
These pages list how a node is reached: its API, who may call it, the certificates behind it and the ports it opens.
-
Node API
The API chalkd serves on every node, generated from its protobuf definition.
-
Roles and credentials
The role each node API method needs, and the order chalkctl looks for credentials.
-
Certificates
Every CA, key and certificate of a cluster, its lifetime, its renewal point and the status notes.
-
Ports and firewall
Every port a node listens on, who needs to reach it, and how the firewall treats it.
Kubernetes¶
This page lists what the Kubernetes layer adds to run Kubernetes on a node.
-
Kubernetes
The components of each node type, the flags chalkos refuses, its add-ons and the status states.
Glossary¶
The glossary defines the terms every page uses, and is the source of their tooltips.
-
Glossary
The terms these pages use, each with a short definition.
Sources: the command line, config kinds, built-ins, mkImages, image options, extension API and node API pages are generated from the code, as Writing documentation describes.