Chapter 2. Installing OpenShift Dev Spaces

This section contains instructions to install Red Hat OpenShift Dev Spaces.

You can deploy only one instance of OpenShift Dev Spaces per cluster.

2.1. Install the dsc management tool

You can install dsc, the Red Hat OpenShift Dev Spaces command-line management tool, on Microsoft Windows, Apple MacOS, and Linux. With dsc, you can perform operations the OpenShift Dev Spaces server such as starting, stopping, updating, and deleting the server.

Procedure

  1. Navigate to https://developers.redhat.com/products/openshift-dev-spaces/download, and download the OpenShift Dev Spaces CLI management tool archive for version 3.0.
  2. Extract the archive to a folder, such as $HOME/dsc.

  3. Run the dsc executable from the extracted folder. For example: 

    $ $HOME/dsc/bin/dsc

  4. Optionally, to enable running dsc without the full path specification, add the extracted bin folder to your $PATH. For example: 

    PATH=$PATH:$HOME/dsc/bin

Verification step

  • Display the current version of the tool. 

    $ dsc version

Additional resources

2.2. Installing OpenShift Dev Spaces on OpenShift using the dsc management tool

You can install OpenShift Dev Spaces on OpenShift.

Prerequisites

Procedure

  • Create the OpenShift Dev Spaces instance: 

    $ dsc server:deploy --platform openshift

Verification steps

  1. Verify the OpenShift Dev Spaces instance status: 

    $ dsc server:status

  2. Navigate to the OpenShift Dev Spaces cluster instance: 

    $ dsc dashboard:open

2.3. Installing OpenShift Dev Spaces on OpenShift using the web console

This section describes how to install OpenShift Dev Spaces using the OpenShift web console. Consider Section 2.2, “Installing OpenShift Dev Spaces on OpenShift using the dsc management tool” instead.

Prerequisites

Procedure

  1. Install the Red Hat OpenShift Dev Spaces Operator. See Installing from OperatorHub using the web console.
  2. Create a OpenShift Dev Spaces instance from the Red Hat OpenShift Dev Spaces Operator. See Creating applications from installed Operators.

Verification

  1. To verify that the OpenShift Dev Spaces instance has installed correctly, navigate to the Dev Spaces Cluster tab of the Operator details page. The Red Hat OpenShift Dev Spaces instance Specification page displays the list of Red Hat OpenShift Dev Spaces instances and their status.
  2. Click devspaces CheCluster and navigate to the Details tab.

  3. See the content of the following fields:

    • The Message field contains error messages. The expected content is None.
    • The Red Hat OpenShift Dev Spaces URL field contains the URL of the Red Hat OpenShift Dev Spaces instance. The URL appears when the deployment finishes successfully.
  4. Navigate to the Resources tab. View the list of resources assigned to the OpenShift Dev Spaces deployment and their status.

2.4. Installing OpenShift Dev Spaces in a restricted environment on OpenShift

On an OpenShift cluster operating in a restricted network, public resources are not available.

However, deploying OpenShift Dev Spaces and running workspaces requires the following public resources:

  • Operator catalog
  • Container images
  • Sample projects

To make these resources available, you can replace them with their copy in a registry accessible by the OpenShift cluster.

Prerequisites

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 \
  --ocp_ver "4.10" \
  --devworkspace_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.10" \
  --devworkspace_operator_version "v0.15.2" \
  --prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.10" \
  --prod_operator_bundle_name "devspacesoperator" \
  --prod_operator_package_name "devspaces-operator" \
  --prod_operator_version "v3.0.1" \
  --my_registry "<my_registry>"

  2. Install OpenShift Dev Spaces with the configuration set in the che-operator-cr-patch.yaml during the previous step: 

    $ dsc server:deploy --platform=openshift \
  --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml

Additional resources