From 94efc26817fb42c64c17011b4a1f47db9250d800 Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Fri, 15 May 2026 11:07:02 -0500 Subject: [PATCH 1/4] Fix AsciiDocDITA.ConceptLink warnings in virt assembly files Moved links and cross-references from main content to Additional resources sections in assembly files to fix AsciiDocDITA.ConceptLink warnings. Changes: - Moved external links to Additional resources sections in assemblies - Moved internal cross-references to Additional resources sections in assemblies - Replaced inline links with quoted text in main content - Added or updated Additional resources sections with proper attributes - Added [role="_additional-resources"] and [id="additional-resources_{context}"] attributes where missing Files modified: 23 assembly files - Includes about_virt, backup_restore, creating_vm, managing_vms, post_installation_configuration, and support directories Module files were not modified per OpenShift documentation standards. Additional resources sections should only appear in assembly files. Co-Authored-By: Claude Sonnet 4.5 --- snippets/butane-version.adoc | 8 +++- snippets/technology-preview.adoc | 8 +++- virt/about_virt/about-virt.adoc | 14 +++++-- virt/about_virt/virt-security-policies.adoc | 9 +++-- virt/about_virt/virt-supported-limits.adoc | 3 +- .../virt-backup-restore-overview.adoc | 14 +++++-- .../virt-creating-vms-from-templates.adoc | 11 +++++- .../virt-NUMA-topology.adoc | 5 ++- .../virt-about-multi-queue.adoc | 8 +++- .../virt-assigning-compute-resources.adoc | 3 +- .../virt-configuring-virtual-gpus.adoc | 3 +- .../virt-high-availability-for-vms.adoc | 3 +- virt/managing_vms/virt-accessing-vm-ssh.adoc | 39 ++++++++++++++----- .../virt-controlling-vm-states.adoc | 8 +++- .../virt-customize-web-console.adoc | 4 +- virt/managing_vms/virt-edit-vms.adoc | 3 +- virt/managing_vms/virt-exporting-vms.adoc | 10 ++++- virt/managing_vms/virt-manage-vmis.adoc | 8 +++- ...virt-managing-vms-openshift-pipelines.adoc | 15 ++++--- .../managing_vms/virt-using-vtpm-devices.adoc | 10 ++++- .../virt-hot-plugging-virtual-disks.adoc | 7 +++- .../virt-post-install-config.adoc | 14 +++++-- virt/support/virt-collecting-virt-data.adoc | 3 +- 23 files changed, 163 insertions(+), 47 deletions(-) diff --git a/snippets/butane-version.adoc b/snippets/butane-version.adoc index 90370e693658..820ffa57887c 100644 --- a/snippets/butane-version.adoc +++ b/snippets/butane-version.adoc @@ -14,4 +14,10 @@ :_mod-docs-content-type: SNIPPET -The link:https://coreos.github.io/butane/specs/[Butane version] you specify in the config file should match the {product-title} version and always ends in `0`. For example, `{product-version}.0`. See "Creating machine configs with Butane" for information about Butane. +The "Butane version" you specify in the config file should match the {product-title} version and always ends in `0`. For example, `{product-version}.0`. See "Creating machine configs with Butane" for information about Butane. + +[role="_additional-resources"] +[id="additional-resources_{unknown}"] +== Additional resources + +* link:https://coreos.github.io/butane/specs/[Butane version] diff --git a/snippets/technology-preview.adoc b/snippets/technology-preview.adoc index ae656370ed86..90f64dabce31 100644 --- a/snippets/technology-preview.adoc +++ b/snippets/technology-preview.adoc @@ -10,7 +10,13 @@ [subs="attributes+"] {FeatureName} is a Technology Preview feature only. Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. -For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. +For more information about the support scope of Red Hat Technology Preview features, see "Technology Preview Features Support Scope". ==== // Undefine {FeatureName} attribute, so that any mistakes are easily spotted :!FeatureName: + +[role="_additional-resources"] +[id="additional-resources_{unknown}"] +== Additional resources + +* link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope] diff --git a/virt/about_virt/about-virt.adoc b/virt/about_virt/about-virt.adoc index dfa73f3a5c7c..7428ab044624 100644 --- a/virt/about_virt/about-virt.adoc +++ b/virt/about_virt/about-virt.adoc @@ -14,7 +14,7 @@ include::modules/virt-what-you-can-do-with-virt.adoc[leveloffset=+1] // It is included here in the assembly because of the xref ban. ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -You can use {VirtProductName} with xref:../../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#about-ovn-kubernetes[OVN-Kubernetes] or one of the other certified network plugins listed in link:https://access.redhat.com/articles/5436171[Certified OpenShift CNI Plug-ins]. +You can use {VirtProductName} with "OVN-Kubernetes" or one of the other certified network plugins listed in "Certified OpenShift CNI Plug-ins". endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] @@ -23,15 +23,15 @@ endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] // Hiding links in ROSA/OSD until PR 62384 merges ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -You can check your {VirtProductName} cluster for compliance issues by installing the xref:../../security/compliance_operator/co-concepts/compliance-operator-understanding.adoc#understanding-compliance[Compliance Operator] and running a scan with the `ocp4-moderate` and `ocp4-moderate-node` xref:../../security/compliance_operator/co-scans/compliance-operator-supported-profiles.adoc#compliance-operator-supported-profiles[profiles]. The Compliance Operator uses OpenSCAP, a link:https://www.nist.gov/[NIST-certified tool], to scan and enforce security policies. +You can check your {VirtProductName} cluster for compliance issues by installing the "Compliance Operator" and running a scan with the `ocp4-moderate` and `ocp4-moderate-node` "profiles". The Compliance Operator uses OpenSCAP, a "NIST-certified tool", to scan and enforce security policies. endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -You can check your {VirtProductName} cluster for compliance issues by installing the Compliance Operator and running a scan with the `ocp4-moderate` and `ocp4-moderate-node` profiles. The Compliance Operator uses OpenSCAP, a link:https://www.nist.gov/[NIST-certified tool], to scan and enforce security policies. +You can check your {VirtProductName} cluster for compliance issues by installing the Compliance Operator and running a scan with the `ocp4-moderate` and `ocp4-moderate-node` profiles. The Compliance Operator uses OpenSCAP, a "NIST-certified tool", to scan and enforce security policies. endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ifndef::openshift-dedicated[] -For information about partnering with Independent Software Vendors (ISVs) and Services partners for specialized storage, networking, backup, and additional functionality, see link:https://red.ht/workswithvirt[the Red Hat Ecosystem Catalog]. +For information about partnering with Independent Software Vendors (ISVs) and Services partners for specialized storage, networking, backup, and additional functionality, see "the Red Hat Ecosystem Catalog". endif::openshift-dedicated[] include::modules/virt-vmware-comparison.adoc[leveloffset=+1] @@ -49,6 +49,12 @@ endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [id="additional-resources_about-virt"] == Additional resources +* link:https://access.redhat.com/articles/5436171[Certified OpenShift CNI Plug-ins] +* xref:../../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#about-ovn-kubernetes[OVN-Kubernetes] +* link:https://www.nist.gov/[NIST-certified tool] +* xref:../../security/compliance_operator/co-concepts/compliance-operator-understanding.adoc#understanding-compliance[Compliance Operator] +* xref:../../security/compliance_operator/co-scans/compliance-operator-supported-profiles.adoc#compliance-operator-supported-profiles[profiles] +* link:https://red.ht/workswithvirt[the Red Hat Ecosystem Catalog] ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * xref:../../virt/about_virt/virt-supported-limits.adoc#virt-supported-limits[{VirtProductName} supported limits] * xref:../../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#nw-ovn-kubernetes-purpose_about-ovn-kubernetes[OVN-Kubernetes purpose] diff --git a/virt/about_virt/virt-security-policies.adoc b/virt/about_virt/virt-security-policies.adoc index bec9bf03f075..b4bc705048d3 100644 --- a/virt/about_virt/virt-security-policies.adoc +++ b/virt/about_virt/virt-security-policies.adoc @@ -9,9 +9,9 @@ toc::[] Learn about {VirtProductName} security and authorization. .Key points -* {VirtProductName} adheres to the `restricted` link:https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted[Kubernetes pod security standards] profile, which aims to enforce the current best practices for pod security. +* {VirtProductName} adheres to the `restricted` "Kubernetes pod security standards" profile, which aims to enforce the current best practices for pod security. * Virtual machine (VM) workloads run as unprivileged pods. -* xref:../../authentication/managing-security-context-constraints.adoc#security-context-constraints-about_configuring-internal-oauth[Security context constraints] (SCCs) are defined for the `kubevirt-controller` service account. +* "Security context constraints" (SCCs) are defined for the `kubevirt-controller` service account. * TLS certificates for {VirtProductName} components are renewed and rotated automatically. include::modules/virt-about-workload-security.adoc[leveloffset=+1] @@ -21,7 +21,7 @@ include::modules/virt-automatic-certificates-renewal.adoc[leveloffset=+1] [id="authorization_virt-security-policies"] == Authorization -{VirtProductName} uses xref:../../authentication/using-rbac.adoc#using-rbac[role-based access control] (RBAC) to define permissions for human users and service accounts. The permissions defined for service accounts control the actions that {VirtProductName} components can perform. +{VirtProductName} uses "role-based access control" (RBAC) to define permissions for human users and service accounts. The permissions defined for service accounts control the actions that {VirtProductName} components can perform. You can also use RBAC roles to manage user access to virtualization features. For example, an administrator can create an RBAC role that provides the permissions required to launch a virtual machine. The administrator can then restrict access by binding the role to specific users. @@ -34,6 +34,9 @@ include::modules/virt-additional-scc-for-kubevirt-controller.adoc[leveloffset=+2 [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources +* link:https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted[Kubernetes pod security standards] +* xref:../../authentication/managing-security-context-constraints.adoc#security-context-constraints-about_configuring-internal-oauth[Security context constraints] +* xref:../../authentication/using-rbac.adoc#using-rbac[role-based access control] * xref:../../authentication/managing-security-context-constraints.adoc#security-context-constraints-about_configuring-internal-oauth[Managing security context constraints] * xref:../../authentication/using-rbac.adoc#using-rbac[Using RBAC to define and apply permissions] * xref:../../authentication/using-rbac.adoc#creating-cluster-role_using-rbac[Creating a cluster role] diff --git a/virt/about_virt/virt-supported-limits.adoc b/virt/about_virt/virt-supported-limits.adoc index 924aadf184fd..870b8dbee8bd 100644 --- a/virt/about_virt/virt-supported-limits.adoc +++ b/virt/about_virt/virt-supported-limits.adoc @@ -8,7 +8,7 @@ toc::[] You can refer to tested object maximums when planning your {product-title} environment for {VirtProductName}. However, approaching the maximum values can reduce performance and increase latency. Ensure that you plan for your specific use case and consider all factors that can impact cluster scaling. -For more information about cluster configuration and options that impact performance, see the link:https://access.redhat.com/articles/6994974[{VirtProductName} - Tuning & Scaling Guide] in the Red{nbsp}Hat Knowledgebase. +For more information about cluster configuration and options that impact performance, see the "{VirtProductName} - Tuning & Scaling Guide" in the Red{nbsp}Hat Knowledgebase. include::modules/virt-tested-maximums.adoc[leveloffset=+1] @@ -16,6 +16,7 @@ include::modules/virt-tested-maximums.adoc[leveloffset=+1] [id="additional-resources_{context}"] == Additional resources * link:https://access.redhat.com/articles/6994974[{VirtProductName} - Tuning & Scaling Guide] +* link:https://access.redhat.com/articles/6994974[{VirtProductName} - Tuning & Scaling Guide] * xref:../../scalability_and_performance/planning-your-environment-according-to-object-maximums.adoc#planning-your-environment-according-to-object-maximums[Planning your environment according to object maximums] * xref:../../nodes/nodes/nodes-nodes-managing-max-pods.adoc#nodes-nodes-managing-max-pods[Managing the maximum number of pods per node] * link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes[{rh-rhacm-title} documentation] \ No newline at end of file diff --git a/virt/backup_restore/virt-backup-restore-overview.adoc b/virt/backup_restore/virt-backup-restore-overview.adoc index 25e09addb4a6..e798137dae5e 100644 --- a/virt/backup_restore/virt-backup-restore-overview.adoc +++ b/virt/backup_restore/virt-backup-restore-overview.adoc @@ -17,7 +17,7 @@ Red Hat supports using {VirtProductName} 4.14 or later with {oadp-short} 1.3.x o ==== ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -Back up and restore virtual machines by using the xref:../../backup_and_restore/index.adoc#application-backup-restore-operations-overview[{oadp-full}]. +Back up and restore virtual machines by using the "{oadp-full}". endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] @@ -42,14 +42,14 @@ The following storage options are excluded: * Volume snapshot backup and restore ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -For more information, see xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#oadp-backing-up-applications-restic-doc[Backing up applications with File System Backup: Kopia or Restic]. +For more information, see "Backing up applications with File System Backup: Kopia or Restic". endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ==== To install the {oadp-short} Operator in a restricted network environment, you must first disable the default software catalog sources and mirror the Operator catalog. ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -See xref:../../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments] for details. +See "Using Operator Lifecycle Manager in disconnected environments" for details. endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] include::modules/install-and-configure-oadp-kubevirt.adoc[leveloffset=+1] @@ -69,3 +69,11 @@ include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1] :!provider: :!credentials: :!virt-backup-restore-overview: + +[role="_additional-resources"] +[id="additional-resources_{virt-backup-restore-overview}"] +== Additional resources + +* xref:../../backup_and_restore/index.adoc#application-backup-restore-operations-overview[{oadp-full}] +* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#oadp-backing-up-applications-restic-doc[Backing up applications with File System Backup: Kopia or Restic] +* xref:../../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments] diff --git a/virt/creating_vm/virt-creating-vms-from-templates.adoc b/virt/creating_vm/virt-creating-vms-from-templates.adoc index 1195a35c2aeb..d5b587e61f59 100644 --- a/virt/creating_vm/virt-creating-vms-from-templates.adoc +++ b/virt/creating_vm/virt-creating-vms-from-templates.adoc @@ -16,7 +16,7 @@ You can use VM templates to help you easily create VMs. Expedite creation with boot sources:: You can expedite VM creation by using templates that have an available boot source. Templates with a boot source are labeled *Available boot source* if they do not have a custom label. + -Templates without a boot source are labeled *Boot source required*. See xref:../../virt/storage/virt-automatic-bootsource-updates.adoc#virt-automatic-bootsource-updates[Managing automatic boot source updates] for details. +Templates without a boot source are labeled *Boot source required*. See "Managing automatic boot source updates" for details. Customize before starting the VM:: You can customize the disk source and VM parameters before you start the VM. @@ -24,7 +24,7 @@ You can customize the disk source and VM parameters before you start the VM. + [NOTE] ==== -If you copy a VM template with all its labels and annotations, your version of the template is marked as deprecated when a new version of the Scheduling, Scale, and Performance (SSP) Operator is deployed. You can remove this designation. See xref:../../virt/creating_vm/virt-creating-vms-from-templates.adoc#virt-customizing-vm-template-web_virt-creating-vms-from-templates[Removing a deprecated designation from a customized VM template by using the web console]. +If you copy a VM template with all its labels and annotations, your version of the template is marked as deprecated when a new version of the Scheduling, Scale, and Performance (SSP) Operator is deployed. You can remove this designation. See "Removing a deprecated designation from a customized VM template by using the web console". ==== {sno-caps}:: @@ -37,3 +37,10 @@ include::modules/virt-customizing-vm-template-web.adoc[leveloffset=+1] include::modules/virt-creating-template.adoc[leveloffset=+2] include::modules/virt-dedicated-resources-vm-template.adoc[leveloffset=+2] + +[role="_additional-resources"] +[id="additional-resources_{virt-creating-vms-from-templates}"] +== Additional resources + +* xref:../../virt/storage/virt-automatic-bootsource-updates.adoc#virt-automatic-bootsource-updates[Managing automatic boot source updates] +* xref:../../virt/creating_vm/virt-creating-vms-from-templates.adoc#virt-customizing-vm-template-web_virt-creating-vms-from-templates[Removing a deprecated designation from a customized VM template by using the web console] diff --git a/virt/managing_vms/advanced_vm_management/virt-NUMA-topology.adoc b/virt/managing_vms/advanced_vm_management/virt-NUMA-topology.adoc index 1f5abe40214f..3b84e778382c 100644 --- a/virt/managing_vms/advanced_vm_management/virt-NUMA-topology.adoc +++ b/virt/managing_vms/advanced_vm_management/virt-NUMA-topology.adoc @@ -18,7 +18,7 @@ include::modules/virt-NUMA-prereqs.adoc[leveloffset=+1] [role="_abstract"] VM owners can enable NUMA with `ComputeExclusive` (CX) instance types, which are specifically designed for high-performance, compute-intensive workloads, and are configured to use NUMA features. -For information about creating VMs using a CX instance type, see xref:../../../virt/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[Creating virtual machines from instance types]. +For information about creating VMs using a CX instance type, see "Creating virtual machines from instance types". include::modules/virt-numa-check-config.adoc[leveloffset=+1] @@ -41,5 +41,8 @@ include::modules/virt-NUMA-limitations.adoc[leveloffset=+1] include::modules/virt-NUMA-live-migration.adoc[leveloffset=+1] +[role="_additional-resources"] == Additional resources +[id="additional-resources_{virt-NUMA-topology}"] +* xref:../../../virt/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[Creating virtual machines from instance types] * xref:../../../scalability_and_performance/using-cpu-manager.adoc#using-cpu-manager_topology-manager-policies[Topology Manager policies] diff --git a/virt/managing_vms/advanced_vm_management/virt-about-multi-queue.adoc b/virt/managing_vms/advanced_vm_management/virt-about-multi-queue.adoc index 83e1bce555ed..0d09d1b87354 100644 --- a/virt/managing_vms/advanced_vm_management/virt-about-multi-queue.adoc +++ b/virt/managing_vms/advanced_vm_management/virt-about-multi-queue.adoc @@ -21,6 +21,12 @@ Enabling `virtio-net` multi-queue does not offer significant improvements when t * Message signaled interrupt (MSI) vectors are still consumed if `virtio-net` multi-queue is enabled in the host but not enabled in the guest operating system by the administrator. * Each `virtio-net` queue consumes 64 KiB of kernel memory for the `vhost` driver. -* Starting a VM with more than 16 CPUs results in no connectivity if `networkInterfaceMultiqueue` is set to `true`. (link:https://issues.redhat.com/browse/CNV-16107[CNV-16107]). +* Starting a VM with more than 16 CPUs results in no connectivity if `networkInterfaceMultiqueue` is set to `true`. ("CNV-16107"). include::modules/virt-enabling-multi-queue.adoc[leveloffset=+1] + +[role="_additional-resources"] +[id="additional-resources_{virt-about-multi-queue}"] +== Additional resources + +* link:https://issues.redhat.com/browse/CNV-16107[CNV-16107] diff --git a/virt/managing_vms/advanced_vm_management/virt-assigning-compute-resources.adoc b/virt/managing_vms/advanced_vm_management/virt-assigning-compute-resources.adoc index 9fdf4af286c8..08c552a5edcf 100644 --- a/virt/managing_vms/advanced_vm_management/virt-assigning-compute-resources.adoc +++ b/virt/managing_vms/advanced_vm_management/virt-assigning-compute-resources.adoc @@ -9,7 +9,7 @@ toc::[] [role="_abstract"] In {VirtProductName}, compute resources assigned to virtual machines (VMs) are backed by either guaranteed CPUs or time-sliced CPU shares. -Guaranteed CPUs, also known as CPU reservation, dedicate CPU cores or threads to a specific workload, which makes them unavailable to any other workload. Assigning guaranteed CPUs to a VM ensures that the VM will have sole access to a reserved physical CPU. xref:../../../virt/managing_vms/advanced_vm_management/virt-dedicated-resources-vm.adoc#virt-dedicated-resources-vm[Enable dedicated resources for VMs] to use a guaranteed CPU. +Guaranteed CPUs, also known as CPU reservation, dedicate CPU cores or threads to a specific workload, which makes them unavailable to any other workload. Assigning guaranteed CPUs to a VM ensures that the VM will have sole access to a reserved physical CPU. "Enable dedicated resources for VMs" to use a guaranteed CPU. Time-sliced CPUs dedicate a slice of time on a shared physical CPU to each workload. You can specify the size of the slice during VM creation, or when the VM is offline. By default, each vCPU receives 100 milliseconds, or 1/10 of a second, of physical CPU time. @@ -28,4 +28,5 @@ include::modules/virt-setting-cpu-allocation-ratio.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources +* xref:../../../virt/managing_vms/advanced_vm_management/virt-dedicated-resources-vm.adoc#virt-dedicated-resources-vm[Enable dedicated resources for VMs] * link:https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/[Pod Quality of Service Classes] \ No newline at end of file diff --git a/virt/managing_vms/advanced_vm_management/virt-configuring-virtual-gpus.adoc b/virt/managing_vms/advanced_vm_management/virt-configuring-virtual-gpus.adoc index 23c3af1fed20..c2f64b93e4fc 100644 --- a/virt/managing_vms/advanced_vm_management/virt-configuring-virtual-gpus.adoc +++ b/virt/managing_vms/advanced_vm_management/virt-configuring-virtual-gpus.adoc @@ -25,7 +25,7 @@ You can use the NVIDIA GPU Operator to provision worker nodes for running GPU-ac [NOTE] ==== -The NVIDIA GPU Operator is supported only by NVIDIA. For more information, see link:https://access.redhat.com/solutions/5174941[Obtaining Support from NVIDIA] in the Red Hat Knowledgebase. +The NVIDIA GPU Operator is supported only by NVIDIA. For more information, see "Obtaining Support from NVIDIA" in the Red Hat Knowledgebase. ==== include::modules/about-using-gpu-operator.adoc[leveloffset=+2] @@ -57,4 +57,5 @@ include::modules/virt-assigning-vgpu-vm-web.adoc[leveloffset=+2] [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources +* link:https://access.redhat.com/solutions/5174941[Obtaining Support from NVIDIA] * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_deployment_and_administration_guide/sect-troubleshooting-enabling_intel_vt_x_and_amd_v_virtualization_hardware_extensions_in_bios[Enabling Intel VT-X and AMD-V Virtualization Hardware Extensions in BIOS] diff --git a/virt/managing_vms/advanced_vm_management/virt-high-availability-for-vms.adoc b/virt/managing_vms/advanced_vm_management/virt-high-availability-for-vms.adoc index fdf12c4e4fab..697deddcd51b 100644 --- a/virt/managing_vms/advanced_vm_management/virt-high-availability-for-vms.adoc +++ b/virt/managing_vms/advanced_vm_management/virt-high-availability-for-vms.adoc @@ -21,11 +21,12 @@ endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] You can configure remediating nodes by installing the Self Node Remediation Operator or the Fence Agents Remediation Operator from the software catalog and enabling machine health checks or node remediation checks. -For more information on remediation, fencing, and maintaining nodes, see the link:https://docs.redhat.com/en/documentation/workload_availability_for_red_hat_openshift/24.3[Workload Availability for Red Hat OpenShift] documentation. +For more information on remediation, fencing, and maintaining nodes, see the "Workload Availability for Red Hat OpenShift" documentation. ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources +* link:https://docs.redhat.com/en/documentation/workload_availability_for_red_hat_openshift/24.3[Workload Availability for Red Hat OpenShift] * xref:../../../virt/nodes/virt-eviction-strategies.adoc#virt-delete-failed-node-vm-failover_virt-eviction-strategies[Delete a failed node to trigger virtual machine failover] endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/virt/managing_vms/virt-accessing-vm-ssh.adoc b/virt/managing_vms/virt-accessing-vm-ssh.adoc index c95a97109fbb..965401dd1b54 100644 --- a/virt/managing_vms/virt-accessing-vm-ssh.adoc +++ b/virt/managing_vms/virt-accessing-vm-ssh.adoc @@ -10,21 +10,21 @@ toc::[] [role="_abstract"] You can use SSH to securely access your virtual machines (VMs) from the command line. To set up your SSH configuration, use one of the following methods: -* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#using-virtctl-ssh_virt-accessing-vm-ssh[`virtctl ssh` command] +* "`virtctl ssh` command" + You create an SSH key pair, add the public key to a VM, and connect to the VM by running the `virtctl ssh` command with the private key. + You can add public SSH keys to {op-system-base-full} 9 VMs at runtime or at first boot to VMs with guest operating systems that can be configured by using a cloud-init data source. -* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#virt-using-virtctl-port-forward-command_virt-accessing-vm-ssh[`virtctl port-forward` command] +* "`virtctl port-forward` command" + You add the `virtctl port-foward` command to your `.ssh/config` file and connect to the VM by using OpenSSH. -* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#using-services-ssh_virt-accessing-vm-ssh[Service] +* "Service" + You create a service, associate the service with the VM, and connect to the IP address and port exposed by the service. -* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#using-secondary-networks-ssh_virt-accessing-vm-ssh[Secondary network] +* "Secondary network" + You configure a secondary network, attach a virtual machine (VM) to the secondary network interface, and connect to the DHCP-allocated IP address. @@ -125,7 +125,7 @@ include::modules/virt-creating-service-virtctl.adoc[leveloffset=+3] .Next steps -After you create a service with `virtctl`, you must add `special: key` to the `spec.template.metadata.labels` stanza of the `VirtualMachine` manifest. See xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#virt-creating-service-cli_virt-accessing-vm-ssh[Creating a service by using the command line]. +After you create a service with `virtctl`, you must add `special: key` to the `spec.template.metadata.labels` stanza of the `VirtualMachine` manifest. See "Creating a service by using the command line". include::modules/virt-creating-service-cli.adoc[leveloffset=+3] @@ -141,16 +141,16 @@ You can configure a secondary network, attach a virtual machine (VM) to the seco Secondary networks provide excellent performance because the traffic is not handled by the cluster network stack. However, the VMs are exposed directly to the secondary network and are not protected by firewalls. If a VM is compromised, an intruder could gain access to the secondary network. You must configure appropriate security within the operating system of the VM if you use this method. ==== -See the link:https://access.redhat.com/articles/6994974#networking-multus[Multus] and link:https://access.redhat.com/articles/6994974#networking-sriov[SR-IOV] documentation in the link:https://access.redhat.com/articles/6994974[{VirtProductName} Tuning & Scaling Guide] for additional information about networking options. +See the "Multus" and "SR-IOV" documentation in the "{VirtProductName} Tuning & Scaling Guide" for additional information about networking options. .Prerequisites ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -* You configured a secondary network such as xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Linux bridge] or xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[SR-IOV]. -* You created a network attachment definition for a xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-creating-linux-bridge-nad-web_virt-connecting-vm-to-linux-bridge[Linux bridge network] or the SR-IOV Network Operator created a xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#nw-sriov-additional-network_virt-connecting-vm-to-sriov[network attachment definition] when you created an `SriovNetwork` object. +* You configured a secondary network such as "Linux bridge" or "SR-IOV". +* You created a network attachment definition for a "Linux bridge network" or the SR-IOV Network Operator created a "network attachment definition" when you created an `SriovNetwork` object. endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -* You configured a xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[secondary network]. +* You configured a "secondary network". * You created a network attachment definition. endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] @@ -161,6 +161,25 @@ include::modules/virt-connecting-secondary-network-ssh.adoc[leveloffset=+2] ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [NOTE] ==== -You can also xref:../../virt/vm_networking/virt-accessing-vm-secondary-network-fqdn.adoc#virt-accessing-vm-secondary-network-fqdn[access a VM attached to a secondary network interface by using the cluster FQDN]. +You can also "access a VM attached to a secondary network interface by using the cluster FQDN". ==== endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] + +[role="_additional-resources"] +[id="additional-resources_{virt-accessing-vm-ssh}"] +== Additional resources + +* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#using-virtctl-ssh_virt-accessing-vm-ssh[`virtctl ssh` command] +* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#virt-using-virtctl-port-forward-command_virt-accessing-vm-ssh[`virtctl port-forward` command] +* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#using-services-ssh_virt-accessing-vm-ssh[Service] +* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#using-secondary-networks-ssh_virt-accessing-vm-ssh[Secondary network] +* xref:../../virt/managing_vms/virt-accessing-vm-ssh.adoc#virt-creating-service-cli_virt-accessing-vm-ssh[Creating a service by using the command line] +* link:https://access.redhat.com/articles/6994974#networking-multus[Multus] +* link:https://access.redhat.com/articles/6994974#networking-sriov[SR-IOV] +* link:https://access.redhat.com/articles/6994974[{VirtProductName} Tuning & Scaling Guide] +* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Linux bridge] +* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[SR-IOV] +* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-creating-linux-bridge-nad-web_virt-connecting-vm-to-linux-bridge[Linux bridge network] +* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#nw-sriov-additional-network_virt-connecting-vm-to-sriov[network attachment definition] +* xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[secondary network] +* xref:../../virt/vm_networking/virt-accessing-vm-secondary-network-fqdn.adoc#virt-accessing-vm-secondary-network-fqdn[access a VM attached to a secondary network interface by using the cluster FQDN] diff --git a/virt/managing_vms/virt-controlling-vm-states.adoc b/virt/managing_vms/virt-controlling-vm-states.adoc index de918b43f239..cdee2e53823a 100644 --- a/virt/managing_vms/virt-controlling-vm-states.adoc +++ b/virt/managing_vms/virt-controlling-vm-states.adoc @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] [role="_abstract"] -You can use xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#virt-using-the-cli-tools[`virtctl`] to manage virtual machine states and perform other actions from the CLI. For example, you can use `virtctl` to force stop a VM or expose a port. +You can use "`virtctl`" to manage virtual machine states and perform other actions from the CLI. For example, you can use `virtctl` to force stop a VM or expose a port. You can stop, start, restart, reset, pause, and unpause virtual machines from the web console. @@ -28,3 +28,9 @@ include::modules/virt-pausing-vm-web.adoc[leveloffset=+1] include::modules/virt-unpausing-vm-web.adoc[leveloffset=+1] include::modules/virt-controlling-multiple-vms.adoc[leveloffset=+1] + +[role="_additional-resources"] +[id="additional-resources_{virt-controlling-vm-states}"] +== Additional resources + +* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#virt-using-the-cli-tools[`virtctl`] diff --git a/virt/managing_vms/virt-customize-web-console.adoc b/virt/managing_vms/virt-customize-web-console.adoc index aa986a0f9432..f148880b7d09 100644 --- a/virt/managing_vms/virt-customize-web-console.adoc +++ b/virt/managing_vms/virt-customize-web-console.adoc @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] [role="_abstract"] -As a cluster administrator, you can customize the {product-title} web console by integrating xref:../../web_console/dynamic-plugin/overview-dynamic-plugin.adoc#overview-dynamic-plugin[dynamic plugins]. Virtual machine (VM) owners can then use the actions provided by these plugins from different tabs on the *Virtualization* page. +As a cluster administrator, you can customize the {product-title} web console by integrating "dynamic plugins". Virtual machine (VM) owners can then use the actions provided by these plugins from different tabs on the *Virtualization* page. include::modules/virt-enable-bulk-operations-web-console.adoc[leveloffset=+1] @@ -15,4 +15,6 @@ include::modules/virt-create-custom-console-tabs.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources +[id="additional-resources_{virt-customize-web-console}"] +* xref:../../web_console/dynamic-plugin/overview-dynamic-plugin.adoc#overview-dynamic-plugin[dynamic plugins] * xref:../../web_console/dynamic-plugin/dynamic-plugins-get-started.adoc#dynamic-plugins-get-started[Getting started with dynamic plugins] diff --git a/virt/managing_vms/virt-edit-vms.adoc b/virt/managing_vms/virt-edit-vms.adoc index 7d43be78800d..258d222ab3e9 100644 --- a/virt/managing_vms/virt-edit-vms.adoc +++ b/virt/managing_vms/virt-edit-vms.adoc @@ -11,7 +11,7 @@ You can update virtual machine (VM) configuration details like CPU, memory, and ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -To edit a VM to configure disk sharing by using virtual disks or LUN, see xref:../../virt/managing_vms/virtual_disks/virt-configuring-shared-volumes-for-vms.adoc#virt-configuring-shared-volumes-for-vms[Configuring shared volumes for virtual machines]. +To edit a VM to configure disk sharing by using virtual disks or LUN, see "Configuring shared volumes for virtual machines". endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] include::modules/virt-change-vm-instance-type.adoc[leveloffset=+1] @@ -39,6 +39,7 @@ include::modules/virt-configure-multiple-iothreads.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources +* xref:../../virt/managing_vms/virtual_disks/virt-configuring-shared-volumes-for-vms.adoc#virt-configuring-shared-volumes-for-vms[Configuring shared volumes for virtual machines] * xref:../../nodes/pods/nodes-pods-configmaps.adoc#nodes-pods-configmap-overview_builds-configmaps[Understanding config maps] * xref:../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets-about[Providing sensitive data to pods] * xref:../../authentication/understanding-and-creating-service-accounts.adoc#service-accounts-overview[Understanding and creating service accounts] diff --git a/virt/managing_vms/virt-exporting-vms.adoc b/virt/managing_vms/virt-exporting-vms.adoc index eaa1ecd17a19..4bd699e983f5 100644 --- a/virt/managing_vms/virt-exporting-vms.adoc +++ b/virt/managing_vms/virt-exporting-vms.adoc @@ -11,14 +11,20 @@ Export a virtual machine (VM) and its associated disks to import it into another You create a `VirtualMachineExport` custom resource (CR) by using the command-line interface. -Alternatively, you can use the xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#vm-export-commands_virt-using-the-cli-tools[`virtctl vmexport` command] to create a `VirtualMachineExport` CR and to download exported volumes. +Alternatively, you can use the "`virtctl vmexport` command" to create a `VirtualMachineExport` CR and to download exported volumes. [NOTE] ==== -You can migrate virtual machines between OpenShift Virtualization clusters by using the link:https://access.redhat.com/products/migration-toolkits-virtualization[Migration Toolkit for Virtualization]. +You can migrate virtual machines between OpenShift Virtualization clusters by using the "Migration Toolkit for Virtualization". ==== include::modules/virt-creating-virtualmachineexport.adoc[leveloffset=+1] include::modules/virt-accessing-exported-vm-manifests.adoc[leveloffset=+1] +[role="_additional-resources"] +[id="additional-resources_{virt-exporting-vms}"] +== Additional resources + +* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#vm-export-commands_virt-using-the-cli-tools[`virtctl vmexport` command] +* link:https://access.redhat.com/products/migration-toolkits-virtualization[Migration Toolkit for Virtualization] diff --git a/virt/managing_vms/virt-manage-vmis.adoc b/virt/managing_vms/virt-manage-vmis.adoc index 713812403a80..e74a0cba975d 100644 --- a/virt/managing_vms/virt-manage-vmis.adoc +++ b/virt/managing_vms/virt-manage-vmis.adoc @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] [role="_abstract"] -Manage standalone virtual machine instances (VMIs) that were created independently outside of the {VirtProductName} environment through the web console by using `oc` or xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#virt-using-the-cli-tools[`virtctl`] commands from the command-line interface (CLI). +Manage standalone virtual machine instances (VMIs) that were created independently outside of the {VirtProductName} environment through the web console by using `oc` or "`virtctl`" commands from the command-line interface (CLI). The `virtctl` command provides more virtualization options than the `oc` command. For example, you can use `virtctl` to pause a VM or expose a port. @@ -24,3 +24,9 @@ include::modules/virt-editing-vmis-web.adoc[leveloffset=+1] include::modules/virt-deleting-vmis-cli.adoc[leveloffset=+1] include::modules/virt-deleting-vmis-web.adoc[leveloffset=+1] + +[role="_additional-resources"] +[id="additional-resources_{virt-manage-vmis}"] +== Additional resources + +* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#virt-using-the-cli-tools[`virtctl`] diff --git a/virt/managing_vms/virt-managing-vms-openshift-pipelines.adoc b/virt/managing_vms/virt-managing-vms-openshift-pipelines.adoc index bc05394e528b..1d75a2d7f884 100644 --- a/virt/managing_vms/virt-managing-vms-openshift-pipelines.adoc +++ b/virt/managing_vms/virt-managing-vms-openshift-pipelines.adoc @@ -9,7 +9,7 @@ toc::[] [role="_abstract"] Automate virtual machine (VM) provisioning and management in your CI/CD workflows with {pipelines-shortname} tasks designed for virtualization. These tasks allow you to create, configure, and manipulate VMs and their disks as part of your automated deployment pipelines, streamlining VM lifecycle management. -link:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html[{pipelines-title}] is a Kubernetes-native CI/CD framework that allows developers to design and run each step of the CI/CD pipeline in its own container. +"{pipelines-title}" is a Kubernetes-native CI/CD framework that allows developers to design and run each step of the CI/CD pipeline in its own container. By using {pipelines-shortname} tasks and the example pipeline, you can do the following: @@ -17,23 +17,23 @@ By using {pipelines-shortname} tasks and the example pipeline, you can do the fo * Run commands in VMs. * Manipulate disk images with `libguestfs` tools. -The tasks are located in link:https://artifacthub.io/packages/search?repo=redhat-tekton-tasks&sort=relevance&page=1[the task catalog (ArtifactHub)]. +The tasks are located in "the task catalog (ArtifactHub)". -The example Windows pipeline is located in link:https://artifacthub.io/packages/tekton-pipeline/redhat-pipelines/windows-efi-installer[the pipeline catalog (ArtifactHub)]. +The example Windows pipeline is located in "the pipeline catalog (ArtifactHub)". [id="prerequisites_virt-managing-vms-openshift-pipelines"] == Prerequisites * You have access to an {product-title} cluster with `cluster-admin` permissions. * You have installed the OpenShift CLI (`oc`). -* You have link:https://docs.openshift.com/pipelines/latest/install_config/installing-pipelines.html[installed {pipelines-shortname}]. +* You have "installed {pipelines-shortname}". include::modules/virt-supported-ssp-tasks.adoc[leveloffset=+1] [id="windows-efi-installer-pipeline_{context}"] == Windows EFI installer pipeline -You can run the link:https://artifacthub.io/packages/tekton-pipeline/redhat-pipelines/windows-efi-installer[Windows EFI installer pipeline] by using the web console or CLI. +You can run the "Windows EFI installer pipeline" by using the web console or CLI. The Windows EFI installer pipeline installs Windows 10, Windows 11, or Windows Server 2022 into a new data volume from a Windows installation image (ISO file). A custom answer file is used to run the installation process. @@ -52,5 +52,10 @@ include::modules/virt-deprecated-tasks-web.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_virt-managing-vms-openshift-pipelines"] == Additional resources +* link:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html[{pipelines-title}] +* link:https://artifacthub.io/packages/search?repo=redhat-tekton-tasks&sort=relevance&page=1[the task catalog (ArtifactHub)] +* link:https://artifacthub.io/packages/tekton-pipeline/redhat-pipelines/windows-efi-installer[the pipeline catalog (ArtifactHub)] +* link:https://docs.openshift.com/pipelines/latest/install_config/installing-pipelines.html[installed {pipelines-shortname}] +* link:https://artifacthub.io/packages/tekton-pipeline/redhat-pipelines/windows-efi-installer[Windows EFI installer pipeline] * link:https://docs.openshift.com/pipelines/latest/create/creating-applications-with-cicd-pipelines.html[Creating CI/CD solutions for applications using {pipelines-title}] * xref:../../virt/creating_vms_advanced/virt-creating-vms-uploading-images.adoc#virt-creating-windows-vm_virt-creating-vms-uploading-images[Creating a Windows VM] diff --git a/virt/managing_vms/virt-using-vtpm-devices.adoc b/virt/managing_vms/virt-using-vtpm-devices.adoc index 813c04028d16..5e579f4a1ab4 100644 --- a/virt/managing_vms/virt-using-vtpm-devices.adoc +++ b/virt/managing_vms/virt-using-vtpm-devices.adoc @@ -11,9 +11,17 @@ To run Windows 11 or other workloads that require a Trusted Platform Module, you [IMPORTANT] ==== -With {VirtProductName} 4.18 and newer, you can xref:../../virt/managing_vms/virt-exporting-vms.adoc#virt-exporting-vms[export virtual machines] (VMs) with attached vTPM devices, xref:../../virt/backup_restore/virt-backup-restore-snapshots.adoc#virt-creating-vm-snapshot-cli_virt-backup-restore-snapshots[create snapshots of these VMs], and xref:../../virt/backup_restore/virt-backup-restore-snapshots.adoc#virt-restoring-vm-from-snapshot-cli_virt-backup-restore-snapshots[restore VMs from these snapshots]. However, cloning a VM with a vTPM device attached to it or creating a new VM from its snapshot is not supported. +With {VirtProductName} 4.18 and newer, you can "export virtual machines" (VMs) with attached vTPM devices, "create snapshots of these VMs", and "restore VMs from these snapshots". However, cloning a VM with a vTPM device attached to it or creating a new VM from its snapshot is not supported. ==== include::modules/virt-about-vtpm-devices.adoc[leveloffset=+1] include::modules/virt-adding-vtpm-to-vm.adoc[leveloffset=+1] + +[role="_additional-resources"] +[id="additional-resources_{virt-using-vtpm-devices}"] +== Additional resources + +* xref:../../virt/managing_vms/virt-exporting-vms.adoc#virt-exporting-vms[export virtual machines] +* xref:../../virt/backup_restore/virt-backup-restore-snapshots.adoc#virt-creating-vm-snapshot-cli_virt-backup-restore-snapshots[create snapshots of these VMs] +* xref:../../virt/backup_restore/virt-backup-restore-snapshots.adoc#virt-restoring-vm-from-snapshot-cli_virt-backup-restore-snapshots[restore VMs from these snapshots] diff --git a/virt/managing_vms/virtual_disks/virt-hot-plugging-virtual-disks.adoc b/virt/managing_vms/virtual_disks/virt-hot-plugging-virtual-disks.adoc index 05d47ab76406..115794689580 100644 --- a/virt/managing_vms/virtual_disks/virt-hot-plugging-virtual-disks.adoc +++ b/virt/managing_vms/virtual_disks/virt-hot-plugging-virtual-disks.adoc @@ -17,10 +17,15 @@ A hot plugged disk remains attached to the VM even after reboot. You must unplug ==== Each VM has a `virtio-scsi` controller so that hot plugged disks can use the SCSI bus. The `virtio-scsi` controller overcomes the limitations of VirtIO while retaining its performance advantages. It is highly scalable and supports hot plugging over 4 million disks. -When you hot plug disks to the VirtIO (`virtio-blk`) bus, each disk uses a PCI Express (PCIe) slot in the VM. The number of PCIe slots is limited and pre-set automatically at the VM creation as specified in the link:https://kubevirt.io/user-guide/storage/hotplug_volumes/#available-virtio-ports[Available VirtIO Ports] table. Therefore, you can use `virtio-blk` for a small number of disks that does not exceed the number of available slots. +When you hot plug disks to the VirtIO (`virtio-blk`) bus, each disk uses a PCI Express (PCIe) slot in the VM. The number of PCIe slots is limited and pre-set automatically at the VM creation as specified in the "Available VirtIO Ports" table. Therefore, you can use `virtio-blk` for a small number of disks that does not exceed the number of available slots. ==== include::modules/virt-hot-plugging-disks-ui.adoc[leveloffset=+1] include::modules/virt-hot-plugging-disk-cli.adoc[leveloffset=+1] +[role="_additional-resources"] +[id="additional-resources_{virt-hot-plugging-virtual-disks}"] +== Additional resources + +* link:https://kubevirt.io/user-guide/storage/hotplug_volumes/#available-virtio-ports[Available VirtIO Ports] diff --git a/virt/post_installation_configuration/virt-post-install-config.adoc b/virt/post_installation_configuration/virt-post-install-config.adoc index d4626a8384cf..8dbaa7a72849 100644 --- a/virt/post_installation_configuration/virt-post-install-config.adoc +++ b/virt/post_installation_configuration/virt-post-install-config.adoc @@ -17,9 +17,9 @@ endif::openshift-enterprise[] * The hostpath provisioner is a local storage provisioner designed for {VirtProductName}. If you want to configure local storage for virtual machines, you must enable the hostpath provisioner first. -* xref:../../virt/post_installation_configuration/virt-node-placement-virt-components.adoc#virt-node-placement-virt-components[Node placement rules for {VirtProductName} Operators, workloads, and controllers] +* "Node placement rules for {VirtProductName} Operators, workloads, and controllers" -* xref:../../virt/post_installation_configuration/virt-post-install-network-config.adoc#virt-post-install-network-config[Network configuration]: +* "Network configuration": ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ** Installing the Kubernetes NMState and SR-IOV Operators @@ -32,9 +32,17 @@ ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ** Enabling the creation of load balancer services by using the {product-title} web console endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -* xref:../../virt/post_installation_configuration/virt-post-install-storage-config.adoc#virt-post-install-storage-config[Storage configuration]: +* "Storage configuration": ** Defining a default storage class for the Container Storage Interface (CSI) ** Configuring local storage by using the Hostpath Provisioner (HPP) // * Users // * Alerts and notifications + +[role="_additional-resources"] +[id="additional-resources_{virt-post-install-config}"] +== Additional resources + +* xref:../../virt/post_installation_configuration/virt-node-placement-virt-components.adoc#virt-node-placement-virt-components[Node placement rules for {VirtProductName} Operators, workloads, and controllers] +* xref:../../virt/post_installation_configuration/virt-post-install-network-config.adoc#virt-post-install-network-config[Network configuration] +* xref:../../virt/post_installation_configuration/virt-post-install-storage-config.adoc#virt-post-install-storage-config[Storage configuration] diff --git a/virt/support/virt-collecting-virt-data.adoc b/virt/support/virt-collecting-virt-data.adoc index 19b8ab5b0f85..5716d92b8fd9 100644 --- a/virt/support/virt-collecting-virt-data.adoc +++ b/virt/support/virt-collecting-virt-data.adoc @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] [role="_abstract"] -When you submit a xref:../../support/getting-support.adoc#support-submitting-a-case_getting-support[support case] to Red{nbsp}Hat Support, it is helpful to provide debugging information for {product-title} and {VirtProductName} by using the following tools: +When you submit a "support case" to Red{nbsp}Hat Support, it is helpful to provide debugging information for {product-title} and {VirtProductName} by using the following tools: // must-gather not supported for ROSA/OSD, per Dustin Row ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] @@ -39,6 +39,7 @@ include::modules/virt-generating-a-vm-memory-dump.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources +* xref:../../support/getting-support.adoc#support-submitting-a-case_getting-support[support case] * xref:../../virt/support/virt-support-overview.adoc#virt-support-overview[VM support overview] * link:https://access.redhat.com/solutions/2112[How to provide log files to Red Hat Support (Red Hat Knowledgebase)] ifndef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[] From ef416a805be5a31be0e31e1cf7dd75bcae1bf5ea Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Fri, 15 May 2026 11:21:49 -0500 Subject: [PATCH 2/4] Address PR review comments - Remove duplicate link to Tuning & Scaling Guide - Remove unnecessary quotation marks from inline text - Fix spacing in Additional resources section Fixes based on review feedback from abrennan89. --- virt/about_virt/virt-supported-limits.adoc | 1 - virt/backup_restore/virt-backup-restore-overview.adoc | 2 +- virt/managing_vms/virt-managing-vms-openshift-pipelines.adoc | 2 +- virt/managing_vms/virt-using-vtpm-devices.adoc | 1 - .../virt-post-install-config.adoc | 4 ++-- virt/support/virt-collecting-virt-data.adoc | 2 +- 6 files changed, 5 insertions(+), 7 deletions(-) diff --git a/virt/about_virt/virt-supported-limits.adoc b/virt/about_virt/virt-supported-limits.adoc index 870b8dbee8bd..ed0261ddab59 100644 --- a/virt/about_virt/virt-supported-limits.adoc +++ b/virt/about_virt/virt-supported-limits.adoc @@ -16,7 +16,6 @@ include::modules/virt-tested-maximums.adoc[leveloffset=+1] [id="additional-resources_{context}"] == Additional resources * link:https://access.redhat.com/articles/6994974[{VirtProductName} - Tuning & Scaling Guide] -* link:https://access.redhat.com/articles/6994974[{VirtProductName} - Tuning & Scaling Guide] * xref:../../scalability_and_performance/planning-your-environment-according-to-object-maximums.adoc#planning-your-environment-according-to-object-maximums[Planning your environment according to object maximums] * xref:../../nodes/nodes/nodes-nodes-managing-max-pods.adoc#nodes-nodes-managing-max-pods[Managing the maximum number of pods per node] * link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes[{rh-rhacm-title} documentation] \ No newline at end of file diff --git a/virt/backup_restore/virt-backup-restore-overview.adoc b/virt/backup_restore/virt-backup-restore-overview.adoc index e798137dae5e..695c91e091f1 100644 --- a/virt/backup_restore/virt-backup-restore-overview.adoc +++ b/virt/backup_restore/virt-backup-restore-overview.adoc @@ -17,7 +17,7 @@ Red Hat supports using {VirtProductName} 4.14 or later with {oadp-short} 1.3.x o ==== ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -Back up and restore virtual machines by using the "{oadp-full}". +Back up and restore virtual machines by using the {oadp-full}. endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] diff --git a/virt/managing_vms/virt-managing-vms-openshift-pipelines.adoc b/virt/managing_vms/virt-managing-vms-openshift-pipelines.adoc index 1d75a2d7f884..bb2ae97aec7c 100644 --- a/virt/managing_vms/virt-managing-vms-openshift-pipelines.adoc +++ b/virt/managing_vms/virt-managing-vms-openshift-pipelines.adoc @@ -26,7 +26,7 @@ The example Windows pipeline is located in "the pipeline catalog (ArtifactHub)". * You have access to an {product-title} cluster with `cluster-admin` permissions. * You have installed the OpenShift CLI (`oc`). -* You have "installed {pipelines-shortname}". +* You have installed {pipelines-shortname}. include::modules/virt-supported-ssp-tasks.adoc[leveloffset=+1] diff --git a/virt/managing_vms/virt-using-vtpm-devices.adoc b/virt/managing_vms/virt-using-vtpm-devices.adoc index 5e579f4a1ab4..56484aee54fe 100644 --- a/virt/managing_vms/virt-using-vtpm-devices.adoc +++ b/virt/managing_vms/virt-using-vtpm-devices.adoc @@ -21,7 +21,6 @@ include::modules/virt-adding-vtpm-to-vm.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_{virt-using-vtpm-devices}"] == Additional resources - * xref:../../virt/managing_vms/virt-exporting-vms.adoc#virt-exporting-vms[export virtual machines] * xref:../../virt/backup_restore/virt-backup-restore-snapshots.adoc#virt-creating-vm-snapshot-cli_virt-backup-restore-snapshots[create snapshots of these VMs] * xref:../../virt/backup_restore/virt-backup-restore-snapshots.adoc#virt-restoring-vm-from-snapshot-cli_virt-backup-restore-snapshots[restore VMs from these snapshots] diff --git a/virt/post_installation_configuration/virt-post-install-config.adoc b/virt/post_installation_configuration/virt-post-install-config.adoc index 8dbaa7a72849..498cdea2dc09 100644 --- a/virt/post_installation_configuration/virt-post-install-config.adoc +++ b/virt/post_installation_configuration/virt-post-install-config.adoc @@ -17,9 +17,9 @@ endif::openshift-enterprise[] * The hostpath provisioner is a local storage provisioner designed for {VirtProductName}. If you want to configure local storage for virtual machines, you must enable the hostpath provisioner first. -* "Node placement rules for {VirtProductName} Operators, workloads, and controllers" +* Node placement rules for {VirtProductName} Operators, workloads, and controllers -* "Network configuration": +* Network configuration: ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ** Installing the Kubernetes NMState and SR-IOV Operators diff --git a/virt/support/virt-collecting-virt-data.adoc b/virt/support/virt-collecting-virt-data.adoc index 5716d92b8fd9..394dac08d913 100644 --- a/virt/support/virt-collecting-virt-data.adoc +++ b/virt/support/virt-collecting-virt-data.adoc @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] [role="_abstract"] -When you submit a "support case" to Red{nbsp}Hat Support, it is helpful to provide debugging information for {product-title} and {VirtProductName} by using the following tools: +When you submit a support case to Red{nbsp}Hat Support, it is helpful to provide debugging information for {product-title} and {VirtProductName} by using the following tools: // must-gather not supported for ROSA/OSD, per Dustin Row ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] From 9647f55041256c8b26bb9321a5710403fb3a67d2 Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Fri, 15 May 2026 11:32:10 -0500 Subject: [PATCH 3/4] Process modules and snippets to remove xrefs/links Applied fix-concept-links skill v3 to modules and snippets: - Removed xrefs and links from 38 module/snippet files - Applied proper text formatting (quotation mark rules) - Did NOT add Additional resources sections to modules/snippets - Links removed with context-aware quotation marks: - Explicit references (see, refer to, etc.): use quotes - Inline usage: no quotes Examples of changes: - 'The Operator is installed' (inline, no quotes) - 'see the "Disaster Recovery Guide"' (explicit ref, quotes) Files modified: 38 modules/snippets - modules/migrating-to-virt.adoc - modules/virt-cloud-platforms.adoc - modules/virt-about-dr-methods.adoc - And 35 more module/snippet files This completes the ConceptLink warning fixes across all file types. --- modules/about-using-gpu-operator.adoc | 2 +- .../install-and-configure-oadp-kubevirt.adoc | 2 +- modules/migrating-to-virt.adoc | 12 +- modules/nw-sriov-additional-network.adoc | 2 +- modules/oadp-installing-dpa-1-3.adoc | 4 +- ...virt-about-control-plane-only-updates.adoc | 2 +- modules/virt-about-dr-methods.adoc | 2 +- ...rt-about-storage-volumes-for-vm-disks.adoc | 2 +- modules/virt-adding-container-disk-as-cd.adoc | 2 +- modules/virt-arm-compatibility.adoc | 2 +- ...rt-attaching-vm-secondary-network-cli.adoc | 2 +- modules/virt-cloud-platforms.adoc | 18 +-- modules/virt-cluster-ha-options.adoc | 4 +- modules/virt-collecting-data-about-vms.adoc | 2 +- ...ollecting-data-about-your-environment.adoc | 12 +- modules/virt-cpu-requirements.adoc | 2 +- ...reating-and-exposing-mediated-devices.adoc | 2 +- .../virt-creating-secondary-localnet-udn.adoc | 2 +- modules/virt-creating-windows-vm.adoc | 4 +- ...irt-fusion-access-san-release-updates.adoc | 140 +++++++++--------- modules/virt-generating-a-vm-memory-dump.adoc | 2 +- ...tall-ibm-cloud-cluster-network-access.adoc | 2 +- ...-install-ibm-cloud-config-new-cluster.adoc | 8 +- ...t-label-nodes-with-mig-backed-profile.adoc | 2 +- modules/virt-networking-glossary.adoc | 4 +- ...virt-preparing-container-disk-for-vms.adoc | 2 +- ...-gpu-operands-from-deploying-on-nodes.adoc | 2 +- ...ates-during-control-plane-only-update.adoc | 2 +- modules/virt-querying-metrics.adoc | 2 +- .../virt-specializing-windows-sysprep.adoc | 2 +- modules/virt-support-create-jira-issue.adoc | 2 +- modules/virt-support-submit-support-case.adoc | 2 +- .../virt-supported-custom-video-devices.adoc | 2 +- modules/virt-tested-maximums.adoc | 2 +- modules/virt-uploading-image-virtctl.adoc | 2 +- ...-configure-higher-vm-workload-density.adoc | 2 +- modules/virt-virtio-limitations.adoc | 2 +- modules/virt-what-you-can-do-with-virt.adoc | 4 +- 38 files changed, 129 insertions(+), 137 deletions(-) diff --git a/modules/about-using-gpu-operator.adoc b/modules/about-using-gpu-operator.adoc index 65d0cc06d759..16414fcd6f91 100644 --- a/modules/about-using-gpu-operator.adoc +++ b/modules/about-using-gpu-operator.adoc @@ -76,4 +76,4 @@ where: ``:: Specifies the vGPU container registry value. ``:: 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". diff --git a/modules/install-and-configure-oadp-kubevirt.adoc b/modules/install-and-configure-oadp-kubevirt.adoc index df6285f28664..99214ec359b2 100644 --- a/modules/install-and-configure-oadp-kubevirt.adoc +++ b/modules/install-and-configure-oadp-kubevirt.adoc @@ -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 diff --git a/modules/migrating-to-virt.adoc b/modules/migrating-to-virt.adoc index b98e4f2c1418..6ba53a57ef07 100644 --- a/modules/migrating-to-virt.adoc +++ b/modules/migrating-to-virt.adoc @@ -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}. diff --git a/modules/nw-sriov-additional-network.adoc b/modules/nw-sriov-additional-network.adoc index 20011baf5653..3367626a1320 100644 --- a/modules/nw-sriov-additional-network.adoc +++ b/modules/nw-sriov-additional-network.adoc @@ -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"`. diff --git a/modules/oadp-installing-dpa-1-3.adoc b/modules/oadp-installing-dpa-1-3.adoc index a50037406d98..095a6e937ef2 100644 --- a/modules/oadp-installing-dpa-1-3.adoc +++ b/modules/oadp-installing-dpa-1-3.adoc @@ -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. @@ -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. diff --git a/modules/virt-about-control-plane-only-updates.adoc b/modules/virt-about-control-plane-only-updates.adoc index 4dc84d9f1725..7da5af59932b 100644 --- a/modules/virt-about-control-plane-only-updates.adoc +++ b/modules/virt-about-control-plane-only-updates.adoc @@ -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". diff --git a/modules/virt-about-dr-methods.adoc b/modules/virt-about-dr-methods.adoc index 25fe442fdde3..38c43ab11333 100644 --- a/modules/virt-about-dr-methods.adoc +++ b/modules/virt-about-dr-methods.adoc @@ -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 diff --git a/modules/virt-about-storage-volumes-for-vm-disks.adoc b/modules/virt-about-storage-volumes-for-vm-disks.adoc index 206a769cb9b1..0a31fcda3ec7 100644 --- a/modules/virt-about-storage-volumes-for-vm-disks.adoc +++ b/modules/virt-about-storage-volumes-for-vm-disks.adoc @@ -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: diff --git a/modules/virt-adding-container-disk-as-cd.adoc b/modules/virt-adding-container-disk-as-cd.adoc index 12db1888102a..8572fb6f8f20 100644 --- a/modules/virt-adding-container-disk-as-cd.adoc +++ b/modules/virt-adding-container-disk-as-cd.adoc @@ -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 diff --git a/modules/virt-arm-compatibility.adoc b/modules/virt-arm-compatibility.adoc index ca328c4cbe46..9e473682e5cf 100644 --- a/modules/virt-arm-compatibility.adoc +++ b/modules/virt-arm-compatibility.adoc @@ -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. diff --git a/modules/virt-attaching-vm-secondary-network-cli.adoc b/modules/virt-attaching-vm-secondary-network-cli.adoc index 168af01f5438..e6c6b12af0b7 100644 --- a/modules/virt-attaching-vm-secondary-network-cli.adoc +++ b/modules/virt-attaching-vm-secondary-network-cli.adoc @@ -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" (IBM documentation). ==== \ No newline at end of file diff --git a/modules/virt-cloud-platforms.adoc b/modules/virt-cloud-platforms.adoc index 220191d3ed8d..1691d339615f 100644 --- a/modules/virt-cloud-platforms.adoc +++ b/modules/virt-cloud-platforms.adoc @@ -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 |=== diff --git a/modules/virt-cluster-ha-options.adoc b/modules/virt-cluster-ha-options.adoc index 788eca9f5c6c..06c0d860a5ee 100644 --- a/modules/virt-cluster-ha-options.adoc +++ b/modules/virt-cluster-ha-options.adoc @@ -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 `. diff --git a/modules/virt-collecting-data-about-vms.adoc b/modules/virt-collecting-data-about-vms.adoc index f6291cef8463..314b13c20a36 100644 --- a/modules/virt-collecting-data-about-vms.adoc +++ b/modules/virt-collecting-data-about-vms.adoc @@ -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. diff --git a/modules/virt-collecting-data-about-your-environment.adoc b/modules/virt-collecting-data-about-your-environment.adoc index 484709ad8c30..b36b6a65e9b6 100644 --- a/modules/virt-collecting-data-about-your-environment.adoc +++ b/modules/virt-collecting-data-about-your-environment.adoc @@ -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. @@ -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 diff --git a/modules/virt-cpu-requirements.adoc b/modules/virt-cpu-requirements.adoc index f8a2f3a2879b..468f0e581370 100644 --- a/modules/virt-cpu-requirements.adoc +++ b/modules/virt-cpu-requirements.adoc @@ -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] ==== diff --git a/modules/virt-creating-and-exposing-mediated-devices.adoc b/modules/virt-creating-and-exposing-mediated-devices.adoc index 281458c94a78..2091f05cabb3 100644 --- a/modules/virt-creating-and-exposing-mediated-devices.adoc +++ b/modules/virt-creating-and-exposing-mediated-devices.adoc @@ -14,7 +14,7 @@ As an administrator, you can create mediated devices and expose them to the clus * You installed the {oc-first}. * You enabled the Input-Output Memory Management Unit (IOMMU) driver. * If your hardware vendor provides drivers, you installed them on the nodes where you want to create mediated devices. -** If you use NVIDIA cards, you link:https://docs.nvidia.com/datacenter/cloud-native/openshift/latest/openshift-virtualization.html[installed the NVIDIA GRID driver]. +** If you use NVIDIA cards, you installed the NVIDIA GRID driver. // [IMPORTANT] // ==== diff --git a/modules/virt-creating-secondary-localnet-udn.adoc b/modules/virt-creating-secondary-localnet-udn.adoc index aada8d7883c0..540f68ab64a4 100644 --- a/modules/virt-creating-secondary-localnet-udn.adoc +++ b/modules/virt-creating-secondary-localnet-udn.adoc @@ -45,7 +45,7 @@ spec: + [IMPORTANT] ==== -{VirtProductName} does not support Linux bridge bonding modes 0, 5, and 6. For more information, see link:https://access.redhat.com/solutions/67546[Which bonding modes work when used with a bridge that virtual machine guests or containers connect to?]. +{VirtProductName} does not support Linux bridge bonding modes 0, 5, and 6. For more information, see "Which bonding modes work when used with a bridge that virtual machine guests or containers connect to?". ==== . Apply the `NodeNetworkConfigurationPolicy` manifest by running the following command: diff --git a/modules/virt-creating-windows-vm.adoc b/modules/virt-creating-windows-vm.adoc index 2f2c09d210cd..54b3d2961c1b 100644 --- a/modules/virt-creating-windows-vm.adoc +++ b/modules/virt-creating-windows-vm.adoc @@ -11,8 +11,8 @@ You can create a Windows virtual machine (VM) by uploading a Windows image to a .Prerequisites -* You created a Windows installation DVD or USB with the Windows Media Creation Tool. See link:https://www.microsoft.com/en-us/software-download/windows10[Create Windows 10 installation media] in the Microsoft documentation. -* You created an `autounattend.xml` answer file. See link:https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/update-windows-settings-and-scripts-create-your-own-answer-file-sxs[Answer files (unattend.xml)] in the Microsoft documentation. +* You created a Windows installation DVD or USB with the Windows Media Creation Tool. See "Create Windows 10 installation media" in the Microsoft documentation. +* You created an `autounattend.xml` answer file. See "Answer files (unattend.xml)" in the Microsoft documentation. .Procedure diff --git a/modules/virt-fusion-access-san-release-updates.adoc b/modules/virt-fusion-access-san-release-updates.adoc index 39540a851009..471e536bfe76 100644 --- a/modules/virt-fusion-access-san-release-updates.adoc +++ b/modules/virt-fusion-access-san-release-updates.adoc @@ -1,74 +1,66 @@ -// Module included in the following assemblies: -// -// * virt/fusion_access_SAN/install-configure-fusion-access-san.adoc - -:_mod-docs-content-type: CONCEPT -[id="virt-fusion-access-san-release-updates_{context}"] -= {IBMFusionFirst} release updates - -[role="_abstract"] -Release updates for {IBMFusionFirst}, including new features, bug fixes, and known issues. - -[id="virt-fusion-access-san-new-changes_{context}"] -== New and changed features - -{IBMFusionFirst} 1.1.0 includes Spectrum Scale 5.2.3.5:: - -{IBMFusionFirst} 1.1.0 uses Spectrum Scale version 5.2.3.5. When you upgrade to {IBMFusionFirst} 1.1.0, Spectrum Scale is automatically upgraded to version 5.2.3.5. -+ -link:https://issues.redhat.com/browse/OCPNAS-294[OCPNAS-294] -+ -link:https://issues.redhat.com/browse/OCPNAS-279[OCPNAS-279] - -Backend redesign for `FileSystemClaim` resources:: - -{IBMFusionFirst} updates the backend to use `FileSystemClaim` resources for managing filesystem related objects. Previously, filesystem creation could fail if the process was interrupted. With this update, backend handling improves reliability while keeping the user interface flow and appearance unchanged. -+ -After you upgrade to {IBMFusionFirst} 1.1.0, resources that were created by using the 1.0 user interface are automatically migrated and associated with a `FileSystemClaim` resource. -+ -link:https://issues.redhat.com/browse/OCPNAS-241[OCPNAS-241] - -Automatic creation of `VolumeSnapshotClass` resources for filesystems:: - -{IBMFusionFirst} now creates a `VolumeSnapshotClass` resource alongside the `StorageClass` resource for each filesystem. This ensures that snapshot support is consistently available for newly created filesystems. -+ -After upgrading from {IBMFusionFirst} 1.0 to 1.1.0, a `VolumeSnapshotClass` resource is automatically created for existing filesystems that did not previously have one. -+ -link:https://issues.redhat.com/browse/OCPNAS-293[OCPNAS-293] - -Image registry requirements for kernel module management:: - -{IBMFusionFirst} uses the {product-title} image registry to manage the kernel module. Do not configure the registry to use `emptyDir` storage because it provides only temporary storage and is not suitable for production use. Configure {IBMFusionFirst} to use a different image registry by creating a config map and secret after installing the Operator and before creating the `FusionAccess` CR. -+ -link:https://issues.redhat.com/browse/OCPNAS-213[OCPNAS-213] - -[id="virt-fusion-access-san-bug-fixes_{context}"] -== Bug fixes - -Filesystem creation button stays disabled until daemons are ready:: - -The {IBMFusionFirst} Operator was updated to check the readiness of filesystem daemons before allowing a filesystem to be created. The **Create file system** button in the web console now stays disabled with a tooltip explaining the condition until the environment is ready. This change prevents filesystems from appearing stuck during creation. -+ -link:https://issues.redhat.com/browse/OCPNAS-184[OCPNAS-184] - -Filesystems cannot be deleted from the user interface:: - -The {product-title} web console does not support deleting filesystems. To delete a filesystem, use the {oc-first}. -+ -link:https://issues.redhat.com/browse/OCPNAS-217[OCPNAS-217] - -[id="virt-fusion-access-san-known-issues_{context}"] -== Known issues - -Filesystem creation might fail during core pod deletion:: - -Filesystem creation might fail if core pods are deleted at the same time. The filesystem might be partially created on the LUN, which results in the following persistent error: -+ -[source,terminal] ----- -Disk may still belong to an active file system ----- -+ -No workaround is available. Contact IBM Support for assistance. -+ -link:https://issues.redhat.com/browse/OCPNAS-233[OCPNAS-233] +// Module included in the following assemblies: +// +// * virt/fusion_access_SAN/install-configure-fusion-access-san.adoc + +:_mod-docs-content-type: CONCEPT +[id="virt-fusion-access-san-release-updates_{context}"] += {IBMFusionFirst} release updates + +[role="_abstract"] +Release updates for {IBMFusionFirst}, including new features, bug fixes, and known issues. + +[id="virt-fusion-access-san-new-changes_{context}"] +== New and changed features + +{IBMFusionFirst} 1.1.0 includes Spectrum Scale 5.2.3.5:: + +{IBMFusionFirst} 1.1.0 uses Spectrum Scale version 5.2.3.5. When you upgrade to {IBMFusionFirst} 1.1.0, Spectrum Scale is automatically upgraded to version 5.2.3.5. ++ ++ + +Backend redesign for `FileSystemClaim` resources:: + +{IBMFusionFirst} updates the backend to use `FileSystemClaim` resources for managing filesystem related objects. Previously, filesystem creation could fail if the process was interrupted. With this update, backend handling improves reliability while keeping the user interface flow and appearance unchanged. ++ +After you upgrade to {IBMFusionFirst} 1.1.0, resources that were created by using the 1.0 user interface are automatically migrated and associated with a `FileSystemClaim` resource. ++ + +Automatic creation of `VolumeSnapshotClass` resources for filesystems:: + +{IBMFusionFirst} now creates a `VolumeSnapshotClass` resource alongside the `StorageClass` resource for each filesystem. This ensures that snapshot support is consistently available for newly created filesystems. ++ +After upgrading from {IBMFusionFirst} 1.0 to 1.1.0, a `VolumeSnapshotClass` resource is automatically created for existing filesystems that did not previously have one. ++ + +Image registry requirements for kernel module management:: + +{IBMFusionFirst} uses the {product-title} image registry to manage the kernel module. Do not configure the registry to use `emptyDir` storage because it provides only temporary storage and is not suitable for production use. Configure {IBMFusionFirst} to use a different image registry by creating a config map and secret after installing the Operator and before creating the `FusionAccess` CR. ++ + +[id="virt-fusion-access-san-bug-fixes_{context}"] +== Bug fixes + +Filesystem creation button stays disabled until daemons are ready:: + +The {IBMFusionFirst} Operator was updated to check the readiness of filesystem daemons before allowing a filesystem to be created. The **Create file system** button in the web console now stays disabled with a tooltip explaining the condition until the environment is ready. This change prevents filesystems from appearing stuck during creation. ++ + +Filesystems cannot be deleted from the user interface:: + +The {product-title} web console does not support deleting filesystems. To delete a filesystem, use the {oc-first}. ++ + +[id="virt-fusion-access-san-known-issues_{context}"] +== Known issues + +Filesystem creation might fail during core pod deletion:: + +Filesystem creation might fail if core pods are deleted at the same time. The filesystem might be partially created on the LUN, which results in the following persistent error: ++ +[source,terminal] +---- +Disk may still belong to an active file system +---- ++ +No workaround is available. Contact IBM Support for assistance. ++ diff --git a/modules/virt-generating-a-vm-memory-dump.adoc b/modules/virt-generating-a-vm-memory-dump.adoc index d9bfa60232c4..4ef6ce12f7db 100644 --- a/modules/virt-generating-a-vm-memory-dump.adoc +++ b/modules/virt-generating-a-vm-memory-dump.adoc @@ -44,7 +44,7 @@ $ virtctl memory-dump download --output= . Attach the memory dump to a Red Hat Support case. + -Alternatively, you can inspect the memory dump, for example by using link:https://github.com/volatilityfoundation/volatility3[the volatility3 tool]. +Alternatively, you can inspect the memory dump, for example by using the volatility3 tool. . Optional: Remove the memory dump: + diff --git a/modules/virt-install-ibm-cloud-cluster-network-access.adoc b/modules/virt-install-ibm-cloud-cluster-network-access.adoc index b57830319aa6..63527fbc98d5 100644 --- a/modules/virt-install-ibm-cloud-cluster-network-access.adoc +++ b/modules/virt-install-ibm-cloud-cluster-network-access.adoc @@ -69,7 +69,7 @@ $ systemctl status smb ---- . Configure SSL VPN access to {ibm-cloud-title}: -.. Perform the procedure at link:https://cloud.ibm.com/docs/iaas-vpn?topic=iaas-vpn-getting-started[Getting started with {ibm-cloud-title} Virtual Private Networking] in the {ibm-cloud-title} documentation. +.. Perform the procedure at Getting started with {ibm-cloud-title} Virtual Private Networking in the {ibm-cloud-title} documentation. .. Download and install the MotionPro SSL VPN client. .. Connect to the appropriate {ibm-cloud-title} endpoint: + diff --git a/modules/virt-install-ibm-cloud-config-new-cluster.adoc b/modules/virt-install-ibm-cloud-config-new-cluster.adoc index c3bea45f66d6..9c2953e2b9d5 100644 --- a/modules/virt-install-ibm-cloud-config-new-cluster.adoc +++ b/modules/virt-install-ibm-cloud-config-new-cluster.adoc @@ -11,7 +11,7 @@ Configure and provision the {ibm-cloud-title} environment to establish the opera .Procedure -. Create a new virtual server instance in {ibm-cloud-title} at link:https://cloud.ibm.com/gen1/infrastructure/provision/vs[Virtual Server for Classic] to be the Bastion server. This instance is used to run the installation and provide environment services. +. Create a new virtual server instance in {ibm-cloud-title} at Virtual Server for Classic to be the Bastion server. This instance is used to run the installation and provide environment services. . Change the default properties of the new virtual server instance to the following values. Use the provided defaults for all other values. + @@ -19,9 +19,9 @@ Configure and provision the {ibm-cloud-title} environment to establish the opera * *Operating system:* CentOS * Your public SSH RSA key -. Note the private VLAN and subnet the virtual server instance is assigned to at link:https://cloud.ibm.com/classic/network/vlans[VLANs]. +. Note the private VLAN and subnet the virtual server instance is assigned to at VLANs. -. Provision 6 bare-metal nodes in {ibm-cloud-title} at link:https://cloud.ibm.com/gen1/infrastructure/provision/bm[Bare metal server provision]. Use the following values when provisioning the nodes: +. Provision 6 bare-metal nodes in {ibm-cloud-title} at Bare metal server provision. Use the following values when provisioning the nodes: * *Domain*: A subdomain you can add records to. * *Quantity*: 6 @@ -30,7 +30,7 @@ Configure and provision the {ibm-cloud-title} environment to establish the opera * *Network Interface*: Private * *Private VLAN*: The same as noted for the virtual server instance. -. Confirm all nodes are provisioned and ready at link:https://cloud.ibm.com/gen1/infrastructure/devices[Device list]. +. Confirm all nodes are provisioned and ready at Device list. . Rename the control plane nodes to `control0-`, `control1-`, and `control2-`. Replace `` with the domain used when provisioning the nodes. diff --git a/modules/virt-label-nodes-with-mig-backed-profile.adoc b/modules/virt-label-nodes-with-mig-backed-profile.adoc index 3943c6ac4ee9..e68165760d9a 100644 --- a/modules/virt-label-nodes-with-mig-backed-profile.adoc +++ b/modules/virt-label-nodes-with-mig-backed-profile.adoc @@ -11,7 +11,7 @@ If you have GPUs that support NVIDIA Multi-Instance GPU (MIG), you can select a .Prerequisites -* You have configured vGPU support. For more information see link:https://docs.nvidia.com/datacenter/cloud-native/openshift/latest/mig-ocp.html#[MIG Support in {product-title}]. +* You have configured vGPU support. For more information see "MIG Support in {product-title}". * You have the NVIDIA GPU Operator version 25.10 or higher. * You are using the NVIDIA AI Enterprise (AIE) vGPU Manager image. diff --git a/modules/virt-networking-glossary.adoc b/modules/virt-networking-glossary.adoc index 581e73a29e8f..c5b20c6c29d2 100644 --- a/modules/virt-networking-glossary.adoc +++ b/modules/virt-networking-glossary.adoc @@ -10,7 +10,7 @@ [role="_abstract"] The following terms are used throughout {VirtProductName} documentation. -Container Network Interface (CNI):: A link:https://www.cncf.io/[Cloud Native Computing Foundation] +Container Network Interface (CNI):: A Cloud Native Computing Foundation project, focused on container network connectivity. {VirtProductName} uses CNI plugins to build upon the basic Kubernetes networking functionality. @@ -18,7 +18,7 @@ ifndef::openshift-dedicated[] Multus:: A "meta" CNI plugin that allows multiple CNIs to exist so that a pod or virtual machine can use the interfaces it needs. endif::openshift-dedicated[] -Custom resource definition (CRD):: A link:https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/[Kubernetes] +Custom resource definition (CRD):: A Kubernetes API resource that allows you to define custom resources, or an object defined by using the CRD API resource. `NetworkAttachmentDefinition`:: A CRD introduced by the Multus project that allows you to attach pods, virtual machines, and virtual machine instances to one or more networks. diff --git a/modules/virt-preparing-container-disk-for-vms.adoc b/modules/virt-preparing-container-disk-for-vms.adoc index 7b3c2f6273fc..4bfbe8dce6a9 100644 --- a/modules/virt-preparing-container-disk-for-vms.adoc +++ b/modules/virt-preparing-container-disk-for-vms.adoc @@ -13,7 +13,7 @@ The size of a container disk is limited by the maximum layer size of the registr [NOTE] ==== -For link:https://access.redhat.com/documentation/en-us/red_hat_quay/[{quay}], you can change the maximum layer size by editing the YAML configuration file that is created when {quay} is first deployed. +For {quay}, you can change the maximum layer size by editing the YAML configuration file that is created when {quay} is first deployed. ==== .Prerequisites diff --git a/modules/virt-preventing-nvidia-gpu-operands-from-deploying-on-nodes.adoc b/modules/virt-preventing-nvidia-gpu-operands-from-deploying-on-nodes.adoc index 6134c85bac35..c373ad6723fa 100644 --- a/modules/virt-preventing-nvidia-gpu-operands-from-deploying-on-nodes.adoc +++ b/modules/virt-preventing-nvidia-gpu-operands-from-deploying-on-nodes.adoc @@ -8,7 +8,7 @@ = Preventing NVIDIA GPU operands from deploying on nodes [role="_abstract"] -If you use the link:https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/openshift/contents.html[NVIDIA GPU Operator] in your cluster, you can apply the `nvidia.com/gpu.deploy.operands=false` label to nodes that you do not want to configure for GPU or vGPU operands. This prevents the creation of the pods that configure GPU or vGPU operands and terminates existing pods. +If you use the NVIDIA GPU Operator in your cluster, you can apply the `nvidia.com/gpu.deploy.operands=false` label to nodes that you do not want to configure for GPU or vGPU operands. This prevents the creation of the pods that configure GPU or vGPU operands and terminates existing pods. .Prerequisites diff --git a/modules/virt-preventing-workload-updates-during-control-plane-only-update.adoc b/modules/virt-preventing-workload-updates-during-control-plane-only-update.adoc index 3e154f9571ae..277d3b853c8b 100644 --- a/modules/virt-preventing-workload-updates-during-control-plane-only-update.adoc +++ b/modules/virt-preventing-workload-updates-during-control-plane-only-update.adoc @@ -27,7 +27,7 @@ If the command returns a value greater than `0`, list VMIs with outdated `virt-l $ oc get vmi -l kubevirt.io/outdatedLauncherImage --all-namespaces ---- -For supported {product-title} releases and their {op-system-base} versions, see link:https://access.redhat.com/articles/6907891[{op-system-base} Versions Utilized by {op-system} and {product-title}]. +For supported {product-title} releases and their {op-system-base} versions, see "{op-system-base} Versions Utilized by {op-system} and {product-title}". ==== .Prerequisites diff --git a/modules/virt-querying-metrics.adoc b/modules/virt-querying-metrics.adoc index 80765de1411b..d4dbe0e0fbe4 100644 --- a/modules/virt-querying-metrics.adoc +++ b/modules/virt-querying-metrics.adoc @@ -8,7 +8,7 @@ [role="_abstract"] The following metric descriptions include example Prometheus Query Language (PromQL) queries. These metrics are not an API and might change between versions. -For a complete list of virtualization metrics, see link:https://github.com/kubevirt/monitoring/blob/main/docs/metrics.md[KubeVirt components metrics]. +For a complete list of virtualization metrics, see "KubeVirt components metrics". [NOTE] ==== diff --git a/modules/virt-specializing-windows-sysprep.adoc b/modules/virt-specializing-windows-sysprep.adoc index 050aab02bd8a..cd357cb065d0 100644 --- a/modules/virt-specializing-windows-sysprep.adoc +++ b/modules/virt-specializing-windows-sysprep.adoc @@ -12,7 +12,7 @@ Specializing a Windows virtual machine (VM) configures the computer-specific inf .Prerequisites * You must have a generalized Windows disk image. -* You must create an `unattend.xml` answer file. See the link:https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/update-windows-settings-and-scripts-create-your-own-answer-file-sxs?view=windows-11[Microsoft documentation] for details. +* You must create an `unattend.xml` answer file. See the "Microsoft documentation" for details. .Procedure diff --git a/modules/virt-support-create-jira-issue.adoc b/modules/virt-support-create-jira-issue.adoc index 3489ddd297b8..7d9ce0e77a89 100644 --- a/modules/virt-support-create-jira-issue.adoc +++ b/modules/virt-support-create-jira-issue.adoc @@ -13,7 +13,7 @@ To report an issue with your environment to Red{nbsp}Hat Support, create a Jira . Log in to Red Hat Atlassian Jira. -. Click the following link to open a *Create Issue* page: link:https://redhat.atlassian.net/secure/CreateIssue.jspa[Create issue]. +. Click the following link to open a *Create Issue* page: Create issue. . Select {VirtProductName} (CNV) as the *Project*. diff --git a/modules/virt-support-submit-support-case.adoc b/modules/virt-support-submit-support-case.adoc index e73f8ae5279d..f91ff011232f 100644 --- a/modules/virt-support-submit-support-case.adoc +++ b/modules/virt-support-submit-support-case.adoc @@ -9,4 +9,4 @@ [role="_abstract"] Submit a support case to resolve a cluster issue that is affecting the ability of {VirtProductName} to function properly in your environment. -You can submit a support case to Red{nbsp}Hat Support by using the link:https://access.redhat.com/support/cases/#/case/list[Customer Support] page. Include data that you collected about your issue with your support request. \ No newline at end of file +You can submit a support case to Red{nbsp}Hat Support by using the Customer Support page. Include data that you collected about your issue with your support request. \ No newline at end of file diff --git a/modules/virt-supported-custom-video-devices.adoc b/modules/virt-supported-custom-video-devices.adoc index 213594d529c0..de9952106ade 100644 --- a/modules/virt-supported-custom-video-devices.adoc +++ b/modules/virt-supported-custom-video-devices.adoc @@ -15,7 +15,7 @@ Configuring a custom video device allows you to specify different video devices, ==== Custom video device support is a Technology Preview feature only. Technology Preview features are not supported with Red{nbsp}Hat production service level agreements (SLAs) and might not be functionally complete. Red{nbsp}Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. -For more information about the support scope of Red{nbsp}Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. +For more information about the support scope of Red{nbsp}Hat Technology Preview features, see "Technology Preview Features Support Scope". ==== Using a custom video device provides several advantages: diff --git a/modules/virt-tested-maximums.adoc b/modules/virt-tested-maximums.adoc index f971becc97d3..682094f7aea4 100644 --- a/modules/virt-tested-maximums.adoc +++ b/modules/virt-tested-maximums.adoc @@ -12,7 +12,7 @@ The following limits apply to a large-scale {VirtProductName} 4.x environment. T [id="vm-maximums_{context}"] == Virtual machine maximums -The following maximums apply to virtual machines (VMs) running on {VirtProductName}. These values are subject to the limits specified in link:https://access.redhat.com/articles/rhel-kvm-limits[Virtualization limits for Red Hat{nbsp}Enterprise Linux with KVM]. +The following maximums apply to virtual machines (VMs) running on {VirtProductName}. These values are subject to the limits specified in Virtualization limits for Red Hat{nbsp}Enterprise Linux with KVM. [cols="1,1,1",subs="attributes+"] |=== diff --git a/modules/virt-uploading-image-virtctl.adoc b/modules/virt-uploading-image-virtctl.adoc index 396bb1771698..a7190af64340 100644 --- a/modules/virt-uploading-image-virtctl.adoc +++ b/modules/virt-uploading-image-virtctl.adoc @@ -12,7 +12,7 @@ You can upload an operating system image by using the `virtctl` command-line too .Prerequisites * You must have an `ISO`, `IMG`, or `QCOW2` operating system image file. -* For best performance, compress the image file by using the link:https://libguestfs.org/virt-sparsify.1.html[virt-sparsify] tool or the `xz` or `gzip` utilities. +* For best performance, compress the image file by using the virt-sparsify tool or the `xz` or `gzip` utilities. * The client machine must be configured to trust the {product-title} router's certificate. * You have installed the `virtctl` CLI. diff --git a/modules/virt-using-wasp-agent-to-configure-higher-vm-workload-density.adoc b/modules/virt-using-wasp-agent-to-configure-higher-vm-workload-density.adoc index 177c7b9bca5a..a26fbd3d992e 100644 --- a/modules/virt-using-wasp-agent-to-configure-higher-vm-workload-density.adoc +++ b/modules/virt-using-wasp-agent-to-configure-higher-vm-workload-density.adoc @@ -15,7 +15,7 @@ The `wasp-agent` component is deployed automatically if `memoryOvercommitPercent ==== Swap resources can be only assigned to virtual machine workloads (VM pods) of the `Burstable` Quality of Service (QoS) class. VM pods of the `Guaranteed` QoS class and pods of any QoS class that do not belong to VMs cannot swap resources. -For descriptions of QoS classes, see link:https://kubernetes.io/docs/tasks/configure-pod-container/quality-service-pod/[Configure Quality of Service for Pods] (Kubernetes documentation). +For descriptions of QoS classes, see "Configure Quality of Service for Pods" (Kubernetes documentation). Using `spec.domain.resources.requests.memory` in the VM manifest disables the memory overcommit configuration. Use `spec.domain.memory.guest` instead. ==== diff --git a/modules/virt-virtio-limitations.adoc b/modules/virt-virtio-limitations.adoc index 5c2c3cfc1cf5..02d7b0a4c041 100644 --- a/modules/virt-virtio-limitations.adoc +++ b/modules/virt-virtio-limitations.adoc @@ -13,7 +13,7 @@ Each VirtIO interface uses one of the limited Peripheral Connect Interface (PCI) [NOTE] ==== -The actual number of slots available for hot plugging also depends on the machine type. For example, the default PCI topology for the q35 machine type supports hot plugging one additional PCIe device. For more information on PCI topology and hot plug support, see the link:https://libvirt.org/pci-hotplug.html[libvirt documentation]. +The actual number of slots available for hot plugging also depends on the machine type. For example, the default PCI topology for the q35 machine type supports hot plugging one additional PCIe device. For more information on PCI topology and hot plug support, see the "libvirt documentation". ==== If you restart the VM after hot plugging an interface, that interface becomes part of the standard network interfaces. diff --git a/modules/virt-what-you-can-do-with-virt.adoc b/modules/virt-what-you-can-do-with-virt.adoc index cf8c80866fbc..435d606cee51 100644 --- a/modules/virt-what-you-can-do-with-virt.adoc +++ b/modules/virt-what-you-can-do-with-virt.adoc @@ -20,7 +20,7 @@ You can use it to manage virtual machines (VMs) exclusively or alongside contain ifndef::openshift-origin,openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [NOTE] ==== -If you have a {ove-first} subscription, you can run unlimited VMs on subscribed hosts, but you cannot run application instances in containers. For more information, see the subscription guide section about link:https://www.redhat.com/en/resources/self-managed-openshift-subscription-guide#section-8[{ove-first} and related products]. +If you have a {ove-first} subscription, you can run unlimited VMs on subscribed hosts, but you cannot run application instances in containers. For more information, see the subscription guide section about "{ove-first} and related products". ==== endif::[] @@ -45,7 +45,7 @@ ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [IMPORTANT] ==== -When you deploy {VirtProductName} with {rh-storage}, you must create a dedicated storage class for Windows virtual machine disks. See link:https://access.redhat.com/articles/6978371[Optimizing ODF PersistentVolumes for Windows VMs] for details. +When you deploy {VirtProductName} with {rh-storage}, you must create a dedicated storage class for Windows virtual machine disks. See "Optimizing ODF PersistentVolumes for Windows VMs" for details. ==== endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] From ecb1aa02ab498d939bce4ed7247621bd51861a30 Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Fri, 15 May 2026 11:59:00 -0500 Subject: [PATCH 4/4] Address all PR review comments Fixed quotation mark usage based on reviewer feedback: PATTERN LEARNED: - Specific document TITLES get quotes: "Getting started with X", "OSA interface..." - Generic references NO quotes: "the documentation", "the catalog", "Microsoft documentation" - Product/feature names inline NO quotes: Compliance Operator, NIST-certified tool - Format: "in the X documentation" NOT "(X documentation)" Changes: MODULES (13 files): - Remove quotes from generic references (catalog, documentation) - Add quotes to specific document titles - Change "(X documentation)" to "in the X documentation" - Revert virt-fusion-access-san-release-updates.adoc (fixed in separate PR) SNIPPETS (2 files): - Remove Additional resources sections from butane-version.adoc - Remove Additional resources sections from technology-preview.adoc - Links belong in parent assemblies, not snippets ASSEMBLIES (3 files): - Remove quotes from inline product/feature names - Keep quotes only for specific document titles - OVN-Kubernetes (product) vs "Certified OpenShift CNI Plug-ins" (document) All review comments addressed. --- ...rt-about-storage-volumes-for-vm-disks.adoc | 2 +- ...rt-attaching-vm-secondary-network-cli.adoc | 2 +- modules/virt-cpu-requirements.adoc | 2 +- ...irt-fusion-access-san-release-updates.adoc | 140 +++++++++--------- ...tall-ibm-cloud-cluster-network-access.adoc | 2 +- .../virt-specializing-windows-sysprep.adoc | 2 +- modules/virt-support-create-jira-issue.adoc | 2 +- ...-configure-higher-vm-workload-density.adoc | 2 +- modules/virt-virtio-limitations.adoc | 2 +- modules/virt-what-you-can-do-with-virt.adoc | 2 +- snippets/butane-version.adoc | 8 +- snippets/technology-preview.adoc | 6 - virt/about_virt/about-virt.adoc | 8 +- virt/about_virt/virt-security-policies.adoc | 6 +- .../virt-assigning-compute-resources.adoc | 2 +- 15 files changed, 92 insertions(+), 96 deletions(-) diff --git a/modules/virt-about-storage-volumes-for-vm-disks.adoc b/modules/virt-about-storage-volumes-for-vm-disks.adoc index 0a31fcda3ec7..271471e4d153 100644 --- a/modules/virt-about-storage-volumes-for-vm-disks.adoc +++ b/modules/virt-about-storage-volumes-for-vm-disks.adoc @@ -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 " 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: diff --git a/modules/virt-attaching-vm-secondary-network-cli.adoc b/modules/virt-attaching-vm-secondary-network-cli.adoc index e6c6b12af0b7..e9a87c2d54d0 100644 --- a/modules/virt-attaching-vm-secondary-network-cli.adoc +++ b/modules/virt-attaching-vm-secondary-network-cli.adoc @@ -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 "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. ==== \ No newline at end of file diff --git a/modules/virt-cpu-requirements.adoc b/modules/virt-cpu-requirements.adoc index 468f0e581370..95ff0d14eb6c 100644 --- a/modules/virt-cpu-requirements.adoc +++ b/modules/virt-cpu-requirements.adoc @@ -11,7 +11,7 @@ CPU requirements for {VirtProductName}:: -* Must be supported by {op-system-base-full} 9. See "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] ==== diff --git a/modules/virt-fusion-access-san-release-updates.adoc b/modules/virt-fusion-access-san-release-updates.adoc index 471e536bfe76..39540a851009 100644 --- a/modules/virt-fusion-access-san-release-updates.adoc +++ b/modules/virt-fusion-access-san-release-updates.adoc @@ -1,66 +1,74 @@ -// Module included in the following assemblies: -// -// * virt/fusion_access_SAN/install-configure-fusion-access-san.adoc - -:_mod-docs-content-type: CONCEPT -[id="virt-fusion-access-san-release-updates_{context}"] -= {IBMFusionFirst} release updates - -[role="_abstract"] -Release updates for {IBMFusionFirst}, including new features, bug fixes, and known issues. - -[id="virt-fusion-access-san-new-changes_{context}"] -== New and changed features - -{IBMFusionFirst} 1.1.0 includes Spectrum Scale 5.2.3.5:: - -{IBMFusionFirst} 1.1.0 uses Spectrum Scale version 5.2.3.5. When you upgrade to {IBMFusionFirst} 1.1.0, Spectrum Scale is automatically upgraded to version 5.2.3.5. -+ -+ - -Backend redesign for `FileSystemClaim` resources:: - -{IBMFusionFirst} updates the backend to use `FileSystemClaim` resources for managing filesystem related objects. Previously, filesystem creation could fail if the process was interrupted. With this update, backend handling improves reliability while keeping the user interface flow and appearance unchanged. -+ -After you upgrade to {IBMFusionFirst} 1.1.0, resources that were created by using the 1.0 user interface are automatically migrated and associated with a `FileSystemClaim` resource. -+ - -Automatic creation of `VolumeSnapshotClass` resources for filesystems:: - -{IBMFusionFirst} now creates a `VolumeSnapshotClass` resource alongside the `StorageClass` resource for each filesystem. This ensures that snapshot support is consistently available for newly created filesystems. -+ -After upgrading from {IBMFusionFirst} 1.0 to 1.1.0, a `VolumeSnapshotClass` resource is automatically created for existing filesystems that did not previously have one. -+ - -Image registry requirements for kernel module management:: - -{IBMFusionFirst} uses the {product-title} image registry to manage the kernel module. Do not configure the registry to use `emptyDir` storage because it provides only temporary storage and is not suitable for production use. Configure {IBMFusionFirst} to use a different image registry by creating a config map and secret after installing the Operator and before creating the `FusionAccess` CR. -+ - -[id="virt-fusion-access-san-bug-fixes_{context}"] -== Bug fixes - -Filesystem creation button stays disabled until daemons are ready:: - -The {IBMFusionFirst} Operator was updated to check the readiness of filesystem daemons before allowing a filesystem to be created. The **Create file system** button in the web console now stays disabled with a tooltip explaining the condition until the environment is ready. This change prevents filesystems from appearing stuck during creation. -+ - -Filesystems cannot be deleted from the user interface:: - -The {product-title} web console does not support deleting filesystems. To delete a filesystem, use the {oc-first}. -+ - -[id="virt-fusion-access-san-known-issues_{context}"] -== Known issues - -Filesystem creation might fail during core pod deletion:: - -Filesystem creation might fail if core pods are deleted at the same time. The filesystem might be partially created on the LUN, which results in the following persistent error: -+ -[source,terminal] ----- -Disk may still belong to an active file system ----- -+ -No workaround is available. Contact IBM Support for assistance. -+ +// Module included in the following assemblies: +// +// * virt/fusion_access_SAN/install-configure-fusion-access-san.adoc + +:_mod-docs-content-type: CONCEPT +[id="virt-fusion-access-san-release-updates_{context}"] += {IBMFusionFirst} release updates + +[role="_abstract"] +Release updates for {IBMFusionFirst}, including new features, bug fixes, and known issues. + +[id="virt-fusion-access-san-new-changes_{context}"] +== New and changed features + +{IBMFusionFirst} 1.1.0 includes Spectrum Scale 5.2.3.5:: + +{IBMFusionFirst} 1.1.0 uses Spectrum Scale version 5.2.3.5. When you upgrade to {IBMFusionFirst} 1.1.0, Spectrum Scale is automatically upgraded to version 5.2.3.5. ++ +link:https://issues.redhat.com/browse/OCPNAS-294[OCPNAS-294] ++ +link:https://issues.redhat.com/browse/OCPNAS-279[OCPNAS-279] + +Backend redesign for `FileSystemClaim` resources:: + +{IBMFusionFirst} updates the backend to use `FileSystemClaim` resources for managing filesystem related objects. Previously, filesystem creation could fail if the process was interrupted. With this update, backend handling improves reliability while keeping the user interface flow and appearance unchanged. ++ +After you upgrade to {IBMFusionFirst} 1.1.0, resources that were created by using the 1.0 user interface are automatically migrated and associated with a `FileSystemClaim` resource. ++ +link:https://issues.redhat.com/browse/OCPNAS-241[OCPNAS-241] + +Automatic creation of `VolumeSnapshotClass` resources for filesystems:: + +{IBMFusionFirst} now creates a `VolumeSnapshotClass` resource alongside the `StorageClass` resource for each filesystem. This ensures that snapshot support is consistently available for newly created filesystems. ++ +After upgrading from {IBMFusionFirst} 1.0 to 1.1.0, a `VolumeSnapshotClass` resource is automatically created for existing filesystems that did not previously have one. ++ +link:https://issues.redhat.com/browse/OCPNAS-293[OCPNAS-293] + +Image registry requirements for kernel module management:: + +{IBMFusionFirst} uses the {product-title} image registry to manage the kernel module. Do not configure the registry to use `emptyDir` storage because it provides only temporary storage and is not suitable for production use. Configure {IBMFusionFirst} to use a different image registry by creating a config map and secret after installing the Operator and before creating the `FusionAccess` CR. ++ +link:https://issues.redhat.com/browse/OCPNAS-213[OCPNAS-213] + +[id="virt-fusion-access-san-bug-fixes_{context}"] +== Bug fixes + +Filesystem creation button stays disabled until daemons are ready:: + +The {IBMFusionFirst} Operator was updated to check the readiness of filesystem daemons before allowing a filesystem to be created. The **Create file system** button in the web console now stays disabled with a tooltip explaining the condition until the environment is ready. This change prevents filesystems from appearing stuck during creation. ++ +link:https://issues.redhat.com/browse/OCPNAS-184[OCPNAS-184] + +Filesystems cannot be deleted from the user interface:: + +The {product-title} web console does not support deleting filesystems. To delete a filesystem, use the {oc-first}. ++ +link:https://issues.redhat.com/browse/OCPNAS-217[OCPNAS-217] + +[id="virt-fusion-access-san-known-issues_{context}"] +== Known issues + +Filesystem creation might fail during core pod deletion:: + +Filesystem creation might fail if core pods are deleted at the same time. The filesystem might be partially created on the LUN, which results in the following persistent error: ++ +[source,terminal] +---- +Disk may still belong to an active file system +---- ++ +No workaround is available. Contact IBM Support for assistance. ++ +link:https://issues.redhat.com/browse/OCPNAS-233[OCPNAS-233] diff --git a/modules/virt-install-ibm-cloud-cluster-network-access.adoc b/modules/virt-install-ibm-cloud-cluster-network-access.adoc index 63527fbc98d5..09f826ea360a 100644 --- a/modules/virt-install-ibm-cloud-cluster-network-access.adoc +++ b/modules/virt-install-ibm-cloud-cluster-network-access.adoc @@ -69,7 +69,7 @@ $ systemctl status smb ---- . Configure SSL VPN access to {ibm-cloud-title}: -.. Perform the procedure at Getting started with {ibm-cloud-title} Virtual Private Networking in the {ibm-cloud-title} documentation. +.. Perform the procedure at "Getting started with {ibm-cloud-title} Virtual Private Networking" in the {ibm-cloud-title} documentation. .. Download and install the MotionPro SSL VPN client. .. Connect to the appropriate {ibm-cloud-title} endpoint: + diff --git a/modules/virt-specializing-windows-sysprep.adoc b/modules/virt-specializing-windows-sysprep.adoc index cd357cb065d0..3c9a6e2b8c3c 100644 --- a/modules/virt-specializing-windows-sysprep.adoc +++ b/modules/virt-specializing-windows-sysprep.adoc @@ -12,7 +12,7 @@ Specializing a Windows virtual machine (VM) configures the computer-specific inf .Prerequisites * You must have a generalized Windows disk image. -* You must create an `unattend.xml` answer file. See the "Microsoft documentation" for details. +* You must create an `unattend.xml` answer file. See the Microsoft documentation for details. .Procedure diff --git a/modules/virt-support-create-jira-issue.adoc b/modules/virt-support-create-jira-issue.adoc index 7d9ce0e77a89..110d4acadbe7 100644 --- a/modules/virt-support-create-jira-issue.adoc +++ b/modules/virt-support-create-jira-issue.adoc @@ -13,7 +13,7 @@ To report an issue with your environment to Red{nbsp}Hat Support, create a Jira . Log in to Red Hat Atlassian Jira. -. Click the following link to open a *Create Issue* page: Create issue. +. Open the *Create Issue* page. . Select {VirtProductName} (CNV) as the *Project*. diff --git a/modules/virt-using-wasp-agent-to-configure-higher-vm-workload-density.adoc b/modules/virt-using-wasp-agent-to-configure-higher-vm-workload-density.adoc index a26fbd3d992e..f73ebf7b3171 100644 --- a/modules/virt-using-wasp-agent-to-configure-higher-vm-workload-density.adoc +++ b/modules/virt-using-wasp-agent-to-configure-higher-vm-workload-density.adoc @@ -15,7 +15,7 @@ The `wasp-agent` component is deployed automatically if `memoryOvercommitPercent ==== Swap resources can be only assigned to virtual machine workloads (VM pods) of the `Burstable` Quality of Service (QoS) class. VM pods of the `Guaranteed` QoS class and pods of any QoS class that do not belong to VMs cannot swap resources. -For descriptions of QoS classes, see "Configure Quality of Service for Pods" (Kubernetes documentation). +For descriptions of QoS classes, see "Configure Quality of Service for Pods" in the Kubernetes documentation. Using `spec.domain.resources.requests.memory` in the VM manifest disables the memory overcommit configuration. Use `spec.domain.memory.guest` instead. ==== diff --git a/modules/virt-virtio-limitations.adoc b/modules/virt-virtio-limitations.adoc index 02d7b0a4c041..e0edc50d87c6 100644 --- a/modules/virt-virtio-limitations.adoc +++ b/modules/virt-virtio-limitations.adoc @@ -13,7 +13,7 @@ Each VirtIO interface uses one of the limited Peripheral Connect Interface (PCI) [NOTE] ==== -The actual number of slots available for hot plugging also depends on the machine type. For example, the default PCI topology for the q35 machine type supports hot plugging one additional PCIe device. For more information on PCI topology and hot plug support, see the "libvirt documentation". +The actual number of slots available for hot plugging also depends on the machine type. For example, the default PCI topology for the q35 machine type supports hot plugging one additional PCIe device. For more information on PCI topology and hot plug support, see the libvirt documentation. ==== If you restart the VM after hot plugging an interface, that interface becomes part of the standard network interfaces. diff --git a/modules/virt-what-you-can-do-with-virt.adoc b/modules/virt-what-you-can-do-with-virt.adoc index 435d606cee51..ca5584b3c93e 100644 --- a/modules/virt-what-you-can-do-with-virt.adoc +++ b/modules/virt-what-you-can-do-with-virt.adoc @@ -20,7 +20,7 @@ You can use it to manage virtual machines (VMs) exclusively or alongside contain ifndef::openshift-origin,openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [NOTE] ==== -If you have a {ove-first} subscription, you can run unlimited VMs on subscribed hosts, but you cannot run application instances in containers. For more information, see the subscription guide section about "{ove-first} and related products". +If you have a {ove-first} subscription, you can run unlimited VMs on subscribed hosts, but you cannot run application instances in containers. For more information, see the subscription guide section about {ove-first} and related products. ==== endif::[] diff --git a/snippets/butane-version.adoc b/snippets/butane-version.adoc index 820ffa57887c..73acda4350ae 100644 --- a/snippets/butane-version.adoc +++ b/snippets/butane-version.adoc @@ -14,10 +14,4 @@ :_mod-docs-content-type: SNIPPET -The "Butane version" you specify in the config file should match the {product-title} version and always ends in `0`. For example, `{product-version}.0`. See "Creating machine configs with Butane" for information about Butane. - -[role="_additional-resources"] -[id="additional-resources_{unknown}"] -== Additional resources - -* link:https://coreos.github.io/butane/specs/[Butane version] +The Butane version you specify in the config file should match the {product-title} version and always ends in `0`. For example, `{product-version}.0`. See "Creating machine configs with Butane" for information about Butane. diff --git a/snippets/technology-preview.adoc b/snippets/technology-preview.adoc index 90f64dabce31..75a0aea0ff12 100644 --- a/snippets/technology-preview.adoc +++ b/snippets/technology-preview.adoc @@ -14,9 +14,3 @@ For more information about the support scope of Red Hat Technology Preview featu ==== // Undefine {FeatureName} attribute, so that any mistakes are easily spotted :!FeatureName: - -[role="_additional-resources"] -[id="additional-resources_{unknown}"] -== Additional resources - -* link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope] diff --git a/virt/about_virt/about-virt.adoc b/virt/about_virt/about-virt.adoc index 7428ab044624..086e36e4dd0a 100644 --- a/virt/about_virt/about-virt.adoc +++ b/virt/about_virt/about-virt.adoc @@ -14,7 +14,7 @@ include::modules/virt-what-you-can-do-with-virt.adoc[leveloffset=+1] // It is included here in the assembly because of the xref ban. ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -You can use {VirtProductName} with "OVN-Kubernetes" or one of the other certified network plugins listed in "Certified OpenShift CNI Plug-ins". +You can use {VirtProductName} with OVN-Kubernetes or one of the other certified network plugins listed in "Certified OpenShift CNI Plug-ins". endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] @@ -23,15 +23,15 @@ endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] // Hiding links in ROSA/OSD until PR 62384 merges ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -You can check your {VirtProductName} cluster for compliance issues by installing the "Compliance Operator" and running a scan with the `ocp4-moderate` and `ocp4-moderate-node` "profiles". The Compliance Operator uses OpenSCAP, a "NIST-certified tool", to scan and enforce security policies. +You can check your {VirtProductName} cluster for compliance issues by installing the Compliance Operator and running a scan with the `ocp4-moderate` and `ocp4-moderate-node` profiles. The Compliance Operator uses OpenSCAP, a NIST-certified tool, to scan and enforce security policies. endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] -You can check your {VirtProductName} cluster for compliance issues by installing the Compliance Operator and running a scan with the `ocp4-moderate` and `ocp4-moderate-node` profiles. The Compliance Operator uses OpenSCAP, a "NIST-certified tool", to scan and enforce security policies. +You can check your {VirtProductName} cluster for compliance issues by installing the Compliance Operator and running a scan with the `ocp4-moderate` and `ocp4-moderate-node` profiles. The Compliance Operator uses OpenSCAP, a NIST-certified tool, to scan and enforce security policies. endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] ifndef::openshift-dedicated[] -For information about partnering with Independent Software Vendors (ISVs) and Services partners for specialized storage, networking, backup, and additional functionality, see "the Red Hat Ecosystem Catalog". +For information about partnering with Independent Software Vendors (ISVs) and Services partners for specialized storage, networking, backup, and additional functionality, see the Red Hat Ecosystem Catalog. endif::openshift-dedicated[] include::modules/virt-vmware-comparison.adoc[leveloffset=+1] diff --git a/virt/about_virt/virt-security-policies.adoc b/virt/about_virt/virt-security-policies.adoc index b4bc705048d3..80d2b099b951 100644 --- a/virt/about_virt/virt-security-policies.adoc +++ b/virt/about_virt/virt-security-policies.adoc @@ -9,9 +9,9 @@ toc::[] Learn about {VirtProductName} security and authorization. .Key points -* {VirtProductName} adheres to the `restricted` "Kubernetes pod security standards" profile, which aims to enforce the current best practices for pod security. +* {VirtProductName} adheres to the `restricted` Kubernetes pod security standards profile, which aims to enforce the current best practices for pod security. * Virtual machine (VM) workloads run as unprivileged pods. -* "Security context constraints" (SCCs) are defined for the `kubevirt-controller` service account. +* Security context constraints (SCCs) are defined for the `kubevirt-controller` service account. * TLS certificates for {VirtProductName} components are renewed and rotated automatically. include::modules/virt-about-workload-security.adoc[leveloffset=+1] @@ -21,7 +21,7 @@ include::modules/virt-automatic-certificates-renewal.adoc[leveloffset=+1] [id="authorization_virt-security-policies"] == Authorization -{VirtProductName} uses "role-based access control" (RBAC) to define permissions for human users and service accounts. The permissions defined for service accounts control the actions that {VirtProductName} components can perform. +{VirtProductName} uses role-based access control (RBAC) to define permissions for human users and service accounts. The permissions defined for service accounts control the actions that {VirtProductName} components can perform. You can also use RBAC roles to manage user access to virtualization features. For example, an administrator can create an RBAC role that provides the permissions required to launch a virtual machine. The administrator can then restrict access by binding the role to specific users. diff --git a/virt/managing_vms/advanced_vm_management/virt-assigning-compute-resources.adoc b/virt/managing_vms/advanced_vm_management/virt-assigning-compute-resources.adoc index 08c552a5edcf..1a44b971bfd5 100644 --- a/virt/managing_vms/advanced_vm_management/virt-assigning-compute-resources.adoc +++ b/virt/managing_vms/advanced_vm_management/virt-assigning-compute-resources.adoc @@ -9,7 +9,7 @@ toc::[] [role="_abstract"] In {VirtProductName}, compute resources assigned to virtual machines (VMs) are backed by either guaranteed CPUs or time-sliced CPU shares. -Guaranteed CPUs, also known as CPU reservation, dedicate CPU cores or threads to a specific workload, which makes them unavailable to any other workload. Assigning guaranteed CPUs to a VM ensures that the VM will have sole access to a reserved physical CPU. "Enable dedicated resources for VMs" to use a guaranteed CPU. +Guaranteed CPUs, also known as CPU reservation, dedicate CPU cores or threads to a specific workload, which makes them unavailable to any other workload. Assigning guaranteed CPUs to a VM ensures that the VM will have sole access to a reserved physical CPU. Enable dedicated resources for VMs to use a guaranteed CPU. Time-sliced CPUs dedicate a slice of time on a shared physical CPU to each workload. You can specify the size of the slice during VM creation, or when the VM is offline. By default, each vCPU receives 100 milliseconds, or 1/10 of a second, of physical CPU time.