Running Che locally | Eclipse Che Documentation

This section contains instructions for deploying and running Eclipse Che locally, on a personal workstation.

Prerequisites

To run and manage Che:

A Kubernetes, version 1.9 or higher, or OpenShift cluster to deploy Che on
The chectl command-line tool for managing a Che server and its development workspaces. See Installing the chectl management tool.

Eclipse Che is available in two modes:

Single-user: Non-authenticated Che, lighter and suited for personal desktop environments
Multi-user: Authenticted Che, suited for the cloud, for organizations and developer teams

This section describes how to deploy and run Che in single-user mode.

Setting up a local Kubernetes or OpenShift cluster

Set up a single-node Kubernetes, version 1.9 or higher, or OpenShift cluster on your machine using the Minikube or Minishift tools. Alternatively, on macOS or Windows, use the Docker Desktop application.

Using Minikube to set up Kubernetes

Install the latest version of the kubectl tool and Minikube.
Start Minikube (it is important to allocate at least 4 GB of RAM):
```
$ minikube start --memory=4096
```

Using Minishift to set up OpenShift

Install the latest version of Minishift and set the path of the oc binary.
Start Minishift (it is important to allocate at least 4 GB of RAM):
```
$ minishift start --memory=4096
```

Using Docker Desktop for Mac or Windows to set up Kubernetes

See Running Eclipse Che on Kubernetes using Docker Desktop on macOS or Windows.

Deploying Che using chectl

Start the Che Server using the chectl tool.

Prerequisites

chectl management tool is installed. See Installing the chectl management tool.

Deploying single-user Che on Minikube

$ chectl server:start

Deploying single-user Che on Minishift

Prerequisites

Use Minishift version 1.34.1 or greater.

Procedure

Run following command:

$ chectl server:start --platform minishift

Deploying multi-user Che on Minikube

$ chectl server:start --multiuser

Che deployment options using chectl

$ chectl server:start --help
Start Eclipse Che Server

USAGE
  $ chectl server:start

OPTIONS
  -a, --installer=installer            [default: helm] Installer type. Valid values are "helm" and "operator"
  -b, --domain=domain                  Domain of the Kubernetes/OpenShift cluster (e.g. starter-us-east-2.openshiftapps.com or <local-ip>.nip.io)
  -d, --debug                          Starts chectl in debug mode
  -h, --help                           show CLI help
  -i, --cheimage=cheimage              [default: eclipse/che-server:nightly] Che server container image
  -m, --multiuser                      Starts che in multi-user mode
  -n, --chenamespace=chenamespace      [default: kube-che] Kubernetes namespace where Che resources will be deployed
  -o, --cheboottimeout=cheboottimeout  (required) [default: 40000] Che server bootstrap timeout (in milliseconds)
  -p, --platform=platform              [default: minikube] Type of Kubernetes platform. Valid values are "minikube", "minishift", "docker4mac", "ocp", "oso".
  -s, --tls                            Enable TLS encryption and multi-user mode
  -t, --templates=templates            [default: /snapshot/chectl/templates] Path to the templates folder

Next steps after deploying and starting Che

Tags: