Creating the Che project in OpenShift 4 web console

This section describes how to create the Che project in OpenShift 4 web console.

Prerequisites

  • An administrator account on a running instance of OpenShift 4.

Procedure

  1. Open the OpenShift web console.

  2. In the left panel, navigate to Projects.

  3. Click the Create Project button.

  4. Enter the project details:

    • In the Name field, type che.

    • In the Display Name field, type Eclipse Che.

  5. Click the Create button.

Installing the Che Operator in OpenShift 4 web console

This section describes how to install the Che Operator in OpenShift 4 web console.

Prerequisites

  • An administrator account on a running instance of OpenShift 4.

  • Administrative rights on an existing project named che on this instance of OpenShift 4. See Creating the Che project in OpenShift 4 web console.

  • The Eclipse Che 6.x Operator is not installed.

Procedure

  1. Open the OpenShift web console.

  2. In the left panel, navigate to the Operators → OperatorHub section.

  3. In the Search by keyword field, type Eclipse Che.

  4. Click on the Eclipse Che tile.

  5. Click the Install button in the Eclipse Che pop-up window.

  6. In the A specific namespace on the cluster field, in the cluster drop-down list, select che.

  7. Click the Subscribe button.

  8. In the left panel, navigate to the Operators → Installed Operators section.

  9. Eclipse Che is displayed as an installed Operator having the InstallSucceeded status.

  10. Click on the Eclipse Che name in the list of installed operators.

  11. Navigate to the Overview tab.

  12. In the Conditions sections at the bottom of the page, wait for this message: install strategy completed with no errors.

  13. Navigate to the Events tab.

  14. Wait for this message: install strategy completed with no errors.

Installing Che using the Che Operator in OpenShift 4 web console

This section describes how to install Che using the Che Operator in OpenShift 4 web console.

Prerequisites

Procedure

  1. Open the OpenShift web console.

  2. Navigate to the Operators → Installed Operators section.

  3. Click Eclipse Che in the list of installed operators.

  4. Click the Create Instance link in Provided APIs section.

  5. The Create Che Cluster page is displayed.

  6. Leave the default values as they are.

  7. Click the Create button in the bottom-left corner of the window.

  8. The eclipse-che cluster is created.

    eclipse che cluster create che cluster

Viewing the state of the Che cluster deployment in OpenShift 4 web console

This section describes how to view the state of the Che cluster deployment in OpenShift 4 web console.

Prerequisites

Procedure

  1. Open the OpenShift web console.

  2. Navigate to the Operators → Installed Operators section.

  3. Click Eclipse Che in the list of installed operators.

  4. Navigate to the Eclipse Che Cluster tab.

  5. Click on the eclipse-che cluster that is listed in the table.

  6. Navigate to the Overview tab.

  7. Watch the content of the Message field. The field contain error messages, if any. The expected content is None.

  8. Navigate to the Resources tab.

  9. The screen displays the state of the resources assigned to the Che cluster deployment.

    eclipse che resources tab

Finding Che cluster URL in OpenShift 4 web console

This section descibes how to find the Che cluster URL in OpenShift 4 web console.

Prerequisites

Procedure

  1. Open the OpenShift web console.

  2. In the left panel, navigate to the Operators → Installed Operators section.

  3. Click on the Eclipse Che Operator tile.

  4. Click on eclipse-che in the table.

  5. Navigate to the Overview tab.

  6. Read the content of the ECLIPSE CHE URL field.

Viewing the state of the Che cluster deployment using OpenShift 4 CLI tools

This section describes how to view the state of the Che cluster deployment using OpenShift 4 CLI tools.

Prerequisites

Procedure

  1. Run the following commands to select the che project:

    $ oc project che

  2. Run the following commands to get the name and status of the pods running in the selected project:

    $ oc get pods

  3. Check that the status of all pods is Running.

    NAME                            READY     STATUS    RESTARTS   AGE
che-8495f4946b-jrzdc            0/1       Running   0          86s
che-operator-578765d954-99szg   1/1       Running   0          42m
keycloak-74fbfb9654-g9vp5       1/1       Running   0          4m32s
postgres-5d579c6847-w6wx5       1/1       Running   0          5m14s

  4. Run the following command:

    $ oc logs --tail=10 -f oc get pods -o name | grep operator

  5. This is an example output of the command:

    time="2019-07-12T09:48:29Z" level=info msg="Exec successfully completed"
time="2019-07-12T09:48:29Z" level=info msg="Updating eclipse-che CR with status: provisioned with OpenShift identity provider: true"
time="2019-07-12T09:48:29Z" level=info msg="Custom resource eclipse-che updated"
time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: ConfigMap, name: che"
time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: ConfigMap, name: custom"
time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: Deployment, name: che"
time="2019-07-12T09:48:30Z" level=info msg="Updating eclipse-che CR with status: Che API: Unavailable"
time="2019-07-12T09:48:30Z" level=info msg="Custom resource eclipse-che updated"
time="2019-07-12T09:48:30Z" level=info msg="Waiting for deployment che. Default timeout: 420 seconds"

Finding Che cluster URL using OpenShift 4 CLI tools

This section describes how to Che cluster URL using OpenShift 4 CLI tool.

Prerequisites

Procedure

  • Wait for the logs to show the message Eclipse Che is now available at: followed by Che URL:

    time="2019-07-12T09:50:13Z" level=info msg="Updating eclipse-che CR with Eclipse Che server URL: http://che-che.apps.cluster-fre-f0a2.fre-f0a2.openshiftworkshop.com"
time="2019-07-12T09:50:13Z" level=info msg="Custom resource eclipse-che updated"
time="2019-07-12T09:50:13Z" level=info msg="Eclipse Che is now available at: http://che-che.apps.cluster-fre-f0a2.fre-f0a2.openshiftworkshop.com"
time="2019-07-12T09:50:13Z" level=info msg="Updating eclipse-che CR with version: 7.0.0-RC-2.0"

Enabling SSL on OpenShift 4

Prerequisites

Procedure

  1. Open the OpenShift web console.

  2. In the left panel, navigate to the Operators → Installed Operators section.

  3. Click on the Eclipse Che Operator tile.

  4. Click on eclipse-che in the table.

  5. Navigate to the Overview tab.

  6. Toggle the TLS MODE switch to True.

  7. Click Confirm change.

    tls mode true

  8. Navigate to the Resources tab.

  9. Wait that the pods are restarted.

  10. Navigate to the Overview tab.

  11. Click the ECLIPSE CHE URL link.

  12. Notice that the link is redirected to HTTPS.

  13. The browser displays the Eclipse Che Dashboard using a valid Let’s Encrypt certificate.

Logging in to Che on OpenShift for the first time using OAuth

This section describes how to log in to Che on OpenShift for the first time using OAuth.

Prerequisites

Procedure

  1. Navigate to the Eclipse Che URL to display the Eclipse Che login page.

  2. Choose the OpenShift OAuth option.

  3. The Authorize Access page is displayed.

  4. Click on the Allow selected permissions button.

  5. Update the account information: fill in the Username, Email, First name and Last name field and click on the Submit button.

  6. The browser displays the Eclipse Che Dashboard.

Logging in to Che on OpenShift for the first time registering as a new user

This section describes how to log in to Che on OpenShift for the first time registering as a new user.

Prerequisites

Procedure

  1. Navigate to the Eclipse Che URL to display the Eclipse Che login page.

  2. Choose the Register as a new user option.

  3. Update the account information: fill in the Username, Email, First name and Last name field and click on the Submit button.

  4. The browser displays the Eclipse Che Dashboard.

Tags: