Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/about-using-gpu-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@ where:
`<vgpu_container_registry>`:: Specifies the vGPU container registry value.
`<nvidia_vgpu_manager_version>`:: Specifies the version of the vGPU driver you have downloaded from the NVIDIA website and used to build the image.

. Use the NVIDIA GPU Operator to configure mediated devices. For more information see link:https://docs.nvidia.com/datacenter/cloud-native/openshift/latest/openshift-virtualization.html[NVIDIA GPU Operator with OpenShift Virtualization].
. Use the NVIDIA GPU Operator to configure mediated devices. For more information see "NVIDIA GPU Operator with OpenShift Virtualization".
2 changes: 1 addition & 1 deletion modules/install-and-configure-oadp-kubevirt.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[role="_abstract"]
As a cluster administrator, you install {oadp-short} by installing the {oadp-short} Operator.

The latest version of the {oadp-short} Operator installs link:https://velero.io/docs/v{velero-version}[Velero {velero-version}].
The latest version of the {oadp-short} Operator installs Velero {velero-version}.

.Prerequisites

Expand Down
12 changes: 6 additions & 6 deletions modules/migrating-to-virt.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ To migrate virtual machines from an external provider such as {vmw-first}, {rh-o
====

.Prerequisites
* The {mtv-full} Operator link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/{mtv-version}/html/installing_and_using_the_migration_toolkit_for_virtualization/installing-the-operator_mtv#installing-the-operator_mtv[is installed].
* The {mtv-full} Operator is installed.

.Procedure

* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/{mtv-version}/html/installing_and_using_the_migration_toolkit_for_virtualization/migrating-vmware#adding-source-provider_vmware[Migrate virtual machines from {vmw-first}].
* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/{mtv-version}/html/installing_and_using_the_migration_toolkit_for_virtualization/migrating-osp_ostack#adding-source-provider_ostack[Migrate virtual machines from {rh-openstack-first}].
* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/{mtv-version}/html/installing_and_using_the_migration_toolkit_for_virtualization/migrating-rhv_rhv#adding-source-provider_rhv[Migrate virtual machines from Red Hat Virtualization].
* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/{mtv-version}/html/installing_and_using_the_migration_toolkit_for_virtualization/migrating-virt_cnv#adding-source-provider_cnv[Migrate virtual machines from {VirtProductName}].
* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/{mtv-version}/html/installing_and_using_the_migration_toolkit_for_virtualization/migrating-ova_ova#adding-source-provider_ova[Migrate virtual machines from OVA files created by {vmw-full}].
* Migrate virtual machines from {vmw-first}.
* Migrate virtual machines from {rh-openstack-first}.
* Migrate virtual machines from Red Hat Virtualization.
* Migrate virtual machines from {VirtProductName}.
* Migrate virtual machines from OVA files created by {vmw-full}.
2 changes: 1 addition & 1 deletion modules/nw-sriov-additional-network.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ You must enclose the value you specify in quotes or the CR is rejected by the SR
+
[NOTE]
====
Intel NICs do not support the `minTxRate` parameter. For more information, see link:https://bugzilla.redhat.com/show_bug.cgi?id=1772847[BZ#1772847].
Intel NICs do not support the `minTxRate` parameter. For more information, see "BZ#1772847".
====
** `spec.vlanQoS` an optional field that defines the IEEE 802.1p priority level for the VF. The default value is `0`.
** `spec.trust` an optional field that defines the trust mode of the VF. The allowed values are the strings `"on"` and `"off"`.
Expand Down
4 changes: 2 additions & 2 deletions modules/oadp-installing-dpa-1-3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ where:
`namespace`:: Specifies the default namespace for OADP which is `openshift-adp`. The namespace is a variable and is configurable.
`aws`:: Specifies that an object store plugin corresponding to your storage locations is required. For all S3 providers, the required plugin is `aws`. For {azure-short} and {gcp-short} object stores, the `azure` or `gcp` plugin is required.
`kubevirt`:: Optional: The `kubevirt` plugin is used with {VirtProductName}.
`csi`:: Specifies the `csi` default plugin if you use CSI snapshots to back up PVs. The `csi` plugin uses the link:https://{velero-domain}/docs/main/csi/[Velero CSI beta snapshot APIs]. You do not need to configure a snapshot location.
`csi`:: Specifies the `csi` default plugin if you use CSI snapshots to back up PVs. The `csi` plugin uses the Velero CSI beta snapshot APIs. You do not need to configure a snapshot location.
`openshift`:: Specifies that the `openshift` plugin is mandatory.
`resourceTimeout`:: Specifies how many minutes to wait for several Velero resources such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability, before timeout occurs. The default is 10m.
`nodeAgent`:: Specifies the administrative agent that routes the administrative requests to servers.
Expand Down Expand Up @@ -435,7 +435,7 @@ where:
`namespace`:: Specifies the default namespace for OADP which is `openshift-adp`. The namespace is a variable and is configurable.
`kubevirt`:: Specifies that the `kubevirt` plugin is mandatory for {VirtProductName}.
`gcp`:: Specifies the plugin for the backup provider, for example, `gcp`, if it exists.
`csi`:: Specifies that the `csi` plugin is mandatory for backing up PVs with CSI snapshots. The `csi` plugin uses the link:https://{velero-domain}/docs/main/csi/[Velero CSI beta snapshot APIs]. You do not need to configure a snapshot location.
`csi`:: Specifies that the `csi` plugin is mandatory for backing up PVs with CSI snapshots. The `csi` plugin uses the Velero CSI beta snapshot APIs. You do not need to configure a snapshot location.
`openshift`:: Specifies that the `openshift` plugin is mandatory.
`resourceTimeout`:: Specifies how many minutes to wait for several Velero resources such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability, before timeout occurs. The default is 10m.
`nodeAgent`:: Specifies the administrative agent that routes the administrative requests to servers.
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-about-control-plane-only-updates.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ To move between EUS versions, first update {VirtProductName} to the latest z-str
You can update {VirtProductName} directly to the latest z-stream release of your current minor version without applying each intermediate z-stream update.
====

For more information about EUS versions, see the link:https://access.redhat.com/support/policy/updates/openshift[{product-title} Life Cycle Policy].
For more information about EUS versions, see the "{product-title} Life Cycle Policy".
2 changes: 1 addition & 1 deletion modules/virt-about-dr-methods.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[role="_abstract"]
The two primary DR methods for {VirtProductName} are Metropolitan Disaster Recovery (Metro-DR) and Regional-DR.

For an overview of disaster recovery (DR) concepts, architecture, and planning considerations, see the link:https://access.redhat.com/articles/7041594[Red{nbsp}Hat {VirtProductName} disaster recovery guide] in the Red{nbsp}Hat Knowledgebase.
For an overview of disaster recovery (DR) concepts, architecture, and planning considerations, see the "Red{nbsp}Hat {VirtProductName} disaster recovery guide" in the Red{nbsp}Hat Knowledgebase.

[id="metro-dr_{context}"]
== Metro-DR
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-about-storage-volumes-for-vm-disks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
If you use the storage API with known storage providers, the volume and access modes are selected automatically. However, if you use a storage class that does not have a storage profile, you must configure the volume and access mode.

ifndef::openshift-dedicated[]
For a list of known storage providers for {VirtProductName}, see the link:https://catalog.redhat.com/search?searchType=software&badges_and_features=OpenShift+Virtualization&subcategories=Storage[ Red Hat Ecosystem Catalog].
For a list of known storage providers for {VirtProductName}, see the Red Hat Ecosystem Catalog.
endif::openshift-dedicated[]

For best results, use the `ReadWriteMany` (RWX) access mode and the `Block` volume mode. This is important for the following reasons:
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-adding-container-disk-as-cd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can install VirtIO drivers from a container disk that you add to a Windows v

[TIP]
====
Downloading the `container-native-virtualization/virtio-win` container disk from the link:https://catalog.redhat.com/software/containers/search?q=virtio-win&p=1[Red Hat Ecosystem Catalog] is not mandatory, because the container disk is downloaded from the Red Hat registry if it not already present in the cluster. However, downloading reduces the installation time.
Downloading the `container-native-virtualization/virtio-win` container disk from the Red Hat Ecosystem Catalog is not mandatory, because the container disk is downloaded from the Red Hat registry if it not already present in the cluster. However, downloading reduces the installation time.
====

.Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-arm-compatibility.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Before using {VirtProductName} on an ARM64-based system, consider the following

Operating system::
* Only Linux-based guest operating systems are supported.
* All virtualization limitations for {op-system-base} also apply to {VirtProductName}. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_virtualization/assembly_feature-support-and-limitations-in-rhel-9-virtualization_configuring-and-managing-virtualization#how-virtualization-on-arm-64-differs-from-amd64-and-intel64_feature-support-and-limitations-in-rhel-9-virtualization[How virtualization on ARM64 differs from AMD64 and Intel 64] in the {op-system-base} documentation.
* All virtualization limitations for {op-system-base} also apply to {VirtProductName}. For more information, see "How virtualization on ARM64 differs from AMD64 and Intel 64" in the {op-system-base} documentation.

Live migration::
* Live migration is *not supported* on ARM64-based {product-title} clusters.
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-attaching-vm-secondary-network-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ $ oc apply -f example-vm.yaml
+
[NOTE]
====
When running {VirtProductName} on {ibm-z-name} using OSA, RoCE, or HiperSockets interfaces, you must register the MAC address of the device. For more information, see link:https://www.ibm.com/docs/en/linux-on-systems?topic=choices-osa-interface-traffic-forwarding[OSA interface traffic forwarding] (IBM documentation).
When running {VirtProductName} on {ibm-z-name} using OSA, RoCE, or HiperSockets interfaces, you must register the MAC address of the device. For more information, see "OSA interface traffic forwarding" in the IBM documentation.
====
18 changes: 9 additions & 9 deletions modules/virt-cloud-platforms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,28 @@ endif::[]
* Portworx
* FSx (Q3)
* {odf-short}
| * link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/virtualization/index[{VirtProductName}] in the {product-rosa} documentation
* link:https://docs.aws.amazon.com/rosa/latest/userguide/what-is-rosa.html[What is {product-rosa}?] in the {aws-short} documentation
| * {VirtProductName} in the {product-rosa} documentation
* What is {product-rosa}? in the {aws-short} documentation

| {oci-first-no-rt}
| GA
| * {oci} native storage
| * link:https://access.redhat.com/articles/7118050[{VirtProductName} and {oci-first-no-rt} known issues and limitations] in the Red{nbsp}Hat Knowledgebase
* link:https://github.com/oracle-quickstart/oci-openshift/blob/main/docs/openshift-virtualization.md[Installing {VirtProductName} on {oci}] in the `oracle-quickstart/oci-openshift` GitHub repository
| * {VirtProductName} and {oci-first-no-rt} known issues and limitations in the Red{nbsp}Hat Knowledgebase
* Installing {VirtProductName} on {oci} in the `oracle-quickstart/oci-openshift` GitHub repository

| Azure Red{nbsp}Hat OpenShift (ARO)
| GA
| * {odf-short}
| * link:https://learn.microsoft.com/en-us/azure/openshift/howto-create-openshift-virtualization[{VirtProductName} for Azure Red Hat OpenShift (preview)] in the Microsoft documentation
| * {VirtProductName} for Azure Red Hat OpenShift (preview) in the Microsoft documentation

| {gcp-first}
| GA, as of {VirtProductName} 4.21.1
| * {gcp-short} native storage
* {gcp-short} NetApp Volumes (GCNV); requires {VirtProductName} 4.21.2 or later
| * link:https://access.redhat.com/articles/7139046[Storage configuration for {VirtProductName} {product-version}.x on {gcp-full}] in the Red{nbsp}Hat Knowledgebase
* link:https://access.redhat.com/articles/7139682[{VirtProductName} on {gcp-full}: Known issues and limitations] in the Red{nbsp}Hat Knowledgebase
* link:https://access.redhat.com/articles/7141472[Storage configuration for {VirtProductName} with GCNV] in the Red{nbsp}Hat Knowledgebase
* link:https://access.redhat.com/articles/7141471[{VirtProductName} with GCNV: Known errors and limitations] in the Red{nbsp}Hat Knowledgebase
| * Storage configuration for {VirtProductName} {product-version}.x on {gcp-full} in the Red{nbsp}Hat Knowledgebase
* {VirtProductName} on {gcp-full}: Known issues and limitations in the Red{nbsp}Hat Knowledgebase
* Storage configuration for {VirtProductName} with GCNV in the Red{nbsp}Hat Knowledgebase
* {VirtProductName} with GCNV: Known errors and limitations in the Red{nbsp}Hat Knowledgebase

|===

Expand Down
4 changes: 2 additions & 2 deletions modules/virt-cluster-ha-options.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ In {product-title} clusters installed using installer-provisioned infrastructure
Currently, installer-provisioned infrastructure is not supported on {ibm-z-name}.
====

* Automatic high availability for both IPI and non-IPI is available by using the *Node Health Check Operator* on the {product-title} cluster to deploy the `NodeHealthCheck` controller. The controller identifies unhealthy nodes and uses a remediation provider, such as the Self Node Remediation Operator or Fence Agents Remediation Operator, to remediate the unhealthy nodes. For more information on remediation, fencing, and maintaining nodes, see the link:https://access.redhat.com/documentation/en-us/workload_availability_for_red_hat_openshift[Workload Availability for Red Hat OpenShift] documentation.
* Automatic high availability for both IPI and non-IPI is available by using the *Node Health Check Operator* on the {product-title} cluster to deploy the `NodeHealthCheck` controller. The controller identifies unhealthy nodes and uses a remediation provider, such as the Self Node Remediation Operator or Fence Agents Remediation Operator, to remediate the unhealthy nodes. For more information on remediation, fencing, and maintaining nodes, see the "Workload Availability for Red Hat OpenShift" documentation.
+
[NOTE]
====
Fence Agents Remediation uses supported fencing agents to reset failed nodes faster than the Self Node Remediation Operator. This improves overall virtual machine high availability. For more information, see the link:https://access.redhat.com/articles/7057929[{VirtProductName} - Fencing and VM High Availability Guide] knowledgebase article.
Fence Agents Remediation uses supported fencing agents to reset failed nodes faster than the Self Node Remediation Operator. This improves overall virtual machine high availability. For more information, see the "{VirtProductName} - Fencing and VM High Availability Guide" knowledgebase article.
====

* High availability for any platform is available by using either a monitoring system or a qualified human to monitor node availability. When a node is lost, shut it down and run `oc delete node <lost_node>`.
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-collecting-data-about-vms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Collecting data about malfunctioning virtual machines (VMs) minimizes the time r
* For Linux VMs, you have installed the latest QEMU guest agent.
* For Windows VMs, you have:
** Recorded the Windows patch update details.
** link:https://access.redhat.com/solutions/6957701[Installed the latest VirtIO drivers].
** Installed the latest VirtIO drivers.
** Installed the latest QEMU guest agent.
** If Remote Desktop Protocol (RDP) is enabled, you have connected by using the desktop viewer to determine whether there is a problem with the connection software.

Expand Down
12 changes: 6 additions & 6 deletions modules/virt-collecting-data-about-your-environment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Collecting data about your environment minimizes the time required to analyze an
.Prerequisites
//link needs to be added for HCP when available
ifdef::openshift-dedicated,openshift-rosa[]
* You have link:https://docs.redhat.com/en/documentation/monitoring_stack_for_red_hat_openshift/4.21/html/configuring_user_workload_monitoring/storing-and-recording-data-uwm#modifying-retention-time-and-size-for-prometheus-metrics-data_storing-and-recording-data-uwm[set the retention time for Prometheus metrics data] to a minimum of seven days.
* You have link:https://docs.redhat.com/en/documentation/monitoring_stack_for_red_hat_openshift/4.21/html/configuring_user_workload_monitoring/storing-and-recording-data-uwm#modifying-retention-time-and-size-for-prometheus-metrics-data_storing-and-recording-data-uwm[configured the Alertmanager to capture relevant alerts and to send alert notifications to a dedicated mailbox] so that they can be viewed and persisted outside the cluster.
* You have set the retention time for Prometheus metrics data to a minimum of seven days.
* You have configured the Alertmanager to capture relevant alerts and to send alert notifications to a dedicated mailbox so that they can be viewed and persisted outside the cluster.
endif::openshift-dedicated,openshift-rosa[]

ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* You have link:https://docs.redhat.com/en/documentation/monitoring_stack_for_red_hat_openshift/4.21/html/configuring_core_platform_monitoring/storing-and-recording-data#modifying-retention-time-and-size-for-prometheus-metrics-data_storing-and-recording-data[set the retention time for Prometheus metrics data] to a minimum of seven days.
* You have link:https://docs.redhat.com/en/documentation/monitoring_stack_for_red_hat_openshift/4.21/html/configuring_core_platform_monitoring/configuring-alerts-and-notifications[configured the Alertmanager to capture relevant alerts and to send alert notifications to a dedicated mailbox] so that they can be viewed and persisted outside the cluster.
* You have set the retention time for Prometheus metrics data to a minimum of seven days.
* You have configured the Alertmanager to capture relevant alerts and to send alert notifications to a dedicated mailbox so that they can be viewed and persisted outside the cluster.
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* You have recorded the exact number of affected nodes and virtual machines.

Expand All @@ -27,10 +27,10 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
// must-gather not supported for ROSA/OSD, per Dustin Row
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
. Collect must-gather data for the cluster.
. link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/latest/html-single/troubleshooting_openshift_data_foundation/index#downloading-log-files-and-diagnostic-information_rhodf[Collect must-gather data for {rh-storage-first}], if necessary.
. Collect must-gather data for {rh-storage-first}, if necessary.
. Collect must-gather data for {VirtProductName}.
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
ifndef::openshift-rosa-hcp[]
. link:https://docs.redhat.com/en/documentation/monitoring_stack_for_red_hat_openshift/4.21/html/accessing_metrics/accessing-metrics-as-an-administrator#querying-metrics-for-all-projects-with-mon-dashboard_accessing-metrics-as-an-administrator[Collect Prometheus metrics for the cluster].
. Collect Prometheus metrics for the cluster.
endif::openshift-rosa-hcp[]
//link needs to be added for HCP when available
2 changes: 1 addition & 1 deletion modules/virt-cpu-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

CPU requirements for {VirtProductName}::

* Must be supported by {op-system-base-full} 9. See link:https://catalog.redhat.com[Red Hat Ecosystem Catalog] for supported CPUs.
* Must be supported by {op-system-base-full} 9. See Red Hat Ecosystem Catalog for supported CPUs.
+
[NOTE]
====
Expand Down
Loading