Unreleased (main)
These are the development docs; they can describe changes no release has yet.
Reference
These pages are generated from the code and are never edited by hand. Run
make docs-reference after changing a command, a flag or an API type; a test
fails when the committed pages are stale.
CLI
The ichor command and its subcommands, with every flag. Start at
ichor. The top-level groups:
| Command | For |
|---|---|
ichor init | Create the first control plane and install Ichor |
ichor adopt | Bring an existing Talos cluster, or one more machine of it, under Ichor |
ichor cluster | Inspect clusters, discovery, CA and key rotation, credentials |
ichor machine | List, approve, reject and reclaim machines |
ichor node | Node actions: reboot, shutdown, reset, remove, logs, support bundle |
ichor operation | List, follow, pause, resume and delete operations |
ichor upgrade | Upgrade Talos, Kubernetes or Ichor |
ichor config and ichor patch | Effective configuration and configuration patches |
ichor cni | Cilium values, upgrades and the kube-proxy mode |
ichor etcd and ichor restore | Backups, snapshots and recovery |
ichor user, ichor auth and ichor settings | Users, sign-in and Ichor's runtime settings |
ichor ui, ichor version, ichor secrets | Open the UI, show versions, encrypt the local bundle |
Custom resources
All resources are in the API group ichor.maesh.dev, version v1alpha1. Each
page lists every field with its type, whether it is required and its
description; fields marked deprecated are kept so that the schema never loses
a field an installed build had, and are unused.
| Resource | What it is |
|---|---|
| TalosCluster | One cluster: versions, endpoint, CNI, drift policy |
| TalosMachine | One machine: identity, role, approval, status |
| TalosConfigPatch | A typed layer of machine configuration |
| TalosOperation | An upgrade, rotation or node action in progress |
| TalosEtcdBackup | Scheduled etcd snapshots and their storage |
| TalosStorage | Disk preparation for a storage system |
| MachineReclaim | Resetting a machine that another cluster configured |
| TalosCredentialRequest | A short-lived request for one certificate |
| IchorInstallation | Ichor's own version and runtime settings |
| IchorUser | An Ichor-owned user |
For how these fit together see the concepts and the architecture document.