Skip to content

Commit 79842e4

Browse files
committed
RHDEVDOCS-3181 Instructions for updating to OpenShift Logging 5.1
1 parent 59744a8 commit 79842e4

7 files changed

+266
-58
lines changed

logging/cluster-logging-release-notes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
[id="cluster-logging-release-notes"]
22
= Release notes for Red Hat OpenShift Logging
3-
include::modules/cluster-logging-document-attributes.adoc[]
3+
include::modules/common-attributes.adoc[]
44
:context: cluster-logging-release-notes-v5x
55

66
toc::[]
77

88
[id="openshift-logging-about-this-release"]
99
== About this release
1010

11-
The following advisories are available for {ProductName}:
11+
The following advisories are available for Red Hat OpenShift Logging:
1212

1313
* link:https://access.redhat.com/errata/RHBA-2021:2112[RHBA-2021:2112 - Bug Fix Advisory. OpenShift Logging Bug Fix Release 5.1.0]
1414
//* link:https://access.redhat.com/errata/RHBA-2021:2655[RHBA-2021:2655 - Bug Fix Advisory. Openshift Logging Bug Fix Release (5.0.6)]

logging/cluster-logging-upgrading.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,19 @@ include::modules/common-attributes.adoc[]
55

66
toc::[]
77

8+
{product-title} versions 4.7 and 4.8 both support OpenShift Logging versions 5.0 and 5.1.
89

10+
To upgrade from cluster logging in {product-title} version 4.6 and earlier to OpenShift Logging 5.x, you update the {product-title} cluster to version 4.7 or 4.8. Then, you update the following operators:
911

10-
After updating the {product-title} cluster from 4.6 to 4.7, you can update the OpenShift Elasticsearch Operator and Cluster Logging Operator from 4.6 to 5.0.
12+
* From Elasticsearch Operator 4.x to OpenShift Elasticsearch Operator 5.x
13+
* From Cluster Logging Operator 4.x to Red Hat OpenShift Logging Operator 5.x
1114
12-
[NOTE]
13-
====
14-
In OpenShift Logging 5.0 and later, the Cluster Logging Operator is called Red Hat OpenShift Logging Operator.
15-
====
15+
To upgrade from a previous version of OpenShift Logging to the current version, you update OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator to their current versions.
1616

1717
// The following include statements pull in the module files that comprise
1818
// the assembly. Include any combination of concept, procedure, or reference
1919
// modules required to cover the user story. You can also include other
2020
// assemblies.
2121

22-
include::modules/cluster-logging-updating-logging.adoc[leveloffset=+1]
22+
include::modules/cluster-logging-updating-logging-to-5-0.adoc[leveloffset=+1]
23+
include::modules/cluster-logging-updating-logging-to-5-1.adoc[leveloffset=+1]

logging/troubleshooting/cluster-logging-troubleshooting-for-critical-alerts.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ At least one primary shard and its replicas are not allocated to a node.
1919
+
2020
[source,terminal]
2121
----
22-
oc exec -n openshift-logging -c elasticsearch <elasticsearch_pod_name> -- es_cluster_health
22+
oc exec -n openshift-logging -c elasticsearch <elasticsearch_pod_name> -- health
2323
----
2424

2525
. List the nodes that have joined the cluster.
@@ -72,7 +72,7 @@ If there is no command output, the recovery process might be delayed or stalled
7272
+
7373
[source,terminal]
7474
----
75-
oc exec -n openshift-logging -c elasticsearch <elasticsearch_pod_name> -- es_cluster_health |grep number_of_pending_tasks
75+
oc exec -n openshift-logging -c elasticsearch <elasticsearch_pod_name> -- health |grep number_of_pending_tasks
7676
----
7777

7878
. If there are pending tasks, monitor their status.

modules/cluster-logging-deploy-cli.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,14 @@ metadata:
139139
name: "elasticsearch-operator"
140140
namespace: "openshift-operators-redhat" <1>
141141
spec:
142-
channel: "5.0" <2>
142+
channel: "stable-5.1" <2>
143143
installPlanApproval: "Automatic"
144144
source: "redhat-operators" <3>
145145
sourceNamespace: "openshift-marketplace"
146146
name: "elasticsearch-operator"
147147
----
148148
<1> You must specify the `openshift-operators-redhat` Namespace.
149-
<2> Specify `5.0` or `stable` as the channel. `stable` is the latest 5.x released code.
149+
<2> Specify `5.0` or `stable-5.<x>` as the channel. `stable-5.<x>` is the latest released code for the version number you specify with `x`.
150150
<3> Specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster,
151151
specify the name of the CatalogSource object created when you configured the Operator Lifecycle Manager (OLM).
152152

@@ -177,14 +177,14 @@ $ oc get csv --all-namespaces
177177
[source,terminal]
178178
----
179179
NAMESPACE NAME DISPLAY VERSION REPLACES PHASE
180-
default elasticsearch-operator.5.0.0-202007012112.p0 OpenShift Elasticsearch Operator 5.0.0-202007012112.p0 Succeeded
181-
kube-node-lease elasticsearch-operator.5.0.0-202007012112.p0 OpenShift Elasticsearch Operator 5.0.0-202007012112.p0 Succeeded
182-
kube-public elasticsearch-operator.5.0.0-202007012112.p0 OpenShift Elasticsearch Operator 5.0.0-202007012112.p0 Succeeded
183-
kube-system elasticsearch-operator.5.0.0-202007012112.p0 OpenShift Elasticsearch Operator 5.0.0-202007012112.p0 Succeeded
184-
openshift-apiserver-operator elasticsearch-operator.5.0.0-202007012112.p0 OpenShift Elasticsearch Operator 5.0.0-202007012112.p0 Succeeded
185-
openshift-apiserver elasticsearch-operator.5.0.0-202007012112.p0 OpenShift Elasticsearch Operator 5.0.0-202007012112.p0 Succeeded
186-
openshift-authentication-operator elasticsearch-operator.5.0.0-202007012112.p0 OpenShift Elasticsearch Operator 5.0.0-202007012112.p0 Succeeded
187-
openshift-authentication elasticsearch-operator.5.0.0-202007012112.p0 OpenShift Elasticsearch Operator 5.0.0-202007012112.p0 Succeeded
180+
default elasticsearch-operator.5.1.0-202007012112.p0 OpenShift Elasticsearch Operator 5.1.0-202007012112.p0 Succeeded
181+
kube-node-lease elasticsearch-operator.5.1.0-202007012112.p0 OpenShift Elasticsearch Operator 5.1.0-202007012112.p0 Succeeded
182+
kube-public elasticsearch-operator.5.1.0-202007012112.p0 OpenShift Elasticsearch Operator 5.1.0-202007012112.p0 Succeeded
183+
kube-system elasticsearch-operator.5.1.0-202007012112.p0 OpenShift Elasticsearch Operator 5.1.0-202007012112.p0 Succeeded
184+
openshift-apiserver-operator elasticsearch-operator.5.1.0-202007012112.p0 OpenShift Elasticsearch Operator 5.1.0-202007012112.p0 Succeeded
185+
openshift-apiserver elasticsearch-operator.5.1.0-202007012112.p0 OpenShift Elasticsearch Operator 5.1.0-202007012112.p0 Succeeded
186+
openshift-authentication-operator elasticsearch-operator.5.1.0-202007012112.p0 OpenShift Elasticsearch Operator 5.1.0-202007012112.p0 Succeeded
187+
openshift-authentication elasticsearch-operator.5.1.0-202007012112.p0 OpenShift Elasticsearch Operator 5.1.0-202007012112.p0 Succeeded
188188
...
189189
----
190190
+
@@ -232,13 +232,13 @@ metadata:
232232
name: cluster-logging
233233
namespace: openshift-logging <1>
234234
spec:
235-
channel: "5.0" <2>
235+
channel: "stable-5.1" <2>
236236
name: cluster-logging
237237
source: redhat-operators <3>
238238
sourceNamespace: openshift-marketplace
239239
----
240240
<1> You must specify the `openshift-logging` Namespace.
241-
<2> Specify `5.0` or `stable` as the channel. `stable` is the latest 5.x released code.
241+
<2> Specify `5.0` or `stable-5.<x>` as the channel. `stable-5.<x>` is the latest released code for the version number you specify with `x`.
242242
<3> Specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the CatalogSource object you created when you configured the Operator Lifecycle Manager (OLM).
243243
+
244244
[source,terminal]
@@ -269,7 +269,7 @@ $ oc get csv -n openshift-logging
269269
----
270270
NAMESPACE NAME DISPLAY VERSION REPLACES PHASE
271271
...
272-
openshift-logging clusterlogging.5.0.0-202007012112.p0 OpenShift Logging 5.0.0-202007012112.p0 Succeeded
272+
openshift-logging clusterlogging.5.1.0-202007012112.p0 OpenShift Logging 5.1.0-202007012112.p0 Succeeded
273273
...
274274
----
275275

modules/cluster-logging-deploy-console.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This option sets the `openshift.io/cluster-monitoring: "true"` label in the Name
5050
You must select this option to ensure that cluster monitoring
5151
scrapes the `openshift-operators-redhat` namespace.
5252

53-
.. Select *5.0* as the *Update Channel*.
53+
.. Select *stable-5.x* as the *Update Channel*.
5454

5555
.. Select an *Approval Strategy*.
5656
+
@@ -80,7 +80,7 @@ This option sets the `openshift.io/cluster-monitoring: "true"` label in the Name
8080
You must select this option to ensure that cluster monitoring
8181
scrapes the `openshift-logging` namespace.
8282

83-
.. Select *5.0* as the *Update Channel*.
83+
.. Select *stable-5.x* as the *Update Channel*.
8484

8585
.. Select an *Approval Strategy*.
8686
+

modules/cluster-logging-updating-logging.adoc renamed to modules/cluster-logging-updating-logging-to-5-0.adoc

Lines changed: 23 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,33 @@
1-
// Module included in the following assemblies:
2-
//
3-
// * logging/cluster-logging-upgrading.adoc
1+
[id="cluster-logging-updating-logging-to-5-0_{context}"]
2+
= Updating from cluster logging in {product-title} 4.6 or earlier to OpenShift Logging 5.x
43

5-
[id="cluster-logging-updating-logging_{context}"]
6-
= Updating OpenShift Logging
4+
{product-title} 4.7 made the following name changes:
75

8-
After updating the {product-title} cluster, you can update from cluster logging 4.6 to Red Hat OpenShift Logging 5.0 by changing the subscription for the OpenShift Elasticsearch Operator and the Cluster Logging Operator.
6+
* The _cluster logging_ feature became the _Red Hat OpenShift Logging_ 5.x product.
7+
* The _Cluster Logging_ Operator became the _Red Hat OpenShift Logging_ Operator.
8+
* The _Elasticsearch_ Operator became _OpenShift Elasticsearch_ Operator.
99

10-
[NOTE]
11-
====
12-
In OpenShift Logging 5.0 and later, the Cluster Logging Operator is called Red Hat OpenShift Logging Operator.
13-
====
10+
To upgrade from cluster logging in {product-title} version 4.6 and earlier to OpenShift Logging 5.x, you update the {product-title} cluster to version 4.7 or 4.8. Then, you update the following operators:
1411

15-
When you update:
16-
17-
* You must update the OpenShift Elasticsearch Operator before updating the Cluster Logging Operator.
18-
* You must update both the OpenShift Elasticsearch Operator and the Cluster Logging Operator.
19-
+
20-
Kibana is unusable when the OpenShift Elasticsearch Operator has been updated but the Cluster Logging Operator has not been updated.
21-
+
22-
If you update the Cluster Logging Operator before the OpenShift Elasticsearch Operator, Kibana does not update and the Kibana custom resource (CR) is not created. To work around this problem, delete the Cluster Logging Operator pod. When the Cluster Logging Operator pod redeploys, the Kibana CR is created.
12+
* From Elasticsearch Operator 4.x to OpenShift Elasticsearch Operator 5.x
13+
* From Cluster Logging Operator 4.x to Red Hat OpenShift Logging Operator 5.x
2314

2415
[IMPORTANT]
2516
====
26-
Upgrade your cluster logging version to 4.6 before updating to Red Hat OpenShift Logging 5.0.
17+
You must update the OpenShift Elasticsearch Operator _before_ you update the Red Hat OpenShift Logging Operator. You must also update _both_ Operators to the same version.
2718
====
2819

20+
If you update the operators in the wrong order, Kibana does not update and the Kibana custom resource (CR) is not created. To work around this problem, you 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.
21+
2922
.Prerequisites
3023

31-
* Update the {product-title} cluster from 4.6 to 4.7.
24+
* The {product-title} version is 4.7 or later.
3225

33-
* Make sure the OpenShift Logging status is healthy:
34-
+
26+
* The OpenShift Logging status is healthy:
3527
** All pods are `ready`.
3628
** The Elasticsearch cluster is healthy.
3729

38-
* Back up your Elasticsearch and Kibana data.
30+
* Your Elasticsearch and Kibana data is backed up.
3931

4032
.Procedure
4133

@@ -49,11 +41,11 @@ Upgrade your cluster logging version to 4.6 before updating to Red Hat OpenShift
4941

5042
.. Click *Subscription* -> *Channel*.
5143

52-
.. In the *Change Subscription Update Channel* window, select *5.0* and click *Save*.
44+
.. In the *Change Subscription Update Channel* window, select *5.0* or *stable-5.1* and click *Save*.
5345

5446
.. Wait for a few seconds, then click *Operators* -> *Installed Operators*.
5547
+
56-
Verify that the OpenShift Elasticsearch Operator version is 5.0.x.
48+
Verify that the OpenShift Elasticsearch Operator version is 5.x.x.
5749
+
5850
Wait for the *Status* field to report *Succeeded*.
5951

@@ -67,11 +59,11 @@ Wait for the *Status* field to report *Succeeded*.
6759

6860
.. Click *Subscription* -> *Channel*.
6961

70-
.. In the *Change Subscription Update Channel* window, select *5.0* and click *Save*.
62+
.. In the *Change Subscription Update Channel* window, select *5.0* or *stable-5.1* and click *Save*.
7163

7264
.. Wait for a few seconds, then click *Operators* -> *Installed Operators*.
7365
+
74-
Verify that the Red Hat OpenShift Logging Operator version is 5.0.x.
66+
Verify that the Red Hat OpenShift Logging Operator version is 5.0.x or 5.1.x.
7567
+
7668
Wait for the *Status* field to report *Succeeded*.
7769

@@ -97,7 +89,7 @@ elasticsearch-cdm-1pbrl44l-3-88df5d47-m45jc 2/2 Running 0 29m
9789
+
9890
[source,terminal]
9991
----
100-
$ oc exec -n openshift-logging -c elasticsearch elasticsearch-cdm-1pbrl44l-1-55b7546f4c-mshhk -- es_cluster_health
92+
$ oc exec -n openshift-logging -c elasticsearch elasticsearch-cdm-1pbrl44l-1-55b7546f4c-mshhk -- health
10193
----
10294
+
10395
[source,json]
@@ -106,7 +98,6 @@ $ oc exec -n openshift-logging -c elasticsearch elasticsearch-cdm-1pbrl44l-1-55b
10698
"cluster_name" : "elasticsearch",
10799
"status" : "green",
108100
}
109-
...
110101
----
111102

112103
.. Ensure that the Elasticsearch cron jobs are created:
@@ -124,13 +115,12 @@ $ oc get cronjob
124115
[source,terminal]
125116
----
126117
NAME SCHEDULE SUSPEND ACTIVE LAST SCHEDULE AGE
127-
curator 30 3,9,15,21 * * * False 0 <none> 20s
128118
elasticsearch-im-app */15 * * * * False 0 <none> 56s
129119
elasticsearch-im-audit */15 * * * * False 0 <none> 56s
130120
elasticsearch-im-infra */15 * * * * False 0 <none> 56s
131121
----
132122

133-
.. Verify that the log store is updated to 5.0 and the indices are `green`:
123+
.. Verify that the log store is updated to 5.0 or 5.1 and the indices are `green`:
134124
+
135125
[source,terminal]
136126
----
@@ -172,7 +162,7 @@ green open audit-000001
172162
----
173163
====
174164

175-
.. Verify that the log collector is updated to 5.0:
165+
.. Verify that the log collector is updated to 5.0 or 5.1:
176166
+
177167
[source,terminal]
178168
----
@@ -186,7 +176,7 @@ Verify that the output includes a `fluentd-init` container:
186176
"containerName": "fluentd-init"
187177
----
188178

189-
.. Verify that the log visualizer is updated to 5.0 using the Kibana CRD:
179+
.. Verify that the log visualizer is updated to 5.0 or 5.1 using the Kibana CRD:
190180
+
191181
[source,terminal]
192182
----

0 commit comments

Comments
 (0)