Bug 1436681 - [Doc RFE] Document rebalance status command enhancements
Summary: [Doc RFE] Document rebalance status command enhancements
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Gluster Storage
Classification: Red Hat Storage
Component: doc-Administration_Guide
Version: rhgs-3.3
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: RHGS 3.3.0
Assignee: Laura Bailey
QA Contact: Ambarish
URL:
Whiteboard:
Depends On: 1380598 1396004 1415915
Blocks: 1417156
TreeView+ depends on / blocked
 
Reported: 2017-03-28 12:40 UTC by Anjana Suparna Sriram
Modified: 2023-09-14 03:55 UTC (History)
18 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of: 1380598
Environment:
Last Closed: 2017-09-21 04:28:27 UTC
Embargoed:


Attachments (Terms of Use)

Comment 2 Divya 2017-05-12 10:32:22 UTC
I think the following section in the Administration Guide needs to be updated: 11.7.2. Displaying Status of a Rebalance Operation [1]

Specifically, I need to update the rebalance status output to include the new "run time in h:m:s" column. 

Nithya, 

Can you confirm if my understanding is correct? Also, is the time displayed in the "run time in h:m:s" column is 100% accurate or is it approximate?

Is there anything else we should tell users about this new column?

[1] http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-master/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#sect-Rebalancing_Volumes

Comment 3 Nithya Balachandran 2017-05-22 14:58:28 UTC
(In reply to Divya from comment #2)
> I think the following section in the Administration Guide needs to be
> updated: 11.7.2. Displaying Status of a Rebalance Operation [1]
> 
> Specifically, I need to update the rebalance status output to include the
> new "run time in h:m:s" column. 
> 
> Nithya, 
> 
> Can you confirm if my understanding is correct? Also, is the time displayed
> in the "run time in h:m:s" column is 100% accurate or is it approximate?
> 
> Is there anything else we should tell users about this new column?
> 
> [1]
> http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-
> Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-master/
> lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#sect-
> Rebalancing_Volumes


This BZ targets the estimation changes that went in recently (not the column changes)

Comment 4 Nithya Balachandran 2017-05-22 15:06:17 UTC
Information on the RFE:

The rebalance status command will now print the estimated time left for the rebalance to complete on all nodes.
This value is dependent on the number of files estimated to be on the bricks and the rate at which files are being processed by the rebalance process.

This value is more accurate for large data sets and may change over time as the value is recalculated every time the rebalance status command is executed.

Comment 5 Divya 2017-05-30 09:53:32 UTC
(In reply to Nithya Balachandran from comment #4)
> Information on the RFE:
> 
> The rebalance status command will now print the estimated time left for the
> rebalance to complete on all nodes.
> This value is dependent on the number of files estimated to be on the bricks
> and the rate at which files are being processed by the rebalance process.
> 
> This value is more accurate for large data sets and may change over time as
> the value is recalculated every time the rebalance status command is
> executed.

Thanks for the information, Nithya!

I have updated the rebalance status and remove-brick status output and its documentation based on your inputs.

Link to the doc:

Rebalance: https://access.qa.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/html-single/administration_guide/#Displaying_Status_of_a_Rebalance_Operation

Remove brick: https://access.qa.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/html-single/administration_guide/#sect-Shrinking_Volumes

Let me know if anything else needs changing so that I can incorporate the same before moving this bug to ON_QA.

Thanks,
Divya

PS:

Comment 6 Divya 2017-05-30 10:44:10 UTC
(In reply to Divya from comment #5)

Missed to add the text for PS :(

> PS: I have been trying multiple ways to edit the output so that each output line stays on one line. As soon as I succeed, I will update the guide.

Comment 7 Nithya Balachandran 2017-06-06 04:45:39 UTC
> Link to the doc:
> 
> Rebalance:
> https://access.qa.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/
> html-single/administration_guide/#Displaying_Status_of_a_Rebalance_Operation
> 

The text looks fine but it look like the status output for the section
11.7.3. Stopping a Rebalance Operation

has not been updated to include the new columns.

Is it recommended that actual IP addresses be included in the status output? I was under the impression that we were supposed to use dummy IPs/names.

> Remove brick:
> https://access.qa.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/
> html-single/administration_guide/#sect-Shrinking_Volumes
> 
> Let me know if anything else needs changing so that I can incorporate the
> same before moving this bug to ON_QA.
> 
> Thanks,
> Divya
> 
> PS:

Comment 9 Divya 2017-06-06 07:12:32 UTC
(In reply to Nithya Balachandran from comment #7)

Thanks, Nithya. I have updated the status output for the section 11.7.3. Stopping a Rebalance Operation.

Link to the doc:

Rebalance: https://access.qa.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/html-single/administration_guide/#Displaying_Status_of_a_Rebalance_Operation

Remove brick: https://access.qa.redhat.com/documentation/en-us/red_hat_gluster_storage/3.3/html-single/administration_guide/#sect-Shrinking_Volumes

Moving the bug ON_QA.

Comment 11 Nithya Balachandran 2017-08-10 09:18:01 UTC
There have been some changes to the estimate implementation in recent builds so we need some changes in the documentation.

Can we have this under a separate section titles "Rebalance estimated time to complete" or similar.

<change from>
The rebalance status command will now display the estimated time left for the rebalance to complete on all nodes. The time taken to complete the rebalance operation depends on the number of files estimated to be on the bricks and the rate at which files are being processed by the rebalance process. This estimated time is more accurate for large data sets and may change over time as the value is recalculated every time the rebalance status command is executed.
</change from>




<change to>
The rebalance status command will now display the estimated time left for the rebalance to complete on all nodes. The time taken to complete the rebalance operation depends on the amount of data estimated to be on the bricks and the rate at which files are being processed by the rebalance process. This value is recalculated every time the rebalance status command is executed and becomes  more accurate the longer rebalance has been running and for large data sets.

The estimated time to complete will be displayed only after the rebalance has been running for 10 minutes.

If the value calculated is very large, the status will display that the estimated time to complete is > 2 months and ask the user to check again later.

The calculation is based on the assumption that a file system partition contains a single brick.

</change to>

Comment 12 Nithya Balachandran 2017-08-10 09:32:20 UTC
Can the following also be corrected?

11.7. REBALANCING VOLUMES

A rebalance operation, without force option, will attempt to balance the space utilized across nodes, thereby skipping files to rebalance in case this would cause the target node of migration to have lesser available space than the source of migration. This leads to link files that are still left behind in the system and hence may cause performance issues in access when a large number of such link files are present.

to 


A rebalance operation run without the force option, will attempt to balance the space utilized across nodes, thereby skipping files whose migration would cause the target node to have less available space than the source of migration. This leaves behind linkto files in the system and may cause slower access when a large number of such files are present.

Comment 15 Ambarish 2017-08-28 12:25:36 UTC
Verified by QE.

Comment 16 Laura Bailey 2017-08-29 04:12:29 UTC
Fixed in RHGS 3.3 documentation.

Comment 20 Red Hat Bugzilla 2023-09-14 03:55:42 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 1000 days


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