Skip to content

Commit 99ba539

Browse files
committed
docs: remove the mention of preserve flag for Talos 1.8+
This flag no longer exists in Talos 1.8 and higher. Fixes siderolabs#10172 Signed-off-by: Dmitriy Matrenichev <[email protected]>
1 parent bde516f commit 99ba539

File tree

11 files changed

+4
-23
lines changed

11 files changed

+4
-23
lines changed

website/content/v1.8/advanced/proprietary-kernel-modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,5 @@ aliases:
6161
3. Deploying to your cluster
6262

6363
```bash
64-
talosctl upgrade --image ghcr.io/your-username/talos-installer:<talos version> --preserve=true
64+
talosctl upgrade --image ghcr.io/your-username/talos-installer:<talos version>
6565
```

website/content/v1.8/kubernetes-guides/configuration/ceph-with-rook.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ ceph-filesystem rook-ceph.cephfs.csi.ceph.com Delete Immediate
103103
## Talos Linux Considerations
104104

105105
It is important to note that a Rook Ceph cluster saves cluster information directly onto the node (by default `dataDirHostPath` is set to `/var/lib/rook`).
106-
If running only a single `mon` instance, cluster management is little bit more involved, as any time a Talos Linux node is reconfigured or upgraded, the partition that stores the `/var` [file system]({{< relref "../../learn-more/architecture#the-file-system" >}}) is wiped, but the `--preserve` option of [`talosctl upgrade`]({{< relref "../../reference/cli#talosctl-upgrade" >}}) will ensure that doesn't happen.
107106

108107
By default, Rook configues Ceph to have 3 `mon` instances, in which case the data stored in `dataDirHostPath` can be regenerated from the other `mon` instances.
109108
So when performing maintenance on a Talos Linux node with a Rook Ceph cluster (e.g. upgrading the Talos Linux version), it is imperative that care be taken to maintain the health of the Ceph cluster.

website/content/v1.8/kubernetes-guides/configuration/local-storage.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ description: "Using local storage for Kubernetes workloads."
66
Using local storage for Kubernetes workloads implies that the pod will be bound to the node where the local storage is available.
77
Local storage is not replicated, so in case of a machine failure contents of the local storage will be lost.
88

9-
> Note: when using `EPHEMERAL` Talos partition (`/var`), make sure to use `--preserve` set while performing upgrades, otherwise you risk losing data.
10-
119
## `hostPath` mounts
1210

1311
The simplest way to use local storage is to use `hostPath` mounts.

website/content/v1.8/kubernetes-guides/configuration/replicated-local-storage-with-openebs.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@ The documentation will follow installing OpenEBS via the offical Helm chart.
1313
Since Talos is different from standard Operating Systems, the OpenEBS components need a little tweaking after the Helm installation.
1414
Refer to the OpenEBS [documentation](https://openebs.io/docs/quickstart-guide/installation) if you need further customization.
1515

16-
> NB: Also note that the Talos nodes need to be upgraded with `--preserve` set while running OpenEBS, otherwise you risk losing data.
17-
> Even though it's possible to recover data from other replicas if the node is wiped during an upgrade, this can require extra operational knowledge to recover, so it's highly recommended to use `--preserve` to avoid data loss.
18-
1916
## Preparing the nodes
2017

2118
Depending on the version of OpenEBS, there is a `hostPath` mount with the path `/var/openebs/local` or `/var/local/openebs`.

website/content/v1.8/learn-more/architecture.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ Directories like this are `overlayfs` backed by an XFS file system mounted at `/
5050

5151
The `/var` directory is owned by Kubernetes with the exception of the above `overlayfs` file systems.
5252
This directory is writable and used by `etcd` (in the case of control plane nodes), the kubelet, and the CRI (containerd).
53-
Its content survives machine reboots, but it is wiped and lost on machine upgrades and resets, unless the
54-
`--preserve` option of [`talosctl upgrade`]({{< relref "../reference/cli#talosctl-upgrade" >}}) or the
53+
Its content survives machine reboots and on machine upgrades, but it is wiped and lost on resets, unless the
5554
`--system-labels-to-wipe` option of [`talosctl reset`]({{< relref "../reference/cli#talosctl-reset" >}})
5655
is used.

website/content/v1.8/talos-guides/upgrading-talos.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,6 @@ as:
6565
--image ghcr.io/siderolabs/installer:{{< release >}}
6666
```
6767

68-
There is an option to this command: `--preserve`, which will explicitly tell Talos to keep ephemeral data intact.
69-
In most cases, it is correct to let Talos perform its default action of erasing the ephemeral data.
70-
However, for a single-node control-plane, make sure that `--preserve=true`.
71-
7268
Rarely, an upgrade command will fail due to a process holding a file open on disk.
7369
In these cases, you can use the `--stage` flag.
7470
This puts the upgrade artifacts on disk, and adds some metadata to a disk partition that gets checked very early in the boot process, then reboots the node.

website/content/v1.9/advanced/proprietary-kernel-modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,5 @@ aliases:
6161
3. Deploying to your cluster
6262

6363
```bash
64-
talosctl upgrade --image ghcr.io/your-username/talos-installer:<talos version> --preserve=true
64+
talosctl upgrade --image ghcr.io/your-username/talos-installer:<talos version>
6565
```

website/content/v1.9/kubernetes-guides/configuration/ceph-with-rook.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ ceph-filesystem rook-ceph.cephfs.csi.ceph.com Delete Immediate
103103
## Talos Linux Considerations
104104

105105
It is important to note that a Rook Ceph cluster saves cluster information directly onto the node (by default `dataDirHostPath` is set to `/var/lib/rook`).
106-
If running only a single `mon` instance, cluster management is little bit more involved, as any time a Talos Linux node is reconfigured or upgraded, the partition that stores the `/var` [file system]({{< relref "../../learn-more/architecture#the-file-system" >}}) is wiped, but the `--preserve` option of [`talosctl upgrade`]({{< relref "../../reference/cli#talosctl-upgrade" >}}) will ensure that doesn't happen.
107106

108107
By default, Rook configues Ceph to have 3 `mon` instances, in which case the data stored in `dataDirHostPath` can be regenerated from the other `mon` instances.
109108
So when performing maintenance on a Talos Linux node with a Rook Ceph cluster (e.g. upgrading the Talos Linux version), it is imperative that care be taken to maintain the health of the Ceph cluster.

website/content/v1.9/kubernetes-guides/configuration/local-storage.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ description: "Using local storage for Kubernetes workloads."
66
Using local storage for Kubernetes workloads implies that the pod will be bound to the node where the local storage is available.
77
Local storage is not replicated, so in case of a machine failure contents of the local storage will be lost.
88

9-
> Note: when using `EPHEMERAL` Talos partition (`/var`), make sure to use `--preserve` set while performing upgrades, otherwise you risk losing data.
10-
119
## `hostPath` mounts
1210

1311
The simplest way to use local storage is to use `hostPath` mounts.

website/content/v1.9/learn-more/architecture.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ Directories like this are `overlayfs` backed by an XFS file system mounted at `/
5050

5151
The `/var` directory is owned by Kubernetes with the exception of the above `overlayfs` file systems.
5252
This directory is writable and used by `etcd` (in the case of control plane nodes), the kubelet, and the CRI (containerd).
53-
Its content survives machine reboots, but it is wiped and lost on machine upgrades and resets, unless the
54-
`--preserve` option of [`talosctl upgrade`]({{< relref "../reference/cli#talosctl-upgrade" >}}) or the
53+
Its content survives machine reboots and on machine upgrades, but it is wiped and lost on resets, unless the
5554
`--system-labels-to-wipe` option of [`talosctl reset`]({{< relref "../reference/cli#talosctl-reset" >}})
5655
is used.

0 commit comments

Comments
 (0)