Chapter 2. Installing Dev Spaces

Procedure

1. Download the archive from https://developers.redhat.com/products/openshift-dev-spaces/download to a directory such as $HOME.
2. Run tar xvzf on the archive to extract the /dsc directory.
3. Add the extracted /dsc/bin subdirectory to $PATH.

Procedure

1. Optional: If you previously deployed OpenShift Dev Spaces on this OpenShift cluster, ensure that the previous OpenShift Dev Spaces instance is removed:

   $ dsc server:delete

   Copy to Clipboard Toggle word wrap

2. Create the OpenShift Dev Spaces instance:

   $ dsc server:deploy --platform openshift

   Copy to Clipboard Toggle word wrap

Verification steps

1. Verify the OpenShift Dev Spaces instance status:

   $ dsc server:status

   Copy to Clipboard Toggle word wrap

2. Navigate to the OpenShift Dev Spaces cluster instance:

   $ dsc dashboard:open

   Copy to Clipboard Toggle word wrap

Procedure

1. Optional: If you previously deployed OpenShift Dev Spaces on this OpenShift cluster, ensure that the previous OpenShift Dev Spaces instance is removed:

   $ dsc server:delete

   Copy to Clipboard Toggle word wrap
2. Install the Red Hat OpenShift Dev Spaces Operator. See Installing from OperatorHub using the web console.

3. Create the openshift-devspaces project in OpenShift as follows:

   oc create namespace openshift-devspaces

   Copy to Clipboard Toggle word wrap
4. In the Administrator view of the OpenShift web console, go to Operators Installed Operators Red Hat OpenShift Dev Spaces instance Specification Create CheCluster YAML view.
5. In the YAML view, replace namespace: openshift-operators with namespace: openshift-devspaces.
6. Select Create. 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.

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.11" \
     --devworkspace_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.10" \
     --devworkspace_operator_version "v0.18.1" \
     --prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.10" \
     --prod_operator_package_name "devspaces-operator" \
     --prod_operator_version "v3.4.0" \
     --my_registry "<my_registry>" \
     --my_catalog "<my_catalog>"

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap
3. Allow incoming traffic from the OpenShift Dev Spaces namespace to all Pods in the user projects. See: Section 3.7.1, “Configuring network policies”.