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.
- 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.
Extract the archive to a folder, such as
dscexecutable from the extracted folder. For example:
Optionally, to enable running
dscwithout the full path specification, add the extracted
binfolder to your
$PATH. For example:
Display the current version of the tool.
$ dsc version
2.2. Installing OpenShift Dev Spaces on OpenShift using the
dsc management tool
You can install OpenShift Dev Spaces on OpenShift.
Create the OpenShift Dev Spaces instance:
$ dsc server:deploy --platform openshift
Verify the OpenShift Dev Spaces instance status:
$ dsc server:status
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.
- An OpenShift web console session by a cluster administrator. See Accessing the web console.
- 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.
CheClusterand navigate to the Details tab.
See the content of the following fields:
The Message field contains error messages. The expected content is
- 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.
- The Message field contains error messages. The expected content is
- 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.
- The OpenShift cluster has at least 64 GB of disk space.
- The OpenShift cluster is ready to operate on a restricted network, and the OpenShift control plane has access to the public internet. See About disconnected installation mirroring and Using Operator Lifecycle Manager on restricted networks.
opm. See Installing the
jq. See Downloading
podman. See Installing Podman.
skopeosession with administrative access to the <my_registry> registry. See Installing Skopeo, Authenticating to a registry, and Mirroring images for a disconnected installation.
dscfor OpenShift Dev Spaces version 3.0. See Section 2.1, “Install the dsc management tool”.
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>"
Install OpenShift Dev Spaces with the configuration set in the
che-operator-cr-patch.yamlduring the previous step:
$ dsc server:deploy --platform=openshift \ --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml