Skip to content

HDDS-12197. Update documentation for all ozone debug tools - #8868

Merged
dombizita merged 3 commits into
apache:masterfrom
Tejaskriya:debug-doc
Aug 12, 2025
Merged

HDDS-12197. Update documentation for all ozone debug tools#8868
dombizita merged 3 commits into
apache:masterfrom
Tejaskriya:debug-doc

Conversation

@Tejaskriya

@TejaskriyaTejaskriya commented Jul 28, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

As a part of HDDS-11944 and other related jiras, many changes were made to the debug tools of ozoe. SOme new commands were added as well. This PR adds the documentation for the same under tools/debug/.
Each major subcommand has it's own page so that it is more user-friendly to read, instead of keeping all the command usages in 1 page which makes the documentation quite cluttered.

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-12197

How was this patch tested?

Checked the rendering through hugo serve.
Screenshot 2025-07-28 at 2 03 05 PM
Screenshot 2025-07-28 at 2 03 16 PM

@TejaskriyaTejaskriya added documentation Improvements or additions to documentation tools Tools that helps with debugging labels Jul 28, 2025
@Tejaskriya

Tejaskriya commented Jul 28, 2025

Copy link
Copy Markdown
ContributorAuthor

@sarvekshayr requesting your review on this

sarvekshayr
sarvekshayr reviewed Jul 30, 2025
View reviewed changes
Comment threadhadoop-hdds/docs/content/tools/debug/DebugOm.md Outdated
dombizita
dombizita reviewed Aug 11, 2025
View reviewed changes

@dombizitadombizita left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for working on this documentation @Tejaskriya!

Comment threadhadoop-hdds/docs/content/tools/debug/_index.md Outdated
Comment threadhadoop-hdds/docs/content/tools/debug/_index.md Outdated
Comment threadhadoop-hdds/docs/content/tools/debug/RatisLogParser.md Outdated
Comment threadhadoop-hdds/docs/content/tools/debug/DebugReplicas.md Outdated
sarvekshayr
sarvekshayr approved these changes Aug 12, 2025
View reviewed changes

@sarvekshayrsarvekshayr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for updating. LGTM.

dombizita
dombizita approved these changes Aug 12, 2025
View reviewed changes

@dombizitadombizita left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for addressing the review comments @Tejaskriya!

@dombizita
dombizita merged commit a59b573 into apache:masterAug 12, 2025
14 checks passed
@dombizita

dombizita commented Aug 12, 2025

Copy link
Copy Markdown
Contributor

Thank you for working on this @Tejaskriya! Thanks for the review @sarvekshayr!

errose28 added a commit to errose28/ozone that referenced this pull request Aug 18, 2025
@errose28
Merge branch 'master' into HDDS-12078-improve-cli
2638e4f
* 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dombizitadombizitadombizita approved these changes
@sarvekshayrsarvekshayrsarvekshayr approved these changes

Assignees

No one assigned

Labels

documentationImprovements or additions to documentationtoolsTools that helps with debugging

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Tejaskriya@dombizita@sarvekshayr