Chapter 2. Installing Dev Spaces

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. In the Administrator view of the OpenShift web console, go to Operators OperatorHub and search for Red Hat OpenShift Dev Spaces.

2. Install the Red Hat OpenShift Dev Spaces Operator.

   Tip

   See Installing from OperatorHub using the web console.

   Important

   The Red Hat OpenShift Dev Spaces Operator depends on the Dev Workspace Operator. If you install the Red Hat OpenShift Dev Spaces Operator manually to a non-default namespace, ensure that the Dev Workspace Operator is also installed in the same namespace. This is required as the Operator Lifecycle Manager will attempt to install the Dev Workspace Operator as a dependency within the Red Hat OpenShift Dev Spaces Operator namespace, potentially resulting in two conflicting installations of the Dev Workspace Operator if the latter is installed in a different namespace.

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

   oc create namespace openshift-devspaces

   Copy to Clipboard Toggle word wrap
4. 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.

   Tip

   See Creating applications from installed Operators.

1. In Red Hat OpenShift Dev Spaces instance Specification, go to devspaces, landing on the Details tab.

1. Under Message, check that there is None, which means no errors.
2. Under Red Hat OpenShift Dev Spaces URL, wait until the URL of the OpenShift Dev Spaces instance appears, and then open the URL to check the OpenShift Dev Spaces dashboard.
3. In the Resources tab, view the resources for 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 \
     --devworkspace_operator_index registry.redhat.io/redhat/redhat-operator-index:v4.13\
     --devworkspace_operator_version "v0.21.0" \
     --prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.13" \
     --prod_operator_package_name "devspaces" \
     --prod_operator_bundle_name "devspacesoperator" \
     --prod_operator_version "v3.8.0" \
     --my_registry "<my_registry>" 

   1

   Copy to Clipboard Toggle word wrap

   1

   The private Docker registry where the images will be mirrored

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 \
     --olm-channel stable \
     --catalog-source-name=devspaces-disconnected-install \
     --catalog-source-namespace=openshift-marketplace \
     --skip-devworkspace-operator \
     --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”.

Procedure

1. Run the following command:

   $ dsc server:status

   Copy to Clipboard Toggle word wrap
2. Copy the Red Hat OpenShift Dev Spaces URL without the trailing /dashboard/.