-description:Eclipse Che cluster with DB and Auth Server
displayName:Eclipse Che Cluster
kind:CheCluster
name:checlusters.org.eclipse.che
specDescriptors:
-description:Log in to Eclipse Che with OpenShift credentials
displayName:OpenShift oAuth
path:auth.openShiftoAuth
x-descriptors:
-urn:alm:descriptor:com.tectonic.ui:booleanSwitch
-description:TLS routes
displayName:TLS Mode
path:server.tlsSupport
x-descriptors:
-urn:alm:descriptor:com.tectonic.ui:booleanSwitch
statusDescriptors:
-description:Route to access Eclipse Che
displayName:Eclipse Che URL
path:cheURL
x-descriptors:
-urn:alm:descriptor:org.w3:link
-description:Route to access Keycloak Admin Console
displayName:Keycloak Admin Console URL
path:keycloakURL
x-descriptors:
-urn:alm:descriptor:org.w3:link
-description:Eclipse Che server version
displayName:Eclipse Che version
path:cheVersion
x-descriptors:
-urn:alm:descriptor:com.tectonic.ui:label
-description:The current status of the application
displayName:Status
path:cheClusterRunning
x-descriptors:
-urn:alm:descriptor:io.kubernetes.phase
-description:Reason of the current status
displayName:Reason
path:reason
x-descriptors:
-urn:alm:descriptor:text
-description:Message explaining the current status
displayName:Message
path:message
x-descriptors:
-urn:alm:descriptor:text
-description:Link providing help related to the current status
displayName:Help link
path:helpLink
x-descriptors:
-urn:alm:descriptor:org.w3:link
version:v1
description:|
A collaborative Kubernetes-native development solution that delivers OpenShift workspaces and in-browser IDE for rapid cloud application development.
This operator installs PostgreSQL, Keycloak, and the Eclipse Che server, as well as configures all three services.
## How to Install
Press the **Install** button, choose the upgrade strategy, and wait for the **Installed** Operator status.
When the operator is installed, create a new CR of Kind CheCluster (click the **Create New** button).
The CR spec contains all defaults (see below).
You can start using Eclipse Che when the CR status is set to **Available**, and you see a URL to Eclipse Che.
## Defaults
By default, the operator deploys Eclipse Che with:
* Bundled PostgreSQL and Keycloak
* Per-Workspace PVC strategy
* Auto-generated passwords
* HTTP mode (non-secure routes)
* Regular login extended with OpenShift OAuth authentication
## Installation Options
Eclipse Che operator installation options include:
* Connection to external database and Keycloak
* Configuration of default passwords and object names
* TLS mode
* PVC strategy (once shared PVC for all workspaces, PVC per workspace, or PVC per volume)
* Authentication options
### External Database and Keycloak
To instruct the operator to skip deploying PostgreSQL and Keycloak and connect to an existing DB and Keycloak instead:
* set respective fields to `true` in a custom resource spec
* provide the operator with connection and authentication details:
`externalDb: true`
`chePostgresHostname: 'yourPostgresHost'`
`chePostgresPort: '5432'`
`chePostgresUser: 'myuser'`
`chePostgresPassword: 'mypass'`
`chePostgresDb: 'mydb'`
`externalIdentityProvider: true`
`identityProviderURL: 'https://my-keycloak.com'`
`identityProviderRealm: 'myrealm'`
`identityProviderClientId: 'myClient'`
### TLS Mode
To activate TLS mode, set the respective field in the CR spec to `true` (in the `server` block):
```
tlsSupport: true
```
#### Self-signed Certificates
To use Eclipse Che with TLS enabled, but the OpenShift router does not use certificates signed by a public authority, you can use self-signed certificates, which the operator can fetch for you:
