Installing Che on OpenShift 4 using OperatorHub

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

Operators are a method of packaging, deploying, and managing an OpenShift application which also provide the following:

  • Repeatability of installation and upgrade.

  • Constant health checks of every system component.

  • Over-the-air (OTA) updates for OpenShift components and independent software vendor (ISV) content.

  • A place to encapsulate knowledge from field engineers and spread it to all users.

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

Creating a project in OpenShift Web Console

A project allows to organize and manage different resources on the cluster in an isolated unit. Create a project first to host the Eclipse Che Operator.

Procedure
  1. Open the OpenShift web console, in the left panel navigate to the HomeProjects section.

  2. Click Create Project.

  3. Specify the project details:

    • Name: che

    • Display Name: Eclipse Che

    • Description: Eclipse Che

Installing the Eclipse Che Operator

Eclipse Che Operator provides all the resources for running Che, such as PostgreSQL, Keycloak, image registries, and the Che server, and also configures all these services.

Prerequisites
  • Access to the Web Console on the cluster.

Procedure
  1. To install the Eclipse Che Operator, in the left panel, navigate to the OperatorsOperatorHub section.

  2. In the Filter by keyword field, type Eclipse Che and click the Eclipse Che tile.

  3. In the Eclipse Che pop-up window, click the Install button.

  4. On the Install Operator screen, specify the following options:

    • Installation mode: A specific namespace on the cluster

    • Installed Namespace: Pick an existing namespaceche

Verification steps
  1. To verify the Eclipse Che Operator has installed correctly, in the left panel navigate to the OperatorsInstalled Operators section.

  2. In the Installed Operators screen, click the Eclipse Che name and navigate to the Details tab.

  3. In the ClusterServiceVersion Details section at the bottom of the page, wait for these messages:

    • Status: Succeeded

    • Status Reason: install strategy completed with no errors

  4. Navigate to the Events tab and wait for this message: install strategy completed with no errors.

Creating an instance of the Eclipse Che Operator

Follow this procedure to install Eclipse Che with the default configuration. To modify the configuration, see Configuring the Che installation.

Procedure
  1. To create an instance of the Eclipse Che Operator, in the left panel, navigate to the OperatorsInstalled Operators section.

  2. In the Installed Operators screen, click the Eclipse Che name.

  3. In the Operator Details screen, in the Details tab, inside of the Provided APIs section, click the Create Instance link.

  4. The Create CheCluster page contains the configuration of the overall Che instance to create. It is the CheCluster Custom Resource. Keep the default values.

  5. To create the eclipse-che cluster, click the Create button in the lower left corner of the window.

  6. On the Operator Details screen, in the Eclipse Che Cluster tab, click on the eclipse-che link.

  7. To navigate to the eclipse-che instance, click the link under Eclipse Che URL.

    The installation might take more than 5 minutes. The URL appears after the Eclipse Che installation finishes.

Verification steps
  1. To verify that the Eclipse Che instance has installed correctly, navigate to the Eclipse Che Cluster tab. The CheClusters screen displays the list of Eclipse Che instances and their status.

  2. Click eclipse-che CheCluster in the table and navigate to the Details tab.

  3. See the content of following fields:

    • Message: the field contains error messages, if any. The expected content is None.

    • Eclipse Che URL: displays the URL of the Eclipse Che instance, once the deployment is successful.

  4. Navigate to the Resources tab. The screen displays the list of the resources assigned to the Che deployment.

  5. To see more details about the state of a resource, click its name and inspect the content of the available tabs.

Additional resources