Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor uninstall doc steps #653

Merged
merged 1 commit into from
Nov 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified en/docs/assets/img/setup/apim-apk-agent-helm-list-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/docs/assets/img/setup/apk-helm-list-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 37 additions & 27 deletions en/docs/setup/uninstall.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Uninstall APK Components

**NOTE**: Uninstalling APK and any other components from the cluster involves deleting APK related data, configurations and CRDs from the cluster. Ensure that you back up any important data or configurations before proceeding with the rest of this guide.
!!! Note
Uninstalling APK and any other components from the cluster involves deleting APK related data, configurations and CRDs from the cluster. Ensure that you back up any important data or configurations before proceeding with the rest of this guide.

## Uninstall APK

Expand Down Expand Up @@ -30,32 +31,41 @@ For example, in the above image, the values are as follows.
To completely remove APK from your Kubernetes cluster, follow the steps given below.

1. Apply the following command.

=== "Command"
```
helm uninstall apk -n apk
```
=== "Format"
```
helm uninstall <chart-name> -n <namespace>
```

2. You will have the APK related CRDs remaining in the cluster. You can pipe them to a yaml file using the command given below.

=== "Command"
```
helm show crds wso2apk/apk-helm --version 1.2.0 > crds.yaml
```
=== "Format"
```
helm show crds <chart-name> <repository-name>/apk-helm --version <version> > crds.yaml
```

3. Then delete the CRDs using the following command.

```
kubectl delete -f crds.yaml
```

=== "Command"
```
helm uninstall apk -n apk
```
=== "Format"
```
helm uninstall <chart-name> -n <namespace>
```

2. You will have the APK specific related CRDs remaining in the cluster. You can delete the remaining CRDs using the command given below.

=== "Command"
```
kubectl delete crds aiproviders.dp.wso2.com airatelimitpolicies.dp.wso2.com applicationmappings.cp.wso2.com applications.cp.wso2.com backendjwts.dp.wso2.com backends.dp.wso2.com gqlroutes.dp.wso2.com interceptorservices.dp.wso2.com ratelimitpolicies.dp.wso2.com scopes.dp.wso2.com subscriptions.cp.wso2.com
```
=== "Format"
```
kubectl delete crds <crd-names>
```

3. You will then have common CRDs, such as those from Cert-Manager and Gateway API specifications, remaining in the cluster. You can delete these remaining CRDs using the command below. Please note that this will affect other applications in your cluster that use these CRDs.

=== "Command Remove GatewaySpec CRDs"
```
kubectl delete crds httproutes.gateway.networking.k8s.io tcproutes.gateway.networking.k8s.io tlsroutes.gateway.networking.k8s.io udproutes.gateway.networking.k8s.io grpcroutes.gateway.networking.k8s.io gateways.gateway.networking.k8s.io gatewayclasses.gateway.networking.k8s.io backendtlspolicies.gateway.networking.k8s.io backendlbpolicies.gateway.networking.k8s.io referencegrants.gateway.networking.k8s.io
```
=== "Command Remove Cert-Manager CRDs"
```
kubectl delete crds kubectl delete crds certificaterequests.cert-manager.io challenges.acme.cert-manager.io challenges.acme.cert-manager.io clusterissuers.cert-manager.io issuers.cert-manager.io orders.acme.cert-manager.io certificates.cert-manager.io
```
=== "Format"
```
kubectl delete crds <crd-names>
```

This will clear the APK installation from your Kubernetes cluster.

Expand Down