From 699cbf1c2cad15ea3a0bb132513e0605b921310a Mon Sep 17 00:00:00 2001 From: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Date: Thu, 21 Nov 2024 15:15:05 -0800 Subject: [PATCH] docs: add helm uninstall instructions (#4736) * docs: add helm uninstall instructions * docs: add vertex instructions * docs: incorporate review feedback * docs: add vertex instructions * docs: typo * minor edit * docs: review feedback * docs: fix missed step * Apply suggestions from code review * ci: auto-formatting prettier issues * Apply suggestions from code review Co-authored-by: caroldelwing * docs: longform --------- Co-authored-by: Lenny Chen Co-authored-by: lennessyy Co-authored-by: caroldelwing --- .../install-on-kubernetes/uninstall.md | 122 ++++++++++++++++++ .../install-on-kubernetes/uninstall.md | 122 ++++++++++++++++++ 2 files changed, 244 insertions(+) create mode 100644 docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/uninstall.md create mode 100644 docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/uninstall.md diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/uninstall.md b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/uninstall.md new file mode 100644 index 0000000000..33b3a886f9 --- /dev/null +++ b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/uninstall.md @@ -0,0 +1,122 @@ +--- +sidebar_label: "Uninstallation" +title: "Uninstall Palette" +description: "Learn how to uninstall a Palette installation from your cluster using Helm charts." +icon: "" +hide_table_of_contents: false +sidebar_position: 40 +tags: ["self-hosted", "enterprise"] +keywords: ["self-hosted", "enterprise"] +--- + +To uninstall Palette from your cluster, you need to uninstall Palette management plane and Cert Manager. Optionally, you +may have installed Image Swap and Reach system, which also need to be uninstalled. This uninstall process applies to +both connected and airgap instances of self-hosted Palette. + +:::warning + +This uninstallation process only applies to Palette instances installed using Helm charts. If you used the Palette CLI +to install Palette, this process does not apply. + +::: + +## Prerequisite + +- An active self-hosted Palette instance. + +- Access to the Kubernetes cluster where Palette is deployed. + +- Permissions to perform delete actions on all relevant cluster resources. + +- [Helm](https://helm.sh/docs/intro/install/) is installed and available on your host machine. + +- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) is installed and available on your host machine. + +## Uninstall Palette + +1. Ensure you are using the appropriate context where Palette is deployed. + + ```shell + kubectl config current-context + ``` + +2. Issue the following command to start uninstalling the Palette management plane. This will only remove the resources + managed by Helm and the remaining resources will require additional manual intervention. + + ```shell + helm uninstall hubble + ``` + +3. Issue the following command to remove the namespace and custom resource definitions related to the Palette management + plane. + + ```shell + kubectl delete namespace hubble-system || kubectl delete crd spectroclusteractions.jet.cluster.spectrocloud.com + ``` + +4. Issue the following command to uninstall Cert Manager. Cert Manager does not reply on any Helm hooks and the Helm + uninstall command will uninstall all related resources. + + ```shell + helm uninstall cert-manager + ``` + +5. (Optional) If you installed Reach, issue the following command to start uninstalling Reach. This will remove all + resources related to Reach that are managed by Helm. However, some resources created by Helm hooks are not managed by + Helm and will require additional manual intervention to remove. + + ```shell + helm uninstall reach-system + ``` + +6. (Optional) Issue the following commands to remove the remaining Reach system resources. + + ```shell + kubectl delete ns reach-system + kubectl delete crd podpresets.reach.spectrocloud.com clusterpodpresets.reach.spectrocloud.com + kubectl delete mutatingwebhookconfiguration reach-mutating-webhook-configuration + kubectl delete validatingwebhookconfiguration reach-validating-webhook-configuration + kubectl delete clusterrolebinding reach-manager-rolebinding + kubectl delete clusterrolebinding reach-proxy-rolebinding + kubectl delete clusterrole reach-manager-role + kubectl delete clusterrole reach-metrics-reader + kubectl delete clusterrole reach-proxy-role + ``` + +7. (Optional) If you installed Image Swap, issue the following command to remove the `image-swap` chart. + + ```shell + helm uninstall image-swap + ``` + +8. (Optional) Issue the following commands to remove the remaining resources related to `image-swap`. + + ```shell + kubectl delete ns imageswap-system + kubectl delete mutatingwebhookconfiguration imageswap-webhook + kubectl delete csr imageswap.imageswap-system.cert-request + ``` + +## Validate + +1. Connect to your cluster via kubectl. + +2. Issue the following command to get a list of the remaining namespaces. Confirm that all Palette-related namespaces + have been deleted. + + ```shell + kubectl get namespaces + ``` + +3. Issue the following command to confirm that all charts have been uninstalled. + + ```shell + helm ls + ``` + +4. Issue the following command to retrieve all resources in your cluster across all namespaces. Confirm that no + Palette-related resources are remaining. + + ```shell + kubectl get all --all-namespaces + ``` diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/uninstall.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/uninstall.md new file mode 100644 index 0000000000..48fe4c7a67 --- /dev/null +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/uninstall.md @@ -0,0 +1,122 @@ +--- +sidebar_label: "Uninstallation" +title: "Uninstall VerteX" +description: "Learn how to uninstall a VerteX installation from your cluster using Helm charts." +icon: "" +hide_table_of_contents: false +sidebar_position: 40 +tags: ["self-hosted", "enterprise"] +keywords: ["vertex"] +--- + +To uninstall VerteX from your cluster, you need to uninstall VerteX management plane and Cert Manager. Optionally, you +may have installed Image Swap and Reach system, which also need to be uninstalled. This uninstall process applies to +both connected and airgap instances of self-hosted VerteX. + +:::warning + +This uninstallation process only applies to VerteX instances installed using Helm charts. If you used the Palette CLI to +install VerteX, this process does not apply. + +::: + +## Prerequisite + +- An active self-hosted VerteX instance. + +- Access to the Kubernetes cluster where VerteX is deployed. + +- Permissions to perform delete actions on all relevant cluster resources. + +- [Helm](https://helm.sh/docs/intro/install/) is installed and available on your host machine. + +- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) is installed and available on your host machine. + +## Uninstall VerteX + +1. Ensure you are using the appropriate context where VerteX is deployed. + + ```shell + kubectl config current-context + ``` + +2. Issue the following command to start uninstalling the Vertex management plane. This will only remove the resources + managed by Helm and the remaining resources will require additional manual intervention. + + ```shell + helm uninstall hubble + ``` + +3. Issue the following command to remove the namespace and custom resource definitions related to Vertex management + plane. + + ```shell + kubectl delete namespace hubble-system || kubectl delete crd spectroclusteractions.jet.cluster.spectrocloud.com + ``` + +4. Issue the following command to uninstall Cert Manager. Cert Manager does not reply on any Helm hooks and the Helm + uninstall command will uninstall all related resources. + + ```shell + helm uninstall cert-manager + ``` + +5. (Optional) If you installed Reach, issue the following command to start uninstalling Reach. This will remove all + resources related to Reach that are managed by Helm. However, some resources created by Helm hooks are not managed by + Helm and will require additional manual intervention to remove. + + ```shell + helm uninstall reach-system + ``` + +6. (Optional) Issue the following commands to remove the remaining Reach system resources. + + ```shell + kubectl delete ns reach-system + kubectl delete crd podpresets.reach.spectrocloud.com clusterpodpresets.reach.spectrocloud.com + kubectl delete mutatingwebhookconfiguration reach-mutating-webhook-configuration + kubectl delete validatingwebhookconfiguration reach-validating-webhook-configuration + kubectl delete clusterrolebinding reach-manager-rolebinding + kubectl delete clusterrolebinding reach-proxy-rolebinding + kubectl delete clusterrole reach-manager-role + kubectl delete clusterrole reach-metrics-reader + kubectl delete clusterrole reach-proxy-role + ``` + +7. (Optional) If you installed Image Swap, issue the following command to remove the `image-swap` chart. + + ```shell + helm uninstall image-swap + ``` + +8. (Optional) Issue the following commands to remove the remaining resources related to `image-swap`. + + ```shell + kubectl delete ns imageswap-system + kubectl delete mutatingwebhookconfiguration imageswap-webhook + kubectl delete csr imageswap.imageswap-system.cert-request + ``` + +## Validate + +1. Connect to your cluster via kubectl. + +2. Issue the following command to get a list of the remaining namespaces. Confirm that all VerteX-related namespaces + have been deleted. + + ```shell + kubectl get namespaces + ``` + +3. Issue the following command to confirm that all charts have been uninstalled. + + ```shell + helm ls + ``` + +4. Issue the following command to retrieve all resources in your cluster across all namespaces. Confirm that no + VerteX-related resources are remaining. + + ```shell + kubectl get all --all-namespaces + ```