Bug 2087056 - [DOCS] the procedures to verify upgrade of OpenShift Logging v5.3+ in docs are incorrect
Summary: [DOCS] the procedures to verify upgrade of OpenShift Logging v5.3+ in docs ar...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.10
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: ---
Assignee: Claire Bremble
QA Contact: Xiaoli Tian
Claire Bremble
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-05-17 08:29 UTC by Daein Park
Modified: 2022-10-25 04:23 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-10-25 04:23:15 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHDEVDOCS-4102 0 None None None 2022-05-17 17:29:18 UTC

Description Daein Park 2022-05-17 08:29:52 UTC
Document URL: 

- Updating OpenShift Logging
  [ https://docs.openshift.com/container-platform/4.10/logging/cluster-logging-upgrading.html ]

Section Number and Name: 
- Updating OpenShift Logging to the current version
  [ https://docs.openshift.com/container-platform/4.10/logging/cluster-logging-upgrading.html#cluster-logging-updating-logging-to-5-1_cluster-logging-upgrading ]

The incorrect procedure is in "3. Check the logging components:" of the above section.
~~~
e. Verify that the log collector is updated to 5.x:

  $ oc get ds fluentd -o json | grep fluentd-init

Verify that the output includes a fluentd-init container:

  "containerName": "fluentd-init"
~~~

Describe the issue: 

As of OpenShift Logging v5.3, the data collector component name has been replaced "fluentd" with "collector".
But our docs do not consider this change in the procedures to verify it after upgrade of it.
So we should provide the correct procedure to verify the collector pod after upgrade in the docs.

You can see the background of changing the component name from here: https://issues.redhat.com/browse/LOG-1337

Suggestions for improvement:

For example, my suggestion is as follows.
~~~
e. Verify that the log collector is updated to it before 5.3:

  $ oc get ds fluentd -o json | grep fluentd-init

  Verify that the output includes a fluentd-init container:

  "containerName": "fluentd-init"

f. Verify that the log collector is updated to it as of 5.3:

  $ oc get ds collector -o json | grep collector

  Verify that the output includes a collector container:

  "containerName": "collector"
~~~

Additional information: 

This issue has been reported by customers.


Note You need to log in before you can comment on or make changes to this bug.