Skip to content

Commit 17817dd

Browse files
authored
Merge pull request #69680 from abrennan89/OBSDOCS603
OBSDOCS-603: Update attributes in upgrading docs
2 parents 25430eb + 8294994 commit 17817dd

5 files changed

+18
-18
lines changed

logging/cluster-logging-upgrading.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:_mod-docs-content-type: ASSEMBLY
22
:context: cluster-logging-upgrading
3+
include::_attributes/common-attributes.adoc[]
34
[id="cluster-logging-upgrading"]
45
= Updating Logging
5-
include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

modules/cluster-logging-upgrading-elasticsearch.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33

44
:_mod-docs-content-type: PROCEDURE
55
[id="cluster-logging-upgrading-elasticsearch_{context}"]
6-
= Updating the OpenShift Elasticsearch Operator
6+
= Updating the {es-op}
77

8-
To update the OpenShift Elasticsearch Operator to the current version, you must modify the subscription.
8+
To update the {es-op} to the current version, you must modify the subscription.
99

1010
include::snippets/logging-elastic-dep-snip.adoc[]
1111

1212
.Prerequisites
1313

14-
* If you are using Elasticsearch as the default log store, and Kibana as the UI, update the OpenShift Elasticsearch Operator before you update the Cluster Logging Operator.
14+
* If you are using Elasticsearch as the default log store, and Kibana as the UI, update the {es-op} before you update the {clo}.
1515
+
1616
[IMPORTANT]
1717
====
18-
If you update the Operators in the wrong order, Kibana does not update and the Kibana custom resource (CR) is not created. To fix this issue, delete the Red Hat OpenShift Logging Operator pod. When the Red Hat OpenShift Logging Operator pod redeploys, it creates the Kibana CR and Kibana becomes available again.
18+
If you update the Operators in the wrong order, Kibana does not update and the Kibana custom resource (CR) is not created. To fix this issue, delete the {clo} pod. When the {clo} pod redeploys, it creates the Kibana CR and Kibana becomes available again.
1919
====
2020
2121
* The Logging status is healthy:
@@ -43,7 +43,7 @@ endif::[]
4343

4444
. In the *Change Subscription Update Channel* window, select *stable-5.y* and click *Save*. Note the `elasticsearch-operator.v5.y.z` version.
4545

46-
. Wait for a few seconds, then click *Operators* -> *Installed Operators*. Verify that the OpenShift Elasticsearch Operator version matches the latest `elasticsearch-operator.v5.y.z` version.
46+
. Wait for a few seconds, then click *Operators* -> *Installed Operators*. Verify that the {es-op} version matches the latest `elasticsearch-operator.v5.y.z` version.
4747

4848
. On the *Operators* -> *Installed Operators* page, wait for the *Status* field to report *Succeeded*.
4949

modules/logging-operator-upgrading-all-ns.adoc

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

55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-operator-upgrading-all-ns_{context}"]
7-
= Upgrading the Cluster Logging Operator to watch all namespaces
7+
= Upgrading the {clo} to watch all namespaces
88

9-
In logging 5.7 and older versions, the Cluster Logging Operator only watches the `openshift-logging` namespace.
10-
If you want the Cluster Logging Operator to watch all namespaces on your cluster, you must redeploy the Operator. You can complete the following procedure to redeploy the Operator without deleting your logging components.
9+
In logging 5.7 and older versions, the {clo} only watches the `openshift-logging` namespace.
10+
If you want the {clo} to watch all namespaces on your cluster, you must redeploy the Operator. You can complete the following procedure to redeploy the Operator without deleting your logging components.
1111

1212
.Prerequisites
1313

@@ -37,7 +37,7 @@ $ oc -n openshift-logging delete operatorgroup <operator_group_name>
3737
$ oc delete clusterserviceversion cluster-logging.<version>
3838
----
3939

40-
. Redeploy the Cluster Logging Operator by following the "Installing Logging" documentation.
40+
. Redeploy the {clo} by following the "Installing Logging" documentation.
4141

4242
.Verification
4343

modules/logging-upgrading-clo.adoc

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

55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-upgrading-clo_{context}"]
7-
= Updating the Cluster Logging Operator
7+
= Updating the {clo}
88

9-
To update the Cluster Logging Operator to a new major release version, you must modify the update channel for the Operator subscription.
9+
To update the {clo} to a new major release version, you must modify the update channel for the Operator subscription.
1010

1111
.Prerequisites
1212

13-
* You have installed the Red Hat OpenShift Logging Operator.
13+
* You have installed the {clo}.
1414
* You have administrator permissions.
1515
* You have access to the {product-title} web console and are viewing the *Administrator* perspective.
1616
@@ -28,6 +28,6 @@ To update the Cluster Logging Operator to a new major release version, you must
2828

2929
.Verification
3030

31-
. Wait for a few seconds, then click *Operators* -> *Installed Operators*. Verify that the Red Hat OpenShift Logging Operator version matches the latest `cluster-logging.v5.y.z` version.
31+
. Wait for a few seconds, then click *Operators* -> *Installed Operators*. Verify that the {clo} version matches the latest `cluster-logging.v5.y.z` version.
3232

3333
. On the *Operators* -> *Installed Operators* page, wait for the *Status* field to report *Succeeded*.

modules/logging-upgrading-loki.adoc

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

55
:_mod-docs-content-type: PROCEDURE
66
[id="logging-upgrading-loki_{context}"]
7-
= Updating the Loki Operator
7+
= Updating the {loki-op}
88

9-
To update the Loki Operator to a new major release version, you must modify the update channel for the Operator subscription.
9+
To update the {loki-op} to a new major release version, you must modify the update channel for the Operator subscription.
1010

1111
.Prerequisites
1212

13-
* You have installed the Loki Operator.
13+
* You have installed the {loki-op}.
1414
* You have administrator permissions.
1515
* You have access to the {product-title} web console and are viewing the *Administrator* perspective.
1616
@@ -28,6 +28,6 @@ To update the Loki Operator to a new major release version, you must modify the
2828

2929
.Verification
3030

31-
. Wait for a few seconds, then click *Operators* -> *Installed Operators*. Verify that the Loki Operator version matches the latest `loki-operator.v5.y.z` version.
31+
. Wait for a few seconds, then click *Operators* -> *Installed Operators*. Verify that the {loki-op} version matches the latest `loki-operator.v5.y.z` version.
3232

3333
. On the *Operators* -> *Installed Operators* page, wait for the *Status* field to report *Succeeded*.

0 commit comments

Comments
 (0)