Chapter 3. Installing

Procedure

1. From the Administrator perspective, click Ecosystem Software Catalog.
2. In the Filter by keyword field, type Virtualization.
3. Select the OpenShift Virtualization Operator 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 Dedicated 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.

      Selecting the Manual approval strategy is not recommended, as it poses a high risk to cluster support and functionality. 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 Dedicated 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
     labels:
       openshift.io/cluster-monitoring: "true"
   ---
   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.21.3
     channel: "stable"

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

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

   $ oc apply -f <filename>.yaml

1. Check that the ClusterServiceVersion (CSV) object was created successfully. Run the following command and verify the output:

   $ oc get csv -n openshift-cnv

   If the CSV was created successfully, the output shows an entry that contains a NAME value of kubevirt-hyperconverged-operator-*, a DISPLAY value of OpenShift Virtualization, and a PHASE value of Succeeded, as shown in the following example output:

   Example output:

   NAME                                       DISPLAY                    VERSION   REPLACES                                   PHASE
   kubevirt-hyperconverged-operator.v4.21.3   OpenShift Virtualization   4.21.3    kubevirt-hyperconverged-operator.v4.20.0   Succeeded

2. Check that the HyperConverged custom resource (CR) has the correct version. Run the following command and verify the output:

   $ oc get hco -n openshift-cnv kubevirt-hyperconverged -o json | jq .status.versions

   Example output:

   {
   "name": "operator",
   "version": "4.21.3"
   }

3. Verify the HyperConverged CR conditions. Run the following command and check the output:

   $ oc get hco kubevirt-hyperconverged -n openshift-cnv -o json | jq -r '.status.conditions[] | {type,status}'

   Example output:

   {
     "type": "ReconcileComplete",
     "status": "True"
   }
   {
     "type": "Available",
     "status": "True"
   }
   {
     "type": "Progressing",
     "status": "False"
   }
   {
     "type": "Degraded",
     "status": "False"
   }
   {
     "type": "Upgradeable",
     "status": "True"
   }

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 the Ecosystem Installed Operators page.
2. Select the OpenShift Virtualization Operator.
3. Click the OpenShift Virtualization Deployment tab.
4. Click the Options menu beside kubevirt-hyperconverged and select Delete HyperConverged.
5. Click Delete in the confirmation window.

Procedure

1. Navigate to the Ecosystem Installed Operators page.
2. Scroll or enter a keyword into the Filter by name field to find the Operator that you want to remove. Then, click on it.

3. On the right side of the Operator Details page, select Uninstall Operator from the Actions list.

   An Uninstall Operator? dialog box is displayed.

4. Select Uninstall to remove the Operator, Operator deployments, and pods. Following this action, the Operator stops running and no longer receives updates.

   Note

   This action does not remove resources managed by the Operator, including custom resource definitions (CRDs) and custom resources (CRs). Dashboards and navigation items enabled by the web console and off-cluster resources that continue to run might need manual clean up. To remove these after uninstalling the Operator, you might need to manually delete the Operator CRDs.

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. Navigate to Administration CustomResourceDefinitions.
2. Select the Label filter and enter operators.coreos.com/kubevirt-hyperconverged.openshift-cnv in the Search field to display the OpenShift Virtualization CRDs.
3. Click the Options menu beside each CRD and select Delete CustomResourceDefinition.

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 hco-operatorhub -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