Bug 1318246 - [Doc RFE] Include multi-threaded self heal related documentation updates
Summary: [Doc RFE] Include multi-threaded self heal related documentation updates
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Gluster Storage
Classification: Red Hat
Component: doc-Administration_Guide
Version: rhgs-3.1
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: RHGS 3.1.3
Assignee: Divya
QA Contact: Nag Pavan Chilakam
URL:
Whiteboard:
Depends On:
Blocks: 1311845
TreeView+ depends on / blocked
 
Reported: 2016-03-16 11:02 UTC by Anjana Suparna Sriram
Modified: 2016-06-29 14:20 UTC (History)
13 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-06-29 14:20:07 UTC
Target Upstream Version:
divya: needinfo-


Attachments (Terms of Use)

Description Anjana Suparna Sriram 2016-03-16 11:02:26 UTC
Document URL: 

Section Number and Name: 

Describe the issue: 

Suggestions for improvement: 

Additional information:

Comment 5 Pranith Kumar K 2016-05-11 04:53:55 UTC
Divya,
      When I click on the link above it gives 404 error.

Pranith

Comment 8 Pranith Kumar K 2016-05-11 08:27:28 UTC
Documentation content is fine, except in the option description may be it is better to say self-heal daemon rather than shd.

Pranith

Comment 13 Divya 2016-05-13 08:19:20 UTC
Based on Comment 12, moving the bug to ON_QA.

Comment 14 Nag Pavan Chilakam 2016-06-03 11:26:45 UTC
I would refrain from using the word thread as it can send a wrong message. It is number of self heals(files) that can be happen rather than really spawning that many threads:



cluster.shd-max-threads 	

current text:
Specifies the number of self-heal threads to be run for healing on each replica by self-heal daemon. 

My suggestion:
Specifies the number of entries that can be self healed in parallel on each replica by self-heal daemon

Comment 15 Divya 2016-06-06 07:51:57 UTC
(In reply to nchilaka from comment #14)
> I would refrain from using the word thread as it can send a wrong message.
> It is number of self heals(files) that can be happen rather than really
> spawning that many threads:
> 
> 
> 
> cluster.shd-max-threads 	
> 
> current text:
> Specifies the number of self-heal threads to be run for healing on each
> replica by self-heal daemon. 
> 
> My suggestion:
> Specifies the number of entries that can be self healed in parallel on each
> replica by self-heal daemon

I have updated the description of cluster.shd-max-threads" based on your suggestion.

Link to the latest doc: 
http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/582/artifact/tmp/en-US/html-single/index.html#Configuring_Volume_Options

Comment 16 Nag Pavan Chilakam 2016-06-06 08:06:29 UTC
Hi Divya,
Unable to open the link ...404 error page not found

Comment 17 Divya 2016-06-06 08:46:45 UTC
(In reply to nchilaka from comment #16)
> Hi Divya,
> Unable to open the link ...404 error page not found

Hi Nag,

Please try this link: http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#Configuring_Volume_Options

Comment 18 Nag Pavan Chilakam 2016-06-06 10:34:50 UTC
looks good to me moving to verified

Comment 19 Divya 2016-06-08 05:15:25 UTC
Alok advised me to add a sub-section on multi-threaded self-heal in the administration guide as this is a significant change.

I will add the same and move this bug back to ON_QA for QA verification.

Comment 20 Divya 2016-06-08 06:36:34 UTC
Akk ... will update the doc and then move it to ON_QA.

Comment 21 Divya 2016-06-08 10:03:57 UTC
Alok, Pranith,

Based on our email discussions, I have added a subsection/formal para for documenting multithreaded self-heal in the Administration guide.

Link to the documentation: http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#Triggering_Self-Healing_on_Replicated_Volumes

Please review and provide feedback/sign-off.

Comment 22 Divya 2016-06-08 10:05:40 UTC
Alok,

Based on our email discussions, I have added a subsection/formal para for documenting multithreaded self-heal in the Administration guide.

Link to the documentation: http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#Triggering_Self-Healing_on_Replicated_Volumes

Please review and provide feedback/sign-off.

Comment 25 Divya 2016-06-10 11:30:54 UTC
Based on my email discussions with Alok and Pranith, I have added a subsection/formal para for documenting multithreaded self-heal in the Administration guide.

Link to the documentation: http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#Triggering_Self-Healing_on_Replicated_Volumes

Alok has signed-off on the content in Comment 23. Hence, moving the bug to ON_QA.

Comment 26 Nag Pavan Chilakam 2016-06-13 05:41:39 UTC
looks good to me

Comment 29 Divya 2016-06-14 09:30:04 UTC
Alok,

I have updated the description of "cluster.shd-wait-qlength" option to:

Specifies the number of entries that must be kept in the queue for self-heal daemon threads to take up as soon as any of the threads are free to heal. This value should be changed based on how much memory self-heal daemon process can use for keeping the next set of entries that need to be healed. 

Link to the latest doc: http://jenkinscat.gsslab.pnq.redhat.com:8080/view/Gluster/job/doc-Red_Hat_Gluster_Storage-3.1.3-Administration_Guide%20%28html-single%29/lastBuild/artifact/tmp/en-US/html-single/index.html#Configuring_Volume_Options

Let me know if it requires any change.

Comment 30 Nag Pavan Chilakam 2016-06-15 06:23:48 UTC
Hi Divya,
I felt the description previously in the options list was right and that was not requiring change.
What was needed to be changed was in  section "10.11.3. Triggering Self-Healing on Replicated Volumes"
Under Multithreaded Self-heal:
Self-heal daemon has the capability to handle multiple heals in parallel and is supported on Replicate and Distribute-replicate volumes. Increasing the number of heals has impact on I/O performance. You can configure the number of entries that can be self healed in parallel on each replica by self-heal daemon using cluster.shd-max-threads volume option. Using cluster.shd-wait-qlength volume option, you can configure the ============================>waiting period for self-heal daemon <=================================== to crawl and keep the entries that need to be healed, ready for the threads to take up as soon as any of the threads are free. 

It is not waiting period but number of heal entries that queue up.

Comment 31 Divya 2016-06-15 06:30:30 UTC
(In reply to nchilaka from comment #30)
> Hi Divya,
> I felt the description previously in the options list was right and that was
> not requiring change.
> What was needed to be changed was in  section "10.11.3. Triggering
> Self-Healing on Replicated Volumes"
> Under Multithreaded Self-heal:
> Self-heal daemon has the capability to handle multiple heals in parallel and
> is supported on Replicate and Distribute-replicate volumes. Increasing the
> number of heals has impact on I/O performance. You can configure the number
> of entries that can be self healed in parallel on each replica by self-heal
> daemon using cluster.shd-max-threads volume option. Using
> cluster.shd-wait-qlength volume option, you can configure the
> ============================>waiting period for self-heal daemon
> <=================================== to crawl and keep the entries that need
> to be healed, ready for the threads to take up as soon as any of the threads
> are free. 
> 
> It is not waiting period but number of heal entries that queue up.

Hi Nag,

The description of "cluster.shd-max-threads" option is added in three places (twice in administration guide (volume options and Multithreaded Self-heal section) and in What's New chapter of Release Notes). 

I am waiting for Alok's confirmation to update it in all the locations.


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