From 9e6eb902039b312a6b3e44eefbe901f22ef26bb5 Mon Sep 17 00:00:00 2001 From: Spencer Smith Date: Mon, 31 Aug 2020 14:41:07 -0400 Subject: [PATCH] docs: add reset doc This PR adds a simple doc on how to do a talos machine reset. This command was introduced all the way back on v0.4 so the docs are added everywhere. Signed-off-by: Spencer Smith --- docs/website/content/v0.4.en.json | 4 ++++ .../v0.4/en/troubleshooting/machine-reset.md | 21 +++++++++++++++++++ docs/website/content/v0.5.en.json | 3 ++- .../v0.5/en/troubleshooting/machine-reset.md | 21 +++++++++++++++++++ docs/website/content/v0.6.en.json | 4 ++++ .../v0.6/en/troubleshooting/machine-reset.md | 21 +++++++++++++++++++ 6 files changed, 73 insertions(+), 1 deletion(-) create mode 100644 docs/website/content/v0.4/en/troubleshooting/machine-reset.md create mode 100644 docs/website/content/v0.5/en/troubleshooting/machine-reset.md create mode 100644 docs/website/content/v0.6/en/troubleshooting/machine-reset.md diff --git a/docs/website/content/v0.4.en.json b/docs/website/content/v0.4.en.json index 154d8e6ab..629f4cb63 100644 --- a/docs/website/content/v0.4.en.json +++ b/docs/website/content/v0.4.en.json @@ -88,6 +88,10 @@ { "title": "PKI", "path": "v0.4/en/troubleshooting/pki" + }, + { + "title": "Machine Reset", + "path": "v0.4/en/troubleshooting/machine-reset" } ] }, diff --git a/docs/website/content/v0.4/en/troubleshooting/machine-reset.md b/docs/website/content/v0.4/en/troubleshooting/machine-reset.md new file mode 100644 index 000000000..24db8d75d --- /dev/null +++ b/docs/website/content/v0.4/en/troubleshooting/machine-reset.md @@ -0,0 +1,21 @@ +--- +title: 'Machine Reset' +--- + +From time to time, it may be beneficial to reset a Talos machine to its "original" state. +Bear in mind that this is a destructive action for the given machine. +Doing this means removing the machine from Kubernetes, Etcd (if applicable), and clears any data on the machine that would normally persist a reboot. + +The API command for doing this is `talosctl reset`. +There are a couple of flags as part of this command: + +```bash +Flags: + --graceful if true, attempt to cordon/drain node and leave etcd (if applicable) (default true) + --reboot if true, reboot the node after resetting instead of shutting down +``` + +The `graceful` flag is especially important when considering HA vs. non-HA Talos clusters. +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. +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. +In this case, reset should be used with `--graceful=false` to skip performing checks that would normally block the reset. diff --git a/docs/website/content/v0.5.en.json b/docs/website/content/v0.5.en.json index a6a7e194f..9eab0df38 100644 --- a/docs/website/content/v0.5.en.json +++ b/docs/website/content/v0.5.en.json @@ -73,7 +73,8 @@ "path": "v0.5/en/troubleshooting", "items": [ { "title": "Overview", "path": "v0.5/en/troubleshooting/overview" }, - { "title": "PKI", "path": "v0.5/en/troubleshooting/pki" } + { "title": "PKI", "path": "v0.5/en/troubleshooting/pki" }, + { "title": "Machine Reset", "path": "v0.5/en/troubleshooting/machine-reset" } ] }, { diff --git a/docs/website/content/v0.5/en/troubleshooting/machine-reset.md b/docs/website/content/v0.5/en/troubleshooting/machine-reset.md new file mode 100644 index 000000000..24db8d75d --- /dev/null +++ b/docs/website/content/v0.5/en/troubleshooting/machine-reset.md @@ -0,0 +1,21 @@ +--- +title: 'Machine Reset' +--- + +From time to time, it may be beneficial to reset a Talos machine to its "original" state. +Bear in mind that this is a destructive action for the given machine. +Doing this means removing the machine from Kubernetes, Etcd (if applicable), and clears any data on the machine that would normally persist a reboot. + +The API command for doing this is `talosctl reset`. +There are a couple of flags as part of this command: + +```bash +Flags: + --graceful if true, attempt to cordon/drain node and leave etcd (if applicable) (default true) + --reboot if true, reboot the node after resetting instead of shutting down +``` + +The `graceful` flag is especially important when considering HA vs. non-HA Talos clusters. +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. +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. +In this case, reset should be used with `--graceful=false` to skip performing checks that would normally block the reset. diff --git a/docs/website/content/v0.6.en.json b/docs/website/content/v0.6.en.json index b94ee1a68..c2ebc80a4 100644 --- a/docs/website/content/v0.6.en.json +++ b/docs/website/content/v0.6.en.json @@ -117,6 +117,10 @@ { "title": "PKI", "path": "v0.6/en/troubleshooting/pki" + }, + { + "title": "Machine Reset", + "path": "v0.6/en/troubleshooting/machine-reset" } ] }, diff --git a/docs/website/content/v0.6/en/troubleshooting/machine-reset.md b/docs/website/content/v0.6/en/troubleshooting/machine-reset.md new file mode 100644 index 000000000..24db8d75d --- /dev/null +++ b/docs/website/content/v0.6/en/troubleshooting/machine-reset.md @@ -0,0 +1,21 @@ +--- +title: 'Machine Reset' +--- + +From time to time, it may be beneficial to reset a Talos machine to its "original" state. +Bear in mind that this is a destructive action for the given machine. +Doing this means removing the machine from Kubernetes, Etcd (if applicable), and clears any data on the machine that would normally persist a reboot. + +The API command for doing this is `talosctl reset`. +There are a couple of flags as part of this command: + +```bash +Flags: + --graceful if true, attempt to cordon/drain node and leave etcd (if applicable) (default true) + --reboot if true, reboot the node after resetting instead of shutting down +``` + +The `graceful` flag is especially important when considering HA vs. non-HA Talos clusters. +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. +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. +In this case, reset should be used with `--graceful=false` to skip performing checks that would normally block the reset.