Hello World for Red Hat OpenShift Dev Spaces (formerly CodeReady Workspaces)

About This Page

This page has two parts:

1. Install OpenShift Dev Spaces (Dev Spaces).
2. Get a "Hello World" example application open in OpenShift Dev Spaces.

Install via Operator Hub

There is a recommended method for creating an OpenShift Dev Spaces instance in your OpenShift cluster. Explore the administrative guide for more information.

Install via command line

Important note: Creating the OpenShift Dev Spaces instance using the command line is supported for versions of OpenShift 4.10 or higher. It is recommended that you use the OpenShift Dev Spaces Operator, located in the Operator Hub, to install Dev Spaces.

1. Download and install the command-line tool, dsc

3 minutes

1. Navigate to https://developers.redhat.com/products/openshift-dev-spaces/download.
2. Download the OpenShift Dev Spaces CLI management tool archive for version 3.0.
3. Extract the archive.
4. Place the extracted binary in your $PATH.

2. Use dsc to create an OpenShift Dev Spaces instance in your cluster

10 minutes

1. Log into your OpenShift cluster with cluster-admin rights.

2. From your command line, run the command: 

   dsc server:start

This will create an OpenShift Dev Spaces instance in the OpenShift namespace /project/openshift-devspaces (which will be created if it does not exist). When it is finished, the Dev Spaces URL will be returned.

Run a sample workspace

After logging in to your Dev Spaces instance, select any sample project.

Run a workspace for your own Git project

After logging in to your Dev Spaces instance, enter the Git Repo URL and click Create & Open. If your project does not already include a devfile.yaml, a default configuration will be loaded. To learn more about devfiles, see https://devfile.io/docs/devfile/2.1.0/user-guide/