Skip to content

Commit 0e9c12e

Browse files
Merge pull request #62954 from aspauldi/CNV-30835
2 parents 2179568 + 8e92fdc commit 0e9c12e

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

modules/virt-must-gather-options.adoc

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,14 @@ You can specify environment variables for a compatible script.
2525
`VM=<vm_name>`:: Collect details about a particular virtual machine. To use this option, you must also specify a namespace by using the `NS` environment variable.
2626

2727
`PROS=<number_of_processes>`:: Modify the maximum number of parallel processes that the `must-gather` tool uses. The default value is `5`.
28+
2829
+
2930
[IMPORTANT]
3031
====
3132
Using too many parallel processes can cause performance issues. Increasing the maximum number of parallel processes is not recommended.
3233
====
3334

35+
3436
.Scripts
3537

3638
Each script is compatible only with certain environment variable combinations.
@@ -41,25 +43,29 @@ Each script is compatible only with certain environment variable combinations.
4143

4244
`/usr/bin/gather --images`:: Collect image, image-stream, and image-stream-tags custom resource information. This script is compatible only with the `PROS` variable.
4345

46+
`/usr/bin/gather --instancetypes`:: Collect instance types information. This information is not currently collected by default; you can, however, optionally collect it.
47+
4448
[id="usage-and-examples_{context}"]
4549
== Usage and examples
4650

4751
Environment variables are optional. You can run a script by itself or with one or more compatible environment variables.
4852

49-
[cols="1a,1a", options="header"]
53+
5054
.Compatible parameters
55+
[options="header"]
5156
|===
5257
|Script |Compatible environment variable
53-
|`/usr/bin/gather` |* `PROS=<number_of_processes>`
58+
|`/usr/bin/gather`
59+
|* `PROS=<number_of_processes>`
5460
|`/usr/bin/gather --vms_details`
5561
|* For a namespace: `NS=<namespace_name>`
5662

5763
* For a VM: `VM=<vm_name> NS=<namespace_name>`
5864

5965
* `PROS=<number_of_processes>`
6066

61-
62-
|`/usr/bin/gather --images` |* `PROS=<number_of_processes>`
67+
|`/usr/bin/gather --images`
68+
|* `PROS=<number_of_processes>`
6369
|===
6470

6571

@@ -111,3 +117,14 @@ $ oc adm must-gather \
111117
--image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v{HCOVersion} \
112118
/usr/bin/gather --images
113119
----
120+
121+
.Instance types information
122+
123+
The following command collects instance types information from the cluster:
124+
125+
[source,terminal,subs="attributes+"]
126+
----
127+
$ oc adm must-gather \
128+
--image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v{HCOVersion} \
129+
/usr/bin/gather --instancetypes
130+
----

modules/virt-using-virt-must-gather.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ The default data collection includes information about the following resources:
1717
* Namespaces that contain virtual machines
1818
* Basic virtual machine definitions
1919
20+
Instance types information is not currently collected by default; you can, however, run a command to optionally collect it.
21+
2022
.Procedure
2123

2224
* Run the following command to collect data about {VirtProductName}:

0 commit comments

Comments
 (0)