status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Formatting for Consul K8s uninstall commands (#12031) 

* docs: Missing $ prior to command for Consul K8s uninstall

* re-do numer bullets was mis-numbered

* Update uninstall.mdx

* simplify wording
This commit is contained in:
David Yu 2022-01-12 09:16:42 -08:00 committed by GitHub
parent 4b730392d6
commit a17c78ab21
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/content/docs/k8s/operations/uninstall.mdx
View File

@ -29,7 +29,7 @@ Refer to the [Consul K8s CLI reference](/docs/k8s/k8s-cli#uninstall) topic for d
Run the `helm uninstall` **and** manually remove resources that Helm does not delete. Run the `helm uninstall` **and** manually remove resources that Helm does not delete.
1. Although the Helm chart automates the deletion of CRDs upon the uninstallation of the Helm chart, sometimes the finalizers tied to those CRDs may not complete because the deletion of the CRDs rely on the Consul K8s controller running. Ensure that previously created CRDs for Consul on Kubernetes are deleted, so subsequent installs of Consul on Kubernetes on the same Kubernetes cluster do not get blocked. 1. Although the Helm chart automates the deletion of CRDs upon uninstallation, sometimes the finalizers tied to those CRDs may not complete because the deletion of the CRDs rely on the Consul K8s controller running. Ensure that previously created CRDs for Consul on Kubernetes are deleted, so subsequent installs of Consul on Kubernetes on the same Kubernetes cluster do not get blocked.
```shell-session ```shell-session
$ kubectl delete crd --selector app=consul $ kubectl delete crd --selector app=consul
@ -37,10 +37,9 @@ Run the `helm uninstall` **and** manually remove resources that Helm does not de
1. (Optional) If Consul is installed in a dedicated namespace, set the kubeConfig context to the `consul` namespace. Otherwise, subsequent commands will need to include `-n consul`. 1. (Optional) If Consul is installed in a dedicated namespace, set the kubeConfig context to the `consul` namespace. Otherwise, subsequent commands will need to include `-n consul`.
```shell-session
$ kubectl config set-context --current --namespace=consul
``` ```
kubectl config set-context --current --namespace=consul
```
1. Run the `helm uninstall <release-name>` command and specify the release name you've installed Consul with, e.g.,: 1. Run the `helm uninstall <release-name>` command and specify the release name you've installed Consul with, e.g.,:
@ -49,7 +48,6 @@ Run the `helm uninstall` **and** manually remove resources that Helm does not de
release "consul" uninstalled release "consul" uninstalled
``` ```
1. After deleting the Helm release, you need to delete the `PersistentVolumeClaim`'s 1. After deleting the Helm release, you need to delete the `PersistentVolumeClaim`'s
for the persistent volumes that store Consul's data. A [bug](https://github.com/helm/helm/issues/5156) in Helm prevents PVCs from being deleted. Issue the following commands: for the persistent volumes that store Consul's data. A [bug](https://github.com/helm/helm/issues/5156) in Helm prevents PVCs from being deleted. Issue the following commands: