# 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](https://ichor.maesh.dev/next/reference/cli/ichor/). The top-level groups:

| Command | For |
|---|---|
| [`ichor init`](https://ichor.maesh.dev/next/reference/cli/ichor_init/) | Create the first control plane and install Ichor |
| [`ichor adopt`](https://ichor.maesh.dev/next/reference/cli/ichor_adopt/) | Bring an existing Talos cluster, or one more machine of it, under Ichor |
| [`ichor cluster`](https://ichor.maesh.dev/next/reference/cli/ichor_cluster/) | Inspect clusters, discovery, CA and key rotation, credentials |
| [`ichor machine`](https://ichor.maesh.dev/next/reference/cli/ichor_machine/) | List, approve, reject and reclaim machines |
| [`ichor node`](https://ichor.maesh.dev/next/reference/cli/ichor_node/) | Node actions: reboot, shutdown, reset, remove, logs, support bundle |
| [`ichor operation`](https://ichor.maesh.dev/next/reference/cli/ichor_operation/) | List, follow, pause, resume and delete operations |
| [`ichor upgrade`](https://ichor.maesh.dev/next/reference/cli/ichor_upgrade/) | Upgrade Talos, Kubernetes or Ichor |
| [`ichor config`](https://ichor.maesh.dev/next/reference/cli/ichor_config/) and [`ichor patch`](https://ichor.maesh.dev/next/reference/cli/ichor_patch/) | Effective configuration and configuration patches |
| [`ichor cni`](https://ichor.maesh.dev/next/reference/cli/ichor_cni/) | Cilium values, upgrades and the kube-proxy mode |
| [`ichor etcd`](https://ichor.maesh.dev/next/reference/cli/ichor_etcd/) and [`ichor restore`](https://ichor.maesh.dev/next/reference/cli/ichor_restore/) | Backups, snapshots and recovery |
| [`ichor user`](https://ichor.maesh.dev/next/reference/cli/ichor_user/), [`ichor auth`](https://ichor.maesh.dev/next/reference/cli/ichor_auth/) and [`ichor settings`](https://ichor.maesh.dev/next/reference/cli/ichor_settings/) | Users, sign-in and Ichor's runtime settings |
| [`ichor ui`](https://ichor.maesh.dev/next/reference/cli/ichor_ui/), [`ichor version`](https://ichor.maesh.dev/next/reference/cli/ichor_version/), [`ichor secrets`](https://ichor.maesh.dev/next/reference/cli/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](https://ichor.maesh.dev/next/reference/crds/taloscluster/) | One cluster: versions, endpoint, CNI, drift policy |
| [TalosMachine](https://ichor.maesh.dev/next/reference/crds/talosmachine/) | One machine: identity, role, approval, status |
| [TalosConfigPatch](https://ichor.maesh.dev/next/reference/crds/talosconfigpatch/) | A typed layer of machine configuration |
| [TalosOperation](https://ichor.maesh.dev/next/reference/crds/talosoperation/) | An upgrade, rotation or node action in progress |
| [TalosEtcdBackup](https://ichor.maesh.dev/next/reference/crds/talosetcdbackup/) | Scheduled etcd snapshots and their storage |
| [TalosStorage](https://ichor.maesh.dev/next/reference/crds/talosstorage/) | Disk preparation for a storage system |
| [MachineReclaim](https://ichor.maesh.dev/next/reference/crds/machinereclaim/) | Resetting a machine that another cluster configured |
| [TalosCredentialRequest](https://ichor.maesh.dev/next/reference/crds/taloscredentialrequest/) | A short-lived request for one certificate |
| [IchorInstallation](https://ichor.maesh.dev/next/reference/crds/ichorinstallation/) | Ichor's own version and runtime settings |
| [IchorUser](https://ichor.maesh.dev/next/reference/crds/ichoruser/) | An Ichor-owned user |

For how these fit together see the [concepts](https://ichor.maesh.dev/next/concepts/clusters-and-machines/)
and the [architecture document](https://ichor.maesh.dev/next/design/architecture/).