OCPBUGS-52653 updated the tar code in step 3 and also added sentence in step 3 about unique cluster ID by wgabor0427 · Pull Request #91615 · openshift/openshift-docs

wgabor0427 · 2025-04-03T19:16:17Z

Version(s):
4.12+

Issue:
https://issues.redhat.com/browse/OCPBUGS-52653

Link to docs preview:
https://91615--ocpdocs-pr.netlify.app/openshift-dedicated/latest/support/gathering-cluster-data.html
https://91615--ocpdocs-pr.netlify.app/openshift-enterprise/latest/support/gathering-cluster-data.html
https://91615--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/support/gathering-cluster-data.html
https://91615--ocpdocs-pr.netlify.app/openshift-rosa/latest/support/gathering-cluster-data.html

QE review:

QE has approved this change.

The following topic steps should have the same information:

Gathering data about your cluster for Red Hat Support (step 3)
Gathering data about specific features (step 4)
Gathering network logs (step 2)

ocpdocs-previewbot · 2025-04-03T19:45:47Z

🤖 Wed Apr 16 15:22:00 - Prow CI generated the docs preview:

https://91615--ocpdocs-pr.netlify.app/openshift-dedicated/latest/support/gathering-cluster-data.html
https://91615--ocpdocs-pr.netlify.app/openshift-enterprise/latest/support/gathering-cluster-data.html
https://91615--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/support/gathering-cluster-data.html
https://91615--ocpdocs-pr.netlify.app/openshift-rosa/latest/support/gathering-cluster-data.html

zhouying7780 · 2025-04-08T01:56:34Z

-. Create a compressed file from the `must-gather` directory that was just created in your working directory. For example, on a computer that uses a Linux
-operating system, run the following command:
+. Create a compressed file from the `must-gather` directory that was just created in your working directory. Make sure you provide the date and cluster ID for a unique must-gather. For moe information on how to fiind the cluster ID, see the Red Hat Knowledge base solution link:https://access.redhat.com/solutions/5280291[How to find the cluster-id or name on Opeshift cluster]. For example, on a computer that uses a Linux operating system, run the following command:
 +


There is a typo fiind the cluster ID , please update , thanks

@zhouying7780 Can you please review the docs again under "Links to doc preview" above. Thanks.

zhouying7780 · 2025-04-08T01:59:58Z

-$ tar cvaf must-gather.tar.gz must-gather.local.5421342344627712289/ <1>
+$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-$CLUSTERID.tar.gz must-gather.local.426787175854303238 <1>
 ----
 <1> Make sure to replace `must-gather-local.5421342344627712289/` with the actual directory name.


here should be the same as the example : must-gather.local.426787175854303238

zhouying7780 · 2025-04-09T02:59:11Z

@wgabor0427 The typo fiind exist in all the 4 docs under "Links to doc preview" . Please help update .

zhouying7780 · 2025-04-15T05:47:05Z

@wgabor0427 still there are the typo fiind the cluster ID under the following :
https://91615--ocpdocs-pr.netlify.app/openshift-dedicated/latest/support/gathering-cluster-data.html#support_gathering_data_gathering-cluster-data
https://91615--ocpdocs-pr.netlify.app/openshift-enterprise/latest/support/gathering-cluster-data.html#support_gathering_data_gathering-cluster-data
https://91615--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/support/gathering-cluster-data.html#support_gathering_data_gathering-cluster-data
https://91615--ocpdocs-pr.netlify.app/openshift-rosa/latest/support/gathering-cluster-data.html#support_gathering_data_gathering-cluster-data

zhouying7780 · 2025-04-16T00:57:24Z

/lgtm

wgabor0427 · 2025-04-16T12:43:51Z

/label peer-review-needed

xenolinux

Left a few comments; otherwise LGTM

xenolinux · 2025-04-16T13:52:14Z

 By default, the `must-gather` tool collects the OVN `nbdb` and `sbdb` databases from all of the nodes in the cluster. Adding the `-- gather_network_logs` option to include additional logs that contain OVN-Kubernetes transactions for OVN `nbdb` database.
 ====
-. Create a compressed file from the `must-gather` directory that was just created in your working directory. For example, on a computer that uses a Linux operating system, run the following command:
+.  Create a compressed file from the `must-gather` directory that was just created in your working directory. Make sure you provide the date and cluster ID for a unique must-gather. For more information on how to find the cluster ID, see the Red Hat Knowledge base solution link:https://access.redhat.com/solutions/5280291[How to find the cluster-id or name on OpenShift cluster]. For example, on a computer that uses a Linux operating system, run the following command:


Suggested change

. Create a compressed file from the `must-gather` directory that was just created in your working directory. Make sure you provide the date and cluster ID for a unique must-gather. For more information on how to find the cluster ID, see the Red Hat Knowledge base solution link:https://access.redhat.com/solutions/5280291[How to find the cluster-id or name on OpenShift cluster]. For example, on a computer that uses a Linux operating system, run the following command:

. Create a compressed file from the `must-gather` directory that was just created in your working directory. Make sure you provide the date and cluster ID for a unique must-gather data. For more information about how to find the cluster ID, see link:https://access.redhat.com/solutions/5280291[How to find the cluster-id or name on OpenShift cluster]. For example, on a computer that uses a Linux operating system, run the following command:

"....a unique must-gather": Assuming this is poiniting to a unique must-gather data. If not, please replace with the suitable name/term.

"...Knowledge base solution" can be omitted

Replaced "for a unique must-gather" with "for the unique must-gather data."

Deleted "Knowledge base solution"

xenolinux · 2025-04-16T14:02:45Z

 [source,terminal]
 ----
-$ tar cvaf must-gather.tar.gz must-gather.local.472290403699006248 <1>
+$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-$CLUSTERID.tar.gz must-gather.local.426787175854303238 <1>


Suggested change

$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-$CLUSTERID.tar.gz must-gather.local.426787175854303238 <1>

$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-<cluster_id>.tar.gz <must_gather_local_dir> <1>

I'd suggest to use a user-replaced variable for cluster id. I believe $ is not needed for <cluster_id>. You might want to confirm with SME/QE.

because must-gather.local.426787175854303238 is replaceable, suggestion to use a placeholder -- <must_gather_local_dir>

Added the user-replaced variable <cluster_id>

Added the placeholder <must_gather_local_dir>

xenolinux · 2025-04-16T14:03:03Z

-$ tar cvaf must-gather.tar.gz must-gather.local.472290403699006248 <1>
+$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-$CLUSTERID.tar.gz must-gather.local.426787175854303238 <1>
 ----
 <1> Replace `must-gather-local.472290403699006248` with the actual directory name.


Suggested change

<1> Replace `must-gather-local.472290403699006248` with the actual directory name.

<1> Replace `<must_gather_local_dir>` with the actual directory name.

xenolinux · 2025-04-16T14:03:39Z


 ifndef::openshift-origin[]
-. Create a compressed file from the `must-gather` directory that was just created in your working directory. For example, on a computer that uses a Linux
+. Create a compressed file from the `must-gather` directory that was just created in your working directory. Make sure you provide the date and cluster ID for a unique must-gather. For more information on how to find the cluster ID, see the Red Hat Knowledge base solution link:https://access.redhat.com/solutions/5280291[How to find the cluster-id or name on OpenShift cluster]. For example, on a computer that uses a Linux


Same comments as earlier

Made same edits in this file

xenolinux · 2025-04-16T14:03:56Z

 [source,terminal]
 ----
-$ tar cvaf must-gather.tar.gz must-gather.local.5421342344627712289/ <1>
+$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-$CLUSTERID.tar.gz must-gather.local.426787175854303238 <1>


Same comments as earlier

Made same edits in this file

xenolinux · 2025-04-16T14:04:43Z

+$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-$CLUSTERID.tar.gz must-gather.local.426787175854303238 <1>
 ----
-<1> Make sure to replace `must-gather-local.5421342344627712289/` with the
+<1> Make sure to replace `must-gather.local.426787175854303238` with the


Suggested change

<1> Make sure to replace `must-gather.local.426787175854303238` with the

<1> Make sure to replace `<must_gather_local_dir>` with the actual directory name.

Made changes

xenolinux · 2025-04-16T14:04:57Z

 ----
-<1> Make sure to replace `must-gather-local.5421342344627712289/` with the
+<1> Make sure to replace `must-gather.local.426787175854303238` with the
 actual directory name.


Suggested change

actual directory name.

Made the same changes to this file as above

xenolinux · 2025-04-16T14:05:13Z


-. Create a compressed file from the `must-gather` directory that was just created in your working directory. For example, on a computer that uses a Linux
-operating system, run the following command:
+. Create a compressed file from the `must-gather` directory that was just created in your working directory. Make sure you provide the date and cluster ID for a unique must-gather. For more information on how to find the cluster ID, see the Red Hat Knowledge base solution link:https://access.redhat.com/solutions/5280291[How to find the cluster-id or name on Opeshift cluster]. For example, on a computer that uses a Linux operating system, run the following command:


Same comments

xenolinux · 2025-04-16T14:05:27Z

+$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-$CLUSTERID.tar.gz must-gather.local.426787175854303238 <1>
 ----
-<1> Make sure to replace `must-gather-local.5421342344627712289/` with the actual directory name.
+<1> Make sure to replace `must-gather-local.426787175854303238/` with the actual directory name.


Same comments

xenolinux · 2025-04-21T13:03:39Z

/cherrypick enterprise-4.16

xenolinux · 2025-04-21T13:03:42Z

/cherrypick enterprise-4.17

xenolinux · 2025-04-21T13:03:45Z

/cherrypick enterprise-4.18

xenolinux · 2025-04-21T13:03:47Z

/cherrypick enterprise-4.19

openshift-cherrypick-robot · 2025-04-21T13:04:12Z

@xenolinux: #91615 failed to apply on top of branch "enterprise-4.12":

Applying: OCPBUGS-52653 made edits to the files
Using index info to reconstruct a base tree...
M	modules/gathering-data-network-logs.adoc
M	modules/gathering-data-specific-features.adoc
M	modules/support-gather-data.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/support-gather-data.adoc
Auto-merging modules/gathering-data-specific-features.adoc
Auto-merging modules/gathering-data-network-logs.adoc
CONFLICT (content): Merge conflict in modules/gathering-data-network-logs.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OCPBUGS-52653 made edits to the files

Details

In response to this:

/cherrypick enterprise-4.12

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 · 2025-04-21T13:04:16Z

@xenolinux: #91615 failed to apply on top of branch "enterprise-4.13":

Applying: OCPBUGS-52653 made edits to the files
Using index info to reconstruct a base tree...
M	modules/gathering-data-network-logs.adoc
M	modules/gathering-data-specific-features.adoc
M	modules/support-gather-data.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/support-gather-data.adoc
Auto-merging modules/gathering-data-specific-features.adoc
Auto-merging modules/gathering-data-network-logs.adoc
CONFLICT (content): Merge conflict in modules/gathering-data-network-logs.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OCPBUGS-52653 made edits to the files

Details

In response to this:

/cherrypick enterprise-4.13

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 · 2025-04-21T13:04:23Z

@xenolinux: new pull request created: #92393

Details

In response to this:

/cherrypick enterprise-4.14

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 · 2025-04-21T13:04:27Z

@xenolinux: new pull request created: #92394

Details

In response to this:

/cherrypick enterprise-4.15

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 · 2025-04-21T13:04:31Z

@xenolinux: new pull request created: #92395

Details

In response to this:

/cherrypick enterprise-4.16

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 · 2025-04-21T13:04:35Z

@xenolinux: new pull request created: #92396

Details

In response to this:

/cherrypick enterprise-4.17

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 · 2025-04-21T13:04:38Z

@xenolinux: #91615 failed to apply on top of branch "enterprise-4.18":

Patch is empty.
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To record the empty patch as an empty commit, run "git am --allow-empty".
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"

Details

In response to this:

/cherrypick enterprise-4.18

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 · 2025-04-21T13:04:47Z

@xenolinux: new pull request created: #92397

Details

In response to this:

/cherrypick enterprise-4.19

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.

xenolinux · 2025-04-21T13:06:01Z

/cherrypick enterprise-4.18

openshift-cherrypick-robot · 2025-04-21T13:06:49Z

@xenolinux: new pull request created: #92398

Details

In response to this:

/cherrypick enterprise-4.18

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.

xenolinux · 2025-04-21T14:04:46Z

@wgabor0427 Automated cherry-picks for 4.12 and 4.13 failed. You need to create manual CP PRs.

openshift-ci Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 3, 2025

wgabor0427 force-pushed the OCPBUGS-52653 branch 2 times, most recently from a19398f to 76268f8 Compare April 4, 2025 19:03

zhouying7780 reviewed Apr 8, 2025

View reviewed changes

wgabor0427 force-pushed the OCPBUGS-52653 branch from 76268f8 to 2357de0 Compare April 8, 2025 13:52

openshift-ci Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 8, 2025

wgabor0427 force-pushed the OCPBUGS-52653 branch from 2357de0 to 120edde Compare April 8, 2025 13:53

wgabor0427 force-pushed the OCPBUGS-52653 branch 4 times, most recently from 33376bd to 421df5a Compare April 14, 2025 17:45

wgabor0427 force-pushed the OCPBUGS-52653 branch from 99e4dd0 to aa4f0ee Compare April 15, 2025 13:02

openshift-ci Bot assigned zhouying7780 Apr 16, 2025

openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Apr 16, 2025

openshift-ci Bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Apr 16, 2025

xenolinux added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 16, 2025

xenolinux reviewed Apr 16, 2025

View reviewed changes

xenolinux added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Apr 16, 2025

wgabor0427 force-pushed the OCPBUGS-52653 branch from aa4f0ee to d86b187 Compare April 16, 2025 14:13

openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Apr 16, 2025

OCPBUGS-52653 made edits to the files

fd44598

xenolinux added this to the Continuous Release milestone Apr 21, 2025

xenolinux added branch/enterprise-4.12 branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 branch/enterprise-4.16 branch/enterprise-4.17 branch/enterprise-4.18 branch/enterprise-4.19 labels Apr 21, 2025

openshift-cherrypick-robot mentioned this pull request Apr 21, 2025

[enterprise-4.14] OCPBUGS-52653 updated the tar code in step 3 and also added sentence in step 3 about unique cluster ID #92393

Merged

openshift-cherrypick-robot mentioned this pull request Apr 21, 2025

[enterprise-4.15] OCPBUGS-52653 updated the tar code in step 3 and also added sentence in step 3 about unique cluster ID #92394

Merged

openshift-cherrypick-robot mentioned this pull request Apr 21, 2025

[enterprise-4.16] OCPBUGS-52653 updated the tar code in step 3 and also added sentence in step 3 about unique cluster ID #92395

Merged

openshift-cherrypick-robot mentioned this pull request Apr 21, 2025

[enterprise-4.17] OCPBUGS-52653 updated the tar code in step 3 and also added sentence in step 3 about unique cluster ID #92396

Merged

openshift-cherrypick-robot mentioned this pull request Apr 21, 2025

[enterprise-4.19] OCPBUGS-52653 updated the tar code in step 3 and also added sentence in step 3 about unique cluster ID #92397

Merged

openshift-cherrypick-robot mentioned this pull request Apr 21, 2025

[enterprise-4.18] OCPBUGS-52653 updated the tar code in step 3 and also added sentence in step 3 about unique cluster ID #92398

Merged

	$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-$CLUSTERID.tar.gz must-gather.local.426787175854303238 <1>
	$ tar cvaf must-gather-`date +"%m-%d-%Y-%H-%M-%S"`-<cluster_id>.tar.gz <must_gather_local_dir> <1>

	<1> Replace `must-gather-local.472290403699006248` with the actual directory name.
	<1> Replace `<must_gather_local_dir>` with the actual directory name.

	<1> Make sure to replace `must-gather.local.426787175854303238` with the
	<1> Make sure to replace `<must_gather_local_dir>` with the actual directory name.

Conversation

wgabor0427 commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zhouying7780 commented Apr 9, 2025

Uh oh!

zhouying7780 commented Apr 15, 2025

Uh oh!

zhouying7780 commented Apr 16, 2025

Uh oh!

wgabor0427 commented Apr 16, 2025

Uh oh!

xenolinux left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xenolinux commented Apr 21, 2025

Uh oh!

xenolinux commented Apr 21, 2025

Uh oh!

xenolinux commented Apr 21, 2025

Uh oh!

xenolinux commented Apr 21, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 21, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 21, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 21, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 21, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 21, 2025

Uh oh!

openshift-cherrypick-robot commented Apr 21, 2025

wgabor0427 commented Apr 3, 2025 •

edited

Loading

ocpdocs-previewbot commented Apr 3, 2025 •

edited

Loading

xenolinux left a comment •

edited

Loading