Skip to content

README.md

Latest commit

 

History

History
65 lines (53 loc) · 3.24 KB

README.md

File metadata and controls

65 lines (53 loc) · 3.24 KB
Raw

KatlOS Documentation

KatlOS is an installable, upgradeable, systemd-native operating system for kubeadm Kubernetes nodes. These guides cover the supported beta journey from a blank UEFI machine to a cluster that is ready for you to install a CNI and the rest of your platform.

KatlOS is experimental home-lab software. Before using real hardware, read the support and security boundary. In particular, the installer and node-management APIs are designed for a trusted network and must not be exposed to the Internet.

Start Here

  1. Understand what Katl owns.
  2. Build your first cluster with the release ISO.
  3. For network boot, use the PXE and Matchbox journey instead of the ISO handoff.
  4. Bootstrap Kubernetes, then install the CNI and add-ons you choose.
  5. Use the operator guide for routine and recovery work.

The complete installation reference describes every ClusterConfig field and advanced installation option. The focused journeys above are the better place to begin.

Install and Bootstrap

Goal Guide
Install a first ISO-based cluster Build your first cluster
Author and validate all installation inputs Installation reference
Automate UEFI network boot Install with PXE and Matchbox
Verify downloaded artifacts Verify release artifacts
Inspect generation 0 and management access Access installed nodes
Create the kubeadm cluster Bootstrap Kubernetes
Preserve trust across a whole-cluster rebuild Preserve Kubernetes identity
Install Cilium on the immutable host Run Cilium on KatlOS

Operate and Recover

Goal Guide
Inspect, reboot, shut down, or use SSH Access installed nodes
Apply host and kubeadm configuration Apply cluster configuration
Add, replace, or remove a node Change cluster membership
Upgrade KatlOS Upgrade a KatlOS host
Upgrade Kubernetes Upgrade Kubernetes
Wipe and reinstall Wipe and reinstall KatlOS
Diagnose a failure Troubleshoot KatlOS

For command discovery and automation boundaries, see the katlctl command map. The CLI's --help output remains the exact reference for flags in the installed release.

Project Documentation

  • Support boundary defines the tested evaluation surface, compatibility promise, trust model, and reporting checklist.
  • Developing Katl covers builds, persistent katldev VMs, automated VM tests, and release tooling.
  • docs/internal contains design records and project working material. It is not operator guidance or a supported product API and should not be published as part of the user documentation site.