Chapter 11. Integrate with OpenShift

Procedure

1. List your workspaces:

   $ oc get devworkspaces

   Example output:

   NAMESPACE   NAME                 DEVWORKSPACE ID             PHASE     INFO
   user1-dev   spring-petclinic     workspace6d99e9ffb9784491   Running   https://url-to-workspace.com
   user1-dev   golang-example       workspacedf64e4a492cd4701   Stopped   Stopped
   user1-dev   python-hello-world   workspace69c26884bbc141f2   Failed    Container tooling has state CrashLoopBackOff

2. Optional: Add the --watch flag to show PHASE changes live:

   $ oc get devworkspaces --watch

3. Optional: Add the --all-namespaces flag to list workspaces from all OpenShift Dev Spaces users. This requires administrative permissions on the cluster.

   $ oc get devworkspaces --all-namespaces

Procedure

1. Copy the contents of the target Git repository’s devfile to prepare the DevWorkspace custom resource.

   For example:

   components:
     - name: tooling-container
       container:
         image: quay.io/devfile/universal-developer-image:ubi9-latest

   For more details, see the devfile v2 documentation.

2. Create a DevWorkspace custom resource, pasting the devfile contents from the previous step under the spec.template field.

   For example:

   kind: DevWorkspace
   apiVersion: workspace.devfile.io/v1alpha2
   metadata:
     name: my-devworkspace
     namespace: user1-dev
   spec:
     routingClass: che
     started: true
     contributions:
       - name: ide
         uri: http://devspaces-dashboard.openshift-devspaces.svc.cluster.local:8080/dashboard/api/editors/devfile?che-editor=che-incubator/che-code/latest
     template:
       projects:
         - name: my-project-name
           git:
             remotes:
               origin: https://github.com/eclipse-che/che-docs
       components:
         - name: tooling-container
           container:
             image: quay.io/devfile/universal-developer-image:ubi9-latest
             env:
               - name: CHE_DASHBOARD_URL
                 value: https://<openshift_dev_spaces_fqdn>/dashboard/

   where:

   name

   Name of the DevWorkspace custom resource. This is the name of the new workspace.

   namespace

   User namespace, which is the target project for the new workspace.

   started

   Determines whether the workspace must be started when the DevWorkspace custom resource is created.

   contributions

   URL reference to the Microsoft Visual Studio Code - Open Source IDE devfile.

   projects

   Details about the Git repository to clone into the workspace when it starts.

   components

   List of components such as workspace containers and volume components.

   CHE_DASHBOARD_URL

   URL to OpenShift Dev Spaces dashboard.

3. Apply the DevWorkspace custom resource to the cluster.

   $ oc apply -f <devworkspace>.yaml

Verification

1. Verify that the workspace is starting by checking the PHASE status of the DevWorkspace.

   $ oc get devworkspaces -n <user_project> --watch

   Example output:

   NAMESPACE        NAME                  DEVWORKSPACE ID             PHASE      INFO
   user1-dev        my-devworkspace       workspacedf64e4a492cd4701   Starting   Waiting for workspace deployment

2. When the workspace has successfully started, its PHASE status changes to Running in the output of the oc get devworkspaces command.

   Example output:

   NAMESPACE            NAME                  DEVWORKSPACE ID             PHASE      INFO
   user1-dev            my-devworkspace       workspacedf64e4a492cd4701   Running    https://url-to-workspace.com

   You can then open the workspace by using one of these options:

   • Visit the URL provided in the INFO section of the output of the oc get devworkspaces command.
   • Open the workspace from the OpenShift Dev Spaces dashboard.

Procedure

1. Run the following command to stop a workspace:

   $ oc patch devworkspace <workspace_name> \
   -p '{"spec":{"started":false}}' \
   --type=merge -n <user_namespace> && \
   oc wait --for=jsonpath='{.status.phase}'=Stopped \
   dw/<workspace_name> -n <user_namespace>

Procedure

1. Run the following command to start a stopped workspace:

   $ oc patch devworkspace <workspace_name> \
   -p '{"spec":{"started":true}}' \
   --type=merge -n <user_namespace> && \
   oc wait --for=jsonpath='{.status.phase}'=Running \
   dw/<workspace_name> -n <user_namespace>

Procedure

1. Open the OpenShift Dev Spaces dashboard and start a workspace.
2. After the workspace starts, open a terminal in the workspace container.

3. Run oc or kubectl commands to deploy applications, inspect and manage cluster resources, or view logs. The injected OpenShift user token authenticates these commands automatically.

   $ oc get pods

   

Procedure

1. Open the Topology view to list all projects.
2. In the Select an Application search field, type workspace to list all workspaces.

3. Click the workspace to edit.

   The deployments are displayed as graphical circles surrounded by circular buttons. One of these buttons is Edit Source Code.

   
4. Click the Edit Source Code button. This redirects to a workspace with the cloned source code of the application component.

Procedure

1. Open the Red Hat Applications menu by using the three-by-three matrix icon in the upper right corner of the main screen.

   The drop-down menu displays the available applications.

   
2. Click the OpenShift Dev Spaces link to open the Red Hat OpenShift Dev Spaces Dashboard.

Procedure

1. Open the OpenShift Dev Spaces dashboard and click the three-by-three matrix icon in the upper right corner of the main screen.

   The drop-down menu displays the available applications.

   
2. Click the OpenShift console link to open the OpenShift web console.