Bug 1423442 - group files to set volume options should have comments
Summary: group files to set volume options should have comments
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: GlusterFS
Classification: Community
Component: glusterd
Version: mainline
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
Assignee: Barak Sason Rofman
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-02-17 10:50 UTC by Niels de Vos
Modified: 2019-08-25 05:19 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-08-25 05:19:29 UTC
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Gluster.org Gerrit 23277 0 None Merged cli - group files to set volume options supports comments 2019-08-25 05:19:28 UTC
Red Hat Bugzilla 1418900 0 unspecified CLOSED [RFE] Include few more options in virt file 2021-02-22 00:41:40 UTC

Internal Links: 1418900

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


Note You need to log in before you can comment on or make changes to this bug.