Bug 1839212

Summary: [Doc] Incorrect command in OCS deployment guide
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Sonal <sarora>
Component: doc-Container_Native_Storage_with_OpenShiftAssignee: Agil Antony <agantony>
Status: CLOSED NOTABUG QA Contact: Prasanth <pprakash>
Severity: medium Docs Contact:
Priority: medium    
Version: ocs-3.11CC: agantony, asriram, puebele, rhs-bugs, storage-doc
Target Milestone: ---Keywords: ZStream
Target Release: RHGS 3.5.z Batch Update 3   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-06-25 10:03:20 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 Sonal 2020-05-22 18:39:25 UTC 
Document URL: 

https://access.redhat.com/documentation/en-us/red_hat_openshift_container_storage/3.11/html-single/deployment_guide/index#upgrading_if_existing_version_deployed_by_using_cns_deploy

Section Number and Name: 

6.1.3.2. Upgrading the Red Hat Gluster Storage Pods

6.1.4.2. Upgrading the Red Hat Gluster Storage Pods

6.2.3.2. Upgrading the Red Hat Gluster Storage Registry Pods

6.2.4.2. Upgrading the Red Hat Gluster Storage Registry Pods

Describe the issue: 

The below command mentioned in the deployment doc is incorrect:

~~~
# for eachVolume in gluster volume list; do echo $eachVolume; gluster volume set $eachVolume server.tcp-user-timeout 42 ; done

For example:

# for eachVolume in gluster volume list; do echo $eachVolume; gluster volume set $eachVolume server.tcp-user-timeout 42 ; done
  volume1
  volume set: success
  volume2
  volume set: success
~~~

This command is mentioned multiple times in the doc. All the section numbers containing command is mentioned above.

Suggestions for improvement: 

It should be:

# for eachVolume in $(gluster volume list); do echo $eachVolume; gluster volume set $eachVolume server.tcp-user-timeout 42 ; done