Bug 1365476

Summary: [Doc RFE] Document the new option nfs.rdirplus
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Anjana Suparna Sriram <asriram>
Component: doc-Administration_GuideAssignee: Bhavana <bmohanra>
doc-Administration_Guide sub component: Default QA Contact: surabhi <sbhaloth>
Status: CLOSED CURRENTRELEASE Docs Contact:
Severity: unspecified    
Priority: unspecified CC: asriram, asrivast, bmohanra, mhideo, nbalacha, nlevinki, rhinduja, rhs-bugs, rwheeler, skoduri, storage-doc
Version: rhgs-3.0Keywords: FutureFeature
Target Milestone: ---   
Target Release: RHGS 3.2.0   
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: 2017-03-24 10:20:46 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: 1351549    

Description Anjana Suparna Sriram 2016-08-09 11:08:19 UTC
Additional information: POC: Nithya Balachandran

Comment 3 Bhavana 2016-11-03 07:19:29 UTC
Hi Nithya,

Should this option be documented in the table under "10.1. Configuring Volume Options" ?

https://access.redhat.com/documentation/en-US/Red_Hat_Storage/3.1/html-single/Administration_Guide/index.html#Configuring_Volume_Options

If yes, can you please share the "Allowed Values", "Default Value", and a brief description of the value. 

Thanks

Comment 4 Nithya Balachandran 2016-11-09 05:33:38 UTC
From the code:

        { .key         = "nfs.rdirplus",
          .voltype     = "nfs/server",
          .option      = "nfs.rdirplus",
          .type        = GLOBAL_DOC,
          .op_version  = GD_OP_VERSION_3_7_12,
          .description = "When this option is turned off NFS falls back to "
                         "standard readdir instead of readdirp"
        },

The default value is on. Turning this off would result in more lookup and stat requests being sent from the client causing a dip in performance.

Comment 5 Soumya Koduri 2016-11-09 05:40:40 UTC
(In reply to Bhavana from comment #3)
> Hi Nithya,
> 
> Should this option be documented in the table under "10.1. Configuring
> Volume Options" ?
> 
> https://access.redhat.com/documentation/en-US/Red_Hat_Storage/3.1/html-
> single/Administration_Guide/index.html#Configuring_Volume_Options

yes. It seems appropriate to add this option to the existing Volume Options list.

> 
> If yes, can you please share the "Allowed Values", "Default Value", and a
> brief description of the value. 

Nithya has provided all the required information above. I do not have anything more to add. Thanks!

> 
> Thanks

Comment 6 Bhavana 2016-11-24 10:32:49 UTC
Hi Soumya / Nithya,

The option is added in the table:

http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-bz-1365476-new_option_nfs.rdirplus/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#Configuring_Volume_Options

I wanted to know if we want to tell the customer about the dip in performance, or is it better to just say that "It is not recommended to turn this option off" ?

For now, I have retained the info shared in comment 4

Comment 7 Soumya Koduri 2016-11-29 18:48:31 UTC
Content looks good to me. Maybe we can reword it to 
"Turning this off would result in more lookup and stat requests being sent from the client which may impact performance." Thoughts?

Comment 8 Bhavana 2016-12-06 07:16:13 UTC
Alright, so we do want to inform the customer about the impact on performance :)

I have updated the content accordingly:

http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-master/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#Configuring_Volume_Options

Comment 9 surabhi 2017-02-07 10:47:05 UTC
The allowed options are written in defaults. need to update the section.

Comment 11 surabhi 2017-02-07 10:52:59 UTC
Verified that the options are added in the volume section. Also verified the on and off options works successfully for nfs.rdirplus. Moving this RFE to verified.

Comment 12 Rejy M Cyriac 2017-03-24 10:20:46 UTC
RHGS 3.2.0 GA completed on 23 March 2017