HDDS-11944. Usability improvements for Ozone tools.

[errose28]

What changes were proposed in this pull request?

Document a proposal for a new layout of the ozone debug and ozone repair CLIs as part of the usability improvements in HDDS-11944.

What is the link to the Apache JIRA

HDDS-11944

How was this patch tested?

N/A

[errose28]

cc @Tejaskriya@sarvekshayr@ptlrs

[adoroszlai]

Thanks @errose28 for the proposal, LGTM.

[adoroszlai]

Found a mismatch while working on the --dry-run flag.

[ivandika3]

HDDS-11944 is well underway, @errose28@adoroszlai is this ready to be merged?

[adoroszlai]

@ivandika3 I think @errose28 wanted to keep it open until all changes are implemented, and tweak the document based on actual changes before merging it. Given that no further changes are planned for now (only additional tests), I guess it's time to finalize it.

CC @dombizita

[errose28]

Yes our current tools effort is wrapping up, with the focus mostly on testing now. I read through the doc and made some updates based on what was done, including the presence of online repair commands. This should be ready for people to take a final look and decide if it should be merged.

[dombizita]

@errose28 thanks for updating the design doc, there a few a things (like command flag names, something was moved to another place etc.) should we update those here or with adding them to our documentation correctly (HDDS-12196 and HDDS-12197 is actively worked on) is enough?

[errose28]

Thanks for reviewing @dombizita I've updated the doc with your suggestions to make it match what is currently on master. I've also added a disclaimer at the top that the doc can serve as a reference going forward but that it is not expected to be up to date with the current state of the CLI.

[dombizita]

Thank you for updating it @errose28! I have a few small comments, otherwise it looks good to me!

[errose28]

Good catches, just applied the updates @dombizita.

[dombizita]

Thanks for addressing the comments @errose28, looks good to me in this form!

[errose28]

Hi @adoroszlai could you take another look at this before merging since you had an outstanding change request?

[errose28]

Thanks all for reviewing and helping with this project!