Chapter 6. Upgrading CodeReady Workspaces

Procedure

1. To upgrade from CodeReady Workspaces 1.1 to CodeReady Workspaces 1.2, run the following command (the default project namespace is workspaces):

   $ ./migrate_1.1_to_1.2.sh -n=<OpenShift-project-name>

   Important

   Substitute <OpenShift-project-name> for the project namespace that you are using.

1. Pull the required images from registry.redhat.io. For example, to pull the codeready-workspaces/server-rhel8 image, run:

   # podman pull registry.redhat.io/codeready-workspaces/server-rhel8:1.2

   Repeat the command for all the images that you want to pull.

1. To upgrade from CodeReady Workspaces 1.1 to CodeReady Workspaces 1.2, run a command like the following, using the correct registry and image names used in the previous steps (The default project namespace is workspaces. Your registry, container names, and tag versions may vary.)

   $ ./migrate_1.1_to_1.2.sh --project=<workspaces> \
        --server-image=registry.yourcompany.com:5000/crw-server-rhel8:1.2 \
        --operator-image=registry.yourcompany.com:5000/crw-server-operator-rhel8:1.2 \
        --identity-provider-image=registry.yourcompany.com:5000/redhat-sso73-openshift:1.0-11 \
        --postgres-image=registry.yourcompany.com:5000/rhscl-postgresql-96-rhel7:1-40 \
        --pvc-jobs-image=registry.yourcompany.com:5000/rhel8-ubi8-minimal:8.0-127 \
        --verbose

Procedure

1. Log in to the registry.redhat.io registry. For details, see https://access.redhat.com/RegistryAuthentication#using-authentication-3.

2. To keep your login secret for the registry.redhat.io registry in a separate file, run the following command:

   $ docker --config /tmp/CRW.docker.config.json login https://registry.redhat.io

   If you do not keep the secret in a seperate file, the secret is stored in the ~/.docker/config.json file and all your secrets are imported to OpenShift in the following step.

3. To add your secret to OpenShift, run the following commands:

   $ oc create secret generic registryredhatio --type=kubernetes.io/dockerconfigjson --from-file=.dockerconfigjson=/tmp/CRW.docker.config.json && \
   oc secrets link default registryredhatio --for=pull && \
   oc secrets link builder registryredhatio

   If the secret is added successfully, the following query shows your new secret:

   $ oc get secret registryredhatio

   If unsuccessful, see https://access.redhat.com/RegistryAuthentication#allowing-pods-to-reference-images-from-other-secured-registries-9.

4. Select your CodeReady Workspaces deployment (the default project namespace is workspaces):

   $ oc project -n=<OpenShift-project-name>

   Important

   Substitute <OpenShift-project-name> for the project namespace that you are using.

5. Obtain the DB_PASSWORD from the running CodeReady Workspaces instance:

   $ DB_PASSWORD=$(oc get deployment keycloak -o=jsonpath={'.spec.template.spec.containers[0].env[?(@.name=="DB_PASSWORD")].value'})

6. Create the JSON patch:

   $ PATCH_JSON=$(cat << EOF
   {
    "spec": {
      "database": {
        "postgresImage": "registry.redhat.io/rhscl/postgresql-96-rhel7:1-40"
      },
      "auth": {
        "identityProviderImage": "registry.redhat.io/redhat-sso-7/sso73-openshift:1.0-11",
        "identityProviderPostgresPassword":"${DB_PASSWORD}"
      },
      "server": {
        "cheImage":"registry.redhat.io/codeready-workspaces/server-rhel8",
        "cheImageTag":"1.2"
      }
    }
   }
   EOF
   )

7. Patch the running cluster:

   $ oc patch checluster codeready -p "${PATCH_JSON}" --type merge

8. Scale down the running deployments:

   $ oc scale deployment/codeready --replicas=0 && \
   oc scale deployment/keycloak --replicas=0

9. Update the operator image and wait until the update is complete:

   $ oc set image deployment/codeready-operator *=registry.redhat.io/codeready-workspaces/server-operator-rhel8:1.2

10. After the operator is redeployed, scale up the keycloak deployment (RH SSO) and wait until the update is complete:

    $ oc scale deployment/keycloak --replicas=1

11. After keycloak is redeployed, scale up the CodeReady Workspaces deployment (Che Server) and wait until the update is complete:

    $ oc scale deployment/codeready --replicas=1

12. After CodeReady Workspaces is redeployed, set the new image for PostgreSQL:

    $ oc set image deployment/postgres "*=registry.redhat.io/rhscl/postgresql-96-rhel7:1-40"

13. Scale down the PostgreSQL deployment and then scale it back up. Wait until the update is complete:

    $ oc scale deployment/postgres --replicas=0 && \
    oc scale deployment/postgres --replicas=1