[HDDS-11018] Document missing configs in ozone-default.xml

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Won't Do
• Assignee: Siyao Meng
• Reporter: Siyao Meng
• Created: 17/Jun/24 21:30
• Updated: 26/Jun/24 22:47
• Resolved: 26/Jun/24 22:47

Description

e.g. hdds.scm.pipeline.choose.policy.impl and hdds.scm.ec.pipeline.choose.policy.impl from ScmConfig are NOT properly documented in ozone-default.xml.

---

Update: As adoroszlai mentioned in HDDS-11020 PR: https://github.com/apache/ozone/pull/6832#discussion_r1646553678

Properties defined in @Config classes should not be duplicated in ozone-default.xml.

Those "missing configs" thus would not be added to ozone-default.xml .

However, this means we are lacking public facing docs of those configs, for which I think we need alternative ways to generate the docs for these, similar to RATIS-2107. cc szetszwo

If we can agree on that I will file another jira for Ozone similiar to what RATIS-2107 is intending to do for Ratis.

Issue Links

• is superceded by: HDDS-11072 Publish user-facing configs to the doc site: ozone-default.xml and ozone-default-generated.xml