docs: when mentioning partitions, link to partition docs
Fixes #5520 Signed-off-by: Sebastian Hasler <sebastian.hasler@stuvus.uni-stuttgart.de> Signed-off-by: Noel Georgi <git@frezbo.dev>
This commit is contained in:
Sebastian Hasler
Noel Georgi
parent
b189e84269
commit
c6722b637b
@ -91,7 +91,7 @@ If some control plane nodes experienced hardware failure, replace them with new
|
||||
Use machine configuration backup to re-create the nodes with the same secret material and control plane settings
|
||||
to allow workers to join the recovered control plane.
|
||||
|
||||
If a control plane node is healthy but `etcd` isn't, wipe the node's `EPHEMERAL` partition to remove the `etcd`
|
||||
If a control plane node is healthy but `etcd` isn't, wipe the node's [EPHEMERAL]({{< relref "../learn-more/architecture/#file-system-partitions" >}}) partition to remove the `etcd`
|
||||
data directory (make sure a database snapshot is taken before doing this):
|
||||
|
||||
```bash
|
||||
|
||||
@ -105,7 +105,7 @@ with a single `--mode` flag that can take the following values:
|
||||
- `auto` new mode that automatically applies the configuration in no-reboot/reboot mode based on the change.
|
||||
- `no-reboot` force apply immediately, if that is not possible then it fails.
|
||||
- `reboot` force reboot with applied config.
|
||||
- `staged` write new machine configuration to `STATE`, but don't apply it (it will be applied after a reboot).
|
||||
- `staged` write new machine configuration to [STATE]({{< relref "../learn-more/architecture/#file-system-partitions" >}}), but don't apply it (it will be applied after a reboot).
|
||||
- `interactive` starts interactive installer, only for `apply`.
|
||||
|
||||
## Networking
|
||||
|
||||
@ -65,7 +65,7 @@ spec:
|
||||
|
||||
Node identity is used as the unique `Affiliate` identifier.
|
||||
|
||||
Node identity resource is preserved in the `STATE` partition in `node-identity.yaml` file.
|
||||
Node identity resource is preserved in the [STATE]({{< relref "../../learn-more/architecture/#file-system-partitions" >}}) partition in `node-identity.yaml` file.
|
||||
Node identity is preserved across reboots and upgrades, but it is regenerated if the node is reset (wiped).
|
||||
|
||||
#### Affiliates
|
||||
|
||||
@ -125,7 +125,7 @@ Talos automatically configures unique IPv6 address for each node in the cluster-
|
||||
|
||||
Wireguard private key is generated for the node, private key never leaves the node while public key is published through the cluster discovery.
|
||||
|
||||
`KubeSpanIdentity` is persisted across reboots and upgrades in `STATE` partition in the file `kubespan-identity.yaml`.
|
||||
`KubeSpanIdentity` is persisted across reboots and upgrades in [STATE]({{< relref "../../learn-more/architecture/#file-system-partitions" >}}) partition in the file `kubespan-identity.yaml`.
|
||||
|
||||
### KubeSpanPeerSpecs
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ aliases:
|
||||
---
|
||||
|
||||
It is possible to enable encryption for system disks at the OS level.
|
||||
As of this writing, only STATE and EPHEMERAL partitions can be encrypted.
|
||||
As of this writing, only [STATE]({{< relref "../../learn-more/architecture/#file-system-partitions" >}}) and [EPHEMERAL]({{< relref "../../learn-more/architecture/#file-system-partitions" >}}) partitions can be encrypted.
|
||||
STATE contains the most sensitive node data: secrets and certs.
|
||||
EPHEMERAL partition may contain some sensitive workload data.
|
||||
Data is encrypted using LUKS2, which is provided by the Linux kernel modules and `cryptsetup` utility.
|
||||
|
||||
@ -171,7 +171,7 @@ govc vm.change \
|
||||
-vm control-plane-1
|
||||
```
|
||||
|
||||
The following can be used to adjust the ephemeral disk size.
|
||||
The following can be used to adjust the [EPHEMERAL]({{< relref "../../../learn-more/architecture/#file-system-partitions" >}}) disk size.
|
||||
|
||||
```bash
|
||||
govc vm.disk.change -vm control-plane-1 -disk.name disk-1000-0 -size 10G
|
||||
|
||||
@ -12,7 +12,7 @@ Doing this means removing the machine from Kubernetes, Etcd (if applicable), and
|
||||
## CLI
|
||||
|
||||
> WARNING: Running a `talosctl reset` on cloud VM's might result in the VM being unable to boot as this wipes the entire disk.
|
||||
It might be more useful to just wipe the `STATE` and `EPHEMERAL` partitions on a cloud VM if not booting via `iPXE`.
|
||||
It might be more useful to just wipe the [STATE]({{< relref "../learn-more/architecture/#file-system-partitions" >}}) and [EPHEMERAL]({{< relref "../learn-more/architecture/#file-system-partitions" >}}) partitions on a cloud VM if not booting via `iPXE`.
|
||||
`talosctl reset --system-labels-to-wipe STATE --system-labels-to-wipe EPHEMERAL`
|
||||
|
||||
The API command for doing this is `talosctl reset`.
|
||||
|
||||
@ -17,7 +17,7 @@ If an upgrade fails to boot, Talos will roll back to the previous version.
|
||||
Likewise, Talos may be manually rolled back via API (or `talosctl rollback`).
|
||||
This will simply update the boot reference and reboot.
|
||||
|
||||
Unless explicitly told to `preserve` data, an upgrade will cause the node to wipe the ephemeral partition, remove itself from the etcd cluster (if it is a control node), and generally make itself as pristine as is possible.
|
||||
Unless explicitly told to `preserve` data, an upgrade will cause the node to wipe the [EPHEMERAL]({{< relref "../learn-more/architecture/#file-system-partitions" >}}) partition, remove itself from the etcd cluster (if it is a control node), and generally make itself as pristine as is possible.
|
||||
(This is generally the desired behavior, except in specialised use cases such as single-node clusters.)
|
||||
|
||||
*Note* that unless the Kubernetes version has been specified in the machine config, an upgrade of the Talos Linux OS will also apply an upgrade of the Kubernetes version.
|
||||
|
||||
@ -91,7 +91,7 @@ If some control plane nodes experienced hardware failure, replace them with new
|
||||
Use machine configuration backup to re-create the nodes with the same secret material and control plane settings
|
||||
to allow workers to join the recovered control plane.
|
||||
|
||||
If a control plane node is healthy but `etcd` isn't, wipe the node's `EPHEMERAL` partition to remove the `etcd`
|
||||
If a control plane node is healthy but `etcd` isn't, wipe the node's [EPHEMERAL]({{< relref "../learn-more/architecture/#file-system-partitions" >}}) partition to remove the `etcd`
|
||||
data directory (make sure a database snapshot is taken before doing this):
|
||||
|
||||
```bash
|
||||
|
||||
@ -65,7 +65,7 @@ spec:
|
||||
|
||||
Node identity is used as the unique `Affiliate` identifier.
|
||||
|
||||
Node identity resource is preserved in the `STATE` partition in `node-identity.yaml` file.
|
||||
Node identity resource is preserved in the [STATE]({{< relref "../../learn-more/architecture/#file-system-partitions" >}}) partition in `node-identity.yaml` file.
|
||||
Node identity is preserved across reboots and upgrades, but it is regenerated if the node is reset (wiped).
|
||||
|
||||
#### Affiliates
|
||||
|
||||
@ -125,7 +125,7 @@ Talos automatically configures unique IPv6 address for each node in the cluster-
|
||||
|
||||
Wireguard private key is generated for the node, private key never leaves the node while public key is published through the cluster discovery.
|
||||
|
||||
`KubeSpanIdentity` is persisted across reboots and upgrades in `STATE` partition in the file `kubespan-identity.yaml`.
|
||||
`KubeSpanIdentity` is persisted across reboots and upgrades in [STATE]({{< relref "../../learn-more/architecture/#file-system-partitions" >}}) partition in the file `kubespan-identity.yaml`.
|
||||
|
||||
### KubeSpanPeerSpecs
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ aliases:
|
||||
---
|
||||
|
||||
It is possible to enable encryption for system disks at the OS level.
|
||||
As of this writing, only STATE and EPHEMERAL partitions can be encrypted.
|
||||
As of this writing, only [STATE]({{< relref "../../learn-more/architecture/#file-system-partitions" >}}) and [EPHEMERAL]({{< relref "../../learn-more/architecture/#file-system-partitions" >}}) partitions can be encrypted.
|
||||
STATE contains the most sensitive node data: secrets and certs.
|
||||
EPHEMERAL partition may contain some sensitive workload data.
|
||||
Data is encrypted using LUKS2, which is provided by the Linux kernel modules and `cryptsetup` utility.
|
||||
|
||||
@ -171,7 +171,7 @@ govc vm.change \
|
||||
-vm control-plane-1
|
||||
```
|
||||
|
||||
The following can be used to adjust the ephemeral disk size.
|
||||
The following can be used to adjust the [EPHEMERAL]({{< relref "../../../learn-more/architecture/#file-system-partitions" >}}) disk size.
|
||||
|
||||
```bash
|
||||
govc vm.disk.change -vm control-plane-1 -disk.name disk-1000-0 -size 10G
|
||||
|
||||
@ -12,7 +12,7 @@ Doing this means removing the machine from Kubernetes, Etcd (if applicable), and
|
||||
## CLI
|
||||
|
||||
> WARNING: Running a `talosctl reset` on cloud VM's might result in the VM being unable to boot as this wipes the entire disk.
|
||||
It might be more useful to just wipe the `STATE` and `EPHEMERAL` partitions on a cloud VM if not booting via `iPXE`.
|
||||
It might be more useful to just wipe the [STATE]({{< relref "../learn-more/architecture/#file-system-partitions" >}}) and [EPHEMERAL]({{< relref "../learn-more/architecture/#file-system-partitions" >}}) partitions on a cloud VM if not booting via `iPXE`.
|
||||
`talosctl reset --system-labels-to-wipe STATE --system-labels-to-wipe EPHEMERAL`
|
||||
|
||||
The API command for doing this is `talosctl reset`.
|
||||
|
||||
@ -17,7 +17,7 @@ If an upgrade fails to boot, Talos will roll back to the previous version.
|
||||
Likewise, Talos may be manually rolled back via API (or `talosctl rollback`).
|
||||
This will simply update the boot reference and reboot.
|
||||
|
||||
Unless explicitly told to `preserve` data, an upgrade will cause the node to wipe the ephemeral partition, remove itself from the etcd cluster (if it is a control node), and generally make itself as pristine as is possible.
|
||||
Unless explicitly told to `preserve` data, an upgrade will cause the node to wipe the [EPHEMERAL]({{< relref "../learn-more/architecture/#file-system-partitions" >}}) partition, remove itself from the etcd cluster (if it is a control node), and generally make itself as pristine as is possible.
|
||||
(This is generally the desired behavior, except in specialised use cases such as single-node clusters.)
|
||||
|
||||
*Note* that unless the Kubernetes version has been specified in the machine config, an upgrade of the Talos Linux OS will also apply an upgrade of the Kubernetes version.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user