docs: clarify talosctl apply-config & talosctl get machineconfig

Fixes: #6522

Signed-off-by: Michael Vorburger ⛑️ <mike@vorburger.ch>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
This commit is contained in:
Michael Vorburger ⛑️
2022-11-19 19:13:49 +01:00
committed by Andrey Smirnov
parent a58c3d6699
commit 49a4b14947

View File

@ -52,8 +52,11 @@ The list of config changes allowed to be applied immediately in Talos {{< releas
### `talosctl apply-config`
This command is mostly used to submit initial machine configuration to the node (generated by `talosctl gen config`).
It can be used to apply new configuration from the file to the running node as well, but most of the time it's not convenient, as it doesn't operate on the current node machine configuration.
This command is traditionally used to submit initial machine configuration generated by `talosctl gen config` to the node.
It can also be used to apply configuration to running nodes.
The initial YAML for this is typically obtained using `talosctl get machineconfig -o yaml | yq eval .spec >machs.yaml`.
(We must use [`yq`](https://github.com/mikefarah/yq) because for historical reasons, `get` returns the configuration as a full resource, while `apply-config` only accepts the raw machine config directly.)
Example: