Chapter 7. Upgrading Dev Spaces

Procedure

1. In the OpenShift web console, navigate to Operators Installed Operators.
2. Click Red Hat OpenShift Dev Spaces in the list of installed Operators.
3. Navigate to the Subscription tab.
4. Configure the Update approval strategy to Automatic or Manual.

Verification steps

1. Navigate to the OpenShift Dev Spaces instance.
2. The 3.17 version number is visible at the bottom of the page.

Procedure

1. Save and push changes back to the Git repositories for all running CodeReady Workspaces 3.1 workspaces.
2. Shut down all workspaces in the CodeReady Workspaces 3.1 instance.

3. Upgrade OpenShift Dev Spaces:

   $ dsc server:update -n openshift-devspaces

   Note

   For slow systems or internet connections, add the --k8spodwaittimeout=1800000 flag option to extend the Pod timeout period to 1800000 ms or longer.

Verification steps

1. Navigate to the OpenShift Dev Spaces instance.
2. The 3.17 version number is visible at the bottom of the page.

Procedure

1. Download and execute the mirroring script to install a custom Operator catalog and mirror the related images: prepare-restricted-environment.sh.

   $ bash prepare-restricted-environment.sh \
     --devworkspace_operator_index registry.redhat.io/redhat/redhat-operator-index:v4.17\
     --devworkspace_operator_version "v0.31.0" \
     --prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.17" \
     --prod_operator_package_name "devspaces" \
     --prod_operator_bundle_name "devspacesoperator" \
     --prod_operator_version "v3.17.0" \
     --my_registry "<my_registry>" 1

   1

   The private Docker registry where the images will be mirrored

2. In all running workspaces in the CodeReady Workspaces 3.1 instance, save and push changes back to the Git repositories.
3. Stop all workspaces in the CodeReady Workspaces 3.1 instance.

4. Run the following command:

   $ dsc server:update --che-operator-image="$TAG" -n openshift-devspaces --k8spodwaittimeout=1800000

Verification steps

1. Navigate to the OpenShift Dev Spaces instance.
2. The 3.17 version number is visible at the bottom of the page.

Procedure

1. Delete the devworkspace-controller namespace that contains the failing pod.

2. Update DevWorkspace and DevWorkspaceTemplate Custom Resource Definitions (CRD) by setting the conversion strategy to None and removing the entire webhook section:

   spec:
     ...
     conversion:
       strategy: None
   status:
   ...

   Tip

   You can find and edit the DevWorkspace and DevWorkspaceTemplate CRDs in the Administrator perspective of the OpenShift web console by searching for DevWorkspace in Administration CustomResourceDefinitions.

   Note

   The DevWorkspaceOperatorConfig and DevWorkspaceRouting CRDs have the conversion strategy set to None by default.

3. Remove the Dev Workspace Operator subscription:

   $ oc delete sub devworkspace-operator \
   -n openshift-operators 1

   1

   openshift-operators or an OpenShift project where the Dev Workspace Operator is installed.

4. Get the Dev Workspace Operator CSVs in the <devworkspace_operator.vX.Y.Z> format:

   $ oc get csv | grep devworkspace

5. Remove each Dev Workspace Operator CSV:

   $ oc delete csv <devworkspace_operator.vX.Y.Z> \
   -n openshift-operators 1

   1

   openshift-operators or an OpenShift project where the Dev Workspace Operator is installed.

6. Re-create the Dev Workspace Operator subscription:

   $ cat <<EOF | oc apply -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: devworkspace-operator
     namespace: openshift-operators
   spec:
     channel: fast
     name: devworkspace-operator
     source: redhat-operators
     sourceNamespace: openshift-marketplace
     installPlanApproval: Automatic 1
     startingCSV: devworkspace-operator.v0.31.0
   EOF

   1

   Automatic or Manual.

   Important

   For installPlanApproval: Manual, in the Administrator perspective of the OpenShift web console, go to Operators Installed Operators and select the following for the Dev Workspace Operator: Upgrade available Preview InstallPlan Approve.

7. In the Administrator perspective of the OpenShift web console, go to Operators Installed Operators and verify the Succeeded status of the Dev Workspace Operator.