Virtualization

Procedure

1. From the Administrator perspective, click Operators → OperatorHub.
2. In the Filter by keyword field, type Virtualization.
3. Select the {CNVOperatorDisplayName} tile with the Red Hat source label.
4. Read the information about the Operator and click Install.

5. On the Install Operator page:

   1. Select stable from the list of available Update Channel options. This ensures that you install the version of OpenShift Virtualization that is compatible with your OpenShift Container Platform version.

   2. For Installed Namespace, ensure that the Operator recommended namespace option is selected. This installs the Operator in the mandatory openshift-cnv namespace, which is automatically created if it does not exist.

      Warning

      Attempting to install the OpenShift Virtualization Operator in a namespace other than openshift-cnv causes the installation to fail.

   3. For Approval Strategy, it is highly recommended that you select Automatic, which is the default value, so that OpenShift Virtualization automatically updates when a new version is available in the stable update channel.

      While it is possible to select the Manual approval strategy, this is inadvisable because of the high risk that it presents to the supportability and functionality of your cluster. Only select Manual if you fully understand these risks and cannot use Automatic.

      Warning

      Because OpenShift Virtualization is only supported when used with the corresponding OpenShift Container Platform version, missing OpenShift Virtualization updates can cause your cluster to become unsupported.

6. Click Install to make the Operator available to the openshift-cnv namespace.
7. When the Operator installs successfully, click Create HyperConverged.
8. Optional: Configure Infra and Workloads node placement options for OpenShift Virtualization components.
9. Click Create to launch OpenShift Virtualization.

Procedure

1. Create a YAML file that contains the following manifest:

   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-cnv
   ---
   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: kubevirt-hyperconverged-group
     namespace: openshift-cnv
   spec:
     targetNamespaces:
       - openshift-cnv
   ---
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: hco-operatorhub
     namespace: openshift-cnv
   spec:
     source: redhat-operators
     sourceNamespace: openshift-marketplace
     name: kubevirt-hyperconverged
     startingCSV: kubevirt-hyperconverged-operator.v4.12.13
     channel: "stable" 1

   1

   Using the stable channel ensures that you install the version of OpenShift Virtualization that is compatible with your OpenShift Container Platform version.

2. Create the required Namespace, OperatorGroup, and Subscription objects for OpenShift Virtualization by running the following command:

   $ oc apply -f <file name>.yaml

Procedure

1. Create a YAML file that contains the following manifest:

   apiVersion: hco.kubevirt.io/v1beta1
   kind: HyperConverged
   metadata:
     name: kubevirt-hyperconverged
     namespace: openshift-cnv
   spec:

2. Deploy the OpenShift Virtualization Operator by running the following command:

   $ oc apply -f <file_name>.yaml

Procedure

1. Navigate to Virtualization > Overview in the OpenShift Container Platform web console.
2. Click the Download virtctl link on the upper right corner of the page and download the virtctl client for your operating system.

3. Install virtctl:

   • For Linux:

     1. Decompress the archive file:

        $ tar -xvf <virtctl-version-distribution.arch>.tar.gz

     2. Run the following command to make the virtctl binary executable:

        $ chmod +x <path/virtctl-file-name>

     3. Move the virtctl binary to a directory in your PATH environment variable.

        You can check your path by running the following command:

        $ echo $PATH

     4. Set the KUBECONFIG environment variable:

        $ export KUBECONFIG=/home/<user>/clusters/current/auth/kubeconfig

   • For Windows:

     1. Decompress the archive file.
     2. Navigate the extracted folder hierarchy and double-click the virtctl executable file to install the client.

     3. Move the virtctl binary to a directory in your PATH environment variable.

        You can check your path by running the following command:

        C:\> path

   • For macOS:

     1. Decompress the archive file.

     2. Move the virtctl binary to a directory in your PATH environment variable.

        You can check your path by running the following command:

        echo $PATH

1. Delete the HyperConverged CR.
2. Delete the OpenShift Virtualization Operator.
3. Delete the openshift-cnv namespace.
4. Delete the OpenShift Virtualization custom resource definitions (CRDs).

Procedure

1. Delete the HyperConverged custom resource:

   $ oc delete HyperConverged kubevirt-hyperconverged -n openshift-cnv

2. Delete the OpenShift Virtualization Operator subscription:

   $ oc delete subscription kubevirt-hyperconverged -n openshift-cnv

3. Delete the OpenShift Virtualization ClusterServiceVersion resource:

   $ oc delete csv -n openshift-cnv -l operators.coreos.com/kubevirt-hyperconverged.openshift-cnv

4. Delete the OpenShift Virtualization namespace:

   $ oc delete namespace openshift-cnv

5. List the OpenShift Virtualization custom resource definitions (CRDs) by running the oc delete crd command with the dry-run option:

   $ oc delete crd --dry-run=client -l operators.coreos.com/kubevirt-hyperconverged.openshift-cnv

   Example output

   customresourcedefinition.apiextensions.k8s.io "cdis.cdi.kubevirt.io" deleted (dry run)
   customresourcedefinition.apiextensions.k8s.io "hostpathprovisioners.hostpathprovisioner.kubevirt.io" deleted (dry run)
   customresourcedefinition.apiextensions.k8s.io "hyperconvergeds.hco.kubevirt.io" deleted (dry run)
   customresourcedefinition.apiextensions.k8s.io "kubevirts.kubevirt.io" deleted (dry run)
   customresourcedefinition.apiextensions.k8s.io "networkaddonsconfigs.networkaddonsoperator.network.kubevirt.io" deleted (dry run)
   customresourcedefinition.apiextensions.k8s.io "ssps.ssp.kubevirt.io" deleted (dry run)
   customresourcedefinition.apiextensions.k8s.io "tektontasks.tektontasks.kubevirt.io" deleted (dry run)

6. Delete the CRDs by running the oc delete crd command without the dry-run option:

   $ oc delete crd -l operators.coreos.com/kubevirt-hyperconverged.openshift-cnv

Procedure

1. In the Administrator perspective of the OpenShift Container Platform web console, navigate to Operators → Installed Operators.
2. Operators that have a pending update display a status with Upgrade available. Click the name of the Operator you want to update.
3. Click the Subscription tab. Any update requiring approval are displayed next to Upgrade Status. For example, it might display 1 requires approval.
4. Click 1 requires approval, then click Preview Install Plan.
5. Review the resources that are listed as available for update. When satisfied, click Approve.
6. Navigate back to the Operators → Installed Operators page to monitor the progress of the update. When complete, the status changes to Succeeded and Up to date.

Procedure

1. Run the following command:

   $ oc get csv -n openshift-cnv

2. Review the output, checking the PHASE field. For example:

   Example output

   VERSION  REPLACES                                        PHASE
   4.9.0    kubevirt-hyperconverged-operator.v4.8.2         Installing
   4.9.0    kubevirt-hyperconverged-operator.v4.9.0         Replacing

3. Optional: Monitor the aggregated status of all OpenShift Virtualization component conditions by running the following command:

   $ oc get hco -n openshift-cnv kubevirt-hyperconverged \
   -o=jsonpath='{range .status.conditions[*]}{.type}{"\t"}{.status}{"\t"}{.message}{"\n"}{end}'

   A successful upgrade results in the following output:

   Example output

   ReconcileComplete  True  Reconcile completed successfully
   Available          True  Reconcile completed successfully
   Progressing        False Reconcile completed successfully
   Degraded           False Reconcile completed successfully
   Upgradeable        True  Reconcile completed successfully

Procedure

1. In the web console, select Quick Starts from the Help menu.
2. Click on a tile in the Quick Starts catalog. For example: Creating a Red Hat Linux Enterprise Linux virtual machine.
3. Follow the instructions in the guided tour and complete the tasks for importing an operating system image and creating a virtual machine. The Virtualization → VirtualMachines page displays the virtual machine.

Procedure

1. Click Virtualization → Catalog in the side menu.

2. Click Boot source available to filter templates with boot sources.

   Note

   By default, the template list will show only Default Templates. Click All Items when filtering to see all available templates for your chosen filters.

3. Click a template to view its details.

4. Click Quick Create VirtualMachine to create a VM from the template.

   The virtual machine Details page is displayed with the provisioning status.

Verification

1. Click Events to view a stream of events as the VM is provisioned.
2. Click Console to verify that the VM booted successfully.

Procedure

1. In the web console, select a template:

   1. Click Virtualization → Catalog in the side menu.
   2. Optional: Filter the templates by project, keyword, operating system, or workload profile.
   3. Click the template that you want to customize.
2. Click Customize VirtualMachine.
3. Specify parameters for your VM, including its Name and Disk source. You can optionally specify a data source to clone.

Verification

1. Click Events to view a stream of events as the VM is provisioned.
2. Click Console to verify that the VM booted successfully.

Procedure

1. Edit the VirtualMachine manifest for your VM. For example, the following manifest configures a Red Hat Enterprise Linux (RHEL) VM:

   Example 10.1. Example manifest for a RHEL VM

   apiVersion: kubevirt.io/v1
   kind: VirtualMachine
   metadata:
     labels:
       app: <vm_name> 1
     name: <vm_name>
   spec:
     dataVolumeTemplates:
     - apiVersion: cdi.kubevirt.io/v1beta1
       kind: DataVolume
       metadata:
         name: <vm_name>
       spec:
         sourceRef:
           kind: DataSource
           name: rhel9
           namespace: openshift-virtualization-os-images
         storage:
           resources:
             requests:
               storage: 30Gi
     running: false
     template:
       metadata:
         labels:
           kubevirt.io/domain: <vm_name>
       spec:
         domain:
           cpu:
             cores: 1
             sockets: 2
             threads: 1
           devices:
             disks:
             - disk:
                 bus: virtio
               name: rootdisk
             - disk:
                 bus: virtio
               name: cloudinitdisk
             interfaces:
             - masquerade: {}
               name: default
             rng: {}
           features:
             smm:
               enabled: true
           firmware:
             bootloader:
               efi: {}
           resources:
             requests:
               memory: 8Gi
         evictionStrategy: LiveMigrate
         networks:
         - name: default
           pod: {}
         volumes:
         - dataVolume:
             name: <vm_name>
           name: rootdisk
         - cloudInitNoCloud:
             userData: |-
               #cloud-config
               user: cloud-user
               password: '<password>' 2
               chpasswd: { expire: False }
           name: cloudinitdisk

   1

   Specify the name of the virtual machine.

   2

   Specify the password for cloud-user.

2. Create a virtual machine by using the manifest file:

   $ oc create -f <vm_manifest_file>.yaml

3. Optional: Start the virtual machine:

   $ virtctl start <vm_name>

Procedure

1. Navigate to Virtualization → VirtualMachines in the web console.
2. Select a virtual machine to open the VirtualMachine details page.
3. Click any field that has the pencil icon, which indicates that the field is editable. For example, click the current Boot mode setting, such as BIOS or UEFI, to open the Boot mode window and select an option from the list.
4. Click Save.

Procedure

1. Click Virtualization → VirtualMachines from the side menu.
2. Select a virtual machine.
3. Click the YAML tab to display the editable configuration.
4. Optional: You can click Download to download the YAML file locally in its current state.
5. Edit the file and click Save.

Procedure

1. Run the following command to update the virtual machine configuration:

   $ oc edit <object_type> <object_ID>

2. Open the object configuration.
3. Edit the YAML.

4. If you edit a running virtual machine, you need to do one of the following:

   • Restart the virtual machine.

   • Run the following command for the new configuration to take effect:

     $ oc apply <object_type> <object_ID>

Procedure

1. Click Virtualization → VirtualMachines from the side menu.
2. Select a virtual machine to open the VirtualMachine details screen.
3. Click the Disks tab and then click Add disk.

4. In the Add disk window, specify the Source, Name, Size, Type, Interface, and Storage Class.

   1. Optional: You can enable preallocation if you use a blank disk source and require maximum write performance when creating data volumes. To do so, select the Enable preallocation checkbox.
   2. Optional: You can clear Apply optimized StorageProfile settings to change the Volume Mode and Access Mode for the virtual disk. If you do not specify these parameters, the system uses the default values from the kubevirt-storage-class-defaults config map.
5. Click Add.

Procedure

1. Click Virtualization → VirtualMachines from the side menu.
2. Select a virtual machine to open the VirtualMachine details screen.
3. Click the Network Interfaces tab.
4. Click Add Network Interface.
5. In the Add Network Interface window, specify the Name, Model, Network, Type, and MAC Address of the network interface.
6. Click Add.

Procedure

1. Click Virtualization → VirtualMachines from the side menu.
2. Select a virtual machine to open the VirtualMachine details page.
3. Click the Details tab.
4. Click the pencil icon that is located on the right side of Boot Order. If a YAML configuration does not exist, or if this is the first time that you are creating a boot order list, the following message displays: No resource selected. VM will attempt to boot from disks by order of appearance in YAML file.
5. Click Add Source and select a bootable disk or network interface controller (NIC) for the virtual machine.
6. Add any additional disks or NICs to the boot order list.
7. Click Save.

Procedure

1. Click Virtualization → VirtualMachines from the side menu.
2. Select a virtual machine to open the VirtualMachine details page.
3. Click the Details tab.
4. Click the pencil icon that is located on the right side of Boot Order.

5. Choose the appropriate method to move the item in the boot order list:

   • If you do not use a screen reader, hover over the arrow icon next to the item that you want to move, drag the item up or down, and drop it in a location of your choice.
   • If you use a screen reader, press the Up Arrow key or Down Arrow key to move the item in the boot order list. Then, press the Tab key to drop the item in a location of your choice.
6. Click Save.

Procedure

1. Open the YAML configuration file for the virtual machine by running the following command:

   $ oc edit vm example

2. Edit the YAML file and modify the values for the boot order associated with a disk or network interface controller (NIC). For example:

   disks:
     - bootOrder: 1 1
       disk:
         bus: virtio
       name: containerdisk
     - disk:
         bus: virtio
       name: cloudinitdisk
     - cdrom:
         bus: virtio
       name: cd-drive-1
   interfaces:
     - boot Order: 2 2
       macAddress: '02:96:c4:00:00'
       masquerade: {}
       name: default

   1

   The boot order value specified for the disk.

   2

   The boot order value specified for the network interface controller.

3. Save the YAML file.
4. Click reload the content to apply the updated boot order values from the YAML file to the boot order list in the web console.

Procedure

1. Click Virtualization → VirtualMachines from the side menu.
2. Select a virtual machine to open the VirtualMachine details page.
3. Click the Details tab.
4. Click the pencil icon that is located on the right side of Boot Order.
5. Click the Remove icon next to the item. The item is removed from the boot order list and saved in the list of available boot sources. If you remove all items from the boot order list, the following message displays: No resource selected. VM will attempt to boot from disks by order of appearance in YAML file.

Procedure

1. In the OpenShift Container Platform console, click Virtualization → VirtualMachines from the side menu.

2. Click the Options menu of the virtual machine that you want to delete and select Delete.

   • Alternatively, click the virtual machine name to open the VirtualMachine details page and click Actions → Delete.
3. In the confirmation pop-up window, click Delete to permanently delete the virtual machine.

Procedure

1. Create a VirtualMachineExport manifest to export a volume from a VirtualMachine, VirtualMachineSnapshot, or PersistentVolumeClaim CR according to the following example and save it as example-export.yaml:

   VirtualMachineExport example

   apiVersion: export.kubevirt.io/v1alpha1
   kind: VirtualMachineExport
   metadata:
     name: example-export
   spec:
     source:
       apiGroup: "kubevirt.io" 1
       kind: VirtualMachine 2
       name: example-vm
     ttlDuration: 1h 3

   1

   Specify the appropriate API group:

   • "kubevirt.io" for VirtualMachine.
   • "snapshot.kubevirt.io" for VirtualMachineSnapshot.
   • "" for PersistentVolumeClaim.

   2

   Specify VirtualMachine, VirtualMachineSnapshot, or PersistentVolumeClaim.

   3

   Optional. The default duration is 2 hours.

2. Create the VirtualMachineExport CR:

   $ oc create -f example-export.yaml

3. Get the VirtualMachineExport CR:

   $ oc get vmexport example-export -o yaml

   The internal and external links for the exported volumes are displayed in the status stanza:

   Output example

   apiVersion: export.kubevirt.io/v1alpha1
   kind: VirtualMachineExport
   metadata:
     name: example-export
     namespace: example
   spec:
     source:
       apiGroup: ""
       kind: PersistentVolumeClaim
       name: example-pvc
     tokenSecretRef: example-token
   status:
     conditions:
     - lastProbeTime: null
       lastTransitionTime: "2022-06-21T14:10:09Z"
       reason: podReady
       status: "True"
       type: Ready
     - lastProbeTime: null
       lastTransitionTime: "2022-06-21T14:09:02Z"
       reason: pvcBound
       status: "True"
       type: PVCReady
     links:
       external: 1
         cert: |-
           -----BEGIN CERTIFICATE-----
           ...
           -----END CERTIFICATE-----
         volumes:
         - formats:
           - format: raw
             url: https://vmexport-proxy.test.net/api/export.kubevirt.io/v1alpha1/namespaces/example/virtualmachineexports/example-export/volumes/example-disk/disk.img
           - format: gzip
             url: https://vmexport-proxy.test.net/api/export.kubevirt.io/v1alpha1/namespaces/example/virtualmachineexports/example-export/volumes/example-disk/disk.img.gz
           name: example-disk
       internal:  2
         cert: |-
           -----BEGIN CERTIFICATE-----
           ...
           -----END CERTIFICATE-----
         volumes:
         - formats:
           - format: raw
             url: https://virt-export-example-export.example.svc/volumes/example-disk/disk.img
           - format: gzip
             url: https://virt-export-example-export.example.svc/volumes/example-disk/disk.img.gz
           name: example-disk
     phase: Ready
     serviceName: virt-export-example-export

   1

   External links are accessible from outside the cluster by using an Ingress or Route.

   2

   Internal links are only valid inside the cluster.

Procedure

1. In the OpenShift Container Platform console, click Virtualization → VirtualMachines from the side menu.
2. Select a standalone VMI to open the VirtualMachineInstance details page.
3. On the Details tab, click the pencil icon beside Annotations or Labels.
4. Make the relevant changes and click Save.

Procedure

1. In the OpenShift Container Platform web console, click Virtualization → VirtualMachines from the side menu.
2. Click Actions → Delete VirtualMachineInstance.
3. In the confirmation pop-up window, click Delete to permanently delete the standalone VMI.

Procedure

1. Click Virtualization → VirtualMachines from the side menu.
2. Find the row that contains the virtual machine that you want to start.

3. Navigate to the appropriate menu for your use case:

   • To stay on this page, where you can perform actions on multiple virtual machines:

     1. Click the Options menu located at the far right end of the row.

   • To view comprehensive information about the selected virtual machine before you start it:

     1. Access the VirtualMachine details page by clicking the name of the virtual machine.
     2. Click Actions.
4. Select Restart.
5. In the confirmation window, click Start to start the virtual machine.

Procedure

1. Click Virtualization → VirtualMachines from the side menu.
2. Find the row that contains the virtual machine that you want to restart.

3. Navigate to the appropriate menu for your use case:

   • To stay on this page, where you can perform actions on multiple virtual machines:

     1. Click the Options menu located at the far right end of the row.

   • To view comprehensive information about the selected virtual machine before you restart it:

     1. Access the VirtualMachine details page by clicking the name of the virtual machine.
     2. Click Actions → Restart.
4. In the confirmation window, click Restart to restart the virtual machine.

Procedure

1. Click Virtualization → VirtualMachines from the side menu.
2. Find the row that contains the virtual machine that you want to stop.

3. Navigate to the appropriate menu for your use case:

   • To stay on this page, where you can perform actions on multiple virtual machines:

     1. Click the Options menu located at the far right end of the row.

   • To view comprehensive information about the selected virtual machine before you stop it:

     1. Access the VirtualMachine details page by clicking the name of the virtual machine.
     2. Click Actions → Stop.
4. In the confirmation window, click Stop to stop the virtual machine.