OpenShift Virtualization

Procedure

1. From the Administrator perspective, click Operators → OperatorHub.
2. In the Filter by keyword field, type OpenShift Virtualization.
3. Select the OpenShift Virtualization tile.
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.8.7
     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. Access the Customer Portal by clicking the icon, which is in the upper-right corner of the web console, and selecting Command Line Tools.
2. Ensure you have the appropriate version for your cluster selected from the Version: list.
3. Download the

   virtctl

   client for your distribution. All downloads are in

   tar.gz

   format.

4. Extract the tarball. The following CLI command extracts it into the same directory as the tarball and is applicable for all distributions:

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

5. For Linux and macOS:

   1. Navigate the extracted folder hierachy and make the

      virtctl

      binary executable:

      $ chmod +x <virtctl-file-name>

   2. Move the

      virtctl

      binary to a directory on your PATH.

      1. To check your path, run:

         $ echo $PATH

6. For Windows users:

   1. Navigate the extracted folder hierarchy and double-click the

      virtctl

      executable file to install the client.

Procedure

1. From the OpenShift Container Platform web console, select

   openshift-cnv

   from the Projects list.
2. Navigate to the Operators → Installed Operators page.
3. Click OpenShift Virtualization.
4. Click the OpenShift Virtualization Operator Deployment tab.
5. Click the Options menu in the row containing the kubevirt-hyperconverged custom resource. In the expanded menu, click Delete HyperConverged Cluster.
6. Click Delete in the confirmation window.
7. Navigate to the Workloads → Pods page to verify that only the Operator pods are running.

8. Open a terminal window and clean up the remaining resources by running the following command:

   $ oc delete apiservices v1alpha3.subresources.kubevirt.io -n openshift-cnv

Procedure

1. Navigate to the Operators → OperatorHub page.
2. Search for OpenShift Virtualization and then select it.
3. Click Uninstall.

Procedure

1. Navigate to Administration → Namespaces.
2. Locate the namespace that you want to delete in the list of namespaces.
3. On the far right side of the namespace listing, select Delete Namespace from the Options menu .
4. When the Delete Namespace pane opens, enter the name of the namespace that you want to delete in the field.
5. Click Delete.

Procedure

1. Delete the

   HyperConverged

   custom resource:

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

2. Delete the subscription of the OpenShift Virtualization operator in the Operator Lifecycle Manager (OLM):

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

3. Set the cluster service version (CSV) name for OpenShift Virtualization as an environment variable:

   $ CSV_NAME=$(oc get csv -n openshift-cnv -o=jsonpath="{.items[0].metadata.name}")

4. Delete the CSV from the OpenShift Virtualization cluster by specifying the CSV name from the previous step:

   $ oc delete csv ${CSV_NAME} -n openshift-cnv

   OpenShift Virtualization is uninstalled when a confirmation message indicates that the CSV was deleted successfully:

   Example output

   clusterserviceversion.operators.coreos.com "kubevirt-hyperconverged-operator.v4.8.7" deleted

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 Virtual Machines tab displays the virtual machine.

Procedure

1. Click Workloads → Virtualization from the side menu.
2. From the Virtual Machines tab or the Templates tab, click Create and select Virtual Machine with Wizard.
3. Select a template that is configured with a boot source.
4. Click Next to go to the Review and create step.
5. Clear the Start this virtual machine after creation checkbox if you do not want to start the virtual machine now.
6. Click Create virtual machine and exit the wizard or continue with the wizard to customize the virtual machine.

7. Click Customize virtual machine to go to the General step.

   1. Optional: Edit the Name field to specify a custom name for the virtual machine.
   2. Optional: In the Description field, add a description.

8. Click Next to go to the Networking step. A

   nic0

   NIC is attached by default.
   1. Optional: Click Add Network Interface to create additional NICs.
   2. Optional: You can remove any or all NICs by clicking the Options menu and selecting Delete. A virtual machine does not need a NIC attached to be created. You can create NICs after the virtual machine has been created.

9. Click Next to go to the Storage step.

   1. Optional: Click Add Disk to create additional disks. These disks can be removed by clicking the Options menu and selecting Delete.
   2. Optional: Click the Options menu to edit the disk and save your changes.

10. Click Next to go to the Advanced step to review the details for Cloud-init and configure SSH access.

    Note

    Statically inject an SSH key by using the custom script in cloud-init or in the wizard. This allows you to securely and remotely manage virtual machines and manage and transfer information. This step is strongly recommended to secure your VM. 

11. Click Next to go to the Review step and review the settings for the virtual machine.
12. Click Create Virtual Machine.

13. Click See virtual machine details to view the Overview for this virtual machine.

    The virtual machine is listed in the Virtual Machines tab.

Procedure

1. Edit the

   VirtualMachine

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

   Example 8.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. Click Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Select a virtual machine.
4. Click the Details tab.
5. Click the pencil icon to make a field editable.
6. Make the relevant changes and click Save.

Procedure

1. Click Workloads → Virtualization 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 Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Select a virtual machine to open the Virtual Machine Overview screen.
4. Click the Disks tab.

5. In the Add Disk window, specify the Source, Name, Size, Type, Interface, and Storage Class.

   1. Optional: In the Advanced list, specify 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.
6. Click Add.

Procedure

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

Procedure

1. Click Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Select a virtual machine to open the Virtual Machine Overview screen.
4. Click the Disks tab.
5. Click the Options menu for the CD-ROM that you want to edit and select Edit.
6. In the Edit CD-ROM window, edit the fields: Source, Persistent Volume Claim, Name, Type, and Interface.
7. Click Save.

Procedure

1. Click Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Select a virtual machine to open the Virtual Machine Overview screen.
4. Click the Details tab.
5. 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.
6. Click Add Source and select a bootable disk or network interface controller (NIC) for the virtual machine.
7. Add any additional disks or NICs to the boot order list.
8. Click Save.

Procedure

1. Click Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Select a virtual machine to open the Virtual Machine Overview screen.
4. Click the Details tab.
5. Click the pencil icon that is located on the right side of Boot Order.

6. 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.
7. 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 Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Select a virtual machine to open the Virtual Machine Overview screen.
4. Click the Details tab.
5. Click the pencil icon that is located on the right side of Boot Order.
6. 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 Virtualization console, click Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.

3. Click the Options menu 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 Overview screen and click Actions → Delete Virtual Machine.
4. In the confirmation pop-up window, click Delete to permanently delete the virtual machine.

Procedure

1. Click Workloads → Virtualization from the side menu. A list of virtual machines (VMs) and standalone VMIs displays.
2. Click the name of a standalone VMI to open the Virtual Machine Instance Overview screen.
3. Click the Details tab.
4. Click the pencil icon that is located on the right side of Annotations.
5. Make the relevant changes and click Save.

Procedure

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

2. Click the ⋮ button of the standalone virtual machine instance (VMI) that you want to delete and select Delete Virtual Machine Instance.

   • Alternatively, click the name of the standalone VMI. The Virtual Machine Instance Overview page displays.
3. Select Actions → Delete Virtual Machine Instance.
4. In the confirmation pop-up window, click Delete to permanently delete the standalone VMI.

Procedure

1. Click Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Find the row that contains the virtual machine that you want to start.

4. 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 Virtual Machine Overview screen by clicking the name of the virtual machine.
     2. Click Actions.
5. Select Start Virtual Machine.
6. In the confirmation window, click Start to start the virtual machine.

Procedure

1. Click Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Find the row that contains the virtual machine that you want to restart.

4. 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 Virtual Machine Overview screen by clicking the name of the virtual machine.
     2. Click Actions.
5. Select Restart Virtual Machine.
6. In the confirmation window, click Restart to restart the virtual machine.

Procedure

1. Click Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Find the row that contains the virtual machine that you want to stop.

4. 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 Virtual Machine Overview screen by clicking the name of the virtual machine.
     2. Click Actions.
5. Select Stop Virtual Machine.
6. In the confirmation window, click Stop to stop the virtual machine.

Procedure

1. Click Workloads → Virtualization from the side menu.
2. Click the Virtual Machines tab.
3. Find the row that contains the virtual machine that you want to unpause.

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

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

     1. In the Status column, click Paused.

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

     1. Access the Virtual Machine Overview screen by clicking the name of the virtual machine.
     2. Click the pencil icon that is located on the right side of Status.
5. In the confirmation window, click Unpause to unpause the virtual machine.