Skip to content

doc: update docs for volume options#638

Merged
sankarshanmukhopadhyay merged 3 commits intogluster:mainfrom
Sheetalpamecha:issue618
Jan 29, 2021
Merged

doc: update docs for volume options#638
sankarshanmukhopadhyay merged 3 commits intogluster:mainfrom
Sheetalpamecha:issue618

Conversation

@Sheetalpamecha
Copy link
Member

@Sheetalpamecha Sheetalpamecha commented Jan 25, 2021

There are around 340+ options.The 1st patch deals with prefix 'cluster.'
options. I have included the most used, enabled by default, majorly
affects the volumes or have been facing issues recently.

Owning to the huge list I move forward by creating a separate md
file for vol options. More commits to follow. Just divided to make
review easy and quick.

Updates: #617
Signed-off-by: Sheetal Pamecha spamecha@redhat.com

There are around 340+ options. I have included the most used,
enabled by default, majorly affects the volumes or have been
facing issues recently. The 1st patch deals with prefix 'cluster.'
options. If I have missed any imp option please highlight or any
unnecessary options is added.

Owning to the huge list I move forward by creating a seperate md
file for vol options. More commits to follow. Just divided to make
review easy and quick.

Updates: gluster#617
Signed-off-by: Sheetal Pamecha <spamecha@redhat.com>
Copy link
Member

@amarts amarts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a much needed document. Thanks.

Copy link
Member

@schaffung schaffung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

| diagnostics.latency-measurement | Statistics related to the latency of each operation would be tracked. | Off | On/Off
| diagnostics.dump-fd-stats | Statistics related to file-operations would be tracked. | Off | On/Off
Performance | *features.trash | Enable/disable trash translator | off | on/off
| *performance.readdir-ahead | Enable/disable readdir-ahead translator in the volume | off | on/off
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the prefixed star

| diagnostics.dump-fd-stats | Statistics related to file-operations would be tracked. | Off | On/Off
Performance | *features.trash | Enable/disable trash translator | off | on/off
| *performance.readdir-ahead | Enable/disable readdir-ahead translator in the volume | off | on/off
| *performance.read-ahead | Enable/disable read-ahead translator in the volume | off | on/off
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the prefixed star

Performance | *features.trash | Enable/disable trash translator | off | on/off
| *performance.readdir-ahead | Enable/disable readdir-ahead translator in the volume | off | on/off
| *performance.read-ahead | Enable/disable read-ahead translator in the volume | off | on/off
| *performance.io-cache | Enable/disable io-cache translator in the volume | off | on/off
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the prefixed star

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These prefix are intentionally added. This is highlighted for below note in line100

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool sounds good.

| diagnostics.client-log-level | Changes the log-level of the clients. | INFO | DEBUG/WARNING/ERROR/CRITICAL/NONE/TRACE
| diagnostics.latency-measurement | Statistics related to the latency of each operation would be tracked. | Off | On/Off
| diagnostics.dump-fd-stats | Statistics related to file-operations would be tracked. | Off | On/Off
Performance | *features.trash | Enable/disable trash translator | off | on/off
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the prefixed star at the start at *features.trash

Copy link
Contributor

@kshithijiyer kshithijiyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sankarshanmukhopadhyay
Copy link
Member

LGTM! Thank you for the focus on making the documents better!

@sankarshanmukhopadhyay sankarshanmukhopadhyay merged commit 2efa9a2 into gluster:main Jan 29, 2021
@Sheetalpamecha Sheetalpamecha deleted the issue618 branch February 14, 2021 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants