Chapter 3. OpenShift Virtualization installation

Procedure

1. Open a browser window and log in to the OpenShift Container Platform web console.
2. Navigate to the Operators OperatorHub page.
3. Search for OpenShift Virtualization and then select it.
4. Read the information about the Operator and click Install.

5. On the Install Operator page:

   1. 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.

   2. 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.
   3. For Approval Strategy, ensure that Automatic, which is the default value, is selected. OpenShift Virtualization automatically updates when a new z-stream release is available.

6. Click Install to make the Operator available to the openshift-cnv namespace.

   On the Installed Operators screen, the Status displays Succeeded when OpenShift Virtualization finishes installation.

Procedure

1. Navigate to the Operators Installed Operators page.
2. Click OpenShift Virtualization.

3. Click the OpenShift Virtualization Operator Deployment tab and click Create HyperConverged Cluster.

   Warning

   To avoid deployment errors, do not rename the custom resource. Before you proceed to the next step, ensure that the custom resource is named the default kubevirt-hyperconverged.

4. Click Create to launch OpenShift Virtualization.
5. Navigate to the Workloads Pods page and monitor the OpenShift Virtualization pods until they are all Running. After all the pods display the Running state, you can access 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.v2.5.8
     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:
     BareMetalPlatform: true

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=custom-columns=: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.v2.5.8" deleted