Bug 1683206

Summary: [DOCS] OCS 3.11 upgrade: labels should be explained better
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: daniel <dmoessne>
Component: doc-Container_Native_Storage_with_OpenShiftAssignee: Amrita <asakthiv>
Status: CLOSED CURRENTRELEASE QA Contact: susgupta
Severity: medium Docs Contact:
Priority: unspecified    
Version: ocs-3.11CC: asakthiv, asriram, puebele, rhs-bugs, storage-doc, storage-qa-internal
Target Milestone: ---Keywords: ZStream
Target Release: OCS 3.11.z Batch Update 6   
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: 2021-01-05 06:51:10 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:
Bug Depends On:    
Bug Blocks: 1845059    

Description daniel 2019-02-26 13:02:55 UTC 
Document URL: 

-- app storage part 
https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/3.11/html/deployment_guide/chap-documentation-red_hat_gluster_storage_container_native_with_openshift_platform-upgrade

-- registry-storage
https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/3.11/html/deployment_guide/chap-upgrade-glusterfs-registry-namespace


Section Number and Name: 

app storage:
6.1.3. Upgrading the Red Hat Gluster Storage Pods
   7.  Label all the OpenShift Container Platform nodes that has the Red Hat Gluster Storage pods: 

registry storage:
6.2.3. Upgrading the Red Hat Gluster Storage Registry Pods
   6.  Label all the OpenShift Container Platform nodes that has the Red Hat Gluster Storage pods: 



Describe the issue:

First of all I think it would be easier to check the node having the right label by using
- # oc get nodes -l glusterfs=storage-host
- # oc get nodes -l glusterfs=registry-host

as this shows only the nodes having appropriate labels and makes it easier to look at and get needed information.

Further on I fail to get the point of " If the Red Hat Gluster Storage nodes do not have the storagenode=glusterfs label, then label the nodes as shown in step ii. "
or
                                       " If the Red Hat Gluster Storage nodes do not have the storagenode=glusterfs label, then label the nodes as shown in step ii."

My understanding is that the daemonset (ds) responsible for deploying gluster pods is dependent on the labels set to the nodes as can be seen for example here:

# oc get ds 
NAME                 DESIRED   CURRENT   READY     UP-TO-DATE   AVAILABLE   NODE SELECTOR             AGE
glusterfs-registry   3         3         3         3            3           glusterfs=registry-host   2h

#

so the ds would ensure that the pods run on any node having that label. If it would not be there, there would not run any glusterfs pod at all. So either this point makes (at least to me no obvious) sense and could confuse customers or we should add information why this step is needed to make it better understandable by customers.
(Also, the label is easily changed as well, as long as it is ensured the label is present before redeploying the template it could be changed ..)



Suggestions for improvement: 
- use easier command to get nodes with appropriate label
- explain why label of nodes is needed or remove that part of labeling for upgrades

Additional information: