HDDS-15441. [DiskBalancer] Fix DiskBalancer documentation inconsistencies.#10399
Open
slfan1989 wants to merge 1 commit into
Open
HDDS-15441. [DiskBalancer] Fix DiskBalancer documentation inconsistencies.#10399slfan1989 wants to merge 1 commit into
slfan1989 wants to merge 1 commit into
Conversation
Contributor
sreejasahithi
left a comment
sreejasahithi
left a comment
There was a problem hiding this comment.
Thanks @slfan1989 for fixing the doc
| | Option | Description | Example | | ||
| |-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| | ||
| | `<datanode-address>` | One or more datanode addresses as positional arguments. Addresses can be:<br>- Hostname (e.g., `DN-1`) - uses default CLIENT_RPC port (19864)<br>- Hostname with port (e.g., `DN-1:19864`)<br>- IP address (e.g., `192.168.1.10`)<br>- IP address with port (e.g., `192.168.1.10:19864`)<br>- Stdin (`-`) - reads datanode addresses from standard input, one per line | `DN-1`<br>`DN-1:19864`<br>`192.168.1.10`<br>`-` | | ||
| | `--in-service-datanodes` | It queries SCM for all IN_SERVICE datanodes and executes the command on all of them. | `--in-service-datanodes` | |
Contributor
There was a problem hiding this comment.
For --in-service-datanodes you can add here as all IN_SERVICE and HEALTHY datanodes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This PR fixes several inconsistencies in the English and Chinese DiskBalancer documentation.
The DiskBalancer docs had examples and default values that did not match the current implementation:
The feature flag section said DiskBalancer should be enabled by setting the property to
true, but the example usedhdds.datanode.disk.balancer.enabled = false.The
--parallel-threadoption documented the default as 1, while the code default is5.The Chinese doc documented
--stop-after-disk-evendefault asfalse, while the code default istrue.The
--container-statesexample usedOPEN,CLOSED, butOPENis rejected by DiskBalancer validation because open-to-write container states are not movable.The Chinese configuration table had an extra table separator in the
hdds.datanode.disk.balancer.enabledrow.This PR updates both
DiskBalancer.mdandDiskBalancer.zh.mdso that the documented examples and defaults match the current code and avoid suggesting invalid configuration values.What is the link to the Apache JIRA
HDDS-15441. [DiskBalancer] Fix DiskBalancer documentation inconsistencies.
How was this patch tested?
This is a documentation-only change.