Bug 2212293 - "Usage and examples" in OpenShift Virtualization must gather is wrong
Summary: "Usage and examples" in OpenShift Virtualization must gather is wrong
Keywords:
Status: CLOSED COMPLETED
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: Documentation
Version: 4.13.0
Hardware: All
OS: Linux
unspecified
medium
Target Milestone: ---
: ---
Assignee: Audrey Spaulding
QA Contact: Debarati Basu-Nag
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-06-05 08:03 UTC by nijin ashok
Modified: 2023-07-18 16:05 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-07-18 16:05:06 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker CNV-29398 0 None None None 2023-06-05 08:04:30 UTC

Description nijin ashok 2023-06-05 08:03:57 UTC
Document URL: 

https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/virtualization/index#usage-and-examples_virt-collecting-virt-data


Section Number and Name: 

14.2.3.1.2. Usage and examples


Describe the issue: 

The doc is asking to run the "script" as below:

~~~
oc adm must-gather \
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v4.12.3 \
  -- gather_vms_details
~~~

This will fail with the below error:

~~~
[must-gather-tlbdx] POD 2023-06-05T07:45:47.809798106Z + echo 'This script should not be directly executed.'
[must-gather-tlbdx] POD 2023-06-05T07:45:47.809808455Z This script should not be directly executed.
[must-gather-tlbdx] POD 2023-06-05T07:45:47.809817753Z + echo 'Please check "/usr/bin/gather --help" for execution options.'
[must-gather-tlbdx] POD 2023-06-05T07:45:47.809817753Z Please check "/usr/bin/gather --help" for execution options.
[must-gather-tlbdx] POD 2023-06-05T07:45:47.809821660Z + exit 1
~~~ 

Suggestions for improvement: 

We should run as below:

~~~
oc adm must-gather --image-stream=openshift/must-gather   --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v4.12.3 -- /usr/bin/gather --vms_details
~~~

Also, refer https://github.com/kubevirt/must-gather#flags

Additional information: 

This is applicable for both 4.12 and 4.13.


Note You need to log in before you can comment on or make changes to this bug.