Skip to content

Conversation

@errose28
Copy link
Contributor

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
Copy link
Contributor Author

cc @Tejaskriya @sarvekshayr @ptlrs

@errose28 errose28 added the tools Tools that helps with debugging label Dec 19, 2024
Copy link
Contributor

@adoroszlai adoroszlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @errose28 for the proposal, LGTM.

Copy link
Contributor

@adoroszlai adoroszlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@ivandika3
Copy link
Contributor

ivandika3 commented Jul 10, 2025

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

@adoroszlai
Copy link
Contributor

@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
Copy link
Contributor Author

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
Copy link
Contributor

@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
Copy link
Contributor Author

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.

Copy link
Contributor

@dombizita dombizita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

errose28 and others added 3 commits July 31, 2025 13:59
Co-authored-by: Zita Dombi <50611074+dombizita@users.noreply.github.com>
Co-authored-by: Zita Dombi <50611074+dombizita@users.noreply.github.com>
Co-authored-by: Zita Dombi <50611074+dombizita@users.noreply.github.com>
@errose28
Copy link
Contributor Author

Good catches, just applied the updates @dombizita.

Copy link
Contributor

@dombizita dombizita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@errose28 errose28 requested a review from adoroszlai August 12, 2025 16:39
@errose28
Copy link
Contributor Author

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

@errose28
Copy link
Contributor Author

Thanks all for reviewing and helping with this project!

@errose28 errose28 merged commit 89dcc4c into apache:master Aug 12, 2025
14 checks passed
errose28 added a commit to errose28/ozone that referenced this pull request Aug 18, 2025
* master:
  HDDS-13553. Recon Staging DB for OM full db reprocess (apache#8917)
  HDDS-13138. [Docs] Update Topology Awareness user doc. (apache#8528)
  HDDS-11944. Usability improvements for Ozone tools. (apache#7597)
  HDDS-12197. Update documentation for all ozone debug tools (apache#8868)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

design tools Tools that helps with debugging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants