Bug 2016429

Summary:	Update the documentation for cnv must gather
Product:	Container Native Virtualization (CNV)	Reporter:	Nahshon Unna-Tsameret <nunnatsa>
Component:	Documentation	Assignee:	Pan Ousley <pousley>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Debarati Basu-Nag <dbasunag>
Severity:	high	Docs Contact:
Priority:	high
Version:	4.9.1	CC:	cnv-qe-bugs, dbasunag, pousley
Target Milestone:	---
Target Release:	4.9.1
Hardware:	Unspecified
OS:	Linux
Whiteboard:
Fixed In Version:	4.9	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2021-12-13 22:59:00 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Nahshon Unna-Tsameret 2021-10-21 14:00:14 UTC

As part of handling https://bugzilla.redhat.com/show_bug.cgi?id=2011463, OpenShift Virtualization's must gather had changed in a non-backward compatible way, and requires changes in the documentation. 

The change will be part of the 4.8.4, 4.9.1 and 4.10.0 releases.

More details are in the gihub repository, here: https://github.com/kubevirt/must-gather.

Comment 1 Pan Ousley 2021-11-16 14:47:49 UTC

Hi Nahshon, thank you for providing the source material for this update.

I have opened the following PR to address this bug: https://github.com/openshift/openshift-docs/pull/38786
Preview build: https://deploy-preview-38786--osdocs.netlify.app/openshift-enterprise/latest/virt/logging_events_monitoring/virt-collecting-virt-data

Please review when you can.

Comment 4 Pan Ousley 2021-11-29 22:24:35 UTC

@dbasunag Thank you for your review! I appreciate the time you spent validating the various command options and am glad that the PR LGTY. Please move this BZ to Verified when you are able. 

At this point, I am confident that the PR addresses all of the use cases in the original PR. I will take it from here with peer review on the doc side and will update the bug after merge.

Comment 5 Pan Ousley 2021-11-30 16:23:42 UTC

I have merged my PR[1] and plan to cherrypick it to the enterprise-4.9 branch when 4.9.1 is released. I will do the same for 4.8.4 and the enterprise-4.8 branch. Moving the BZ to RELEASE_PENDING.

[1] https://github.com/openshift/openshift-docs/pull/38786

Comment 6 Pan Ousley 2021-12-13 22:59:00 UTC

4.9.1 released today. I cherrypicked my PR to the enterprise-4.9 branch, and the documentation is now live: 

https://docs.openshift.com/container-platform/4.9/virt/logging_events_monitoring/virt-collecting-virt-data.html#virt-must-gather-usage-targeted-vm-data_virt-collecting-virt-data

Because this bug is targeted to 4.9.1, I am closing it CURRENTRELEASE. I will follow up regarding 4.8.4.