Supported OpenShift Flavors and Versions

Single User Eclipse Che can be deployed to Minishift, OCP, OSD and OSO v3.6+.

Pre-Requisites

OpenShift oc client installed locally

Admin Guide

Deployment Diagram

There are a few essential Kubernetes and OpenShift objects that are created when Che is deployed to OpenShift. When a workspace is started additional objects are created. See the diagram below:

ocp single user

This diagram depicts the default PVC strategy (PVC per workspace).

Minishift Addon

Before starting install Minishift or update your Minishift to ensure you’re on the most up-to-date version.

Minishift Addon

The best way of deploying Che to Minishift is using an add-on via the minishift add-ons apply command which is outlined in the following paragraphs.

Install add-On

Starting with minishift v1.23.0 Che addon is pre-installed. To start Che we need to enable the addon and apply it:

$ minishift addons enable che && minishift addons apply che

Deploy a local Che server image

To deploy a local che-server image (e.g. eclipse/che-server:local) based on Che v5:

$ minishift addons apply --addon-env CHE_DOCKER_IMAGE=eclipse/che-server:local che

If the local image is based on Che v6:

$ minishift addons apply \
    --addon-env CHE_DOCKER_IMAGE=eclipse/che-server:local \
    che

Addon Variables

To customize the deployment of the Che server, the following variables can be applied to the execution:

Name Description Default Value

NAMESPACE

The OpenShift project where Che service will be deployed

che-mini

CHE_DOCKER_IMAGE

The docker image to be used for che.

eclipse/che-server:latest

GITHUB_CLIENT_ID

GitHub client ID to be used in Che workspaces

changeme

GITHUB_CLIENT_SECRET

GitHub client secred to be used in Che workspaces

changeme

Variables can be specified by adding --addon-env <key=value> when the addon is being invoked (either by minishift start or minishift addons apply).

Remove add-on

To remove all created template and che project:

minishift addons remove che

Uninstall add-on

To uninstall the addon from the addon list:

minishift addons uninstall che

MiniShift: Deployment Script

Alternatively, you may download deployment script and run deployment manually instead of using MiniShift addons:

curl -fsSL https://raw.githubusercontent.com/eclipse/che/master/deploy/openshift/deploy_che.sh -o deploy_che.sh
./deploy_che.sh

The script will download deployment templates, check your current oc session and context. Run ./deploy_che.sh --help to get a list of all deployment options.

You can use the same script to deploy to a local Origin/OKD cluster (oc cluster up)

HTTPS Mode

IMPORTANT! Find instructions on adding self signed certs at OpenShift Configuration page.

./deploy_che.sh -s

OpenShift Container Platform

Same instructions as in MiniShift.

OpenShift Dedicated

Instructions to deploy Che to OSD are identical to those for OpenShift Container Platform

OpenShift Online

Instructions to deploy Che to OSO Pro are identical to those for OpenShift Container Platform

Deployment Options and Configuration

What’s Next