Bug 1398514

Summary: Consistency in volume options table
Product: Red Hat Gluster Storage Reporter: Laura Bailey <lbailey>
Component: doc-Administration_GuideAssignee: storage-doc
doc-Administration_Guide sub component: 3.2 Release QA Contact: storage-qa-internal <storage-qa-internal>
Status: CLOSED DEFERRED Docs Contact:
Severity: unspecified    
Priority: unspecified CC: asriram, rhs-bugs, sasundar, storage-doc
Version: unspecified   
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: 2019-04-22 07:49: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:
Attachments:
Description Flags
all volume options none

Comment 2 SATHEESARAN 2016-11-25 05:25:50 UTC
Technically speaking all the boolean values irrespective of the case should work for all the volume options that sets/unsets that option:

on/ON
off/OFF
enable/ENABLE
disable/DISABLE
true/TRUE
false/FALSE
0
1

I have come across the scenario where some of the volume option accepts only one combination of the above said values.

For example: cluster.enable-shared-storage accepts only 'enable' or 'disable'. All other values are deemed as illegal.

I feel all the boolean-value-expecting volume options should accept all the boolean value combination, and we can document one pair of boolean values, uniformly all through the guide.

Comment 3 Laura Bailey 2016-11-25 05:37:51 UTC
Sas, is there any option that does not accept enable|disable?

If we document enable|disable as the "official" method, is there any boolean option that will not work with that?

Comment 4 SATHEESARAN 2016-11-25 06:20:56 UTC
(In reply to Laura Bailey from comment #3)
> Sas, is there any option that does not accept enable|disable?
> 
> If we document enable|disable as the "official" method, is there any boolean
> option that will not work with that?

Laura,

I am not sure. As I remember there were close to 300 volume options ( 296 exactly ), out of which we need to look for set/unset volume options. 

I also see for some of the volume options, it makes lot of sense to say 'on' or 'off'. For example:
cluster.self-heal-daemon on
performance.read-ahead on

I did a quick search of volume options that has enable/disable combinations, which is very less (5).

cluster.eager-lock                      enable                                  
cluster.enable-shared-storage           disable                                 
cluster.disperse-self-heal-daemon       enable                                  
features.bitrot                         disable                                 
features.barrier                        disable                                 

With the above all options, only 'enable-shared-storage' and 'gluster volume bitrot <vol>' requires 'enable'/'disable'.

Most of the options are ok with 'on'/'off' combination. It would be good, if we could get some thoughts from Developers as they would have more insight in to this.

Comment 6 SATHEESARAN 2016-11-25 06:22:24 UTC
Created attachment 1224151 [details]
all volume options

Comment 7 Yaniv Kaul 2019-04-22 07:49:15 UTC
This BZ was not touched for 2+ years, closing for the time being. Please free to re-open if you intend to work on it.