You are viewing the development docs which are in progress. For the latest stable documentation, click here.

Reference

Access essential reference materials for configuring, building, and troubleshooting Kairos nodes and images.

Artifact Naming Convention

Detailed information about how we name our artifacts including repositories.

Architecture

Explore the internal design of Kairos and how its modular, container-based approach supports secure, reproducible infrastructure.

AuroraBoot

Reference documentation for AuroraBoot, a tool for generating bootable images

Configuration

Welcome to the Kairos configuration reference page. This page provides details on the fields available in the YAML file used for installing Kairos, a Linux distribution focused on running Kubernetes. This file, written in cloud-config format, allows you to enable Kairos features, configure k3s, and set various other options.

Stage modules

Explore built-in modules for DNS, users, files, and services that help you customize Kairos via cloud-init during boot stages.

kairosctl

Learn how to use kairosctl to register nodes, generate tokens, and manage VPN connections securely and efficiently.

Reset a node

Discover how to reset a Kairos node using boot options, Kubernetes integration, or recovery tools while preserving config data.

The Kairos Factory

Converting any base image into a Kairos ready image

Image support matrix

Build Kairos from scratch

This article shows how to bring your own image with Kairos, and build a Kairos derivative from scratch using base container images from popular distributions such as Ubuntu, Fedora, openSUSE, etc.

Build Raw images with QEMU

This article shows how to bring your own image with Kairos, and build a Kairos derivative from scratch using base container images from popular distributions such as Ubuntu, Fedora, openSUSE, etc.

Troubleshooting

Recovery mode

Entangle CRDs

Inter-connecting Kubernetes clusters without the need of exposing any service to the public via E2E P2P encrypted networks.

FAQ

Alerts Styling

Last modified May 27, 2025: Add llmstxt (#413) (4f86cf9)