Skip to content

Commit 04289d3

Browse files
EricPonvelleEricPonvelle
authored
Merge pull request #47622 from tshwartz/TELCODOCS-392
Telcodocs 392
2 parents 8f60e02 + af1e6f9 commit 04289d3

11 files changed

+170
-95
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2135,7 +2135,7 @@ Topics:
21352135
File: deploying-sandboxed-container-workloads
21362136
- Name: Monitoring OpenShift sandboxed containers
21372137
File: monitoring-sandboxed-containers
2138-
- Name: Uninstalling OpenShift sandboxed containers workloads
2138+
- Name: Uninstalling OpenShift sandboxed containers
21392139
File: uninstalling-sandboxed-containers
21402140
- Name: Upgrade OpenShift sandboxed containers
21412141
File: upgrade-sandboxed-containers

‎modules/sandboxed-containers-deleting-resources.adoc renamed to ‎modules/sandboxed-containers-deleting-kataconfig-cli.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
// *uninstalling-sandboxed-containers.adoc
44

55
:_content-type: PROCEDURE
6-
[id="sandboxed-containers-deleting-resources_{context}"]
7-
= Deleting {sandboxed-containers-first} resources
6+
[id="sandboxed-containers-deleting-kataconfig-cli_{context}"]
7+
= Deleting the KataConfig custom resource using the CLI
88

9-
You can remove and uninstall the `kata` runtime and all its related resources, such as CRI-O config and `RuntimeClass`, from your cluster.
9+
Remove and uninstall the `kata` runtime and all its related resources, such as CRI-O config and `RuntimeClass`, from your cluster. The deletion typically takes between ten to forty minutes, depending on the size of the deployment.
1010

1111
.Prerequisites
1212

@@ -30,7 +30,7 @@ $ oc delete kataconfig <KataConfig_CR_Name>
3030
$ oc delete crd kataconfigs.kataconfiguration.openshift.io
3131
----
3232

33-
The {sandboxed-containers-operator} removes all resources that were initially created to enable the runtime on your cluster. After you run the preceding commands, your cluster is restored to the state that it was prior to the installation process. You can now delete the `openshift-sandboxed-containers-operator` namespace.
33+
The {sandboxed-containers-operator} removes all resources that were initially created to enable the runtime on your cluster.
3434

3535
.Verification
3636

‎modules/sandboxed-containers-deleting-kataconfig-web-console.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *uninstalling-sandboxed-containers.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="sandboxed-containers-deleting-kataconfig-web-console_{context}"]
7+
= Deleting the KataConfig custom resource using the web console
8+
9+
Deleting the `KataConfig` custom resource (CR) removes and uninstalls the `kata` runtime and its related resources from your cluster. The deletion typically takes between ten to forty minutes, depending on the size of the deployment.
10+
11+
.Prerequisites
12+
13+
* You have {product-title} {product-version} installed on your cluster.
14+
* You have access to the cluster as a user with the `cluster-admin` role.
15+
* You have no running pods that use `kata` as the `runtimeClass`.
16+
17+
.Procedure
18+
19+
. From the *Administrator* perspective, navigate to *Operators* → *Installed Operators*.
20+
. Search for the {sandboxed-containers-operator} using the *Search by name* field.
21+
. Click the Operator to open it, and then select the *KataConfig* tab.
22+
. Click the *Options* menu {kebab} for the `KataConfig` resource, and then select *Delete `KataConfig`*.
23+
. Click *Delete* in the confirmation window.

‎modules/sandboxed-containers-deleting-namespace-web-console.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_content-type: PROCEDURE
66
[id="sandboxed-containers-deleting-namespace-web-console_{context}"]
7-
= Deleting a namespace using the web console
7+
= Deleting the {sandboxed-containers-first} namespace using the web console
88

9-
You can delete a namespace by using the {product-title} web console.
9+
After you run the preceding commands, your cluster is restored to the state that it was prior to the installation process. You can now revoke namespace access to the Operator by deleting the `openshift-sandboxed-containers-operator` namespace.
1010

1111
.Prerequisites
1212

@@ -15,13 +15,13 @@ You can delete a namespace by using the {product-title} web console.
1515
1616
.Procedure
1717

18-
. Navigate to *Administration* → *Namespaces*.
19-
. Locate the `openshift-sandboxed-containers-operator` namespace to delete in the list of namespaces.
20-
. On the rightmost side of the namespace listing, select *Delete Namespace* from the *Options* menu .
21-
. When the *Delete Namespace* pane opens, enter `openshift-sandboxed-containers-operator` in the field.
18+
. From the *Administrator* perspective, navigate to *Administration* → *Namespaces*.
19+
. Search for the `openshift-sandboxed-containers-operator` namespace using the *Search by name* field.
20+
. Click the *Options* menu {kebab} for the namespace and select *Delete Namespace*.
2221
+
2322
[NOTE]
2423
====
2524
If the *Delete Namespace* option is not available, you do not have permission to delete the namespace.
2625
====
26+
. In the *Delete Namespace* pane, enter `openshift-sandboxed-containers-operator` and click *Delete*.
2727
. Click *Delete*.

‎modules/sandboxed-containers-deleting-operator-cli.adoc

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *uninstalling-sandboxed-containers.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="sandboxed-containers-deleting-operator-cli_{context}"]
7+
= Deleting the {sandboxed-containers-operator} using the CLI
8+
9+
Remove the {sandboxed-containers-operator} from your cluster by deleting the Operator subscription, Operator group, cluster service version (CSV), and namespace.
10+
11+
.Prerequisites
12+
13+
* You have {product-title} 4.10 installed on your cluster.
14+
* You have installed the OpenShift CLI (`oc`).
15+
* You have installed the comand-line JSON processor (`jq`).
16+
* You have access to the cluster as a user with the `cluster-admin` role.
17+
18+
.Procedure
19+
20+
. Fetch the cluster service version (CSV) name for {sandboxed-containers-first} from the subscription by running the following command:
21+
+
22+
[source,terminal]
23+
----
24+
CSV_NAME=$(oc get csv -n openshift-sandboxed-containers-operator -o=custom-columns=:metadata.name)
25+
----
26+
27+
. Delete the {sandboxed-containers-operator} subscription from Operator Lifecyle Manager (OLM) by running the following command:
28+
+
29+
[source,terminal]
30+
----
31+
$ oc delete subscription sandboxed-containers-operator -n openshift-sandboxed-containers-operator
32+
----
33+
34+
. Delete the CSV name for {sandboxed-containers-first} by running the following command:
35+
+
36+
[source, terminal]
37+
----
38+
$ oc delete csv ${CSV_NAME} -n openshift-sandboxed-containers-operator
39+
----
40+
41+
. Fetch the {sandboxed-containers-first} Operator group name by running the following command:
42+
+
43+
[source, terminal]
44+
----
45+
$ OG_NAME=$(oc get operatorgroup -n openshift-sandboxed-containers-operator -o=jsonpath={..name})
46+
----
47+
48+
. Delete the {sandboxed-containers-first} Operator group name by running the following command:
49+
+
50+
[source, terminal]
51+
----
52+
$ oc delete operatorgroup ${OG_NAME} -n openshift-sandboxed-containers-operator
53+
----
54+
55+
. Delete the {sandboxed-containers-first} namespace by running the following command:
56+
+
57+
[source, terminal]
58+
----
59+
$ oc delete namespace openshift-sandboxed-containers-operator
60+
----

‎modules/sandboxed-containers-deleting-operator-deployment-cr.adoc

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎modules/sandboxed-containers-deleting-operator-web-console.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_content-type: PROCEDURE
66
[id="sandboxed-containers-deleting-operator-web-console_{context}"]
7-
= Deleting {sandboxed-containers-operator}
7+
= Deleting the {sandboxed-containers-operator} using the web console
88

9-
You can delete the {sandboxed-containers-operator} by deleting the catalog subscription and revoking namespace access to the Operator.
9+
Deleting the {sandboxed-containers-operator} removes the catalog subscription, Operator group, and cluster service version (CSV) for that Operator.
1010

1111
.Prerequisites
1212

@@ -15,7 +15,7 @@ You can delete the {sandboxed-containers-operator} by deleting the catalog subsc
1515
1616
.Procedure
1717

18-
. Navigate to the *Operators* → *OperatorHub* page.
19-
. Search for `{sandboxed-containers-first}` and then select the Operator.
20-
. Click *Uninstall*.
21-
. Delete the `openshift-sandboxed-containers-operator` namespace.
18+
. From the *Administrator* perspective, navigate to *Operators* → *Installed Operators*.
19+
. Search for the {sandboxed-containers-operator} using the *Search by name* field.
20+
. Click the *Options* menu {kebab} for the Operator and select *Uninstall Operator*.
21+
. Click *Uninstall* in the confirmation window.

‎modules/sandboxed-containers-deleting-operator.adoc

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎modules/sandboxed-containers-deleting-pods-cli.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *uninstalling-sandboxed-containers.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="sandboxed-containers-deleting-pods-cli_{context}"]
7+
= Deleting {sandboxed-containers-first} pods using the CLI
8+
9+
To uninstall {sandboxed-containers-first}, you must first delete all running pods that use `kata` as the `runtimeClass`.
10+
11+
.Prerequisites
12+
13+
* You have installed the OpenShift CLI (`oc`).
14+
* You have the command-line JSON processor (`jq`) installed.
15+
16+
.Procedure
17+
18+
. Search for pods that use `kata` as the `runtimeClass` by running the following command:
19+
+
20+
[source,terminal]
21+
----
22+
$ oc get pods -A -o json | jq -r '.items[] | select(.spec.runtimeClassName == "kata").metadata.name'
23+
----
24+
. To delete each pod, run the following command:
25+
+
26+
[source,terminal]
27+
----
28+
$ oc delete pod <pod-name>
29+
----

‎modules/sandboxed-containers-deleting-pods-web-console.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *uninstalling-sandboxed-containers.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="sandboxed-containers-deleting-pods-web-console_{context}"]
7+
= Deleting {sandboxed-containers-first} pods using the web console
8+
9+
To uninstall {sandboxed-containers-first}, you must first delete all running pods that use `kata` as the `runtimeClass`.
10+
11+
.Prerequisites
12+
13+
* You have {product-title} {product-version} installed on your cluster.
14+
* You have access to the cluster as a user with the `cluster-admin` role.
15+
* You have a list of the pods that use `kata` as the `runtimeClass`.
16+
17+
.Procedure
18+
19+
. From the *Administrator* perspective, navigate to *Workloads* → *Pods*.
20+
. Search for the pod that you want to delete using the *Search by name* field.
21+
. Click the pod name to open it.
22+
. On the *Details* page, check that `kata` is displayed for *Runtime class*.
23+
. Click the *Actions* menu and select *Delete Pod*.
24+
. Click *Delete* in the confirmation window.

0 commit comments

Comments
 (0)