OSDOCS-12568 virt book integration

Author: xJustin

_topic_maps/_topic_map_rosa_hcp.yml

@@ -1352,3 +1352,301 @@ Topics:
       File: logging-5-6-reference
   - Name: Glossary
     File: logging-common-terms
+---
+Name: Virtualization
+Dir: virt
+Distros: openshift-rosa-hcp
+Topics:
+- Name: About
+  Dir: about_virt
+  Topics:
+  - Name: About OpenShift Virtualization
+    File: about-virt
+    Distros: openshift-rosa-hcp
+  - Name: About OKD Virtualization
+    File: about-virt
+    Distros: openshift-origin
+  - Name: Security policies
+    File: virt-security-policies
+  - Name: Architecture
+    File: virt-architecture
+    Distros: openshift-rosa-hcp
+#- Name: Release notes
+#  Dir: release_notes
+#  Topics:
+#  - Name: OpenShift Virtualization release notes
+#    File: virt-release-notes-placeholder
+#    Distros: openshift-rosa
+- Name: Getting started
+  Dir: getting_started
+  Topics:
+  - Name: Getting started with OpenShift Virtualization
+    File: virt-getting-started
+    Distros: openshift-rosa-hcp
+  - Name: Getting started with OKD Virtualization
+    File: virt-getting-started
+    Distros: openshift-origin
+  - Name: virtctl and libguestfs
+    File: virt-using-the-cli-tools
+    Distros: openshift-rosa-hcp
+- Name: Installing
+  Dir: install
+  Topics:
+  - Name: Preparing your cluster
+    File: preparing-cluster-for-virt
+  - Name: Installing OpenShift Virtualization
+    File: installing-virt
+  - Name: Uninstalling OpenShift Virtualization
+    File: uninstalling-virt
+- Name: Post-installation configuration
+  Dir: post_installation_configuration
+  Topics:
+  - Name: Post-installation configuration
+    File: virt-post-install-config
+  - Name: Node placement rules
+    File: virt-node-placement-virt-components
+  - Name: Network configuration
+    File: virt-post-install-network-config
+  - Name: Storage configuration
+    File: virt-post-install-storage-config
+  - Name: Configuring certificate rotation
+    File: virt-configuring-certificate-rotation
+- Name: Updating
+  Dir: updating
+  Topics:
+  - Name: Updating OpenShift Virtualization
+    File: upgrading-virt
+    Distros: openshift-rosa-hcp
+- Name: Creating a virtual machine
+  Dir: creating_vm
+  Topics:
+#  - Name: Overview
+#    File: virt-basic-vm-overview
+#  - Name: Setting up your environment
+#    File: virt-setting-up-environment
+  - Name: Creating VMs from instance types
+    File: virt-creating-vms-from-instance-types
+  - Name: Creating VMs from templates
+    File: virt-creating-vms-from-templates
+- Name: Advanced VM creation
+  Dir: creating_vms_advanced
+  Topics:
+#  - Name: Overview
+#    File: virt-advanced-vm-overview
+  - Name: Creating VMs in the web console
+    Dir: creating_vms_advanced_web
+    Topics:
+    - Name: Creating VMs from Red Hat images
+      File: virt-creating-vms-from-rh-images-overview
+    - Name: Creating VMs by importing images from web pages
+      File: virt-creating-vms-from-web-images
+    - Name: Creating VMs by uploading images
+      File: virt-creating-vms-uploading-images
+    - Name: Cloning VMs
+      File: virt-cloning-vms
+  - Name: Creating VMs using the CLI
+    Dir: creating_vms_cli
+    Topics:
+    - Name: Creating virtual machines from the command line
+      File: virt-creating-vms-from-cli
+    - Name: Creating VMs by using container disks
+      File: virt-creating-vms-from-container-disks
+    - Name: Creating VMs by cloning PVCs
+      File: virt-creating-vms-by-cloning-pvcs
+- Name: Managing VMs
+  Dir: managing_vms
+  Topics:
+  - Name: Installing the QEMU guest agent and VirtIO drivers
+    File: virt-installing-qemu-guest-agent
+  - Name: Connecting to VM consoles
+    File: virt-accessing-vm-consoles
+  - Name: Configuring SSH access to VMs
+    File: virt-accessing-vm-ssh
+  - Name: Editing virtual machines
+    File: virt-edit-vms
+  - Name: Editing boot order
+    File: virt-edit-boot-order
+  - Name: Deleting virtual machines
+    File: virt-delete-vms
+  - Name: Exporting virtual machines
+    File: virt-exporting-vms
+  - Name: Managing virtual machine instances
+    File: virt-manage-vmis
+  - Name: Controlling virtual machine states
+    File: virt-controlling-vm-states
+  - Name: Using virtual Trusted Platform Module devices
+    File: virt-using-vtpm-devices
+  - Name: Managing virtual machines with OpenShift Pipelines
+    File: virt-managing-vms-openshift-pipelines
+  - Name: Advanced virtual machine management
+    Dir: advanced_vm_management
+    Topics:
+    - Name: Working with resource quotas for virtual machines
+      File: virt-working-with-resource-quotas-for-vms
+    - Name: Specifying nodes for virtual machines
+      File: virt-specifying-nodes-for-vms
+    - Name: Configuring the default CPU model
+      File: virt-configuring-default-cpu-model
+    - Name: UEFI mode for virtual machines
+      File: virt-uefi-mode-for-vms
+    - Name: Configuring PXE booting for virtual machines
+      File: virt-configuring-pxe-booting
+# Huge pages not supported in ROSA
+#   - Name: Using huge pages with virtual machines
+#     File: virt-using-huge-pages-with-vms
+# CPU Manager not supported in ROSA
+#   - Name: Enabling dedicated resources for a virtual machine
+#     File: virt-dedicated-resources-vm
+    - Name: Scheduling virtual machines
+      File: virt-schedule-vms
+# Cannot create required machine config in ROSA as required
+#   - Name: Configuring PCI passthrough
+#     File: virt-configuring-pci-passthrough
+# Cannot create required machine config in ROSA as required
+#   - Name: Configuring virtual GPUs
+#     File: virt-configuring-virtual-gpus
+# Feature is TP, thus not supported in ROSA
+#   - Name: Enabling descheduler evictions on virtual machines
+#     File: virt-enabling-descheduler-evictions
+    - Name: About high availability for virtual machines
+      File: virt-high-availability-for-vms
+    - Name: Control plane tuning
+      File: virt-vm-control-plane-tuning
+# Need to review following are supported:
+#   - Name: Assigning compute resources
+#     File: virt-assigning-compute-resources
+#   - Name: About multi-queue functionality
+#     File: virt-about-multi-queue
+  - Name: VM disks
+    Dir: virtual_disks
+    Topics:
+    - Name: Hot-plugging VM disks
+      File: virt-hot-plugging-virtual-disks
+    - Name: Expanding VM disks
+      File: virt-expanding-vm-disks
+# Need to check if supported:
+#   - Name: Configuring shared volumes
+#     File: virt-configuring-shared-volumes-for-vms
+    - Name: Migrating VM disks to a different storage class
+      File: virt-migrating-storage-class
+- Name: Networking
+  Dir: vm_networking
+  Topics:
+  - Name: Networking configuration overview
+    File: virt-networking-overview
+  - Name: Connecting a VM to the default pod network
+    File: virt-connecting-vm-to-default-pod-network
+  - Name: Connecting a VM to a primary user-defined network
+    File: virt-connecting-vm-to-primary-udn
+  - Name: Exposing a VM by using a service
+    File: virt-exposing-vm-with-service
+# Not supported in ROSA/OSD
+#  - Name: Connecting a VM to a Linux bridge network
+#    File: virt-connecting-vm-to-linux-bridge
+#  - Name: Connecting a VM to an SR-IOV network
+#    File: virt-connecting-vm-to-sriov
+#  - Name: Using DPDK with SR-IOV
+#    File: virt-using-dpdk-with-sriov
+  - Name: Connecting a VM to an OVN-Kubernetes secondary network
+    File: virt-connecting-vm-to-ovn-secondary-network
+  - Name: Hot plugging secondary network interfaces
+    File: virt-hot-plugging-network-interfaces
+  - Name: Connecting a VM to a service mesh
+    File: virt-connecting-vm-to-service-mesh
+  - Name: Configuring a dedicated network for live migration
+    File: virt-dedicated-network-live-migration
+  - Name: Configuring and viewing IP addresses
+    File: virt-configuring-viewing-ips-for-vms
+# Tech Preview features not supported in ROSA/OSD
+#  - Name: Accessing a VM by using the cluster FQDN
+#    File: virt-accessing-vm-secondary-network-fqdn
+  - Name: Managing MAC address pools for network interfaces
+    File: virt-using-mac-address-pool-for-vms
+- Name: Storage
+  Dir: storage
+  Topics:
+  - Name: Storage configuration overview
+    File: virt-storage-config-overview
+  - Name: Configuring storage profiles
+    File: virt-configuring-storage-profile
+  - Name: Managing automatic boot source updates
+    File: virt-automatic-bootsource-updates
+  - Name: Reserving PVC space for file system overhead
+    File: virt-reserving-pvc-space-fs-overhead
+  - Name: Configuring local storage by using HPP
+    File: virt-configuring-local-storage-with-hpp
+  - Name: Enabling user permissions to clone data volumes across namespaces
+    File: virt-enabling-user-permissions-to-clone-datavolumes
+  - Name: Configuring CDI to override CPU and memory quotas
+    File: virt-configuring-cdi-for-namespace-resourcequota
+  - Name: Preparing CDI scratch space
+    File: virt-preparing-cdi-scratch-space
+  - Name: Using preallocation for data volumes
+    File: virt-using-preallocation-for-datavolumes
+  - Name: Managing data volume annotations
+    File: virt-managing-data-volume-annotations
+# Virtual machine live migration
+- Name: Live migration
+  Dir: live_migration
+  Topics:
+  - Name: About live migration
+    File: virt-about-live-migration
+  - Name: Configuring live migration
+    File: virt-configuring-live-migration
+  - Name: Initiating and canceling live migration
+    File: virt-initiating-live-migration
+# Node maintenance mode
+- Name: Nodes
+  Dir: nodes
+  Topics:
+  - Name: Node maintenance
+    File: virt-node-maintenance
+  - Name: Managing node labeling for obsolete CPU models
+    File: virt-managing-node-labeling-obsolete-cpu-models
+  - Name: Preventing node reconciliation
+    File: virt-preventing-node-reconciliation
+# Hiding in ROSA as user cannot cordon and drain nodes
+#  - Name: Deleting a failed node to trigger VM failover
+#    File: virt-triggering-vm-failover-resolving-failed-node
+- Name: Monitoring
+  Dir: monitoring
+  Topics:
+  - Name: Monitoring overview
+    File: virt-monitoring-overview
+# Hiding in ROSA/OSD as TP not supported
+#  - Name: Cluster checkup framework
+#    File: virt-running-cluster-checkups
+  - Name: Prometheus queries for virtual resources
+    File: virt-prometheus-queries
+  - Name: Virtual machine custom metrics
+    File: virt-exposing-custom-metrics-for-vms
+  - Name: Virtual machine health checks
+    File: virt-monitoring-vm-health
+  - Name: Runbooks
+    File: virt-runbooks
+- Name: Support
+  Dir: support
+  Topics:
+  - Name: Support overview
+    File: virt-support-overview
+  - Name: Collecting data for Red Hat Support
+    File: virt-collecting-virt-data
+    Distros: openshift-rosa-hcp
+  - Name: Troubleshooting
+    File: virt-troubleshooting
+- Name: Backup and restore
+  Dir: backup_restore
+  Topics:
+  - Name: Backup and restore by using VM snapshots
+    File: virt-backup-restore-snapshots
+  - Name: Backing up and restoring virtual machines
+    File: virt-backup-restore-overview
+#  - Name: Removed topics (Placeholder for topics removed from topic map)
+#    Dir: Removed_topics
+#    Topics:
+#    - Name: Collecting OKD Virtualization data for community report
+#      File: virt-collecting-virt-data
+#    - Name: Preparing to upgrade ROSA to 4.9
+#      File: rosa-upgrading-cluster-prepare
+#    - Name: Upgrading ROSA Classic clusters
+#      File: rosa-upgrading

modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc

@@ -17,9 +17,9 @@ Cluster administrators can delete installed Operators from a selected namespace
 ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
 `cluster-admin` permissions.
 endif::[]
-ifdef::openshift-dedicated,openshift-rosa[]
+ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
 `dedicated-admin` permissions.
-endif::openshift-dedicated,openshift-rosa[]
+endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
 
 .Procedure
 

modules/virt-about-services.adoc

@@ -15,16 +15,16 @@ NodePort:: Exposes the service on the same port of each selected node in the clu
 
 LoadBalancer:: Creates an external load balancer in the current cloud (if supported) and assigns a fixed, external IP address to the service.
 
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
 [NOTE]
 ====
 For on-premise clusters, you can configure a load-balancing service by deploying the MetalLB Operator.
 ====
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
 
-ifdef::openshift-rosa,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
 [NOTE]
 ====
 For {product-rosa}, you must use `externalTrafficPolicy: Cluster` when configuring a load-balancing service, to minimize the network downtime during live migration.
 ====
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]

modules/virt-about-storage-volumes-for-vm-disks.adoc

@@ -14,10 +14,10 @@ For best results, use the `ReadWriteMany` (RWX) access mode and the `Block` volu
 * `ReadWriteMany` (RWX) access mode is required for live migration.
 
 * The `Block` volume mode performs significantly better than the `Filesystem` volume mode. This is because the `Filesystem` volume mode uses more storage layers, including a file system layer and a disk image file. These layers are not necessary for VM disk storage.
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
 +
 For example, if you use {rh-storage-first}, Ceph RBD volumes are preferable to CephFS volumes.
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
 
 [IMPORTANT]
 ====

modules/virt-about-upgrading-virt.adoc

@@ -33,22 +33,22 @@ connection. Most automatic updates complete within fifteen minutes.
 
 * Data volumes and their associated persistent volume claims are preserved during an update.
 
-ifndef::openshift-rosa,openshift-dedicated[]
+ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
 [IMPORTANT]
 ====
 If you have virtual machines running that use hostpath provisioner storage, they cannot be live migrated and might block an {product-title} cluster update.
 
 As a workaround, you can reconfigure the virtual machines so that they can be powered off automatically during a cluster update. Set the `evictionStrategy` field to `None` and the `runStrategy` field to `Always`.
 ====
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
+ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
 [IMPORTANT]
 ====
 If you have virtual machines running that use AWS Elastic Block Store (EBS) storage, they cannot be live migrated and might block an {product-title} cluster update.
 
 As a workaround, you can reconfigure the virtual machines so that they can be powered off automatically during a cluster update. Set the `evictionStrategy` field to `None` and the `runStrategy` field to `Always`.
 ====
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
 
 [id="how-updates-work_{context}"]
 == How updates work