From 32a3edc4f886f1551cf05113e8198730d982621a Mon Sep 17 00:00:00 2001 From: Benjamin Schimke Date: Thu, 9 Jan 2025 11:44:54 +0100 Subject: [PATCH 1/7] Add uninstall section --- docs/src/snap/howto/install/index.md | 1 + docs/src/snap/howto/install/uninstall.md | 39 ++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 docs/src/snap/howto/install/uninstall.md diff --git a/docs/src/snap/howto/install/index.md b/docs/src/snap/howto/install/index.md index 76e1169c7..cb8eeba54 100644 --- a/docs/src/snap/howto/install/index.md +++ b/docs/src/snap/howto/install/index.md @@ -16,4 +16,5 @@ Install from a snap multipass Install in LXD Install in air-gapped environments +Uninstall the snap ``` diff --git a/docs/src/snap/howto/install/uninstall.md b/docs/src/snap/howto/install/uninstall.md new file mode 100644 index 000000000..f85e5f573 --- /dev/null +++ b/docs/src/snap/howto/install/uninstall.md @@ -0,0 +1,39 @@ +# How to uninstall the {{ product }} snap + +This guide provides step-by-step instructions for removing the {{ product }} +snap from your system. + +--- + +## Steps to Uninstall + +### Remove the snap + +To uninstall the `k8s` snap, run the following command: + +``` +sudo snap remove k8s +``` + +This command uninstalls the snap but may leave some configuration and data +files on the system. +For a complete removal, including all cluster data, use the `--purge` option: + +``` +sudo snap remove k8s --purge +``` + +### Verify removal + +To confirm the snap has been successfully removed, check the list of installed +snaps: + +``` +snap list k8s +``` + +which should produce an output similar to: + +``` +error: no matching snaps installed +``` From 3a215d0b4e7610d6ce2182357e4fa967c606250a Mon Sep 17 00:00:00 2001 From: Benjamin Schimke Date: Thu, 9 Jan 2025 12:20:51 +0100 Subject: [PATCH 2/7] Update docs/src/snap/howto/install/uninstall.md Co-authored-by: Homayoon Alimohammadi --- docs/src/snap/howto/install/uninstall.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/snap/howto/install/uninstall.md b/docs/src/snap/howto/install/uninstall.md index f85e5f573..1e1c06811 100644 --- a/docs/src/snap/howto/install/uninstall.md +++ b/docs/src/snap/howto/install/uninstall.md @@ -1,4 +1,4 @@ -# How to uninstall the {{ product }} snap +# How to Uninstall the {{ product }} Snap This guide provides step-by-step instructions for removing the {{ product }} snap from your system. From b2687863c91f43abc15aad2e8a4f6cc3b772b8bb Mon Sep 17 00:00:00 2001 From: Benjamin Schimke Date: Thu, 9 Jan 2025 14:20:40 +0100 Subject: [PATCH 3/7] Update docs/src/snap/howto/install/uninstall.md Co-authored-by: Louise K. Schmidtgen --- docs/src/snap/howto/install/uninstall.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/snap/howto/install/uninstall.md b/docs/src/snap/howto/install/uninstall.md index 1e1c06811..18e5b0535 100644 --- a/docs/src/snap/howto/install/uninstall.md +++ b/docs/src/snap/howto/install/uninstall.md @@ -23,9 +23,9 @@ For a complete removal, including all cluster data, use the `--purge` option: sudo snap remove k8s --purge ``` -### Verify removal +## Confirm snap removal -To confirm the snap has been successfully removed, check the list of installed +To confirm the snap is successfully removed, check the list of installed snaps: ``` From 9119d9851f41ed4b77d6f99a3a02a5ae99e96d4c Mon Sep 17 00:00:00 2001 From: Benjamin Schimke Date: Thu, 9 Jan 2025 14:20:49 +0100 Subject: [PATCH 4/7] Update docs/src/snap/howto/install/uninstall.md Co-authored-by: Louise K. Schmidtgen --- docs/src/snap/howto/install/uninstall.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/src/snap/howto/install/uninstall.md b/docs/src/snap/howto/install/uninstall.md index 18e5b0535..aa874b134 100644 --- a/docs/src/snap/howto/install/uninstall.md +++ b/docs/src/snap/howto/install/uninstall.md @@ -5,9 +5,7 @@ snap from your system. --- -## Steps to Uninstall - -### Remove the snap +## Removing the k8s snap To uninstall the `k8s` snap, run the following command: From b30e7017f6c8f8dbeed10cbd94a0cc7c59197b9c Mon Sep 17 00:00:00 2001 From: Benjamin Schimke Date: Thu, 9 Jan 2025 14:20:59 +0100 Subject: [PATCH 5/7] Update docs/src/snap/howto/install/uninstall.md Co-authored-by: Louise K. Schmidtgen --- docs/src/snap/howto/install/uninstall.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/snap/howto/install/uninstall.md b/docs/src/snap/howto/install/uninstall.md index aa874b134..0b7bdf2a8 100644 --- a/docs/src/snap/howto/install/uninstall.md +++ b/docs/src/snap/howto/install/uninstall.md @@ -30,7 +30,7 @@ snaps: snap list k8s ``` -which should produce an output similar to: +This command should produce an output similar to: ``` error: no matching snaps installed From 07c913b655faee1bbcd138d15ccd7d73c330c003 Mon Sep 17 00:00:00 2001 From: Benjamin Schimke Date: Thu, 9 Jan 2025 14:21:06 +0100 Subject: [PATCH 6/7] Update docs/src/snap/howto/install/uninstall.md Co-authored-by: Louise K. Schmidtgen --- docs/src/snap/howto/install/uninstall.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/snap/howto/install/uninstall.md b/docs/src/snap/howto/install/uninstall.md index 0b7bdf2a8..0dda1721c 100644 --- a/docs/src/snap/howto/install/uninstall.md +++ b/docs/src/snap/howto/install/uninstall.md @@ -13,7 +13,7 @@ To uninstall the `k8s` snap, run the following command: sudo snap remove k8s ``` -This command uninstalls the snap but may leave some configuration and data +This command uninstalls the snap but may leave some configurations and data files on the system. For a complete removal, including all cluster data, use the `--purge` option: From 04e6ac73141319d1aea1a26fa70867a2cd45adca Mon Sep 17 00:00:00 2001 From: Benjamin Schimke Date: Fri, 10 Jan 2025 11:07:31 +0100 Subject: [PATCH 7/7] Update header --- docs/src/snap/howto/install/uninstall.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/src/snap/howto/install/uninstall.md b/docs/src/snap/howto/install/uninstall.md index 0dda1721c..ce31c27ce 100644 --- a/docs/src/snap/howto/install/uninstall.md +++ b/docs/src/snap/howto/install/uninstall.md @@ -1,9 +1,8 @@ -# How to Uninstall the {{ product }} Snap +# How to uninstall the {{product}} snap This guide provides step-by-step instructions for removing the {{ product }} snap from your system. ---- ## Removing the k8s snap