diff --git a/_topic_map.yml b/_topic_map.yml index 6db5254cb3..3b3b3dfca0 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -1457,190 +1457,187 @@ Topics: File: rhbjaeger-removing --- -Name: Container-native virtualization -Dir: cnv +Name: OpenShift virtualization +Dir: virt Distros: openshift-enterprise,openshift-webscale Topics: -- Name: About container-native virtualization - File: cnv-about-cnv -- Name: Container-native virtualization release notes - Dir: cnv_release_notes +- Name: About OpenShift virtualization + File: about-virt +- Name: OpenShift virtualization release notes + File: virt-2-4-release-notes +- Name: OpenShift virtualization installation + Dir: install Topics: - - Name: Container-native virtualization release notes - File: cnv-2-4-release-notes -- Name: Container-native virtualization installation - Dir: cnv_install - Topics: - - Name: Preparing your OpenShift cluster for container-native virtualization - File: preparing-cluster-for-cnv - - Name: Installing container-native virtualization - File: installing-container-native-virtualization + - Name: Preparing your OpenShift cluster for OpenShift virtualization + File: preparing-cluster-for-virt + - Name: Installing OpenShift virtualization + File: installing-virt - Name: Installing the virtctl client - File: cnv-installing-virtctl - - Name: Uninstalling container-native virtualization - File: uninstalling-container-native-virtualization -- Name: Upgrading container-native virtualization - File: upgrading-container-native-virtualization + File: virt-installing-virtctl + - Name: Uninstalling OpenShift virtualization + File: uninstalling-virt +- Name: Upgrading OpenShift virtualization + File: upgrading-virt - Name: Using the CLI tools - File: cnv-using-the-cli-tools + File: virt-using-the-cli-tools - Name: Virtual machines - Dir: cnv_virtual_machines + Dir: virtual_machines Topics: ###VIRTUAL MACHINE CHESS SALAD (silly name to highlight that the commented out assemblies need to be checked against merged filenams) - Name: Creating virtual machines - File: cnv-create-vms + File: virt-create-vms - Name: Editing virtual machines - File: cnv-edit-vms + File: virt-edit-vms - Name: Editing boot order - File: cnv-edit-boot-order + File: virt-edit-boot-order - Name: Deleting virtual machines - File: cnv-delete-vms + File: virt-delete-vms - Name: Deleting virtual machine instances - File: cnv-deleting-vmis - - Name: Controlling virtual machine states - File: cnv-controlling-vm-states + File: virt-deleting-vmis + - Name: Controlling virtual machines states + File: virt-controlling-vm-states - Name: Accessing virtual machine consoles - File: cnv-accessing-vm-consoles + File: virt-accessing-vm-consoles - Name: Installing VirtIO driver on an existing Windows virtual machine - File: cnv-installing-virtio-drivers-on-existing-windows-vm + File: virt-installing-virtio-drivers-on-existing-windows-vm - Name: Installing VirtIO driver on a new Windows virtual machine - File: cnv-installing-virtio-drivers-on-new-windows-vm + File: virt-installing-virtio-drivers-on-new-windows-vm - Name: Advanced virtual machine management - Dir: cnv_advanced_vm_management + Dir: advanced_vm_management Topics: #Advanced virtual machine configuration - Name: Automating management tasks - File: cnv-automating-management-tasks + File: virt-automating-management-tasks - Name: Configuring PXE booting for virtual machines - File: cnv-configuring-pxe-booting + File: virt-configuring-pxe-booting - Name: Managing guest memory - File: cnv-managing-guest-memory + File: virt-managing-guest-memory - Name: Enabling dedicated resources for a virtual machine - File: cnv-dedicated-resources-vm -#Importing virtual machines + File: virt-dedicated-resources-vm +# Importing virtual machines - Name: Importing virtual machines - Dir: cnv_importing_vms + Dir: importing_vms Topics: - Name: TLS certificates for DataVolume imports - File: cnv-tls-certificates-for-dv-imports + File: virt-tls-certificates-for-dv-imports - Name: Importing virtual machine images with DataVolumes - File: cnv-importing-virtual-machine-images-datavolumes + File: virt-importing-virtual-machine-images-datavolumes - Name: Importing virtual machine images to block storage with DataVolumes - File: cnv-importing-virtual-machine-images-datavolumes-block + File: virt-importing-virtual-machine-images-datavolumes-block - Name: Importing a VMware virtual machine or template - File: cnv-importing-vmware-vm -#Cloning virtual machines + File: virt-importing-vmware-vm +# Cloning virtual machines - Name: Cloning virtual machines - Dir: cnv_cloning_vms + Dir: cloning_vms Topics: - Name: Enabling user permissions to clone DataVolumes across namespaces - File: cnv-enabling-user-permissions-to-clone-datavolumes + File: virt-enabling-user-permissions-to-clone-datavolumes - Name: Cloning a virtual machine disk into a new DataVolume - File: cnv-cloning-vm-disk-into-new-datavolume + File: virt-cloning-vm-disk-into-new-datavolume - Name: Cloning a virtual machine by using a DataVolumeTemplate - File: cnv-cloning-vm-using-datavolumetemplate + File: virt-cloning-vm-using-datavolumetemplate - Name: Cloning a virtual machine disk into a new block storage DataVolume - File: cnv-cloning-vm-disk-into-new-datavolume-block -#Virtual machine networking + File: virt-cloning-vm-disk-into-new-datavolume-block +# Virtual machine networking - Name: Virtual machine networking - Dir: cnv_vm_networking + Dir: vm_networking Topics: - - Name: Using the default Pod network with container-native virtualization - File: cnv-using-the-default-pod-network-with-cnv + - Name: Using the default Pod network with OpenShift virtualization + File: virt-using-the-default-pod-network-with-virt - Name: Attaching a virtual machine to multiple networks - File: cnv-attaching-vm-multiple-networks + File: virt-attaching-vm-multiple-networks - Name: Installing the QEMU guest agent on virtual machines - File: cnv-installing-qemu-guest-agent + File: virt-installing-qemu-guest-agent - Name: Viewing the IP address of NICs on a virtual machine - File: cnv-viewing-ip-of-vm-nic -#A BETTER NAME THAN 'STORAGE 4 U' + File: virt-viewing-ip-of-vm-nic +# A BETTER NAME THAN 'STORAGE 4 U' - Name: Virtual machine disks - Dir: cnv_virtual_disks + Dir: virtual_disks Topics: - Name: Configuring local storage for virtual machines - File: cnv-configuring-local-storage-for-vms + File: virt-configuring-local-storage-for-vms - Name: Uploading local disk images by using the virtctl tool - File: cnv-uploading-local-disk-images-virtctl + File: virt-uploading-local-disk-images-virtctl - Name: Uploading a local disk image to a block storage DataVolume - File: cnv-uploading-local-disk-images-block + File: virt-uploading-local-disk-images-block - Name: Moving a local virtual machine disk to a different node - File: cnv-moving-local-vm-disk-to-different-node + File: virt-moving-local-vm-disk-to-different-node - Name: Expanding virtual storage by adding blank disk images - File: cnv-expanding-virtual-storage-with-blank-disk-images + File: virt-expanding-virtual-storage-with-blank-disk-images - Name: Storage defaults for DataVolumes - File: cnv-storage-defaults-for-datavolumes + File: virt-storage-defaults-for-datavolumes - Name: Preparing CDI scratch space - File: cnv-preparing-cdi-scratch-space + File: virt-preparing-cdi-scratch-space - Name: Deleting DataVolumes - File: cnv-deleting-datavolumes -#Templates + File: virt-deleting-datavolumes +# Templates - Name: Virtual machine templates - Dir: cnv_vm_templates + Dir: vm_templates Topics: - Name: Creating virtual machine templates - File: cnv-creating-vm-template + File: virt-creating-vm-template - Name: Editing a virtual machine template - File: cnv-editing-vm-template + File: virt-editing-vm-template - Name: Enabling dedicated resources for a virtual machine template - File: cnv-dedicated-resources-vm-template + File: virt-dedicated-resources-vm-template - Name: Deleting a virtual machine template - File: cnv-deleting-vm-template -#Virtual machine live migration + File: virt-deleting-vm-template +# Virtual machine live migration - Name: Live migration - Dir: cnv_live_migration + Dir: live_migration Topics: - Name: Virtual machine live migration - File: cnv-live-migration + File: virt-live-migration - Name: Live migration limits and timeouts - File: cnv-live-migration-limits + File: virt-live-migration-limits - Name: Migrating a virtual machine instance to another node - File: cnv-migrate-vmi + File: virt-migrate-vmi - Name: Monitoring live migration of a virtual machine instance - File: cnv-monitor-vmi-migration + File: virt-monitor-vmi-migration - Name: Cancelling the live migration of a virtual machine instance - File: cnv-cancel-vmi-migration + File: virt-cancel-vmi-migration - Name: Configuring virtual machine eviction strategy - File: cnv-configuring-vmi-eviction-strategy -#Node maintenance mode + File: virt-configuring-vmi-eviction-strategy +# Node maintenance mode - Name: Node maintenance - Dir: cnv_node_maintenance + Dir: node_maintenance Topics: - Name: Manually refreshing TLS certificates - File: cnv-refresh-certificates + File: virt-refresh-certificates - Name: Node maintenance mode - File: cnv-node-maintenance + File: virt-node-maintenance - Name: Setting a node to maintenance mode - File: cnv-setting-node-maintenance + File: virt-setting-node-maintenance - Name: Resuming a node from maintenance mode - File: cnv-resuming-node -#Node Networking + File: virt-resuming-node +# Node Networking - Name: Node networking - Dir: cnv_node_network + Dir: node_network Topics: - Name: Observing node network state - File: cnv-observing-node-network-state + File: virt-observing-node-network-state - Name: Updating node network configuration - File: cnv-updating-node-network-config + File: virt-updating-node-network-config - Name: Troubleshooting node network configuration - File: cnv-troubleshooting-node-network -#Logging, events, and monitoring + File: virt-troubleshooting-node-network +# Logging, events, and monitoring - Name: Logging, events, and monitoring - Dir: cnv_logging_events_monitoring + Dir: logging_events_monitoring Topics: - Name: Viewing logs - File: cnv-logs + File: virt-logs - Name: Viewing events - File: cnv-events + File: virt-events - Name: Viewing information about virtual machine workloads - File: cnv-viewing-information-about-vm-workloads + File: virt-viewing-information-about-vm-workloads - Name: Monitoring virtual machine health - File: cnv-monitoring-vm-health + File: virt-monitoring-vm-health - Name: Viewing cluster information - File: cnv-using-dashboard-to-get-cluster-info + File: virt-using-dashboard-to-get-cluster-info - Name: OpenShift cluster monitoring, logging, and Telemetry - File: cnv-openshift-cluster-monitoring - - Name: Collecting container-native virtualization data for Red Hat Support - File: cnv-collecting-cnv-data + File: virt-openshift-cluster-monitoring + - Name: Collecting OpenShift virtualization data for Red Hat Support + File: virt-collecting-virt-data --- # OpenShift Serverless Name: Serverless applications diff --git a/cnv/cnv-about-cnv.adoc b/cnv/cnv-about-cnv.adoc deleted file mode 100644 index 29ffd2c53e..0000000000 --- a/cnv/cnv-about-cnv.adoc +++ /dev/null @@ -1,14 +0,0 @@ -[id="cnv-about-cnv"] -= About container-native virtualization -include::modules/cnv-document-attributes.adoc[] -:context: cnv-about-cnv -toc::[] - -Learn about {CNVProductName}'s capabilities and support scope. - -include::modules/cnv-what-you-can-do-with-cnv.adoc[leveloffset=+1] - -== {CNVProductNameStart} support - -:FeatureName: {CNVProductNameStart} -include::modules/technology-preview.adoc[leveloffset=+2] diff --git a/cnv/cnv-using-the-cli-tools.adoc b/cnv/cnv-using-the-cli-tools.adoc deleted file mode 100644 index eb99c73b1f..0000000000 --- a/cnv/cnv-using-the-cli-tools.adoc +++ /dev/null @@ -1,20 +0,0 @@ -[id="cnv-using-the-cli-tools"] -= Using the CLI tools -include::modules/cnv-document-attributes.adoc[] -:context: using-the-cli-tools -toc::[] - -The two primary CLI tools used for managing resources in the cluster are: - -* The {CNVProductName} `virtctl` client -* The {product-title} `oc` client - -.Prerequisites - -* You must xref:../cnv/cnv_install/cnv-installing-virtctl.adoc#cnv-installing-virtctl[install the `virtctl` client]. - -include::modules/cnv-virtctl-commands.adoc[leveloffset=+1] -include::modules/cnv-openshift-client-commands.adoc[leveloffset=+1] - -For more comprehensive information on `oc` client commands, see the -xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#cli_reference[{product-title} CLI tools] documentation. diff --git a/cnv/cnv_install/cnv-installing-virtctl.adoc b/cnv/cnv_install/cnv-installing-virtctl.adoc deleted file mode 100644 index d473a67b31..0000000000 --- a/cnv/cnv_install/cnv-installing-virtctl.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="cnv-installing-virtctl"] -= Installing the `virtctl` client -include::modules/cnv-document-attributes.adoc[] -:context: cnv-installing-virtctl -toc::[] - -The `virtctl` client is a command-line utility for managing {CNVProductName} -resources. - -Install the client to your system by enabling the {CNVProductName} repository and -installing the `kubevirt-virtctl` package. - -include::modules/cnv-enabling-cnv-repos.adoc[leveloffset=+1] -include::modules/cnv-installing-virtctl-client.adoc[leveloffset=+1] - -See also: -xref:../../cnv/cnv-using-the-cli-tools.adoc#cnv-using-the-cli-tools[Using the CLI tools] for {CNVProductName}. diff --git a/cnv/cnv_install/installing-container-native-virtualization.adoc b/cnv/cnv_install/installing-container-native-virtualization.adoc deleted file mode 100644 index c14039d9d4..0000000000 --- a/cnv/cnv_install/installing-container-native-virtualization.adoc +++ /dev/null @@ -1,22 +0,0 @@ -[id="installing-container-native-virtualization"] -= Installing container-native virtualization -include::modules/cnv-document-attributes.adoc[] -:context: installing-container-native-virtualization -toc::[] - -Install {CNVProductName} to add virtualization functionality to your {product-title} -cluster. - -You can use the {product-title} {product-version} -xref:../../web_console/web-console.adoc#web-console-overview_web-console[web console] -to subscribe to and deploy the {CNVProductName} Operators. - -.Prerequisites -* {product-title} {product-version} - -:FeatureName: {CNVProductNameStart} -include::modules/technology-preview.adoc[leveloffset=+1] - -include::modules/cnv-subscribing-to-the-catalog.adoc[leveloffset=+1] - -include::modules/cnv-deploying-cnv.adoc[leveloffset=+1] diff --git a/cnv/cnv_install/uninstalling-container-native-virtualization.adoc b/cnv/cnv_install/uninstalling-container-native-virtualization.adoc deleted file mode 100644 index 9d8f06f238..0000000000 --- a/cnv/cnv_install/uninstalling-container-native-virtualization.adoc +++ /dev/null @@ -1,32 +0,0 @@ -[id="uninstalling-container-native-virtualization"] -= Uninstalling container-native virtualization -include::modules/cnv-document-attributes.adoc[] -:context: uninstalling-container-native-virtualization -toc::[] - -You can uninstall {CNVProductName} by using the {product-title} -xref:../../web_console/web-console.adoc#web-console-overview_web-console[web console]. - -.Prerequisites - -* You must have {CNVProductName} {CNVVersion} installed. -* You must delete all xref:../../cnv/cnv_virtual_machines/cnv-delete-vms.adoc#cnv-delete-vm-web_cnv-delete-vms[virtual machines], -xref:../../cnv/cnv_virtual_machines/cnv-deleting-vmis.adoc#cnv-deleting-vmi_cnv-deleting-vmis[virtual machine instances], -and xref:../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-deleting-datavolumes.adoc#cnv-deleting-dvs_cnv-deleting-datavolumes[DataVolumes]. -+ -[IMPORTANT] -==== -Attempting to uninstall {CNVProductName} without deleting these objects -results in failure. -==== - -include::modules/cnv-deleting-custom-resource.adoc[leveloffset=+1] - -include::modules/cnv-deleting-catalog-subscription.adoc[leveloffset=+1] - -[NOTE] -==== -You can now delete the `openshift-cnv` namespace. -==== - -include::modules/deleting-a-namespace-using-the-web-console.adoc[leveloffset=+1] diff --git a/cnv/cnv_live_migration/cnv-live-migration-limits.adoc b/cnv/cnv_live_migration/cnv-live-migration-limits.adoc deleted file mode 100644 index 4d1cf862df..0000000000 --- a/cnv/cnv_live_migration/cnv-live-migration-limits.adoc +++ /dev/null @@ -1,14 +0,0 @@ -[id="cnv-live-migration-limits"] -= Live migration limits and timeouts -include::modules/cnv-document-attributes.adoc[] -:context: cnv-live-migration-limits -toc::[] - -Live migration limits and timeouts are applied so that migration processes do -not overwhelm the cluster. Configure these settings by editing the -`kubevirt-config` configuration file. - -include::modules/cnv-configuring-live-migration-limits.adoc[leveloffset=+1] -include::modules/cnv-live-migration-limits-reftable.adoc[leveloffset=+1] - - diff --git a/cnv/cnv_live_migration/cnv-live-migration.adoc b/cnv/cnv_live_migration/cnv-live-migration.adoc deleted file mode 100644 index 2735503f99..0000000000 --- a/cnv/cnv_live_migration/cnv-live-migration.adoc +++ /dev/null @@ -1,13 +0,0 @@ -[id="cnv-live-migration"] -= Virtual machine live migration -include::modules/cnv-document-attributes.adoc[] -:context: cnv-live-migration -toc::[] - -include::modules/cnv-understanding-live-migration.adoc[leveloffset=+1] - -.Additional resources: - -* xref:../../cnv/cnv_live_migration/cnv-migrate-vmi.adoc#cnv-migrate-vmi[Migrating a virtual machine instance to another node] -* xref:../../cnv/cnv_node_maintenance/cnv-node-maintenance.adoc#cnv-node-maintenance[Node maintenance mode] -* xref:../../cnv/cnv_live_migration/cnv-live-migration-limits.adoc#cnv-live-migration-limits[Live migration limiting] diff --git a/cnv/cnv_live_migration/cnv-migrate-vmi.adoc b/cnv/cnv_live_migration/cnv-migrate-vmi.adoc deleted file mode 100644 index 9bbd8bd0b7..0000000000 --- a/cnv/cnv_live_migration/cnv-migrate-vmi.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="cnv-migrate-vmi"] -= Migrating a virtual machine instance to another node -include::modules/cnv-document-attributes.adoc[] -include::modules/common-attributes.adoc[] -:context: cnv-migrate-vmi -toc::[] - -Manually initiate a live migration of a virtual machine instance to another node using either the web console or the CLI. - -include::modules/cnv-initiating-vm-migration-web.adoc[leveloffset=+1] -include::modules/cnv-initiating-vm-migration-cli.adoc[leveloffset=+1] - -.Additional resources: - -* xref:../../cnv/cnv_live_migration/cnv-monitor-vmi-migration.adoc#cnv-monitor-vmi-migration[Monitoring live migration of a virtual machine instance] -* xref:../../cnv/cnv_live_migration/cnv-cancel-vmi-migration.adoc#cnv-cancel-vmi-migration[Cancelling the live migration of a virtual machine instance] - diff --git a/cnv/cnv_live_migration/cnv-monitor-vmi-migration.adoc b/cnv/cnv_live_migration/cnv-monitor-vmi-migration.adoc deleted file mode 100644 index 857fe4fe6c..0000000000 --- a/cnv/cnv_live_migration/cnv-monitor-vmi-migration.adoc +++ /dev/null @@ -1,11 +0,0 @@ -[id="cnv-monitor-vmi-migration"] -= Monitoring live migration of a virtual machine instance -include::modules/cnv-document-attributes.adoc[] -:context: cnv-monitor-vmi-migration -toc::[] - -You can monitor the progress of a live migration of a virtual machine instance from either the web console or the CLI. - -include::modules/cnv-monitoring-vm-migration-web.adoc[leveloffset=+1] -include::modules/cnv-monitoring-vm-migration-cli.adoc[leveloffset=+1] - diff --git a/cnv/cnv_logging_events_monitoring/cnv-events.adoc b/cnv/cnv_logging_events_monitoring/cnv-events.adoc deleted file mode 100644 index 6c561575e3..0000000000 --- a/cnv/cnv_logging_events_monitoring/cnv-events.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="cnv-events"] -= Viewing events -include::modules/cnv-document-attributes.adoc[] -:context: cnv-events -toc::[] - -include::modules/cnv-understanding-events.adoc[leveloffset=+1] - -See also: -xref:../../nodes/clusters/nodes-containers-events.adoc#nodes-containers-events[Viewing system event information in an {product-title} cluster]. - -include::modules/cnv-viewing-vm-events-web.adoc[leveloffset=+1] - -include::modules/cnv-viewing-namespace-events-cli.adoc[leveloffset=+1] - -include::modules/cnv-viewing-resource-events-cli.adoc[leveloffset=+1] - diff --git a/cnv/cnv_logging_events_monitoring/cnv-logs.adoc b/cnv/cnv_logging_events_monitoring/cnv-logs.adoc deleted file mode 100644 index 5b65dff7b1..0000000000 --- a/cnv/cnv_logging_events_monitoring/cnv-logs.adoc +++ /dev/null @@ -1,11 +0,0 @@ -[id="cnv-logs"] -= Viewing virtual machine logs -include::modules/cnv-document-attributes.adoc[] -:context: cnv-logs -toc::[] - -include::modules/cnv-understanding-logs.adoc[leveloffset=+1] - -include::modules/cnv-viewing-virtual-machine-logs-cli.adoc[leveloffset=+1] - -include::modules/cnv-viewing-virtual-machine-logs-web.adoc[leveloffset=+1] diff --git a/cnv/cnv_logging_events_monitoring/cnv-monitoring-vm-health.adoc b/cnv/cnv_logging_events_monitoring/cnv-monitoring-vm-health.adoc deleted file mode 100644 index 842737e17b..0000000000 --- a/cnv/cnv_logging_events_monitoring/cnv-monitoring-vm-health.adoc +++ /dev/null @@ -1,13 +0,0 @@ -[id="cnv-monitoring-vm-health"] -= Monitoring virtual machine health -include::modules/cnv-document-attributes.adoc[] -:context: cnv-monitoring-vm-health -toc::[] - -Use this procedure to create liveness and readiness probes -to monitor virtual machine health. - -include::modules/cnv-about-liveness-readiness-probes.adoc[leveloffset=+1] -include::modules/cnv-define-http-liveness-probe.adoc[leveloffset=+1] -include::modules/cnv-define-tcp-liveness-probe.adoc[leveloffset=+1] -include::modules/cnv-define-readiness-probe.adoc[leveloffset=+1] diff --git a/cnv/cnv_logging_events_monitoring/cnv-viewing-information-about-vm-workloads.adoc b/cnv/cnv_logging_events_monitoring/cnv-viewing-information-about-vm-workloads.adoc deleted file mode 100644 index 6a3c3f1bef..0000000000 --- a/cnv/cnv_logging_events_monitoring/cnv-viewing-information-about-vm-workloads.adoc +++ /dev/null @@ -1,9 +0,0 @@ -[id="cnv-viewing-information-about-vm-workloads"] -= Viewing information about virtual machine workloads -include::modules/cnv-document-attributes.adoc[] -:context: cnv-viewing-information-about-vm-workloads -toc::[] - -You can view high-level information about your virtual machines by using the *Virtual Machines* dashboard in the {product-title} web console. - -include::modules/cnv-about-the-vm-dashboard.adoc[leveloffset=+1] diff --git a/cnv/cnv_node_maintenance/cnv-node-maintenance.adoc b/cnv/cnv_node_maintenance/cnv-node-maintenance.adoc deleted file mode 100644 index 7fed970255..0000000000 --- a/cnv/cnv_node_maintenance/cnv-node-maintenance.adoc +++ /dev/null @@ -1,12 +0,0 @@ -[id="cnv-node-maintenance"] -= Node maintenance mode -include::modules/cnv-document-attributes.adoc[] -:context: cnv-node-maintenance -toc::[] - -include::modules/cnv-understanding-node-maintenance.adoc[leveloffset=+1] - -.Additional resources: - -* xref:../../cnv/cnv_live_migration/cnv-live-migration.adoc#cnv-live-migration[Virtual machine live migration] -* xref:../../cnv/cnv_live_migration/cnv-configuring-vmi-eviction-strategy.adoc#cnv-configuring-vmi-eviction-strategy[Configuring virtual machine eviction strategy] diff --git a/cnv/cnv_node_maintenance/cnv-refresh-certificates.adoc b/cnv/cnv_node_maintenance/cnv-refresh-certificates.adoc deleted file mode 100644 index 5e98f67065..0000000000 --- a/cnv/cnv_node_maintenance/cnv-refresh-certificates.adoc +++ /dev/null @@ -1,13 +0,0 @@ -[id="cnv-refresh-certificates"] -= Manually refreshing TLS certificates -include::modules/cnv-document-attributes.adoc[] -include::modules/common-attributes.adoc[] -:context: cnv-refresh-certificates -toc::[] - -The TLS certificates for {CNVProductName} components are created at the time -of installation and are valid for one year. You must manually refresh -these certificates before they expire. - -include::modules/cnv-refreshing-certificates.adoc[leveloffset=+1] - diff --git a/cnv/cnv_node_maintenance/cnv-resuming-node.adoc b/cnv/cnv_node_maintenance/cnv-resuming-node.adoc deleted file mode 100644 index b977644bfb..0000000000 --- a/cnv/cnv_node_maintenance/cnv-resuming-node.adoc +++ /dev/null @@ -1,14 +0,0 @@ -[id="cnv-resuming-node"] -= Resuming a node from maintenance mode -include::modules/cnv-document-attributes.adoc[] -include::modules/common-attributes.adoc[] -:context: cnv-resuming-node -toc::[] - -Resuming a node brings it out of maintenance mode and schedulable again. - -Resume a node from maintenance from either the web console or the CLI. - -include::modules/cnv-resuming-node-maintenance-web.adoc[leveloffset=+1] -include::modules/cnv-resuming-node-maintenance-cli.adoc[leveloffset=+1] - diff --git a/cnv/cnv_node_maintenance/cnv-setting-node-maintenance.adoc b/cnv/cnv_node_maintenance/cnv-setting-node-maintenance.adoc deleted file mode 100644 index 58f2d078ae..0000000000 --- a/cnv/cnv_node_maintenance/cnv-setting-node-maintenance.adoc +++ /dev/null @@ -1,18 +0,0 @@ -[id="cnv-setting-node-maintenance"] -= Setting a node to maintenance mode -include::modules/cnv-document-attributes.adoc[] -include::modules/common-attributes.adoc[] -:context: cnv-setting-node-maintenance -toc::[] - -include::modules/cnv-understanding-node-maintenance.adoc[leveloffset=+1] - -Place a node into maintenance from either the web console or the CLI. - -include::modules/cnv-setting-node-maintenance-web.adoc[leveloffset=+1] -include::modules/cnv-setting-node-maintenance-cli.adoc[leveloffset=+1] - -.Additional resources: - -* xref:../../cnv/cnv_node_maintenance/cnv-resuming-node.adoc#cnv-resuming-node[Resuming a node from maintenance mode] - diff --git a/cnv/cnv_node_network/cnv-observing-node-network-state.adoc b/cnv/cnv_node_network/cnv-observing-node-network-state.adoc deleted file mode 100644 index 050400ef15..0000000000 --- a/cnv/cnv_node_network/cnv-observing-node-network-state.adoc +++ /dev/null @@ -1,14 +0,0 @@ -[id="cnv-observing-node-network-state"] -= Observing node network state -include::modules/cnv-document-attributes.adoc[] -:context: cnv-observing-node-network-state -toc::[] - -Node network state is the network configuration for all nodes in the cluster. - -include::modules/cnv-about-nmstate.adoc[leveloffset=+1] - -include::modules/cnv-viewing-network-state-of-node.adoc[leveloffset=+1] - - - diff --git a/cnv/cnv_node_network/cnv-updating-node-network-config.adoc b/cnv/cnv_node_network/cnv-updating-node-network-config.adoc deleted file mode 100644 index 8e30df831d..0000000000 --- a/cnv/cnv_node_network/cnv-updating-node-network-config.adoc +++ /dev/null @@ -1,25 +0,0 @@ -[id="cnv-updating-node-network"] -= Updating node network configuration -include::modules/cnv-document-attributes.adoc[] -:context: cnv-updating-node-network-config -toc::[] - -You can update the node network configuration, such as adding or removing interfaces -from nodes, by applying `NodeNetworkConfigurationPolicy` manifests to the cluster. - -include::modules/cnv-about-nmstate.adoc[leveloffset=+1] - -include::modules/cnv-creating-interface-on-nodes.adoc[leveloffset=+1] - -include::modules/cnv-confirming-policy-updates-on-nodes.adoc[leveloffset=+1] - -include::modules/cnv-removing-interface-from-nodes.adoc[leveloffset=+1] - -include::modules/cnv-restoring-node-network-configuration.adoc[leveloffset=+1] - -include::modules/cnv-example-bridge-nncp.adoc[leveloffset=+1] - -include::modules/cnv-example-vlan-nncp.adoc[leveloffset=+1] - -include::modules/cnv-example-bond-nncp.adoc[leveloffset=+1] - diff --git a/cnv/cnv_virtual_machines/cnv-controlling-vm-states.adoc b/cnv/cnv_virtual_machines/cnv-controlling-vm-states.adoc deleted file mode 100644 index f8864e79f3..0000000000 --- a/cnv/cnv_virtual_machines/cnv-controlling-vm-states.adoc +++ /dev/null @@ -1,21 +0,0 @@ -[id="cnv-controlling-vm-states"] -= Controlling virtual machine states -include::modules/cnv-document-attributes.adoc[] -:context: cnv-controlling-vm-states -toc::[] - -You can stop, start, restart, and unpause virtual machines from the web console. - -[NOTE] -==== -To control virtual machines from the command-line interface (CLI), use the -xref:../../cnv/cnv-using-the-cli-tools.html#cnv-virtctl-commands_using-the-cli-tools[`virtctl` client]. -==== - -include::modules/cnv-starting-vm-web.adoc[leveloffset=+1] - -include::modules/cnv-restarting-vm-web.adoc[leveloffset=+1] - -include::modules/cnv-stopping-vm-web.adoc[leveloffset=+1] - -include::modules/cnv-unpausing-vm-web.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv-create-vms.adoc b/cnv/cnv_virtual_machines/cnv-create-vms.adoc deleted file mode 100644 index 43a26fbe45..0000000000 --- a/cnv/cnv_virtual_machines/cnv-create-vms.adoc +++ /dev/null @@ -1,42 +0,0 @@ -[id="cnv-create-vms"] -= Creating virtual machines -include::modules/cnv-document-attributes.adoc[] -:context: cnv-create-vms -toc::[] - - -Use one of these procedures to create a virtual machine: - -* Running the virtual machine wizard -* Pasting a pre-configured YAML file with the virtual machine wizard -* Using the CLI -* xref:../../cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc#cnv-importing-vmware-vm[Importing a VMware virtual machine or template with the virtual machine wizard] - -[WARNING] -==== -Do not create virtual machines in `openshift-*` namespaces. -Instead, create a new namespace or use an existing namespace without the -`openshift` prefix. -==== - -include::modules/cnv-creating-vm-wizard-web.adoc[leveloffset=+1] - -Refer to the virtual machine wizard fields section when running the web console wizard. - -:virtualmachine: -include::modules/cnv-vm-wizard-fields-web.adoc[leveloffset=+2] -include::modules/cnv-cloud-init-fields-web.adoc[leveloffset=+2] -include::modules/cnv-cdrom-wizard-fields-web.adoc[leveloffset=+2] -include::modules/cnv-networking-wizard-fields-web.adoc[leveloffset=+2] -include::modules/cnv-storage-wizard-fields-web.adoc[leveloffset=+2] - -include::modules/cnv-creating-vm-yaml-web.adoc[leveloffset=+1] -include::modules/cnv-creating-vm.adoc[leveloffset=+1] - -:virtualmachine!: - -include::modules/cnv-vm-storage-volume-types.adoc[leveloffset=+1] - -See the -https://kubevirt.io/api-reference/master/definitions.html#_v1_virtualmachinespec[kubevirt -API Reference] for a definitive list of virtual machine settings. diff --git a/cnv/cnv_virtual_machines/cnv-delete-vms.adoc b/cnv/cnv_virtual_machines/cnv-delete-vms.adoc deleted file mode 100644 index 1d1311b794..0000000000 --- a/cnv/cnv_virtual_machines/cnv-delete-vms.adoc +++ /dev/null @@ -1,11 +0,0 @@ -[id="cnv-delete-vms"] -= Deleting virtual machines -include::modules/cnv-document-attributes.adoc[] -:context: cnv-delete-vms -toc::[] - -You can delete a virtual machine from the web console or by using the `oc` -command-line interface. - -include::modules/cnv-delete-vm-web.adoc[leveloffset=+1] -include::modules/cnv-deleting-vms.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv-edit-vms.adoc b/cnv/cnv_virtual_machines/cnv-edit-vms.adoc deleted file mode 100644 index 2856424890..0000000000 --- a/cnv/cnv_virtual_machines/cnv-edit-vms.adoc +++ /dev/null @@ -1,16 +0,0 @@ -[id="cnv-edit-vms"] -= Editing virtual machines -include::modules/cnv-document-attributes.adoc[] -:context: cnv-edit-vms -toc::[] - -You can update a virtual machine configuration using either the YAML editor in the -web console or the OpenShift client on the command line. You can also update -a subset of the parameters in the *Virtual Machine Overview* of the web console. - -include::modules/cnv-editing-vm-web.adoc[leveloffset=+1] -include::modules/cnv-editing-vm-yaml-web.adoc[leveloffset=+1] -include::modules/cnv-editing-vm-cli.adoc[leveloffset=+1] -include::modules/cnv-add-disk-to-vm.adoc[leveloffset=+1] -include::modules/cnv-add-nic-to-vm.adoc[leveloffset=+1] -include::modules/cnv-edit-cdrom-vm.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-existing-windows-vm.adoc b/cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-existing-windows-vm.adoc deleted file mode 100644 index 4b5f609937..0000000000 --- a/cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-existing-windows-vm.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="cnv-installing-virtio-drivers-on-existing-windows-vm"] -= Installing VirtIO driver on an existing Windows virtual machine -include::modules/cnv-document-attributes.adoc[] -:context: cnv-installing-virtio-drivers-on-existing-windows-vm -toc::[] - -include::modules/cnv-understanding-virtio-drivers.adoc[leveloffset=+1] - -See also: xref:../../cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-new-windows-vm.adoc#cnv-installing-virtio-drivers-on-new-windows-vm[Installing Virtio drivers on a new Windows virtual machine]. - -include::modules/cnv-supported-virtio-drivers.adoc[leveloffset=+1] - -include::modules/cnv-adding-virtio-drivers-vm-yaml.adoc[leveloffset=+1] - -include::modules/cnv-installing-virtio-drivers-existing-windows.adoc[leveloffset=+1] - -include::modules/cnv-removing-virtio-disk-from-vm.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-new-windows-vm.adoc b/cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-new-windows-vm.adoc deleted file mode 100644 index a5356469dc..0000000000 --- a/cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-new-windows-vm.adoc +++ /dev/null @@ -1,23 +0,0 @@ -[id="cnv-installing-virtio-drivers-on-new-windows-vm"] -= Installing VirtIO driver on a new Windows virtual machine -include::modules/cnv-document-attributes.adoc[] -:context: cnv-installing-virtio-drivers-on-new-windows-vm" -toc::[] - -.Prerequisites - -* Windows installation media accessible by the virtual machine, such as -xref:../../cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes.adoc#cnv-importing-vm-datavolume_cnv-importing-virtual-machine-images-datavolumes[importing an ISO into a data volume] -and attaching it to the virtual machine. - -include::modules/cnv-understanding-virtio-drivers.adoc[leveloffset=+1] - -See also: xref:../../cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-existing-windows-vm.adoc#cnv-installing-virtio-drivers-on-existing-windows-vm[Installing VirtIO driver on an existing Windows virtual machine]. - -include::modules/cnv-supported-virtio-drivers.adoc[leveloffset=+1] - -include::modules/cnv-adding-virtio-drivers-vm-yaml.adoc[leveloffset=+1] - -include::modules/cnv-installing-virtio-drivers-installing-windows.adoc[leveloffset=+1] - -include::modules/cnv-removing-virtio-disk-from-vm.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-automating-management-tasks.adoc b/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-automating-management-tasks.adoc deleted file mode 100644 index 8a3099b8be..0000000000 --- a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-automating-management-tasks.adoc +++ /dev/null @@ -1,19 +0,0 @@ -[id="cnv-automating-management-tasks"] -= Automating management tasks -include::modules/cnv-document-attributes.adoc[] -:context: cnv-automating-management-tasks -toc::[] - -You can automate {CNVProductName} management tasks by using Red Hat Ansible -Automation Platform. Learn the basics by using an Ansible Playbook to create a new -virtual machine. - -include::modules/cnv-about-red-hat-ansible-automation.adoc[leveloffset=+1] - -include::modules/cnv-automating-virtual-machine-creation-with-ansible.adoc[leveloffset=+1] - -To verify that the virtual machine was created, try to -xref:../../../cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc#cnv-accessing-vm-consoles[access the VM console]. - -include::modules/cnv-example-ansible-playbook-creating-vms.adoc[leveloffset=+1] - diff --git a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-configuring-pxe-booting.adoc b/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-configuring-pxe-booting.adoc deleted file mode 100644 index 7c6ba7acd7..0000000000 --- a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-configuring-pxe-booting.adoc +++ /dev/null @@ -1,23 +0,0 @@ -[id="configuring-pxe-booting"] -= Configuring PXE booting for virtual machines -include::modules/cnv-document-attributes.adoc[] -:context: pxe-booting -toc::[] - -PXE booting, or network booting, is available in {CNVProductName}. -Network booting allows a computer to boot and load an -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. - -.Prerequisites - -* A Linux bridge must be xref:../../../cnv/cnv_virtual_machines/cnv_vm_networking/cnv-attaching-vm-multiple-networks.adoc#attaching-to-multiple-networks[connected]. - -* The PXE server must be connected to the same VLAN as the bridge. - -include::modules/cnv-networking-glossary.adoc[leveloffset=+1] - -include::modules/cnv-pxe-booting-with-mac-address.adoc[leveloffset=+1] - -include::modules/cnv-template-vmi-pxe-config.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-managing-guest-memory.adoc b/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-managing-guest-memory.adoc deleted file mode 100644 index 0c1e15cbe5..0000000000 --- a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-managing-guest-memory.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="cnv-managing-guest-memory"] -= Managing guest memory -include::modules/cnv-document-attributes.adoc[] -:context: cnv-managing-guest-memory -toc::[] - -If you want to adjust guest memory settings to suit a specific use case, you can -do so by editing the guest's YAML configuration file. {CNVProductNameStart} allows you -to configure guest memory overcommitment and disable guest memory overhead -accounting. - -Both of these procedures carry some degree of risk. Proceed only if you are -an experienced administrator. - -include::modules/cnv-configuring-guest-memory-overcommitment.adoc[leveloffset=+1] - -include::modules/cnv-disabling-guest-memory-overhead-accounting.adoc[leveloffset=+1] \ No newline at end of file diff --git a/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume-block.adoc b/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume-block.adoc deleted file mode 100644 index f3399fbd30..0000000000 --- a/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume-block.adoc +++ /dev/null @@ -1,31 +0,0 @@ -[id="cnv-cloning-vm-disk-into-new-datavolume-block"] -= Cloning a virtual machine disk into a new block storage DataVolume -include::modules/cnv-document-attributes.adoc[] -:context: cnv-cloning-vm-disk-into-new-datavolume-block -toc::[] - -You can clone the PersistentVolumeClaim (PVC) of a virtual machine disk into -a new block DataVolume by referencing the source PVC in your DataVolume configuration -file. - -.Prerequisites - -* If you require scratch space according to the -xref:#cnv-cdi-supported-operations-matrix_cnv-cloning-vm-disk-into-new-datavolume-block[CDI supported operations matrix], you must first -xref:../../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc#cnv-defining-storageclass-in-cdi-configuration_cnv-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] -for this operation to complete successfully. - -* Users need xref:../../../cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-enabling-user-permissions-to-clone-datavolumes.adoc#cnv-enabling-user-permissions-to-clone-datavolumes[additional permissions] to clone the PVC of a virtual machine disk into another namespace. - -:blockstorage: -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-about-block-pvs.adoc[leveloffset=+1] - -include::modules/cnv-creating-local-block-pv.adoc[leveloffset=+1] - -include::modules/cnv-cloning-pvc-of-vm-disk-into-new-datavolume.adoc[leveloffset=+1] - -include::modules/cnv-cdi-supported-operations-matrix.adoc[leveloffset=+1] - -:blockstorage!: diff --git a/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume.adoc b/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume.adoc deleted file mode 100644 index 35e42cb196..0000000000 --- a/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume.adoc +++ /dev/null @@ -1,26 +0,0 @@ -[id="cnv-cloning-vm-disk-into-new-datavolume"] -= Cloning a virtual machine disk into a new DataVolume -include::modules/cnv-document-attributes.adoc[] -:context: cnv-cloning-vm-disk-into-new-datavolume -toc::[] - -You can clone the PersistentVolumeClaim (PVC) of a virtual machine disk into -a new DataVolume by referencing the source PVC in your DataVolume configuration -file. - -.Prerequisites - -* You may need to xref:../../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc#cnv-defining-storageclass-in-cdi-configuration_cnv-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] -for this operation to complete successfully. The -xref:#cnv-cdi-supported-operations-matrix_cnv-cloning-vm-disk-into-new-datavolume[CDI supported operations matrix] -shows the conditions that require scratch space. - -* Users need xref:../../../cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-enabling-user-permissions-to-clone-datavolumes.adoc#cnv-enabling-user-permissions-to-clone-datavolumes[additional permissions] to clone the PVC of a virtual machine disk into another namespace. - -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-cloning-pvc-of-vm-disk-into-new-datavolume.adoc[leveloffset=+1] - -include::modules/cnv-template-datavolume-clone.adoc[leveloffset=+1] - -include::modules/cnv-cdi-supported-operations-matrix.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-using-datavolumetemplate.adoc b/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-using-datavolumetemplate.adoc deleted file mode 100644 index 3f1a678ec0..0000000000 --- a/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-using-datavolumetemplate.adoc +++ /dev/null @@ -1,27 +0,0 @@ -[id="cnv-cloning-vm-using-datavolumetemplate"] -= Cloning a virtual machine by using a DataVolumeTemplate -include::modules/cnv-document-attributes.adoc[] -:context: cnv-cloning-vm-using-datavolumetemplate -toc::[] - -You can create a new virtual machine by cloning the PersistentVolumeClaim (PVC) of -an existing VM. By including a `dataVolumeTemplate` in your virtual machine -configuration file, you create a new DataVolume from the original PVC. - -.Prerequisites - -* You may need to xref:../../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc#cnv-defining-storageclass-in-cdi-configuration_cnv-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] -for this operation to complete successfully. The -xref:#cnv-cdi-supported-operations-matrix_cnv-cloning-vm-using-datavolumetemplate[CDI supported operations matrix] -shows the conditions that require scratch space. - -* Users need xref:../../../cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-enabling-user-permissions-to-clone-datavolumes.adoc#cnv-enabling-user-permissions-to-clone-datavolumes[additional permissions] to clone the PVC of a virtual machine disk into another namespace. - -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-creating-new-vm-from-cloned-pvc-using-datavolumetemplate.adoc[leveloffset=+1] - -include::modules/cnv-template-datavolume-vm.adoc[leveloffset=+1] - -include::modules/cnv-cdi-supported-operations-matrix.adoc[leveloffset=+1] - diff --git a/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes-block.adoc b/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes-block.adoc deleted file mode 100644 index 16b37f1e58..0000000000 --- a/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes-block.adoc +++ /dev/null @@ -1,39 +0,0 @@ -[id="cnv-importing-virtual-machine-images-datavolumes-block"] -= Importing virtual machine images to block storage with DataVolumes -include::modules/cnv-document-attributes.adoc[] -:context: cnv-importing-virtual-machine-images-datavolumes-block -toc::[] - -You can import an existing virtual machine image into your {product-title} -cluster. {CNVProductNameStart} uses DataVolumes to automate the import of data and the -creation of an underlying PersistentVolumeClaim (PVC). - -[CAUTION] -==== -When you import a disk image into a PVC, the disk image is -expanded to use the full storage capacity that is requested in the PVC. To use -this space, the disk partitions and file system(s) in the virtual machine -might need to be expanded. - -The resizing procedure varies based on the operating system that is installed on the virtual machine. -Refer to the operating system documentation for details. -==== - -.Prerequisites - -* If you require scratch space according to the -xref:#cnv-cdi-supported-operations-matrix_cnv-importing-virtual-machine-images-datavolumes-block[CDI supported operations matrix], you must first -xref:../../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc#cnv-defining-storageclass-in-cdi-configuration_cnv-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] -for this operation to complete successfully. - -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-about-block-pvs.adoc[leveloffset=+1] - -include::modules/cnv-creating-local-block-pv.adoc[leveloffset=+1] - -include::modules/cnv-importing-vm-to-block-pv.adoc[leveloffset=+1] - -include::modules/cnv-cdi-supported-operations-matrix.adoc[leveloffset=+1] - - diff --git a/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes.adoc b/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes.adoc deleted file mode 100644 index 210caa48a5..0000000000 --- a/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes.adoc +++ /dev/null @@ -1,39 +0,0 @@ -[id="cnv-importing-virtual-machine-images-datavolumes"] -= Importing virtual machine images with DataVolumes -include::modules/cnv-document-attributes.adoc[] -:context: cnv-importing-virtual-machine-images-datavolumes -toc::[] - -You can import an existing virtual machine image into your {product-title} -cluster. {CNVProductNameStart} uses DataVolumes to automate the import of data and the -creation of an underlying PersistentVolumeClaim (PVC). - -[CAUTION] -==== -When you import a disk image into a PVC, the disk image is -expanded to use the full storage capacity that is requested in the PVC. To use -this space, the disk partitions and file system(s) in the virtual machine -might need to be expanded. - -The resizing procedure varies based on the operating system installed on the VM. -Refer to the operating system documentation for details. -==== - -.Prerequisites - -* If the endpoint requires a TLS certificate, the certificate must be -xref:../../../cnv/cnv_virtual_machines/cnv_importing_vms/cnv-tls-certificates-for-dv-imports.adoc#cnv-adding-tls-certificates-for-authenticating-dv-imports_cnv-tls-certificates-for-dv-imports[included in a ConfigMap] -in the same namespace as the DataVolume and referenced in the DataVolume configuration. - -* You may need to xref:../../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc#cnv-defining-storageclass-in-cdi-configuration_cnv-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] -for this operation to complete successfully. - -include::modules/cnv-cdi-supported-operations-matrix.adoc[leveloffset=+1] - -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-importing-vm-datavolume.adoc[leveloffset=+1] - -include::modules/cnv-template-datavolume-vm.adoc[leveloffset=+1] - -include::modules/cnv-template-datavolume-import.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc b/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc deleted file mode 100644 index 9b33647239..0000000000 --- a/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc +++ /dev/null @@ -1,34 +0,0 @@ -[id="cnv-importing-vmware-vm"] -= Importing a VMware virtual machine or template -include::modules/cnv-document-attributes.adoc[] -:context: cnv-importing-vmware-vm -toc::[] - -You can import a single VMware virtual machine or template into your {product-title} cluster. - -If you import a VMware template, the wizard creates a virtual machine based on the template. - -:FeatureName: Importing a VMware virtual machine or template -include::modules/technology-preview.adoc[leveloffset=+1] -:!FeatureName: - -.Prerequisites - -* If you use NFS-backed storage for the 2 GB disk that is attached to the Conversion Pod, you must link:https://access.redhat.com/solutions/4982751[configure a hostPath volume]. - -include::modules/cnv-creating-vddk-image.adoc[leveloffset=+1] -include::modules/cnv-importing-vmware-vm.adoc[leveloffset=+1] - -Refer to the xref:cnv-importing-vmware-vm-wizard-fields_cnv-importing-vmware-vm[virtual machine wizard fields] section for more information on the wizard fields. - -include::modules/cnv-updating-imported-vm-network-name.adoc[leveloffset=+1] -include::modules/cnv-troubleshooting-vmware-vm-import.adoc[leveloffset=+1] - -[id="cnv-importing-vmware-vm-wizard-fields_{context}"] -== Virtual machine wizard fields -:virtualmachine: -include::modules/cnv-vm-wizard-fields-web.adoc[leveloffset=+2] -include::modules/cnv-cloud-init-fields-web.adoc[leveloffset=+2] -include::modules/cnv-networking-wizard-fields-web.adoc[leveloffset=+2] -include::modules/cnv-storage-wizard-fields-web.adoc[leveloffset=+2] -:virtualmachine!: diff --git a/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-tls-certificates-for-dv-imports.adoc b/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-tls-certificates-for-dv-imports.adoc deleted file mode 100644 index c666ebe63e..0000000000 --- a/cnv/cnv_virtual_machines/cnv_importing_vms/cnv-tls-certificates-for-dv-imports.adoc +++ /dev/null @@ -1,11 +0,0 @@ -[id="cnv-tls-certificates-for-dv-imports"] -= TLS certificates for DataVolume imports -include::modules/cnv-document-attributes.adoc[] -include::modules/common-attributes.adoc[] -:context: cnv-tls-certificates-for-dv-imports -toc::[] - -include::modules/cnv-adding-tls-certificates-for-authenticating-dv-imports.adoc[leveloffset=+1] -include::modules/cnv-example-configmap-tls-certificate.adoc[leveloffset=+1] - - diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-configuring-local-storage-for-vms.adoc b/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-configuring-local-storage-for-vms.adoc deleted file mode 100644 index 86e3df2105..0000000000 --- a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-configuring-local-storage-for-vms.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="cnv-configuring-local-storage-for-vms"] -= Configuring local storage for virtual machines -include::modules/cnv-document-attributes.adoc[] -:context: cnv-configuring-local-storage-for-vms -toc::[] - - -You can configure local storage for your virtual machines by using the hostpath -provisioner feature. - -include::modules/cnv-about-hostpath-provisioner.adoc[leveloffset=+1] - -include::modules/cnv-configuring-selinux-hpp-on-rhcos8.adoc[leveloffset=+1] - -include::modules/cnv-using-hostpath-provisioner.adoc[leveloffset=+1] - -include::modules/cnv-creating-storage-class.adoc[leveloffset=+1] \ No newline at end of file diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-deleting-datavolumes.adoc b/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-deleting-datavolumes.adoc deleted file mode 100644 index 5c23a1c700..0000000000 --- a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-deleting-datavolumes.adoc +++ /dev/null @@ -1,15 +0,0 @@ -[id="cnv-deleting-datavolumes"] -= Deleting DataVolumes -include::modules/cnv-document-attributes.adoc[] -:context: cnv-deleting-datavolumes -toc::[] - -You can manually delete a DataVolume by using the `oc` command-line interface. + -[NOTE] -==== -When you delete a virtual machine, the DataVolume it uses is automatically deleted. -==== - -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] -include::modules/cnv-listing-dvs.adoc[leveloffset=+1] -include::modules/cnv-deleting-dvs.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-expanding-virtual-storage-with-blank-disk-images.adoc b/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-expanding-virtual-storage-with-blank-disk-images.adoc deleted file mode 100644 index 6786847157..0000000000 --- a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-expanding-virtual-storage-with-blank-disk-images.adoc +++ /dev/null @@ -1,14 +0,0 @@ -[id="cnv-expanding-virtual-storage-with-blank-disk-images"] -= Expanding virtual storage by adding blank disk images -include::modules/cnv-document-attributes.adoc[] -:context: cnv-expanding-virtual-storage-with-blank-disk-images -toc::[] - -You can increase your storage capacity or create new data partitions by adding -blank disk images to {CNVProductName}. - -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-creating-blank-disk-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-template-blank-disk-datavolume.adoc[leveloffset=+1] \ No newline at end of file diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-moving-local-vm-disk-to-different-node.adoc b/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-moving-local-vm-disk-to-different-node.adoc deleted file mode 100644 index 992ae274db..0000000000 --- a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-moving-local-vm-disk-to-different-node.adoc +++ /dev/null @@ -1,22 +0,0 @@ -[id="cnv-moving-local-vm-disk-to-different-node"] -= Moving a local virtual machine disk to a different node -include::modules/cnv-document-attributes.adoc[] -:context: cnv-moving-local-vm-disk-to-different-node -toc::[] - -Virtual machines that use local volume storage can be moved so that they run on a specific node. - -You might want to move the virtual machine to a specific node for the following reasons: - -* The current node has limitations to the local storage configuration. -* The new node is better optimized for the workload of that virtual machine. - -To move a virtual machine that uses local storage, you must clone the underlying volume by using a DataVolume. After the cloning operation is complete, you can xref:../../../cnv/cnv_virtual_machines/cnv-edit-vms.adoc#cnv-edit-vms[edit the virtual machine configuration] so that it uses the new DataVolume, or xref:../../../cnv/cnv_virtual_machines/cnv-edit-vms.adoc#cnv-vm-add-disk_cnv-edit-vms[add the new DataVolume to another virtual machine]. - -[NOTE] -==== -Users without the `cluster-admin` role require xref:../../../cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-enabling-user-permissions-to-clone-datavolumes.adoc#cnv-enabling-user-permissions-to-clone-datavolumes[additional user permissions] in order to clone volumes across namespaces. -==== - -include::modules/cnv-cloning-local-volume-to-another-node.adoc[leveloffset=+1] - diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc b/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc deleted file mode 100644 index 0f7b9eb35a..0000000000 --- a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc +++ /dev/null @@ -1,19 +0,0 @@ -[id="cnv-preparing-cdi-scratch-space"] -= Preparing CDI scratch space -include::modules/cnv-document-attributes.adoc[] -:context: cnv-preparing-cdi-scratch-space -toc::[] - -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-understanding-scratch-space.adoc[leveloffset=+1] - -include::modules/cnv-operations-requiring-scratch-space.adoc[leveloffset=+1] - -include::modules/cnv-defining-storageclass-in-cdi-configuration.adoc[leveloffset=+1] - -include::modules/cnv-cdi-supported-operations-matrix.adoc[leveloffset=+1] - -.Additional resources - -* See the xref:../../../storage/dynamic-provisioning.adoc#about_dynamic-provisioning[Dynamic provisioning] section for more information on StorageClasses and how these are defined in the cluster. diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-storage-defaults-for-datavolumes.adoc b/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-storage-defaults-for-datavolumes.adoc deleted file mode 100644 index b5dbea72d9..0000000000 --- a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-storage-defaults-for-datavolumes.adoc +++ /dev/null @@ -1,16 +0,0 @@ -[id="cnv-storage-defaults-for-datavolumes"] -= Storage defaults for DataVolumes -include::modules/cnv-document-attributes.adoc[] -:context: cnv-storage-defaults-for-datavolumes -toc::[] - -The `kubevirt-storage-class-defaults` ConfigMap provides _access mode_ and _volume mode_ defaults for DataVolumes. You can edit or add storage class defaults to the ConfigMap in order to create DataVolumes in the web console that better match the underlying storage. - -include::modules/cnv-about-storage-setting-for-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-editing-kubevirtstorageclassdefaults-web.adoc[leveloffset=+1] - -include::modules/cnv-editing-kubevirtstorageclassdefaults-cli.adoc[leveloffset=+1] - -include::modules/cnv-example-kubevirtstorageclassdefaults.adoc[leveloffset=+1] - diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-block.adoc b/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-block.adoc deleted file mode 100644 index 9388a085f0..0000000000 --- a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-block.adoc +++ /dev/null @@ -1,37 +0,0 @@ -[id="cnv-uploading-local-disk-images-block"] -= Uploading a local disk image to a block storage DataVolume -include::modules/cnv-document-attributes.adoc[] -:context: cnv-uploading-local-disk-images-block -toc::[] - -You can upload a local disk image into a block DataVolume by using the -`virtctl` command-line utility. - -In this workflow, you create a local block device to use as a PersistentVolume, -associate this block volume with an `upload` DataVolume, and use `virtctl` -to upload the local disk image into the DataVolume. - -.Prerequisites - -* xref:../../../cnv/cnv_install/cnv-installing-virtctl.adoc#cnv-installing-virtctl[Install] -the `kubevirt-virtctl` package. - -* If you require scratch space according to the -xref:#cnv-cdi-supported-operations-matrix_cnv-uploading-local-disk-images-block[CDI supported operations matrix], you must first -xref:../../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc#cnv-defining-storageclass-in-cdi-configuration_cnv-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] -for this operation to complete successfully. - -:blockstorage: -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-about-block-pvs.adoc[leveloffset=+1] - -include::modules/cnv-creating-local-block-pv.adoc[leveloffset=+1] - -include::modules/cnv-creating-an-upload-dv.adoc[leveloffset=+1] - -include::modules/cnv-uploading-local-disk-image-dv.adoc[leveloffset=+1] - -include::modules/cnv-cdi-supported-operations-matrix.adoc[leveloffset=+1] - -:blockstorage!: diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-virtctl.adoc b/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-virtctl.adoc deleted file mode 100644 index d61e947e97..0000000000 --- a/cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-virtctl.adoc +++ /dev/null @@ -1,26 +0,0 @@ -[id="cnv-uploading-local-disk-images-virtctl"] -= Uploading local disk images by using the virtctl tool -include::modules/cnv-document-attributes.adoc[] -:context: cnv-uploading-local-disk-images-virtctl -toc::[] - -You can upload a locally stored disk image to a new or existing DataVolume by using the -`virtctl` command-line utility. - -.Prerequisites - -* xref:../../../cnv/cnv_install/cnv-installing-virtctl.adoc#cnv-installing-virtctl[Install] -the `kubevirt-virtctl` package. - -* If you require scratch space according to the -xref:#cnv-cdi-supported-operations-matrix_cnv-uploading-local-disk-images-virtctl[CDI supported operations matrix], you must first -xref:../../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc#cnv-defining-storageclass-in-cdi-configuration_cnv-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] -for this operation to complete successfully. - -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] - -include::modules/cnv-creating-an-upload-dv.adoc[leveloffset=+1] - -include::modules/cnv-uploading-local-disk-image-dv.adoc[leveloffset=+1] - -include::modules/cnv-cdi-supported-operations-matrix.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv_vm_networking/cnv-using-the-default-pod-network-with-cnv.adoc b/cnv/cnv_virtual_machines/cnv_vm_networking/cnv-using-the-default-pod-network-with-cnv.adoc deleted file mode 100644 index 14cbc58312..0000000000 --- a/cnv/cnv_virtual_machines/cnv_vm_networking/cnv-using-the-default-pod-network-with-cnv.adoc +++ /dev/null @@ -1,32 +0,0 @@ -[id="cnv-using-the-default-pod-network-with-cnv"] -= Using the default Pod network for virtual machines -include::modules/cnv-document-attributes.adoc[] -:context: cnv-using-the-default-pod-network-with-cnv -toc::[] - -You can use the default Pod network with {CNVProductName}. To do so, -you must use the `masquerade` binding method. It is the only recommended -binding method for use with the default Pod network. Do not use -`masquerade` mode with non-default networks. - -[NOTE] -==== -For secondary networks, use the `bridge` binding method. -==== - -include::modules/cnv-configuring-masquerade-mode-cli.adoc[leveloffset=+1] - -[id="cnv-selecting-binding-method"] -== Selecting binding method - -If you create a virtual machine from the {CNVProductName} -xref:../../../cnv/cnv_virtual_machines/cnv-create-vms.adoc#cnv-create-vms[web console wizard], -select the required binding method from the *Networking* screen. - -include::modules/cnv-networking-wizard-fields-web.adoc[leveloffset=+2] - -== Virtual machine configuration examples for the default network - -include::modules/cnv-template-vm-config.adoc[leveloffset=+2] - -include::modules/cnv-template-windows-vmi.adoc[leveloffset=+2] diff --git a/cnv/cnv_vm_templates/cnv-creating-vm-template.adoc b/cnv/cnv_vm_templates/cnv-creating-vm-template.adoc deleted file mode 100644 index 8c13811072..0000000000 --- a/cnv/cnv_vm_templates/cnv-creating-vm-template.adoc +++ /dev/null @@ -1,24 +0,0 @@ -[id="cnv-creating-vm-template"] -= Creating virtual machine templates -include::modules/cnv-document-attributes.adoc[] -:context: cnv-creating-vm-template -toc::[] - -Using Virtual machines templates is an easy way to create multiple virtual machines -with similar configuration. After a template is created, reference the template -when creating virtual machines. - -include::modules/cnv-creating-template-wizard-web.adoc[leveloffset=+1] - -[id="cnv-template-wizard-fields"] -== Virtual machine template interactive wizard fields - -The following tables describe the fields for the *Basic Settings*, *Networking*, -and *Storage* panes in the *Create Virtual Machine Template* interactive wizard. - -:vmtemplate: -include::modules/cnv-vm-wizard-fields-web.adoc[leveloffset=+2] -include::modules/cnv-cloud-init-fields-web.adoc[leveloffset=+2] -include::modules/cnv-networking-wizard-fields-web.adoc[leveloffset=+2] -include::modules/cnv-storage-wizard-fields-web.adoc[leveloffset=+2] -:vmtemplate!: diff --git a/cnv/cnv_vm_templates/cnv-deleting-vm-template.adoc b/cnv/cnv_vm_templates/cnv-deleting-vm-template.adoc deleted file mode 100644 index e086a77703..0000000000 --- a/cnv/cnv_vm_templates/cnv-deleting-vm-template.adoc +++ /dev/null @@ -1,11 +0,0 @@ -[id="cnv-deleting-vm-template"] -= Deleting a virtual machine template -include::modules/cnv-document-attributes.adoc[] -:context: cnv-deleting-vm-template -toc::[] - -You can delete a virtual machine template in the web console. - -include::modules/cnv-deleting-template-web.adoc[leveloffset=+1] - - diff --git a/cnv/cnv_vm_templates/cnv-editing-vm-template.adoc b/cnv/cnv_vm_templates/cnv-editing-vm-template.adoc deleted file mode 100644 index e0e5a10509..0000000000 --- a/cnv/cnv_vm_templates/cnv-editing-vm-template.adoc +++ /dev/null @@ -1,15 +0,0 @@ -[id="cnv-editing-vm-template"] -= Editing virtual machine templates -include::modules/cnv-document-attributes.adoc[] -:context: cnv-editing-vm-template -toc::[] - -You can update a virtual machine template in the web console, either by editing -the full configuration in the YAML editor or by editing a subset of the -parameters in the *Virtual Machine Template Overview* screen. - -include::modules/cnv-editing-vm-web.adoc[leveloffset=+1] -include::modules/cnv-editing-template-yaml-web.adoc[leveloffset=+1] -include::modules/cnv-add-disk-to-vm.adoc[leveloffset=+1] -include::modules/cnv-add-nic-to-vm.adoc[leveloffset=+1] -include::modules/cnv-edit-cdrom-vm.adoc[leveloffset=+1] diff --git a/cnv/cnv_vm_templates/images b/cnv/cnv_vm_templates/images deleted file mode 120000 index 5fa6987088..0000000000 --- a/cnv/cnv_vm_templates/images +++ /dev/null @@ -1 +0,0 @@ -../../images \ No newline at end of file diff --git a/cnv/cnv_vm_templates/modules b/cnv/cnv_vm_templates/modules deleted file mode 120000 index 36719b9de7..0000000000 --- a/cnv/cnv_vm_templates/modules +++ /dev/null @@ -1 +0,0 @@ -../../modules/ \ No newline at end of file diff --git a/cnv/upgrading-container-native-virtualization.adoc b/cnv/upgrading-container-native-virtualization.adoc deleted file mode 100644 index 946da08f26..0000000000 --- a/cnv/upgrading-container-native-virtualization.adoc +++ /dev/null @@ -1,21 +0,0 @@ -[id="upgrading-container-native-virtualization"] -= Upgrading container-native virtualization -include::modules/cnv-document-attributes.adoc[] -:context: upgrading-container-native-virtualization -toc::[] - -You can manually upgrade to the next minor version of {CNVProductName} and -monitor the status of an update by using the web console. - -:FeatureName: {CNVProductNameStart} -include::modules/technology-preview.adoc[leveloffset=+1] - -include::modules/cnv-about-upgrading-cnv.adoc[leveloffset=+1] - -include::modules/cnv-upgrading-cnv.adoc[leveloffset=+1] - -include::modules/cnv-monitoring-upgrade-status.adoc[leveloffset=+1] - -.Additional information - -* xref:../operators/understanding_olm/olm-understanding-olm.adoc#olm-csv_olm-understanding-olm[ClusterServiceVersions (CSVs)] diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc index c396043f14..88dd19de28 100644 --- a/contributing_to_docs/doc_guidelines.adoc +++ b/contributing_to_docs/doc_guidelines.adoc @@ -79,6 +79,15 @@ important terms that may cause confusion. For example, the `managing_authorization_policies.adoc` file name would be appropriate for an assembly titled "Managing Authorization Policies". +== Directory names + +If you create a directory with a multiple-word name, separate each word with an +underscore, for example `backup_and_restore`. Do not create a top-level directory +in the repository without checking with the docs team. In the main OpenShift +docs, you can create one level of subdirectories. In the docs for features that +are designed to be used with OpenShift, such as Service Mesh and OpenShift virtualization, +you can create two levels of subdirectories. + == Assembly/Module titles and section headings Use sentence case in all titles and section headings. See http://www.titlecase.com/ or diff --git a/modules/about-must-gather.adoc b/modules/about-must-gather.adoc index 346f36ee26..c3b0643e11 100644 --- a/modules/about-must-gather.adoc +++ b/modules/about-must-gather.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-collecting-cnv-data.adoc +// * virt/logging_events_monitoring/virt-collecting-virt-data.adoc // * support/gathering-cluster-data.adoc // * serverless/serverless-support.adoc // * service_mesh/service_mesh_support/ossm-collecting-ossm-data.adoc diff --git a/modules/cluster-logging-about-components.adoc b/modules/cluster-logging-about-components.adoc index 83b4e74300..512d8a9a52 100644 --- a/modules/cluster-logging-about-components.adoc +++ b/modules/cluster-logging-about-components.adoc @@ -2,8 +2,8 @@ // // * logging/cluster-logging.adoc -ifeval::["{context}" == "cnv-openshift-cluster-monitoring"] -:cnv-logging: +ifeval::["{context}" == "virt-openshift-cluster-monitoring"] +:virt-logging: endif::[] [id="cluster-logging-about-components_{context}"] @@ -26,10 +26,10 @@ There are currently 5 different types of cluster logging components: * curation - This is the component that trims logs by age. The current implementation is Curator. * event routing - This is the component forwards {product-title} events to cluster logging. The current implementation is Event Router. -ifndef::cnv-logging[] +ifndef::virt-logging[] In this document, we may refer to logStore or Elasticsearch, visualization or Kibana, curation or Curator, collection or Fluentd, interchangeably, except where noted. -endif::cnv-logging[] +endif::virt-logging[] -ifeval::["{context}" == "cnv-openshift-cluster-monitoring"] -:!cnv-logging: +ifeval::["{context}" == "virt-openshift-cluster-monitoring"] +:!virt-logging: endif::[] diff --git a/modules/cluster-logging-about.adoc b/modules/cluster-logging-about.adoc index 38622f38ec..df4afa6b80 100644 --- a/modules/cluster-logging-about.adoc +++ b/modules/cluster-logging-about.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-openshift-cluster-monitoring.adoc +// * virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc // * logging/cluster-logging.adoc // * serverless/knative_serving/cluster-logging-serverless.adoc diff --git a/modules/cnv-about-collecting-cnv-data.adoc b/modules/cnv-about-collecting-cnv-data.adoc deleted file mode 100644 index 10d7c1aebc..0000000000 --- a/modules/cnv-about-collecting-cnv-data.adoc +++ /dev/null @@ -1,20 +0,0 @@ -// Module included in the following assemblies: -// -// * cnv/cnv_logging_events_monitoring/cnv-collecting-cnv-data.adoc - -[id="cnv-about-collecting-cnv-data_{context}"] -= About collecting container-native virtualization data - -You can use the `oc adm must-gather` CLI command to collect information about your -cluster, including features and objects associated with {CNVProductName}: - -* The Hyperconverged Cluster Operator namespaces (and child objects) -* All namespaces (and their child objects) that belong to any {CNVProductName} -resources -* All {CNVProductName} Custom Resource Definitions (CRDs) -* All namespaces that contain virtual machines -* All virtual machine definitions - -To collect {CNVProductName} data with `must-gather`, you must specify the -{CNVProductName} image: -`--image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8`. \ No newline at end of file diff --git a/modules/cnv-about-datavolumes.adoc b/modules/cnv-about-datavolumes.adoc deleted file mode 100644 index 0682c59f32..0000000000 --- a/modules/cnv-about-datavolumes.adoc +++ /dev/null @@ -1,21 +0,0 @@ -// Module included in the following assemblies: -// -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-expanding-virtual-storage-with-blank-disk-images.adoc -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-block.adoc -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-using-datavolumetemplate.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-enabling-user-permissions-to-clone-datavolumes.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume-block.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes-block.adoc -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-deleting-datavolumes.adoc - -[id="cnv-about-datavolumes_{context}"] -= About DataVolumes - -`DataVolume` objects are custom resources that are provided by the Containerized -Data Importer (CDI) project. DataVolumes orchestrate import, clone, and upload -operations that are associated with an underlying PersistentVolumeClaim (PVC). -DataVolumes are integrated with KubeVirt, and they prevent a virtual machine -from being started before the PVC has been prepared. \ No newline at end of file diff --git a/modules/cnv-accessing-vmi-web.adoc b/modules/cnv-accessing-vmi-web.adoc index fedb62a771..f733d2873f 100644 --- a/modules/cnv-accessing-vmi-web.adoc +++ b/modules/cnv-accessing-vmi-web.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -[id="cnv-accessing-vmi-web_{context}"] +[id="virt-accessing-vmi-web_{context}"] = Connecting to a virtual machine with the web console You can connect to a virtual machine by using the web console. diff --git a/modules/cnv-deleting-catalog-subscription.adoc b/modules/cnv-deleting-catalog-subscription.adoc deleted file mode 100644 index bd31b7c3fc..0000000000 --- a/modules/cnv-deleting-catalog-subscription.adoc +++ /dev/null @@ -1,21 +0,0 @@ -// Module included in the following assemblies: -// -// * cnv/cnv_install/uninstalling-container-native-virtualization.adoc - -[id="cnv-deleting-catalog-subscription_{context}"] -= Deleting the {CNVProductNameStart} catalog subscription - -To finish uninstalling {CNVProductName}, delete the -*{CNVProductNameStart}* catalog subscription. - -.Prerequisites - -* An active subscription to the *{CNVProductNameStart}* catalog - -.Procedure - -. Navigate to the *Operators* -> *OperatorHub* page. - -. Search for *{CNVProductNameStart}* and then select it. - -. Click *Uninstall*. diff --git a/modules/cnv-enabling-cnv-repos.adoc b/modules/cnv-enabling-cnv-repos.adoc deleted file mode 100644 index 924c51ffb3..0000000000 --- a/modules/cnv-enabling-cnv-repos.adoc +++ /dev/null @@ -1,26 +0,0 @@ -// Module included in the following assemblies: -// -// cnv_install/cnv-installing-virtctl.adoc - -[id="cnv-enabling-cnv-repos_{context}"] -= Enabling container-native virtualization repositories - -Red Hat offers {CNVProductName} repositories for both Red Hat Enterprise Linux 8 -and Red Hat Enterprise Linux 7: - -* Red Hat Enterprise Linux 8 repository: `cnv-2.3-for-rhel-8-x86_64-rpms` - -* Red Hat Enterprise Linux 7 repository: `rhel-7-server-cnv-2.3-rpms` - -The process for enabling the repository in `subscription-manager` is the same -in both platforms. - -.Procedure - -* Use `subscription manager` to enable the appropriate {CNVProductName} repository for - your system: -+ ----- -# subscription-manager repos --enable ----- - diff --git a/modules/deleting-a-namespace-using-the-web-console.adoc b/modules/deleting-a-namespace-using-the-web-console.adoc index 104ed4b5cf..24d23e66a1 100644 --- a/modules/deleting-a-namespace-using-the-web-console.adoc +++ b/modules/deleting-a-namespace-using-the-web-console.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cnv/cnv_install/uninstalling-container-native-virtualization.adoc +// * virt/install/uninstalling-virt.adoc [id="deleting-a-namespace-using-the-web-console_{context}"] = Deleting a namespace using the web console diff --git a/modules/gathering-data-specific-features.adoc b/modules/gathering-data-specific-features.adoc index 5f046c9ac1..879457e20c 100644 --- a/modules/gathering-data-specific-features.adoc +++ b/modules/gathering-data-specific-features.adoc @@ -1,8 +1,10 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-collecting-cnv-data.adoc +// * virt/logging_events_monitoring/virt-collecting-virt-data.adoc -// Dependency: modules/cnv-document-attributes.adoc +//This file contains UI elements and/or package names that need to be updated. + +// Dependency: modules/virt-document-attributes.adoc [id="gathering-data-specific-features_{context}"] = Gathering data about specific features @@ -23,7 +25,7 @@ more than one feature by running a single command. . Run the `oc adm must-gather` command with one or more `--image` or `--image-stream` arguments. For example, the following command gathers both the default cluster -data and information specific to {CNVProductName}: +data and information specific to {VirtProductName}: + ---- $ oc adm must-gather \ @@ -31,7 +33,7 @@ $ oc adm must-gather \ --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8 <2> ---- <1> Default {product-title} must-gather image -<2> {CNVProductNameStart} must-gather image +<2> {VirtProductName} must-gather image . Create a compressed file from the `must-gather` directory that was just created in your working directory. For example, on a computer that uses a Linux diff --git a/modules/monitoring-about-cluster-monitoring.adoc b/modules/monitoring-about-cluster-monitoring.adoc index 02d46d2541..4b0323f396 100644 --- a/modules/monitoring-about-cluster-monitoring.adoc +++ b/modules/monitoring-about-cluster-monitoring.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-openshift-cluster-monitoring.adoc +// * virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc // * monitoring/cluster_monitoring/about-cluster-monitoring.adoc // This module uses a conditionalized title so that the module diff --git a/modules/support.adoc b/modules/support.adoc index 850db23beb..b8b8ea623d 100644 --- a/modules/support.adoc +++ b/modules/support.adoc @@ -27,7 +27,7 @@ When submitting a support case, it is recommended to provide the following infor endif::[] * Access other product documentation. -// TODO: verify that these settings apply for Service Mesh and CNV, etc. +// TODO: verify that these settings apply for Service Mesh and OpenShift virtualization, etc. If you have a suggestion for improving this documentation or have found an error, please submit a link:http://bugzilla.redhat.com[Bugzilla report] against the *OpenShift Container Platform* product for the *Documentation* component. Please diff --git a/modules/telemetry-about-telemetry.adoc b/modules/telemetry-about-telemetry.adoc index 2508bdfcd7..06c1b28a0a 100644 --- a/modules/telemetry-about-telemetry.adoc +++ b/modules/telemetry-about-telemetry.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-openshift-cluster-monitoring.adoc +// * virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc // * support/remote_health_monitoring/about-remote-health-monitoring.adoc [id="telemetry-about-telemetry_{context}"] diff --git a/modules/telemetry-what-information-is-collected.adoc b/modules/telemetry-what-information-is-collected.adoc index 8bb1b29db2..d2347d80aa 100644 --- a/modules/telemetry-what-information-is-collected.adoc +++ b/modules/telemetry-what-information-is-collected.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-openshift-cluster-monitoring.adoc +// * virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc // * support/remote_health_monitoring/about-remote-health-monitoring.adoc -ifeval::["{context}" == "cnv-openshift-cluster-monitoring"] -:cnv-cluster: +ifeval::["{context}" == "virt-openshift-cluster-monitoring"] +:virt-cluster: endif::[] [id="what-information-is-collected_{context}"] @@ -21,9 +21,9 @@ Primary information collected by Telemetry includes: * The number of members in the etcd cluster and number of objects currently stored in the etcd cluster * The number of CPU cores and RAM used per machine type - infra or master * The number of CPU cores and RAM used per cluster -ifdef::cnv-cluster[] +ifdef::virt-cluster[] * The number of running virtual machine instances in the cluster -endif::cnv-cluster[] +endif::virt-cluster[] * Use of {product-title} framework components per cluster * The version of the {product-title} cluster * Health, condition, and status for any {product-title} framework component that is installed on the cluster, for example Cluster Version Operator, Cluster Monitoring, Image Registry, and Elasticsearch for Logging @@ -32,7 +32,7 @@ endif::cnv-cluster[] Telemetry does not collect identifying information such as user names, passwords, or the names or addresses of user resources. -ifeval::["{context}" == "cnv-openshift-cluster-monitoring"] -:!cnv-cluster: +ifeval::["{context}" == "virt-openshift-cluster-monitoring"] +:!virt-cluster: endif::[] diff --git a/modules/cnv-about-block-pvs.adoc b/modules/virt-about-block-pvs.adoc similarity index 58% rename from modules/cnv-about-block-pvs.adoc rename to modules/virt-about-block-pvs.adoc index 2ddbe59f62..4fcef17e5b 100644 --- a/modules/cnv-about-block-pvs.adoc +++ b/modules/virt-about-block-pvs.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-block.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume-block.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes-block.adoc +// * virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc -[id="cnv-about-block-pvs_{context}"] +[id="virt-about-block-pvs_{context}"] = About block PersistentVolumes A block PersistentVolume (PV) is a PV that is backed by a raw block device. These volumes diff --git a/modules/virt-about-collecting-virt-data.adoc b/modules/virt-about-collecting-virt-data.adoc new file mode 100644 index 0000000000..2dc0d2b1ab --- /dev/null +++ b/modules/virt-about-collecting-virt-data.adoc @@ -0,0 +1,22 @@ +// Module included in the following assemblies: +// +// * virt/logging_events_monitoring/virt-collecting-virt-data.adoc + +//This file contains UI elements and/or package names that need to be updated. + +[id="virt-about-collecting-virt-data_{context}"] += About collecting {VirtProductName} data + +You can use the `oc adm must-gather` CLI command to collect information about your +cluster, including features and objects associated with {VirtProductName}: + +* The Hyperconverged Cluster Operator namespaces (and child objects) +* All namespaces (and their child objects) that belong to any {VirtProductName} +resources +* All {VirtProductName} Custom Resource Definitions (CRDs) +* All namespaces that contain virtual machines +* All virtual machine definitions + +To collect {VirtProductName} data with `must-gather`, you must specify the +{VirtProductName} image: +`--image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8`. diff --git a/modules/virt-about-datavolumes.adoc b/modules/virt-about-datavolumes.adoc new file mode 100644 index 0000000000..55155d36f1 --- /dev/null +++ b/modules/virt-about-datavolumes.adoc @@ -0,0 +1,20 @@ +// Module included in the following assemblies: +// +// * virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc +// * virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc +// * virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc +// * virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc + +[id="virt-about-datavolumes_{context}"] += About DataVolumes + +`DataVolume` objects are custom resources that are provided by the Containerized +Data Importer (CDI) project. DataVolumes orchestrate import, clone, and upload +operations that are associated with an underlying PersistentVolumeClaim (PVC). +DataVolumes are integrated with KubeVirt, and they prevent a virtual machine +from being started before the PVC has been prepared. diff --git a/modules/cnv-about-dedicated-resources.adoc b/modules/virt-about-dedicated-resources.adoc similarity index 64% rename from modules/cnv-about-dedicated-resources.adoc rename to modules/virt-about-dedicated-resources.adoc index 585d16909a..d92ef60ef6 100644 --- a/modules/cnv-about-dedicated-resources.adoc +++ b/modules/virt-about-dedicated-resources.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-dedicated-resources-vm.adoc -// * cnv/cnv_vm_templates/cnv-dedicated-resources-vm-template.adoc +// * virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc +// * virt/vm_templates/virt-dedicated-resources-vm-template.adoc -[id="cnv-about-dedicated-resources_{context}"] +[id="virt-about-dedicated-resources_{context}"] = About dedicated resources diff --git a/modules/cnv-about-hostpath-provisioner.adoc b/modules/virt-about-hostpath-provisioner.adoc similarity index 75% rename from modules/cnv-about-hostpath-provisioner.adoc rename to modules/virt-about-hostpath-provisioner.adoc index 8afe6dd47d..c8c74266b4 100644 --- a/modules/cnv-about-hostpath-provisioner.adoc +++ b/modules/virt-about-hostpath-provisioner.adoc @@ -1,15 +1,15 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-configuring-local-storage-for-vms.adoc +// * virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc -[id="cnv-about-hostpath-provisioner_{context}"] +[id="virt-about-hostpath-provisioner_{context}"] = About the hostpath provisioner The hostpath provisioner is a local storage provisioner designed for -{CNVProductName}. If you want to configure local storage for +{VirtProductName}. If you want to configure local storage for virtual machines, you must enable the hostpath provisioner first. -When you install the {CNVProductName} Operator, the hostpath provisioner Operator +When you install the {VirtProductName} Operator, the hostpath provisioner Operator is automatically installed. To use it, you must: * Configure SELinux: diff --git a/modules/cnv-about-liveness-readiness-probes.adoc b/modules/virt-about-liveness-readiness-probes.adoc similarity index 80% rename from modules/cnv-about-liveness-readiness-probes.adoc rename to modules/virt-about-liveness-readiness-probes.adoc index dc0a97975b..d953e3cc61 100644 --- a/modules/cnv-about-liveness-readiness-probes.adoc +++ b/modules/virt-about-liveness-readiness-probes.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-monitoring-vm-health.adoc +// * virt/logging_events_monitoring/virt-monitoring-vm-health.adoc -[id="cnv-about-liveness-readiness-probes_{context}"] +[id="virt-about-liveness-readiness-probes_{context}"] = About liveness and readiness probes diff --git a/modules/cnv-about-nmstate.adoc b/modules/virt-about-nmstate.adoc similarity index 57% rename from modules/cnv-about-nmstate.adoc rename to modules/virt-about-nmstate.adoc index a392f58f0a..1cadc8841a 100644 --- a/modules/cnv-about-nmstate.adoc +++ b/modules/virt-about-nmstate.adoc @@ -1,11 +1,11 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-observing-node-network-state.adoc +// * virt/node_network/virt-observing-node-network-state.adoc -[id="cnv-about-nmstate_{context}"] +[id="virt-about-nmstate_{context}"] = About nmstate -{CNVProductNameStart} uses link:https://nmstate.github.io/[`nmstate`] to report on and configure the state of the node network. This makes it possible to modify network policy configuration, such as by creating a Linux bridge on all nodes, by applying a single configuration manifest to the cluster. +{VirtProductName} uses link:https://nmstate.github.io/[`nmstate`] to report on and configure the state of the node network. This makes it possible to modify network policy configuration, such as by creating a Linux bridge on all nodes, by applying a single configuration manifest to the cluster. Node networking is monitored and updated by the following objects: diff --git a/modules/cnv-about-red-hat-ansible-automation.adoc b/modules/virt-about-red-hat-ansible-automation.adoc similarity index 65% rename from modules/cnv-about-red-hat-ansible-automation.adoc rename to modules/virt-about-red-hat-ansible-automation.adoc index 82569fe849..8620a460a4 100644 --- a/modules/cnv-about-red-hat-ansible-automation.adoc +++ b/modules/virt-about-red-hat-ansible-automation.adoc @@ -1,17 +1,17 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-automating-management-tasks.adoc +// * virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc -[id="cnv-about-red-hat-ansible-automation_{context}"] +[id="virt-about-red-hat-ansible-automation_{context}"] = About Red Hat Ansible Automation link:https://docs.ansible.com/ansible/latest/index.html[Ansible] is an automation tool used to configure systems, deploy software, and perform rolling updates. -Ansible includes support for {CNVProductName}, and Ansible modules enable you to +Ansible includes support for {VirtProductName}, and Ansible modules enable you to automate cluster management tasks such as template, persistent volume claim, and virtual machine operations. -Ansible provides a way to automate {CNVProductName} management, which you can also +Ansible provides a way to automate {VirtProductName} management, which you can also accomplish by using the `oc` CLI tool or APIs. Ansible is unique because it allows you to integrate link:https://docs.ansible.com/ansible/latest/modules/list_of_cloud_modules.html#kubevirt[KubeVirt modules] with other Ansible modules. diff --git a/modules/cnv-about-storage-setting-for-datavolumes.adoc b/modules/virt-about-storage-setting-for-datavolumes.adoc similarity index 85% rename from modules/cnv-about-storage-setting-for-datavolumes.adoc rename to modules/virt-about-storage-setting-for-datavolumes.adoc index aed33bd044..b07bb00637 100644 --- a/modules/cnv-about-storage-setting-for-datavolumes.adoc +++ b/modules/virt-about-storage-setting-for-datavolumes.adoc @@ -1,15 +1,15 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-storage-defaults-for-datavolumes.adoc +// * virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc -[id="cnv-about-kubevirtstorageclassdefaults_{context}"] +[id="virt-about-kubevirtstorageclassdefaults_{context}"] = About storage settings for DataVolumes -DataVolumes require a defined _access mode_ and _volume mode_ to be created in the web console. +DataVolumes require a defined _access mode_ and _volume mode_ to be created in the web console. These storage settings are configured by default with a `ReadWriteOnce` access mode and `Filesystem` volume mode. You can modify these settings by editing the `kubevirt-storage-class-defaults` ConfigMap in the `openshift-cnv` namespace. -You can also add settings for other storage classes in order to create DataVolumes in the web console for different storage types. +You can also add settings for other storage classes in order to create DataVolumes in the web console for different storage types. [NOTE] ==== @@ -18,7 +18,7 @@ You must configure storage settings that are supported by the underlying storage All DataVolumes that you create in the web console use the default storage settings unless you specifya storage class that is also defined in the ConfigMap. -[id="cnv-datavolumes-access-modes_{context}"] +[id="virt-datavolumes-access-modes_{context}"] == Access modes DataVolumes support the following access modes: @@ -28,11 +28,10 @@ DataVolumes support the following access modes: `ReadWriteMany` is recommended if the underlying storage supports it. -[id="cnv-datavolumes-volume-modes_{context}"] +[id="virt-datavolumes-volume-modes_{context}"] == Volume modes The volume mode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. DataVolumes support the following volume modes: * `Filesystem`: Creates a filesystem on the DataVolume. This is the default setting. * `Block`: Creates a block DataVolume. Only use `Block` if the underlying storage supports it. - diff --git a/modules/cnv-about-the-overview-dashboard.adoc b/modules/virt-about-the-overview-dashboard.adoc similarity index 72% rename from modules/cnv-about-the-overview-dashboard.adoc rename to modules/virt-about-the-overview-dashboard.adoc index 95ab2ba9e8..7ccab4111b 100644 --- a/modules/cnv-about-the-overview-dashboard.adoc +++ b/modules/virt-about-the-overview-dashboard.adoc @@ -1,13 +1,13 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-using-dashboard-to-get-cluster-info.adoc +// * virt/logging_events_monitoring/virt-using-dashboard-to-get-cluster-info.adoc // * web_console/using-dashboard-to-get-cluster-information.adoc -ifeval::["{context}" == "cnv-using-dashboard-to-get-cluster-info"] -:cnv-cluster: +ifeval::["{context}" == "virt-using-dashboard-to-get-cluster-info"] +:virt-cluster: endif::[] -[id="cnv-about-the-overview-dashboard_{context}"] +[id="virt-about-the-overview-dashboard_{context}"] = About the {product-title} dashboards page The {product-title} dashboard consists of the following cards: @@ -23,13 +23,13 @@ Status include *ok*, *error*, *warning*, *in progress*, and *unknown*. Resources ** Number of nodes ** Number of Pods ** Persistent storage volume claims -ifdef::cnv-cluster[] -** Virtual machines (available if {CNVProductName} is installed) -endif::cnv-cluster[] +ifdef::virt-cluster[] +** Virtual machines (available if {VirtProductName} is installed) +endif::virt-cluster[] ** Bare metal hosts in the cluster, listed according to their state (only available in *metal3* environment). -ifdef::cnv-cluster[] -* *Cluster Health* summarizes the current health of the cluster as a whole, including relevant alerts and descriptions. If {CNVProductName} is installed, the overall health of {CNVProductName} is diagnosed as well. If more than one subsystem is present, click *See All* to view the status of each subsystem. -endif::cnv-cluster[] +ifdef::virt-cluster[] +* *Cluster Health* summarizes the current health of the cluster as a whole, including relevant alerts and descriptions. If {VirtProductName} is installed, the overall health of {VirtProductName} is diagnosed as well. If more than one subsystem is present, click *See All* to view the status of each subsystem. +endif::virt-cluster[] * *Cluster Capacity* charts help administrators understand when additional resources are required in the cluster. The charts contain an inner ring that displays current consumption, while an outer ring displays thresholds configured for the resource, including information about: ** CPU time ** Memory allocation @@ -39,6 +39,6 @@ endif::cnv-cluster[] * *Events* lists messages related to recent activity in the cluster, such as Pod creation or virtual machine migration to another host. * *Top Consumers* helps administrators understand how cluster resources are consumed. Click on a resource to jump to a detailed page listing Pods and nodes that consume the largest amount of the specified cluster resource (CPU, memory, or storage). -ifeval::["{context}" == "cnv-using-dashboard-to-get-cluster-info"] -:!cnv-cluster: +ifeval::["{context}" == "virt-using-dashboard-to-get-cluster-info"] +:!virt-cluster: endif::[] diff --git a/modules/cnv-about-the-vm-dashboard.adoc b/modules/virt-about-the-vm-dashboard.adoc similarity index 89% rename from modules/cnv-about-the-vm-dashboard.adoc rename to modules/virt-about-the-vm-dashboard.adoc index 2426914a42..37cf3a1c51 100644 --- a/modules/cnv-about-the-vm-dashboard.adoc +++ b/modules/virt-about-the-vm-dashboard.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-viewing-information-about-vm-workloads.adoc +// * virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc -[id="cnv-about-the-vm-dashboard_{context}"] +[id="virt-about-the-vm-dashboard_{context}"] = About the Virtual Machines dashboard Access the *Virtual Machines* dashboard from the {product-title} web console by navigating to the *Workloads* -> *Virtual Machines* page and diff --git a/modules/cnv-about-upgrading-cnv.adoc b/modules/virt-about-upgrading-virt.adoc similarity index 72% rename from modules/cnv-about-upgrading-cnv.adoc rename to modules/virt-about-upgrading-virt.adoc index 485cdb0ee0..2512688b5b 100644 --- a/modules/cnv-about-upgrading-cnv.adoc +++ b/modules/virt-about-upgrading-virt.adoc @@ -1,16 +1,16 @@ // Module included in the following assemblies: // -// * cnv/upgrading-container-native-virtualization.adoc +// * virt/upgrading-virt.adoc -[id="cnv-about-upgrading-cnv_{context}"] -= About upgrading container-native virtualization +[id="virt-about-upgrading-virt_{context}"] += About upgrading {VirtProductName} -== How {CNVProductName} upgrades work +== How {VirtProductName} upgrades work -* You can upgrade to the next minor version of {CNVProductName} by using the +* You can upgrade to the next minor version of {VirtProductName} by using the {product-title} web console to change the channel of your Operator subscription. -* You can enable automatic _z-stream_ updates during {CNVProductName} installation. +* You can enable automatic _z-stream_ updates during {VirtProductName} installation. * Updates are delivered via the _Marketplace Operator_, which is deployed during {product-title} installation. The Marketplace Operator makes @@ -19,7 +19,7 @@ external Operators available to your cluster. * The amount of time an update takes to complete depends on your network connection. Most automatic updates complete within fifteen minutes. -== How {CNVProductName} upgrades affect your cluster +== How {VirtProductName} upgrades affect your cluster * Upgrading does not interrupt virtual machine workloads. ** Virtual machine Pods are not restarted or migrated during an upgrade. If you diff --git a/modules/cnv-accessing-rdp-console.adoc b/modules/virt-accessing-rdp-console.adoc similarity index 90% rename from modules/cnv-accessing-rdp-console.adoc rename to modules/virt-accessing-rdp-console.adoc index c92c3e0f33..a7c45b514a 100644 --- a/modules/cnv-accessing-rdp-console.adoc +++ b/modules/virt-accessing-rdp-console.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +// * virt/virtual_machines/virt-accessing-vm-consoles.adoc -[id="cnv-accessing-rdp-console_{context}"] +[id="virt-accessing-rdp-console_{context}"] = Connecting to a Windows virtual machine with an RDP console The Remote Desktop Protocol (RDP) provides a better console experience for @@ -21,7 +21,7 @@ Windows virtual machine. .Procedure -. Log in to the {CNVProductName} cluster through the `oc` CLI tool as a user with +. Log in to the {VirtProductName} cluster through the `oc` CLI tool as a user with an access token. + ---- diff --git a/modules/cnv-accessing-serial-console.adoc b/modules/virt-accessing-serial-console.adoc similarity index 80% rename from modules/cnv-accessing-serial-console.adoc rename to modules/virt-accessing-serial-console.adoc index d025c5f9e6..002dc38cec 100644 --- a/modules/cnv-accessing-serial-console.adoc +++ b/modules/virt-accessing-serial-console.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +// * virt/virtual_machines/virt-accessing-vm-consoles.adoc -[id="cnv-accessing-serial-console_{context}"] +[id="virt-accessing-serial-console_{context}"] = Accessing the serial console of a virtual machine instance The `virtctl console` command opens a serial console to the specified virtual diff --git a/modules/cnv-accessing-vmi-ssh.adoc b/modules/virt-accessing-vmi-ssh.adoc similarity index 93% rename from modules/cnv-accessing-vmi-ssh.adoc rename to modules/virt-accessing-vmi-ssh.adoc index afb2a23825..3898d39cf0 100644 --- a/modules/cnv-accessing-vmi-ssh.adoc +++ b/modules/virt-accessing-vmi-ssh.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +// * virt/virtual_machines/virt-accessing-vm-consoles.adoc -[id="cnv-accessing-vmi-ssh_{context}"] +[id="virt-accessing-vmi-ssh_{context}"] = Accessing a virtual machine instance via SSH You can use SSH to access a virtual machine after you expose port diff --git a/modules/cnv-accessing-vnc-console.adoc b/modules/virt-accessing-vnc-console.adoc similarity index 88% rename from modules/cnv-accessing-vnc-console.adoc rename to modules/virt-accessing-vnc-console.adoc index ed08f229b4..0a651db0e1 100644 --- a/modules/cnv-accessing-vnc-console.adoc +++ b/modules/virt-accessing-vnc-console.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +// * virt/virtual_machines/virt-accessing-vm-consoles.adoc -[id="cnv-accessing-vnc-console_{context}"] +[id="virt-accessing-vnc-console_{context}"] = Accessing the graphical console of a virtual machine instances with VNC The `virtctl` client utility can use the `remote-viewer` function to open a diff --git a/modules/cnv-add-boot-order-web.adoc b/modules/virt-add-boot-order-web.adoc similarity index 90% rename from modules/cnv-add-boot-order-web.adoc rename to modules/virt-add-boot-order-web.adoc index caa564fc44..b2d1f1723f 100644 --- a/modules/cnv-add-boot-order-web.adoc +++ b/modules/virt-add-boot-order-web.adoc @@ -1,9 +1,9 @@ // Module included in the following assembly: // -// * cnv/cnv_users_guide/cnv-edit-boot-order.adoc +// * virt/virt_users_guide/virt-edit-boot-order.adoc // -[id="cnv-add-boot-order-web_{context}"] +[id="virt-add-boot-order-web_{context}"] = Adding items to a boot order list in the web console Add items to a boot order list by using the web console. diff --git a/modules/cnv-add-disk-to-vm.adoc b/modules/virt-add-disk-to-vm.adoc similarity index 72% rename from modules/cnv-add-disk-to-vm.adoc rename to modules/virt-add-disk-to-vm.adoc index 32bf7f13c7..06a303bddd 100644 --- a/modules/cnv-add-disk-to-vm.adoc +++ b/modules/virt-add-disk-to-vm.adoc @@ -1,22 +1,22 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-edit-vms.adoc -// * cnv/cnv_vm_templates/cnv-editing-vm-template.adoc +// * virt/virtual_machines/virt-edit-vms.adoc +// * virt/vm_templates/virt-editing-vm-template.adoc // Establishing conditionals so content can be re-used for editing VMs // and VM templates. -ifeval::["{context}" == "cnv-edit-vms"] +ifeval::["{context}" == "virt-edit-vms"] :object: virtual machine :object-gui: Virtual Machines endif::[] -ifeval::["{context}" == "cnv-editing-vm-template"] +ifeval::["{context}" == "virt-editing-vm-template"] :object: virtual machine template :object-gui: Virtual Machine Templates endif::[] -[id="cnv-vm-add-disk_{context}"] +[id="virt-vm-add-disk_{context}"] = Adding a virtual disk to a {object} @@ -33,12 +33,12 @@ Use this procedure to add a virtual disk to a {object}. // Unsetting all conditionals used in module -ifeval::["{context}" == "cnv-edit-vms"] +ifeval::["{context}" == "virt-edit-vms"] :object!: :object-gui!: endif::[] -ifeval::["{context}" == "cnv-editing-vm-template"] +ifeval::["{context}" == "virt-editing-vm-template"] :object!: :object-gui!: endif::[] diff --git a/modules/cnv-add-nic-to-vm.adoc b/modules/virt-add-nic-to-vm.adoc similarity index 80% rename from modules/cnv-add-nic-to-vm.adoc rename to modules/virt-add-nic-to-vm.adoc index ff578f90ad..776d1d3afa 100644 --- a/modules/cnv-add-nic-to-vm.adoc +++ b/modules/virt-add-nic-to-vm.adoc @@ -1,19 +1,19 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-edit-vms.adoc -// * cnv/cnv_vm_templates/cnv-editing-vm-template.adoc +// * virt/virtual_machines/virt-edit-vms.adoc +// * virt/vm_templates/virt-editing-vm-template.adoc -ifeval::["{context}" == "cnv-edit-vms"] +ifeval::["{context}" == "virt-edit-vms"] :object: virtual machine :object-gui: Virtual Machines endif::[] -ifeval::["{context}" == "cnv-editing-vm-template"] +ifeval::["{context}" == "virt-editing-vm-template"] :object: virtual machine template :object-gui: Virtual Machine Templates endif::[] -[id="cnv-vm-add-nic_{context}"] +[id="virt-vm-add-nic_{context}"] = Adding a network interface to a {object} @@ -45,12 +45,12 @@ is defined on the virtual machine and connected to the network. // Scrubbing all conditionals used in module -ifeval::["{context}" == "cnv-edit-vms"] +ifeval::["{context}" == "virt-edit-vms"] :object!: :object-gui!: endif::[] -ifeval::["{context}" == "cnv-editing-vm-template"] +ifeval::["{context}" == "virt-editing-vm-template"] :object!: :object-gui!: endif::[] diff --git a/modules/cnv-adding-tls-certificates-for-authenticating-dv-imports.adoc b/modules/virt-adding-tls-certificates-for-authenticating-dv-imports.adoc similarity index 80% rename from modules/cnv-adding-tls-certificates-for-authenticating-dv-imports.adoc rename to modules/virt-adding-tls-certificates-for-authenticating-dv-imports.adoc index a7da25ed34..76aae78d45 100644 --- a/modules/cnv-adding-tls-certificates-for-authenticating-dv-imports.adoc +++ b/modules/virt-adding-tls-certificates-for-authenticating-dv-imports.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-tls-certificates-for-dv-imports.adoc +// * virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc -[id="cnv-adding-tls-certificates-for-authenticating-dv-imports_{context}"] +[id="virt-adding-tls-certificates-for-authenticating-dv-imports_{context}"] = Adding TLS certificates for authenticating DataVolume imports TLS certificates for registry or HTTPS endpoints must be added to a ConfigMap diff --git a/modules/cnv-adding-virtio-drivers-vm-yaml.adoc b/modules/virt-adding-virtio-drivers-vm-yaml.adoc similarity index 70% rename from modules/cnv-adding-virtio-drivers-vm-yaml.adoc rename to modules/virt-adding-virtio-drivers-vm-yaml.adoc index 1b11ed0a1a..847e911169 100644 --- a/modules/cnv-adding-virtio-drivers-vm-yaml.adoc +++ b/modules/virt-adding-virtio-drivers-vm-yaml.adoc @@ -1,30 +1,32 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-new-windows-vm.adoc -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-existing-windows-vm.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc -[id="cnv-adding-virtio-drivers-vm-yaml_{context}"] +//This file contains UI elements and/or package names that need to be updated. + +[id="virt-adding-virtio-drivers-vm-yaml_{context}"] = Adding VirtIO drivers container disk to a virtual machine -{CNVProductNameStart} distributes VirtIO drivers for Microsoft Windows as a -container disk, which is available from the -link:https://access.redhat.com/containers/#/registry.access.redhat.com/container-native-virtualization/virtio-win[Red Hat Container Catalog]. -To install these drivers to a Windows virtual machine, attach the -`container-native-virtualization/virtio-win` container disk to the virtual machine as a SATA CD drive -in the virtual machine configuration file. +{VirtProductName} distributes VirtIO drivers for Microsoft Windows as a +container disk, which is available from the +link:https://access.redhat.com/containers/#/registry.access.redhat.com/container-native-virtualization/virtio-win[Red Hat Container Catalog]. +To install these drivers to a Windows virtual machine, attach the +`container-native-virtualization/virtio-win` container disk to the virtual machine as a SATA CD drive +in the virtual machine configuration file. .Prerequisites -* Download the `container-native-virtualization/virtio-win` container disk from the +* Download the `container-native-virtualization/virtio-win` container disk from the link:https://access.redhat.com/containers/#/registry.access.redhat.com/container-native-virtualization/virtio-win[Red Hat Container Catalog]. -This is not mandatory, because the container disk will be downloaded from the Red Hat registry +This is not mandatory, because the container disk will be downloaded from the Red Hat registry if it not already present in the cluster, but it can reduce installation time. .Procedure -. Add the `container-native-virtualization/virtio-win` container disk as a `cdrom` disk in the -Windows virtual machine configuration file. The container disk will be -downloaded from the registry if it is not already present in the cluster. +. Add the `container-native-virtualization/virtio-win` container disk as a `cdrom` disk in the +Windows virtual machine configuration file. The container disk will be +downloaded from the registry if it is not already present in the cluster. + [source,yaml] ---- @@ -41,19 +43,18 @@ volumes: image: container-native-virtualization/virtio-win name: virtiocontainerdisk ---- -<1> {CNVProductNameStart} boots virtual machine disks in the order defined in the -`VirtualMachine` configuration file. You can either define other disks for the -virtual machine before the `container-native-virtualization/virtio-win` container disk or use the optional +<1> {VirtProductName} boots virtual machine disks in the order defined in the +`VirtualMachine` configuration file. You can either define other disks for the +virtual machine before the `container-native-virtualization/virtio-win` container disk or use the optional `bootOrder` parameter to ensure the virtual machine boots from the correct disk. - If you specify the `bootOrder` for a disk, it must be specified for all disks + If you specify the `bootOrder` for a disk, it must be specified for all disks in the configuration. . The disk is available once the virtual machine has started: -** If you add the container disk to a running virtual machine, use -`oc apply -f ` in the CLI or reboot the virtual machine for the changes +** If you add the container disk to a running virtual machine, use +`oc apply -f ` in the CLI or reboot the virtual machine for the changes to take effect. ** If the virtual machine is not running, use `virtctl start `. -After the virtual machine has started, the VirtIO drivers can be installed from +After the virtual machine has started, the VirtIO drivers can be installed from the attached SATA CD drive. - diff --git a/modules/cnv-automating-virtual-machine-creation-with-ansible.adoc b/modules/virt-automating-virtual-machine-creation-with-ansible.adoc similarity index 93% rename from modules/cnv-automating-virtual-machine-creation-with-ansible.adoc rename to modules/virt-automating-virtual-machine-creation-with-ansible.adoc index 3fc1c7956b..86cb74b1e3 100644 --- a/modules/cnv-automating-virtual-machine-creation-with-ansible.adoc +++ b/modules/virt-automating-virtual-machine-creation-with-ansible.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-automating-management-tasks.adoc +// * virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc -[id="cnv-automating-virtual-machine-creation-with-ansible_{context}"] +[id="virt-automating-virtual-machine-creation-with-ansible_{context}"] = Automating virtual machine creation You can use the `kubevirt_vm` Ansible Playbook to create virtual machines in diff --git a/modules/cnv-cancelling-vm-migration-cli.adoc b/modules/virt-cancelling-vm-migration-cli.adoc similarity index 80% rename from modules/cnv-cancelling-vm-migration-cli.adoc rename to modules/virt-cancelling-vm-migration-cli.adoc index 85e752682f..a91280fe5f 100644 --- a/modules/cnv-cancelling-vm-migration-cli.adoc +++ b/modules/virt-cancelling-vm-migration-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-cancel-vmi-migration.adoc +// * virt/live_migration/virt-cancel-vmi-migration.adoc -[id="cnv-cancelling-vm-migration-cli_{context}"] +[id="virt-cancelling-vm-migration-cli_{context}"] = Cancelling live migration of a virtual machine instance in the CLI Cancel the live migration of a virtual machine instance by deleting the diff --git a/modules/cnv-cancelling-vm-migration-web.adoc b/modules/virt-cancelling-vm-migration-web.adoc similarity index 84% rename from modules/cnv-cancelling-vm-migration-web.adoc rename to modules/virt-cancelling-vm-migration-web.adoc index 61bd20c71b..5e7fc76276 100644 --- a/modules/cnv-cancelling-vm-migration-web.adoc +++ b/modules/virt-cancelling-vm-migration-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-cancel-vmi-migration.adoc +// * virt/live_migration/virt-cancel-vmi-migration.adoc -[id="cnv-cancelling-vm-migration-web_{context}"] +[id="virt-cancelling-vm-migration-web_{context}"] = Cancelling live migration of a virtual machine instance in the web console A live migration of the virtual machine instance can be cancelled using the @@ -12,7 +12,7 @@ on the *Virtual Machine Details* screen. .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machines*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machines*. . You can cancel the migration from this screen, which makes it easier to perform actions on multiple virtual machines in the one screen, or from the *Virtual Machine Details* screen where you can view comprehensive details of the selected virtual machine: ** Click the Options menu {kebab} at the end of virtual machine and select *Cancel Virtual Machine Migration*. diff --git a/modules/cnv-cdi-supported-operations-matrix.adoc b/modules/virt-cdi-supported-operations-matrix.adoc similarity index 57% rename from modules/cnv-cdi-supported-operations-matrix.adoc rename to modules/virt-cdi-supported-operations-matrix.adoc index 538c78a97a..218dd06813 100644 --- a/modules/cnv-cdi-supported-operations-matrix.adoc +++ b/modules/virt-cdi-supported-operations-matrix.adoc @@ -1,16 +1,16 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-virtctl.adoc -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-block.adoc -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-using-datavolumetemplate.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume-block.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes-block.adoc +// * virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc +// * virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc +// * virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc -[id="cnv-cdi-supported-operations-matrix_{context}"] +[id="virt-cdi-supported-operations-matrix_{context}"] = CDI supported operations matrix This matrix shows the supported CDI operations for content types against endpoints, and which of these operations requires scratch space. diff --git a/modules/cnv-cdrom-wizard-fields-web.adoc b/modules/virt-cdrom-wizard-fields-web.adoc similarity index 71% rename from modules/cnv-cdrom-wizard-fields-web.adoc rename to modules/virt-cdrom-wizard-fields-web.adoc index 5257ba88be..5aed4d39d1 100644 --- a/modules/cnv-cdrom-wizard-fields-web.adoc +++ b/modules/virt-cdrom-wizard-fields-web.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-create-vms.adoc -// * cnv/cnv_vm_templates/cnv-creating-vm-template.adoc +// * virt/virtual_machines/virt-create-vms.adoc +// * virt/vm_templates/virt-creating-vm-template.adoc -[id="cnv-cdrom-wizard-fields-web_{context}"] +[id="virt-cdrom-wizard-fields-web_{context}"] = CD-ROM fields |=== diff --git a/modules/virt-cli-reference-controlling-vms.adoc b/modules/virt-cli-reference-controlling-vms.adoc new file mode 100644 index 0000000000..f655713f4c --- /dev/null +++ b/modules/virt-cli-reference-controlling-vms.adoc @@ -0,0 +1,84 @@ +// Module included in the following assemblies: +// +// * virt/virtual_machines/virt-controlling-vm-states.adoc + +[id="virt-cli-reference-controlling-vms_{context}"] += CLI reference for controlling virtual machines + +Use the following `virtctl` client utility and `oc` commands to change the state of the virtual +machines and display lists of the virtual machines and the virtual machine instances +that represent them. + +[NOTE] +==== +When you run `virtctl` commands, you modify the virtual machines themselves, +not the virtual machine instances that represent them in the web console. +==== + +== start + +Start a virtual machine. + +.Example: Start a virtual machine in the current project +---- +$ virtctl start +---- + +.Example: Start a virtual machine in a specific project +---- +$ virtctl start -n +---- + +== restart + +Restart a running virtual machine. + +.Example: Restart a virtual machine in the current project +---- +$ virtctl restart +---- + +.Example: Restart a virtual machine in a specific project +---- +$ virtctl restart -n +---- + +== stop + +Stop a running virtual machine. + +.Example: Stop a virtual machine in the current project +---- +$ virtctl stop +---- + +.Example: Stop a virtual machine in a specific project +---- +$ virtctl stop -n +---- + +== list + +List the virtual machines or virtual machine instances in a project. The +virtual machine instances are abstractions that represent the virtual machines +themselves. + +.Example: List the virtual machines in the current project +---- +$ oc get vm +---- + +.Example: List the virtual machines in a specific project +---- +$ oc get vm -n +---- + +.Example: List the running virtual machine instances in the current project +---- +$ oc get vmi +---- + +.Example: List the running virtual machine instances in a specific project +---- +$ oc get vmi -n +---- diff --git a/modules/cnv-cloning-local-volume-to-another-node.adoc b/modules/virt-cloning-local-volume-to-another-node.adoc similarity index 93% rename from modules/cnv-cloning-local-volume-to-another-node.adoc rename to modules/virt-cloning-local-volume-to-another-node.adoc index 70bf1f71e7..3f91491e02 100644 --- a/modules/cnv-cloning-local-volume-to-another-node.adoc +++ b/modules/virt-cloning-local-volume-to-another-node.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-moving-local-vm-disk-to-different-node.adoc +// * virt/virtual_machines/virtual_disks/virt-moving-local-vm-disk-to-different-node.adoc -[id="cnv-cloning-local-volume-to-another-node_{context}"] +[id="virt-cloning-local-volume-to-another-node_{context}"] = Cloning a local volume to another node You can move a virtual machine disk so that it runs on a specific node by cloning the underlying PersistentVolumeClaim (PVC). @@ -18,13 +18,13 @@ If the destination PV is smaller than the source PVC, the cloning operation fail .Prerequisites -* The virtual machine must not be running. Power down the virtual machine before cloning the virtual machine disk. +* The virtual machine must not be running. Power down the virtual machine before cloning the virtual machine disk. .Procedure . Either create a new local PV on the node, or identify a local PV already on the node: -* Create a local PV that includes the `nodeAffinity.nodeSelectorTerms` parameters. The following manifest creates a `10Gi` local PV on `node01`. +* Create a local PV that includes the `nodeAffinity.nodeSelectorTerms` parameters. The following manifest creates a `10Gi` local PV on `node01`. + [source,yaml] ---- @@ -80,7 +80,7 @@ spec: ... ---- <1> The `kubernetes.io/hostname` key uses the node host name to select a node. -<2> The host name of the node. +<2> The host name of the node. . Add a unique label to the PV: + diff --git a/modules/cnv-cloning-pvc-of-vm-disk-into-new-datavolume.adoc b/modules/virt-cloning-pvc-of-vm-disk-into-new-datavolume.adoc similarity index 90% rename from modules/cnv-cloning-pvc-of-vm-disk-into-new-datavolume.adoc rename to modules/virt-cloning-pvc-of-vm-disk-into-new-datavolume.adoc index 9cc85a9a99..7807af4239 100644 --- a/modules/cnv-cloning-pvc-of-vm-disk-into-new-datavolume.adoc +++ b/modules/virt-cloning-pvc-of-vm-disk-into-new-datavolume.adoc @@ -1,11 +1,11 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume-block.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc // `blockstorage` conditionals are used (declared in the "*-block" assembly) to separate content -[id="cnv-cloning-pvc-of-vm-disk-into-new-datavolume_{context}"] +[id="virt-cloning-pvc-of-vm-disk-into-new-datavolume_{context}"] = Cloning the PersistentVolumeClaim of a virtual machine disk into a new DataVolume You can clone a PersistentVolumeClaim (PVC) of an existing virtual machine disk diff --git a/modules/cnv-cloud-init-fields-web.adoc b/modules/virt-cloud-init-fields-web.adoc similarity index 63% rename from modules/cnv-cloud-init-fields-web.adoc rename to modules/virt-cloud-init-fields-web.adoc index 0a64beabd3..aa74f55bbd 100644 --- a/modules/cnv-cloud-init-fields-web.adoc +++ b/modules/virt-cloud-init-fields-web.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-create-vms.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc -// * cnv/cnv_vm_templates/cnv-creating-vm-template.adoc +// * virt/virtual_machines/virt-create-vms.adoc +// * virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc +// * virt/vm_templates/virt-creating-vm-template.adoc -[id="cnv-cloud-init-fields-web_{context}"] +[id="virt-cloud-init-fields-web_{context}"] = Cloud-init fields |=== diff --git a/modules/cnv-configuring-guest-memory-overcommitment.adoc b/modules/virt-configuring-guest-memory-overcommitment.adoc similarity index 91% rename from modules/cnv-configuring-guest-memory-overcommitment.adoc rename to modules/virt-configuring-guest-memory-overcommitment.adoc index c78f7c60ba..2f2b9fc746 100644 --- a/modules/cnv-configuring-guest-memory-overcommitment.adoc +++ b/modules/virt-configuring-guest-memory-overcommitment.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-managing-guest-memory.adoc +// * virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc -[id="cnv-configuring-guest-memory-overcommitment_{context}"] +[id="virt-configuring-guest-memory-overcommitment_{context}"] = Configuring guest memory overcommitment If your virtual workload requires more memory than available, you can diff --git a/modules/cnv-configuring-live-migration-limits.adoc b/modules/virt-configuring-live-migration-limits.adoc similarity index 88% rename from modules/cnv-configuring-live-migration-limits.adoc rename to modules/virt-configuring-live-migration-limits.adoc index 0a220f52f0..0a6cfd85a7 100644 --- a/modules/cnv-configuring-live-migration-limits.adoc +++ b/modules/virt-configuring-live-migration-limits.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-live-migration-limits.adoc +// * virt/live_migration/virt-live-migration-limits.adoc -[id="cnv-configuring-live-migration-limits_{context}"] +[id="virt-configuring-live-migration-limits_{context}"] = Configuring live migration limits and timeouts Configure live migration limits and timeouts for the cluster by adding updated diff --git a/modules/cnv-configuring-masquerade-mode-cli.adoc b/modules/virt-configuring-masquerade-mode-cli.adoc similarity index 87% rename from modules/cnv-configuring-masquerade-mode-cli.adoc rename to modules/virt-configuring-masquerade-mode-cli.adoc index 17ef7e993f..a14d3b666e 100644 --- a/modules/cnv-configuring-masquerade-mode-cli.adoc +++ b/modules/virt-configuring-masquerade-mode-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-using-the-default-pod-network-with-cnv.adoc +// * virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc -[id="cnv-configuring-masquerade-mode-cli_{context}"] +[id="virt-configuring-masquerade-mode-cli_{context}"] = Configuring masquerade mode from the command line You can use masquerade mode to hide a virtual machine's outgoing traffic behind diff --git a/modules/cnv-configuring-selinux-hpp-on-rhcos8.adoc b/modules/virt-configuring-selinux-hpp-on-rhcos8.adoc similarity index 91% rename from modules/cnv-configuring-selinux-hpp-on-rhcos8.adoc rename to modules/virt-configuring-selinux-hpp-on-rhcos8.adoc index ac9bf54796..6467d04c88 100644 --- a/modules/cnv-configuring-selinux-hpp-on-rhcos8.adoc +++ b/modules/virt-configuring-selinux-hpp-on-rhcos8.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-configuring-local-storage-for-vms.adoc +// * virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc -[id="cnv-configuring-selinux-hpp-on-rhcos8_{context}"] +[id="virt-configuring-selinux-hpp-on-rhcos8_{context}"] = Configuring SELinux for the hostpath provisioner on Red Hat Enterprise Linux CoreOS 8 You must configure SELinux before you create the HostPathProvisioner custom diff --git a/modules/cnv-configuring-vm-live-migration-cli.adoc b/modules/virt-configuring-vm-live-migration-cli.adoc similarity index 88% rename from modules/cnv-configuring-vm-live-migration-cli.adoc rename to modules/virt-configuring-vm-live-migration-cli.adoc index f2c1308a76..8d112e212c 100644 --- a/modules/cnv-configuring-vm-live-migration-cli.adoc +++ b/modules/virt-configuring-vm-live-migration-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-configuring-vmi-eviction-strategy.adoc +// * virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc -[id="cnv-configuring-vm-live-migration-cli_{context}"] +[id="virt-configuring-vm-live-migration-cli_{context}"] = Configuring custom virtual machines with the `LiveMigration` eviction strategy You only need to configure the `LiveMigration` eviction strategy on custom diff --git a/modules/cnv-confirming-policy-updates-on-nodes.adoc b/modules/virt-confirming-policy-updates-on-nodes.adoc similarity index 92% rename from modules/cnv-confirming-policy-updates-on-nodes.adoc rename to modules/virt-confirming-policy-updates-on-nodes.adoc index ce4eefac4c..a321dc11a9 100644 --- a/modules/cnv-confirming-policy-updates-on-nodes.adoc +++ b/modules/virt-confirming-policy-updates-on-nodes.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-configuring-node-network-policy +// * virt/node_network/virt-configuring-node-network-policy -[id="cnv-confirming-policy-updates-on-nodes_{context}"] +[id="virt-confirming-policy-updates-on-nodes_{context}"] = Confirming Policy updates on nodes A `NodeNetworkConfigurationPolicy` manifest describes your requested network configuration for nodes in the cluster. diff --git a/modules/cnv-connecting-to-the-terminal.adoc b/modules/virt-connecting-to-the-terminal.adoc similarity index 84% rename from modules/cnv-connecting-to-the-terminal.adoc rename to modules/virt-connecting-to-the-terminal.adoc index 58a2768ea0..da50afccad 100644 --- a/modules/cnv-connecting-to-the-terminal.adoc +++ b/modules/virt-connecting-to-the-terminal.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +// * virt/virtual_machines/virt-accessing-vm-consoles.adoc -[id="cnv-connecting-to-the-terminal_{context}"] +[id="virt-connecting-to-the-terminal_{context}"] = Connecting to the terminal You can connect to a virtual machine by using the web console. diff --git a/modules/cnv-connecting-vnc-console.adoc b/modules/virt-connecting-vnc-console.adoc similarity index 63% rename from modules/cnv-connecting-vnc-console.adoc rename to modules/virt-connecting-vnc-console.adoc index db6fa95821..2b3bb47595 100644 --- a/modules/cnv-connecting-vnc-console.adoc +++ b/modules/virt-connecting-vnc-console.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +// * virt/virtual_machines/virt-accessing-vm-consoles.adoc -[id="cnv-connecting-vnc-console_{context}"] +[id="virt-connecting-vnc-console_{context}"] = Connecting to the VNC console Connect to the VNC console of a running virtual machine from the *Consoles* tab @@ -10,6 +10,6 @@ in the *Virtual Machine Details* screen of the web console. .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machines*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machines*. . Select a virtual machine. . Click *Consoles*. The VNC console opens by default. diff --git a/modules/cnv-creating-an-upload-dv.adoc b/modules/virt-creating-an-upload-dv.adoc similarity index 85% rename from modules/cnv-creating-an-upload-dv.adoc rename to modules/virt-creating-an-upload-dv.adoc index 3513be8774..29edcc7a94 100644 --- a/modules/cnv-creating-an-upload-dv.adoc +++ b/modules/virt-creating-an-upload-dv.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-block.adoc +// * virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc -[id="cnv-creating-an-upload-dv_{context}"] +[id="virt-creating-an-upload-dv_{context}"] = Creating an upload DataVolume You can manually create a DataVolume with an `upload` data source to use for uploading diff --git a/modules/cnv-creating-blank-disk-datavolumes.adoc b/modules/virt-creating-blank-disk-datavolumes.adoc similarity index 84% rename from modules/cnv-creating-blank-disk-datavolumes.adoc rename to modules/virt-creating-blank-disk-datavolumes.adoc index a2714c0988..6d05f09205 100644 --- a/modules/cnv-creating-blank-disk-datavolumes.adoc +++ b/modules/virt-creating-blank-disk-datavolumes.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-expanding-virtual-storage-with-blank-disk-images.adoc +// * virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc -[id="cnv-creating-blank-disk-datavolumes_{context}"] +[id="virt-creating-blank-disk-datavolumes_{context}"] = Creating a blank disk image with DataVolumes You can create a new blank disk image in a PersistentVolumeClaim by diff --git a/modules/cnv-creating-bridge-nad-cli.adoc b/modules/virt-creating-bridge-nad-cli.adoc similarity index 94% rename from modules/cnv-creating-bridge-nad-cli.adoc rename to modules/virt-creating-bridge-nad-cli.adoc index 105c615b66..0bf7fb63b1 100644 --- a/modules/cnv-creating-bridge-nad-cli.adoc +++ b/modules/virt-creating-bridge-nad-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-attaching-vm-multiple-networks.adoc +// * virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc -[id="cnv-creating-bridge-nad-cli_{context}"] +[id="virt-creating-bridge-nad-cli_{context}"] = Creating a Linux bridge NetworkAttachmentDefinition in the CLI As a network administrator, you can configure a NetworkAttachmentDefinition diff --git a/modules/cnv-creating-bridge-nad-web.adoc b/modules/virt-creating-bridge-nad-web.adoc similarity index 66% rename from modules/cnv-creating-bridge-nad-web.adoc rename to modules/virt-creating-bridge-nad-web.adoc index 224da86064..6b7a703d16 100644 --- a/modules/cnv-creating-bridge-nad-web.adoc +++ b/modules/virt-creating-bridge-nad-web.adoc @@ -1,15 +1,17 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-attaching-vm-multiple-networks.adoc +// * virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc -[id="cnv-creating-bridge-nad-web_{context}"] +//This file contains UI elements and/or package names that need to be updated. + +[id="virt-creating-bridge-nad-web_{context}"] = Creating a Linux bridge NetworkAttachmentDefinition in the web console The NetworkAttachmentDefinition is a custom resource that exposes layer-2 devices -to a specific namespace in your {CNVProductName} cluster. +to a specific namespace in your {VirtProductName} cluster. -Network administrators can create NetworkAttachmentDefinitions -to provide existing layer-2 networking to Pods and virtual machines. +Network administrators can create NetworkAttachmentDefinitions +to provide existing layer-2 networking to Pods and virtual machines. .Procedure @@ -19,6 +21,4 @@ to provide existing layer-2 networking to Pods and virtual machines. . Click the *Network Type* list and select *CNV Linux bridge*. . Enter the name of the bridge in the *Bridge Name* field. . (Optional) If the resource has VLAN IDs configured, enter the ID numbers in the *VLAN Tag Number* field. -. Click *Create*. - - +. Click *Create*. diff --git a/modules/cnv-creating-interface-on-nodes.adoc b/modules/virt-creating-interface-on-nodes.adoc similarity index 93% rename from modules/cnv-creating-interface-on-nodes.adoc rename to modules/virt-creating-interface-on-nodes.adoc index 03cdfdeb28..de1609532a 100644 --- a/modules/cnv-creating-interface-on-nodes.adoc +++ b/modules/virt-creating-interface-on-nodes.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-updating-node-network-config.adoc +// * virt/node_network/virt-updating-node-network-config.adoc -[id="cnv-creating-interface-on-nodes_{context}"] +[id="virt-creating-interface-on-nodes_{context}"] = Creating an interface on nodes Create an interface on nodes in the cluster by applying a `NodeNetworkConfigurationPolicy` manifest to the cluster. The manifest details the requested configuration for the interface. diff --git a/modules/cnv-creating-local-block-pv.adoc b/modules/virt-creating-local-block-pv.adoc similarity index 84% rename from modules/cnv-creating-local-block-pv.adoc rename to modules/virt-creating-local-block-pv.adoc index 07f377c4f4..0ee9ca9a71 100644 --- a/modules/cnv-creating-local-block-pv.adoc +++ b/modules/virt-creating-local-block-pv.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-block.adoc -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume-block.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes-block.adoc +// * virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc -[id="cnv-creating-local-block-pv_{context}"] +[id="virt-creating-local-block-pv_{context}"] = Creating a local block PersistentVolume Create a local block PersistentVolume (PV) on a node by populating a file and diff --git a/modules/cnv-creating-new-vm-from-cloned-pvc-using-datavolumetemplate.adoc b/modules/virt-creating-new-vm-from-cloned-pvc-using-datavolumetemplate.adoc similarity index 93% rename from modules/cnv-creating-new-vm-from-cloned-pvc-using-datavolumetemplate.adoc rename to modules/virt-creating-new-vm-from-cloned-pvc-using-datavolumetemplate.adoc index b1735213da..0c4acb0e0f 100644 --- a/modules/cnv-creating-new-vm-from-cloned-pvc-using-datavolumetemplate.adoc +++ b/modules/virt-creating-new-vm-from-cloned-pvc-using-datavolumetemplate.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-using-datavolumetemplate.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc -[id="cnv-creating-new-vm-from-cloned-pvc-using-datavolumetemplate_{context}"] +[id="virt-creating-new-vm-from-cloned-pvc-using-datavolumetemplate_{context}"] = Creating a new virtual machine from a cloned PersistentVolumeClaim by using a DataVolumeTemplate You can create a virtual machine that clones the PersistentVolumeClaim (PVC) of diff --git a/modules/cnv-creating-rbac-cloning-dvs.adoc b/modules/virt-creating-rbac-cloning-dvs.adoc similarity index 91% rename from modules/cnv-creating-rbac-cloning-dvs.adoc rename to modules/virt-creating-rbac-cloning-dvs.adoc index 3118b7cb9f..9a0055008a 100644 --- a/modules/cnv-creating-rbac-cloning-dvs.adoc +++ b/modules/virt-creating-rbac-cloning-dvs.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-enabling-user-permissions-to-clone-datavolumes.adoc +// * virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc -[id="cnv-creating-rbac-cloning-dvs_{context}"] +[id="virt-creating-rbac-cloning-dvs_{context}"] = Creating RBAC resources for cloning DataVolumes Create a new ClusterRole that enables permissions for all actions for the `datavolumes` resource. diff --git a/modules/cnv-creating-storage-class.adoc b/modules/virt-creating-storage-class.adoc similarity index 91% rename from modules/cnv-creating-storage-class.adoc rename to modules/virt-creating-storage-class.adoc index c4a178d445..612ef7bcd6 100644 --- a/modules/cnv-creating-storage-class.adoc +++ b/modules/virt-creating-storage-class.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-configuring-local-storage-for-vms.adoc +// * virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc -[id="cnv-creating-storage-class_{context}"] +[id="virt-creating-storage-class_{context}"] = Creating a StorageClass object When you create a StorageClass object, you set parameters that affect the diff --git a/modules/cnv-creating-template-wizard-web.adoc b/modules/virt-creating-template-wizard-web.adoc similarity index 91% rename from modules/cnv-creating-template-wizard-web.adoc rename to modules/virt-creating-template-wizard-web.adoc index c53f3439b0..08c5be39bb 100644 --- a/modules/cnv-creating-template-wizard-web.adoc +++ b/modules/virt-creating-template-wizard-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_vm_templates/cnv-creating-vm-template.adoc +// * virt/vm_templates/virt-creating-vm-template.adoc -[id="cnv-creating-template-wizard-web_{context}"] +[id="virt-creating-template-wizard-web_{context}"] = Creating a virtual machine template with the interactive wizard in the web console The web console features an interactive wizard that guides you through the *General*, @@ -12,7 +12,7 @@ until you provide values in the required fields. .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machine Templates*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machine Templates*. . Click *Create Template* and select *New with Wizard*. . Fill in all required fields in the *General* step. . Click *Next* to progress to the *Networking* screen. A NIC that is named `nic0` is attached by default. diff --git a/modules/cnv-creating-vddk-image.adoc b/modules/virt-creating-vddk-image.adoc similarity index 90% rename from modules/cnv-creating-vddk-image.adoc rename to modules/virt-creating-vddk-image.adoc index 1574b8934e..69b3460ecf 100644 --- a/modules/cnv-creating-vddk-image.adoc +++ b/modules/virt-creating-vddk-image.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc +// * virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc -[id="cnv-creating-vddk-image_{context}"] +[id="virt-creating-vddk-image_{context}"] = Creating a VDDK image The VMware Virtual Disk Development Kit (VDDK) SDK is used to copy VMware virtual disks. @@ -58,7 +58,7 @@ $ docker push <1> ---- <1> Specify your repository details. -. Ensure that the image is accessible to your {CNVProductName} environment. +. Ensure that the image is accessible to your {VirtProductName} environment. . Edit the `v2v-vmware` ConfigMap in the *openshift-cnv* project: + ---- diff --git a/modules/cnv-creating-vm-wizard-web.adoc b/modules/virt-creating-vm-wizard-web.adoc similarity index 96% rename from modules/cnv-creating-vm-wizard-web.adoc rename to modules/virt-creating-vm-wizard-web.adoc index 23f625a78d..77bbcbdabd 100644 --- a/modules/cnv-creating-vm-wizard-web.adoc +++ b/modules/virt-creating-vm-wizard-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-create-vms.adoc +// * virt/virtual_machines/virt-create-vms.adoc -[id="cnv-creating-vm-wizard-web_{context}"] +[id="virt-creating-vm-wizard-web_{context}"] = Running the virtual machine wizard to create a virtual machine The web console features an interactive wizard that guides you through *General*, *Networking*, *Storage*, *Advanced*, and *Review* steps to simplify the process of creating virtual machines. All required fields are marked by a `*`. When the required fields are completed, you can review and create your virtual machine. diff --git a/modules/cnv-creating-vm-yaml-web.adoc b/modules/virt-creating-vm-yaml-web.adoc similarity index 92% rename from modules/cnv-creating-vm-yaml-web.adoc rename to modules/virt-creating-vm-yaml-web.adoc index 86984d09f6..b08a0d3117 100644 --- a/modules/cnv-creating-vm-yaml-web.adoc +++ b/modules/virt-creating-vm-yaml-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-create-vms.adoc +// * virt/virtual_machines/virt-create-vms.adoc -[id="cnv-creating-vm-yaml-web_{context}"] +[id="virt-creating-vm-yaml-web_{context}"] = Pasting in a pre-configured YAML file to create a virtual machine Create a virtual machine by writing or pasting a YAML configuration file in the web console in the *Workloads* -> *Virtual Machines* screen. A valid `example` virtual machine configuration is provided by default whenever you open the YAML edit screen. diff --git a/modules/cnv-creating-vm.adoc b/modules/virt-creating-vm.adoc similarity index 91% rename from modules/cnv-creating-vm.adoc rename to modules/virt-creating-vm.adoc index 871f723c91..2570e1b551 100644 --- a/modules/cnv-creating-vm.adoc +++ b/modules/virt-creating-vm.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-create-vms.adoc +// * virt/virtual_machines/virt-create-vms.adoc -[id="cnv-creating-vm_{context}"] +[id="virt-creating-vm_{context}"] = Using the CLI to create a virtual machine .Procedure @@ -26,7 +26,7 @@ instance by starting it. [NOTE] ==== A https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/[ReplicaSet]’s purpose is often used to guarantee the availability of a specified number of identical Pods. -ReplicaSet is not currently supported in {CNVProductName}. +ReplicaSet is not currently supported in {VirtProductName}. ==== diff --git a/modules/cnv-define-http-liveness-probe.adoc b/modules/virt-define-http-liveness-probe.adoc similarity index 93% rename from modules/cnv-define-http-liveness-probe.adoc rename to modules/virt-define-http-liveness-probe.adoc index 008402e916..94fdf3030e 100644 --- a/modules/cnv-define-http-liveness-probe.adoc +++ b/modules/virt-define-http-liveness-probe.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-monitoring-vm-health.adoc +// * virt/logging_events_monitoring/virt-monitoring-vm-health.adoc -[id="cnv-define-http-liveness-probe_{context}"] +[id="virt-define-http-liveness-probe_{context}"] = Define an HTTP liveness probe diff --git a/modules/cnv-define-readiness-probe.adoc b/modules/virt-define-readiness-probe.adoc similarity index 94% rename from modules/cnv-define-readiness-probe.adoc rename to modules/virt-define-readiness-probe.adoc index ef574a173d..4ebe3ee628 100644 --- a/modules/cnv-define-readiness-probe.adoc +++ b/modules/virt-define-readiness-probe.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-monitoring-vm-health.adoc +// * virt/logging_events_monitoring/virt-monitoring-vm-health.adoc -[id="cnv-define-readiness-probe_{context}"] +[id="virt-define-readiness-probe_{context}"] = Define a readiness probe diff --git a/modules/cnv-define-tcp-liveness-probe.adoc b/modules/virt-define-tcp-liveness-probe.adoc similarity index 93% rename from modules/cnv-define-tcp-liveness-probe.adoc rename to modules/virt-define-tcp-liveness-probe.adoc index d18ae328fd..93da59411f 100644 --- a/modules/cnv-define-tcp-liveness-probe.adoc +++ b/modules/virt-define-tcp-liveness-probe.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-monitoring-vm-health.adoc +// * virt/logging_events_monitoring/virt-monitoring-vm-health.adoc -[id="cnv-define-tcp-liveness-probe_{context}"] +[id="virt-define-tcp-liveness-probe_{context}"] = Define a TCP liveness probe diff --git a/modules/cnv-defining-storageclass-in-cdi-configuration.adoc b/modules/virt-defining-storageclass-in-cdi-configuration.adoc similarity index 79% rename from modules/cnv-defining-storageclass-in-cdi-configuration.adoc rename to modules/virt-defining-storageclass-in-cdi-configuration.adoc index f40bea6b40..2ec76469e0 100644 --- a/modules/cnv-defining-storageclass-in-cdi-configuration.adoc +++ b/modules/virt-defining-storageclass-in-cdi-configuration.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc +// * virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc -[id="cnv-defining-storageclass-in-cdi-configuration_{context}"] +[id="virt-defining-storageclass-in-cdi-configuration_{context}"] = Defining a StorageClass in the CDI configuration Define a StorageClass in the CDI configuration to dynamically provision scratch diff --git a/modules/cnv-delete-vm-web.adoc b/modules/virt-delete-vm-web.adoc similarity index 77% rename from modules/cnv-delete-vm-web.adoc rename to modules/virt-delete-vm-web.adoc index 27c8b222dd..238847adf4 100644 --- a/modules/cnv-delete-vm-web.adoc +++ b/modules/virt-delete-vm-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-delete-vms.adoc +// * virt/virtual_machines/virt-delete-vms.adoc -[id="cnv-delete-vm-web_{context}"] +[id="virt-delete-vm-web_{context}"] = Deleting a virtual machine using the web console @@ -14,7 +14,7 @@ When you delete a virtual machine, the DataVolume it uses is automatically delet .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machines* from the side menu. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machines* from the side menu. . Click the ⋮ button of the virtual machine that you want to delete and select *Delete Virtual Machine*. ** Alternatively, click the virtual machine name to open the *Virtual Machine Details* screen and click *Actions* -> *Delete Virtual Machine*. . In the confirmation pop-up window, click *Delete* to permanently delete the virtual machine. diff --git a/modules/virt-deleting-catalog-subscription.adoc b/modules/virt-deleting-catalog-subscription.adoc new file mode 100644 index 0000000000..251021a7bf --- /dev/null +++ b/modules/virt-deleting-catalog-subscription.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * virt/install/uninstalling-virt.adoc + +[id="virt-deleting-catalog-subscription_{context}"] += Deleting the {VirtProductName} catalog subscription + +To finish uninstalling {VirtProductName}, delete the +*{VirtProductName}* catalog subscription. + +.Prerequisites + +* An active subscription to the *{VirtProductName}* catalog + +.Procedure + +. Navigate to the *Operators* -> *OperatorHub* page. + +. Search for *{VirtProductName}* and then select it. + +. Click *Uninstall*. diff --git a/modules/cnv-deleting-custom-resource.adoc b/modules/virt-deleting-custom-resource.adoc similarity index 76% rename from modules/cnv-deleting-custom-resource.adoc rename to modules/virt-deleting-custom-resource.adoc index faff47dd14..3232f81d4d 100644 --- a/modules/cnv-deleting-custom-resource.adoc +++ b/modules/virt-deleting-custom-resource.adoc @@ -1,11 +1,13 @@ // Module included in the following assemblies: // -// * cnv/cnv_install/uninstalling-container-native-virtualization.adoc +// * virt/install/uninstalling-virt.adoc -[id="cnv-deleting-kubevirt-hyperconverged-custom-resource_{context}"] +//This file contains UI elements and/or package names that need to be updated. + +[id="virt-deleting-kubevirt-hyperconverged-custom-resource_{context}"] = Deleting the CNV Operator Deployment custom resource -To uninstall {CNVProductName}, you must first delete the +To uninstall {VirtProductName}, you must first delete the *CNV Operator Deployment* custom resource. .Prerequisites @@ -19,7 +21,7 @@ the *Projects* list. . Navigate to the *Operators* -> *Installed Operators* page. -. Click *{CNVProductNameStart}*. +. Click *{VirtProductName}*. . Click the *CNV Operator Deployment* tab. @@ -37,4 +39,3 @@ the following command: ---- $ oc delete apiservices v1alpha3.subresources.kubevirt.io -n openshift-cnv ---- - diff --git a/modules/cnv-deleting-dvs.adoc b/modules/virt-deleting-dvs.adoc similarity index 84% rename from modules/cnv-deleting-dvs.adoc rename to modules/virt-deleting-dvs.adoc index 697deb3728..530145655b 100644 --- a/modules/cnv-deleting-dvs.adoc +++ b/modules/virt-deleting-dvs.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-deleting-datavolumes.adoc +// * virt/virtual_machines/virt-deleting-datavolumes.adoc -[id="cnv-deleting-dvs_{context}"] +[id="virt-deleting-dvs_{context}"] = Deleting a DataVolume @@ -25,4 +25,4 @@ $ oc delete dv This command only deletes objects that exist in the current project. Specify the `-n ` option if the object you want to delete is in a different project or namespace. -==== \ No newline at end of file +==== diff --git a/modules/cnv-deleting-template-web.adoc b/modules/virt-deleting-template-web.adoc similarity index 79% rename from modules/cnv-deleting-template-web.adoc rename to modules/virt-deleting-template-web.adoc index 88b37b29ba..7f8e3468c9 100644 --- a/modules/cnv-deleting-template-web.adoc +++ b/modules/virt-deleting-template-web.adoc @@ -1,15 +1,15 @@ // Module included in the following assemblies: // -// * cnv/cnv_vm_templates/cnv-deleting-vm-template.adoc +// * virt/vm_templates/virt-deleting-vm-template.adoc -[id="cnv-deleting-template-wizard-web_{context}"] +[id="virt-deleting-template-wizard-web_{context}"] = Deleting a virtual machine template in the web console Deleting a virtual machine template permanently removes it from the cluster. .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machine Templates*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machine Templates*. . You can delete the virtual machine template from this pane, which makes it easier to perform actions on multiple templates in the one pane, or from the *Virtual Machine Template Details* pane where you can view comprehensive diff --git a/modules/cnv-deleting-vmi.adoc b/modules/virt-deleting-vmi.adoc similarity index 86% rename from modules/cnv-deleting-vmi.adoc rename to modules/virt-deleting-vmi.adoc index 482895b6aa..6be05dafa6 100644 --- a/modules/cnv-deleting-vmi.adoc +++ b/modules/virt-deleting-vmi.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-deleting-vmis.adoc +// * virt/virtual_machines/virt-deleting-vmis .adoc -[id="cnv-deleting-vmi_{context}"] +[id="virt-deleting-vmi_{context}"] = Deleting a virtual machine instance @@ -25,4 +25,4 @@ $ oc delete vmi This command only deletes objects that exist in the current project. Specify the `-n ` option if the object you want to delete is in a different project or namespace. -==== \ No newline at end of file +==== diff --git a/modules/cnv-deleting-vms.adoc b/modules/virt-deleting-vms.adoc similarity index 90% rename from modules/cnv-deleting-vms.adoc rename to modules/virt-deleting-vms.adoc index f4793f2037..a271327ad6 100644 --- a/modules/cnv-deleting-vms.adoc +++ b/modules/virt-deleting-vms.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-delete-vms.adoc +// * virt/virtual_machines/virt-delete-vms.adoc -[id="cnv-deleting-vms_{context}"] +[id="virt-deleting-vms_{context}"] = Deleting a virtual machine by using the CLI diff --git a/modules/cnv-deploying-cnv.adoc b/modules/virt-deploying-virt.adoc similarity index 50% rename from modules/cnv-deploying-cnv.adoc rename to modules/virt-deploying-virt.adoc index 370b873b47..687feede6b 100644 --- a/modules/cnv-deploying-cnv.adoc +++ b/modules/virt-deploying-virt.adoc @@ -1,23 +1,25 @@ // Module included in the following assemblies: // -// * cnv/cnv_install/installing-container-native-virtualization.adoc +// * virt/install/installing-virt.adoc -[id="cnv-deploying-cnv_{context}"] -= Deploying {CNVProductName} +//This file contains UI elements and/or package names that need to be updated. -After subscribing to the *{CNVProductNameStart}* catalog, +[id="virt-deploying-virt_{context}"] += Deploying {VirtProductName} + +After subscribing to the *{VirtProductName}* catalog, create the *CNV Operator Deployment* custom resource -to deploy {CNVProductName}. +to deploy {VirtProductName}. .Prerequisites -* An active subscription to the *{CNVProductNameStart}* catalog in the `openshift-cnv` namespace +* An active subscription to the *{VirtProductName}* catalog in the `openshift-cnv` namespace .Procedure . Navigate to the *Operators* -> *Installed Operators* page. -. Click *{CNVProductNameStart}*. +. Click *{VirtProductName}*. . Click the *CNV Operator Deployment* tab and click *Create HyperConverged Cluster*. @@ -29,8 +31,8 @@ to the next step, ensure that the custom resource is named the default `kubevirt-hyperconverged`. ==== -. Click *Create* to launch {CNVProductName}. +. Click *Create* to launch {VirtProductName}. -. Navigate to the *Workloads* -> *Pods* page and monitor the {CNVProductName} Pods +. Navigate to the *Workloads* -> *Pods* page and monitor the {VirtProductName} Pods until they are all *Running*. After all the Pods display the *Running* state, -you can access {CNVProductName}. +you can access {VirtProductName}. diff --git a/modules/cnv-disabling-guest-memory-overhead-accounting.adoc b/modules/virt-disabling-guest-memory-overhead-accounting.adoc similarity index 88% rename from modules/cnv-disabling-guest-memory-overhead-accounting.adoc rename to modules/virt-disabling-guest-memory-overhead-accounting.adoc index 420077fab1..8753a1d5e8 100644 --- a/modules/cnv-disabling-guest-memory-overhead-accounting.adoc +++ b/modules/virt-disabling-guest-memory-overhead-accounting.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-managing-guest-memory.adoc +// * virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc -[id="cnv-disabling-guest-memory-overhead-accounting_{context}"] +[id="virt-disabling-guest-memory-overhead-accounting_{context}"] = Disabling guest memory overhead accounting [WARNING] diff --git a/modules/cnv-document-attributes.adoc b/modules/virt-document-attributes.adoc similarity index 70% rename from modules/cnv-document-attributes.adoc rename to modules/virt-document-attributes.adoc index 5c039ca856..03c5ab8708 100644 --- a/modules/cnv-document-attributes.adoc +++ b/modules/virt-document-attributes.adoc @@ -9,12 +9,10 @@ // Product content attributes, that is, substitution variables in the files. // :product-title: OpenShift Container Platform -:CNVProductName: container-native virtualization -:CNVProductNameStart: Container-native virtualization -:ProductShortName: CNV +:VirtProductName: OpenShift virtualization :ProductRelease: :ProductVersion: -:CNVVersion: 2.3 +:VirtVersion: 2.4 :product-build: :DownloadURL: registry.access.redhat.com :kebab: image:kebab.png[title="Options menu"] @@ -26,6 +24,6 @@ // Using the pattern ending in 'BookName' makes it easy to grep for occurrences // throughout the topics // -:Install_BookName: Installing container-native virtualization -:Using_BookName: Using container-native virtualization -:RN_BookName: Container-native virtualization release notes +:Install_BookName: Installing OpenShift virtualization +:Using_BookName: Using OpenShift virtualization +:RN_BookName: OpenShift virtualization release notes diff --git a/modules/cnv-edit-boot-order-web.adoc b/modules/virt-edit-boot-order-web.adoc similarity index 89% rename from modules/cnv-edit-boot-order-web.adoc rename to modules/virt-edit-boot-order-web.adoc index d8fcc5670a..9439cf01d4 100644 --- a/modules/cnv-edit-boot-order-web.adoc +++ b/modules/virt-edit-boot-order-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_users_guide/cnv-edit-boot-order.adoc +// * virt/virt_users_guide/virt-edit-boot-order.adoc -[id="cnv-edit-boot-order-web_{context}"] +[id="virt-edit-boot-order-web_{context}"] = Editing a boot order list in the web console Edit the boot order list in the web console. diff --git a/modules/cnv-edit-boot-order-yaml-web.adoc b/modules/virt-edit-boot-order-yaml-web.adoc similarity index 91% rename from modules/cnv-edit-boot-order-yaml-web.adoc rename to modules/virt-edit-boot-order-yaml-web.adoc index 5a7b0dcf6b..33aa90acbe 100644 --- a/modules/cnv-edit-boot-order-yaml-web.adoc +++ b/modules/virt-edit-boot-order-yaml-web.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_users_guide/cnv-edit-boot-order.adoc +// * virt/virt_users_guide/virt-edit-boot-order.adoc // -[id="cnv-edit-boot-order-yaml-web_{context}"] +[id="virt-edit-boot-order-yaml-web_{context}"] = Editing a boot order list in the YAML configuration file Edit the boot order list in a YAML configuration file by using the CLI. diff --git a/modules/cnv-edit-cdrom-vm.adoc b/modules/virt-edit-cdrom-vm.adoc similarity index 79% rename from modules/cnv-edit-cdrom-vm.adoc rename to modules/virt-edit-cdrom-vm.adoc index 612d9d98b7..63aff33da6 100644 --- a/modules/cnv-edit-cdrom-vm.adoc +++ b/modules/virt-edit-cdrom-vm.adoc @@ -1,22 +1,22 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-edit-vms.adoc -// * cnv/cnv_vm_templates/cnv-editing-vm-template.adoc +// * virt/virtual_machines/virt-edit-vms.adoc +// * virt/vm_templates/virt-editing-vm-template.adoc // Establishing conditionals so content can be re-used for editing VMs // and VM templates. -ifeval::["{context}" == "cnv-edit-vms"] +ifeval::["{context}" == "virt-edit-vms"] :object: virtual machine :object-gui: Virtual Machines endif::[] -ifeval::["{context}" == "cnv-editing-vm-template"] +ifeval::["{context}" == "virt-editing-vm-template"] :object: virtual machine template :object-gui: Virtual Machine Templates endif::[] -[id="cnv-vm-edit-cdrom_{context}"] +[id="virt-vm-edit-cdrom_{context}"] = Editing CD-ROMs for {object-gui} Use the following procedure to configure CD-ROMs for virtual machines. @@ -43,12 +43,12 @@ Use the following procedure to configure CD-ROMs for virtual machines. // Scrubbing all conditionals used in module -ifeval::["{context}" == "cnv-edit-vms"] +ifeval::["{context}" == "virt-edit-vms"] :object!: :object-gui!: endif::[] -ifeval::["{context}" == "cnv-editing-vm-template"] +ifeval::["{context}" == "virt-editing-vm-template"] :object!: :object-gui!: endif::[] diff --git a/modules/cnv-editing-kubevirtstorageclassdefaults-cli.adoc b/modules/virt-editing-kubevirtstorageclassdefaults-cli.adoc similarity index 88% rename from modules/cnv-editing-kubevirtstorageclassdefaults-cli.adoc rename to modules/virt-editing-kubevirtstorageclassdefaults-cli.adoc index e877ceec4a..d332e4df78 100644 --- a/modules/cnv-editing-kubevirtstorageclassdefaults-cli.adoc +++ b/modules/virt-editing-kubevirtstorageclassdefaults-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-storage-defaults-for-datavolumes.adoc +// * virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc -[id="cnv-editing-kubevirtstorageclassdefaults-cli_{context}"] +[id="virt-editing-kubevirtstorageclassdefaults-cli_{context}"] = Editing the `kubevirt-storage-class-defaults` ConfigMap in the CLI Modify the storage settings for DataVolumes by editing the `kubevirt-storage-class-defaults` ConfigMap in the `openshift-cnv` namespace. diff --git a/modules/cnv-editing-kubevirtstorageclassdefaults-web.adoc b/modules/virt-editing-kubevirtstorageclassdefaults-web.adoc similarity index 90% rename from modules/cnv-editing-kubevirtstorageclassdefaults-web.adoc rename to modules/virt-editing-kubevirtstorageclassdefaults-web.adoc index e13d173d3b..ef314a9cff 100644 --- a/modules/cnv-editing-kubevirtstorageclassdefaults-web.adoc +++ b/modules/virt-editing-kubevirtstorageclassdefaults-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-storage-defaults-for-datavolumes.adoc +// * virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc -[id="cnv-editing-kubevirtstorageclassdefaults-web_{context}"] +[id="virt-editing-kubevirtstorageclassdefaults-web_{context}"] = Editing the `kubevirt-storage-class-defaults` ConfigMap in the web console Modify the storage settings for DataVolumes by editing the `kubevirt-storage-class-defaults` ConfigMap in the `openshift-cnv` namespace. diff --git a/modules/cnv-editing-template-yaml-web.adoc b/modules/virt-editing-template-yaml-web.adoc similarity index 80% rename from modules/cnv-editing-template-yaml-web.adoc rename to modules/virt-editing-template-yaml-web.adoc index 4fbcaa0943..e67ad8418b 100644 --- a/modules/cnv-editing-template-yaml-web.adoc +++ b/modules/virt-editing-template-yaml-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_vm_templates/cnv-editing-vm-template.adoc +// * virt/vm_templates/virt-editing-vm-template.adoc -[id="cnv-editing-template-yaml-web_{context}"] +[id="virt-editing-template-yaml-web_{context}"] = Editing virtual machine template YAML configuration in the web console You can edit the YAML configuration of a virtual machine template from the @@ -19,7 +19,7 @@ Navigating away from the YAML screen while editing cancels any changes to the .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machine Templates*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machine Templates*. . Select a template. . Click the *YAML* tab to display the editable configuration. . Edit the file and click *Save*. diff --git a/modules/cnv-editing-vm-cli.adoc b/modules/virt-editing-vm-cli.adoc similarity index 89% rename from modules/cnv-editing-vm-cli.adoc rename to modules/virt-editing-vm-cli.adoc index 660a4d9fe1..15885aa988 100644 --- a/modules/cnv-editing-vm-cli.adoc +++ b/modules/virt-editing-vm-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-edit-vms.adoc +// * virt/virtual_machines/virt-edit-vms.adoc -[id="cnv-editing-vm-cli_{context}"] +[id="virt-editing-vm-cli_{context}"] = Editing a virtual machine YAML configuration using the CLI Use this procedure to edit a virtual machine YAML configuration using the CLI. diff --git a/modules/cnv-editing-vm-web.adoc b/modules/virt-editing-vm-web.adoc similarity index 78% rename from modules/cnv-editing-vm-web.adoc rename to modules/virt-editing-vm-web.adoc index ddb145df36..ec16d7ba49 100644 --- a/modules/cnv-editing-vm-web.adoc +++ b/modules/virt-editing-vm-web.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-edit-vms.adoc -// * cnv/cnv_vm_templates/cnv-editing-vm-template.adoc +// * virt/virtual_machines/virt-edit-vms.adoc +// * virt/vm_templates/virt-editing-vm-template.adoc // Establishing conditionals so content can be re-used for editing VMs // and VM templates. @@ -11,19 +11,19 @@ // and {object-gui} variables used throughout. We need two variables because // the object is lower case, but the gui elements are capitalized. -ifeval::["{context}" == "cnv-editing-vm-template"] -:cnv-vm-template: +ifeval::["{context}" == "virt-editing-vm-template"] +:virt-vm-template: :object: virtual machine template :object-gui: Virtual Machine Template endif::[] -ifeval::["{context}" == "cnv-edit-vms"] -:cnv-vm: +ifeval::["{context}" == "virt-edit-vms"] +:virt-vm: :object: virtual machine :object-gui: Virtual Machine endif::[] -[id="cnv-editing-vm-web_{context}"] +[id="virt-editing-vm-web_{context}"] = Editing a {object} in the web console @@ -41,25 +41,25 @@ Other values can be edited using the CLI. // Using the attributes we declared earlier, we can have different lines after // the procedure that will be included in the different assemblies. -ifdef::cnv-vm-template[] +ifdef::virt-vm-template[] Editing a virtual machine template will not affect virtual machines already created from that template. -endif::cnv-vm-template[] -ifdef::cnv-vm[] +endif::virt-vm-template[] +ifdef::virt-vm[] If the {object} is running, changes will not take effect until you reboot the {object}. -endif::cnv-vm[] +endif::virt-vm[] // Unsetting the attributes/variables used in the module or else they will stay active // subsequent modules in the assembly and topic_map. // Attributes set with an ifeval statement need to be unset with an ifeval statement. -ifeval::["{context}" == "cnv-edit-vms"] -:cnv-vm!: +ifeval::["{context}" == "virt-edit-vms"] +:virt-vm!: :object!: :object-gui!: endif::[] -ifeval::["{context}" == "cnv-editing-vm-template"] -:cnv-vm-template!: +ifeval::["{context}" == "virt-editing-vm-template"] +:virt-vm-template!: :object!: :object-gui!: endif::[] diff --git a/modules/cnv-editing-vm-yaml-web.adoc b/modules/virt-editing-vm-yaml-web.adoc similarity index 92% rename from modules/cnv-editing-vm-yaml-web.adoc rename to modules/virt-editing-vm-yaml-web.adoc index e2ff9e2aa1..997116bf8e 100644 --- a/modules/cnv-editing-vm-yaml-web.adoc +++ b/modules/virt-editing-vm-yaml-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-edit-vms.adoc +// * virt/virtual_machines/virt-edit-vms.adoc -[id="cnv-editing-vm-yaml-web_{context}"] +[id="virt-editing-vm-yaml-web_{context}"] = Editing a virtual machine YAML configuration using the web console diff --git a/modules/cnv-enabling-dedicated-resources.adoc b/modules/virt-enabling-dedicated-resources.adoc similarity index 65% rename from modules/cnv-enabling-dedicated-resources.adoc rename to modules/virt-enabling-dedicated-resources.adoc index 08248c65dd..6fc5be6937 100644 --- a/modules/cnv-enabling-dedicated-resources.adoc +++ b/modules/virt-enabling-dedicated-resources.adoc @@ -1,24 +1,24 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-dedicated-resources-vm.adoc -// * cnv/cnv_vm_templates/cnv-dedicated-resources-vm-template.adoc +// * virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc +// * virt/vm_templates/virt-dedicated-resources-vm-template.adoc // Establishing conditionals so content can be re-used for editing VMs // and VM templates. -ifeval::["{context}" == "cnv-dedicated-resources-vm-template"] -:cnv-vm-template: +ifeval::["{context}" == "virt-dedicated-resources-vm-template"] +:virt-vm-template: :object: virtual machine template :object-gui: Virtual Machine Template endif::[] -ifeval::["{context}" == "cnv-dedicated-resources-vm"] -:cnv-vm: +ifeval::["{context}" == "virt-dedicated-resources-vm"] +:virt-vm: :object: virtual machine :object-gui: Virtual Machine endif::[] -[id="cnv-enabling-dedicated-resources_{context}"] +[id="virt-enabling-dedicated-resources_{context}"] = Enabling dedicated resources for a {object} You can enable dedicated resources for a {object} in the @@ -36,14 +36,14 @@ the *Dedicated Resources* window. // Unsetting all conditionals used in module -ifeval::["{context}" == "cnv-dedicated-resources-vm"] -:cnv-vm!: +ifeval::["{context}" == "virt-dedicated-resources-vm"] +:virt-vm!: :object!: :object-gui!: endif::[] -ifeval::["{context}" == "cnv-dedicated-resources-vm-template"] -:cnv-vm-template!: +ifeval::["{context}" == "virt-dedicated-resources-vm-template"] +:virt-vm-template!: :object!: :object-gui!: endif::[] diff --git a/modules/virt-enabling-virt-repos.adoc b/modules/virt-enabling-virt-repos.adoc new file mode 100644 index 0000000000..597f0985cf --- /dev/null +++ b/modules/virt-enabling-virt-repos.adoc @@ -0,0 +1,25 @@ +// Module included in the following assemblies: +// +// install/virt-installing-virtctl.adoc + +[id="virt-enabling-virt-repos_{context}"] += Enabling {VirtProductName} repositories + +Red Hat offers {VirtProductName} repositories for both Red Hat Enterprise Linux 8 +and Red Hat Enterprise Linux 7: + +* Red Hat Enterprise Linux 8 repository: `cnv-2.3-for-rhel-8-x86_64-rpms` + +* Red Hat Enterprise Linux 7 repository: `rhel-7-server-virt-2.3-rpms` + +The process for enabling the repository in `subscription-manager` is the same +in both platforms. + +.Procedure + +* Use `subscription manager` to enable the appropriate {VirtProductName} repository for + your system: ++ +---- +# subscription-manager repos --enable +---- diff --git a/modules/cnv-example-ansible-playbook-creating-vms.adoc b/modules/virt-example-ansible-playbook-creating-vms.adoc similarity index 87% rename from modules/cnv-example-ansible-playbook-creating-vms.adoc rename to modules/virt-example-ansible-playbook-creating-vms.adoc index 2dcc1aa851..83f1b53c67 100644 --- a/modules/cnv-example-ansible-playbook-creating-vms.adoc +++ b/modules/virt-example-ansible-playbook-creating-vms.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-automating-management-tasks.adoc +// * virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc -[id="cnv-example-ansible-playbook-creating-vms_{context}"] +[id="virt-example-ansible-playbook-creating-vms_{context}"] = Example: Ansible Playbook for creating virtual machines You can use the `kubevirt_vm` Ansible Playbook to automate virtual machine diff --git a/modules/cnv-example-bond-nncp.adoc b/modules/virt-example-bond-nncp.adoc similarity index 81% rename from modules/cnv-example-bond-nncp.adoc rename to modules/virt-example-bond-nncp.adoc index dfe100c73c..428a6ca95d 100644 --- a/modules/cnv-example-bond-nncp.adoc +++ b/modules/virt-example-bond-nncp.adoc @@ -1,16 +1,16 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-updating-node-network-config.adoc +// * virt/node_network/virt-updating-node-network-config.adoc -[id="cnv-example-bond-nncp_{context}"] +[id="virt-example-bond-nncp_{context}"] = Example: Bond interface NodeNetworkConfigurationPolicy Create a bond interface on nodes in the cluster by applying a `NodeNetworkConfigurationPolicy` manifest -to the cluster. +to the cluster. [NOTE] ==== -{CNVProductNameStart} only supports the following bond modes: +{VirtProductName} only supports the following bond modes: * mode=1 active-backup + * mode=5 balance-tlb + @@ -43,20 +43,20 @@ spec: options: miimon: '140' <11> slaves: <12> - - eth1 + - eth1 - eth2 mtu: 1450 <13> ---- -<1> Name of the Policy. +<1> Name of the Policy. <2> Optional. If you do not include the `nodeSelector`, the Policy applies to all nodes in the cluster. <3> This example uses a `hostname` node selector. <4> Name of the interface. <5> Optional. Human-readable description of the interface. -<6> The type of interface. This example creates a bond. +<6> The type of interface. This example creates a bond. <7> The requested state for the interface after creation. <8> Optional. If you do not use `dhcp` you must specify static IP address for the interface. <9> Enables `ipv4` in this example. <10> The driver mode for the bond. This example uses an active backup mode. <11> Optional. This example uses miimon to inspect the bond link every 140ms. -<12> The subordinate node NICs in the bond. -<13> Optional. The maximum transmission unit (MTU) for the bond. If not specified, this value is set to `1500` by default. +<12> The subordinate node NICs in the bond. +<13> Optional. The maximum transmission unit (MTU) for the bond. If not specified, this value is set to `1500` by default. diff --git a/modules/cnv-example-bridge-nncp.adoc b/modules/virt-example-bridge-nncp.adoc similarity index 93% rename from modules/cnv-example-bridge-nncp.adoc rename to modules/virt-example-bridge-nncp.adoc index 0fe6ed29ca..48236d50f5 100644 --- a/modules/cnv-example-bridge-nncp.adoc +++ b/modules/virt-example-bridge-nncp.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-updating-node-network-config.adoc +// * virt/node_network/virt-updating-node-network-config.adoc -[id="cnv-example-bridge-nncp_{context}"] +[id="virt-example-bridge-nncp_{context}"] = Example: Linux bridge interface NodeNetworkConfigurationPolicy Create a Linux bridge interface on nodes in the cluster by applying a `NodeNetworkConfigurationPolicy` manifest diff --git a/modules/cnv-example-configmap-tls-certificate.adoc b/modules/virt-example-configmap-tls-certificate.adoc similarity index 72% rename from modules/cnv-example-configmap-tls-certificate.adoc rename to modules/virt-example-configmap-tls-certificate.adoc index 5928b491d5..c6434a6c12 100644 --- a/modules/cnv-example-configmap-tls-certificate.adoc +++ b/modules/virt-example-configmap-tls-certificate.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-tls-certificates-for-dv-imports.adoc +// * virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc -[id="cnv-example-configmap-tls-certificate_{context}"] +[id="virt-example-configmap-tls-certificate_{context}"] = Example: ConfigMap created from a TLS certificate The following example is of a ConfigMap created from `ca.pem` TLS certificate. diff --git a/modules/cnv-example-kubevirtstorageclassdefaults.adoc b/modules/virt-example-kubevirtstorageclassdefaults.adoc similarity index 78% rename from modules/cnv-example-kubevirtstorageclassdefaults.adoc rename to modules/virt-example-kubevirtstorageclassdefaults.adoc index 0dcf3f18aa..167f82ff6d 100644 --- a/modules/cnv-example-kubevirtstorageclassdefaults.adoc +++ b/modules/virt-example-kubevirtstorageclassdefaults.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-storage-defaults-for-datavolumes.adoc +// * virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc -[id="cnv-example-kubevirtstorageclassdefaults_{context}"] +[id="virt-example-kubevirtstorageclassdefaults_{context}"] = Example of multiple storage class defaults The following YAML file is an example of a `kubevirt-storage-class-defaults` ConfigMap that has storage settings configured for two storage classes, `migration` and `block`. - + Ensure that all settings are supported by your underlying storage before you update the ConfigMap. [source,yaml] @@ -20,9 +20,8 @@ metadata: data: accessMode: ReadWriteOnce volumeMode: Filesystem - nfs-sc.accessMode: ReadWriteMany + nfs-sc.accessMode: ReadWriteMany nfs-sc.volumeMode: Filesystem block-sc.accessMode: ReadWriteMany block-sc.volumeMode: Block ---- - diff --git a/modules/cnv-example-vlan-nncp.adoc b/modules/virt-example-vlan-nncp.adoc similarity index 92% rename from modules/cnv-example-vlan-nncp.adoc rename to modules/virt-example-vlan-nncp.adoc index 32b1c41d77..7e5f4232d6 100644 --- a/modules/cnv-example-vlan-nncp.adoc +++ b/modules/virt-example-vlan-nncp.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-updating-node-network-config.adoc +// * virt/node_network/virt-updating-node-network-config.adoc -[id="cnv-example-vlan-nncp_{context}"] +[id="virt-example-vlan-nncp_{context}"] = Example: VLAN interface NodeNetworkConfigurationPolicy Create a VLAN interface on nodes in the cluster by applying a `NodeNetworkConfigurationPolicy` manifest diff --git a/modules/cnv-importing-vm-datavolume.adoc b/modules/virt-importing-vm-datavolume.adoc similarity index 96% rename from modules/cnv-importing-vm-datavolume.adoc rename to modules/virt-importing-vm-datavolume.adoc index e5d9be773a..ce97db8674 100644 --- a/modules/cnv-importing-vm-datavolume.adoc +++ b/modules/virt-importing-vm-datavolume.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc -[id="cnv-importing-vm-datavolume_{context}"] +[id="virt-importing-vm-datavolume_{context}"] = Importing a virtual machine image into an object with DataVolumes To create a virtual machine from an imported image, specify the image location diff --git a/modules/cnv-importing-vm-to-block-pv.adoc b/modules/virt-importing-vm-to-block-pv.adoc similarity index 90% rename from modules/cnv-importing-vm-to-block-pv.adoc rename to modules/virt-importing-vm-to-block-pv.adoc index 1da6bb88bd..be32c54954 100644 --- a/modules/cnv-importing-vm-to-block-pv.adoc +++ b/modules/virt-importing-vm-to-block-pv.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes-block.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc -[id="cnv-importing-vm-to-block-pv_{context}"] +[id="virt-importing-vm-to-block-pv_{context}"] = Importing a virtual machine image to a block PersistentVolume using DataVolumes You can import an existing virtual machine image into your {product-title} -cluster. {CNVProductNameStart} uses DataVolumes to automate the importing data and the +cluster. {VirtProductName} uses DataVolumes to automate the importing data and the creation of an underlying PersistentVolumeClaim (PVC). You can then reference the DataVolume in a virtual machine configuration. diff --git a/modules/cnv-importing-vmware-vm.adoc b/modules/virt-importing-vmware-vm.adoc similarity index 92% rename from modules/cnv-importing-vmware-vm.adoc rename to modules/virt-importing-vmware-vm.adoc index 4193e2f848..df44f699eb 100644 --- a/modules/cnv-importing-vmware-vm.adoc +++ b/modules/virt-importing-vmware-vm.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc +// * virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc [id='Importing_vmware_vm_or_template_{context}'] = Importing a VMware virtual machine or template @@ -22,7 +22,7 @@ If you try to import a virtual machine whose disk size is larger than the availa .Procedure -. In the {CNVProductName} web console, click *Workloads* -> *Virtual Machines*. +. In the {VirtProductName} web console, click *Workloads* -> *Virtual Machines*. . Click *Create Virtual Machine* and select *Import with Wizard*. . In the *General* screen, perform the following steps: @@ -65,7 +65,7 @@ The name can contain lowercase letters (`a-z`), numbers (`0-9`), and hyphens (`- .. Select the interface type. .. Select the storage class. + -If you do not select a storage class, {CNVProductName} uses the default storage class to create the virtual machine. +If you do not select a storage class, {VirtProductName} uses the default storage class to create the virtual machine. .. Click *Save* and then click *Next*. diff --git a/modules/cnv-initiating-vm-migration-cli.adoc b/modules/virt-initiating-vm-migration-cli.adoc similarity index 90% rename from modules/cnv-initiating-vm-migration-cli.adoc rename to modules/virt-initiating-vm-migration-cli.adoc index f909fb4458..85b9ff0cb2 100644 --- a/modules/cnv-initiating-vm-migration-cli.adoc +++ b/modules/virt-initiating-vm-migration-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-migrate-vmi.adoc +// * virt/live_migration/virt-migrate-vmi.adoc -[id="cnv-initiating-vm-migration-cli_{context}"] +[id="virt-initiating-vm-migration-cli_{context}"] = Initiating live migration of a virtual machine instance in the CLI Initiate a live migration of a running virtual machine instance by creating a diff --git a/modules/cnv-initiating-vm-migration-web.adoc b/modules/virt-initiating-vm-migration-web.adoc similarity index 84% rename from modules/cnv-initiating-vm-migration-web.adoc rename to modules/virt-initiating-vm-migration-web.adoc index 02ef002ef5..2121c6589b 100644 --- a/modules/cnv-initiating-vm-migration-web.adoc +++ b/modules/virt-initiating-vm-migration-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-migrate-vmi.adoc +// * virt/live_migration/virt-migrate-vmi.adoc -[id="cnv-initiating-vm-migration-web_{context}"] +[id="virt-initiating-vm-migration-web_{context}"] = Initiating live migration of a virtual machine instance in the web console Migrate a running virtual machine instance to a different node in the cluster. @@ -15,7 +15,7 @@ can initiate a virtual machine migration. .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machines*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machines*. . You can initiate the migration from this screen, which makes it easier to perform actions on multiple virtual machines in the one screen, or from the *Virtual Machine Details* screen where you can view comprehensive details of the diff --git a/modules/cnv-installing-qemu-guest-agent-on-linux-vm.adoc b/modules/virt-installing-qemu-guest-agent-on-linux-vm.adoc similarity index 80% rename from modules/cnv-installing-qemu-guest-agent-on-linux-vm.adoc rename to modules/virt-installing-qemu-guest-agent-on-linux-vm.adoc index ccc1217946..aa2e59085e 100644 --- a/modules/cnv-installing-qemu-guest-agent-on-linux-vm.adoc +++ b/modules/virt-installing-qemu-guest-agent-on-linux-vm.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-installing-qemu-guest-agent.adoc +// * virt/virtual_machines/vm_networking/virt-installing-qemu-guest-agent.adoc -[id="cnv-installing-qemu-guest-agent-on-linux-vm_{context}"] +[id="virt-installing-qemu-guest-agent-on-linux-vm_{context}"] = Installing QEMU guest agent on a Linux virtual machine The `qemu-guest-agent` is widely available and available by default in Red Hat diff --git a/modules/cnv-installing-qemu-guest-agent-on-windows-vm.adoc b/modules/virt-installing-qemu-guest-agent-on-windows-vm.adoc similarity index 79% rename from modules/cnv-installing-qemu-guest-agent-on-windows-vm.adoc rename to modules/virt-installing-qemu-guest-agent-on-windows-vm.adoc index 6d87f1d656..b74234457a 100644 --- a/modules/cnv-installing-qemu-guest-agent-on-windows-vm.adoc +++ b/modules/virt-installing-qemu-guest-agent-on-windows-vm.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-installing-qemu-guest-agent.adoc +// * virt/virtual_machines/vm_networking/virt-installing-qemu-guest-agent.adoc [id="installing-qemu-guest-agent-on-a-windows-virtual-machine"] = Installing QEMU guest agent on a Windows virtual machine diff --git a/modules/cnv-installing-virtctl-client.adoc b/modules/virt-installing-virtctl-client.adoc similarity index 73% rename from modules/cnv-installing-virtctl-client.adoc rename to modules/virt-installing-virtctl-client.adoc index bdd3682586..4ae32e61f8 100644 --- a/modules/cnv-installing-virtctl-client.adoc +++ b/modules/virt-installing-virtctl-client.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// cnv_install/cnv-installing-virtctl.adoc +// install/virt-installing-virtctl.adoc -[id="cnv-installing-virtctl-client_{context}"] +[id="virt-installing-virtctl-client_{context}"] = Installing the `virtctl` client Install the `virtctl` client from the `kubevirt-virtctl` package. diff --git a/modules/cnv-installing-virtio-drivers-existing-windows.adoc b/modules/virt-installing-virtio-drivers-existing-windows.adoc similarity index 86% rename from modules/cnv-installing-virtio-drivers-existing-windows.adoc rename to modules/virt-installing-virtio-drivers-existing-windows.adoc index ade9b90077..25376032d2 100644 --- a/modules/cnv-installing-virtio-drivers-existing-windows.adoc +++ b/modules/virt-installing-virtio-drivers-existing-windows.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-installing-qemu-guest-agent.adoc -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-existing-windows-vm.adoc +// * virt/virtual_machines/vm_networking/virt-installing-qemu-guest-agent.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc -[id="cnv-installing-virtio-drivers-existing-windows_{context}"] +[id="virt-installing-virtio-drivers-existing-windows_{context}"] = Installing VirtIO drivers on an existing Windows virtual machine Install the VirtIO drivers from the attached SATA CD drive to an diff --git a/modules/cnv-installing-virtio-drivers-installing-windows.adoc b/modules/virt-installing-virtio-drivers-installing-windows.adoc similarity index 81% rename from modules/cnv-installing-virtio-drivers-installing-windows.adoc rename to modules/virt-installing-virtio-drivers-installing-windows.adoc index bb497e3de0..2e906cb16c 100644 --- a/modules/cnv-installing-virtio-drivers-installing-windows.adoc +++ b/modules/virt-installing-virtio-drivers-installing-windows.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-installing-qemu-guest-agent.adoc -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-new-windows-vm.adoc +// * virt/virtual_machines/vm_networking/virt-installing-qemu-guest-agent.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc -[id="cnv-installing-virtio-drivers-installing-windows_{context}"] +[id="virt-installing-virtio-drivers-installing-windows_{context}"] = Installing VirtIO drivers during Windows installation Install the VirtIO drivers from the attached SATA CD driver during Windows installation. diff --git a/modules/cnv-listing-dvs.adoc b/modules/virt-listing-dvs.adoc similarity index 73% rename from modules/cnv-listing-dvs.adoc rename to modules/virt-listing-dvs.adoc index d648e0712a..379b7dbb6c 100644 --- a/modules/cnv-listing-dvs.adoc +++ b/modules/virt-listing-dvs.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-deleting-datavolumes.adoc +// * virt/virtual_machines/virt-deleting-datavolumes.adoc -[id="cnv-listing-dvs_{context}"] +[id="virt-listing-dvs_{context}"] = Listing all DataVolumes diff --git a/modules/cnv-listing-vmis.adoc b/modules/virt-listing-vmis.adoc similarity index 78% rename from modules/cnv-listing-vmis.adoc rename to modules/virt-listing-vmis.adoc index f8f66857a6..c293fae1a9 100644 --- a/modules/cnv-listing-vmis.adoc +++ b/modules/virt-listing-vmis.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-deleting-vmis.adoc +// * virt/virtual_machines/virt-deleting-vmis .adoc -[id="cnv-listing-vmis_{context}"] +[id="virt-listing-vmis_{context}"] = Listing all virtual machine instances diff --git a/modules/cnv-live-migration-limits-reftable.adoc b/modules/virt-live-migration-limits-reftable.adoc similarity index 89% rename from modules/cnv-live-migration-limits-reftable.adoc rename to modules/virt-live-migration-limits-reftable.adoc index 3f42c20805..7980e091c0 100644 --- a/modules/cnv-live-migration-limits-reftable.adoc +++ b/modules/virt-live-migration-limits-reftable.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-live-migration-limits.adoc +// * virt/live_migration/virt-live-migration-limits.adoc -[id="cnv-live-migration-limits-ref_{context}"] +[id="virt-live-migration-limits-ref_{context}"] = Cluster-wide live migration limits and timeouts .Migration parameters diff --git a/modules/cnv-monitoring-upgrade-status.adoc b/modules/virt-monitoring-upgrade-status.adoc similarity index 84% rename from modules/cnv-monitoring-upgrade-status.adoc rename to modules/virt-monitoring-upgrade-status.adoc index b4d25a7ce7..2e137d358c 100644 --- a/modules/cnv-monitoring-upgrade-status.adoc +++ b/modules/virt-monitoring-upgrade-status.adoc @@ -1,11 +1,11 @@ // Module included in the following assemblies: // -// * cnv/upgrading-container-native-virtualization.adoc +// * virt/upgrading-virt.adoc -[id="cnv-monitoring-upgrade-status_{context}"] +[id="virt-monitoring-upgrade-status_{context}"] = Monitoring upgrade status -The best way to monitor {CNVProductName} upgrade status is to watch the +The best way to monitor {VirtProductName} upgrade status is to watch the ClusterServiceVersion (CSV) `PHASE`. You can also monitor the CSV conditions in the web console or by running the command provided here. @@ -36,7 +36,7 @@ VERSION REPLACES PHASE 2.2.0 Replacing ---- -. Optional: Monitor the aggregated status of all {CNVProductName} component +. Optional: Monitor the aggregated status of all {VirtProductName} component conditions by running the following command: + ---- diff --git a/modules/cnv-monitoring-vm-migration-cli.adoc b/modules/virt-monitoring-vm-migration-cli.adoc similarity index 90% rename from modules/cnv-monitoring-vm-migration-cli.adoc rename to modules/virt-monitoring-vm-migration-cli.adoc index 357c9a617d..30bb1959b8 100644 --- a/modules/cnv-monitoring-vm-migration-cli.adoc +++ b/modules/virt-monitoring-vm-migration-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-monitor-vmi-migration.adoc +// * virt/live_migration/virt-monitor-vmi-migration.adoc -[id="cnv-monitoring-vm-migration-cli_{context}"] +[id="virt-monitoring-vm-migration-cli_{context}"] = Monitoring live migration of a virtual machine instance in the CLI The status of the virtual machine migration is stored in the `Status` component diff --git a/modules/cnv-monitoring-vm-migration-web.adoc b/modules/virt-monitoring-vm-migration-web.adoc similarity index 66% rename from modules/cnv-monitoring-vm-migration-web.adoc rename to modules/virt-monitoring-vm-migration-web.adoc index 37942c26fa..134d791cbd 100644 --- a/modules/cnv-monitoring-vm-migration-web.adoc +++ b/modules/virt-monitoring-vm-migration-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-monitor-vmi-migration.adoc +// * virt/live_migration/virt-monitor-vmi-migration.adoc -[id="cnv-monitoring-vm-migration-web_{context}"] +[id="virt-monitoring-vm-migration-web_{context}"] = Monitoring live migration of a virtual machine instance in the web console For the duration of the migration, the virtual machine has a status of @@ -11,5 +11,5 @@ For the duration of the migration, the virtual machine has a status of .Procedure -* In the {CNVProductName} console, click *Workloads* -> *Virtual Machines*. +* In the {VirtProductName} console, click *Workloads* -> *Virtual Machines*. diff --git a/modules/cnv-networking-glossary.adoc b/modules/virt-networking-glossary.adoc similarity index 67% rename from modules/cnv-networking-glossary.adoc rename to modules/virt-networking-glossary.adoc index fc64ba16ac..75e2d46f7b 100644 --- a/modules/cnv-networking-glossary.adoc +++ b/modules/virt-networking-glossary.adoc @@ -1,18 +1,18 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-configuring-pxe-booting.adoc -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-attaching-vm-multiple-networks.adoc +// * virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc +// * virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc -[id="cnv-networking-glossary_{context}"] -= Container-native virtualization networking glossary +[id="virt-networking-glossary_{context}"] += {VirtProductName} networking glossary -{CNVProductNameStart} provides advanced networking functionality by using custom +{VirtProductName} provides advanced networking functionality by using custom resources and plug-ins. -The following terms are used throughout {CNVProductName} documentation: +The following terms are used throughout {VirtProductName} documentation: Container Network Interface (CNI):: a link:https://www.cncf.io/[Cloud Native Computing Foundation] -project, focused on container network connectivity. {CNVProductNameStart} uses CNI +project, focused on container network connectivity. {VirtProductName} uses CNI plug-ins to build upon the basic Kubernetes networking functionality. Multus:: a "meta" CNI plug-in that allows multiple CNIs to exist so that a Pod or diff --git a/modules/cnv-networking-wizard-fields-web.adoc b/modules/virt-networking-wizard-fields-web.adoc similarity index 64% rename from modules/cnv-networking-wizard-fields-web.adoc rename to modules/virt-networking-wizard-fields-web.adoc index b1f7369cf1..1828ef047d 100644 --- a/modules/cnv-networking-wizard-fields-web.adoc +++ b/modules/virt-networking-wizard-fields-web.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-create-vms.adoc -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-using-the-default-pod-network-with-cnv.adoc -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-attaching-vm-multiple-networks.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc -// * cnv/cnv_vm_templates/cnv-creating-vm-template.adoc +// * virt/virtual_machines/virt-create-vms.adoc +// * virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc +// * virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc +// * virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc +// * virt/vm_templates/virt-creating-vm-template.adoc -[id="cnv-networking-wizard-fields-web_{context}"] +[id="virt-networking-wizard-fields-web_{context}"] = Networking fields |=== diff --git a/modules/cnv-openshift-client-commands.adoc b/modules/virt-openshift-client-commands.adoc similarity index 92% rename from modules/cnv-openshift-client-commands.adoc rename to modules/virt-openshift-client-commands.adoc index af4e7097c7..ffc58f921b 100644 --- a/modules/cnv-openshift-client-commands.adoc +++ b/modules/virt-openshift-client-commands.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv-using-the-cli-tools.adoc +// * virt/virt-using-the-cli-tools.adoc -[id="cnv-openshift-client-commands_{context}"] +[id="virt-openshift-client-commands_{context}"] = {product-title} client commands The {product-title} `oc` client is a command-line utility for managing @@ -37,4 +37,3 @@ You can use the `-n ` flag to specify a different project. |`oc delete ` |Delete a resource in the current project. |=== - diff --git a/modules/cnv-operations-requiring-scratch-space.adoc b/modules/virt-operations-requiring-scratch-space.adoc similarity index 88% rename from modules/cnv-operations-requiring-scratch-space.adoc rename to modules/virt-operations-requiring-scratch-space.adoc index 4edf380c59..cb7c7e09be 100644 --- a/modules/cnv-operations-requiring-scratch-space.adoc +++ b/modules/virt-operations-requiring-scratch-space.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc +// * virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc -[id="cnv-operations-requiring-scratch-space_{context}"] +[id="virt-operations-requiring-scratch-space_{context}"] = CDI operations that require scratch space [options="header"] diff --git a/modules/cnv-pxe-booting-with-mac-address.adoc b/modules/virt-pxe-booting-with-mac-address.adoc similarity index 93% rename from modules/cnv-pxe-booting-with-mac-address.adoc rename to modules/virt-pxe-booting-with-mac-address.adoc index 5073a5f690..b855e9308d 100644 --- a/modules/cnv-pxe-booting-with-mac-address.adoc +++ b/modules/virt-pxe-booting-with-mac-address.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-configuring-pxe-booting.adoc +// * virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc -[id="cnv-pxe-booting-with-mac-address_{context}"] +[id="virt-pxe-booting-with-mac-address_{context}"] = PXE booting with a specified MAC address As an administrator, you can boot a client over the network by first creating a @@ -39,12 +39,12 @@ spec: "bridge": "br1" }, { - "type": "cnv-tuning" <1> + "type": "virt-tuning" <1> } ] }' ---- -<1> The `cnv-tuning` plug-in provides support for custom MAC addresses. +<1> The `virt-tuning` plug-in provides support for custom MAC addresses. + [NOTE] ==== diff --git a/modules/cnv-refreshing-certificates.adoc b/modules/virt-refreshing-certificates.adoc similarity index 74% rename from modules/cnv-refreshing-certificates.adoc rename to modules/virt-refreshing-certificates.adoc index 9db7fb9d2d..d2181bf0da 100644 --- a/modules/cnv-refreshing-certificates.adoc +++ b/modules/virt-refreshing-certificates.adoc @@ -1,11 +1,11 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_maintenance/cnv-refresh-certificates.adoc +// * virt/node_maintenance/virt-refresh-certificates.adoc -[id="cnv-refreshing-certificates_{context}"] +[id="virt-refreshing-certificates_{context}"] = Refreshing TLS certificates -To refresh the TLS certificates for {CNVProductName}, download and run the `rotate-certs` script. This script is available from the `kubevirt/hyperconverged-cluster-operator` repository on GitHub. +To refresh the TLS certificates for {VirtProductName}, download and run the `rotate-certs` script. This script is available from the `kubevirt/hyperconverged-cluster-operator` repository on GitHub. [IMPORTANT] ==== diff --git a/modules/cnv-remove-boot-order-item-web.adoc b/modules/virt-remove-boot-order-item-web.adoc similarity index 88% rename from modules/cnv-remove-boot-order-item-web.adoc rename to modules/virt-remove-boot-order-item-web.adoc index 43df970df1..d6a890e090 100644 --- a/modules/cnv-remove-boot-order-item-web.adoc +++ b/modules/virt-remove-boot-order-item-web.adoc @@ -1,9 +1,9 @@ // Module included in the following assembly: // -// * cnv/cnv_users_guide/cnv-edit-boot-order.adoc +// * virt/virt_users_guide/virt-edit-boot-order.adoc // -[id="cnv-remove-boot-order-item-web_{context}"] +[id="virt-remove-boot-order-item-web_{context}"] = Removing items from a boot order list in the web console diff --git a/modules/cnv-removing-interface-from-nodes.adoc b/modules/virt-removing-interface-from-nodes.adoc similarity index 92% rename from modules/cnv-removing-interface-from-nodes.adoc rename to modules/virt-removing-interface-from-nodes.adoc index 506cb97826..e939b5c3b5 100644 --- a/modules/cnv-removing-interface-from-nodes.adoc +++ b/modules/virt-removing-interface-from-nodes.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-updating-node-network-config.adoc +// * virt/node_network/virt-updating-node-network-config.adoc -[id="cnv-removing-interface-from-nodes_{context}"] +[id="virt-removing-interface-from-nodes_{context}"] = Removing an interface from nodes Remove an interface from nodes by editing the `NodeNetworkConfigurationPolicy` object and set diff --git a/modules/cnv-removing-virtio-disk-from-vm.adoc b/modules/virt-removing-virtio-disk-from-vm.adoc similarity index 60% rename from modules/cnv-removing-virtio-disk-from-vm.adoc rename to modules/virt-removing-virtio-disk-from-vm.adoc index 7a222f80f4..11f2f7b058 100644 --- a/modules/cnv-removing-virtio-disk-from-vm.adoc +++ b/modules/virt-removing-virtio-disk-from-vm.adoc @@ -1,14 +1,16 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-new-windows-vm.adoc -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-existing-windows-vm.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc -[id="cnv-removing-virtio-disk-from-vm_{context}"] +//This file contains UI elements and/or package names that need to be updated. + +[id="virt-removing-virtio-disk-from-vm_{context}"] = Removing the VirtIO container disk from a virtual machine After installing all required VirtIO drivers to the virtual machine, the - `container-native-virtualization/virtio-win` container disk no longer needs to be attached to the virtual machine. -Remove the `container-native-virtualization/virtio-win` container disk from the virtual machine configuration file. + `container-native-virtualization/virtio-win` container disk no longer needs to be attached to the virtual machine. +Remove the `container-native-virtualization/virtio-win` container disk from the virtual machine configuration file. .Procedure . Edit the configuration file and remove the `disk` and the `volume`. @@ -33,5 +35,4 @@ volumes: name: virtiocontainerdisk ---- -. Reboot the virtual machine for the changes to take effect. - +. Reboot the virtual machine for the changes to take effect. diff --git a/modules/cnv-restarting-vm-web.adoc b/modules/virt-restarting-vm-web.adoc similarity index 90% rename from modules/cnv-restarting-vm-web.adoc rename to modules/virt-restarting-vm-web.adoc index de5954fc71..738edb0d61 100644 --- a/modules/cnv-restarting-vm-web.adoc +++ b/modules/virt-restarting-vm-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-controlling-vm-states.adoc +// * virt/virtual_machines/virt-controlling-vm-states.adoc -[id="cnv-restarting-vm-web_{context}"] +[id="virt-restarting-vm-web_{context}"] = Restarting a virtual machine You can restart a running virtual machine from the web console. diff --git a/modules/cnv-restoring-node-network-configuration.adoc b/modules/virt-restoring-node-network-configuration.adoc similarity index 89% rename from modules/cnv-restoring-node-network-configuration.adoc rename to modules/virt-restoring-node-network-configuration.adoc index cde396b3cc..698e5b8f25 100644 --- a/modules/cnv-restoring-node-network-configuration.adoc +++ b/modules/virt-restoring-node-network-configuration.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-updating-node-network-config.adoc +// * virt/node_network/virt-updating-node-network-config.adoc -[id="cnv-restoring-node-network-configuration_{context}"] +[id="virt-restoring-node-network-configuration_{context}"] = Restoring node network configuration after removing an interface Removing an interface from a node does not automatically restore the node network configuration to a previous state. After you remove an interface, any of the node NICs throughout the cluster that were previously attached or subordinate to the interface are placed in a `down` state. Restore the NICs by applying a new `NodeNetworkConfigurationPolicy` manifest to the cluster. diff --git a/modules/cnv-resuming-node-maintenance-cli.adoc b/modules/virt-resuming-node-maintenance-cli.adoc similarity index 88% rename from modules/cnv-resuming-node-maintenance-cli.adoc rename to modules/virt-resuming-node-maintenance-cli.adoc index d2d39caca8..69ed8bdc1b 100644 --- a/modules/cnv-resuming-node-maintenance-cli.adoc +++ b/modules/virt-resuming-node-maintenance-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_maintenance/cnv-resuming-node.adoc +// * virt/node_maintenance/virt-resuming-node.adoc -[id="cnv-resuming-node-maintenance-cli_{context}"] +[id="virt-resuming-node-maintenance-cli_{context}"] = Resuming a node from maintenance mode in the CLI Resume a node from maintenance mode and make it schedulable again by deleting diff --git a/modules/cnv-resuming-node-maintenance-web.adoc b/modules/virt-resuming-node-maintenance-web.adoc similarity index 84% rename from modules/cnv-resuming-node-maintenance-web.adoc rename to modules/virt-resuming-node-maintenance-web.adoc index 431aacb844..721522d051 100644 --- a/modules/cnv-resuming-node-maintenance-web.adoc +++ b/modules/virt-resuming-node-maintenance-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_maintenance/cnv-resuming-node.adoc +// * virt/node_maintenance/virt-resuming-node.adoc -[id="cnv-resuming-node-maintenance-web_{context}"] +[id="virt-resuming-node-maintenance-web_{context}"] = Resuming a node from maintenance mode in the web console Resume a node from maintenance mode using the Options menu {kebab} found @@ -11,7 +11,7 @@ of the *Node Details* screen. .Procedure -. In the {CNVProductName} console, click *Compute* -> *Nodes*. +. In the {VirtProductName} console, click *Compute* -> *Nodes*. . You can resume the node from this screen, which makes it easier to perform actions on multiple nodes in the one screen, or from the *Node Details* screen where you can view comprehensive details of the selected node: diff --git a/modules/cnv-setting-node-maintenance-cli.adoc b/modules/virt-setting-node-maintenance-cli.adoc similarity index 89% rename from modules/cnv-setting-node-maintenance-cli.adoc rename to modules/virt-setting-node-maintenance-cli.adoc index 73770db37c..df6b102e22 100644 --- a/modules/cnv-setting-node-maintenance-cli.adoc +++ b/modules/virt-setting-node-maintenance-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_maintenance/cnv-setting-node-maintenance.adoc +// * virt/node_maintenance/virt-setting-node-maintenance.adoc -[id="cnv-setting-node-maintenance-cli_{context}"] +[id="virt-setting-node-maintenance-cli_{context}"] = Setting a node to maintenance mode in the CLI Set a node to maintenance mode by creating a `NodeMaintenance` Custom Resource diff --git a/modules/cnv-setting-node-maintenance-web.adoc b/modules/virt-setting-node-maintenance-web.adoc similarity index 85% rename from modules/cnv-setting-node-maintenance-web.adoc rename to modules/virt-setting-node-maintenance-web.adoc index eb1f3a65ab..ffd5b642e4 100644 --- a/modules/cnv-setting-node-maintenance-web.adoc +++ b/modules/virt-setting-node-maintenance-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_maintenance/cnv-setting-node-maintenance.adoc +// * virt/node_maintenance/virt-setting-node-maintenance.adoc -[id="cnv-setting-node-maintenance-web_{context}"] +[id="virt-setting-node-maintenance-web_{context}"] = Setting a node to maintenance mode in the web console Set a node to maintenance mode using the Options menu {kebab} found on each node in the @@ -11,7 +11,7 @@ screen. .Procedure -. In the {CNVProductName} console, click *Compute* -> *Nodes*. +. In the {VirtProductName} console, click *Compute* -> *Nodes*. . You can set the node to maintenance from this screen, which makes it easier to perform actions on multiple nodes in the one screen or from the *Node Details* screen where you can view comprehensive details of the selected node: diff --git a/modules/cnv-starting-vm-web.adoc b/modules/virt-starting-vm-web.adoc similarity index 90% rename from modules/cnv-starting-vm-web.adoc rename to modules/virt-starting-vm-web.adoc index 4ae2bae0f6..794d0bb56e 100644 --- a/modules/cnv-starting-vm-web.adoc +++ b/modules/virt-starting-vm-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-controlling-vm-states.adoc +// * virt/virtual_machines/virt-controlling-vm-states.adoc -[id="cnv-starting-vm-web_{context}"] +[id="virt-starting-vm-web_{context}"] = Starting a virtual machine You can start a virtual machine from the web console. @@ -34,7 +34,7 @@ machine. [NOTE] ==== When you start virtual machine that is provisioned from a `URL` source for the -first time, the virtual machine has a status of *Importing* while {CNVProductName} +first time, the virtual machine has a status of *Importing* while {VirtProductName} imports the container from the URL endpoint. Depending on the size of the image, this process might take several minutes. ==== diff --git a/modules/cnv-stopping-vm-web.adoc b/modules/virt-stopping-vm-web.adoc similarity index 88% rename from modules/cnv-stopping-vm-web.adoc rename to modules/virt-stopping-vm-web.adoc index dce6de80fc..6cd22c8228 100644 --- a/modules/cnv-stopping-vm-web.adoc +++ b/modules/virt-stopping-vm-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-controlling-vm-states.adoc +// * virt/virtual_machines/virt-controlling-vm-states.adoc -[id="cnv-stopping-vm-web_{context}"] +[id="virt-stopping-vm-web_{context}"] = Stopping a virtual machine You can stop a virtual machine from the web console. diff --git a/modules/cnv-storage-wizard-fields-web.adoc b/modules/virt-storage-wizard-fields-web.adoc similarity index 79% rename from modules/cnv-storage-wizard-fields-web.adoc rename to modules/virt-storage-wizard-fields-web.adoc index 6517531f10..d60f0f5781 100644 --- a/modules/cnv-storage-wizard-fields-web.adoc +++ b/modules/virt-storage-wizard-fields-web.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-create-vms.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc -// * cnv/cnv_vm_templates/cnv-creating-vm-template.adoc +// * virt/virtual_machines/virt-create-vms.adoc +// * virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc +// * virt/vm_templates/virt-creating-vm-template.adoc -[id="cnv-storage-wizard-fields-web_{context}"] +[id="virt-storage-wizard-fields-web_{context}"] = Storage fields |=== diff --git a/modules/cnv-subscribing-to-the-catalog.adoc b/modules/virt-subscribing-to-the-catalog.adoc similarity index 55% rename from modules/cnv-subscribing-to-the-catalog.adoc rename to modules/virt-subscribing-to-the-catalog.adoc index cc2cdebafc..28113df406 100644 --- a/modules/cnv-subscribing-to-the-catalog.adoc +++ b/modules/virt-subscribing-to-the-catalog.adoc @@ -1,13 +1,13 @@ // Module included in the following assemblies: // -// * cnv/cnv_install/installing-container-native-virtualization.adoc +// * virt/install/installing-virt.adoc -[id="cnv-subscribing-to-the-catalog_{context}"] -= Subscribing to the {CNVProductNameStart} catalog +[id="virt-subscribing-to-the-catalog_{context}"] += Subscribing to the {VirtProductName} catalog -Before you install {CNVProductName}, subscribe to the -*{CNVProductNameStart}* catalog from the {product-title} web console. -Subscribing gives the `openshift-cnv` namespace access to the {CNVProductName} +Before you install {VirtProductName}, subscribe to the +*{VirtProductName}* catalog from the {product-title} web console. +Subscribing gives the `openshift-cnv` namespace access to the {VirtProductName} Operators. .Procedure @@ -16,7 +16,7 @@ Operators. . Navigate to the *Operators* → *OperatorHub* page. -. Search for *{CNVProductNameStart}* and then select it. +. Search for *{VirtProductName}* and then select it. . Read the information about the Operator and click *Install*. @@ -28,16 +28,16 @@ is automatically created if it does not exist. + [WARNING] ==== -Attempting to install the {CNVProductName} Operator in a namespace other than +Attempting to install the {VirtProductName} Operator in a namespace other than `openshift-cnv` causes the installation to fail. ==== -.. Select *{CNVVersion}* from the list of available *Update Channel* options. +.. Select *{VirtVersion}* from the list of available *Update Channel* options. .. For *Approval Strategy*, ensure that *Automatic*, which is the default value, is selected. -{CNVProductNameStart} automatically updates when a new z-stream release is +{VirtProductName} automatically updates when a new z-stream release is available. . Click *Subscribe* to make the Operator available to the `openshift-cnv` namespace. + On the *Installed Operators* screen, the *Status* displays *Succeeded* when -{CNVProductName} finishes installation. +{VirtProductName} finishes installation. diff --git a/modules/cnv-supported-virtio-drivers.adoc b/modules/virt-supported-virtio-drivers.adoc similarity index 75% rename from modules/cnv-supported-virtio-drivers.adoc rename to modules/virt-supported-virtio-drivers.adoc index 0aedb84011..fafbcc46fc 100644 --- a/modules/cnv-supported-virtio-drivers.adoc +++ b/modules/virt-supported-virtio-drivers.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-new-windows-vm.adoc -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-existing-windows-vm.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc -[id="cnv-supported-virtio-drivers_{context}"] +[id="virt-supported-virtio-drivers_{context}"] = Supported VirtIO drivers for Microsoft Windows virtual machines .Supported drivers diff --git a/modules/cnv-template-blank-disk-datavolume.adoc b/modules/virt-template-blank-disk-datavolume.adoc similarity index 75% rename from modules/cnv-template-blank-disk-datavolume.adoc rename to modules/virt-template-blank-disk-datavolume.adoc index b86f234657..78d5aa0234 100644 --- a/modules/cnv-template-blank-disk-datavolume.adoc +++ b/modules/virt-template-blank-disk-datavolume.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-expanding-virtual-storage-with-blank-disk-images.adoc +// * virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc -[id="cnv-template-blank-disk-datavolume_{context}"] +[id="virt-template-blank-disk-datavolume_{context}"] = Template: DataVolume configuration file for blank disk images *blank-image-datavolume.yaml* diff --git a/modules/cnv-template-datavolume-clone.adoc b/modules/virt-template-datavolume-clone.adoc similarity index 75% rename from modules/cnv-template-datavolume-clone.adoc rename to modules/virt-template-datavolume-clone.adoc index 3ef6603ff4..2bafe7df9f 100644 --- a/modules/cnv-template-datavolume-clone.adoc +++ b/modules/virt-template-datavolume-clone.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-disk-into-new-datavolume.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc -[id="cnv-template-datavolume-clone_{context}"] +[id="virt-template-datavolume-clone_{context}"] = Template: DataVolume clone configuration file *example-clone-dv.yaml* diff --git a/modules/cnv-template-datavolume-import.adoc b/modules/virt-template-datavolume-import.adoc similarity index 77% rename from modules/cnv-template-datavolume-import.adoc rename to modules/virt-template-datavolume-import.adoc index 1a10e4b6ec..a98ce93151 100644 --- a/modules/cnv-template-datavolume-import.adoc +++ b/modules/virt-template-datavolume-import.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc -[id="cnv-template-datavolume-import_{context}"] +[id="virt-template-datavolume-import_{context}"] = Template: DataVolume import configuration file *example-import-dv.yaml* diff --git a/modules/cnv-template-datavolume-vm.adoc b/modules/virt-template-datavolume-vm.adoc similarity index 82% rename from modules/cnv-template-datavolume-vm.adoc rename to modules/virt-template-datavolume-vm.adoc index 5405a56ae4..8ac427143c 100644 --- a/modules/cnv-template-datavolume-vm.adoc +++ b/modules/virt-template-datavolume-vm.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-cloning-vm-using-datavolumetemplate.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-virtual-machine-images-datavolumes.adoc +// * virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc +// * virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc -[id="cnv-template-datavolume-vm_{context}"] +[id="virt-template-datavolume-vm_{context}"] = Template: DataVolume virtual machine configuration file *example-dv-vm.yaml* diff --git a/modules/cnv-template-vm-config.adoc b/modules/virt-template-vm-config.adoc similarity index 87% rename from modules/cnv-template-vm-config.adoc rename to modules/virt-template-vm-config.adoc index 37cf166d51..655f8bf984 100644 --- a/modules/cnv-template-vm-config.adoc +++ b/modules/virt-template-vm-config.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-using-the-default-pod-network-with-cnv.adoc +// * virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc -[id="cnv-template-vm-config_{context}"] +[id="virt-template-vm-config_{context}"] = Template: virtual machine configuration file [source,yaml] diff --git a/modules/cnv-template-vmi-pxe-config.adoc b/modules/virt-template-vmi-pxe-config.adoc similarity index 89% rename from modules/cnv-template-vmi-pxe-config.adoc rename to modules/virt-template-vmi-pxe-config.adoc index 335f14c327..4da3babbab 100644 --- a/modules/cnv-template-vmi-pxe-config.adoc +++ b/modules/virt-template-vmi-pxe-config.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-configuring-pxe-booting.adoc +// * virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc -[id="cnv-pxe-vmi-template_{context}"] +[id="virt-pxe-vmi-template_{context}"] = Template: virtual machine instance configuration file for PXE booting [source,yaml] diff --git a/modules/cnv-template-windows-vmi.adoc b/modules/virt-template-windows-vmi.adoc similarity index 88% rename from modules/cnv-template-windows-vmi.adoc rename to modules/virt-template-windows-vmi.adoc index 6e92555432..adfca3e732 100644 --- a/modules/cnv-template-windows-vmi.adoc +++ b/modules/virt-template-windows-vmi.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-using-the-default-pod-network-with-cnv.adoc +// * virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc -[id="cnv-template-windows-vmi_{context}"] +[id="virt-template-windows-vmi_{context}"] = Template: Windows virtual machine instance configuration file [source,yaml] diff --git a/modules/cnv-troubleshooting-incorrect-policy-config.adoc b/modules/virt-troubleshooting-incorrect-policy-config.adoc similarity index 93% rename from modules/cnv-troubleshooting-incorrect-policy-config.adoc rename to modules/virt-troubleshooting-incorrect-policy-config.adoc index 8065c9a8e8..77f2e0c051 100644 --- a/modules/cnv-troubleshooting-incorrect-policy-config.adoc +++ b/modules/virt-troubleshooting-incorrect-policy-config.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-troubleshooting-node-network.adoc +// * virt/node_network/virt-troubleshooting-node-network.adoc -[id="cnv-troubleshooting-incorrect-policy-config_{context}"] +[id="virt-troubleshooting-incorrect-policy-config_{context}"] = Troubleshooting an incorrect NodeNetworkConfigurationPolicy configuration -You can apply changes to the node network configuration across your entire cluster by applying a -NodeNetworkConfigurationPolicy. If you apply an incorrect configuration, you can use the +You can apply changes to the node network configuration across your entire cluster by applying a +NodeNetworkConfigurationPolicy. If you apply an incorrect configuration, you can use the following example to troubleshoot and correct the failed network Policy. In this example, a Linux bridge Policy is applied to an example cluster that has 3 master nodes and 3 worker nodes. @@ -27,7 +27,7 @@ spec: desiredState: interfaces: - name: br1 - description: Linux bridge with the wrong port + description: Linux bridge with the wrong port type: linux-bridge state: up ipv4: @@ -62,7 +62,7 @@ NAME STATUS ens01-bridge-testfail FailedToConfigure ---- + -However the Policy status alone does not indicate if it failed on all nodes or a subset of nodes. +However the Policy status alone does not indicate if it failed on all nodes or a subset of nodes. . List the Enactments to see if the Policy was successful on any of the nodes. If the Policy failed for only a subset it suggests the problem is with specific node configuration; if the Policy failed on all nodes it suggest the problem is with the Policy. + @@ -74,7 +74,7 @@ The output shows that the Policy failed on all nodes: + ---- NAME STATUS -utput +utput master-1.ens01-bridge-testfail FailedToConfigure master-2.ens01-bridge-testfail FailedToConfigure master-3.ens01-bridge-testfail FailedToConfigure @@ -92,9 +92,9 @@ $ oc get nnce worker-1.ens01-bridge-testfail -o jsonpath='{.status.conditions[?( This command returns a large traceback that has been edited for brevity: + ---- -error reconciling NodeNetworkConfigurationPolicy at desired state apply: , failed to execute nmstatectl set --no-commit --timeout 480: 'exit status 1' '' +error reconciling NodeNetworkConfigurationPolicy at desired state apply: , failed to execute nmstatectl set --no-commit --timeout 480: 'exit status 1' '' ... -libnmstate.error.NmstateVerificationError: +libnmstate.error.NmstateVerificationError: desired ======= --- @@ -175,7 +175,7 @@ difference line 651, in _assert_interfaces_equal\n current_state.interfaces[ifname],\nlibnmstate.error.NmstateVerificationError: ---- + -The `NmstateVerificationError` lists the `desired` Policy configuration, the `current` configuration of the Policy on the node, and the `difference` highlighting the parameters that do not match. In this example, the `port` is included in the `difference`, which suggests that the problem is the port configuration in the Policy. +The `NmstateVerificationError` lists the `desired` Policy configuration, the `current` configuration of the Policy on the node, and the `difference` highlighting the parameters that do not match. In this example, the `port` is included in the `difference`, which suggests that the problem is the port configuration in the Policy. . To ensure that the Policy is configured properly, view the network configuration for one or all of the nodes by requesting the `NodeNetworkState`. The following command returns the network configuration for the `master-1` node: + diff --git a/modules/cnv-troubleshooting-vmware-vm-import.adoc b/modules/virt-troubleshooting-vmware-vm-import.adoc similarity index 92% rename from modules/cnv-troubleshooting-vmware-vm-import.adoc rename to modules/virt-troubleshooting-vmware-vm-import.adoc index 1c573ad7ec..41728b4d66 100644 --- a/modules/cnv-troubleshooting-vmware-vm-import.adoc +++ b/modules/virt-troubleshooting-vmware-vm-import.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc +// * virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc [id='troubleshooting-vmware-vm-import_{context}'] = Troubleshooting a VMware virtual machine import @@ -29,7 +29,7 @@ INFO - have error: ('virt-v2v error: internal error: invalid argument: libvirt d + You must ensure that the virtual machine is shut down before importing it. -ifeval::["{CNVVersion}" == "2.3"] +ifeval::["{VirtVersion}" == "2.3"] == Known issues * Migration progress status is not displayed in the Cluster Application Migration tool web console. link:https://bugzilla.redhat.com/show_bug.cgi?id=1830780[(*1830780*)] diff --git a/modules/cnv-understanding-events.adoc b/modules/virt-understanding-events.adoc similarity index 63% rename from modules/cnv-understanding-events.adoc rename to modules/virt-understanding-events.adoc index 8e43c2bf81..3e870e1bed 100644 --- a/modules/cnv-understanding-events.adoc +++ b/modules/virt-understanding-events.adoc @@ -1,13 +1,13 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-events.adoc +// * virt/logging_events_monitoring/virt-events.adoc -[id="cnv-understanding-events_{context}"] +[id="virt-understanding-events_{context}"] = Understanding virtual machine events {product-title} events are records of important life-cycle information in a namespace and are useful for monitoring and troubleshooting resource scheduling, creation, and deletion issues. -{CNVProductNameStart} adds events for virtual machines and virtual machine instances. These +{VirtProductName} adds events for virtual machines and virtual machine instances. These can be viewed from either the web console or the CLI. diff --git a/modules/cnv-understanding-live-migration.adoc b/modules/virt-understanding-live-migration.adoc similarity index 86% rename from modules/cnv-understanding-live-migration.adoc rename to modules/virt-understanding-live-migration.adoc index 3bea86ace5..cd3bb2cda5 100644 --- a/modules/cnv-understanding-live-migration.adoc +++ b/modules/virt-understanding-live-migration.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_live_migration/cnv-live-migration.adoc +// * virt/live_migration/virt-live-migration.adoc -[id="cnv-understanding-live-migration_{context}"] +[id="virt-understanding-live-migration_{context}"] = Understanding live migration Live migration is the process of moving a running virtual machine instance to diff --git a/modules/cnv-understanding-logs.adoc b/modules/virt-understanding-logs.adoc similarity index 79% rename from modules/cnv-understanding-logs.adoc rename to modules/virt-understanding-logs.adoc index e7d3cf3560..85a50cf7c4 100644 --- a/modules/cnv-understanding-logs.adoc +++ b/modules/virt-understanding-logs.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-logs.adoc +// * virt/logging_events_monitoring/virt-logs.adoc -[id="cnv-understanding-logs_{context}"] +[id="virt-understanding-logs_{context}"] = Understanding virtual machine logs Logs are collected for {product-title} Builds, Deployments, and Pods. -In {CNVProductName}, virtual machine logs can be retrieved from the +In {VirtProductName}, virtual machine logs can be retrieved from the virtual machine launcher Pod in either the web console or the CLI. The `-f` option follows the log output in real time, which is useful for diff --git a/modules/cnv-understanding-node-maintenance.adoc b/modules/virt-understanding-node-maintenance.adoc similarity index 81% rename from modules/cnv-understanding-node-maintenance.adoc rename to modules/virt-understanding-node-maintenance.adoc index cf3e60ef91..6c544facc9 100644 --- a/modules/cnv-understanding-node-maintenance.adoc +++ b/modules/virt-understanding-node-maintenance.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_maintenance/cnv-node-maintenance.adoc -// * cnv/cnv_node_maintenance/cnv-setting-node-maintenance.adoc +// * virt/node_maintenance/virt-node-maintenance.adoc +// * virt/node_maintenance/virt-setting-node-maintenance.adoc -[id="cnv-understanding-node-maintenance{context}"] +[id="virt-understanding-node-maintenance{context}"] = Understanding node maintenance mode Placing a node into maintenance marks the node as unschedulable and drains all diff --git a/modules/cnv-understanding-scratch-space.adoc b/modules/virt-understanding-scratch-space.adoc similarity index 92% rename from modules/cnv-understanding-scratch-space.adoc rename to modules/virt-understanding-scratch-space.adoc index 57f38df70d..0866de530e 100644 --- a/modules/cnv-understanding-scratch-space.adoc +++ b/modules/virt-understanding-scratch-space.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-preparing-cdi-scratch-space.adoc +// * virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc -[id="cnv-understanding-scratch-space_{context}"] +[id="virt-understanding-scratch-space_{context}"] = Understanding scratch space The Containerized Data Importer (CDI) requires scratch space (temporary storage) diff --git a/modules/cnv-understanding-virtio-drivers.adoc b/modules/virt-understanding-virtio-drivers.adoc similarity index 52% rename from modules/cnv-understanding-virtio-drivers.adoc rename to modules/virt-understanding-virtio-drivers.adoc index 729d6ee309..218b876089 100644 --- a/modules/cnv-understanding-virtio-drivers.adoc +++ b/modules/virt-understanding-virtio-drivers.adoc @@ -1,21 +1,22 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-new-windows-vm.adoc -// * cnv/cnv_virtual_machines/cnv-installing-virtio-drivers-on-existing-windows-vm.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc +// * virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc -[id="cnv-understanding-virtio-drivers_{context}"] +//This file contains UI elements and/or package names that need to be updated. + +[id="virt-understanding-virtio-drivers_{context}"] = Understanding VirtIO drivers VirtIO drivers are paravirtualized device drivers required for Microsoft Windows - virtual machines to run in {CNVProductName}. The supported drivers are -available in the `container-native-virtualization/virtio-win` container disk of the + virtual machines to run in {VirtProductName}. The supported drivers are +available in the `container-native-virtualization/virtio-win` container disk of the link:https://access.redhat.com/containers/#/registry.access.redhat.com/container-native-virtualization/virtio-win[Red Hat Container Catalog]. -The `container-native-virtualization/virtio-win` container disk must be attached to the virtual machine as a -SATA CD drive to enable driver installation. You can install VirtIO drivers during -Windows installation on the virtual machine or added to an +The `container-native-virtualization/virtio-win` container disk must be attached to the virtual machine as a +SATA CD drive to enable driver installation. You can install VirtIO drivers during +Windows installation on the virtual machine or added to an existing Windows installation. -After the drivers are installed, the `container-native-virtualization/virtio-win` container disk can be removed +After the drivers are installed, the `container-native-virtualization/virtio-win` container disk can be removed from the virtual machine. - diff --git a/modules/cnv-unpausing-vm-web.adoc b/modules/virt-unpausing-vm-web.adoc similarity index 90% rename from modules/cnv-unpausing-vm-web.adoc rename to modules/virt-unpausing-vm-web.adoc index 90208ff092..c165d6c084 100644 --- a/modules/cnv-unpausing-vm-web.adoc +++ b/modules/virt-unpausing-vm-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-controlling-vm-states.adoc +// * virt/virtual_machines/virt-controlling-vm-states.adoc -[id="cnv-unpausing-vm-web_{context}"] +[id="virt-unpausing-vm-web_{context}"] = Unpausing a virtual machine You can unpause a paused virtual machine from the web console. @@ -37,5 +37,3 @@ machine. .. Click the pencil icon that is located on the right side of *Status*. . In the confirmation window, click *Unpause* to unpause the virtual machine. - - diff --git a/modules/cnv-updating-imported-vm-network-name.adoc b/modules/virt-updating-imported-vm-network-name.adoc similarity index 77% rename from modules/cnv-updating-imported-vm-network-name.adoc rename to modules/virt-updating-imported-vm-network-name.adoc index 47e3b29191..a5106f54c6 100644 --- a/modules/cnv-updating-imported-vm-network-name.adoc +++ b/modules/virt-updating-imported-vm-network-name.adoc @@ -1,11 +1,11 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc +// * virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc -[id="cnv-updating-imported-vmware-vm-network-name_{context}"] +[id="virt-updating-imported-vmware-vm-network-name_{context}"] = Updating the imported VMware virtual machine's NIC name -You must update the NIC name of a virtual machine imported from VMware to conform to {CNVProductName} naming conventions. +You must update the NIC name of a virtual machine imported from VMware to conform to {VirtProductName} naming conventions. .Procedure diff --git a/modules/cnv-upgrading-cnv.adoc b/modules/virt-upgrading-virt.adoc similarity index 69% rename from modules/cnv-upgrading-cnv.adoc rename to modules/virt-upgrading-virt.adoc index 298babe4eb..082552637c 100644 --- a/modules/cnv-upgrading-cnv.adoc +++ b/modules/virt-upgrading-virt.adoc @@ -1,11 +1,11 @@ // Module included in the following assemblies: // -// * cnv/upgrading-container-native-virtualization.adoc +// * virt/upgrading-virt.adoc -[id="cnv-upgrading-cnv_{context}"] -= Upgrading {CNVProductName} to the next minor version +[id="virt-upgrading-virt_{context}"] += Upgrading {VirtProductName} to the next minor version -You can manually upgrade {CNVProductName} to the next minor version by using the +You can manually upgrade {VirtProductName} to the next minor version by using the {product-title} web console to change the channel of your Operator subscription. .Prerequisites @@ -16,15 +16,15 @@ You can manually upgrade {CNVProductName} to the next minor version by using the . Access the {product-title} web console and navigate to *Operators* -> *Installed Operators*. -. Click *{CNVProductNameStart}* to open the *Operator Details* page. +. Click *{VirtProductName}* to open the *Operator Details* page. . Click the *Subscription* tab to open the *Subscription Overview* page. . In the *Channel* pane, click the pencil icon on the right side of the version number to open the *Change Subscription Update Channel* window. -. Select the next minor version. For example, if you want to upgrade to {CNVProductName} -{CNVVersion}, select *{CNVVersion}*. +. Select the next minor version. For example, if you want to upgrade to {VirtProductName} +{VirtVersion}, select *{VirtVersion}*. . Click *Save*. diff --git a/modules/cnv-uploading-local-disk-image-dv.adoc b/modules/virt-uploading-local-disk-image-dv.adoc similarity index 93% rename from modules/cnv-uploading-local-disk-image-dv.adoc rename to modules/virt-uploading-local-disk-image-dv.adoc index 5dedd5b9aa..e4f5754477 100644 --- a/modules/cnv-uploading-local-disk-image-dv.adoc +++ b/modules/virt-uploading-local-disk-image-dv.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-block.adoc +// * virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc -[id="cnv-uploading-local-disk-image-dv_{context}"] +[id="virt-uploading-local-disk-image-dv_{context}"] = Uploading a local disk image to a DataVolume You can use the `virtctl` CLI utility to upload a local disk image from @@ -60,4 +60,3 @@ by running the following command: ---- $ oc get dvs ---- - diff --git a/modules/virt-uploading-local-disk-image-pvc.adoc b/modules/virt-uploading-local-disk-image-pvc.adoc new file mode 100644 index 0000000000..4a4807db25 --- /dev/null +++ b/modules/virt-uploading-local-disk-image-pvc.adoc @@ -0,0 +1,44 @@ +// Module included in the following assemblies: +// +// * virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc + +[id="virt-uploading-local-disk-image-pvc_{context}"] += Uploading a local disk image to a new PersistentVolumeClaim + +You can use the `virtctl` CLI utility to upload a virtual machine disk image from +a client machine to your cluster. Uploading the disk image creates a +PersistentVolumeClaim (PVC) that you can associate with a virtual machine. + +.Prerequisites + +* A virtual machine disk image, in RAW, ISO, or QCOW2 format, optionally +compressed by using `xz` or `gz`. +* The `kubevirt-virtctl` package must be installed on the client machine. +* The client machine must be configured to trust the {product-title} router's +certificate. + +.Procedure + +. Identify the following items: +* File location of the VM disk image you want to upload +* Name and size required for the resulting PVC + +. Run the `virtctl image-upload` command to upload your VM image. +You must specify the PVC name, PVC size, and file location. For example: ++ +---- +$ virtctl image-upload --pvc-name= --pvc-size=<2Gi> --image-path= +---- ++ +[CAUTION] +==== +To allow insecure server connections when using HTTPS, use the `--insecure` +parameter. Be aware that when you use the `--insecure` flag, the authenticity of +the upload endpoint is *not* verified. +==== + +. To verify that the PVC was created, view all PVC objects: ++ +---- +$ oc get pvc +---- diff --git a/modules/cnv-using-hostpath-provisioner.adoc b/modules/virt-using-hostpath-provisioner.adoc similarity index 93% rename from modules/cnv-using-hostpath-provisioner.adoc rename to modules/virt-using-hostpath-provisioner.adoc index 1d234744da..929f47b6b1 100644 --- a/modules/cnv-using-hostpath-provisioner.adoc +++ b/modules/virt-using-hostpath-provisioner.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-configuring-local-storage-for-vms.adoc +// * virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc -[id="cnv-using-hostpath-provisioner_{context}"] +[id="virt-using-hostpath-provisioner_{context}"] = Using the hostpath provisioner to enable local storage To deploy the hostpath provisioner and enable your virtual machines to use local diff --git a/modules/cnv-viewing-namespace-events-cli.adoc b/modules/virt-viewing-namespace-events-cli.adoc similarity index 70% rename from modules/cnv-viewing-namespace-events-cli.adoc rename to modules/virt-viewing-namespace-events-cli.adoc index 51b261b680..b89344c130 100644 --- a/modules/cnv-viewing-namespace-events-cli.adoc +++ b/modules/virt-viewing-namespace-events-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-events.adoc +// * virt/logging_events_monitoring/virt-events.adoc -[id="cnv-viewing-namespace-events-cli_{context}"] +[id="virt-viewing-namespace-events-cli_{context}"] = Viewing namespace events in the CLI Use the {product-title} client to get the events for a namespace. diff --git a/modules/cnv-viewing-network-state-of-node.adoc b/modules/virt-viewing-network-state-of-node.adoc similarity index 90% rename from modules/cnv-viewing-network-state-of-node.adoc rename to modules/virt-viewing-network-state-of-node.adoc index ad828d999c..58d927fd87 100644 --- a/modules/cnv-viewing-network-state-of-node.adoc +++ b/modules/virt-viewing-network-state-of-node.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_node_network/cnv-observing-node-network-state.adoc +// * virt/node_network/virt-observing-node-network-state.adoc -[id="cnv-viewing-network-state-of-node_{context}"] +[id="virt-viewing-network-state-of-node_{context}"] = Viewing the network state of a node A `NodeNetworkState` object exists on every node in the cluster. This object is periodically updated and captures the state of the network for that node. diff --git a/modules/cnv-viewing-resource-events-cli.adoc b/modules/virt-viewing-resource-events-cli.adoc similarity index 82% rename from modules/cnv-viewing-resource-events-cli.adoc rename to modules/virt-viewing-resource-events-cli.adoc index 9915a7b08c..f30a3b04be 100644 --- a/modules/cnv-viewing-resource-events-cli.adoc +++ b/modules/virt-viewing-resource-events-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-events.adoc +// * virt/logging_events_monitoring/virt-events.adoc -[id="cnv-viewing-resource-events-cli_{context}"] +[id="virt-viewing-resource-events-cli_{context}"] = Viewing resource events in the CLI Events are included in the resource description, which you can get using the diff --git a/modules/cnv-viewing-virtual-machine-logs-cli.adoc b/modules/virt-viewing-virtual-machine-logs-cli.adoc similarity index 69% rename from modules/cnv-viewing-virtual-machine-logs-cli.adoc rename to modules/virt-viewing-virtual-machine-logs-cli.adoc index 4fb1c1ed3e..03ccb2102e 100644 --- a/modules/cnv-viewing-virtual-machine-logs-cli.adoc +++ b/modules/virt-viewing-virtual-machine-logs-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-logs.adoc +// * virt/logging_events_monitoring/virt-logs.adoc -[id="cnv-viewing-virtual-machine-logs-cli_{context}"] +[id="virt-viewing-virtual-machine-logs-cli_{context}"] = Viewing virtual machine logs in the CLI Get virtual machine logs from the virtual machine launcher Pod. diff --git a/modules/cnv-viewing-virtual-machine-logs-web.adoc b/modules/virt-viewing-virtual-machine-logs-web.adoc similarity index 66% rename from modules/cnv-viewing-virtual-machine-logs-web.adoc rename to modules/virt-viewing-virtual-machine-logs-web.adoc index 8690eaaf30..30eb1bd394 100644 --- a/modules/cnv-viewing-virtual-machine-logs-web.adoc +++ b/modules/virt-viewing-virtual-machine-logs-web.adoc @@ -1,15 +1,15 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-logs.adoc +// * virt/logging_events_monitoring/virt-logs.adoc -[id="cnv-viewing-virtual-machine-logs-web_{context}"] +[id="virt-viewing-virtual-machine-logs-web_{context}"] = Viewing virtual machine logs in the web console Get virtual machine logs from the associated virtual machine launcher Pod. .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machines*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machines*. . Click the virtual machine to open the *Virtual Machine Details* panel. . In the *Overview* tab, click the `virt-launcher-` Pod in the *POD* section. diff --git a/modules/cnv-viewing-vm-events-web.adoc b/modules/virt-viewing-vm-events-web.adoc similarity index 84% rename from modules/cnv-viewing-vm-events-web.adoc rename to modules/virt-viewing-vm-events-web.adoc index 2ec34bc05b..fc32bf0017 100644 --- a/modules/cnv-viewing-vm-events-web.adoc +++ b/modules/virt-viewing-vm-events-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_logging_events_monitoring/cnv-events.adoc +// * virt/logging_events_monitoring/virt-events.adoc -[id="cnv-viewing-vm-events-web_{context}"] +[id="virt-viewing-vm-events-web_{context}"] = Viewing the events for a virtual machine in the web console You can view the stream events for a running a virtual machine from the diff --git a/modules/cnv-viewing-vmi-ip-cli.adoc b/modules/virt-viewing-vmi-ip-cli.adoc similarity index 90% rename from modules/cnv-viewing-vmi-ip-cli.adoc rename to modules/virt-viewing-vmi-ip-cli.adoc index d867905617..d274777e36 100644 --- a/modules/cnv-viewing-vmi-ip-cli.adoc +++ b/modules/virt-viewing-vmi-ip-cli.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-viewing-ip-of-vm-vnic.adoc +// * virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-vnic.adoc -[id="cnv-viewing-vmi-ip-cli_{context}"] +[id="virt-viewing-vmi-ip-cli_{context}"] = Viewing the IP address of a virtual machine interface in the CLI The network interface configuration is included in the `oc describe vmi ` command. diff --git a/modules/cnv-viewing-vmi-ip-web.adoc b/modules/virt-viewing-vmi-ip-web.adoc similarity index 66% rename from modules/cnv-viewing-vmi-ip-web.adoc rename to modules/virt-viewing-vmi-ip-web.adoc index ba56f3a511..da7738a586 100644 --- a/modules/cnv-viewing-vmi-ip-web.adoc +++ b/modules/virt-viewing-vmi-ip-web.adoc @@ -1,15 +1,15 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-viewing-ip-of-vm-nic.adoc +// * virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-nic.adoc -[id="cnv-viewing-vmi-ip-web_{context}"] +[id="virt-viewing-vmi-ip-web_{context}"] = Viewing the IP address of a virtual machine interface in the web console The IP information displays in the *Virtual Machine Overview* screen for the virtual machine. .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machines*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machines*. . Click the virtual machine name to open the *Virtual Machine Overview* screen. The information for each attached NIC is displayed under *IP ADDRESSES*. diff --git a/modules/cnv-virtctl-commands.adoc b/modules/virt-virtctl-commands.adoc similarity index 88% rename from modules/cnv-virtctl-commands.adoc rename to modules/virt-virtctl-commands.adoc index d3f8c52ef7..cccd43d572 100644 --- a/modules/cnv-virtctl-commands.adoc +++ b/modules/virt-virtctl-commands.adoc @@ -1,13 +1,13 @@ // Module included in the following assemblies: // -// * cnv/cnv-using-the-cli-tools.adoc +// * virt/virt-using-the-cli-tools.adoc -[id="cnv-virtctl-commands_{context}"] +[id="virt-virtctl-commands_{context}"] = Virtctl client commands -The `virtctl` client is a command-line utility for managing {CNVProductName} +The `virtctl` client is a command-line utility for managing {VirtProductName} resources. The following table contains the `virtctl` commands used throughout -the {CNVProductName} documentation. + +the {VirtProductName} documentation. + [NOTE] ==== To view a list of options that you can use with a command, run it with the `-h` or `--help` flag. For example: @@ -55,4 +55,3 @@ the specified port of the node. |`virtctl image-upload dv --size= --image-path=` |Upload a virtual machine image to a new DataVolume. |=== - diff --git a/modules/cnv-vm-console-web.adoc b/modules/virt-vm-console-web.adoc similarity index 92% rename from modules/cnv-vm-console-web.adoc rename to modules/virt-vm-console-web.adoc index 68d2609fa5..17f44fd0d4 100644 --- a/modules/cnv-vm-console-web.adoc +++ b/modules/virt-vm-console-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +// * virt/virtual_machines/virt-accessing-vm-consoles.adoc -[id="cnv-vm-console-web_{context}"] +[id="virt-vm-console-web_{context}"] = Virtual machine console sessions You can connect to the VNC and serial consoles of a running virtual machine from diff --git a/modules/cnv-vm-create-nic-web.adoc b/modules/virt-vm-create-nic-web.adoc similarity index 70% rename from modules/cnv-vm-create-nic-web.adoc rename to modules/virt-vm-create-nic-web.adoc index 1f7c8a87b2..d5c9374e5b 100644 --- a/modules/cnv-vm-create-nic-web.adoc +++ b/modules/virt-vm-create-nic-web.adoc @@ -1,15 +1,15 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv_vm_networking/cnv-attaching-vm-multiple-networks.adoc +// * virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc -[id="cnv-vm-create-nic-web_{context}"] +[id="virt-vm-create-nic-web_{context}"] = Creating a NIC for a virtual machine Create and attach additional NICs to a virtual machine from the web console. .Procedure -. In the correct project in the {CNVProductName} console, click *Workloads* -> *Virtual Machines*. +. In the correct project in the {VirtProductName} console, click *Workloads* -> *Virtual Machines*. . Select a virtual machine. . Click *Network Interfaces* to display the NICs already attached to the virtual machine. . Click *Create Network Interface* to create a new slot in the list. diff --git a/modules/cnv-vm-rdp-console-web.adoc b/modules/virt-vm-rdp-console-web.adoc similarity index 87% rename from modules/cnv-vm-rdp-console-web.adoc rename to modules/virt-vm-rdp-console-web.adoc index 08e3980083..9db3874f7c 100644 --- a/modules/cnv-vm-rdp-console-web.adoc +++ b/modules/virt-vm-rdp-console-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +// * virt/virtual_machines/virt-accessing-vm-consoles.adoc -[id="cnv-vm-rdp-console-web_{context}"] +[id="virt-vm-rdp-console-web_{context}"] = Connecting to the RDP console The desktop viewer console, which utilizes the Remote Desktop Protocol (RDP), @@ -23,7 +23,7 @@ Windows virtual machine. .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machines*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machines*. . Select a Windows virtual machine. . Click the *Consoles* tab. . Click the *Consoles* list and select *Desktop Viewer*. diff --git a/modules/cnv-vm-serial-console-web.adoc b/modules/virt-vm-serial-console-web.adoc similarity index 68% rename from modules/cnv-vm-serial-console-web.adoc rename to modules/virt-vm-serial-console-web.adoc index 3f26c35509..5e558b8f58 100644 --- a/modules/cnv-vm-serial-console-web.adoc +++ b/modules/virt-vm-serial-console-web.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-accessing-vm-consoles.adoc +// * virt/virtual_machines/virt-accessing-vm-consoles.adoc -[id="cnv-vm-serial-console-web_{context}"] +[id="virt-vm-serial-console-web_{context}"] = Connecting to the serial console Connect to the *Serial Console* of a running virtual machine from the *Consoles* @@ -10,7 +10,7 @@ tab in the *Virtual Machine Details* screen of the web console. .Procedure -. In the {CNVProductName} console, click *Workloads* -> *Virtual Machines*. +. In the {VirtProductName} console, click *Workloads* -> *Virtual Machines*. . Select a virtual machine. . Click *Consoles*. The VNC console opens by default. . Click the *VNC Console* drop-down list and select *Serial Console*. diff --git a/modules/cnv-vm-storage-volume-types.adoc b/modules/virt-vm-storage-volume-types.adoc similarity index 96% rename from modules/cnv-vm-storage-volume-types.adoc rename to modules/virt-vm-storage-volume-types.adoc index 5c714c791f..994c239519 100644 --- a/modules/cnv-vm-storage-volume-types.adoc +++ b/modules/virt-vm-storage-volume-types.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-create-vms.adoc +// * virt/virtual_machines/virt-create-vms.adoc -[id="cnv-vm-storage-volume-types_{context}"] +[id="virt-vm-storage-volume-types_{context}"] = Virtual machine storage volume types Virtual machine storage volume types are listed, as well as domain and volume settings. See the diff --git a/modules/cnv-vm-wizard-fields-web.adoc b/modules/virt-vm-wizard-fields-web.adoc similarity index 90% rename from modules/cnv-vm-wizard-fields-web.adoc rename to modules/virt-vm-wizard-fields-web.adoc index 48bbc2d009..1807f0b272 100644 --- a/modules/cnv-vm-wizard-fields-web.adoc +++ b/modules/virt-vm-wizard-fields-web.adoc @@ -1,13 +1,13 @@ // Module included in the following assemblies: // -// * cnv/cnv_virtual_machines/cnv-create-vms.adoc -// * cnv/cnv_virtual_machines/cnv_importing_vms/cnv-importing-vmware-vm.adoc -// * cnv/cnv_vm_templates/cnv-creating-vm-template.adoc +// * virt/virtual_machines/virt-create-vms.adoc +// * virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc +// * virt/vm_templates/virt-creating-vm-template.adoc // VM wizard includes additional options to VM template wizard // Call appropriate attribute in the assembly -[id="cnv-vm-wizard-fields-web_{context}"] +[id="virt-vm-wizard-fields-web_{context}"] ifdef::virtualmachine[] = Virtual machine wizard fields endif::[] diff --git a/modules/cnv-what-you-can-do-with-cnv.adoc b/modules/virt-what-you-can-do-with-virt.adoc similarity index 51% rename from modules/cnv-what-you-can-do-with-cnv.adoc rename to modules/virt-what-you-can-do-with-virt.adoc index 97901eff72..9558e3f3f6 100644 --- a/modules/cnv-what-you-can-do-with-cnv.adoc +++ b/modules/virt-what-you-can-do-with-virt.adoc @@ -1,15 +1,15 @@ // Module included in the following assemblies: // -// * cnv/cnv-about-cnv.adoc -// * cnv/cnv_release_notes/cnv-release-notes.adoc +// * virt/virt-about-virt.adoc +// * virt/virt_release_notes/virt-2-4-release-notes.adoc -[id="cnv-what-you-can-do-with-cnv_{context}"] -= What you can do with container-native virtualization +[id="virt-what-you-can-do-with-virt_{context}"] += What you can do with {VirtProductName} -{CNVProductNameStart} is an add-on to {product-title} that allows you to run and manage +{VirtProductName} is an add-on to {product-title} that allows you to run and manage virtual machine workloads alongside container workloads. -{CNVProductNameStart} adds new objects into your {product-title} cluster via Kubernetes +{VirtProductName} adds new objects into your {product-title} cluster via Kubernetes custom resources to enable virtualization tasks. These tasks include: * Creating and managing Linux and Windows virtual machines @@ -21,5 +21,4 @@ custom resources to enable virtualization tasks. These tasks include: An enhanced web console provides a graphical portal to manage these virtualized resources alongside the {product-title} cluster containers and infrastructure. -You can use {CNVProductName} with either the xref:../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#learn-about-ovn-kubernetes[OVN-Kubernetes] or the xref:../networking/openshift_sdn/about-openshift-sdn.adoc#about-openshift-sdn[OpenShiftSDN] network provider. - +You can use {VirtProductName} with either the xref:../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#learn-about-ovn-kubernetes[OVN-Kubernetes] or the xref:../networking/openshift_sdn/about-openshift-sdn.adoc#about-openshift-sdn[OpenShiftSDN] network provider. diff --git a/scripts/find_unused.py b/scripts/find_unused.py new file mode 100755 index 0000000000..dde54d290b --- /dev/null +++ b/scripts/find_unused.py @@ -0,0 +1,103 @@ +#!/usr/bin/env python + +""" +This script goes through and searches the OpenShift docs repository for any modules +that are not included in assemblies. + +__author__ = "Christian Huffman" +__version__ = "1 July, 2019" +""" + +from os.path import join +import argparse +import os +import shutil +import sys + +class FindUnused(): + unused_directory = "_unused_topics" # Edit this to adjust the target path. + modules_directory = "/modules" # Edit this to adjust the modules subdirectory + ignored_prefixes = ["virt","ossm"] # Add any prefixes to ignore here + + def __init__(self, args): + self.args = args + + def process(self): + """ + This function is responsible for obtaining the list of modules, the list of assemblies, + and then either moving or displaying any modules not being included. + """ + modules = {} + assemblies = [] + # Build up a dictionary from the elements in the modules subdirectory, storing their path as the value. + for root, directories, files in os.walk(self.args.path + self.modules_directory): + for filename in files: + for prefix in self.ignored_prefixes: + # Search through all provided prefixes. If one is found, skip including it. + if filename.startswith(prefix): + break + modules[filename] = os.path.join(root,filename) + # Since modules can also include other modules, we include them in the list of assemblies. + for root, directories, files in os.walk(self.args.path): + for filename in files: + if filename.endswith(".adoc"): + assemblies.append(os.path.join(root,filename)) + remaining_modules = self.check_assemblies(assemblies,modules) + # Determine if we should move the files or simply print the list + if self.args.move: + self.move_files(self.args.path,remaining_modules) + else: + for filename in remaining_modules: + print remaining_modules[filename] + + def check_assemblies(self,assemblies,modules): + """ + Because we can't modify dictionaries while they're being iterated over, we're + forced to create a new list to collect any files that are found. Once this process + completes, we then go through the original list and remove the found files. + + This process leaves us with a dictionary containing the unused files and their paths, + which is returned. + """ + included_modules = {} + for filename in assemblies: + currentfile = open(filename,"r") + for line in currentfile.readlines(): + for key in modules: + if key in line: + included_modules[key] = "" + currentfile.close() + for key in included_modules: + del modules[key] + return modules + + def move_files(self,root,remaining_modules): + """ + Goes through each path in the dictionary and moves it to "root/self.unused_directory/" + Once finished it prints out the total number of files moved. + """ + try: + for key in remaining_modules: + os.rename(remaining_modules[key],root + "/" + self.unused_directory + "/" + key) + print "Moved %d files" % len(remaining_modules) + except OSError as err: + print("Unable to move files: {0}".format(err)) + print("Target destination: " + self.unused_directory) + + +def main(): + usage = """ + Identifies any modules in the `/modules` directory and subdirectories + that are not currently included in any assembly or module. + """ + + parser = argparse.ArgumentParser(description=usage) + parser.add_argument('path', help="path to the root of the github repository.") + parser.add_argument('-m', dest='move', action='store_true', help="moves the files instead of displaying them.") + args = parser.parse_args() + + parser = FindUnused(args) + parser.process() + +if __name__ == "__main__": + main() diff --git a/virt/about-virt.adoc b/virt/about-virt.adoc new file mode 100644 index 0000000000..982725855b --- /dev/null +++ b/virt/about-virt.adoc @@ -0,0 +1,14 @@ +[id="virt-about-virt"] += About {VirtProductName} +include::modules/virt-document-attributes.adoc[] +:context: virt-about-virt +toc::[] + +Learn about {VirtProductName}'s capabilities and support scope. + +include::modules/virt-what-you-can-do-with-virt.adoc[leveloffset=+1] + +== {VirtProductName} support + +:FeatureName: {VirtProductName} +include::modules/technology-preview.adoc[leveloffset=+2] diff --git a/cnv/images b/virt/images similarity index 100% rename from cnv/images rename to virt/images diff --git a/cnv/cnv_install/images b/virt/install/images similarity index 100% rename from cnv/cnv_install/images rename to virt/install/images diff --git a/virt/install/installing-virt.adoc b/virt/install/installing-virt.adoc new file mode 100644 index 0000000000..a80d9aff19 --- /dev/null +++ b/virt/install/installing-virt.adoc @@ -0,0 +1,22 @@ +[id="installing-virt"] += Installing {VirtProductName} +include::modules/virt-document-attributes.adoc[] +:context: installing-virt +toc::[] + +Install {VirtProductName} to add virtualization functionality to your {product-title} +cluster. + +You can use the {product-title} {product-version} +xref:../../web_console/web-console.adoc#web-console-overview_web-console[web console] +to subscribe to and deploy the {VirtProductName} Operators. + +.Prerequisites +* {product-title} {product-version} + +:FeatureName: {VirtProductName} +include::modules/technology-preview.adoc[leveloffset=+1] + +include::modules/virt-subscribing-to-the-catalog.adoc[leveloffset=+1] + +include::modules/virt-deploying-virt.adoc[leveloffset=+1] diff --git a/cnv/cnv_install/modules b/virt/install/modules similarity index 100% rename from cnv/cnv_install/modules rename to virt/install/modules diff --git a/cnv/cnv_install/preparing-cluster-for-cnv.adoc b/virt/install/preparing-cluster-for-virt.adoc similarity index 68% rename from cnv/cnv_install/preparing-cluster-for-cnv.adoc rename to virt/install/preparing-cluster-for-virt.adoc index d2c875678c..793ddd175d 100644 --- a/cnv/cnv_install/preparing-cluster-for-cnv.adoc +++ b/virt/install/preparing-cluster-for-virt.adoc @@ -1,13 +1,13 @@ -[id="preparing-cluster-for-cnv"] -= Configuring your cluster for container-native virtualization -include::modules/cnv-document-attributes.adoc[] -:context: preparing-cluster-for-cnv +[id="preparing-cluster-for-virt"] += Configuring your cluster for {VirtProductName} +include::modules/virt-document-attributes.adoc[] +:context: preparing-cluster-for-virt toc::[] To obtain an evaluation version of {product-title}, download a trial from the {product-title} home page. -{CNVProductNameStart} works with {product-title} by default, however the following +{VirtProductName} works with {product-title} by default, however the following installation configurations are recommended: * The {product-title} cluster is installed on diff --git a/virt/install/uninstalling-virt.adoc b/virt/install/uninstalling-virt.adoc new file mode 100644 index 0000000000..218d0fc55f --- /dev/null +++ b/virt/install/uninstalling-virt.adoc @@ -0,0 +1,32 @@ +[id="uninstalling-virt"] += Uninstalling {VirtProductName} +include::modules/virt-document-attributes.adoc[] +:context: uninstalling-virt +toc::[] + +You can uninstall {VirtProductName} by using the {product-title} +xref:../../web_console/web-console.adoc#web-console-overview_web-console[web console]. + +.Prerequisites + +* You must have {VirtProductName} {VirtVersion} installed. +* You must delete all xref:../../virt/virtual_machines/virt-delete-vms.adoc#virt-delete-vm-web_virt-delete-vms[virtual machines], +xref:../../virt/virtual_machines/virt-deleting-vmis.adoc#virt-deleting-vmi_virt-deleting-vmis[virtual machine instances], +and xref:../../virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc#virt-deleting-dvs_virt-deleting-datavolumes[DataVolumes]. ++ +[IMPORTANT] +==== +Attempting to uninstall {VirtProductName} without deleting these objects +results in failure. +==== + +include::modules/virt-deleting-custom-resource.adoc[leveloffset=+1] + +include::modules/virt-deleting-catalog-subscription.adoc[leveloffset=+1] + +[NOTE] +==== +You can now delete the `openshift-cnv` namespace. +==== + +include::modules/deleting-a-namespace-using-the-web-console.adoc[leveloffset=+1] diff --git a/virt/install/virt-installing-virtctl.adoc b/virt/install/virt-installing-virtctl.adoc new file mode 100644 index 0000000000..b688695063 --- /dev/null +++ b/virt/install/virt-installing-virtctl.adoc @@ -0,0 +1,17 @@ +[id="virt-installing-virtctl"] += Installing the `virtctl` client +include::modules/virt-document-attributes.adoc[] +:context: virt-installing-virtctl +toc::[] + +The `virtctl` client is a command-line utility for managing {VirtProductName} +resources. + +Install the client to your system by enabling the {VirtProductName} repository and +installing the `kubevirt-virtctl` package. + +include::modules/virt-enabling-virt-repos.adoc[leveloffset=+1] +include::modules/virt-installing-virtctl-client.adoc[leveloffset=+1] + +See also: +xref:../../virt/virt-using-the-cli-tools.adoc#virt-using-the-cli-tools[Using the CLI tools] for {VirtProductName}. diff --git a/cnv/cnv_live_migration/images b/virt/live_migration/images similarity index 100% rename from cnv/cnv_live_migration/images rename to virt/live_migration/images diff --git a/cnv/cnv_live_migration/modules b/virt/live_migration/modules similarity index 100% rename from cnv/cnv_live_migration/modules rename to virt/live_migration/modules diff --git a/cnv/cnv_live_migration/cnv-cancel-vmi-migration.adoc b/virt/live_migration/virt-cancel-vmi-migration.adoc similarity index 52% rename from cnv/cnv_live_migration/cnv-cancel-vmi-migration.adoc rename to virt/live_migration/virt-cancel-vmi-migration.adoc index 4eeaa4b15e..5cd90f1aae 100644 --- a/cnv/cnv_live_migration/cnv-cancel-vmi-migration.adoc +++ b/virt/live_migration/virt-cancel-vmi-migration.adoc @@ -1,8 +1,8 @@ -[id="cnv-cancel-vmi-migration"] +[id="virt-cancel-vmi-migration"] = Cancelling the live migration of a virtual machine instance -include::modules/cnv-document-attributes.adoc[] +include::modules/virt-document-attributes.adoc[] include::modules/common-attributes.adoc[] -:context: cnv-cancel-vmi-migration +:context: virt-cancel-vmi-migration toc::[] Cancel the live migration so that the virtual machine instance remains @@ -10,6 +10,6 @@ on the original node. You can cancel a live migration from either the web console or the CLI. -include::modules/cnv-cancelling-vm-migration-web.adoc[leveloffset=+1] -include::modules/cnv-cancelling-vm-migration-cli.adoc[leveloffset=+1] +include::modules/virt-cancelling-vm-migration-web.adoc[leveloffset=+1] +include::modules/virt-cancelling-vm-migration-cli.adoc[leveloffset=+1] diff --git a/cnv/cnv_live_migration/cnv-configuring-vmi-eviction-strategy.adoc b/virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc similarity index 57% rename from cnv/cnv_live_migration/cnv-configuring-vmi-eviction-strategy.adoc rename to virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc index 91e8b474f1..bf34d13cd3 100644 --- a/cnv/cnv_live_migration/cnv-configuring-vmi-eviction-strategy.adoc +++ b/virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc @@ -1,7 +1,7 @@ -[id="cnv-configuring-vmi-eviction-strategy"] +[id="virt-configuring-vmi-eviction-strategy"] = Configuring virtual machine eviction strategy -include::modules/cnv-document-attributes.adoc[] -:context: cnv-configuring-vmi-eviction-strategy +include::modules/virt-document-attributes.adoc[] +:context: virt-configuring-vmi-eviction-strategy toc::[] The `LiveMigrate` eviction strategy ensures that a virtual machine instance is @@ -9,4 +9,4 @@ not interrupted if the node is placed into maintenance or drained. Virtual machines instances with this eviction strategy will be live migrated to another node. -include::modules/cnv-configuring-vm-live-migration-cli.adoc[leveloffset=+1] +include::modules/virt-configuring-vm-live-migration-cli.adoc[leveloffset=+1] diff --git a/virt/live_migration/virt-live-migration-limits.adoc b/virt/live_migration/virt-live-migration-limits.adoc new file mode 100644 index 0000000000..92fafe0813 --- /dev/null +++ b/virt/live_migration/virt-live-migration-limits.adoc @@ -0,0 +1,14 @@ +[id="virt-live-migration-limits"] += Live migration limits and timeouts +include::modules/virt-document-attributes.adoc[] +:context: virt-live-migration-limits +toc::[] + +Live migration limits and timeouts are applied so that migration processes do +not overwhelm the cluster. Configure these settings by editing the +`kubevirt-config` configuration file. + +include::modules/virt-configuring-live-migration-limits.adoc[leveloffset=+1] +include::modules/virt-live-migration-limits-reftable.adoc[leveloffset=+1] + + diff --git a/virt/live_migration/virt-live-migration.adoc b/virt/live_migration/virt-live-migration.adoc new file mode 100644 index 0000000000..d7843e6c1d --- /dev/null +++ b/virt/live_migration/virt-live-migration.adoc @@ -0,0 +1,13 @@ +[id="virt-live-migration"] += Virtual machine live migration +include::modules/virt-document-attributes.adoc[] +:context: virt-live-migration +toc::[] + +include::modules/virt-understanding-live-migration.adoc[leveloffset=+1] + +.Additional resources: + +* xref:../../virt/live_migration/virt-migrate-vmi.adoc#virt-migrate-vmi[Migrating a virtual machine instance to another node] +* xref:../../virt/node_maintenance/virt-node-maintenance.adoc#virt-node-maintenance[Node maintenance mode] +* xref:../../virt/live_migration/virt-live-migration-limits.adoc#virt-live-migration-limits[Live migration limiting] diff --git a/virt/live_migration/virt-migrate-vmi.adoc b/virt/live_migration/virt-migrate-vmi.adoc new file mode 100644 index 0000000000..8bfe7fe78d --- /dev/null +++ b/virt/live_migration/virt-migrate-vmi.adoc @@ -0,0 +1,17 @@ +[id="virt-migrate-vmi"] += Migrating a virtual machine instance to another node +include::modules/virt-document-attributes.adoc[] +include::modules/common-attributes.adoc[] +:context: virt-migrate-vmi +toc::[] + +Manually initiate a live migration of a virtual machine instance to another node using either the web console or the CLI. + +include::modules/virt-initiating-vm-migration-web.adoc[leveloffset=+1] +include::modules/virt-initiating-vm-migration-cli.adoc[leveloffset=+1] + +.Additional resources: + +* xref:../../virt/live_migration/virt-monitor-vmi-migration.adoc#virt-monitor-vmi-migration[Monitoring live migration of a virtual machine instance] +* xref:../../virt/live_migration/virt-cancel-vmi-migration.adoc#virt-cancel-vmi-migration[Cancelling the live migration of a virtual machine instance] + diff --git a/virt/live_migration/virt-monitor-vmi-migration.adoc b/virt/live_migration/virt-monitor-vmi-migration.adoc new file mode 100644 index 0000000000..1d170b28ec --- /dev/null +++ b/virt/live_migration/virt-monitor-vmi-migration.adoc @@ -0,0 +1,11 @@ +[id="virt-monitor-vmi-migration"] += Monitoring live migration of a virtual machine instance +include::modules/virt-document-attributes.adoc[] +:context: virt-monitor-vmi-migration +toc::[] + +You can monitor the progress of a live migration of a virtual machine instance from either the web console or the CLI. + +include::modules/virt-monitoring-vm-migration-web.adoc[leveloffset=+1] +include::modules/virt-monitoring-vm-migration-cli.adoc[leveloffset=+1] + diff --git a/cnv/cnv_logging_events_monitoring/images b/virt/logging_events_monitoring/images similarity index 100% rename from cnv/cnv_logging_events_monitoring/images rename to virt/logging_events_monitoring/images diff --git a/cnv/cnv_logging_events_monitoring/modules b/virt/logging_events_monitoring/modules similarity index 100% rename from cnv/cnv_logging_events_monitoring/modules rename to virt/logging_events_monitoring/modules diff --git a/cnv/cnv_logging_events_monitoring/cnv-collecting-cnv-data.adoc b/virt/logging_events_monitoring/virt-collecting-virt-data.adoc similarity index 62% rename from cnv/cnv_logging_events_monitoring/cnv-collecting-cnv-data.adoc rename to virt/logging_events_monitoring/virt-collecting-virt-data.adoc index 378a0caf83..c8c3fbcda7 100644 --- a/cnv/cnv_logging_events_monitoring/cnv-collecting-cnv-data.adoc +++ b/virt/logging_events_monitoring/virt-collecting-virt-data.adoc @@ -1,7 +1,7 @@ -[id="cnv-collecting-cnv-data"] -= Collecting container-native virtualization data for Red Hat Support -include::modules/cnv-document-attributes.adoc[] -:context: cnv-collecting-cnv-data +[id="virt-collecting-virt-data"] += Collecting {VirtProductName} data for Red Hat Support +include::modules/virt-document-attributes.adoc[] +:context: virt-collecting-virt-data toc::[] When opening a support case, it is helpful to provide debugging @@ -9,17 +9,17 @@ information about your cluster to Red Hat Support. The `must-gather` tool enables you to collect diagnostic information about your {product-title} cluster, including virtual machines and other data related to -{CNVProductName}. +{VirtProductName}. For prompt support, supply diagnostic information for both {product-title} -and {CNVProductName}. +and {VirtProductName}. -:FeatureName: {CNVProductNameStart} +:FeatureName: {VirtProductName} include::modules/technology-preview.adoc[leveloffset=+1] include::modules/about-must-gather.adoc[leveloffset=+1] -include::modules/cnv-about-collecting-cnv-data.adoc[leveloffset=+1] +include::modules/virt-about-collecting-virt-data.adoc[leveloffset=+1] include::modules/gathering-data-specific-features.adoc[leveloffset=+1] diff --git a/virt/logging_events_monitoring/virt-events.adoc b/virt/logging_events_monitoring/virt-events.adoc new file mode 100644 index 0000000000..cfa168240a --- /dev/null +++ b/virt/logging_events_monitoring/virt-events.adoc @@ -0,0 +1,17 @@ +[id="virt-events"] += Viewing events +include::modules/virt-document-attributes.adoc[] +:context: virt-events +toc::[] + +include::modules/virt-understanding-events.adoc[leveloffset=+1] + +See also: +xref:../../nodes/clusters/nodes-containers-events.adoc#nodes-containers-events[Viewing system event information in an {product-title} cluster]. + +include::modules/virt-viewing-vm-events-web.adoc[leveloffset=+1] + +include::modules/virt-viewing-namespace-events-cli.adoc[leveloffset=+1] + +include::modules/virt-viewing-resource-events-cli.adoc[leveloffset=+1] + diff --git a/virt/logging_events_monitoring/virt-logs.adoc b/virt/logging_events_monitoring/virt-logs.adoc new file mode 100644 index 0000000000..ce99e014cf --- /dev/null +++ b/virt/logging_events_monitoring/virt-logs.adoc @@ -0,0 +1,11 @@ +[id="virt-logs"] += Viewing virtual machine logs +include::modules/virt-document-attributes.adoc[] +:context: virt-logs +toc::[] + +include::modules/virt-understanding-logs.adoc[leveloffset=+1] + +include::modules/virt-viewing-virtual-machine-logs-cli.adoc[leveloffset=+1] + +include::modules/virt-viewing-virtual-machine-logs-web.adoc[leveloffset=+1] diff --git a/virt/logging_events_monitoring/virt-monitoring-vm-health.adoc b/virt/logging_events_monitoring/virt-monitoring-vm-health.adoc new file mode 100644 index 0000000000..e482943ab8 --- /dev/null +++ b/virt/logging_events_monitoring/virt-monitoring-vm-health.adoc @@ -0,0 +1,13 @@ +[id="virt-monitoring-vm-health"] += Monitoring virtual machine health +include::modules/virt-document-attributes.adoc[] +:context: virt-monitoring-vm-health +toc::[] + +Use this procedure to create liveness and readiness probes +to monitor virtual machine health. + +include::modules/virt-about-liveness-readiness-probes.adoc[leveloffset=+1] +include::modules/virt-define-http-liveness-probe.adoc[leveloffset=+1] +include::modules/virt-define-tcp-liveness-probe.adoc[leveloffset=+1] +include::modules/virt-define-readiness-probe.adoc[leveloffset=+1] diff --git a/cnv/cnv_logging_events_monitoring/cnv-openshift-cluster-monitoring.adoc b/virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc similarity index 87% rename from cnv/cnv_logging_events_monitoring/cnv-openshift-cluster-monitoring.adoc rename to virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc index f38bf45f62..944be2779f 100644 --- a/cnv/cnv_logging_events_monitoring/cnv-openshift-cluster-monitoring.adoc +++ b/virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc @@ -1,7 +1,7 @@ -[id="cnv-openshift-cluster-monitoring"] +[id="virt-openshift-cluster-monitoring"] = {product-title} cluster monitoring, logging, and Telemetry -include::modules/cnv-document-attributes.adoc[] -:context: cnv-openshift-cluster-monitoring +include::modules/virt-document-attributes.adoc[] +:context: virt-openshift-cluster-monitoring toc::[] {product-title} provides various resources for monitoring at the cluster level. diff --git a/cnv/cnv_logging_events_monitoring/cnv-using-dashboard-to-get-cluster-info.adoc b/virt/logging_events_monitoring/virt-using-dashboard-to-get-cluster-info.adoc similarity index 62% rename from cnv/cnv_logging_events_monitoring/cnv-using-dashboard-to-get-cluster-info.adoc rename to virt/logging_events_monitoring/virt-using-dashboard-to-get-cluster-info.adoc index f8fb20a73f..12361ab492 100644 --- a/cnv/cnv_logging_events_monitoring/cnv-using-dashboard-to-get-cluster-info.adoc +++ b/virt/logging_events_monitoring/virt-using-dashboard-to-get-cluster-info.adoc @@ -1,11 +1,11 @@ -[id="cnv-using-dashboard-to-get-cluster-info"] +[id="virt-using-dashboard-to-get-cluster-info"] = Using the {product-title} dashboard to get cluster information -include::modules/cnv-document-attributes.adoc[] -:context: cnv-using-dashboard-to-get-cluster-info +include::modules/virt-document-attributes.adoc[] +:context: virt-using-dashboard-to-get-cluster-info toc::[] Access the {product-title} dashboard, which captures high-level information about the cluster, by clicking *Home > Dashboards > Overview* from the {product-title} web console. The {product-title} dashboard provides various cluster information, captured in individual dashboard _cards_. -include::modules/cnv-about-the-overview-dashboard.adoc[leveloffset=+1] +include::modules/virt-about-the-overview-dashboard.adoc[leveloffset=+1] diff --git a/virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc b/virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc new file mode 100644 index 0000000000..3d82967f3c --- /dev/null +++ b/virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc @@ -0,0 +1,9 @@ +[id="virt-viewing-information-about-vm-workloads"] += Viewing information about virtual machine workloads +include::modules/virt-document-attributes.adoc[] +:context: virt-viewing-information-about-vm-workloads +toc::[] + +You can view high-level information about your virtual machines by using the *Virtual Machines* dashboard in the {product-title} web console. + +include::modules/virt-about-the-vm-dashboard.adoc[leveloffset=+1] diff --git a/cnv/modules b/virt/modules similarity index 100% rename from cnv/modules rename to virt/modules diff --git a/cnv/cnv_node_maintenance/images b/virt/node_maintenance/images similarity index 100% rename from cnv/cnv_node_maintenance/images rename to virt/node_maintenance/images diff --git a/cnv/cnv_node_maintenance/modules b/virt/node_maintenance/modules similarity index 100% rename from cnv/cnv_node_maintenance/modules rename to virt/node_maintenance/modules diff --git a/virt/node_maintenance/virt-node-maintenance.adoc b/virt/node_maintenance/virt-node-maintenance.adoc new file mode 100644 index 0000000000..936c25db62 --- /dev/null +++ b/virt/node_maintenance/virt-node-maintenance.adoc @@ -0,0 +1,12 @@ +[id="virt-node-maintenance"] += Node maintenance mode +include::modules/virt-document-attributes.adoc[] +:context: virt-node-maintenance +toc::[] + +include::modules/virt-understanding-node-maintenance.adoc[leveloffset=+1] + +.Additional resources: + +* xref:../../virt/live_migration/virt-live-migration.adoc#virt-live-migration[Virtual machine live migration] +* xref:../../virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc#virt-configuring-vmi-eviction-strategy[Configuring virtual machine eviction strategy] diff --git a/virt/node_maintenance/virt-refresh-certificates.adoc b/virt/node_maintenance/virt-refresh-certificates.adoc new file mode 100644 index 0000000000..2b88e28fd1 --- /dev/null +++ b/virt/node_maintenance/virt-refresh-certificates.adoc @@ -0,0 +1,12 @@ +[id="virt-refresh-certificates"] += Manually refreshing TLS certificates +include::modules/virt-document-attributes.adoc[] +include::modules/common-attributes.adoc[] +:context: virt-refresh-certificates +toc::[] + +The TLS certificates for {VirtProductName} components are created at the time +of installation and are valid for one year. You must manually refresh +these certificates before they expire. + +include::modules/virt-refreshing-certificates.adoc[leveloffset=+1] diff --git a/virt/node_maintenance/virt-resuming-node.adoc b/virt/node_maintenance/virt-resuming-node.adoc new file mode 100644 index 0000000000..7c1b756509 --- /dev/null +++ b/virt/node_maintenance/virt-resuming-node.adoc @@ -0,0 +1,14 @@ +[id="virt-resuming-node"] += Resuming a node from maintenance mode +include::modules/virt-document-attributes.adoc[] +include::modules/common-attributes.adoc[] +:context: virt-resuming-node +toc::[] + +Resuming a node brings it out of maintenance mode and schedulable again. + +Resume a node from maintenance from either the web console or the CLI. + +include::modules/virt-resuming-node-maintenance-web.adoc[leveloffset=+1] +include::modules/virt-resuming-node-maintenance-cli.adoc[leveloffset=+1] + diff --git a/virt/node_maintenance/virt-setting-node-maintenance.adoc b/virt/node_maintenance/virt-setting-node-maintenance.adoc new file mode 100644 index 0000000000..4c6ba4bd05 --- /dev/null +++ b/virt/node_maintenance/virt-setting-node-maintenance.adoc @@ -0,0 +1,18 @@ +[id="virt-setting-node-maintenance"] += Setting a node to maintenance mode +include::modules/virt-document-attributes.adoc[] +include::modules/common-attributes.adoc[] +:context: virt-setting-node-maintenance +toc::[] + +include::modules/virt-understanding-node-maintenance.adoc[leveloffset=+1] + +Place a node into maintenance from either the web console or the CLI. + +include::modules/virt-setting-node-maintenance-web.adoc[leveloffset=+1] +include::modules/virt-setting-node-maintenance-cli.adoc[leveloffset=+1] + +.Additional resources: + +* xref:../../virt/node_maintenance/virt-resuming-node.adoc#virt-resuming-node[Resuming a node from maintenance mode] + diff --git a/cnv/cnv_node_network/images b/virt/node_network/images similarity index 100% rename from cnv/cnv_node_network/images rename to virt/node_network/images diff --git a/cnv/cnv_node_network/modules b/virt/node_network/modules similarity index 100% rename from cnv/cnv_node_network/modules rename to virt/node_network/modules diff --git a/virt/node_network/virt-observing-node-network-state.adoc b/virt/node_network/virt-observing-node-network-state.adoc new file mode 100644 index 0000000000..3e4fe77833 --- /dev/null +++ b/virt/node_network/virt-observing-node-network-state.adoc @@ -0,0 +1,14 @@ +[id="virt-observing-node-network-state"] += Observing node network state +include::modules/virt-document-attributes.adoc[] +:context: virt-observing-node-network-state +toc::[] + +Node network state is the network configuration for all nodes in the cluster. + +include::modules/virt-about-nmstate.adoc[leveloffset=+1] + +include::modules/virt-viewing-network-state-of-node.adoc[leveloffset=+1] + + + diff --git a/cnv/cnv_node_network/cnv-troubleshooting-node-network.adoc b/virt/node_network/virt-troubleshooting-node-network.adoc similarity index 62% rename from cnv/cnv_node_network/cnv-troubleshooting-node-network.adoc rename to virt/node_network/virt-troubleshooting-node-network.adoc index d51cbbaa1c..d78482cbf9 100644 --- a/cnv/cnv_node_network/cnv-troubleshooting-node-network.adoc +++ b/virt/node_network/virt-troubleshooting-node-network.adoc @@ -1,7 +1,7 @@ -[id="cnv-troubleshooting-node-network"] +[id="virt-troubleshooting-node-network"] = Troubleshooting node network configuration -include::modules/cnv-document-attributes.adoc[] -:context: cnv-troubleshooting-node-network +include::modules/virt-document-attributes.adoc[] +:context: virt-troubleshooting-node-network toc::[] If the node network configuration encounters an issue, the Policy is automatically rolled back and the Enactments report failure. @@ -11,5 +11,5 @@ This includes issues such as: * The host loses connection to the default gateway. * The host loses connection to the API server. -include::modules/cnv-troubleshooting-incorrect-policy-config.adoc[leveloffset=+1] +include::modules/virt-troubleshooting-incorrect-policy-config.adoc[leveloffset=+1] diff --git a/virt/node_network/virt-updating-node-network-config.adoc b/virt/node_network/virt-updating-node-network-config.adoc new file mode 100644 index 0000000000..51d3bfc15e --- /dev/null +++ b/virt/node_network/virt-updating-node-network-config.adoc @@ -0,0 +1,25 @@ +[id="virt-updating-node-network"] += Updating node network configuration +include::modules/virt-document-attributes.adoc[] +:context: virt-updating-node-network-config +toc::[] + +You can update the node network configuration, such as adding or removing interfaces +from nodes, by applying `NodeNetworkConfigurationPolicy` manifests to the cluster. + +include::modules/virt-about-nmstate.adoc[leveloffset=+1] + +include::modules/virt-creating-interface-on-nodes.adoc[leveloffset=+1] + +include::modules/virt-confirming-policy-updates-on-nodes.adoc[leveloffset=+1] + +include::modules/virt-removing-interface-from-nodes.adoc[leveloffset=+1] + +include::modules/virt-restoring-node-network-configuration.adoc[leveloffset=+1] + +include::modules/virt-example-bridge-nncp.adoc[leveloffset=+1] + +include::modules/virt-example-vlan-nncp.adoc[leveloffset=+1] + +include::modules/virt-example-bond-nncp.adoc[leveloffset=+1] + diff --git a/virt/upgrading-virt.adoc b/virt/upgrading-virt.adoc new file mode 100644 index 0000000000..4aa27bb0cd --- /dev/null +++ b/virt/upgrading-virt.adoc @@ -0,0 +1,21 @@ +[id="upgrading-virt"] += Upgrading {VirtProductName} +include::modules/virt-document-attributes.adoc[] +:context: upgrading-virt +toc::[] + +You can manually upgrade to the next minor version of {VirtProductName} and +monitor the status of an update by using the web console. + +:FeatureName: {VirtProductName} +include::modules/technology-preview.adoc[leveloffset=+1] + +include::modules/virt-about-upgrading-virt.adoc[leveloffset=+1] + +include::modules/virt-upgrading-virt.adoc[leveloffset=+1] + +include::modules/virt-monitoring-upgrade-status.adoc[leveloffset=+1] + +.Additional information + +* xref:../operators/understanding_olm/olm-understanding-olm.adoc#olm-csv_olm-understanding-olm[ClusterServiceVersions (CSVs)] diff --git a/cnv/cnv_release_notes/cnv-2-4-release-notes.adoc b/virt/virt-2-3-release-notes.adoc similarity index 71% rename from cnv/cnv_release_notes/cnv-2-4-release-notes.adoc rename to virt/virt-2-3-release-notes.adoc index bf88f21a13..1e902dc17e 100644 --- a/cnv/cnv_release_notes/cnv-2-4-release-notes.adoc +++ b/virt/virt-2-3-release-notes.adoc @@ -1,22 +1,22 @@ -[id="cnv-2-4-release-notes"] +[id="virt-2-3-release-notes"] = {RN_BookName} -include::modules/cnv-document-attributes.adoc[] -:context: cnv-release-notes +include::modules/virt-document-attributes.adoc[] +:context: virt-release-notes toc::[] -== About {CNVProductName} {CNVVersion} +== About {VirtProductName} {VirtVersion} -include::modules/cnv-what-you-can-do-with-cnv.adoc[leveloffset=+2] +include::modules/virt-what-you-can-do-with-virt.adoc[leveloffset=+2] -=== {CNVProductNameStart} support +=== {VirtProductName} support -:FeatureName: {CNVProductNameStart} +:FeatureName: {VirtProductName} include::modules/technology-preview.adoc[leveloffset=+2] -[id="cnv-2-4-new"] +[id="virt-2-4-new"] == New and changed features -* {CNVProductNameStart} is certified in Microsoft's Windows Server +* {VirtProductName} is certified in Microsoft's Windows Server Virtualization Validation Program (SVVP) to run Windows Server workloads. ** SVVP Certification applies to Intel and AMD CPUs. ** link:https://www.windowsservercatalog.com/item.aspx?idItem=b3c14590-2d36-300c-1c03-c0c23c8229e7&bCatID=1521&qos=2000000000[SVVP Certificate] Red Hat Enterprise Linux CoreOS 8 workers are named _Red Hat OpenShift @@ -24,23 +24,23 @@ Container Platform 4 on RHEL CoreOS 8_. * New templates are available that are compatible with Microsoft Windows 10. -[id="cnv-2-4-networking-new"] +[id="virt-2-4-networking-new"] === Networking -* You can now use {CNVProductName} with either the xref:../../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#learn-about-ovn-kubernetes[OVN-Kubernetes] or the xref:../../networking/openshift_sdn/about-openshift-sdn.adoc#about-openshift-sdn[OpenShiftSDN] network provider. +* You can now use {VirtProductName} with either the xref:../../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#learn-about-ovn-kubernetes[OVN-Kubernetes] or the xref:../../networking/openshift_sdn/about-openshift-sdn.adoc#about-openshift-sdn[OpenShiftSDN] network provider. -* {CNVProductNameStart} uses link:https://nmstate.github.io/[`nmstate`] to report on and configure the state of the node network. You can now modify network policy configuration, such as creating or removing Linux bridges, bonds, and VLAN devices on all nodes, by applying a single configuration manifest to the cluster. +* {VirtProductName} uses link:https://nmstate.github.io/[`nmstate`] to report on and configure the state of the node network. You can now modify network policy configuration, such as creating or removing Linux bridges, bonds, and VLAN devices on all nodes, by applying a single configuration manifest to the cluster. -** For more information, see the xref:../../cnv/cnv_node_network/cnv-observing-node-network-state.adoc#cnv-about-nmstate_cnv-observing-node-network-state[node networking] chapter. +** For more information, see the xref:../../virt/node_network/virt-observing-node-network-state.adoc#virt-about-nmstate_virt-observing-node-network-state[node networking] chapter. -[id="cnv-2-4-storage-new"] +[id="virt-2-4-storage-new"] === Storage * You can now import, upload, and clone virtual machine disks into namespaces that are subject to CPU and memory resource restrictions. -* The `virtctl` tool can now monitor server-side upload post-processing asynchronously and more accurately reports the status of xref:../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-uploading-local-disk-images-virtctl.adoc#cnv-uploading-local-disk-images-virtctl[virtual machine disk uploads]. +* The `virtctl` tool can now monitor server-side upload post-processing asynchronously and more accurately reports the status of xref:../../virt/virtual_machines/virt_virtual_disks/virt-uploading-local-disk-images-virtctl.adoc#virt-uploading-local-disk-images-virtctl[virtual machine disk uploads]. -[id="cnv-2-4-web-new"] +[id="virt-2-4-web-new"] === Web console * You can now view the *Paused* status of a virtual machine in the web console. The web console displays this status on the *Virtual Machines* dashboard and on the *Virtual Machine Details* page. + @@ -53,64 +53,64 @@ $ oc get vmi testvm -o=jsonpath='{.status.conditions[?(@.type=="Paused")].messag ---- ==== -* If a virtual machine has a status of *Paused*, you can now xref:../../cnv/cnv_virtual_machines/cnv-controlling-vm-states.html#cnv-unpausing-vm-web_cnv-controlling-vm-states[unpause it from the +* If a virtual machine has a status of *Paused*, you can now xref:../../virt/virtual_machines/virt-controlling-vm-states.html#virt-unpausing-vm-web_virt-controlling-vm-states[unpause it from the web console]. * You can view and manage virtual machine instances that are independent of virtual machines within the virtual machine lists. -* {CNVProductNameStart} enables you to configure a CD-ROM in the xref:../../cnv/cnv_virtual_machines/cnv-create-vms.adoc#cnv-creating-vm-wizard-web_cnv-create-vms[virtual machine wizard]. You can select the type of CD-ROM configuration from a drop-down list: *Container*, *URL* or *Attach Disk*. You can also xref:../../cnv/cnv_virtual_machines/cnv-edit-vms.adoc#cnv-vm-edit-cdrom_cnv-edit-vms[edit CD-ROM configurations] in the *Virtual Machine Details* page. +* {VirtProductName} enables you to configure a CD-ROM in the xref:../../virt/virtual_machines/virt-create-vms.adoc#virt-creating-vm-wizard-web_virt-create-vms[virtual machine wizard]. You can select the type of CD-ROM configuration from a drop-down list: *Container*, *URL* or *Attach Disk*. You can also xref:../../virt/virtual_machines/virt-edit-vms.adoc#virt-vm-edit-cdrom_virt-edit-vms[edit CD-ROM configurations] in the *Virtual Machine Details* page. -* The xref:../../cnv/cnv_virtual_machines/cnv-edit-boot-order.adoc#cnv-edit-boot-order[boot order list] is now available in the *Virtual Machine Details*. You can add items, remove items, and modify the boot order list. +* The xref:../../virt/virtual_machines/virt-edit-boot-order.adoc#virt-edit-boot-order[boot order list] is now available in the *Virtual Machine Details*. You can add items, remove items, and modify the boot order list. * The virtual machine and virtual machine template wizards now validate CPU and memory sizes and disk bus requirements for different operating systems. If you attempt to create a virtual machine or virtual machine template that does not meet the requirements for a particular operating system, the wizard raises a resource warning. -* You can now view and configure xref:../../cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-dedicated-resources-vm.adoc#cnv-dedicated-resources-vm[dedicated resources for virtual machines] in +* You can now view and configure xref:../../virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc#virt-dedicated-resources-vm[dedicated resources for virtual machines] in the *Virtual Machine Details* page. When you enable dedicated resources, you ensure that your virtual machine's workload runs on CPUs that are not used by other processes. This can improve your virtual machine's performance and the accuracy of latency predictions. -[id="cnv-2-4-changes"] +[id="virt-2-4-changes"] == Notable technical changes -* You must deploy {CNVProductName} in a single namespace that is named +* You must deploy {VirtProductName} in a single namespace that is named `openshift-cnv`. If it does not already exist, the `openshift-cnv` namespace is now automatically created during deployment. * To prevent errors, you can no longer rename the *CNV Operator Deployment* custom -resource that you create during {CNVProductName} deployment. If you try to create +resource that you create during {VirtProductName} deployment. If you try to create a custom resource that is not named `kubevirt-hyperconverged`, which is the default name, creation fails and an error message displays in the web console. -* To prevent unintentional data loss, you can no longer uninstall {CNVProductName} if your cluster has a virtual machine or DataVolume defined. -** You must manually delete all xref:../../cnv/cnv_virtual_machines/cnv-delete-vms.adoc#cnv-delete-vm-web_cnv-delete-vms[virtual machines] (VMs), -xref:../../cnv/cnv_virtual_machines/cnv-deleting-vmis.adoc#cnv-deleting-vmi_cnv-deleting-vmis[virtual machine instances] (VMIs), -and xref:../../cnv/cnv_virtual_machines/cnv_virtual_disks/cnv-deleting-datavolumes.adoc#cnv-deleting-dvs_cnv-deleting-datavolumes[DataVolumes] (DVs) -before uninstalling {CNVProductName}. +* To prevent unintentional data loss, you can no longer uninstall {VirtProductName} if your cluster has a virtual machine or DataVolume defined. +** You must manually delete all xref:../../virt/virtual_machines/virt-delete-vms.adoc#virt-delete-vm-web_virt-delete-vms[virtual machines] (VMs), +xref:../../virt/virtual_machines/virt-deleting-vmis.adoc#virt-deleting-vmi_virt-deleting-vmis[virtual machine instances] (VMIs), +and xref:../../virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc#virt-deleting-dvs_virt-deleting-datavolumes[DataVolumes] (DVs) +before uninstalling {VirtProductName}. ** If VM, VMI, or DV objects are present when you attempt to uninstall -{CNVProductName}, the uninstallation process does not complete until you remove +{VirtProductName}, the uninstallation process does not complete until you remove the remaining objects. + [NOTE] ==== To confirm that uninstallation is paused due to a pending object, view the -xref:../../cnv/cnv_logging_events_monitoring/cnv-events.adoc#cnv-viewing-vm-events-web_cnv-events[*Events*] tab. +xref:../../virt/logging_events_monitoring/virt-events.adoc#virt-viewing-vm-events-web_virt-events[*Events*] tab. ==== -[id="cnv-2-4-known-issues"] +[id="virt-2-4-known-issues"] == Known issues -* KubeMacPool is disabled in {CNVProductName} {CNVVersion}. This means that a secondary +* KubeMacPool is disabled in {VirtProductName} {VirtVersion}. This means that a secondary interface of a Pod or virtual machine obtains a randomly generated MAC address rather than a unique one from a pool. Although rare, randomly assigned MAC addresses can conflict. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1816971[*BZ#1816971*]) -* Sometimes, when attempting to edit the subscription channel of the *{CNVProductNameStart} Operator* in the web console, clicking the +* Sometimes, when attempting to edit the subscription channel of the *{VirtProductName} Operator* in the web console, clicking the *Channel* button of the *Subscription Overview* results in a JavaScript error. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1796410[*BZ#1796410*]) -** As a workaround, trigger the upgrade process to {CNVProductName} {CNVVersion} +** As a workaround, trigger the upgrade process to {VirtProductName} {VirtVersion} from the CLI by running the following `oc` patch command: + ---- @@ -135,7 +135,7 @@ $ oc patch storageclass -p '{"metadata": {"annotations": {" ---- * If you renamed the Operator deployment custom resource when you deployed -an earlier version of {CNVProductName}, you cannot upgrade directly to {CNVProductName} {CNVVersion}. +an earlier version of {VirtProductName}, you cannot upgrade directly to {VirtProductName} {VirtVersion}. The custom resource must be named `kubevirt-hyperconverged`, which is the default name. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1822266[*BZ#1822266*]) @@ -250,17 +250,17 @@ virtualization, where virtual machines could be successfully launched on Haswell + As a workaround, select a different CPU model, if possible. -* The {CNVProductName} upgrade process occasionally fails due to an interruption +* The {VirtProductName} upgrade process occasionally fails due to an interruption from the Operator Lifecycle Manager (OLM). This issue is caused by the limitations -associated with using a declarative API to track the state of {CNVProductName} +associated with using a declarative API to track the state of {VirtProductName} Operators. Enabling automatic updates during -xref:../cnv_install/installing-container-native-virtualization.adoc#cnv-subscribing-to-the-catalog_installing-container-native-virtualization[installation] +xref:../install/installing-container-native-virtualization.adoc#virt-subscribing-to-the-catalog_installing-container-native-virtualization[installation] decreases the risk of encountering this issue. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1759612[*BZ#1759612*]) -* {CNVProductNameStart} cannot reliably identify node drains that are triggered by +* {VirtProductName} cannot reliably identify node drains that are triggered by running either `oc adm drain` or `kubectl drain`. Do not run these commands on -the nodes of any clusters where {CNVProductName} is deployed. The nodes might not +the nodes of any clusters where {VirtProductName} is deployed. The nodes might not drain if there are virtual machines running on top of them. The current solution is to put nodes into maintenance. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1707427[*BZ#1707427*]) @@ -271,7 +271,7 @@ page and click the current upgrade channel to edit it, there might be no visible If this occurs, there are no visible errors. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1796410[*BZ#1796410*]) + -** As a workaround, trigger the upgrade process to {CNVProductName} {CNVVersion} +** As a workaround, trigger the upgrade process to {VirtProductName} {VirtVersion} from the CLI by running the following `oc` patch command: + ---- diff --git a/virt/virt-2-4-release-notes.adoc b/virt/virt-2-4-release-notes.adoc new file mode 100644 index 0000000000..fc8b3674e0 --- /dev/null +++ b/virt/virt-2-4-release-notes.adoc @@ -0,0 +1,211 @@ +[id="virt-release-notes"] += {RN_BookName} +include::modules/virt-document-attributes.adoc[] +:context: virt-release-notes +toc::[] + +== About {VirtProductName} {VirtVersion} + +include::modules/virt-what-you-can-do-with-virt.adoc[leveloffset=+2] + +=== {VirtProductName} support + +:FeatureName: {VirtProductName} +include::modules/technology-preview.adoc[leveloffset=+2] + +== New and changed features + +* Managing virtual machines is simpler and more efficient due to improvements +in design and workflow. You can now: +** Run the virtual machine wizard with less navigation. The wizard now uses +a comprehensive in-page style and includes a review page for confirming +configuration details before submission. +** Import a single VMware virtual machine with less navigation. +** Edit virtual machine templates as well as virtual machine configurations. +** Monitor health of virtual machine-backed services as you would for +Pod-based services. +** Enable persistent local storage for virtual machine images. +** Add, edit, and view virtual CD-ROM devices attached to a virtual machine. +** Add and view network attachment definitions with a graphical editor. + +== Resolved issues + +* Previously, when you added a disk to a virtual machine via the *Disks* tab in +the web console, the added disk had a `Filesystem` volumeMode regardless of the +volumeMode set in the `kubevirt-storage-class-default` ConfigMap. This issue has been fixed. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1753688[*BZ#1753688*]) + +* Previously, when navigating to the *Virtual Machines Console* tab, +sometimes no content was displayed. This issue has been fixed. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1753606[*BZ#1753606*]) + +* Previously, attempting to list all instances of the {VirtProductName} operator +from a browser resulted in a 404 (page not found) error. +This issue has been fixed. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1757526[*BZ#1757526*]) + +* Previously, if a virtual machine used guaranteed CPUs, it was not scheduled +because the label `cpumanager=true` was not automatically set on nodes. +This issue has been fixed. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1718944[*BZ#1718944*]) + +== Known issues + +* If you have {VirtProductName} 2.1.0 deployed, you must first upgrade {VirtProductName} +to 2.2.0 before upgrading {product-title}. Upgrading {product-title} before upgrading +{VirtProductName} might trigger virtual machine deletion. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1785661[*BZ#1785661*]) + +// Don't remove: this BZ is probably true for all 2.x releases +* The `masquerade` binding method for virtual machines cannot be used in clusters with RHEL 7 compute nodes. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1741626[*BZ#1741626*]) + +* After migration, a virtual machine is assigned a new IP address. However, the +commands `oc get vmi` and `oc describe vmi` still generate output containing the +obsolete IP address. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1686208[*BZ#1686208*]) ++ +** As a workaround, view the correct IP address by running the following command: ++ +---- +$ oc get pod -o wide +---- + +* Some resources are improperly retained when removing {VirtProductName}. You +must manually remove these resources in order to reinstall {VirtProductName}. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1712429[*BZ#1712429*]) + +* Users without administrator privileges cannot add a network interface +to a project in an L2 network using the virtual machine wizard. +This issue is caused by missing permissions that allow users to load +network attachment definitions. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1743985[*BZ#1743985*]) ++ +** As a workaround, provide the user with permissions to load the network attachment +definitions. ++ +. Define `ClusterRole` and `ClusterRoleBinding` objects to the YAML configuration +file, using the following examples: ++ +[source,yaml] +---- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: cni-resources +rules: +- apiGroups: ["k8s.cni.cncf.io"] + resources: ["*"] + verbs: ["*"] +---- ++ +[source,yaml] +---- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRoleBinding +metadata: + name: +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: cni-resources +subjects: +- kind: User + name: + namespace: +---- ++ +. As a `cluster-admin` user, run the following command to create the `ClusterRole` +and `ClusterRoleBinding` objects you defined: ++ +---- +$ oc create -f .yaml +---- + +* Live migration fails when nodes have different CPU models. Even in cases where +nodes have the same physical CPU model, differences introduced by microcode +updates have the same effect. This is because the default settings trigger +host CPU passthrough behavior, which is incompatible with live migration. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1760028[*BZ#1760028*]) ++ +** As a workaround, set the default CPU model in the `kubevirt-config` ConfigMap, +as shown in the following example: ++ +[NOTE] +==== +You must make this change before starting the virtual machines that support +live migration. +==== ++ +. Open the `kubevirt-config` ConfigMap for editing by running the following command: ++ +---- +$ oc edit configmap kubevirt-config -n openshift-cnv +---- ++ +. Edit the ConfigMap: ++ +[source,yaml] +---- +kind: ConfigMap +metadata: + name: kubevirt-config +data: + default-cpu-model: "" <1> +---- +<1> Replace `` with the actual CPU model value. You can determine this +value by running `oc describe node ` for all nodes and looking at the +`cpu-model-` labels. Select the CPU model that is present on all of your +nodes. + +* When running `virtctl image-upload` to upload large VM disk images in `qcow2` +format, an end-of-file (EOF) error may be reported after the data is +transmitted, even though the upload is either progressing normally or completed. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1789093[*BZ#1789093*]) ++ +Run the following command to check the status of an upload on a given PVC: ++ +---- +$ oc describe pvc | grep cdi.kubevirt.io/storage.pod.phase +---- + +* When attempting to create and launch a virtual machine using a Haswell CPU, +the launch of the virtual machine can fail due to incorrectly labeled nodes. +This is a change in behavior from previous versions of {VirtProductName}, +where virtual machines could be successfully launched on Haswell hosts. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1781497[*BZ#1781497*]) ++ +As a workaround, select a different CPU model, if possible. + +* If you select a directory that shares space with your operating system, +you can potentially exhaust the space on the partition, causing the node to +be non-functional. Instead, create a separate partition +and point the hostpath provisioner to that partition so it will not +interfere with your operating system. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1793132[*BZ#1793132*]) + +* The {VirtProductName} upgrade process occasionally fails due to an interruption +from the Operator Lifecycle Manager (OLM). This issue is caused by the limitations +associated with using a declarative API to track the state of {VirtProductName} +Operators. Enabling automatic updates during +xref:install/installing-virt.adoc#virt-subscribing-to-the-catalog_installing-virt[installation] +decreases the risk of encountering this issue. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1759612[*BZ#1759612*]) + +* {VirtProductName} cannot reliably identify node drains that are triggered by +running either `oc adm drain` or `kubectl drain`. Do not run these commands on +the nodes of any clusters where {VirtProductName} is deployed. The nodes might not +drain if there are virtual machines running on top of them. +The current solution is to put nodes into maintenance. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1707427[*BZ#1707427*]) + +* If you navigate to the *Subscription* tab on the *Operators* -> *Installed Operators* +page and click the current upgrade channel to edit it, there might be no visible results. +If this occurs, there are no visible errors. +(link:https://bugzilla.redhat.com/show_bug.cgi?id=1796410[*BZ#1796410*]) ++ +** As a workaround, trigger the upgrade process to {VirtProductName} {VirtVersion} +from the CLI by running the following `oc` patch command: ++ +---- +$ TARGET_NAMESPACE=openshift-cnv HCO_CHANNEL=2.2 oc patch -n "${TARGET_NAMESPACE}" $(oc get subscription -n ${TARGET_NAMESPACE} --no-headers -o name) --type='json' -p='[{"op": "replace", "path": "/spec/channel", "value":"${HCO_CHANNEL}"}, {"op": "replace", "path": "/spec/installPlanApproval", "value":"Automatic"}]' +---- ++ +This command points your subscription to upgrade channel `2.2` and enables automatic updates. diff --git a/virt/virt-using-the-cli-tools.adoc b/virt/virt-using-the-cli-tools.adoc new file mode 100644 index 0000000000..e37d75d227 --- /dev/null +++ b/virt/virt-using-the-cli-tools.adoc @@ -0,0 +1,20 @@ +[id="virt-using-the-cli-tools"] += Using the CLI tools +include::modules/virt-document-attributes.adoc[] +:context: virt-using-the-cli-tools +toc::[] + +The two primary CLI tools used for managing resources in the cluster are: + +* The {VirtProductName} `virtctl` client +* The {product-title} `oc` client + +.Prerequisites + +* You must xref:../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[install the `virtctl` client]. + +include::modules/virt-virtctl-commands.adoc[leveloffset=+1] +include::modules/virt-openshift-client-commands.adoc[leveloffset=+1] + +For more comprehensive information on `oc` client commands, see the +xref:../cli_reference/openshift_cli/developer-cli-commands.adoc#cli_reference[{product-title} CLI tools] documentation. diff --git a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/images b/virt/virtual_machines/advanced_vm_management/images similarity index 100% rename from cnv/cnv_virtual_machines/cnv_advanced_vm_management/images rename to virt/virtual_machines/advanced_vm_management/images diff --git a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/modules b/virt/virtual_machines/advanced_vm_management/modules similarity index 100% rename from cnv/cnv_virtual_machines/cnv_advanced_vm_management/modules rename to virt/virtual_machines/advanced_vm_management/modules diff --git a/virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc b/virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc new file mode 100644 index 0000000000..77503aace2 --- /dev/null +++ b/virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc @@ -0,0 +1,19 @@ +[id="virt-automating-management-tasks"] += Automating management tasks +include::modules/virt-document-attributes.adoc[] +:context: virt-automating-management-tasks +toc::[] + +You can automate {VirtProductName} management tasks by using Red Hat Ansible +Automation Platform. Learn the basics by using an Ansible Playbook to create a new +virtual machine. + +include::modules/virt-about-red-hat-ansible-automation.adoc[leveloffset=+1] + +include::modules/virt-automating-virtual-machine-creation-with-ansible.adoc[leveloffset=+1] + +To verify that the virtual machine was created, try to +xref:../../../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-accessing-vm-consoles[access the VM console]. + +include::modules/virt-example-ansible-playbook-creating-vms.adoc[leveloffset=+1] + diff --git a/virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc b/virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc new file mode 100644 index 0000000000..e2c2daaf71 --- /dev/null +++ b/virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc @@ -0,0 +1,23 @@ +[id="configuring-pxe-booting"] += Configuring PXE booting for virtual machines +include::modules/virt-document-attributes.adoc[] +:context: pxe-booting +toc::[] + +PXE booting, or network booting, is available in {VirtProductName}. +Network booting allows a computer to boot and load an +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. + +.Prerequisites + +* A Linux bridge must be xref:../../../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#attaching-to-multiple-networks[connected]. + +* The PXE server must be connected to the same VLAN as the bridge. + +include::modules/virt-networking-glossary.adoc[leveloffset=+1] + +include::modules/virt-pxe-booting-with-mac-address.adoc[leveloffset=+1] + +include::modules/virt-template-vmi-pxe-config.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-dedicated-resources-vm.adoc b/virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc similarity index 60% rename from cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-dedicated-resources-vm.adoc rename to virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc index 9147ac45a9..299ce82b83 100644 --- a/cnv/cnv_virtual_machines/cnv_advanced_vm_management/cnv-dedicated-resources-vm.adoc +++ b/virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc @@ -1,13 +1,13 @@ -[id="cnv-dedicated-resources-vm"] +[id="virt-dedicated-resources-vm"] = Enabling dedicated resources for virtual machines -include::modules/cnv-document-attributes.adoc[] -:context: cnv-dedicated-resources-vm +include::modules/virt-document-attributes.adoc[] +:context: virt-dedicated-resources-vm toc::[] Virtual machines can have resources of a node, such as CPU, dedicated to them in order to improve performance. -include::modules/cnv-about-dedicated-resources.adoc[leveloffset=+1] +include::modules/virt-about-dedicated-resources.adoc[leveloffset=+1] .Prerequisites @@ -16,4 +16,4 @@ xref:../../../scalability_and_performance/using-cpu-manager.adoc[CPU Manager] m be configured on the node. Verify that the node has the `cpumanager` = `true` label before scheduling virtual machine workloads. -include::modules/cnv-enabling-dedicated-resources.adoc[leveloffset=+1] +include::modules/virt-enabling-dedicated-resources.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc b/virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc new file mode 100644 index 0000000000..11f382f0a2 --- /dev/null +++ b/virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc @@ -0,0 +1,17 @@ +[id="virt-managing-guest-memory"] += Managing guest memory +include::modules/virt-document-attributes.adoc[] +:context: virt-managing-guest-memory +toc::[] + +If you want to adjust guest memory settings to suit a specific use case, you can +do so by editing the guest's YAML configuration file. {VirtProductName} allows you +to configure guest memory overcommitment and disable guest memory overhead +accounting. + +Both of these procedures carry some degree of risk. Proceed only if you are +an experienced administrator. + +include::modules/virt-configuring-guest-memory-overcommitment.adoc[leveloffset=+1] + +include::modules/virt-disabling-guest-memory-overhead-accounting.adoc[leveloffset=+1] \ No newline at end of file diff --git a/cnv/cnv_virtual_machines/cnv_cloning_vms/images b/virt/virtual_machines/cloning_vms/images similarity index 100% rename from cnv/cnv_virtual_machines/cnv_cloning_vms/images rename to virt/virtual_machines/cloning_vms/images diff --git a/cnv/cnv_virtual_machines/cnv_cloning_vms/modules b/virt/virtual_machines/cloning_vms/modules similarity index 100% rename from cnv/cnv_virtual_machines/cnv_cloning_vms/modules rename to virt/virtual_machines/cloning_vms/modules diff --git a/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc b/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc new file mode 100644 index 0000000000..9f935a59ea --- /dev/null +++ b/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc @@ -0,0 +1,31 @@ +[id="virt-cloning-vm-disk-into-new-datavolume-block"] += Cloning a virtual machine disk into a new block storage DataVolume +include::modules/virt-document-attributes.adoc[] +:context: virt-cloning-vm-disk-into-new-datavolume-block +toc::[] + +You can clone the PersistentVolumeClaim (PVC) of a virtual machine disk into +a new block DataVolume by referencing the source PVC in your DataVolume configuration +file. + +.Prerequisites + +* If you require scratch space according to the +xref:#virt-cdi-supported-operations-matrix_virt-cloning-vm-disk-into-new-datavolume-block[CDI supported operations matrix], you must first +xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass-in-cdi-configuration_virt-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] +for this operation to complete successfully. + +* Users need xref:../../../virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc#virt-enabling-user-permissions-to-clone-datavolumes[additional permissions] to clone the PVC of a virtual machine disk into another namespace. + +:blockstorage: +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-about-block-pvs.adoc[leveloffset=+1] + +include::modules/virt-creating-local-block-pv.adoc[leveloffset=+1] + +include::modules/virt-cloning-pvc-of-vm-disk-into-new-datavolume.adoc[leveloffset=+1] + +include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1] + +:blockstorage!: diff --git a/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc b/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc new file mode 100644 index 0000000000..8e9c29ec7f --- /dev/null +++ b/virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc @@ -0,0 +1,26 @@ +[id="virt-cloning-vm-disk-into-new-datavolume"] += Cloning a virtual machine disk into a new DataVolume +include::modules/virt-document-attributes.adoc[] +:context: virt-cloning-vm-disk-into-new-datavolume +toc::[] + +You can clone the PersistentVolumeClaim (PVC) of a virtual machine disk into +a new DataVolume by referencing the source PVC in your DataVolume configuration +file. + +.Prerequisites + +* You may need to xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass-in-cdi-configuration_virt-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] +for this operation to complete successfully. The +xref:#virt-cdi-supported-operations-matrix_virt-cloning-vm-disk-into-new-datavolume[CDI supported operations matrix] +shows the conditions that require scratch space. + +* Users need xref:../../../virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc#virt-enabling-user-permissions-to-clone-datavolumes[additional permissions] to clone the PVC of a virtual machine disk into another namespace. + +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-cloning-pvc-of-vm-disk-into-new-datavolume.adoc[leveloffset=+1] + +include::modules/virt-template-datavolume-clone.adoc[leveloffset=+1] + +include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc b/virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc new file mode 100644 index 0000000000..240189968a --- /dev/null +++ b/virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc @@ -0,0 +1,27 @@ +[id="virt-cloning-vm-using-datavolumetemplate"] += Cloning a virtual machine by using a DataVolumeTemplate +include::modules/virt-document-attributes.adoc[] +:context: virt-cloning-vm-using-datavolumetemplate +toc::[] + +You can create a new virtual machine by cloning the PersistentVolumeClaim (PVC) of +an existing VM. By including a `dataVolumeTemplate` in your virtual machine +configuration file, you create a new DataVolume from the original PVC. + +.Prerequisites + +* You may need to xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass-in-cdi-configuration_virt-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] +for this operation to complete successfully. The +xref:#virt-cdi-supported-operations-matrix_virt-cloning-vm-using-datavolumetemplate[CDI supported operations matrix] +shows the conditions that require scratch space. + +* Users need xref:../../../virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc#virt-enabling-user-permissions-to-clone-datavolumes[additional permissions] to clone the PVC of a virtual machine disk into another namespace. + +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-creating-new-vm-from-cloned-pvc-using-datavolumetemplate.adoc[leveloffset=+1] + +include::modules/virt-template-datavolume-vm.adoc[leveloffset=+1] + +include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1] + diff --git a/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-enabling-user-permissions-to-clone-datavolumes.adoc b/virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc similarity index 66% rename from cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-enabling-user-permissions-to-clone-datavolumes.adoc rename to virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc index 5771d0acbb..12198d21f1 100644 --- a/cnv/cnv_virtual_machines/cnv_cloning_vms/cnv-enabling-user-permissions-to-clone-datavolumes.adoc +++ b/virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc @@ -1,7 +1,7 @@ -[id="cnv-enabling-user-permissions-to-clone-datavolumes"] +[id="virt-enabling-user-permissions-to-clone-datavolumes"] = Enabling user permissions to clone DataVolumes across namespaces -include::modules/cnv-document-attributes.adoc[] -:context: cnv-enabling-user-permissions-to-clone-datavolumes +include::modules/virt-document-attributes.adoc[] +:context: virt-enabling-user-permissions-to-clone-datavolumes toc::[] The isolating nature of namespaces means that users cannot by default @@ -17,8 +17,8 @@ to the destination namespace. * Only a user with the xref:../../../authentication/using-rbac.adoc#default-roles_using-rbac[`cluster-admin`] role can create ClusterRoles. -include::modules/cnv-about-datavolumes.adoc[leveloffset=+1] +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] -include::modules/cnv-creating-rbac-cloning-dvs.adoc[leveloffset=+1] +include::modules/virt-creating-rbac-cloning-dvs.adoc[leveloffset=+1] diff --git a/cnv/cnv_release_notes/images b/virt/virtual_machines/images similarity index 100% rename from cnv/cnv_release_notes/images rename to virt/virtual_machines/images diff --git a/cnv/cnv_virtual_machines/cnv_importing_vms/images b/virt/virtual_machines/importing_vms/images similarity index 100% rename from cnv/cnv_virtual_machines/cnv_importing_vms/images rename to virt/virtual_machines/importing_vms/images diff --git a/cnv/cnv_virtual_machines/cnv_importing_vms/modules b/virt/virtual_machines/importing_vms/modules similarity index 100% rename from cnv/cnv_virtual_machines/cnv_importing_vms/modules rename to virt/virtual_machines/importing_vms/modules diff --git a/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc b/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc new file mode 100644 index 0000000000..e97d89154d --- /dev/null +++ b/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc @@ -0,0 +1,39 @@ +[id="virt-importing-virtual-machine-images-datavolumes-block"] += Importing virtual machine images to block storage with DataVolumes +include::modules/virt-document-attributes.adoc[] +:context: virt-importing-virtual-machine-images-datavolumes-block +toc::[] + +You can import an existing virtual machine image into your {product-title} +cluster. {VirtProductName} uses DataVolumes to automate the import of data and the +creation of an underlying PersistentVolumeClaim (PVC). + +[CAUTION] +==== +When you import a disk image into a PVC, the disk image is +expanded to use the full storage capacity that is requested in the PVC. To use +this space, the disk partitions and file system(s) in the virtual machine +might need to be expanded. + +The resizing procedure varies based on the operating system that is installed on the virtual machine. +Refer to the operating system documentation for details. +==== + +.Prerequisites + +* If you require scratch space according to the +xref:#virt-cdi-supported-operations-matrix_virt-importing-virtual-machine-images-datavolumes-block[CDI supported operations matrix], you must first +xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass-in-cdi-configuration_virt-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] +for this operation to complete successfully. + +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-about-block-pvs.adoc[leveloffset=+1] + +include::modules/virt-creating-local-block-pv.adoc[leveloffset=+1] + +include::modules/virt-importing-vm-to-block-pv.adoc[leveloffset=+1] + +include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1] + + diff --git a/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc b/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc new file mode 100644 index 0000000000..1f8b45b2e2 --- /dev/null +++ b/virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc @@ -0,0 +1,39 @@ +[id="virt-importing-virtual-machine-images-datavolumes"] += Importing virtual machine images with DataVolumes +include::modules/virt-document-attributes.adoc[] +:context: virt-importing-virtual-machine-images-datavolumes +toc::[] + +You can import an existing virtual machine image into your {product-title} +cluster. {VirtProductName} uses DataVolumes to automate the import of data and the +creation of an underlying PersistentVolumeClaim (PVC). + +[CAUTION] +==== +When you import a disk image into a PVC, the disk image is +expanded to use the full storage capacity that is requested in the PVC. To use +this space, the disk partitions and file system(s) in the virtual machine +might need to be expanded. + +The resizing procedure varies based on the operating system installed on the VM. +Refer to the operating system documentation for details. +==== + +.Prerequisites + +* If the endpoint requires a TLS certificate, the certificate must be +xref:../../../virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc#virt-adding-tls-certificates-for-authenticating-dv-imports_virt-tls-certificates-for-dv-imports[included in a ConfigMap] +in the same namespace as the DataVolume and referenced in the DataVolume configuration. + +* You may need to xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass-in-cdi-configuration_virt-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] +for this operation to complete successfully. + +include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1] + +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-importing-vm-datavolume.adoc[leveloffset=+1] + +include::modules/virt-template-datavolume-vm.adoc[leveloffset=+1] + +include::modules/virt-template-datavolume-import.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc b/virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc new file mode 100644 index 0000000000..8727bd177d --- /dev/null +++ b/virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc @@ -0,0 +1,34 @@ +[id="virt-importing-vmware-vm"] += Importing a VMware virtual machine or template +include::modules/virt-document-attributes.adoc[] +:context: virt-importing-vmware-vm +toc::[] + +You can import a single VMware virtual machine or template into your {product-title} cluster. + +If you import a VMware template, the wizard creates a virtual machine based on the template. + +:FeatureName: Importing a VMware virtual machine or template +include::modules/technology-preview.adoc[leveloffset=+1] +:!FeatureName: + +.Prerequisites + +* If you use NFS-backed storage for the 2 GB disk that is attached to the Conversion Pod, you must link:https://access.redhat.com/solutions/4982751[configure a hostPath volume]. + +include::modules/virt-creating-vddk-image.adoc[leveloffset=+1] +include::modules/virt-importing-vmware-vm.adoc[leveloffset=+1] + +Refer to the xref:virt-importing-vmware-vm-wizard-fields_virt-importing-vmware-vm[virtual machine wizard fields] section for more information on the wizard fields. + +include::modules/virt-updating-imported-vm-network-name.adoc[leveloffset=+1] +include::modules/virt-troubleshooting-vmware-vm-import.adoc[leveloffset=+1] + +[id="virt-importing-vmware-vm-wizard-fields_{context}"] +== Virtual machine wizard fields +:virtualmachine: +include::modules/virt-vm-wizard-fields-web.adoc[leveloffset=+2] +include::modules/virt-cloud-init-fields-web.adoc[leveloffset=+2] +include::modules/virt-networking-wizard-fields-web.adoc[leveloffset=+2] +include::modules/virt-storage-wizard-fields-web.adoc[leveloffset=+2] +:virtualmachine!: diff --git a/virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc b/virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc new file mode 100644 index 0000000000..6f9717f4b3 --- /dev/null +++ b/virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc @@ -0,0 +1,11 @@ +[id="virt-tls-certificates-for-dv-imports"] += TLS certificates for DataVolume imports +include::modules/virt-document-attributes.adoc[] +include::modules/common-attributes.adoc[] +:context: virt-tls-certificates-for-dv-imports +toc::[] + +include::modules/virt-adding-tls-certificates-for-authenticating-dv-imports.adoc[leveloffset=+1] +include::modules/virt-example-configmap-tls-certificate.adoc[leveloffset=+1] + + diff --git a/cnv/cnv_release_notes/modules b/virt/virtual_machines/modules similarity index 100% rename from cnv/cnv_release_notes/modules rename to virt/virtual_machines/modules diff --git a/virt/virtual_machines/virt-accessing-vm-consoles.adoc b/virt/virtual_machines/virt-accessing-vm-consoles.adoc new file mode 100644 index 0000000000..937460e3af --- /dev/null +++ b/virt/virtual_machines/virt-accessing-vm-consoles.adoc @@ -0,0 +1,33 @@ +[id="virt-accessing-vm-consoles"] += Accessing virtual machine consoles +include::modules/virt-document-attributes.adoc[] +:context: virt-accessing-vm-consoles +toc::[] + +{VirtProductName} provides different virtual machine consoles that you can +use to accomplish different product tasks. You can access these consoles through +the web console and by using CLI commands. + +include::modules/virt-vm-console-web.adoc[leveloffset=+1] + +[id="virt-accessing-vm-consoles-web"] +== Connecting to the virtual machine with the web console + +include::modules/virt-connecting-to-the-terminal.adoc[leveloffset=+2] + +include::modules/virt-vm-serial-console-web.adoc[leveloffset=+2] + +include::modules/virt-connecting-vnc-console.adoc[leveloffset=+2] + +include::modules/virt-vm-rdp-console-web.adoc[leveloffset=+2] + +[id="virt-accessing-vm-consoles-cli"] +== Accessing virtual machine consoles by using CLI commands + +include::modules/virt-accessing-vmi-ssh.adoc[leveloffset=+2] + +include::modules/virt-accessing-serial-console.adoc[leveloffset=+2] + +include::modules/virt-accessing-vnc-console.adoc[leveloffset=+2] + +include::modules/virt-accessing-rdp-console.adoc[leveloffset=+2] diff --git a/virt/virtual_machines/virt-controlling-vm-states.adoc b/virt/virtual_machines/virt-controlling-vm-states.adoc new file mode 100644 index 0000000000..9811ccbf5e --- /dev/null +++ b/virt/virtual_machines/virt-controlling-vm-states.adoc @@ -0,0 +1,21 @@ +[id="virt-controlling-vm-states"] += Controlling virtual machine states +include::modules/virt-document-attributes.adoc[] +:context: virt-controlling-vm-states +toc::[] + +You can stop, start, restart, and unpause virtual machines from the web console. + +[NOTE] +==== +To control virtual machines from the command-line interface (CLI), use the +xref:../../virt/virt-using-the-cli-tools.html#virt-using-the-cli-tools[`virtctl` client]. +==== + +include::modules/virt-starting-vm-web.adoc[leveloffset=+1] + +include::modules/virt-restarting-vm-web.adoc[leveloffset=+1] + +include::modules/virt-stopping-vm-web.adoc[leveloffset=+1] + +include::modules/virt-unpausing-vm-web.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virt-create-vms.adoc b/virt/virtual_machines/virt-create-vms.adoc new file mode 100644 index 0000000000..011280ec1a --- /dev/null +++ b/virt/virtual_machines/virt-create-vms.adoc @@ -0,0 +1,42 @@ +[id="virt-create-vms"] += Creating virtual machines +include::modules/virt-document-attributes.adoc[] +:context: virt-create-vms +toc::[] + + +Use one of these procedures to create a virtual machine: + +* Running the virtual machine wizard +* Pasting a pre-configured YAML file with the virtual machine wizard +* Using the CLI +* xref:../../virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc#virt-importing-vmware-vm[Importing a VMware virtual machine or template with the virtual machine wizard] + +[WARNING] +==== +Do not create virtual machines in `openshift-*` namespaces. +Instead, create a new namespace or use an existing namespace without the +`openshift` prefix. +==== + +include::modules/virt-creating-vm-wizard-web.adoc[leveloffset=+1] + +Refer to the virtual machine wizard fields section when running the web console wizard. + +:virtualmachine: +include::modules/virt-vm-wizard-fields-web.adoc[leveloffset=+2] +include::modules/virt-cloud-init-fields-web.adoc[leveloffset=+2] +include::modules/virt-cdrom-wizard-fields-web.adoc[leveloffset=+2] +include::modules/virt-networking-wizard-fields-web.adoc[leveloffset=+2] +include::modules/virt-storage-wizard-fields-web.adoc[leveloffset=+2] + +include::modules/virt-creating-vm-yaml-web.adoc[leveloffset=+1] +include::modules/virt-creating-vm.adoc[leveloffset=+1] + +:virtualmachine!: + +include::modules/virt-vm-storage-volume-types.adoc[leveloffset=+1] + +See the +https://kubevirt.io/api-reference/master/definitions.html#_v1_virtualmachinespec[kubevirt +API Reference] for a definitive list of virtual machine settings. diff --git a/virt/virtual_machines/virt-delete-vms.adoc b/virt/virtual_machines/virt-delete-vms.adoc new file mode 100644 index 0000000000..61154cfc2d --- /dev/null +++ b/virt/virtual_machines/virt-delete-vms.adoc @@ -0,0 +1,11 @@ +[id="virt-delete-vms"] += Deleting virtual machines +include::modules/virt-document-attributes.adoc[] +:context: virt-delete-vms +toc::[] + +You can delete a virtual machine from the web console or by using the `oc` +command-line interface. + +include::modules/virt-delete-vm-web.adoc[leveloffset=+1] +include::modules/virt-deleting-vms.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv-deleting-vmis.adoc b/virt/virtual_machines/virt-deleting-vmis.adoc similarity index 54% rename from cnv/cnv_virtual_machines/cnv-deleting-vmis.adoc rename to virt/virtual_machines/virt-deleting-vmis.adoc index 57470f90a7..1852b9df11 100644 --- a/cnv/cnv_virtual_machines/cnv-deleting-vmis.adoc +++ b/virt/virtual_machines/virt-deleting-vmis.adoc @@ -1,14 +1,14 @@ -[id="cnv-deleting-vmis"] +[id="virt-deleting-vmis "] = Deleting virtual machine instances -include::modules/cnv-document-attributes.adoc[] -:context: cnv-deleting-vmis +include::modules/virt-document-attributes.adoc[] +:context: virt-deleting-vmis toc::[] When you delete a virtual machine, the associated VMI is automatically deleted. To manually delete a virtual machine instance (VMI), use the `oc` command-line interface (CLI). + [NOTE] ==== -Use this procedure to check for and delete any outstanding VMIs before you uninstall {CNVProductName}. +Use this procedure to check for and delete any outstanding VMIs before you uninstall {VirtProductName}. ==== -include::modules/cnv-listing-vmis.adoc[leveloffset=+1] -include::modules/cnv-deleting-vmi.adoc[leveloffset=+1] \ No newline at end of file +include::modules/virt-listing-vmis.adoc[leveloffset=+1] +include::modules/virt-deleting-vmi.adoc[leveloffset=+1] \ No newline at end of file diff --git a/cnv/cnv_virtual_machines/cnv-edit-boot-order.adoc b/virt/virtual_machines/virt-edit-boot-order.adoc similarity index 54% rename from cnv/cnv_virtual_machines/cnv-edit-boot-order.adoc rename to virt/virtual_machines/virt-edit-boot-order.adoc index 0b9c2e14a3..a9899e188b 100644 --- a/cnv/cnv_virtual_machines/cnv-edit-boot-order.adoc +++ b/virt/virtual_machines/virt-edit-boot-order.adoc @@ -1,7 +1,7 @@ -[id="cnv-edit-boot-order"] +[id="virt-edit-boot-order"] = Editing boot order -include::modules/cnv-document-attributes.adoc[] -:context: cnv-edit-boot-order +include::modules/virt-document-attributes.adoc[] +:context: virt-edit-boot-order toc::[] You can update the values for a boot order list by using the web console or the CLI. @@ -12,7 +12,7 @@ With *Boot Order* in the *Virtual Machine Overview* page, you can: * Edit the order of the disks or NICs in the boot order list. * Remove a disk or NIC from the boot order list, and return it back to the inventory of bootable sources. -include::modules/cnv-add-boot-order-web.adoc[leveloffset=+1] -include::modules/cnv-edit-boot-order-web.adoc[leveloffset=+1] -include::modules/cnv-edit-boot-order-yaml-web.adoc[leveloffset=+1] -include::modules/cnv-remove-boot-order-item-web.adoc[leveloffset=+1] +include::modules/virt-add-boot-order-web.adoc[leveloffset=+1] +include::modules/virt-edit-boot-order-web.adoc[leveloffset=+1] +include::modules/virt-edit-boot-order-yaml-web.adoc[leveloffset=+1] +include::modules/virt-remove-boot-order-item-web.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virt-edit-vms.adoc b/virt/virtual_machines/virt-edit-vms.adoc new file mode 100644 index 0000000000..470ee3e3ce --- /dev/null +++ b/virt/virtual_machines/virt-edit-vms.adoc @@ -0,0 +1,16 @@ +[id="virt-edit-vms"] += Editing virtual machines +include::modules/virt-document-attributes.adoc[] +:context: virt-edit-vms +toc::[] + +You can update a virtual machine configuration using either the YAML editor in the +web console or the OpenShift client on the command line. You can also update +a subset of the parameters in the *Virtual Machine Overview* of the web console. + +include::modules/virt-editing-vm-web.adoc[leveloffset=+1] +include::modules/virt-editing-vm-yaml-web.adoc[leveloffset=+1] +include::modules/virt-editing-vm-cli.adoc[leveloffset=+1] +include::modules/virt-add-disk-to-vm.adoc[leveloffset=+1] +include::modules/virt-add-nic-to-vm.adoc[leveloffset=+1] +include::modules/virt-edit-cdrom-vm.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc b/virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc new file mode 100644 index 0000000000..a32eb602a3 --- /dev/null +++ b/virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc @@ -0,0 +1,17 @@ +[id="virt-installing-virtio-drivers-on-existing-windows-vm"] += Installing VirtIO driver on an existing Windows virtual machine +include::modules/virt-document-attributes.adoc[] +:context: virt-installing-virtio-drivers-on-existing-windows-vm +toc::[] + +include::modules/virt-understanding-virtio-drivers.adoc[leveloffset=+1] + +See also: xref:../../virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc#virt-installing-virtio-drivers-on-new-windows-vm[Installing Virtio drivers on a new Windows virtual machine]. + +include::modules/virt-supported-virtio-drivers.adoc[leveloffset=+1] + +include::modules/virt-adding-virtio-drivers-vm-yaml.adoc[leveloffset=+1] + +include::modules/virt-installing-virtio-drivers-existing-windows.adoc[leveloffset=+1] + +include::modules/virt-removing-virtio-disk-from-vm.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc b/virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc new file mode 100644 index 0000000000..a4775f0c68 --- /dev/null +++ b/virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc @@ -0,0 +1,23 @@ +[id="virt-installing-virtio-drivers-on-new-windows-vm"] += Installing VirtIO driver on a new Windows virtual machine +include::modules/virt-document-attributes.adoc[] +:context: virt-installing-virtio-drivers-on-new-windows-vm" +toc::[] + +.Prerequisites + +* Windows installation media accessible by the virtual machine, such as +xref:../../virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc#virt-importing-vm-datavolume_virt-importing-virtual-machine-images-datavolumes[importing an ISO into a data volume] +and attaching it to the virtual machine. + +include::modules/virt-understanding-virtio-drivers.adoc[leveloffset=+1] + +See also: xref:../../virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc#virt-installing-virtio-drivers-on-existing-windows-vm[Installing VirtIO driver on an existing Windows virtual machine]. + +include::modules/virt-supported-virtio-drivers.adoc[leveloffset=+1] + +include::modules/virt-adding-virtio-drivers-vm-yaml.adoc[leveloffset=+1] + +include::modules/virt-installing-virtio-drivers-installing-windows.adoc[leveloffset=+1] + +include::modules/virt-removing-virtio-disk-from-vm.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/images b/virt/virtual_machines/virtual_disks/images similarity index 100% rename from cnv/cnv_virtual_machines/cnv_virtual_disks/images rename to virt/virtual_machines/virtual_disks/images diff --git a/cnv/cnv_virtual_machines/cnv_virtual_disks/modules b/virt/virtual_machines/virtual_disks/modules similarity index 100% rename from cnv/cnv_virtual_machines/cnv_virtual_disks/modules rename to virt/virtual_machines/virtual_disks/modules diff --git a/virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc b/virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc new file mode 100644 index 0000000000..3fc53b1673 --- /dev/null +++ b/virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc @@ -0,0 +1,17 @@ +[id="virt-configuring-local-storage-for-vms"] += Configuring local storage for virtual machines +include::modules/virt-document-attributes.adoc[] +:context: virt-configuring-local-storage-for-vms +toc::[] + + +You can configure local storage for your virtual machines by using the hostpath +provisioner feature. + +include::modules/virt-about-hostpath-provisioner.adoc[leveloffset=+1] + +include::modules/virt-configuring-selinux-hpp-on-rhcos8.adoc[leveloffset=+1] + +include::modules/virt-using-hostpath-provisioner.adoc[leveloffset=+1] + +include::modules/virt-creating-storage-class.adoc[leveloffset=+1] \ No newline at end of file diff --git a/virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc b/virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc new file mode 100644 index 0000000000..b722a16178 --- /dev/null +++ b/virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc @@ -0,0 +1,15 @@ +[id="virt-deleting-datavolumes"] += Deleting DataVolumes +include::modules/virt-document-attributes.adoc[] +:context: virt-deleting-datavolumes +toc::[] + +You can manually delete a DataVolume by using the `oc` command-line interface. + +[NOTE] +==== +When you delete a virtual machine, the DataVolume it uses is automatically deleted. +==== + +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] +include::modules/virt-listing-dvs.adoc[leveloffset=+1] +include::modules/virt-deleting-dvs.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc b/virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc new file mode 100644 index 0000000000..5b12a20ba0 --- /dev/null +++ b/virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc @@ -0,0 +1,14 @@ +[id="virt-expanding-virtual-storage-with-blank-disk-images"] += Expanding virtual storage by adding blank disk images +include::modules/virt-document-attributes.adoc[] +:context: virt-expanding-virtual-storage-with-blank-disk-images +toc::[] + +You can increase your storage capacity or create new data partitions by adding +blank disk images to {VirtProductName}. + +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-creating-blank-disk-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-template-blank-disk-datavolume.adoc[leveloffset=+1] \ No newline at end of file diff --git a/virt/virtual_machines/virtual_disks/virt-moving-local-vm-disk-to-different-node.adoc b/virt/virtual_machines/virtual_disks/virt-moving-local-vm-disk-to-different-node.adoc new file mode 100644 index 0000000000..e8ab93d922 --- /dev/null +++ b/virt/virtual_machines/virtual_disks/virt-moving-local-vm-disk-to-different-node.adoc @@ -0,0 +1,21 @@ +[id="virt-moving-local-vm-disk-to-different-node"] += Moving a local virtual machine disk to a different node +include::modules/virt-document-attributes.adoc[] +:context: virt-moving-local-vm-disk-to-different-node +toc::[] + +Virtual machines that use local volume storage can be moved so that they run on a specific node. + +You might want to move the virtual machine to a specific node for the following reasons: + +* The current node has limitations to the local storage configuration. +* The new node is better optimized for the workload of that virtual machine. + +To move a virtual machine that uses local storage, you must clone the underlying volume by using a DataVolume. After the cloning operation is complete, you can xref:../../../virt/virtual_machines/virt-edit-vms.adoc#virt-edit-vms[edit the virtual machine configuration] so that it uses the new DataVolume, or xref:../../../virt/virtual_machines/virt-edit-vms.adoc#virt-vm-add-disk_virt-edit-vms[add the new DataVolume to another virtual machine]. + +[NOTE] +==== +Users without the `cluster-admin` role require xref:../../../virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc#virt-enabling-user-permissions-to-clone-datavolumes[additional user permissions] in order to clone volumes across namespaces. +==== + +include::modules/virt-cloning-local-volume-to-another-node.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc b/virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc new file mode 100644 index 0000000000..ef287dc40d --- /dev/null +++ b/virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc @@ -0,0 +1,19 @@ +[id="virt-preparing-cdi-scratch-space"] += Preparing CDI scratch space +include::modules/virt-document-attributes.adoc[] +:context: virt-preparing-cdi-scratch-space +toc::[] + +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-understanding-scratch-space.adoc[leveloffset=+1] + +include::modules/virt-operations-requiring-scratch-space.adoc[leveloffset=+1] + +include::modules/virt-defining-storageclass-in-cdi-configuration.adoc[leveloffset=+1] + +include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1] + +.Additional resources + +* See the xref:../../../storage/dynamic-provisioning.adoc#about_dynamic-provisioning[Dynamic provisioning] section for more information on StorageClasses and how these are defined in the cluster. diff --git a/virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc b/virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc new file mode 100644 index 0000000000..cd23f98618 --- /dev/null +++ b/virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc @@ -0,0 +1,15 @@ +[id="virt-storage-defaults-for-datavolumes"] += Storage defaults for DataVolumes +include::modules/virt-document-attributes.adoc[] +:context: virt-storage-defaults-for-datavolumes +toc::[] + +The `kubevirt-storage-class-defaults` ConfigMap provides _access mode_ and _volume mode_ defaults for DataVolumes. You can edit or add storage class defaults to the ConfigMap in order to create DataVolumes in the web console that better match the underlying storage. + +include::modules/virt-about-storage-setting-for-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-editing-kubevirtstorageclassdefaults-web.adoc[leveloffset=+1] + +include::modules/virt-editing-kubevirtstorageclassdefaults-cli.adoc[leveloffset=+1] + +include::modules/virt-example-kubevirtstorageclassdefaults.adoc[leveloffset=+1] diff --git a/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc new file mode 100644 index 0000000000..abcabc2e5c --- /dev/null +++ b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc @@ -0,0 +1,36 @@ +[id="virt-uploading-local-disk-images-block"] += Uploading a local disk image to a block storage DataVolume +include::modules/virt-document-attributes.adoc[] +:context: virt-uploading-local-disk-images-block +toc::[] + +You can upload a local disk image into a block DataVolume by using the +`virtctl` command-line utility. + +In this workflow, you create a local block device to use as a PersistentVolume, +associate this block volume with an `upload` DataVolume, and use `virtctl` +to upload the local disk image into the DataVolume. + +.Prerequisites + +* xref:../../../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[Install] +the `kubevirt-virtctl` package. +* If you require scratch space according to the +xref:#virt-cdi-supported-operations-matrix_virt-uploading-local-disk-images-block[CDI supported operations matrix], you must first +xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass-in-cdi-configuration_virt-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] +for this operation to complete successfully. + +:blockstorage: +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-about-block-pvs.adoc[leveloffset=+1] + +include::modules/virt-creating-local-block-pv.adoc[leveloffset=+1] + +include::modules/virt-creating-an-upload-dv.adoc[leveloffset=+1] + +include::modules/virt-uploading-local-disk-image-dv.adoc[leveloffset=+1] + +include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1] + +:blockstorage!: diff --git a/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc new file mode 100644 index 0000000000..a1345cd9a3 --- /dev/null +++ b/virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc @@ -0,0 +1,26 @@ +[id="virt-uploading-local-disk-images-virtctl"] += Uploading local disk images by using the virtctl tool +include::modules/virt-document-attributes.adoc[] +:context: virt-uploading-local-disk-images-virtctl +toc::[] + +You can upload a locally stored disk image to a new or existing DataVolume by using the +`virtctl` command-line utility. + +.Prerequisites + +* xref:../../../virt/install/virt-installing-virtctl.adoc#virt-installing-virtctl[Install] +the `kubevirt-virtctl` package. + +* If you require scratch space according to the +xref:#virt-cdi-supported-operations-matrix_virt-cloning-vm-disk-into-new-datavolume-block[CDI supported operations matrix], you must first +xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass-in-cdi-configuration_virt-preparing-cdi-scratch-space[define a StorageClass or prepare CDI scratch space] +for this operation to complete successfully. + +include::modules/virt-about-datavolumes.adoc[leveloffset=+1] + +include::modules/virt-creating-an-upload-dv.adoc[leveloffset=+1] + +include::modules/virt-uploading-local-disk-image-dv.adoc[leveloffset=+1] + +include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/cnv_vm_networking/images b/virt/virtual_machines/vm_networking/images similarity index 100% rename from cnv/cnv_virtual_machines/cnv_vm_networking/images rename to virt/virtual_machines/vm_networking/images diff --git a/cnv/cnv_virtual_machines/cnv_vm_networking/modules b/virt/virtual_machines/vm_networking/modules similarity index 100% rename from cnv/cnv_virtual_machines/cnv_vm_networking/modules rename to virt/virtual_machines/vm_networking/modules diff --git a/cnv/cnv_virtual_machines/cnv_vm_networking/cnv-attaching-vm-multiple-networks.adoc b/virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc similarity index 50% rename from cnv/cnv_virtual_machines/cnv_vm_networking/cnv-attaching-vm-multiple-networks.adoc rename to virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc index 8a574ff0b5..3180e77220 100644 --- a/cnv/cnv_virtual_machines/cnv_vm_networking/cnv-attaching-vm-multiple-networks.adoc +++ b/virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc @@ -1,10 +1,10 @@ [id="attaching-to-multiple-networks"] = Attaching a virtual machine to multiple networks -include::modules/cnv-document-attributes.adoc[] -:context: cnv-attaching-multiple-networks +include::modules/virt-document-attributes.adoc[] +:context: virt-attaching-multiple-networks toc::[] -{CNVProductNameStart} provides layer-2 networking capabilities that allow you to connect +{VirtProductName} provides layer-2 networking capabilities that allow you to connect virtual machines to multiple networks. You can import virtual machines with existing workloads that depend on access to multiple interfaces. You can also configure a PXE network so that you can boot machines over the network. @@ -12,18 +12,18 @@ configure a PXE network so that you can boot machines over the network. To get started, a network administrator configures a bridge NetworkAttachmentDefinition for a namespace in the web console or CLI. Users can then create a NIC to attach Pods and virtual machines in that namespace to the bridge network. -include::modules/cnv-networking-glossary.adoc[leveloffset=+1] +include::modules/virt-networking-glossary.adoc[leveloffset=+1] == Creating a NetworkAttachmentDefinition .Prerequisites * A Linux bridge must be configured and attached on every node. -See the xref:../../../cnv/cnv_node_network/cnv-updating-node-network-config.adoc#cnv-about-nmstate_cnv-updating-node-network-config[node networking] section for more information. +See the xref:../../../virt/node_network/virt-updating-node-network-config.adoc#virt-about-nmstate_virt-updating-node-network-config[node networking] section for more information. -include::modules/cnv-creating-bridge-nad-web.adoc[leveloffset=+2] +include::modules/virt-creating-bridge-nad-web.adoc[leveloffset=+2] -include::modules/cnv-creating-bridge-nad-cli.adoc[leveloffset=+2] +include::modules/virt-creating-bridge-nad-cli.adoc[leveloffset=+2] [NOTE] ==== @@ -32,8 +32,8 @@ the bridge network name from the NetworkAttachmentDefinition you created in the previous section. ==== -include::modules/cnv-vm-create-nic-web.adoc[leveloffset=+1] +include::modules/virt-vm-create-nic-web.adoc[leveloffset=+1] -include::modules/cnv-networking-wizard-fields-web.adoc[leveloffset=+1] +include::modules/virt-networking-wizard-fields-web.adoc[leveloffset=+1] -Install the optional xref:../../../cnv/cnv_virtual_machines/cnv_vm_networking/cnv-installing-qemu-guest-agent.adoc#cnv-installing-qemu-guest-agent[QEMU guest agent] on the virtual machine so that the host can display relevant information about the additional networks. +Install the optional xref:../../../virt/virtual_machines/vm_networking/virt-installing-qemu-guest-agent.adoc#virt-installing-qemu-guest-agent[QEMU guest agent] on the virtual machine so that the host can display relevant information about the additional networks. diff --git a/cnv/cnv_virtual_machines/cnv_vm_networking/cnv-installing-qemu-guest-agent.adoc b/virt/virtual_machines/vm_networking/virt-installing-qemu-guest-agent.adoc similarity index 57% rename from cnv/cnv_virtual_machines/cnv_vm_networking/cnv-installing-qemu-guest-agent.adoc rename to virt/virtual_machines/vm_networking/virt-installing-qemu-guest-agent.adoc index b704273799..61c362f5c2 100644 --- a/cnv/cnv_virtual_machines/cnv_vm_networking/cnv-installing-qemu-guest-agent.adoc +++ b/virt/virtual_machines/vm_networking/virt-installing-qemu-guest-agent.adoc @@ -1,7 +1,7 @@ -[id="cnv-installing-qemu-guest-agent"] +[id="virt-installing-qemu-guest-agent"] = Installing the QEMU guest agent on virtual machines -include::modules/cnv-document-attributes.adoc[] -:context: cnv-installing-qemu-guest-agent +include::modules/virt-document-attributes.adoc[] +:context: virt-installing-qemu-guest-agent toc::[] The QEMU guest agent is a daemon that runs on the virtual machine. The agent @@ -17,14 +17,14 @@ $ systemctl status qemu-guest-agent ---- + -include::modules/cnv-installing-qemu-guest-agent-on-linux-vm.adoc[leveloffset=+1] +include::modules/virt-installing-qemu-guest-agent-on-linux-vm.adoc[leveloffset=+1] You can also install and start the QEMU guest agent by using the *custom script* field in the *cloud-init* section of the wizard when creating either virtual machines or virtual machines templates in the web console. -include::modules/cnv-installing-qemu-guest-agent-on-windows-vm.adoc[leveloffset=+1] +include::modules/virt-installing-qemu-guest-agent-on-windows-vm.adoc[leveloffset=+1] -include::modules/cnv-installing-virtio-drivers-existing-windows.adoc[leveloffset=+2] +include::modules/virt-installing-virtio-drivers-existing-windows.adoc[leveloffset=+2] -include::modules/cnv-installing-virtio-drivers-installing-windows.adoc[leveloffset=+2] +include::modules/virt-installing-virtio-drivers-installing-windows.adoc[leveloffset=+2] diff --git a/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc b/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc new file mode 100644 index 0000000000..6354858367 --- /dev/null +++ b/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc @@ -0,0 +1,32 @@ +[id="virt-using-the-default-pod-network-with-virt"] += Using the default Pod network for virtual machines +include::modules/virt-document-attributes.adoc[] +:context: virt-using-the-default-pod-network-with-virt +toc::[] + +You can use the default Pod network with {VirtProductName}. To do so, +you must use the `masquerade` binding method. It is the only recommended +binding method for use with the default Pod network. Do not use +`masquerade` mode with non-default networks. + +[NOTE] +==== +For secondary networks, use the `bridge` binding method. +==== + +include::modules/virt-configuring-masquerade-mode-cli.adoc[leveloffset=+1] + +[id="virt-selecting-binding-method"] +== Selecting binding method + +If you create a virtual machine from the {VirtProductName} +xref:../../../virt/virtual_machines/virt-create-vms.adoc#virt-create-vms[web console wizard], +select the required binding method from the *Networking* screen. + +include::modules/virt-networking-wizard-fields-web.adoc[leveloffset=+2] + +== Virtual machine configuration examples for the default network + +include::modules/virt-template-vm-config.adoc[leveloffset=+2] + +include::modules/virt-template-windows-vmi.adoc[leveloffset=+2] diff --git a/cnv/cnv_virtual_machines/cnv_vm_networking/cnv-viewing-ip-of-vm-nic.adoc b/virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-nic.adoc similarity index 53% rename from cnv/cnv_virtual_machines/cnv_vm_networking/cnv-viewing-ip-of-vm-nic.adoc rename to virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-nic.adoc index fbac761d0c..b2dd23e5ec 100644 --- a/cnv/cnv_virtual_machines/cnv_vm_networking/cnv-viewing-ip-of-vm-nic.adoc +++ b/virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-nic.adoc @@ -1,7 +1,7 @@ -[id="cnv-viewing-ip-of-vm-nic"] +[id="virt-viewing-ip-of-vm-nic"] = Viewing the IP address of NICs on a virtual machine -include::modules/cnv-document-attributes.adoc[] -:context: cnv-viewing-ip-of-vm-vnic +include::modules/virt-document-attributes.adoc[] +:context: virt-viewing-ip-of-vm-vnic toc::[] The QEMU guest agent runs on the virtual machine and passes the IP address of attached NICs to the host, allowing you to view the IP address from both the web console and the `oc` client. @@ -14,7 +14,7 @@ The QEMU guest agent runs on the virtual machine and passes the IP address of at $ systemctl status qemu-guest-agent ---- + -. If the guest agent is not installed and running, xref:../../../cnv/cnv_virtual_machines/cnv_vm_networking/cnv-installing-qemu-guest-agent.adoc#cnv-installing-qemu-guest-agent[install and run the guest agent on the virtual machine]. +. If the guest agent is not installed and running, xref:../../../virt/virtual_machines/vm_networking/virt-installing-qemu-guest-agent.adoc#virt-installing-qemu-guest-agent[install and run the guest agent on the virtual machine]. -include::modules/cnv-viewing-vmi-ip-cli.adoc[leveloffset=+1] -include::modules/cnv-viewing-vmi-ip-web.adoc[leveloffset=+1] +include::modules/virt-viewing-vmi-ip-cli.adoc[leveloffset=+1] +include::modules/virt-viewing-vmi-ip-web.adoc[leveloffset=+1] diff --git a/cnv/cnv_virtual_machines/images b/virt/vm_templates/images similarity index 100% rename from cnv/cnv_virtual_machines/images rename to virt/vm_templates/images diff --git a/cnv/cnv_virtual_machines/modules b/virt/vm_templates/modules similarity index 100% rename from cnv/cnv_virtual_machines/modules rename to virt/vm_templates/modules diff --git a/virt/vm_templates/virt-creating-vm-template.adoc b/virt/vm_templates/virt-creating-vm-template.adoc new file mode 100644 index 0000000000..bb08d74c1a --- /dev/null +++ b/virt/vm_templates/virt-creating-vm-template.adoc @@ -0,0 +1,24 @@ +[id="virt-creating-vm-template"] += Creating virtual machine templates +include::modules/virt-document-attributes.adoc[] +:context: virt-creating-vm-template +toc::[] + +Using Virtual machines templates is an easy way to create multiple virtual machines +with similar configuration. After a template is created, reference the template +when creating virtual machines. + +include::modules/virt-creating-template-wizard-web.adoc[leveloffset=+1] + +[id="virt-template-wizard-fields"] +== Virtual machine template interactive wizard fields + +The following tables describe the fields for the *Basic Settings*, *Networking*, +and *Storage* panes in the *Create Virtual Machine Template* interactive wizard. + +:vmtemplate: +include::modules/virt-vm-wizard-fields-web.adoc[leveloffset=+2] +include::modules/virt-cloud-init-fields-web.adoc[leveloffset=+2] +include::modules/virt-networking-wizard-fields-web.adoc[leveloffset=+2] +include::modules/virt-storage-wizard-fields-web.adoc[leveloffset=+2] +:vmtemplate!: diff --git a/cnv/cnv_vm_templates/cnv-dedicated-resources-vm-template.adoc b/virt/vm_templates/virt-dedicated-resources-vm-template.adoc similarity index 59% rename from cnv/cnv_vm_templates/cnv-dedicated-resources-vm-template.adoc rename to virt/vm_templates/virt-dedicated-resources-vm-template.adoc index 82b38a9f8a..64b54f59f1 100644 --- a/cnv/cnv_vm_templates/cnv-dedicated-resources-vm-template.adoc +++ b/virt/vm_templates/virt-dedicated-resources-vm-template.adoc @@ -1,13 +1,13 @@ -[id="cnv-dedicated-resources-vm-template"] +[id="virt-dedicated-resources-vm-template"] = Enabling dedicated resources for virtual machine templates -include::modules/cnv-document-attributes.adoc[] -:context: cnv-dedicated-resources-vm-template +include::modules/virt-document-attributes.adoc[] +:context: virt-dedicated-resources-vm-template toc::[] Virtual machines can have resources of a node, such as CPU, dedicated to them in order to improve performance. -include::modules/cnv-about-dedicated-resources.adoc[leveloffset=+1] +include::modules/virt-about-dedicated-resources.adoc[leveloffset=+1] .Prerequisites @@ -16,4 +16,4 @@ xref:../../scalability_and_performance/using-cpu-manager.adoc[CPU Manager] must be configured on the node. Verify that the node has the `cpumanager` = `true` label before scheduling virtual machine workloads. -include::modules/cnv-enabling-dedicated-resources.adoc[leveloffset=+1] +include::modules/virt-enabling-dedicated-resources.adoc[leveloffset=+1] diff --git a/virt/vm_templates/virt-deleting-vm-template.adoc b/virt/vm_templates/virt-deleting-vm-template.adoc new file mode 100644 index 0000000000..f2248b5c79 --- /dev/null +++ b/virt/vm_templates/virt-deleting-vm-template.adoc @@ -0,0 +1,11 @@ +[id="virt-deleting-vm-template"] += Deleting a virtual machine template +include::modules/virt-document-attributes.adoc[] +:context: virt-deleting-vm-template +toc::[] + +You can delete a virtual machine template in the web console. + +include::modules/virt-deleting-template-web.adoc[leveloffset=+1] + + diff --git a/virt/vm_templates/virt-editing-vm-template.adoc b/virt/vm_templates/virt-editing-vm-template.adoc new file mode 100644 index 0000000000..3e3d5c3d7a --- /dev/null +++ b/virt/vm_templates/virt-editing-vm-template.adoc @@ -0,0 +1,15 @@ +[id="virt-editing-vm-template"] += Editing virtual machine templates +include::modules/virt-document-attributes.adoc[] +:context: virt-editing-vm-template +toc::[] + +You can update a virtual machine template in the web console, either by editing +the full configuration in the YAML editor or by editing a subset of the +parameters in the *Virtual Machine Template Overview* screen. + +include::modules/virt-editing-vm-web.adoc[leveloffset=+1] +include::modules/virt-editing-template-yaml-web.adoc[leveloffset=+1] +include::modules/virt-add-disk-to-vm.adoc[leveloffset=+1] +include::modules/virt-add-nic-to-vm.adoc[leveloffset=+1] +include::modules/virt-edit-cdrom-vm.adoc[leveloffset=+1] diff --git a/web_console/using-dashboard-to-get-cluster-information.adoc b/web_console/using-dashboard-to-get-cluster-information.adoc index 66ba914b8d..44e518320b 100644 --- a/web_console/using-dashboard-to-get-cluster-information.adoc +++ b/web_console/using-dashboard-to-get-cluster-information.adoc @@ -11,4 +11,4 @@ the {product-title} web console. The {product-title} dashboard provides various cluster information, captured in individual dashboard cards. -include::modules/cnv-about-the-overview-dashboard.adoc[leveloffset=+1] +include::modules/virt-about-the-overview-dashboard.adoc[leveloffset=+1] diff --git a/welcome/oce_about.adoc b/welcome/oce_about.adoc index fc1e72bb1a..8b3217214c 100644 --- a/welcome/oce_about.adoc +++ b/welcome/oce_about.adoc @@ -7,7 +7,7 @@ :icons: :experimental: :toc: macro -:toc-title: +:toc-title:a Red Hat {oce} is a new product offering from Red Hat @@ -154,7 +154,7 @@ such as function based and serverless container services. === Quay Integration compatible {oce} is compatible and supported with Red Hat Quay. -=== CNV VM Virtualization Compatible +=== OpenShift virtualization compatible {oce} is compatible and supported with Red Hat product offerings derived from the kubevirt.io open source project.