Chapter 4. Installing CodeReady Workspaces in restricted environments

Procedure

1. Import the required images from an external registry to a local registry that your OpenShift Container Platform cluster can reach. See Section 4.4, “Making CodeReady Workspaces images available from a local registry” for example instructions on how to do this.

2. Edit the custom-resource.yaml configuration file to specify that the CodeReady Workspaces deployment script should use images from your internal registry. Add the following specification fields to the respective blocks. Use the address of your internal registry and the name of the OpenShift project into which you imported the images. For example:

     spec:
   
       storage:
         pvcJobsImage: '172.0.0.30:5000/openshift/ubi8-minimal:8.0-127'
   
       database:
         postgresImage: '172.0.0.30:5000/openshift/rhscl/postgresql-96-rhel7:1-40'
   
       auth:
         identityProviderImage: '172.0.0.30:5000/openshift/redhat-sso-7/sso73-openshift:1.0-11'

   Important

   • Make sure to use correct indentation as shown above.
   • Substitute 172.0.0.30:5000 for the actual address of your local registry.
   • Substitute openshift for the name of the OpenShift project into which you imported the images.

1. Use the --server-image and --version parameters to specify the server image and the --operator-image parameter to specify the operator image. For example:

   $ ./deploy.sh --deploy \
     --server-image=172.0.0.30:5000/openshift/codeready-workspaces/server-rhel8 \
     --version=1.2 \
     --operator-image=172.0.0.30:5000/openshift/codeready-workspaces/server-operator-rhel8:1.2

   Important

   • Substitute 172.0.0.30:5000 for the actual address of your local registry.
   • Substitute openshift for the name of the OpenShift project into which you imported the images.

1. Import all of the following images you need to an internal registry:

   • registry.redhat.io/codeready-workspaces/stacks-java-rhel8:1.2
   • registry.redhat.io/codeready-workspaces/stacks-node-rhel8:1.2
   • registry.redhat.io/codeready-workspaces/stacks-node:1.2
   • registry.redhat.io/codeready-workspaces/stacks-php-rhel8:1.2
   • registry.redhat.io/codeready-workspaces/stacks-python-rhel8:1.2
   • registry.redhat.io/codeready-workspaces/stacks-dotnet-rhel8:1.2
   • registry.redhat.io/codeready-workspaces/stacks-golang-rhel8:1.2
   • registry.redhat.io/codeready-workspaces/stacks-java-rhel8:1.2

   • registry.redhat.io/codeready-workspaces/stacks-cpp-rhel8:1.2

     See Section 4.4, “Making CodeReady Workspaces images available from a local registry” for example instructions on how to transfer container images required for CodeReady Workspaces deployment to a restricted environment.

2. Modify the preconfigured stacks:

   1. Log in to CodeReady Workspaces as an administrator. (The default login credentials are username: admin and password: admin.)
   2. In the left pane, click Stacks.

   3. From the list of stacks, select a stack to edit.

      Figure 4.1. Selecting a stack to edit

      
   4. Click and expand DEV-MACHINE.

   5. In the Source field, replace the default Red Hat Container Catalog image with a local image that you pushed to an internal registry.

      Figure 4.2. Editing a stack

      

   6. Click Save.

      Repeat step 2 for all the stacks that you want to use.

3. By default, the CodeReady Workspaces server is configured to overwrite default stacks on application start. To ensure that the changes persist between restarts, edit the custom config map:

   1. In the OpenShist Web Console, navigate to the Resources > Config Maps tab, and select the custom config map:

      Figure 4.3. Navigate to the custom Config Map

      
   2. From the Actions drop-down menu in the top-right corner, select Edit.

   3. Scroll to the CHE_PREDEFINED_STACKS_RELOAD__ON__START key, and enter false:

      Figure 4.4. Set the CHE_PREDEFINED_STACKS_RELOAD__ON__START key to false

      
   4. Save the config map.

4. Forcibly start a new CodeReady Workspaces deployment, either by scaling the current deployment to 0 and then back to 1, or deleting the CodeReady Workspaces server pod:

   1. In the OpenShist Web Console, navigate to the Applications > Deployments tab, and select the codeready deployment:

      Figure 4.5. Select the codeready deployment

      
   2. Click the name of the running codeready pod.

   3. Click the down arrow next to the number of pods, and confirm by clicking the Scale Down button:

      Figure 4.6. Scale down the codeready deployment

      
   4. Scale the deployment back up by clicking the up arrow.

Steps to perform on a machine with connection to the Internet

1. Pull the required images from the registry.redhat.io. For example, for 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 you need.

2. Save all the pulled images to a tar file in your current directory on the disk. For example, for the codeready-workspaces/server-rhel8 image, run:

   # podman save --output codeready-server.tar \
     registry.redhat.io/codeready-workspaces/server-rhel8:1.2

   Repeat the command for all the images you need.

Steps to perform on a machine within the restricted environment

1. Load all the required images to the local container repository from which they can uploaded to OpenShift. For example, for the codeready-workspaces/server-rhel8 image, run:

   # podman load --input codeready-server.tar

   Repeat the command for all the images you need.

2. Optionally, check that the images have been successfully loaded to your local container repository. For example, to check for the codeready images, run:

   # podman images */codeready/*
   REPOSITORY                                                TAG
   registry.redhat.io/codeready-workspaces/server-rhel8    1.2
   registry.redhat.io/codeready-workspaces/server-operator-rhel8  1.2

3. Log in to the instance of OpenShift Container Platform where you intend to deploy CodeReady Workspaces as a user with the cluster-admin role. For example, to log in as the user admin, run:

   $ oc login --username <admin> --password <password>

   In the above command, substitute <admin> for the username of the account you intend to use to deploy CodeReady Workspaces and <password> for the associated password.

4. Log in with podman to the local OpenShift registry that CodeReady Workspaces will be deployed from:

   # podman login --username <admin> \
     --password $(oc whoami --show-token) 172.0.0.30:5000

   In the above command:

   • Substitute <admin> for the username of the account you used to log in to OpenShift.
   • Substitute 172.0.0.30:5000 for the URL of the local OpenShift registry to which you are logging in.

5. Tag the required images to prepare them to be pushed to the local OpenShift registry. For example, for the codeready-workspaces/server-rhel8 image, run:

   # podman tag registry.redhat.io/codeready-workspaces/server-rhel8:1.2 \
     172.0.0.30:5000/openshift/codeready-server:1.2

   Repeat the command for all the images you need.

   In the above command, substitute 172.0.0.30:5000 for the URL of the local OpenShift registry to which you will be pushing the images.

6. Optionally, check that the images have been successfully tagged for pushing to the local OpenShift registry. For example, to check for the codeready images, run:

   # podman images */openshift/codeready-*
   REPOSITORY                                    TAG
   172.0.0.30:5000/openshift/codeready-operator  1.2
   172.0.0.30:5000/openshift/codeready-server    1.2

7. Push the required images to the local OpenShift registry. For example, for the codeready-workspaces/server-rhel8 image, run:

   # podman push 172.0.0.30:5000/openshift/codeready-server:1.2

   Repeat the command for all the images you need.

   In the above command, substitute 172.0.0.30:5000 for the URL of the local OpenShift registry to which you will be pushing the images.

8. Switch to the openshift project:

   $ oc project openshift

9. Optionally, check that the images have been successfully pushed to the local OpenShift registry. For example, to check for the codeready images, run:

   $ oc get imagestream codeready-*
   NAME                DOCKER REPO                                   TAGS
   codeready-operator  172.0.0.30:5000/openshift/codeready-operator  1.2
   codeready-server    172.0.0.30:5000/openshift/codeready-server    1.2

   You can also verify that the images have been successfully pushed in the OpenShift Console. Navigate to the Builds > Images tab, and look for image streams available in the openshift project:

   Figure 4.7. Confirming images have been pushed to the openshift project