Skip to content

Commit e900cd2

Browse files
committed
Clarify that removing an app/kots is for existing cluster installs
1 parent 596bb05 commit e900cd2

File tree

1 file changed

+1
-13
lines changed

1 file changed

+1
-13
lines changed

docs/enterprise/delete-admin-console.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
11
# Deleting the Admin Console and Removing Applications
22

3-
This topic describes how to remove installed applications and delete the Replicated Admin Console from a cluster.
3+
This topic describes how to remove installed applications and delete the Replicated KOTS Admin Console. The information in this topic applies to existing cluster installations with KOTS.
44

55
## Remove an Application
66

7-
This section describes how to remove an application instance that was installed with KOTS in an existing cluster.
8-
9-
### About Removing an Installed Application Instance
10-
117
The Replicated KOTS CLI `kots remove` command removes the reference to an installed application from the Admin Console. When you use `kots remove`, the Admin Console no longer manages the application because the record of that application’s installation is removed. This means that you can no longer manage the application through the Admin Console or through the KOTS CLI.
128

139
By default, `kots remove` does not delete any of the installed Kubernetes resources for the application from the cluster. To remove both the reference to an application from the Admin Console and remove any resources for the application from the cluster, you can run `kots remove` with the `--undeploy` flag.
1410

1511
It can be useful to remove only the reference to an application from the Admin Console if you want to reinstall the application, but you do not want to recreate the namespace or other Kubernetes resources. For example, if you installed an application using an incorrect license file and need to reinstall with the correct license.
16-
17-
### Procedure
1812

1913
To remove an application:
2014

@@ -50,10 +44,6 @@ To remove an application:
5044
5145
## Delete the Admin Console
5246
53-
This section describes how to remove the KOTS Admin Console from an existing cluster.
54-
55-
### About Deleting the Admin Console from an Existing Cluster
56-
5747
When you install an application, KOTS creates the Kubernetes resources for the Admin Console itself on the cluster. The Admin Console includes Deployments and Services, Secrets, and other resources such as StatefulSets and PersistentVolumeClaims.
5848
5949
By default, KOTS also creates Kubernetes ClusterRole and ClusterRoleBinding resources that grant permissions to the Admin Console on the cluster level. These `kotsadm-role` and `kotsadm-rolebinding` resources are managed outside of the namespace where the Admin Console is installed. Alternatively, when the Admin Console is installed with namespace-scoped access, KOTS creates Role and RoleBinding resources inside the namespace where the Admin Console is installed.
@@ -64,8 +54,6 @@ If you installed the Admin Console with namespace-scoped access, then the Admin
6454
6555
For more information about installing with cluster- or namespace-scoped access, see [RBAC Requirements](/enterprise/installing-general-requirements#rbac-requirements) in _Installation Requirements_.
6656
67-
### Procedure
68-
6957
To completely delete the Admin Console from an existing cluster:
7058
7159
1. Run the following command to delete the namespace where the Admin Console is installed:

0 commit comments

Comments
 (0)