Skip to content

Commit 793bd21

Browse files
abrennan89abrennan89
authored
Merge pull request #69255 from abrennan89/OBSDOCS-462
OBSDOCS-462: Update logging uninstall docs
2 parents 650bfbf + 4694bc0 commit 793bd21

6 files changed

+157
-89
lines changed

‎logging/cluster-logging-uninstall.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
You can remove the {logging} from your {product-title} cluster.
9+
You can remove the {logging} from your {product-title} cluster by removing installed Operators and related custom resources (CRs).
1010

11-
include::modules/cluster-logging-uninstall.adoc[leveloffset=+1]
12-
13-
//Generic deleting operators from cluster using web console
14-
include::modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc[leveloffset=+1]
11+
include::modules/uninstall-cluster-logging-operator.adoc[leveloffset=+1]
12+
include::modules/uninstall-logging-delete-pvcs.adoc[leveloffset=+1]
13+
include::modules/uninstall-loki-operator.adoc[leveloffset=+1]
14+
include::modules/uninstall-es-operator.adoc[leveloffset=+1]
1515

1616
//Generic deleting operators from a cluster using CLI
1717
include::modules/olm-deleting-operators-from-a-cluster-using-cli.adoc[leveloffset=+1]

‎modules/cluster-logging-uninstall.adoc

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

‎modules/uninstall-cluster-logging-operator.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging-uninstall.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="uninstall-cluster-logging-operator_{context}"]
7+
= Uninstalling the {logging}
8+
9+
You can stop aggregating logs by deleting the {clo} and the `ClusterLogging` custom resource (CR).
10+
11+
.Prerequisites
12+
13+
* You have administrator permissions.
14+
* You have access to the *Administrator* perspective of the {product-title} web console.
15+
16+
.Procedure
17+
18+
. Go to the *Administration* -> *Custom Resource Definitions* page, and click *ClusterLogging*.
19+
20+
. On the *Custom Resource Definition Details* page, click *Instances*.
21+
22+
. Click the options menu {kebab} next to the instance, and click *Delete ClusterLogging*.
23+
24+
. Go to the *Administration* -> *Custom Resource Definitions* page.
25+
26+
. Click the options menu {kebab} next to *ClusterLogging*, and select *Delete Custom Resource Definition*.
27+
+
28+
[WARNING]
29+
====
30+
Deleting the `ClusterLogging` CR does not remove the persistent volume claims (PVCs). To delete the remaining PVCs, persistent volumes (PVs), and associated data, you must take further action. Releasing or deleting PVCs can delete PVs and cause data loss.
31+
====
32+
33+
. If you have created a `ClusterLogForwarder` CR, click the options menu {kebab} next to *ClusterLogForwarder*, and then click *Delete Custom Resource Definition*.
34+
35+
. Go to the *Operators* -> *Installed Operators* page.
36+
37+
. Click the options menu {kebab} next to the {clo}, and then click *Uninstall Operator*.
38+
39+
. Optional: Delete the `openshift-logging` project.
40+
+
41+
[WARNING]
42+
====
43+
Deleting the `openshift-logging` project deletes everything in that namespace, including any persistent volume claims (PVCs). If you want to preserve logging data, do not delete the `openshift-logging` project.
44+
====
45+
46+
.. Go to the *Home* -> *Projects* page.
47+
.. Click the options menu {kebab} next to the *openshift-logging* project, and then click *Delete Project*.
48+
.. Confirm the deletion by typing `openshift-logging` in the dialog box, and then click *Delete*.

‎modules/uninstall-es-operator.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging-uninstall.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="uninstall-es-operator_{context}"]
7+
= Uninstalling Elasticsearch
8+
9+
.Prerequisites
10+
11+
* You have administrator permissions.
12+
* You have access to the *Administrator* perspective of the {product-title} web console.
13+
* If you have not already removed the {clo} and related resources, you must remove references to Elasticsearch from the `ClusterLogging` custom resource.
14+
15+
.Procedure
16+
17+
. Go to the *Administration* -> *Custom Resource Definitions* page, and click *Elasticsearch*.
18+
19+
. On the *Custom Resource Definition Details* page, click *Instances*.
20+
21+
. Click the options menu {kebab} next to the instance, and then click *Delete Elasticsearch*.
22+
23+
. Go to the *Administration* -> *Custom Resource Definitions* page.
24+
25+
. Click the options menu {kebab} next to *Elasticsearch*, and select *Delete Custom Resource Definition*.
26+
27+
. Delete the object storage secret.
28+
29+
. Go to the *Operators* -> *Installed Operators* page.
30+
31+
. Click the options menu {kebab} next to the {es-op}, and then click *Uninstall Operator*.
32+
33+
. Optional: Delete the `openshift-operators-redhat` project.
34+
+
35+
[IMPORTANT]
36+
====
37+
Do not delete the `openshift-operators-redhat` project if other global Operators are installed in this namespace.
38+
====
39+
40+
.. Go to the *Home* -> *Projects* page.
41+
.. Click the options menu {kebab} next to the *openshift-operators-redhat* project, and then click *Delete Project*.
42+
.. Confirm the deletion by typing `openshift-operators-redhat` in the dialog box, and then click *Delete*.

‎modules/uninstall-logging-delete-pvcs.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+
// * logging/cluster-logging-uninstall.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="uninstall-logging-delete-pvcs_{context}"]
7+
= Deleting logging PVCs
8+
9+
To keep persistent volume claims (PVCs) for reuse with other pods, keep the labels or PVC names that you need to reclaim the PVCs.
10+
If you do not want to keep the PVCs, you can delete them. If you want to recover storage space, you can also delete the persistent volumes (PVs).
11+
12+
.Prerequisites
13+
14+
* You have administrator permissions.
15+
* You have access to the *Administrator* perspective of the {product-title} web console.
16+
17+
.Procedure
18+
19+
. Go to the *Storage* -> *Persistent Volume Claims* page.
20+
. Click the options menu {kebab} next to each PVC, and select *Delete Persistent Volume Claim*.

‎modules/uninstall-loki-operator.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging-uninstall.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="uninstall-loki-operator_{context}"]
7+
= Uninstalling Loki
8+
9+
.Prerequisites
10+
11+
* You have administrator permissions.
12+
* You have access to the *Administrator* perspective of the {product-title} web console.
13+
* If you have not already removed the {clo} and related resources, you have removed references to LokiStack from the `ClusterLogging` custom resource.
14+
15+
.Procedure
16+
17+
. Go to the *Administration* -> *Custom Resource Definitions* page, and click *LokiStack*.
18+
19+
. On the *Custom Resource Definition Details* page, click *Instances*.
20+
21+
. Click the options menu {kebab} next to the instance, and then click *Delete LokiStack*.
22+
23+
. Go to the *Administration* -> *Custom Resource Definitions* page.
24+
25+
. Click the options menu {kebab} next to *LokiStack*, and select *Delete Custom Resource Definition*.
26+
27+
. Delete the object storage secret.
28+
29+
. Go to the *Operators* -> *Installed Operators* page.
30+
31+
. Click the options menu {kebab} next to the {loki-op}, and then click *Uninstall Operator*.
32+
33+
. Optional: Delete the `openshift-operators-redhat` project.
34+
+
35+
[IMPORTANT]
36+
====
37+
Do not delete the `openshift-operators-redhat` project if other global Operators are installed in this namespace.
38+
====
39+
40+
.. Go to the *Home* -> *Projects* page.
41+
.. Click the options menu {kebab} next to the *openshift-operators-redhat* project, and then click *Delete Project*.
42+
.. Confirm the deletion by typing `openshift-operators-redhat` in the dialog box, and then click *Delete*.

0 commit comments

Comments
 (0)