Chapter 6. Installing

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