Skip to content

RHIDP-12611: Document the RHDH must-gather tool for diagnostics data collection#2151

Merged
Gerry-Forde merged 7 commits into
redhat-developer:mainfrom
jmagak:RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection
Jun 3, 2026
Merged

RHIDP-12611: Document the RHDH must-gather tool for diagnostics data collection#2151
Gerry-Forde merged 7 commits into
redhat-developer:mainfrom
jmagak:RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection

Conversation

@jmagak

@jmagak jmagak commented May 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

@rhdh-bot

rhdh-bot commented May 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 35/35 titles | 72s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2151/

Content Quality Assessment

CQA Report

  • CQA-00a: Orphaned modules
  • CQA-00b: Directory structure
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure
  • CQA-03: Verify content type metadata
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements
  • CQA-06: Verify assemblies follow official template (one user story)
  • CQA-07: Verify TOC depth (max 3 levels)
  • CQA-08: Verify short description content quality
  • CQA-09: Verify short description format
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-11: Verify procedure prerequisites
  • CQA-12: Verify grammar and style (Vale)
  • CQA-13: Verify content matches declared type
  • CQA-14: Verify no broken links
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 19 pass, 0 fail

19 checks: 19 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.

Updated 2026-06-03 13:46:04 UTC

@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 6bb563d to aee87bf Compare May 4, 2026 10:37
rm3l
rm3l suggested changes May 5, 2026
View reviewed changes
Comment thread ...les/support_diagnostic-data-collection/con-diagnostic-data-collection-for-support-cases.adoc Outdated
Comment thread ...les/support_diagnostic-data-collection/con-diagnostic-data-collection-for-support-cases.adoc Outdated
Comment thread modules/support_diagnostic-data-collection/con-diagnostic-data-types-and-collection-scope.adoc Outdated
Comment thread modules/support_diagnostic-data-collection/con-diagnostic-data-types-and-collection-scope.adoc Outdated
Comment thread modules/support_diagnostic-data-collection/con-diagnostic-data-types-and-collection-scope.adoc Outdated
Comment thread ...port_diagnostic-data-collection/ref-platform-compatibility-and-supported-configurations.adoc Outdated
Comment thread ...es/support_diagnostic-data-collection/proc-collect-heap-dumps-to-diagnose-memory-issues.adoc Outdated
Comment thread ...es/support_diagnostic-data-collection/proc-collect-heap-dumps-to-diagnose-memory-issues.adoc Outdated
Comment thread ...es/support_diagnostic-data-collection/proc-collect-heap-dumps-to-diagnose-memory-issues.adoc Outdated
Comment thread ...ion/proc-collect-heap-dumps-with-custom-sigusr2-configuration-to-diagnose-memory-issues.adoc Outdated
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from aee87bf to 31d09c4 Compare May 5, 2026 13:28
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 31d09c4 to bd9e729 Compare May 5, 2026 13:32
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from bd9e729 to e8384e6 Compare May 5, 2026 14:26
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from e8384e6 to d5dc1b5 Compare May 5, 2026 15:16
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from c9f7cb6 to 3099922 Compare May 6, 2026 11:10
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 3099922 to 19afd22 Compare May 6, 2026 12:30
@jmagak jmagak force-pushed the RHIDP-12611-Document-the-RHDH-must-gather-tool-for-diagnostics-data-collection branch from 19afd22 to 8928639 Compare May 7, 2026 09:45
themr0c
themr0c requested changes May 26, 2026
View reviewed changes

@themr0c themr0c left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The 2 procedures are still mixing oc and helm => the objective of having one procedure for each is missed.

rm3l
rm3l suggested changes May 27, 2026
View reviewed changes
Comment thread titles/observe_diagnostic-data-collection/master.adoc Outdated
rm3l
rm3l approved these changes May 29, 2026
View reviewed changes

@rm3l rm3l left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @jmagak !!

/lgtm

@rm3l

rm3l commented May 29, 2026

Copy link
Copy Markdown
Member

btw, is there a note somewhere that the must-gather is currently Tech Preview? I remember seeing it previously on your PR, but can no longer find it.
Or I might have missed it.

@openshift-ci

openshift-ci Bot commented May 29, 2026

Copy link
Copy Markdown

New changes are detected. LGTM label has been removed.

@sonarqubecloud

sonarqubecloud Bot commented May 29, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@jmagak

jmagak commented May 29, 2026

Copy link
Copy Markdown
Member Author

btw, is there a note somewhere that the must-gather is currently Tech Preview? I remember seeing it previously on your PR, but can no longer find it. Or I might have missed it.

Yes, the Technology Preview banner has now been included in the first section after the abstract in the "Diagnostic data collection overview" concept module. @rm3l

rh-tokeefe
rh-tokeefe reviewed Jun 1, 2026
View reviewed changes

@rh-tokeefe rh-tokeefe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@jmagak overall this LGTM. I made a few comments for you to consider, but I defer to your judgement. It looks like two comments by Armel Soro are not resolved. I'm not sure if there needs to be an action, if an action was taken but the comment not resolved, etc.

Comment thread modules/observe_diagnostic-data-collection/con-diagnostic-data-collection-overview.adoc Outdated
Comment thread ...iagnostic-data-collection/proc-run-must-gather-on-kubernetes-to-collect-diagnostic-data.adoc Outdated
Comment thread ...diagnostic-data-collection/proc-run-must-gather-on-openshift-to-collect-diagnostic-data.adoc Outdated
rm3l
rm3l reviewed Jun 2, 2026
View reviewed changes

@rm3l rm3l left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@jmagak I just realized that a previous section about running the must-gather image in air-gapped/disconnected environments seems to be missing from this PR.
I had made a few comments like this one, but now it seems to be completely missing:

Image

I think disconnected environments is an important topic to cover here. Upstream docs: https://github.com/redhat-developer/rhdh-must-gather/blob/release-1.10/docs/disconnected-environments.md

@jmagak

jmagak commented Jun 3, 2026

Copy link
Copy Markdown
Member Author

@jmagak I just realized that a previous section about running the must-gather image in air-gapped/disconnected environments seems to be missing from this PR.

That is true, @rm3l. I had removed that section. I have added back the air-gapped section here. Please help me review it.

rm3l
rm3l reviewed Jun 3, 2026
View reviewed changes
Comment thread ...nostic-data-from-air-gapped-clusters-by-mirroring-must-gather-to-your-internal-registry.adoc Outdated
Comment thread ...nostic-data-from-air-gapped-clusters-by-mirroring-must-gather-to-your-internal-registry.adoc Outdated
Comment thread ...nostic-data-from-air-gapped-clusters-by-mirroring-must-gather-to-your-internal-registry.adoc
rh-tokeefe
rh-tokeefe approved these changes Jun 3, 2026
View reviewed changes

@rh-tokeefe rh-tokeefe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@jmagak overall LGTM. I made a suggestion for the short description based on the gem output. The other item is more a question for my own benefit.

Comment thread ...nostic-data-from-air-gapped-clusters-by-mirroring-must-gather-to-your-internal-registry.adoc Outdated
@sonarqubecloud

sonarqubecloud Bot commented Jun 3, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@jmagak

jmagak commented Jun 3, 2026

Copy link
Copy Markdown
Member Author

/cherry-pick release-1.10

@openshift-cherrypick-robot

openshift-cherrypick-robot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

@jmagak: once the present PR merges, I will cherry-pick it on top of release-1.10 in a new PR and assign it to you.

Details

In response to this:

/cherry-pick release-1.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

rh-tokeefe
rh-tokeefe reviewed Jun 3, 2026
View reviewed changes

@rh-tokeefe rh-tokeefe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Added one comment :)

rh-tokeefe
rh-tokeefe approved these changes Jun 3, 2026
View reviewed changes

@rh-tokeefe rh-tokeefe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@openshift-cherrypick-robot

openshift-cherrypick-robot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

@jmagak: new pull request created: #2314

Details

In response to this:

/cherry-pick release-1.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Jun 3, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rh-tokeefe rh-tokeefe rh-tokeefe approved these changes

@themr0c themr0c Awaiting requested review from themr0c

+1 more reviewer

@rm3l rm3l rm3l approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@rm3l rm3l

Labels

Peer review done 📘 Ready to merge 💂 Technical review done ⛅ Any procedure has been succesfully tested

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@jmagak @rhdh-bot @rm3l @openshift-cherrypick-robot @themr0c @rh-tokeefe @Gerry-Forde