Bug 2087056

Summary: [DOCS] the procedures to verify upgrade of OpenShift Logging v5.3+ in docs are incorrect
Product: OpenShift Container Platform Reporter: Daein Park <dapark>
Component: DocumentationAssignee: Claire Bremble <cbremble>
Status: CLOSED CURRENTRELEASE QA Contact: Xiaoli Tian <xtian>
Severity: medium Docs Contact: Claire Bremble <cbremble>
Priority: unspecified    
Version: 4.10CC: landerso
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-10-25 04:23:15 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

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.