Bug 1625856

Summary:	Unclear description of brick ports
Product:	[Red Hat Storage] Red Hat Gluster Storage	Reporter:	Vijay Avuthu <vavuthu>
Component:	Documentation	Assignee:	Laura Bailey <lbailey>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Anees Patel <anepatel>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	rhgs-3.4	CC:	anepatel, asriram, mchangir, moagrawa, rhs-bugs, sanandpa, sankarshan, storage-doc, storage-qa-internal, vavuthu
Target Milestone:	---	Keywords:	ZStream
Target Release:	RHGS 3.4.z Async Update
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:	2018-12-28 10:21:44 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:	1650394

Description Vijay Avuthu 2018-09-06 05:45:47 UTC

Document URL: 

https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.4/html-single/installation_guide/

Section Number and Name: 

Chapter 1, 
    1.4. Port Information

    Table 1.1. TCP Port Numbers

Describe the issue: 

The description for the brick ports seems out of date and unclear. 


Suggestions for improvement: 

Change the description for the 49152 - 49251 range to something like:

Each brick for every volume on the host requires its own port for communications with GlusterFS clients. For each brick, one port will be used starting from 49152. Sizing must be considered for the expected maximum of concurrent volumes to determine what the exact range of ports should be.

Comment 2 Sweta Anandpara 2018-11-15 05:49:05 UTC

Ack for Doc Async Update 2.

Comment 3 Laura Bailey 2018-11-21 03:58:13 UTC

This is already updated in the admin doc with the exact text you suggested above, looks like as part of Bug 1511981, but I think we can be clearer:


Every brick requires its own port on its host for communication with Gluster clients. Each brick uses one port. Ports are consumed in ascending order, starting from port 49152 by default. Consider the expected maximum number of concurrent volumes and connections to determine the port range that you require and follow <xref linkend="port-range-configuration"/> to modify the range if required.

The port-range-configuration xref links to https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.4/html-single/administration_guide/#port-range-configuration.


Vijay, can you review this and confirm?



Ideally we would remove this duplicated section from the Installation Guide, because I am certain that either it or the Admin Guide will be out of date if it remains duplicated. Will discuss with the team.

Comment 9 Anees Patel 2018-11-26 06:55:57 UTC

Setting need_info on Mohit and Milind from dev, to review comment #3 and comment #4.

-Thanks,

Comment 13 Anees Patel 2018-12-11 08:05:17 UTC

Looks good to me, setting to verified.