Bug 1423442

Summary:	group files to set volume options should have comments
Product:	[Community] GlusterFS	Reporter:	Niels de Vos <ndevos>
Component:	glusterd	Assignee:	Barak Sason Rofman <bsasonro>
Status:	CLOSED NEXTRELEASE	QA Contact:
Severity:	low	Docs Contact:
Priority:	low
Version:	mainline	CC:	amukherj, atumball, bugs
Target Milestone:	---	Keywords:	EasyFix, StudentProject, Triaged
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-08-25 05:19:29 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:

Description Niels de Vos 2017-02-17 10:50:08 UTC

Description of problem:
Files like extras/group-virt.example should have comments for each option. Unfortunately it is likely that glusterd does not handle the comments correctly.

Changes like https://review.gluster.org/16577 now mention the reasons for the options in the related bug report, but that is not easily accessible for people that install Gluster packages and do not have the sources available.

To enable easier testing of optimal values, and have users understand the advise to use certain options, comments in the config files are crucial.

Please add support for reading comments in these files to GlusterD, and copy the comments from the bugzilla reports into the option files.

Thanks!

Comment 1 Atin Mukherjee 2017-02-18 07:28:04 UTC

IMO, the profile file itself talks about what kind of workload the set of tunables are meant for. And gluster volume help does provide the list of volume tunables with the description of each of them. With that mind, the priority of this bug stays low and in near future I don't plan to work on this.

Comment 2 Amar Tumballi 2019-05-10 12:51:51 UTC

This can be done by making some changes in the way we read profile files. If we start considering json/yaml model for reading profile file.

Comment 3 Niels de Vos 2019-05-13 06:20:23 UTC

(In reply to Amar Tumballi from comment #2)
> If we start considering json/yaml model for reading profile file.

I do not know of a reason why we want to change the format completely. It would be sufficient to have lines starting with # as comments and ignore these while applying the key/values.

Comment 4 Atin Mukherjee 2019-07-08 03:51:08 UTC

Let's address this as part of intern activity this year.

Comment 5 Worker Ant 2019-08-20 12:43:43 UTC

REVIEW: https://review.gluster.org/23277 (cli - group files to set volume options supports comments) posted (#1) for review on master by Barak Sason Rofman

Comment 6 Worker Ant 2019-08-25 05:19:29 UTC

REVIEW: https://review.gluster.org/23277 (cli - group files to set volume options supports comments) merged (#5) on master by Atin Mukherjee