You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Deleting the Admin Console and Removing Applications
2
2
3
-
This topic describes how to remove installed applications and delete the Replicated Admin Console from a cluster. See the following sections:
4
-
*[Remove an Application](#remove-an-application)
5
-
*[Delete the Admin Console](#delete-the-admin-console)
3
+
This topic describes how to remove installed applications and delete the Replicated Admin Console from a cluster.
6
4
7
5
## Remove an Application
8
6
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
+
9
11
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.
10
12
11
13
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.
12
14
13
15
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
14
18
15
19
To remove an application:
16
20
@@ -46,43 +50,39 @@ To remove an application:
46
50
47
51
## Delete the Admin Console
48
52
49
-
When you install an application with the Admin Console, Replicated KOTS also 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.
50
-
51
-
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.
52
-
53
-
If you need to completely delete the Admin Console and an application installation, such as during testing, follow one of these procedures depending on the type of cluster where you installed the Admin Console:
54
-
55
-
* **Existing cluster**: Manually delete the Admin Console Kubernetes objects and resources from the cluster. See [Delete from an Existing Cluster](#existing) below.
56
-
* **Embedded cluster**: Remove Kubernetes from the VM where the cluster is installed. See [Delete from an Embedded Cluster](#embedded) below.
53
+
This section describes how to remove the KOTS Admin Console from an existing cluster.
57
54
58
-
:::note
59
-
These procedures do not uninstall the KOTS CLI. To uninstall the KOTS CLI, see [Uninstall](https://docs.replicated.com/reference/kots-cli-getting-started#uninstall) in _Installing the KOTS CLI_.
60
-
:::
55
+
### About Deleting the Admin Console from an Existing Cluster
61
56
62
-
### Delete from an Existing Cluster {#existing}
57
+
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.
63
58
64
-
In existing cluster installations, if the Admin Console is not installed in the `default` namespace, then you delete the Admin Console by deleting the namespace where it is installed.
59
+
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.
65
60
66
-
If you installed the Admin Console with namespace-scoped access, then the Admin Console Role and RoleBinding RBAC resources are also deleted when you delete the namespace. Alternatively, if you installed with the default cluster-scoped access, then you manually delete the Admin Console ClusterRole and ClusterRoleBindings resources from the cluster.
61
+
In existing cluster installations, if the Admin Console is not installed in the `default` namespace, then you delete the Admin Console by deleting the namespace where it is installed.
67
62
68
-
The application vendor can require, support, or not support namespace-scoped installations. For more information, see [supportMinimalRBACPrivileges](/reference/custom-resource-application#supportminimalrbacprivileges) and [requireMinimalRBACPrivileges](/reference/custom-resource-application#requireminimalrbacprivileges) in _Application_.
63
+
If you installed the Admin Console with namespace-scoped access, then the Admin Console Role and RoleBinding RBAC resources are also deleted when you delete the namespace. Alternatively, if you installed with the default cluster-scoped access, then you manually delete the Admin Console ClusterRole and ClusterRoleBindings resources from the cluster. For more information, see [supportMinimalRBACPrivileges](/reference/custom-resource-application#supportminimalrbacprivileges) and [requireMinimalRBACPrivileges](/reference/custom-resource-application#requireminimalrbacprivileges) in _Application_.
69
64
70
65
For more information about installing with cluster- or namespace-scoped access, see [RBAC Requirements](/enterprise/installing-general-requirements#rbac-requirements) in _Installation Requirements_.
71
66
72
-
To delete the Admin Console from an existing cluster:
67
+
### Procedure
68
+
69
+
To completely delete the Admin Console from an existing cluster:
73
70
74
71
1. Run the following command to delete the namespace where the Admin Console is installed:
75
72
76
-
:::note
77
-
* You cannot delete the `default` namespace.
78
-
* This command deletes everything inside the specified namespace, including the Admin Console Role and RoleBinding resources if you installed with namespace-scoped access.
73
+
:::important
74
+
This command deletes everything inside the specified namespace, including the Admin Console Role and RoleBinding resources if you installed with namespace-scoped access.
79
75
:::
80
76
81
77
```
82
78
kubectl delete ns NAMESPACE
83
79
```
84
80
Replace `NAMESPACE` with the name of the namespace where the Admin Console is installed.
85
81
82
+
:::note
83
+
You cannot delete the `default` namespace.
84
+
:::
85
+
86
86
1. (Cluster-scoped Access Only) If you installed the Admin Console with the default cluster-scoped access, run the following commands to delete the Admin Console ClusterRole and ClusterRoleBinding from the cluster:
87
87
88
88
```
@@ -93,28 +93,4 @@ To delete the Admin Console from an existing cluster:
If you installed on a cluster created by Replicated kURL, KOTS installs the Admin Console in the `default` namespace. Kubernetes does not allow the `default` namespace to be deleted.
99
-
100
-
To delete the Admin Console from an embedded cluster, use the kURL `tasks.sh` `reset` command to remove Kubernetes from the system.
101
-
102
-
:::important
103
-
The `reset` command is intended to be used only on development servers. It has the potential to leave your machine in an unrecoverable state. It is not recommended unless you are able to discard this server and provision a new one.
104
-
:::
105
-
106
-
Instead of using the `reset` command, you can also discard your current VM (if you are using one) and recreate the VM with a new OS to reinstall the Admin Console and an application.
107
-
108
-
For more information about the `reset` command, see [Resetting a Node](https://kurl.sh/docs/install-with-kurl/managing-nodes#reset-a-node) in the kURL documentation.
109
-
110
-
To delete the Admin Console from an embedded cluster:
111
-
112
-
1. Run the following command to remove Kubernetes from the system:
1. Follow the instructions in the output of the command to manually remove any files that the `reset` command does not remove.
119
-
120
-
If the `reset` command is unsuccessful, discard your current VM, and recreate the VM with a new OS to reinstall the Admin Console and an application.
96
+
1. (Optional) To uninstall the KOTS CLI, see [Uninstall](https://docs.replicated.com/reference/kots-cli-getting-started#uninstall) in _Installing the KOTS CLI_.
This topic describes how to use the kURL `reset` command to reset a kURL cluster.
4
+
5
+
## Overview
6
+
7
+
If you need to reset a kURL installation, such as when you are testing releases with kURL, You can use the kURL `tasks.sh``reset` command to remove Kubernetes from the system.
8
+
9
+
Alterntaively, you can discard your current VM (if you are using one) and recreate the VM with a new OS to reinstall with kURL.
10
+
11
+
:::important
12
+
The `reset` command is intended to be used only on development servers. It has the potential to leave your machine in an unrecoverable state. It is not recommended unless you are able to discard this server and provision a new one.
13
+
:::
14
+
15
+
For more information about the `reset` command, see [Resetting a Node](https://kurl.sh/docs/install-with-kurl/managing-nodes#reset-a-node) in the kURL documentation.
16
+
17
+
To reset a kURL installation:
18
+
19
+
1. Access the machine where you installed with kURL.
20
+
21
+
1. Run the following command to remove Kubernetes from the system:
0 commit comments