Skip to content

Commit 6388ef7

Browse files
sagidlowsagidlow
authored
Merge pull request #32926 from sagidlow/sandboxed-containers-uninstall
OSDOCS-2218: Uninstalling section, migrating docs from Google Docs to GitHub
2 parents b193808 + dcbc645 commit 6388ef7

9 files changed

+199
-30
lines changed

‎_topic_map.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1767,8 +1767,8 @@ Topics:
17671767
File: understanding-sandboxed-containers
17681768
- Name: Deploying OpenShift sandboxed containers workloads
17691769
File: deploying-sandboxed-container-workloads
1770-
- Name: Disabling OpenShift sandboxed container workloads
1771-
File: disabling-sandboxed-container-workloads
1770+
- Name: Uninstalling OpenShift sandboxed containers workloads
1771+
File: uninstalling-sandboxed-containers
17721772
- Name: Upgrade OpenShift sandboxed containers
17731773
File: upgrade-sandboxed-containers
17741774
---

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *uninstalling-sandboxed-containers.adoc
4+
5+
[id="sandboxed-containers-deleting-namespace-web-console_{context}"]
6+
= Deleting a namespace using the web console
7+
8+
You can delete a namespace by using the {product-title} web console.
9+
10+
.Prerequisites
11+
12+
* You have {product-title} {product-version} installed on your cluster.
13+
* You have access to the cluster as a user with the `cluster-admin` role.
14+
15+
.Procedure
16+
17+
. Navigate to *Administration* → *Namespaces*.
18+
. Locate the `openshift-sandboxed-containers-operator` namespace to delete in the list of namespaces.
19+
. On the rightmost side of the namespace listing, select *Delete Namespace* from the *Options* menu .
20+
. When the *Delete Namespace* pane opens, enter `openshift-sandboxed-containers-operator` in the field.
21+
+
22+
[NOTE]
23+
====
24+
If the *Delete Namespace* option is not available, you do not have permission to delete the namespace.
25+
====
26+
. Click *Delete*.

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *uninstalling-sandboxed-containers.adoc
4+
5+
[id="sandboxed-containers-deleting-operator-deployment-cr_{context}"]
6+
= Deleting {sandboxed-containers-first} resources
7+
8+
To uninstall {sandboxed-containers-first}, you must first delete the {sandboxed-containers-first} custom resource `KataConfig`. This removes and uninstalls the `kata` runtime and its related resources from your cluster.
9+
10+
.Prerequisites
11+
12+
* You have {product-title} {product-version} installed on your cluster.
13+
* You have access to the cluster as a user with the `cluster-admin` role.
14+
* You have no running pods that use `kata` as the `runtimeClassName`.
15+
** You have installed the OpenShift CLI (`oc`).
16+
** You the command-line JSON processor (`jq`) installed.
17+
** Verify that you have no running pods that use `kata` as the `runtimeClassName` by running the following command:
18+
+
19+
[source,terminal]
20+
----
21+
$ oc get pods -A -o json | jq -r '.items[] | select(.spec.runtimeClassName | test("kata")).metadata.name'
22+
----
23+
24+
.Procedure
25+
26+
. Delete all pods that use `runtimeClassName` with the value of `kata`.
27+
. From the {product-title} web console, select `openshift-sandboxed-containers` from the *Projects* list.
28+
. Navigate to the *Operators* → *Installed Operators* page.
29+
. Click *{sandboxed-containers-first}*.
30+
. Click the *{sandboxed-containers-operator}* tab.
31+
. Click the scroll-down list in the *Operator Details*, and then click *Delete `KataConfig`*.
32+
. Click *Delete* in the confirmation window.

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *uninstalling-sandboxed-containers.adoc
4+
5+
[id="sandboxed-containers-deleting-operator-web-console_{context}"]
6+
= Deleting {sandboxed-containers-operator}
7+
8+
You can delete the {sandboxed-containers-operator} by deleting the catalog subscription and revoking namespace access to the Operator.
9+
10+
.Prerequisites
11+
12+
* You have {product-title} {product-version} installed on your cluster.
13+
* You have access to the cluster as a user with the `cluster-admin` role.
14+
15+
.Procedure
16+
17+
. Navigate to the *Operators* → *OperatorHub* page.
18+
. Search for `{sandboxed-containers-first}` and then select the Operator.
19+
. Click *Uninstall*.
20+
. Delete the `openshift-sandboxed-containers-operator` namespace.

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *uninstalling-sandboxed-containers.adoc
4+
5+
[id="sandboxed-containers-deleting-operator_{context}"]
6+
= Deleting {sandboxed-containers-operator}
7+
8+
You can delete the {sandboxed-containers-operator} from your cluster.
9+
10+
.Prerequisites
11+
12+
* You have {product-title} {product-version} installed on your cluster.
13+
* You have installed the OpenShift CLI (`oc`).
14+
* You have access to the cluster as a user with the `cluster-admin` role.
15+
16+
.Procedure
17+
18+
. Delete the {sandboxed-containers-operator} subscription from Operator Lifecyle Manager (OLM) by running the following command:
19+
+
20+
[source,terminal]
21+
----
22+
$ oc delete subscription openshift-sandboxed-containers-subscription -n openshift-sandboxed-containers-operator
23+
----
24+
25+
. Set the cluster service version (CSV) name for {sandboxed-containers-first} as an environment variable by running the following command:
26+
+
27+
[source,terminal]
28+
----
29+
CSV_NAME=$(oc get csv -n openshift-sandboxed-containers-operator -o=custom-columns=:metadata.name)
30+
----
31+
32+
. Delete the CSV name for {sandboxed-containers-first} by running the following command:
33+
+
34+
[source, terminal]
35+
----
36+
$ oc delete csv ${CSV_NAME} -n openshift-sandboxed-containers-operator
37+
----

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *uninstalling-sandboxed-containers.adoc
4+
5+
[id="sandboxed-containers-deleting-resources_{context}"]
6+
= Deleting {sandboxed-containers-first} resources
7+
8+
You can remove and uninstall the `kata` runtime and all its related resources, such as CRI-O config and `RuntimeClass`, from your cluster.
9+
10+
.Prerequisites
11+
12+
* You have {product-title} {product-version} installed on your cluster.
13+
* You have installed the OpenShift CLI (`oc`).
14+
* You have access to the cluster as a user with the `cluster-admin` role.
15+
16+
.Procedure
17+
18+
. Delete the `KataConfig` custom resource by running the following command:
19+
+
20+
[source,terminal]
21+
----
22+
$ oc delete kataconfig <KataConfig_CR_Name>
23+
----
24+
25+
. Delete the `KataConfig` custom resource definition by running the following command:
26+
+
27+
[source,terminal]
28+
----
29+
$ oc delete crd kataconfigs.kataconfiguration.openshift.io
30+
----
31+
32+
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+
34+
.Verification
35+
36+
* To verify that the `KataConfig` custom resource is deleted, run the following command:
37+
+
38+
[source,terminal]
39+
----
40+
$ oc get kataconfig <KataConfig_CR_Name>
41+
----
42+
+
43+
.Example output
44+
+
45+
[source,terminal]
46+
----
47+
No KataConfig instances exist
48+
----
49+
50+
* To verify that the `KataConfig` custom resource definition is deleted, run the following command:
51+
+
52+
[source,terminal]
53+
----
54+
$ oc get crd kataconfigs.kataconfiguration.openshift.io
55+
----
56+
+
57+
.Example output
58+
+
59+
[source,terminal]
60+
----
61+
Unknown CR KataConfig
62+
----

‎modules/sandboxed-containers-uninstalling-kata-runtime.adoc‎

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

‎sandboxed_containers/disabling-sandboxed-container-workloads.adoc‎

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

‎sandboxed_containers/uninstalling-sandboxed-containers.adoc‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[id="uninstalling-sandboxed-containers"]
2+
= Uninstalling {sandboxed-containers-first}
3+
include::modules/common-attributes.adoc[]
4+
:context: uninstalling-sandboxed-containers
5+
6+
toc::[]
7+
8+
== Uninstalling OpenShift sandboxed containers using the web console
9+
You can uninstall {sandboxed-containers-first} by using the {product-title} web console.
10+
11+
include::modules/sandboxed-containers-deleting-operator-deployment-cr.adoc[leveloffset=+2]
12+
include::modules/sandboxed-containers-deleting-namespace-web-console.adoc[leveloffset=+3]
13+
include::modules/sandboxed-containers-deleting-operator-web-console.adoc[leveloffset=+2]
14+
15+
== Uninstalling Kata runtime from the CLI
16+
17+
You can uninstall OpenShift sandboxed containers by using the {product-title} xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[command-line interface (CLI)].
18+
19+
include::modules/sandboxed-containers-deleting-resources.adoc[leveloffset=+2]
20+
include::modules/sandboxed-containers-deleting-operator.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)