HDDS-15441. [DiskBalancer] Fix DiskBalancer documentation inconsistencies.#10399
HDDS-15441. [DiskBalancer] Fix DiskBalancer documentation inconsistencies.#10399slfan1989 wants to merge 4 commits into
Conversation
sreejasahithi
left a comment
sreejasahithi
left a comment
There was a problem hiding this comment.
Thanks @slfan1989 for fixing the doc
| @@ -158,9 +158,9 @@ ozone admin datanode diskbalancer report [<datanode-address> ...] [--in-service- | |||
There was a problem hiding this comment.
For --in-service-datanodes you can add here as all IN_SERVICE and HEALTHY datanodes.
There was a problem hiding this comment.
@sreejasahithi @Gargi-jais11 Thanks for the suggestion. I updated the --in-service-datanodes description to mention all IN_SERVICE and HEALTHY datanodes, and made the same update in the related examples and Chinese documentation.
Gargi-jais11
left a comment
Gargi-jais11
left a comment
There was a problem hiding this comment.
Thanks @slfan1989 for catching these inconsistencies.
Please find inlined comments.
| | `hdds.datanode.disk.balancer.container.choosing.policy` | `org.apache.hadoop.ozone.container.diskbalancer.policy.DefaultContainerChoosingPolicy` | 用于选择源/目标卷以及要移动的容器的策略。 | | ||
| | `hdds.datanode.disk.balancer.service.timeout` | `300s` | Datanode DiskBalancer 服务操作超时。 | | ||
| | `hdds.datanode.disk.balancer.should.run.default` | `false` | 如果平衡器无法读取其持久配置，则该值决定服务是否应默认运行。 | | ||
|
|
There was a problem hiding this comment.
I believe we need a newline at end of a file?
There was a problem hiding this comment.
Thanks for pointing it out! I verified the Chinese documentation now ends with a newline.
There was a problem hiding this comment.
@slfan1989 thanks for adding the newline, but the same applies to the English doc as well
Co-authored-by: Gargi Jaiswal <134698352+Gargi-jais11@users.noreply.github.com>
5 participants
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.