Skip to content

Commit 3dd8d9a

Browse files
ihelmer07smira
authored andcommitted
docs: update resetting-a-machine.md to include example of reset
Slight formatting change and provided example of `talosctl reset`. Signed-off-by: ihelmer07 <ihelmer07@gmail.com> Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
1 parent 7af8f6b commit 3dd8d9a

2 files changed

Lines changed: 42 additions & 32 deletions

File tree

website/content/v1.10/talos-guides/resetting-a-machine.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,23 @@ aliases:
55
- ../guides/resetting-a-machine
66
---
77

8-
From time to time, it may be beneficial to reset a Talos machine to its "original" state.
9-
Bear in mind that this is a destructive action for the given machine.
10-
Doing this means removing the machine from Kubernetes, `etcd` (if applicable), and clears any data on the machine that would normally persist a reboot.
8+
Occasionally, it may be necessary to reset a Talos machine to its "original" state.
9+
Keep in mind that this is a destructive action for the given machine.
10+
This process involves removing the machine from Kubernetes, `etcd` (if applicable), and clearing any data on the machine that would normally persist after a reboot.
1111

1212
## CLI
1313

14-
> WARNING: Running a `talosctl reset` on cloud VM's might result in the VM being unable to boot as this wipes the entire disk.
15-
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`.
16-
`talosctl reset --system-labels-to-wipe STATE --system-labels-to-wipe EPHEMERAL`
14+
To reset a machine, use the `talosctl reset` command:
1715

18-
The API command for doing this is `talosctl reset`.
19-
There are a couple of flags as part of this command:
16+
```sh
17+
talosctl reset -n <node_ip_to_be_reset>
18+
```
19+
20+
> WARNING: Running `talosctl reset` on cloud VMs might result in the VM being unable to boot as this wipes the entire disk.
21+
> It might be more practical to only 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`.
22+
> `talosctl reset --system-labels-to-wipe STATE --system-labels-to-wipe EPHEMERAL`
23+
24+
The command includes several flags:
2025

2126
```bash
2227
Flags:
@@ -25,15 +30,15 @@ Flags:
2530
--system-labels-to-wipe strings if set, just wipe selected system disk partitions by label but keep other partitions intact
2631
```
2732
28-
The `graceful` flag is especially important when considering HA vs. non-HA Talos clusters.
29-
If the machine is part of an HA cluster, a normal, graceful reset should work just fine right out of the box as long as the cluster is in a good state.
30-
However, if this is a single node cluster being used for testing purposes, a graceful reset is not an option since Etcd cannot be "left" if there is only a single member.
31-
In this case, reset should be used with `--graceful=false` to skip performing checks that would normally block the reset.
33+
The `graceful` flag is particularly important when considering HA vs. non-HA Talos clusters.
34+
If the machine is part of an HA cluster, a normal, graceful reset should work fine as long as the cluster is in a good state.
35+
However, if this is a single-node cluster used for testing purposes, a graceful reset is not an option since `etcd` cannot be "left" if there is only a single member.
36+
In this case, use the reset command with `--graceful=false` to skip checks that would normally block the reset.
3237
3338
## Kernel Parameter
3439
35-
Another way to reset a machine is to specify `talos.experimental.wipe=system` kernel parameter.
36-
If the machine got stuck in the boot loop and you access to the console you can use GRUB to specify this kernel argument.
37-
Then when Talos boots for the next time it will reset system disk and reboot.
40+
Another method to reset a machine is by specifying the `talos.experimental.wipe=system` kernel parameter.
41+
If the machine is stuck in a boot loop and you have access to the console, you can use GRUB to specify this kernel argument.
42+
When Talos boots next, it will reset the system disk and reboot.
3843
39-
Next steps can be to install Talos either using PXE boot or by mounting an ISO.
44+
The next steps can include installing Talos either using PXE boot or by mounting an ISO.

website/content/v1.9/talos-guides/resetting-a-machine.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,23 @@ aliases:
55
- ../guides/resetting-a-machine
66
---
77

8-
From time to time, it may be beneficial to reset a Talos machine to its "original" state.
9-
Bear in mind that this is a destructive action for the given machine.
10-
Doing this means removing the machine from Kubernetes, `etcd` (if applicable), and clears any data on the machine that would normally persist a reboot.
8+
Occasionally, it may be necessary to reset a Talos machine to its "original" state.
9+
Keep in mind that this is a destructive action for the given machine.
10+
This process involves removing the machine from Kubernetes, `etcd` (if applicable), and clearing any data on the machine that would normally persist after a reboot.
1111

1212
## CLI
1313

14-
> WARNING: Running a `talosctl reset` on cloud VM's might result in the VM being unable to boot as this wipes the entire disk.
15-
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`.
16-
`talosctl reset --system-labels-to-wipe STATE --system-labels-to-wipe EPHEMERAL`
14+
To reset a machine, use the `talosctl reset` command:
1715

18-
The API command for doing this is `talosctl reset`.
19-
There are a couple of flags as part of this command:
16+
```sh
17+
talosctl reset -n <node_ip_to_be_reset>
18+
```
19+
20+
> WARNING: Running `talosctl reset` on cloud VMs might result in the VM being unable to boot as this wipes the entire disk.
21+
> It might be more practical to only 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`.
22+
> `talosctl reset --system-labels-to-wipe STATE --system-labels-to-wipe EPHEMERAL`
23+
24+
The command includes several flags:
2025

2126
```bash
2227
Flags:
@@ -25,15 +30,15 @@ Flags:
2530
--system-labels-to-wipe strings if set, just wipe selected system disk partitions by label but keep other partitions intact
2631
```
2732
28-
The `graceful` flag is especially important when considering HA vs. non-HA Talos clusters.
29-
If the machine is part of an HA cluster, a normal, graceful reset should work just fine right out of the box as long as the cluster is in a good state.
30-
However, if this is a single node cluster being used for testing purposes, a graceful reset is not an option since Etcd cannot be "left" if there is only a single member.
31-
In this case, reset should be used with `--graceful=false` to skip performing checks that would normally block the reset.
33+
The `graceful` flag is particularly important when considering HA vs. non-HA Talos clusters.
34+
If the machine is part of an HA cluster, a normal, graceful reset should work fine as long as the cluster is in a good state.
35+
However, if this is a single-node cluster used for testing purposes, a graceful reset is not an option since `etcd` cannot be "left" if there is only a single member.
36+
In this case, use the reset command with `--graceful=false` to skip checks that would normally block the reset.
3237
3338
## Kernel Parameter
3439
35-
Another way to reset a machine is to specify `talos.experimental.wipe=system` kernel parameter.
36-
If the machine got stuck in the boot loop and you access to the console you can use GRUB to specify this kernel argument.
37-
Then when Talos boots for the next time it will reset system disk and reboot.
40+
Another method to reset a machine is by specifying the `talos.experimental.wipe=system` kernel parameter.
41+
If the machine is stuck in a boot loop and you have access to the console, you can use GRUB to specify this kernel argument.
42+
When Talos boots next, it will reset the system disk and reboot.
3843
39-
Next steps can be to install Talos either using PXE boot or by mounting an ISO.
44+
The next steps can include installing Talos either using PXE boot or by mounting an ISO.

0 commit comments

Comments
 (0)