mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-12568 virt book integration
This commit is contained in:
committed by
openshift-cherrypick-robot
parent
20a25c75ed
commit
6c79ac13c2
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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[]
|
||||
|
||||
@@ -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]
|
||||
====
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * virt/install/preparing-cluster-for-virt.adoc
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="virt-aws-bm_{context}"]
|
||||
= {VirtProductName} on AWS bare metal
|
||||
@@ -12,29 +12,29 @@ You can run {VirtProductName} on an Amazon Web Services (AWS) bare-metal {produc
|
||||
====
|
||||
{VirtProductName} is also supported on {product-rosa} (ROSA) Classic clusters, which have the same configuration requirements as AWS bare-metal clusters.
|
||||
====
|
||||
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[]
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="virt-aws-bm_{context}"]
|
||||
= {VirtProductName} on {product-title}
|
||||
|
||||
ifdef::openshift-rosa[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
||||
You can run {VirtProductName} on a {product-rosa} (ROSA) Classic cluster.
|
||||
endif::openshift-rosa[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
ifdef::openshift-dedicated[]
|
||||
You can run {VirtProductName} on a {product-dedicated} cluster.
|
||||
endif::openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
Before you set up your cluster, review the following summary of supported features and limitations:
|
||||
|
||||
Installing::
|
||||
--
|
||||
* You can install the cluster by using installer-provisioned infrastructure, ensuring that you specify bare-metal instance types for the worker nodes. For example, you can use the `c5n.metal` type value for a machine based on x86_64 architecture.
|
||||
ifndef::openshift-rosa[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
||||
You specify bare-metal instance types by editing the `install-config.yaml` file.
|
||||
endif::openshift-rosa[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
+
|
||||
For more information, see the {product-title} documentation about installing on AWS.
|
||||
--
|
||||
@@ -48,16 +48,16 @@ Accessing virtual machines (VMs)::
|
||||
|
||||
Networking::
|
||||
// Hiding the following in ROSA/OSD because SR-IOV is not supported.
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
--
|
||||
* You cannot use Single Root I/O Virtualization (SR-IOV) or bridge Container Network Interface (CNI) networks, including virtual LAN (VLAN). If your application requires a flat layer 2 network or control over the IP pool, consider using OVN-Kubernetes secondary overlay networks.
|
||||
--
|
||||
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[]
|
||||
--
|
||||
* If your application requires a flat layer 2 network or control over the IP pool, consider using OVN-Kubernetes secondary overlay networks.
|
||||
--
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
Storage::
|
||||
--
|
||||
@@ -106,9 +106,9 @@ AWS bare-metal and ROSA clusters might have different supported storage solution
|
||||
Consider using CSI storage, which supports ReadWriteMany (RWX), cloning, and snapshots to enable live migration, fast VM creation, and VM snapshots capabilities.
|
||||
--
|
||||
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
Hosted control planes (HCPs)::
|
||||
--
|
||||
* HCPs for {VirtProductName} are not currently supported on AWS infrastructure.
|
||||
--
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
@@ -13,9 +13,9 @@ You can deploy the {VirtProductName} Operator by using the `oc` CLI.
|
||||
* Subscribe to the {VirtProductName} catalog in the `{CNVNamespace}` namespace.
|
||||
* Log in as a user with `cluster-admin` privileges.
|
||||
// required for ROSA/OSD
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* Create a machine pool based on a bare metal compute node instance type.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
.Procedure
|
||||
|
||||
|
||||
@@ -13,9 +13,9 @@ You can deploy the {VirtProductName} Operator by using the {product-title} web c
|
||||
* Install {product-title} {product-version} on your cluster.
|
||||
* Log in to the {product-title} web console as a user with `cluster-admin` permissions.
|
||||
// required for ROSA/OSD
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* Create a machine pool based on a bare metal compute node instance type. For more information, see "Creating a machine pool" in the Additional resources of this section.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
.Procedure
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ ifdef::openshift-origin[]
|
||||
endif::[]
|
||||
You can use it to manage virtual machines (VMs) exclusively or alongside container workloads.
|
||||
|
||||
ifndef::openshift-origin,openshift-rosa,openshift-dedicated[]
|
||||
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].
|
||||
@@ -31,14 +31,14 @@ endif::[]
|
||||
|
||||
You can manage your cluster and virtualization resources by using the *Virtualization* perspective of the {product-title} web console, and by using the {oc-first}.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
{VirtProductName} is designed and tested to work well with {rh-storage-first} features.
|
||||
|
||||
[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.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
// A line about support for OVN and OpenShiftSDN network providers has been moved to the `about-virt` assembly due to xrefs.
|
||||
// If you are re-using this module, you might also want to include that line in your assembly.
|
||||
|
||||
@@ -26,22 +26,22 @@ include::modules/virt-what-you-can-do-with-virt.adoc[leveloffset=+1]
|
||||
// This line is attached to the above `virt-what-you-can-do-with-virt` module.
|
||||
// It is included here in the assembly because of the xref ban.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
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].
|
||||
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[]
|
||||
You can use {VirtProductName} with OVN-Kubernetes.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
// Hiding links in ROSA/OSD until PR 62384 merges
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
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.
|
||||
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[]
|
||||
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.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-vmware-comparison.adoc[leveloffset=+1]
|
||||
|
||||
@@ -50,18 +50,18 @@ include::modules/virt-supported-cluster-version.adoc[leveloffset=+1]
|
||||
include::modules/virt-about-storage-volumes-for-vm-disks.adoc[leveloffset=+1]
|
||||
|
||||
// removing from OSD/ROSA, as SNO is not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
include::modules/virt-sno-differences.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_about-virt"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../storage/index.adoc#openshift-storage-common-terms_storage-overview[Glossary of common terms for {product-title} storage]
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../installing/installing_sno/install-sno-preparing-to-install-sno.adoc#install-sno-about-installing-on-a-single-node_install-sno-preparing[About {sno}]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* link:https://cloud.redhat.com/blog/using-the-openshift-assisted-installer-service-to-deploy-an-openshift-cluster-on-metal-and-vsphere[Assisted installer]
|
||||
* xref:../../nodes/pods/nodes-pods-priority.adoc#priority-preemption-other_nodes-pods-priority[Pod disruption budgets]
|
||||
* xref:../../virt/live_migration/virt-about-live-migration.adoc#virt-about-live-migration[About live migration]
|
||||
|
||||
@@ -16,13 +16,13 @@ Red Hat supports using {VirtProductName} 4.14 or later with {oadp-short} 1.3.x o
|
||||
{oadp-short} versions earlier than 1.3.0 are not supported for back up and restore of {VirtProductName}.
|
||||
====
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
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}].
|
||||
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[]
|
||||
Back up and restore virtual machines by using the {oadp-full}.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
You can install the {oadp-first} with {VirtProductName} by installing the {oadp-short} Operator and configuring a backup location. You can then install the Data Protection Application.
|
||||
|
||||
@@ -41,20 +41,20 @@ The following storage options are excluded:
|
||||
|
||||
* Volume snapshot backup and restore
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
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].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
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 OperatorHub sources and mirror the Operator catalog.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
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.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/install-and-configure-oadp-kubevirt.adoc[leveloffset=+1]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
@@ -62,7 +62,7 @@ ifndef::openshift-rosa,openshift-dedicated[]
|
||||
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[`Backup` custom resource (CR)]
|
||||
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#restoring-applications[`Restore` CR]
|
||||
* xref:../../disconnected/using-olm.adoc#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -9,13 +9,13 @@ toc::[]
|
||||
You can back up and restore virtual machines (VMs) by using snapshots. Snapshots are supported by the following storage providers:
|
||||
|
||||
// Hiding in ROSA/OSD as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* {rh-storage-first}
|
||||
* Any other cloud storage provider with the Container Storage Interface (CSI) driver that supports the Kubernetes Volume Snapshot API
|
||||
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[]
|
||||
* Any cloud storage provider with the Container Storage Interface (CSI) driver that supports the Kubernetes Volume Snapshot API
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
To create snapshots of a VM in the `Running` state with the highest integrity, install the QEMU guest agent if it is not included with your operating system. The QEMU guest agent is included with the default Red{nbsp}Hat templates.
|
||||
|
||||
@@ -62,9 +62,9 @@ include::modules/virt-deleting-vm-snapshot-web.adoc[leveloffset=+2]
|
||||
include::modules/virt-deleting-vm-snapshot-cli.adoc[leveloffset=+2]
|
||||
|
||||
// Hiding in ROSA/OSD as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources-snapshots"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots[CSI Volume Snapshots]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
@@ -9,12 +9,12 @@ toc::[]
|
||||
You can simplify virtual machine (VM) creation by using instance types, whether you use the {product-title} web console or the CLI to create VMs.
|
||||
|
||||
// special TP note for ROSA only:
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[NOTE]
|
||||
====
|
||||
Creating a VM from an instance type in {VirtProductName} 4.15 and higher is supported on {product-title} clusters. In {VirtProductName} 4.14, creating a VM from an instance type is a Technology Preview feature and is not supported on {product-title} clusters.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-about-instance-types.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ You can create virtual machines (VMs) by using container disks built from operat
|
||||
You can enable auto updates for your container disks. See xref:../../../virt/storage/virt-automatic-bootsource-updates.adoc#virt-automatic-bootsource-updates[Managing automatic boot source updates] for details.
|
||||
|
||||
// Hiding links in ROSA/OSD
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
If the container disks are large, the I/O traffic might increase and cause worker nodes to be unavailable. You can perform the following tasks to resolve this issue:
|
||||
@@ -19,13 +19,13 @@ If the container disks are large, the I/O traffic might increase and cause worke
|
||||
* xref:../../../applications/pruning-objects.adoc#pruning-deployments_pruning-objects[Pruning `DeploymentConfig` objects].
|
||||
* xref:../../../nodes/nodes/nodes-nodes-garbage-collection.adoc#nodes-nodes-garbage-collection-configuring_nodes-nodes-configuring[Configuring garbage collection].
|
||||
====
|
||||
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 the container disks are large, the I/O traffic might increase and cause worker nodes to be unavailable. You can prune `DeploymentConfig` objects to resolve this issue:
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
You create a VM from a container disk by performing the following steps:
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ Cluster configuration procedures require `cluster-admin` privileges.
|
||||
====
|
||||
|
||||
// Hiding in ROSA/OSD for now - unsure if supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[id="tours-quick-starts_{context}"]
|
||||
== Tours and quick starts
|
||||
|
||||
@@ -39,7 +39,7 @@ Quick start tours are available for several {VirtProductName} features. To acces
|
||||
. Select *Quick Starts*.
|
||||
|
||||
You can filter the available tours by entering the keyword `virtual` in the *Filter* field.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="planning-and-installing-virt_{context}"]
|
||||
== Planning and installing {VirtProductName}
|
||||
@@ -47,9 +47,9 @@ endif::openshift-rosa,openshift-dedicated[]
|
||||
Plan and install {VirtProductName} on an {product-title} cluster:
|
||||
|
||||
// Hiding in ROSA/OSD, not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#virt-planning-bare-metal-cluster-for-ocp-virt_preparing-to-install-on-bare-metal[Plan your bare metal cluster for {VirtProductName}].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Prepare your cluster for {VirtProductName}].
|
||||
* xref:../../virt/install/installing-virt.adoc#virt-installing-virt-operator_installing-virt[Install the {VirtProductName} Operator].
|
||||
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#installing-virtctl_virt-using-the-cli-tools[Install the `virtctl` command line interface (CLI) tool].
|
||||
@@ -64,9 +64,9 @@ endif::openshift-rosa,openshift-dedicated[]
|
||||
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Using a CSI-enabled storage provider].
|
||||
* xref:../../virt/storage/virt-configuring-local-storage-with-hpp.adoc#virt-configuring-local-storage-with-hpp[Configuring local storage for virtual machines].
|
||||
// Hiding in ROSA/OSD, as feature is TP
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#installing-the-kubernetes-nmstate-operator-cli[Installing the Kubernetes NMState Operator].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../virt/managing_vms/advanced_vm_management/virt-specifying-nodes-for-vms.adoc#virt-specifying-nodes-for-vms[Specifying nodes for virtual machines].
|
||||
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#virt-virtctl-commands_virt-using-the-cli-tools[`Virtctl` commands].
|
||||
|
||||
@@ -76,21 +76,21 @@ endif::openshift-rosa,openshift-dedicated[]
|
||||
Create a virtual machine (VM):
|
||||
|
||||
* xref:../../virt/creating_vms_advanced/creating_vms_advanced_web/virt-creating-vms-from-rh-images-overview.adoc#virt-creating-vms-from-rh-images-overview[Create a VM from a Red Hat image].
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
+
|
||||
You can create a VM by using a Red Hat template or an xref:../../virt/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[instance type].
|
||||
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[]
|
||||
+
|
||||
You can create a VM by using a Red Hat template.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
* You can create a VM by xref:../../virt/creating_vms_advanced/creating_vms_advanced_web/virt-creating-vms-from-web-images.adoc#virt-creating-vms-from-web-images[importing a custom image from a container registry or a web page], by xref:../../virt/creating_vms_advanced/creating_vms_advanced_web/virt-creating-vms-uploading-images.adoc#virt-creating-vms-uploading-images[uploading an image from your local machine], or by xref:../../virt/creating_vms_advanced/creating_vms_cli/virt-creating-vms-by-cloning-pvcs.adoc#virt-creating-vms-by-cloning-pvcs[cloning a persistent volume claim (PVC)].
|
||||
|
||||
Connect a VM to a secondary network:
|
||||
|
||||
// Linux bridge and SR-IOV not supported in ROSA/OSD
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Linux bridge network].
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Open Virtual Network (OVN)-Kubernetes secondary network].
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Single Root I/O Virtualization (SR-IOV) network].
|
||||
@@ -99,15 +99,15 @@ ifndef::openshift-rosa,openshift-dedicated[]
|
||||
====
|
||||
VMs are connected to the pod network by default.
|
||||
====
|
||||
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[]
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Open Virtual Network (OVN)-Kubernetes secondary network].
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
VMs are connected to the pod network by default.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
Connect to a VM:
|
||||
|
||||
@@ -130,7 +130,7 @@ include::modules/migrating-to-virt.adoc[leveloffset=+1]
|
||||
* xref:../../virt/storage/virt-storage-config-overview.adoc#virt-storage-config-overview[Configure storage options and automatic boot source updates].
|
||||
* xref:../../virt/monitoring/virt-monitoring-overview.adoc#virt-monitoring-overview[Learn about monitoring and health checks].
|
||||
* xref:../../virt/live_migration/virt-about-live-migration.adoc#virt-about-live-migration[Learn about live migration].
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#installing-oadp-kubevirt[Back up and restore VMs by using the {oadp-first}].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* link:https://access.redhat.com/articles/6994974[Tune and scale your cluster].
|
||||
|
||||
@@ -8,14 +8,14 @@ toc::[]
|
||||
|
||||
Install {VirtProductName} to add virtualization functionality to your {product-title} cluster.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
If you install {VirtProductName} in a restricted environment with no internet connectivity, you must xref:../../disconnected/using-olm.adoc#olm-restricted-networks[configure Operator Lifecycle Manager for disconnected environments].
|
||||
|
||||
If you have limited internet connectivity, you can xref:../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[configure proxy support in OLM] to access the OperatorHub.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="installing-virt-operator_installing-virt"]
|
||||
== Installing the {VirtProductName} Operator
|
||||
@@ -24,12 +24,12 @@ Install the {VirtProductName} Operator by using the {product-title} web console
|
||||
|
||||
include::modules/virt-installing-virt-operator.adoc[leveloffset=+2]
|
||||
|
||||
ifdef::openshift-rosa[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.html#creating_a_machine_pool_rosa-managing-worker-nodes[Creating a machine pool]
|
||||
endif::openshift-rosa[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
ifdef::openshift-dedicated[]
|
||||
[role="_additional-resources"]
|
||||
@@ -52,12 +52,12 @@ You can xref:../../virt/post_installation_configuration/virt-configuring-certifi
|
||||
|
||||
include::modules/virt-deploying-operator-cli.adoc[leveloffset=+3]
|
||||
|
||||
ifdef::openshift-rosa[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.html#creating_a_machine_pool_rosa-managing-worker-nodes[Creating a machine pool]
|
||||
endif::openshift-rosa[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
ifdef::openshift-dedicated[]
|
||||
[role="_additional-resources"]
|
||||
|
||||
@@ -10,7 +10,7 @@ toc::[]
|
||||
Review this section before you install {VirtProductName} to ensure that your cluster meets the requirements.
|
||||
|
||||
// Hiding in ROSA/OSD as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
Installation method considerations::
|
||||
@@ -22,14 +22,14 @@ If you deploy {VirtProductName} with {rh-storage-first}, you must create a dedic
|
||||
IPv6::
|
||||
You cannot run {VirtProductName} on a single-stack IPv6 cluster.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
// Hiding in ROSA/OSD as FIPS not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
.FIPS mode
|
||||
|
||||
If you install your cluster in xref:../../installing/overview/installing-fips.adoc#installing-fips-mode_installing-fips[FIPS mode], no additional setup is required for {VirtProductName}.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="supported-platforms_preparing-cluster-for-virt"]
|
||||
== Supported platforms
|
||||
@@ -37,7 +37,7 @@ endif::openshift-rosa,openshift-dedicated[]
|
||||
You can use the following platforms with {VirtProductName}:
|
||||
|
||||
// Hiding in ROSA/OSD, as bare metal not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* On-premise bare metal servers. See xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#virt-planning-bare-metal-cluster-for-ocp-virt_preparing-to-install-on-bare-metal[Planning a bare metal cluster for {VirtProductName}].
|
||||
|
||||
* Amazon Web Services bare metal instances. See xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations].
|
||||
@@ -62,16 +62,16 @@ include::snippets/technology-preview.adoc[]
|
||||
:!FeatureName:
|
||||
endif::[]
|
||||
--
|
||||
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[]
|
||||
* Amazon Web Services bare metal instances.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
// Hiding in ROSA/OSD, as bare metal not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
Bare metal instances or servers offered by other cloud providers are not supported.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-aws-bm.adoc[leveloffset=+2]
|
||||
|
||||
@@ -81,7 +81,7 @@ include::modules/virt-aws-bm.adoc[leveloffset=+2]
|
||||
* xref:../../virt/vm_networking/virt-exposing-vm-with-service.adoc#virt-exposing-vm-with-service[Exposing a virtual machine by using a service]
|
||||
|
||||
// Hiding in ROSA/OSD - todo: double check this
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[id="ibm-z-linuxone-compatibility_{context}"]
|
||||
=== {ibm-z-title} and {ibm-linuxone-title} compatibility
|
||||
|
||||
@@ -133,7 +133,7 @@ $ virtctl restart <vm_name>
|
||||
|
||||
* When xref:../../virt/monitoring/virt-exposing-downward-metrics.adoc#virt-configuring-downward-metrics_virt-using-downward-metrics_virt-exposing-downward-metrics[configuring a downward metrics device], if you use a VM preference, the `spec.preference.name` value must be set to `rhel.9.s390x` or another available preference with the format `*.s390x`.
|
||||
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
// Section is in assembly so that we can use xrefs
|
||||
[id="virt-hardware-os-requirements_preparing-cluster-for-virt"]
|
||||
@@ -164,7 +164,7 @@ See xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-schedul
|
||||
=== Operating system requirements
|
||||
|
||||
* {op-system-first} installed on worker nodes.
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
+
|
||||
See xref:../../architecture/architecture-rhcos.adoc#rhcos-about_architecture-rhcos[About RHCOS] for details.
|
||||
+
|
||||
@@ -172,26 +172,26 @@ See xref:../../architecture/architecture-rhcos.adoc#rhcos-about_architecture-rhc
|
||||
====
|
||||
{op-system-base} worker nodes are not supported.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="storage-requirements_preparing-cluster-for-virt"]
|
||||
=== Storage requirements
|
||||
|
||||
// Hiding link until PR 65079 merges
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* Supported by {product-title}. See xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#_optimizing-storage[Optimizing storage].
|
||||
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[]
|
||||
* Supported by {product-title}.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* You must create a default {VirtProductName} or {product-title} storage class. The purpose of this is to address the unique storage needs of VM workloads and offer optimized performance, reliability, and user experience. If both {VirtProductName} and {product-title} default storage classes exist, the {VirtProductName} class takes precedence when creating VM disks.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
To mark a storage class as the default for virtualization workloads, set the annotation `storageclass.kubevirt.io/is-default-virt-class` to `"true"`.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
* If the storage provisioner supports snapshots, you must associate a `VolumeSnapshotClass` object with the default storage class.
|
||||
|
||||
@@ -220,16 +220,16 @@ The default xref:../../virt/live_migration/virt-configuring-live-migration.adoc#
|
||||
include::modules/virt-cluster-resource-requirements.adoc[leveloffset=+1]
|
||||
|
||||
// Hiding in ROSA/OSD as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
include::modules/virt-sno-differences.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../storage/index.adoc#openshift-storage-common-terms_storage-overview[Glossary of common terms for {product-title} storage]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[id="object-maximums_preparing-cluster-for-virt"]
|
||||
== Object maximums
|
||||
|
||||
@@ -259,4 +259,4 @@ In {product-title} clusters installed using installer-provisioned infrastructure
|
||||
====
|
||||
Without an external monitoring system or a qualified human monitoring node health, virtual machines lose high availability.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
@@ -12,13 +12,13 @@ operating system or other program without requiring a locally attached
|
||||
storage device. For example, you can use it to choose your desired OS
|
||||
image from a PXE server when deploying a new host.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
== Prerequisites
|
||||
|
||||
* A Linux bridge must be xref:../../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[connected].
|
||||
|
||||
* The PXE server must be connected to the same VLAN as the bridge.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-pxe-booting-with-mac-address.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[]
|
||||
toc::[]
|
||||
|
||||
// Hiding manual delete item as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can enable high availability for virtual machines (VMs) by manually deleting a failed node to trigger VM failover or by configuring remediating nodes.
|
||||
|
||||
.Manually deleting a failed node
|
||||
@@ -17,10 +17,10 @@ If a node fails and machine health checks are not deployed on your cluster, virt
|
||||
See xref:../../../virt/nodes/virt-triggering-vm-failover-resolving-failed-node.adoc#virt-triggering-vm-failover-resolving-failed-node[Deleting a failed node to trigger virtual machine failover].
|
||||
|
||||
.Configuring remediating nodes
|
||||
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[]
|
||||
You can enable high availability for virtual machines (VMs) by configuring remediating nodes.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
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 OperatorHub and enabling machine health checks or node remediation checks.
|
||||
|
||||
|
||||
@@ -19,8 +19,8 @@ include::modules/virt-schedule-cpu-host-model-vms.adoc[leveloffset=+1]
|
||||
include::modules/virt-vm-custom-scheduler.adoc[leveloffset=+1]
|
||||
|
||||
// Hiding in ROSA/OSD, not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../../nodes/scheduling/secondary_scheduler/nodes-secondary-scheduler-configuring.adoc#nodes-secondary-scheduler-configuring-console_secondary-scheduler-configuring[Deploying a secondary scheduler]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
@@ -27,6 +27,6 @@ include::modules/virt-example-vm-node-placement-tolerations.adoc[leveloffset=+2]
|
||||
* xref:../../../virt/post_installation_configuration/virt-node-placement-virt-components.adoc#virt-node-placement-virt-components[Specifying nodes for virtualization components]
|
||||
* xref:../../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors[Placing pods on specific nodes using node selectors]
|
||||
* xref:../../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity[Controlling pod placement on nodes using node affinity rules]
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
* xref:../../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
@@ -139,22 +139,22 @@ See the link:https://access.redhat.com/articles/6994974#networking-multus[Multus
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
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-network-attachment_virt-connecting-vm-to-sriov[network attachment definition] when you created an `SriovNetwork` object.
|
||||
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[]
|
||||
* 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 created a xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#creating-ovn-nad_virt-connecting-vm-to-ovn-secondary-network[network attachment definition].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-vm-creating-nic-web.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-connecting-secondary-network-ssh.adoc[leveloffset=+2]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
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].
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
@@ -10,9 +10,9 @@ You can update a virtual machine (VM) configuration by using the {product-title}
|
||||
|
||||
You can also edit a VM by using the command line.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
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].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-change-vm-instance-type.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ include::modules/virt-accessing-node-exporter-outside-cluster.adoc[leveloffset=+
|
||||
[id="additional-resources_virt-exposing-custom-metrics-for-vms"]
|
||||
== Additional resources
|
||||
// Hiding in ROSA/OSD as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../observability/monitoring/getting-started/core-platform-monitoring-first-steps.adoc#core-platform-monitoring-first-steps[Core platform monitoring first steps]
|
||||
|
||||
* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
|
||||
@@ -31,7 +31,7 @@ ifndef::openshift-rosa,openshift-dedicated[]
|
||||
* xref:../../observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc#reviewing-monitoring-dashboards-developer_accessing-metrics-as-a-developer[Reviewing monitoring dashboards as a developer]
|
||||
|
||||
* xref:../../applications/application-health.adoc#application-health[Monitoring application health by using health checks]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
* xref:../../nodes/pods/nodes-pods-configmaps.adoc#nodes-pods-configmaps[Creating and using config maps]
|
||||
|
||||
|
||||
@@ -11,14 +11,14 @@ You can monitor the health of your cluster and virtual machines (VMs) with the f
|
||||
Monitoring {VirtProductName} VM health status::
|
||||
View the overall health of your {VirtProductName} environment in the web console by navigating to the *Home* -> *Overview* page in the {product-title} web console. The *Status* card displays the overall health of {VirtProductName} based on the alerts and conditions.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
xref:../../virt/monitoring/virt-running-cluster-checkups.adoc#virt-running-cluster-checkups[{product-title} cluster checkup framework]::
|
||||
Run automated tests on your cluster with the {product-title} cluster checkup framework to check the following conditions:
|
||||
* Network connectivity and latency between two VMs attached to a secondary network interface
|
||||
* VM running a Data Plane Development Kit (DPDK) workload with zero packet loss
|
||||
* Cluster storage is optimally configured for {VirtProductName}
|
||||
//* The {product-title} cluster can run real-time virtualized workloads.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
//:FeatureName: The {product-title} cluster checkup framework
|
||||
//include::snippets/technology-preview.adoc[]
|
||||
@@ -36,9 +36,9 @@ xref:../../virt/monitoring/virt-runbooks.adoc#virt-runbooks[Runbooks]::
|
||||
ifdef::openshift-dedicated,openshift-rosa[]
|
||||
Diagnose and resolve issues that trigger {VirtProductName} xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[alerts] in the {product-title} web console.
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
Diagnose and resolve issues that trigger {VirtProductName} xref:../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#about-managing-alerts_key-concepts[alerts] in the {product-title} web console.
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
//:FeatureName: The guest agent ping probe
|
||||
//include::snippets/technology-preview.adoc[]
|
||||
|
||||
@@ -46,15 +46,15 @@ include::modules/virt-defining-watchdog-device-vm.adoc[leveloffset=+2]
|
||||
include::modules/virt-installing-watchdog-agent.adoc[leveloffset=+2]
|
||||
|
||||
// Hiding in ROSA/OSD as TP not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
include::modules/virt-define-guest-agent-ping-probe.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
// Hiding in ROSA/OSD as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[id="additional-resources_monitoring-vm-health"]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../applications/application-health.adoc#application-health[Monitoring application health by using health checks]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
@@ -7,21 +7,21 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
{VirtProductName} provides metrics that you can use to monitor the consumption of cluster infrastructure resources, including vCPU, network, storage, and guest memory swapping. You can also use metrics to query live migration status.
|
||||
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[]
|
||||
Use the {product-title} monitoring dashboard to query virtualization metrics.
|
||||
{VirtProductName} provides metrics that you can use to monitor the consumption of cluster infrastructure resources, including network, storage, and guest memory swapping. You can also use metrics to query live migration status.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="prerequisites_{context}"]
|
||||
== Prerequisites
|
||||
|
||||
// Hiding in ROSA/OSD as user cannot edit MCO
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* To use the vCPU metric, the `schedstats=enable` kernel argument must be applied to the `MachineConfig` object. This kernel argument enables scheduler statistics used for debugging and performance tuning and adds a minor additional load to the scheduler. For more information, see xref:../../machine_configuration/machine-configs-configure.adoc#nodes-nodes-kernel-arguments_machine-configs-configure[Adding kernel arguments to nodes].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
* For guest memory swapping queries to return data, memory swapping must be enabled on the virtual guests.
|
||||
|
||||
@@ -36,12 +36,13 @@ include::modules/virt-live-migration-metrics.adoc[leveloffset=+2]
|
||||
[id="additional-resources_virt-prometheus-queries"]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
// HCP link removed for now
|
||||
ifdef::openshift-dedicated,openshift-rosa[]
|
||||
* xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
* xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
* link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus]
|
||||
|
||||
|
||||
@@ -11,9 +11,9 @@ To diagnose and resolve issues that trigger {VirtProductName}
|
||||
ifdef::openshift-dedicated,openshift-rosa[]
|
||||
xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[alerts],
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
xref:../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#about-managing-alerts_key-concepts[alerts],
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
follow the procedures in the runbooks for the {VirtProductName} Operator. Triggered {VirtProductName} alerts can be viewed in the main *Observe* -> *Alerts* tab in the web console, and also in the *Virtualization* -> *Overview* tab.
|
||||
|
||||
Runbooks for the {VirtProductName} Operator are maintained in the link:https://github.com/openshift/runbooks/tree/master/alerts/openshift-virtualization-operator[openshift/runbooks] Git repository, and you can view them on GitHub.
|
||||
|
||||
@@ -63,20 +63,20 @@ include::modules/virt-building-real-time-container-disk-image.adoc[leveloffset=+
|
||||
////
|
||||
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_running-cluster-checkups"]
|
||||
== Additional resources
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Attaching a virtual machine to multiple networks]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
// Hiding pending resolution of OSDOCS-3691
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../networking/hardware_networks/using-dpdk-and-rdma.adoc#example-vf-use-in-dpdk-mode-intel_using-dpdk-and-rdma[Using a virtual function in DPDK mode with an Intel NIC]
|
||||
* xref:../../networking/hardware_networks/using-dpdk-and-rdma.adoc#nw-example-dpdk-line-rate_using-dpdk-and-rdma[Using SR-IOV and the Node Tuning Operator to achieve a DPDK line rate]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/composing_a_customized_rhel_system_image/installing-composer_composing-a-customized-rhel-system-image[Installing image builder]
|
||||
* link:https://access.redhat.com/solutions/253273[How to register and subscribe a RHEL system to the Red Hat Customer Portal using Red Hat Subscription Manager]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
@@ -25,6 +25,6 @@ include::modules/virt-node-placement-rule-examples.adoc[leveloffset=+1]
|
||||
* xref:../../virt/managing_vms/advanced_vm_management/virt-specifying-nodes-for-vms.adoc#virt-specifying-nodes-for-vms[Specifying nodes for virtual machines]
|
||||
* xref:../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors[Placing pods on specific nodes using node selectors]
|
||||
* xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity[Controlling pod placement on nodes using node affinity rules]
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
@@ -14,16 +14,16 @@ The following procedures are typically performed after {VirtProductName} is inst
|
||||
|
||||
* xref:../../virt/post_installation_configuration/virt-post-install-network-config.adoc#virt-post-install-network-config[Network configuration]:
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
** Installing the Kubernetes NMState and SR-IOV Operators
|
||||
** Configuring a Linux bridge network for external access to virtual machines (VMs)
|
||||
** Configuring a dedicated secondary network for live migration
|
||||
** Configuring an SR-IOV network
|
||||
** Enabling the creation of load balancer services by using the {product-title} web console
|
||||
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[]
|
||||
** Enabling the creation of load balancer services by using the {product-title} web console
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
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]:
|
||||
** Defining a default storage class for the Container Storage Interface (CSI)
|
||||
|
||||
@@ -8,24 +8,24 @@ toc::[]
|
||||
|
||||
By default, {VirtProductName} is installed with a single, internal pod network.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
After you install {VirtProductName}, you can install networking Operators and configure additional networks.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="installing-operators"]
|
||||
== Installing networking Operators
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You must install the xref:../../networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#k8s-nmstate-about-the-k8s-nmstate-operator[Kubernetes NMState Operator] to configure a Linux bridge network for live migration or external access to virtual machines (VMs). For installation instructions, see xref:../../networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#installing-the-kubernetes-nmstate-operator-web-console_k8s-nmstate-operator[Installing the Kubernetes NMState Operator by using the web console].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can install the xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[SR-IOV Operator] to manage SR-IOV network devices and network attachments. For installation instructions, see xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sr-iov-operator_installing-sriov-operator[Installing the SR-IOV Network Operator].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can add the xref:../../networking/networking_operators/metallb-operator/about-metallb.adoc#about-metallb[About MetalLB and the MetalLB Operator] to manage the lifecycle for an instance of MetalLB on your cluster. For installation instructions, see xref:../../networking/networking_operators/metallb-operator/metallb-operator-install.adoc#installing-the-metallb-operator-using-web-console_metallb-operator-install[Installing the MetalLB Operator from the OperatorHub using the web console].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="configuring-linux-bridge-network"]
|
||||
== Configuring a Linux bridge network
|
||||
@@ -36,10 +36,10 @@ include::modules/virt-creating-linux-bridge-nncp.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-creating-linux-bridge-nad-web.adoc[leveloffset=+2]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
.Next steps
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-attaching-vm-secondary-network-cli_virt-connecting-vm-to-linux-bridge[Attaching a virtual machine (VM) to a Linux bridge network]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="configuring-network-live-migration"]
|
||||
== Configuring a network for live migration
|
||||
@@ -50,7 +50,7 @@ include::modules/virt-configuring-secondary-network-vm-live-migration.adoc[level
|
||||
|
||||
include::modules/virt-selecting-migration-network-ui.adoc[leveloffset=+2]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[id="configuring-sriov-network"]
|
||||
== Configuring an SR-IOV network
|
||||
|
||||
@@ -63,6 +63,6 @@ include::modules/nw-sriov-network-attachment.adoc[leveloffset=+2]
|
||||
.Next steps
|
||||
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-attaching-vm-to-sriov-network_virt-connecting-vm-to-sriov[Attaching a virtual machine (VM) to an SR-IOV network]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-enabling-load-balancer-service-web.adoc[leveloffset=+1]
|
||||
|
||||
@@ -8,9 +8,9 @@ toc::[]
|
||||
|
||||
The following storage configuration tasks are mandatory:
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* You must configure a xref:../../storage/dynamic-provisioning.adoc#defining-storage-classes_dynamic-provisioning[default storage class] for your cluster. Otherwise, the cluster cannot receive automated boot source updates.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* You must configure xref:../../virt/storage/virt-configuring-storage-profile.adoc#virt-configuring-storage-profile[storage profiles] if your storage provider is not recognized by CDI. A storage profile provides recommended storage settings based on the associated storage class.
|
||||
|
||||
Optional: You can configure local storage by using the hostpath provisioner (HPP).
|
||||
|
||||
@@ -28,18 +28,18 @@ include::modules/virt-managing-auto-update-all-system-boot-sources.adoc[leveloff
|
||||
|
||||
_Custom_ boot sources that are not provided by {VirtProductName} are not controlled by the feature gate. You must manage them individually by editing the `HyperConverged` custom resource (CR).
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
You must configure a storage class. Otherwise, the cluster cannot receive automated updates for custom boot sources. See xref:../../storage/dynamic-provisioning.adoc#defining-storage-classes_dynamic-provisioning[Defining a storage class] for details.
|
||||
====
|
||||
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]
|
||||
====
|
||||
You must configure a storage profile. Otherwise, the cluster cannot receive automated updates for custom boot sources. See xref:../../virt/storage/virt-configuring-storage-profile.adoc#virt-configuring-storage-profile[Configure storage profiles] for details.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-configuring-default-and-virt-default-storage-class.adoc[leveloffset=+2]
|
||||
|
||||
|
||||
@@ -12,14 +12,14 @@ The Containerized Data Importer (CDI) recognizes a storage provider if it has be
|
||||
|
||||
For recognized storage types, the CDI provides values that optimize the creation of PVCs. You can also configure automatic settings for the storage class by customizing the storage profile. If the CDI does not recognize your storage provider, you must configure storage profiles.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
When using {VirtProductName} with {rh-storage-first}, specify RBD block mode persistent volume claims (PVCs) when creating virtual machine disks. RBD block mode volumes are more efficient and provide better performance than Ceph FS or RBD filesystem-mode PVCs.
|
||||
|
||||
To specify RBD block mode PVCs, use the 'ocs-storagecluster-ceph-rbd' storage class and `VolumeMode: Block`.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-customizing-storage-profile.adoc[leveloffset=+1]
|
||||
include::modules/virt-viewing-automatically-created-storage-profiles.adoc[leveloffset=+2]
|
||||
@@ -13,11 +13,11 @@ You can configure a default storage class, storage profiles, Containerized Data
|
||||
|
||||
The following storage configuration tasks are mandatory:
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
xref:../../storage/dynamic-provisioning.adoc#defining-storage-classes_dynamic-provisioning[Configure a default storage class]::
|
||||
|
||||
You must configure a default storage class for your cluster. Otherwise, the cluster cannot receive automated boot source updates.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
xref:../../virt/storage/virt-configuring-storage-profile.adoc#virt-configuring-storage-profile[Configure storage profiles]::
|
||||
|
||||
|
||||
@@ -9,22 +9,23 @@ toc::[]
|
||||
When you submit a xref:../../support/getting-support.adoc#support-submitting-a-case_getting-support[support case] to Red 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[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
must-gather tool::
|
||||
The `must-gather` tool collects diagnostic information, including resource definitions and service logs.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
Prometheus::
|
||||
Prometheus is a time-series database and a rule evaluation engine for metrics. Prometheus sends alerts to Alertmanager for processing.
|
||||
|
||||
Alertmanager::
|
||||
The Alertmanager service handles alerts received from Prometheus. The Alertmanager is also responsible for sending the alerts to external notification systems.
|
||||
//link needs to be added for HCP when available
|
||||
ifdef::openshift-dedicated,openshift-rosa[]
|
||||
For information about the {product-title} monitoring stack, see xref:../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[About {product-title} monitoring].
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
For information about the {product-title} monitoring stack, see xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring].
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
// This procedure is in the assembly so that we can add xrefs instead of a long list of additional resources.
|
||||
[id="virt-collecting-data-about-your-environment_{context}"]
|
||||
@@ -33,25 +34,27 @@ endif::openshift-dedicated,openshift-rosa[]
|
||||
Collecting data about your environment minimizes the time required to analyze and determine the root cause.
|
||||
|
||||
.Prerequisites
|
||||
//link needs to be added for HCP when available
|
||||
ifdef::openshift-dedicated,openshift-rosa[]
|
||||
* xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#modifying-retention-time-for-prometheus-metrics-data_configuring-the-monitoring-stack[Set the retention time for Prometheus metrics data] to a minimum of seven days.
|
||||
* xref:../../observability/monitoring/managing-alerts.adoc#sending-notifications-to-external-systems_managing-alerts[Configure 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[]
|
||||
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
* xref:../../observability/monitoring/configuring-core-platform-monitoring/storing-and-recording-data.adoc#modifying-retention-time-for-prometheus-metrics-data_storing-and-recording-data[Set the retention time for Prometheus metrics data] to a minimum of seven days.
|
||||
* xref:../../observability/monitoring/configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc#configuring-alert-notifications_configuring-alerts-and-notifications[Configure 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[]
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
* Record the exact number of affected nodes and virtual machines.
|
||||
|
||||
.Procedure
|
||||
|
||||
// must-gather not supported for ROSA/OSD, per Dustin Row
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
. xref:../../support/gathering-cluster-data.adoc#support_gathering_data_gathering-cluster-data[Collect must-gather data for the cluster].
|
||||
. link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.18/html-single/troubleshooting_openshift_data_foundation/index#downloading-log-files-and-diagnostic-information_rhodf[Collect must-gather data for {rh-storage-first}], if necessary.
|
||||
. xref:../../virt/support/virt-collecting-virt-data.adoc#virt-using-virt-must-gather_virt-collecting-virt-data[Collect must-gather data for {VirtProductName}].
|
||||
. xref:../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#querying-metrics-for-all-projects-with-mon-dashboard_accessing-metrics-as-an-administrator[Collect Prometheus metrics for the cluster].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
//link needs to be added for HCP when available
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
* xref:../../observability/monitoring/managing-metrics.adoc#querying-metrics-for-all-projects-with-mon-dashboard_managing-metrics[Collect Prometheus metrics for the cluster].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
@@ -73,16 +76,16 @@ Collecting data about malfunctioning virtual machines (VMs) minimizes the time r
|
||||
.Procedure
|
||||
|
||||
// must-gather not supported for ROSA/OSD, per Dustin Row
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
. xref:../../virt/support/virt-collecting-virt-data.adoc#virt-must-gather-options_virt-collecting-virt-data[Collect must-gather data for the VMs] using the `/usr/bin/gather` script.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
. Collect screenshots of VMs that have crashed _before_ you restart them.
|
||||
. xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#vm-memory-dump-commands_virt-using-the-cli-tools[Collect memory dumps from VMs] _before_ remediation attempts.
|
||||
. Record factors that the malfunctioning VMs have in common. For example, the VMs have the same host or network.
|
||||
|
||||
// must-gather not supported for ROSA/OSD, per Dustin Row
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
include::modules/virt-using-virt-must-gather.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-must-gather-options.adoc[leveloffset=+2]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
@@ -31,13 +31,13 @@ xref:../../virt/support/virt-collecting-virt-data.adoc#virt-collecting-data-abou
|
||||
Configure Prometheus and Alertmanager and collect `must-gather` data for {product-title} and {VirtProductName}.
|
||||
|
||||
// must-gather not supported for ROSA/OSD, per Dustin Row
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
xref:../../virt/support/virt-collecting-virt-data.adoc#virt-using-virt-must-gather_virt-collecting-virt-data[`must-gather` tool for {VirtProductName}]::
|
||||
Configure and use the `must-gather` tool.
|
||||
|
||||
xref:../../virt/support/virt-collecting-virt-data.adoc#virt-collecting-data-about-vms_virt-collecting-virt-data[Collecting data about VMs]::
|
||||
Collect `must-gather` data and memory dumps from VMs.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="virt-creating-jira-issue_{context}"]
|
||||
=== Creating a Jira issue
|
||||
|
||||
@@ -29,13 +29,13 @@ To ensure that VMIs update automatically, configure workload updates.
|
||||
|
||||
// control plane updates
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-origin[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-origin,openshift-rosa-hcp[]
|
||||
include::modules/virt-about-control-plane-only-updates.adoc[leveloffset=+1]
|
||||
|
||||
Learn more about xref:../../updating/updating_a_cluster/control-plane-only-update.adoc#control-plane-only-update[Performing a Control Plane Only update].
|
||||
|
||||
include::modules/virt-preventing-workload-updates-during-control-plane-only-update.adoc[leveloffset=+2]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-origin[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-origin,openshift-rosa-hcp[]
|
||||
|
||||
[id="advanced-options_upgrading-virt"]
|
||||
== Advanced options
|
||||
@@ -51,9 +51,9 @@ include::modules/olm-approving-pending-upgrade.adoc[leveloffset=+2]
|
||||
[id="additional-resources_upgrading-virt"]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-origin[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-origin,openshift-rosa-hcp[]
|
||||
* xref:../../updating/updating_a_cluster/control-plane-only-update.adoc#control-plane-only-update[Performing a Control Plane Only update]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-origin[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-origin,openshift-rosa-hcp[]
|
||||
* xref:../../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[What are Operators?]
|
||||
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources]
|
||||
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-csv_olm-understanding-olm[Cluster service versions (CSVs)]
|
||||
|
||||
@@ -19,8 +19,8 @@ include::modules/virt-connecting-vm-secondarynw-using-fqdn.adoc[leveloffset=+1]
|
||||
[id="additional-resources_accessing-vm-secondary-network-fqdn"]
|
||||
== Additional resources
|
||||
// Hiding until OSDOCS-3691 is merged
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-load-balancer.adoc#configuring-ingress-cluster-traffic-load-balancer[Configuring ingress cluster traffic using a load balancer]
|
||||
* xref:../../networking/networking_operators/metallb-operator/about-metallb.adoc#about-metallb_about-metallb[About MetalLB and the MetalLB Operator]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../virt/vm_networking/virt-configuring-viewing-ips-for-vms.adoc#configuring-ips_virt-configuring-viewing-ips-for-vms[Configuring IP addresses for virtual machines]
|
||||
|
||||
@@ -21,10 +21,10 @@ include::modules/virt-configuring-masquerade-mode-dual-stack.adoc[leveloffset=+1
|
||||
include::modules/virt-jumbo-frames-vm-pod-nw.adoc[leveloffset=+1]
|
||||
|
||||
// Hiding from ROSA/OSD as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_virt-connecting-vm-to-default-pod-network"]
|
||||
== Additional resources
|
||||
* xref:../../networking/changing-cluster-network-mtu.adoc#changing-cluster-network-mtu[Changing the MTU for the cluster network]
|
||||
* xref:../../scalability_and_performance/optimization/optimizing-networking.adoc#optimizing-mtu_optimizing-networking[Optimizing the MTU for your network]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
@@ -6,13 +6,13 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can connect a VM to an Open Virtual Network (OVN)-Kubernetes secondary network. {VirtProductName} supports the `layer2` topology for OVN-Kubernetes.
|
||||
|
||||
A `layer2` topology connects workloads by a cluster-wide logical switch. The OVN-Kubernetes Container Network Interface (CNI) plugin uses the Geneve (Generic Network Virtualization Encapsulation) protocol to create an overlay network between nodes. You can use this overlay network to connect VMs on different nodes, without having to configure any additional physical networking infrastructure.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can connect a virtual machine (VM) to an OVN-Kubernetes secondary network. {VirtProductName} supports the `layer2` and `localnet` topologies for OVN-Kubernetes.
|
||||
|
||||
* A `layer2` topology connects workloads by a cluster-wide logical switch. The OVN-Kubernetes Container Network Interface (CNI) plugin uses the Geneve (Generic Network Virtualization Encapsulation) protocol to create an overlay network between nodes. You can use this overlay network to connect VMs on different nodes, without having to configure any additional physical networking infrastructure.
|
||||
@@ -23,18 +23,18 @@ You can connect a virtual machine (VM) to an OVN-Kubernetes secondary network. {
|
||||
====
|
||||
An OVN-Kubernetes secondary network is compatible with the xref:../../networking/multiple_networks/secondary_networks/configuring-multi-network-policy.adoc#compatibility-with-multi-network-policy_configuring-additional-network[multi-network policy API] which provides the `MultiNetworkPolicy` custom resource definition (CRD) to control traffic flow to and from VMs. You can use the `ipBlock` attribute to define network policy ingress and egress rules for specific CIDR blocks.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
To configure an OVN-Kubernetes secondary network and attach a VM to that network, perform the following steps:
|
||||
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Configure an OVN-Kubernetes secondary network] by creating a network attachment definition (NAD).
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
For `localnet` topology, you must xref:../../networking/multiple_networks/secondary_networks/creating-secondary-nwt-ovnk.adoc#configuration-localnet-switched-topology_configuring-additional-network-ovnk[configure an OVS bridge] by creating a `NodeNetworkConfigurationPolicy` object before creating the NAD.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#attaching-vm-to-ovn-secondary-nw[Connect the VM to the OVN-Kubernetes secondary network] by adding the network details to the VM specification.
|
||||
|
||||
@@ -50,15 +50,15 @@ Configuring IP address management (IPAM) by specifying the `spec.config.ipam.sub
|
||||
|
||||
include::modules/virt-creating-layer2-nad-cli.adoc[leveloffset=+2]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
include::modules/virt-creating-localnet-nad-cli.adoc[leveloffset=+2]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-creating-nad-l2-overlay-console.adoc[leveloffset=+2]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
include::modules/virt-creating-nad-localnet-console.adoc[leveloffset=+2]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="attaching-vm-to-ovn-secondary-nw"]
|
||||
== Attaching a virtual machine to the OVN-Kubernetes secondary network
|
||||
@@ -68,11 +68,11 @@ You can attach a virtual machine (VM) to the OVN-Kubernetes secondary network in
|
||||
include::modules/virt-attaching-vm-to-ovn-secondary-nw-cli.adoc[leveloffset=+2]
|
||||
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_virt-connecting-vm-to-ovn-secondary-network"]
|
||||
== Additional resources
|
||||
* xref:../../networking/multiple_networks/secondary_networks/creating-secondary-nwt-ovnk.adoc#configuration-ovnk-additional-networks_configuring-additional-network[Creating secondary networks on OVN-Kubernetes]
|
||||
* xref:../../networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#k8s-nmstate-about-the-k8s-nmstate-operator[About the Kubernetes NMState Operator]
|
||||
* xref:../../networking/multiple_networks/primary_networks/about-primary-nwt-nad.adoc#understanding-multiple-networks[Creating primary networks using a NetworkAttachmentDefinition]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
@@ -66,9 +66,9 @@ include::modules/virt-creating-a-primary-cluster-udn.adoc[leveloffset=+2]
|
||||
include::modules/virt-attaching-vm-to-primary-udn.adoc[leveloffset=+1]
|
||||
|
||||
//Excluding from ROSA because the Networking -> Multiple networks -> Primary networks section is not part of ROSA docs
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_{context}"]
|
||||
== Additional resources
|
||||
* xref:../../networking/multiple_networks/primary_networks/about-user-defined-networks.adoc#about-user-defined-networks[About user-defined networks]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
@@ -10,12 +10,12 @@ toc::[]
|
||||
|
||||
include::modules/virt-adding-vm-to-service-mesh.adoc[leveloffset=+1]
|
||||
|
||||
// Hiding in OSD until PR 67901 merges
|
||||
ifndef::openshift-dedicated[]
|
||||
// Hiding in OSD until PR 67901 merges - HCP hidden as well
|
||||
ifndef::openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_virt-connecting-vm-to-service-mesh"]
|
||||
== Additional resources
|
||||
* xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[Installing the Service Mesh Operators]
|
||||
* xref:../../service_mesh/v2x/ossm-create-smcp.adoc#ossm-create-smcp[Creating the Service Mesh control plane]
|
||||
* xref:../../service_mesh/v2x/ossm-create-mesh.adoc#ossm-create-mesh[Adding projects to the Service Mesh member roll]
|
||||
endif::openshift-dedicated[]
|
||||
endif::openshift-dedicated,openshift-rosa-hcp[]
|
||||
@@ -6,12 +6,12 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can configure a dedicated xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Multus network] for live migration. A dedicated network minimizes the effects of network saturation on tenant workloads during live migration.
|
||||
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[]
|
||||
You can configure a dedicated xref:../../virt/vm_networking/virt-dedicated-network-live-migration.adoc#virt-configuring-secondary-network-vm-live-migration_virt-dedicated-network-live-migration[secondary network] for live migration. A dedicated network minimizes the effects of network saturation on tenant workloads during live migration.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-configuring-secondary-network-vm-live-migration.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -11,21 +11,21 @@ You can expose a virtual machine within the cluster or outside the cluster by cr
|
||||
include::modules/virt-about-services.adoc[leveloffset=+1]
|
||||
|
||||
// Hiding in ROSA/OSD as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../networking/networking_operators/metallb-operator/metallb-operator-install.adoc#metallb-operator-install_metallb-operator-install[Installing the MetalLB Operator]
|
||||
* xref:../../networking/metallb/metallb-configure-services.adoc#metallb-configure-services[Configuring services to use MetalLB]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-dual-stack-support-services.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-creating-service-cli.adoc[leveloffset=+1]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_creating-service-vm"]
|
||||
== Additional resources
|
||||
* xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc#configuring-ingress-cluster-traffic-nodeport[Configuring ingress cluster traffic using a NodePort]
|
||||
* xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-load-balancer.adoc#configuring-ingress-cluster-traffic-load-balancer[Configuring ingress cluster traffic using a load balancer]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
@@ -6,19 +6,19 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can add or remove secondary network interfaces without stopping your virtual machine (VM). {VirtProductName} supports hot plugging and hot unplugging for secondary interfaces that use bridge binding and the VirtIO device driver.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can add or remove secondary network interfaces without stopping your virtual machine (VM). {VirtProductName} supports hot plugging and hot unplugging for secondary interfaces that use bridge binding and the VirtIO device driver. {VirtProductName} also supports hot plugging secondary interfaces that use SR-IOV binding.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Hot unplugging is not supported for Single Root I/O Virtualization (SR-IOV) interfaces.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="virtio-limitations_virt-hot-plugging-network-interfaces"]
|
||||
== VirtIO limitations
|
||||
@@ -40,9 +40,9 @@ include::modules/virt-hot-unplugging-bridge-network-interface-cli.adoc[leveloffs
|
||||
== Additional resources
|
||||
|
||||
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#installing-virtctl_virt-using-the-cli-tools[Installing virtctl]
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#creating-linux-bridge-nad[Creating a Linux bridge network attachment definition]
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#configuring-vm-network-interface[Connecting a virtual machine to a Linux bridge network]
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#nw-sriov-network-attachment_virt-connecting-vm-to-sriov[Creating an SR-IOV network attachment definition]
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-attaching-vm-to-sriov-network_virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
@@ -57,13 +57,13 @@ Each VM is connected by default to the default internal pod network. You can add
|
||||
xref:../../virt/vm_networking/virt-exposing-vm-with-service.adoc#virt-exposing-vm-with-service[Exposing a virtual machine as a service]::
|
||||
|
||||
// Hiding from ROSA/OSD until OSDOCS-3691 is merged
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can expose a VM within the cluster or outside the cluster by creating a `Service` object. For on-premise clusters, you can configure a load balancing service by using the MetalLB Operator. You can xref:../../networking/networking_operators/metallb-operator/metallb-operator-install.adoc#metallb-operator-install_metallb-operator-install[install the MetalLB Operator] by using the {product-title} web console or the CLI.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
// Hiding from ROSA/OSD until OSDOCS-3691 is merged
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can expose a VM within the cluster or outside the cluster by creating a `Service` object.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
[id="primary-udn-config"]
|
||||
== Configuring a primary user-defined network
|
||||
@@ -77,26 +77,26 @@ User-defined networks with the `layer2` overlay topology are useful for VM workl
|
||||
[id="secondary-network-config"]
|
||||
== Configuring VM secondary network interfaces
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can connect a virtual machine to a secondary network by using Linux bridge, SR-IOV and OVN-Kubernetes CNI plugins. You can list multiple secondary networks and interfaces in the VM specification. It is not required to specify the primary pod network in the VM specification when connecting to a secondary network interface.
|
||||
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[]
|
||||
You can connect a virtual machine to a secondary network by using an OVN-Kubernetes Container Network Interface (CNI) plugin. It is not required to specify the primary pod network in the VM specification when connecting to a secondary network interface.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
|
||||
xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Connecting a virtual machine to an OVN-Kubernetes secondary network]::
|
||||
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can connect a VM to an Open Virtual Network (OVN)-Kubernetes secondary network. {VirtProductName} supports the `layer2` topology for OVN-Kubernetes.
|
||||
+
|
||||
--
|
||||
A `layer2` topology connects workloads by a cluster-wide logical switch. The OVN-Kubernetes CNI plugin uses the Geneve (Generic Network Virtualization Encapsulation) protocol to create an overlay network between nodes. You can use this overlay network to connect VMs on different nodes, without having to configure any additional physical networking infrastructure.
|
||||
--
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can connect a VM to an OVN-Kubernetes secondary network. {VirtProductName} supports the `layer2` and `localnet` topologies for OVN-Kubernetes. The `localnet` topology is the recommended way of exposing VMs to the underlying physical network, with or without VLAN encapsulation.
|
||||
+
|
||||
--
|
||||
@@ -104,25 +104,25 @@ You can connect a VM to an OVN-Kubernetes secondary network. {VirtProductName} s
|
||||
|
||||
* A `localnet` topology connects the secondary network to the physical underlay. This enables both east-west cluster traffic and access to services running outside the cluster, but it requires additional configuration of the underlying Open vSwitch (OVS) system on cluster nodes.
|
||||
--
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
// Updated the xref to the correct ID
|
||||
|
||||
To configure an OVN-Kubernetes secondary network and attach a VM to that network, perform the following steps:
|
||||
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#creating-ovn-nad_virt-connecting-vm-to-ovn-secondary-network[Configure an OVN-Kubernetes secondary network] by creating a network attachment definition (NAD).
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
For `localnet` topology, you must xref:../../networking/multiple_networks/secondary_networks/creating-secondary-nwt-ovnk.adoc#configuration-localnet-switched-topology_configuring-additional-network-ovnk[configure an OVS bridge] by creating a `NodeNetworkConfigurationPolicy` object before creating the NAD.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#attaching-vm-to-ovn-secondary-nw[Connect the VM to the OVN-Kubernetes secondary network] by adding the network details to the VM specification.
|
||||
|
||||
// Hiding from ROSA/OSD as SR-IOV not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network]::
|
||||
|
||||
You can use Single Root I/O Virtualization (SR-IOV) network devices with additional networks on your {product-title} cluster installed on bare metal or Red Hat OpenStack Platform (RHOSP) infrastructure for applications that require high bandwidth or low latency.
|
||||
@@ -134,11 +134,11 @@ You can connect a VM to an SR-IOV network by performing the following steps:
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#nw-sriov-configuring-device_virt-connecting-vm-to-sriov[Configure an SR-IOV network device] by creating a `SriovNetworkNodePolicy` CRD.
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#nw-sriov-network-attachment_virt-connecting-vm-to-sriov[Configure an SR-IOV network] by creating an `SriovNetwork` object.
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-attaching-vm-to-sriov-network_virt-connecting-vm-to-sriov[Connect the VM to the SR-IOV network] by including the network details in the VM configuration.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
|
||||
// Hiding from ROSA/OSD as Linux Bridge not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Connecting a virtual machine to a Linux bridge network]::
|
||||
|
||||
xref:../../networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc#k8s-nmstate-about-the-k8s-nmstate-operator[Install the Kubernetes NMState Operator] to configure Linux bridges, VLANs, and bonding for your secondary networks. The OVN-Kubernetes `localnet` topology is the recommended way of connecting a VM to the underlying physical network, but {VirtProductName} also supports Linux bridge networks.
|
||||
@@ -153,47 +153,47 @@ You can create a Linux bridge network and attach a VM to the network by performi
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-creating-linux-bridge-nncp_virt-connecting-vm-to-linux-bridge[Configure a Linux bridge network device] by creating a `NodeNetworkConfigurationPolicy` custom resource definition (CRD).
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#creating-linux-bridge-nad[Configure a Linux bridge network] by creating a `NetworkAttachmentDefinition` CRD.
|
||||
. xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#configuring-vm-network-interface[Connect the VM to the Linux bridge network] by including the network details in the VM configuration.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
|
||||
//ROSA/OSD supports hot plugging with bridge binding and layer2 OVN-Kubernetes topology
|
||||
xref:../../virt/vm_networking/virt-hot-plugging-network-interfaces.adoc#virt-hot-plugging-network-interfaces[Hot plugging secondary network interfaces]::
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
You can add or remove secondary network interfaces without stopping your VM. {VirtProductName} supports hot plugging and hot unplugging for secondary interfaces that use bridge binding and the VirtIO device driver. {VirtProductName} also supports hot plugging secondary interfaces that use the SR-IOV binding.
|
||||
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[]
|
||||
You can add or remove secondary network interfaces without stopping your VM. {VirtProductName} supports hot plugging and hot unplugging for secondary interfaces that use bridge binding and the OVN-Kubernetes `layer2` topology.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
|
||||
// Hiding in ROSA/OSD as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
xref:../../virt/vm_networking/virt-using-dpdk-with-sriov.adoc#virt-using-dpdk-with-sriov[Using DPDK with SR-IOV]::
|
||||
|
||||
The Data Plane Development Kit (DPDK) provides a set of libraries and drivers for fast packet processing. You can configure clusters and VMs to run DPDK workloads over SR-IOV networks.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
xref:../../virt/vm_networking/virt-dedicated-network-live-migration.adoc#virt-dedicated-network-live-migration[Configuring a dedicated network for live migration]::
|
||||
|
||||
You can configure a dedicated xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Multus network] for live migration. A dedicated network minimizes the effects of network saturation on tenant workloads during live migration.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
// Hiding in ROSA/OSD as not supported Tech Preview
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
xref:../../virt/vm_networking/virt-accessing-vm-secondary-network-fqdn.adoc#virt-accessing-vm-secondary-network-fqdn[Accessing a virtual machine by using the cluster FQDN]::
|
||||
|
||||
You can access a VM that is attached to a secondary network interface from outside the cluster by using its fully qualified domain name (FQDN).
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
xref:../../virt/vm_networking/virt-configuring-viewing-ips-for-vms.adoc#virt-configuring-viewing-ips-for-vms[Configuring and viewing IP addresses]::
|
||||
|
||||
You can configure an IP address of a secondary network interface when you create a VM. The IP address is provisioned with cloud-init. You can view the IP address of a VM by using the {product-title} web console or the command line. The network information is collected by the QEMU guest agent.
|
||||
|
||||
// Hiding from ROSA/OSD as Linux Bridge is not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[id="comparing-bridge-localnet"]
|
||||
=== Comparing Linux bridge CNI and OVN-Kubernetes localnet topology
|
||||
|
||||
@@ -227,7 +227,7 @@ The following table provides a comparison of features available when using the L
|
||||
|Yes
|
||||
|
||||
|===
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
|
||||
[id="service-mesh-integration"]
|
||||
|
||||
@@ -13,16 +13,16 @@ You can configure clusters and virtual machines (VMs) to run DPDK workloads over
|
||||
include::modules/virt-configuring-cluster-dpdk.adoc[leveloffset=+1]
|
||||
|
||||
// Hiding until PR 65079 is merged
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources_configuring-cluster-dpdk"]
|
||||
.Additional resources
|
||||
* xref:../../scalability_and_performance/using-cpu-manager.adoc#using-cpu-manager[Using CPU Manager and Topology Manager]
|
||||
* xref:../../scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.adoc#configuring-huge-pages_huge-pages[Configuring huge pages]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
// Hiding as not supported
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* link:https://access.redhat.com/solutions/5688941[Creating a custom machine config pool]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
include::modules/virt-removing-custom-mcp.adoc[leveloffset=+2]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user