CNV#64706: [DOC] Add IOMMU verification step to OpenShift Virtualization documentation. | Version 4.18

[aspauldi]

Version(s): 4.18+

Issue: CNV-64706

Link to docs preview: https://98467--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/managing_vms/advanced_vm_management/virt-configuring-virtual-gpus.html#virt-adding-kernel-arguments-enable-IOMMU_virt-configuring-virtual-gpus

QE review:

• QE has approved this change.

[aspauldi]

/label CNV

[ocpdocs-previewbot]

🤖 Thu Sep 25 16:03:16 - Prow CI generated the docs preview:

https://98467--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/managing_vms/advanced_vm_management/virt-configuring-pci-passthrough.html
https://98467--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/managing_vms/advanced_vm_management/virt-configuring-virtual-gpus.html

[aspauldi]

Hi @vladikr, I'm hoping that you can help me. I'm working on this doc bug and asked Sarika Patil, the reporter, some clarifying questions. She said the following in Jira comments:

"Apologies for the delay. I believe the engineering team would be better equipped to answer your questions more precisely, so please check with them. Thanks for your understanding."

Are you able to assist with doc updates for this? I found a Closed doc PR that you had helped with back in 2022 and hope that you are the right contact again. If you are not, can you please suggest a more appropriate person?

Thanks very much.

[aspauldi]

Hi @vladikr, Can you review or suggest someone else to take a look? Thanks.

[aspauldi]

Hi vladikr, Can you take another look at this PR when you have a chance? Here is the link to the actual heading: https://98467--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/managing_vms/advanced_vm_management/virt-configuring-virtual-gpus.html#virt-adding-kernel-arguments-enable-IOMMU_virt-configuring-virtual-gpus

Also, I wondered about the version number showing as 3.2. Should that change?

Thanks!

[vladikr]

@aspauldi Thank you! It looks good to me.

[vladikr]

Also, I wondered about the version number showing as 3.2. Should that change?

3.2.0 is the ignition version. I'm not sure what the most recent one is. I think OCP 4.19 supports 3.4.0 as well, but I'm not sure.
Overall, 3.2.0 should remain backward compatible and valid.

[abrennan89]

Just a couple of suggestions to make this closer to the standard format https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#source-tags-for-terminal-commands-and-output

These are not blockers though and otherwise lgtm

[abrennan89]

Suggested change

	. Verify that IOMMU is enabled at the operating system (OS) level by entering the following command:
	+
	[source,terminal]
	----
	$ dmesg | grep -i iommu
	----
	* If IOMMU is enabled, output is displayed as shown in the following example:
	+
	.Example output
	[source,terminal]
	----
	Intel: [ 0.000000] DMAR: Intel(R) IOMMU Driver
	AMD: [ 0.000000] AMD-Vi: IOMMU Initialized
	----
	. Verify that IOMMU is enabled at the operating system (OS) level by entering the following command and observing the output:
	+
	[source,terminal]
	----
	$ dmesg | grep -i iommu
	----
	+
	.Example output
	[source,terminal]
	----
	Intel: [ 0.000000] DMAR: Intel(R) IOMMU Driver
	AMD: [ 0.000000] AMD-Vi: IOMMU Initialized
	----

[sjhala-ccs]

@aspauldi Are you planning to address this?

[aspauldi]

Hi @sjhala-ccs, what do you mean? Sorry!

[sjhala-ccs]

Hi @aspauldi, I meant the suggestion (highlighted in green) to remove this line - * If IOMMU is enabled, output is displayed as shown in the following example: and rewording the procedure step to Verify that IOMMU is enabled at the operating system (OS) level by entering the following command and observing the output:.

[aspauldi]

I had opted to leave the content as is and should have left a comment about that.

[abrennan89]

Suggested change

	. Verify that the new `MachineConfig` object was added by entering the following command:
	. Verify that the new `MachineConfig` object was added by entering the following command and observing the output:

I would recommend standardizing these and calling out the need to observe the output as part of the command step. I would also add an example output here if possible, similar to the next step

[aspauldi]

Hi @vladikr, our docs go through a documentation peer review after SME and QE input has been added. The reviewer who looked at this PR suggested adding example output for this step:

. Verify that the new MachineConfig object was added by entering the following command and observing the output:
+
[source,terminal]

$ oc get MachineConfig

Are you able to provide sample output for this command? Thanks!

[vladikr]

Hi @vladikr, our docs go through a documentation peer review after SME and QE input has been added. The reviewer who looked at this PR suggested adding example output for this step:

. Verify that the new MachineConfig object was added by entering the following command and observing the output:

[source,terminal]

$ oc get MachineConfig

Are you able to provide sample output for this command? Thanks!

@aspauldi It should probably look something like:

NAME                  GENERATEDBYCONTROLLER  IGNITIONVERSION  AGE
00-master             75d18f2                3.2.0            5d
00-worker             75d18f2                3.2.0            5d
01-master-container   75d18f2                3.2.0            5d
01-worker-container   75d18f2                3.2.0            5d
rendered-master-abc   75d18f2                3.2.0            5d
rendered-worker-def   75d18f2                3.2.0            5d
100-worker-iommu      75d18f2                3.2.0            1m
...
``` but I don't have a cluster to test this. It's just based on a previous output I've saved. I think QE could have an existing cluster. 

[aspauldi]

Hi @lkladnit, Are you able to test this, as Vladik mentioned regarding his not having a cluster for testing? Thanks.

[lkladnit]

@aspauldi , i don't have cluster with GPU. But adding the MachineConfig works anyway, so i can confirm

lkladnit-mac:kubevirt-ui lkladnit$ oc get MachineConfig
NAME                                                                  IGNITIONVERSION   AGE
00-master                                                          3.5.0             164m
00-worker                                                          3.5.0             164m
01-master-container-runtime                          3.5.0             164m
01-master-kubelet                                            3.5.0             164m
01-worker-container-runtime                          3.5.0             164m
01-worker-kubelet                                            3.5.0             164m
100-master-chrony-configuration                  3.5.0             169m
100-master-set-core-user-password            3.5.0             169m
100-worker-chrony-configuration                  3.5.0             169m
100-worker-iommu                                           3.5.0             14s

In OCP v4.20 version 3.5.0 is the default, i guess

[openshift-ci]

@aspauldi: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

[aspauldi]

Hi @sjhala-ccs, I meant to request a merge review on this rather than a peer review. Sorry for any confusion!

[sjhala-ccs]

/cherrypick enterprise-4.18

[sjhala-ccs]

/cherrypick enterprise-4.19

[sjhala-ccs]

/cherrypick enterprise-4.20

[openshift-cherrypick-robot]

@sjhala-ccs: new pull request created: #99880

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]

@sjhala-ccs: new pull request created: #99881

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.

[openshift-cherrypick-robot]

@sjhala-ccs: new pull request created: #99882

In response to this:

/cherrypick enterprise-4.20

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.