Talosctl
Talos Linux machines for swamp, through talosctl, with or without Omni.
One model type, @dataverket/talosctl/node, targets one or many nodes: version, services and etcd members, the cluster kubeconfig, apply and patch machine config, bootstrap, reboot, shutdown, reset (whole system disk or only named partitions such as EPHEMERAL), upgrade, and the cluster health check. volumes reads every node's disks, partitions by label, unallocated space on the system disk and how full EPHEMERAL is, in one execution, so a plan for user volumes starts from measured numbers.
Forked from @magistr/talos-node (MIT) and typed. For an Omni-managed fleet, @dataverket/omni supplies the node addresses and a minted talosconfig as data; this model takes the config as content (talosconfigContent) and speaks to the machines through Omni's proxy, so a lab cluster on plain talosctl and a managed one share one code path.
Global Arguments
| Argument | Type | Description |
|---|---|---|
| endpoint? | string | Talos API endpoint (--endpoints); also the default node. Leave unset with an Omni talosconfig |
| nodes? | array | Node addresses the methods target (--nodes); defaults to [endpoint] |
| talosconfig? | string | Path to a talosconfig; defaults to talosctl's own lookup |
| talosconfigContent? | string | A talosconfig\ |
| insecure | boolean | Use --insecure (maintenance mode, no client certificate) |
| talosctlPath | string | Path to the talosctl binary; override when it is not on PATH |
| serviceAccountKey? | string | Omni service-account key for an Omni-issued talosconfig (OMNI_SERVICE_ACCOUNT_KEY); supply via a vault expression |
| retryDelayMs | number | Pause between retries of transient API errors |
| Argument | Type | Description |
|---|---|---|
| configFile | string | Path to the machine config YAML file |
| mode | enum | |
| insecure | boolean | Override the global insecure flag (maintenance mode) |
| Argument | Type | Description |
|---|---|---|
| mode | enum |
| Argument | Type | Description |
|---|---|---|
| force | boolean |
| Argument | Type | Description |
|---|---|---|
| graceful | boolean | Cordon, drain and leave etcd first |
| reboot | boolean | Reboot after the reset instead of shutting down |
| systemLabelsToWipe? | array | Wipe only these system partitions (e.g. [EPHEMERAL]); keeps STATE and the config |
| Argument | Type | Description |
|---|---|---|
| image | string | Installer image, e.g. ghcr.io/siderolabs/installer:v1.14.1 |
| preserve | boolean | Preserve ephemeral data |
| Argument | Type | Description |
|---|---|---|
| patchFile | string | Path to the YAML patch file |
| mode | enum |
| Argument | Type | Description |
|---|---|---|
| waitTimeout | string | How long to wait for the check to pass, e.g. 30s, 2m |
Resources
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned