[HDDS-10683] Add table of all Ozone configurations generated from ozone-default.xml

• Type: Sub-task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Assignee: Unassigned
• Reporter: Ethan Rose
• Created: 12/Apr/24 00:13
• Updated: 08/Jul/24 17:28

Description

While common configurations should be called out as needed in the docs, there are many specialized configurations that may not fit in any of the main docs sections but should still be searchable on the website. We can add create a page similar to Hadoop but nicer with the following process:

1. Add a build step in the website that pulls ozone-default.xml from the main apache/ozone repo.

2. Run a custom script that converts the XML to a markdown table to generate the webpage.

• Reading the XML can be done with an existing CLI XML parser. Outputting as a markdown table should be simple enough if we already know the structure of the XML.

We only need to pull the config file for the "next" (master) version of the docs. For already released versions, we can commit the generated markdown page directly.

Issue Links

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