Skip to content

Commit

Permalink
document new uninstall command
Browse files Browse the repository at this point in the history 
Signed-off-by: Rohan CJ <[email protected]>
  • Loading branch information
@rohantmp
rohantmp committed Nov 29, 2024
1 parent dd26c10 commit 7134460
Showing 1 changed file with 10 additions and 23 deletions.
33 changes: 10 additions & 23 deletions platform/how-to/uninstall.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,25 @@ sidebar_label: Uninstall vCluster Platform
sidebar_position: 8
---

## Delete Helm Release

```bash
helm delete -n vcluster-platform loft
```

Please make sure you also uninstall kiosk, if you have connected the loft cluster:
## Delete The Platform

Check warning on line 9 in platform/how-to/uninstall.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Headings] 'Delete The Platform' should use sentence-style capitalization.

Raw Output:
{"message": "[Google.Headings] 'Delete The Platform' should use sentence-style capitalization.", "location": {"path": "platform/how-to/uninstall.mdx", "range": {"start": {"line": 9, "column": 4}}}, "severity": "WARNING"}

```bash
helm delete -n vcluster-platform loft-agent
```
:::warning
This action is done against the cluster the kube-context is pointing to, and not the Platform instance that is logged in.
It does not require logging in to the Platform.
:::

## Delete Namespace (optional)

```bash
kubectl delete ns vcluster-platform
```
VirtualClusterInstances managed with driver Helm are deleted, but the underlying virtual clusters are not uninstalled

If you have deleted the namespace **without** deleting the vcluster-platform and loft-agent helm releases beforehand, please make sure the api-services and webhooks are deleted correctly:

```bash
# vCluster Platform agent api service and webhook
kubectl delete apiservice v1.cluster.loft.sh
kubectl delete validatingwebhookconfiguration loft-agent
vcluster destroy platform
```

## Delete CRDs (optional)
## Troubleshooting

```bash
kubectl api-resources --api-group='storage.loft.sh' -o name | xargs kubectl delete crd
```
If a resource is stuck/errored in deletion, you may have to investigate the logs and status of the stuck resource and remove it manually.

:::warning Data Loss
Deleting the vCluster Platform CRDs will also remove all vCluster Platform objects inside your cluster, e.g. `Cluster`, `Team`, and `User`. This **cannot** be undone.
:::
The command is retryable.

0 comments on commit 7134460

Please sign in to comment.