Chapter 6. Updating

Procedure

1. Run the following command and record the workloadUpdateMethods configuration:

   $ oc get kv kubevirt-kubevirt-hyperconverged \
     -n openshift-cnv -o jsonpath='{.spec.workloadUpdateStrategy.workloadUpdateMethods}'

2. Turn off all workload update methods by running the following command:

   $ oc patch hyperconverged kubevirt-hyperconverged -n openshift-cnv \
     --type json -p '[{"op":"replace","path":"/spec/workloadUpdateStrategy/workloadUpdateMethods", "value":[]}]'

   Example output

   hyperconverged.hco.kubevirt.io/kubevirt-hyperconverged patched

3. Ensure that the HyperConverged Operator is Upgradeable before you continue. Enter the following command and monitor the output:

   $ oc get hyperconverged kubevirt-hyperconverged -n openshift-cnv -o json | jq ".status.conditions"

   Example 6.1. Example output

   [
     {
       "lastTransitionTime": "2022-12-09T16:29:11Z",
       "message": "Reconcile completed successfully",
       "observedGeneration": 3,
       "reason": "ReconcileCompleted",
       "status": "True",
       "type": "ReconcileComplete"
     },
     {
       "lastTransitionTime": "2022-12-09T20:30:10Z",
       "message": "Reconcile completed successfully",
       "observedGeneration": 3,
       "reason": "ReconcileCompleted",
       "status": "True",
       "type": "Available"
     },
     {
       "lastTransitionTime": "2022-12-09T20:30:10Z",
       "message": "Reconcile completed successfully",
       "observedGeneration": 3,
       "reason": "ReconcileCompleted",
       "status": "False",
       "type": "Progressing"
     },
     {
       "lastTransitionTime": "2022-12-09T16:39:11Z",
       "message": "Reconcile completed successfully",
       "observedGeneration": 3,
       "reason": "ReconcileCompleted",
       "status": "False",
       "type": "Degraded"
     },
     {
       "lastTransitionTime": "2022-12-09T20:30:10Z",
       "message": "Reconcile completed successfully",
       "observedGeneration": 3,
       "reason": "ReconcileCompleted",
       "status": "True",
       "type": "Upgradeable" 1
     }
   ]

   1

   The OpenShift Virtualization Operator has the Upgradeable status.

4. Manually update your cluster from the source EUS version to the next minor version of OpenShift Container Platform:

   $ oc adm upgrade

   Verification

   • Check the current version by running the following command:

     $ oc get clusterversion

     Note

     Updating OpenShift Container Platform to the next version is a prerequisite for updating OpenShift Virtualization. For more details, refer to the "Updating clusters" section of the OpenShift Container Platform documentation.

5. Update OpenShift Virtualization.

   • With the default Automatic approval strategy, OpenShift Virtualization automatically updates to the corresponding version after you update OpenShift Container Platform.
   • If you use the Manual approval strategy, approve the pending updates by using the web console.

6. Monitor the OpenShift Virtualization update by running the following command:

   $ oc get csv -n openshift-cnv

7. Update OpenShift Virtualization to every z-stream version that is available for the non-EUS minor version, monitoring each update by running the command shown in the previous step.

8. Confirm that OpenShift Virtualization successfully updated to the latest z-stream release of the non-EUS version by running the following command:

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

   Example output

   [
     {
       "name": "operator",
       "version": "4.17.0"
     }
   ]

9. Wait until the HyperConverged Operator has the Upgradeable status before you perform the next update. Enter the following command and monitor the output:

   $ oc get hyperconverged kubevirt-hyperconverged -n openshift-cnv -o json | jq ".status.conditions"

10. Update OpenShift Container Platform to the target EUS version.

11. Confirm that the update succeeded by checking the cluster version:

    $ oc get clusterversion

12. Update OpenShift Virtualization to the target EUS version.

    • With the default Automatic approval strategy, OpenShift Virtualization automatically updates to the corresponding version after you update OpenShift Container Platform.
    • If you use the Manual approval strategy, approve the pending updates by using the web console.

13. Monitor the OpenShift Virtualization update by running the following command:

    $ oc get csv -n openshift-cnv

    The update completes when the VERSION field matches the target EUS version and the PHASE field reads Succeeded.

14. Restore the workloadUpdateMethods configuration that you recorded from step 1 with the following command:

    $ oc patch hyperconverged kubevirt-hyperconverged -n openshift-cnv --type json -p \
      "[{\"op\":\"add\",\"path\":\"/spec/workloadUpdateStrategy/workloadUpdateMethods\", \"value\":{WorkloadUpdateMethodConfig}}]"

    Example output

    hyperconverged.hco.kubevirt.io/kubevirt-hyperconverged patched

    Verification

    • Check the status of VM migration by running the following command:

      $ oc get vmim -A

Procedure

1. To open the HyperConverged CR in your default editor, run the following command:

   $ oc edit hyperconverged kubevirt-hyperconverged -n openshift-cnv

2. Edit the workloadUpdateStrategy stanza of the HyperConverged CR. For example:

   apiVersion: hco.kubevirt.io/v1beta1
   kind: HyperConverged
   metadata:
     name: kubevirt-hyperconverged
   spec:
     workloadUpdateStrategy:
       workloadUpdateMethods: 1
       - LiveMigrate 2
       - Evict 3
       batchEvictionSize: 10 4
       batchEvictionInterval: "1m0s" 5
   # ...

   1

   The methods that can be used to perform automated workload updates. The available values are LiveMigrate and Evict. If you enable both options as shown in this example, updates use LiveMigrate for VMIs that support live migration and Evict for any VMIs that do not support live migration. To disable automatic workload updates, you can either remove the workloadUpdateStrategy stanza or set workloadUpdateMethods: [] to leave the array empty.

   2

   The least disruptive update method. VMIs that support live migration are updated by migrating the virtual machine (VM) guest into a new pod with the updated components enabled. If LiveMigrate is the only workload update method listed, VMIs that do not support live migration are not disrupted or updated.

   3

   A disruptive method that shuts down VMI pods during upgrade. Evict is the only update method available if live migration is not enabled in the cluster. If a VMI is controlled by a VirtualMachine object that has runStrategy: Always configured, a new VMI is created in a new pod with updated components.

   4

   The number of VMIs that can be forced to be updated at a time by using the Evict method. This does not apply to the LiveMigrate method.

   5

   The interval to wait before evicting the next batch of workloads. This does not apply to the LiveMigrate method.

   Note

   You can configure live migration limits and timeouts by editing the spec.liveMigrationConfig stanza of the HyperConverged CR.

3. To apply your changes, save and exit the editor.