Configuring the Che installation
The following section describes configuration options to install Eclipse Che using the Operator.
-
Choose an installation procedure using the Operator.
Understanding the CheCluster
Custom Resource
A default deployment of Che consist in the application of a parametrized CheCluster
Custom Resource by the Eclipse Che Operator.
CheCluster
Custom Resource-
-
A YAML document describing the configuration of the overall Che installation.
-
Contains sections to configure each component:
auth
,database
,server
,storage
.
-
- Role of the Eclipse Che Operator
-
-
To translate the
CheCluster
Custom Resource into configuration (ConfigMap) usable by each component of the Che installation.
-
- Role of the Kubernetes platform
-
-
To apply the configuration (ConfigMap) for each component.
-
To create the necessary Pods.
-
When Kubernetes detects a change in the configuration of a component, it restarts the Pods accordingly.
-
-
The user applies a
CheCluster
Custom Resource containing some configuration related to theserver
. -
The Operator generates a necessary ConfigMap, called
che
. -
Kubernetes detects change in the ConfigMap and triggers a restart of the Che Pod.
-
To learn how to modify the
CheCluster
Custom Resource, see the chosen installation procedure.
CheCluster
Custom Resource fields reference
This section describes all fields available to customize the CheCluster
Custom Resource.
-
CheCluster
Custom Resourcedatabase
configuration settings related to the database used by Che -
CheCluster
Custom Resourceserver
settings, related to the Che server component. -
CheCluster
Custom Resourcestorage
configuration settings related to persistent storage used by Che -
CheCluster
Custom Resourcestatus
defines the observed state of Che installation
CheCluster
Custom Resource example.apiVersion: org.eclipse.che/v1
kind: CheCluster
metadata:
name: eclipse-che
spec:
auth:
externalIdentityProvider: false
database:
externalDb: false
server:
selfSignedCert: false
gitSelfSignedCert: false
tlsSupport: true
storage:
pvcStrategy: 'common'
pvcClaimSize: '1Gi'
Property | Default value | Description |
---|---|---|
|
omit |
An optional host name or URL to an alternative container registry to pull images from. This value overrides the container registry host name defined in all default container images involved in a Che deployment. This is particularly useful to install Che in an air-gapped environment. |
|
omit |
Optional repository name of an alternative container registry to pull images from. This value overrides the container registry organization defined in all the default container images involved in a Che deployment. This is particularly useful to install Che in an air-gapped environment. |
|
|
Enables the debug mode for Che server. |
|
|
Flavor of the installation. |
|
The Operator automatically sets the value. |
A public host name of the installed Che server. |
|
|
Overrides the image pull policy used in Che deployment. |
|
omit |
Overrides the tag of the container image used in Che deployment. Omit it or leave it empty to use the default image tag provided by the Operator. |
|
omit |
Overrides the container image used in Che deployment. This does not include the container image tag. Omit it or leave it empty to use the default container image provided by the Operator. |
|
|
Log level for the Che server: |
|
|
Comma-separated list of ClusterRoles that will be assigned to che ServiceAccount. Che uses default |
|
omit |
Custom cluster role bound to the user for the Che workspaces. Omit or leave empty to use the default roles. |
|
omit |
Map of additional environment variables that will be applied in the generated |
|
omit |
Overrides the container image used in the Devfile registry deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. |
|
|
Overrides the memory limit used in the Devfile registry deployment. |
|
|
Overrides the memory request used in the Devfile registry deployment. |
|
|
Overrides the image pull policy used in the Devfile registry deployment. |
|
The Operator automatically sets the value. |
Public URL of the Devfile registry that serves sample, ready-to-use devfiles. Set it if you use an external devfile registry (see the |
|
|
Instructs the Operator to deploy a dedicated Devfile registry server. By default a dedicated devfile registry server is started. If |
|
|
Instructs the Operator to deploy a dedicated Plugin registry server. By default, a dedicated plug-in registry server is started. If |
|
omit |
List of hosts that will not use the configured proxy. Use |
|
omit |
Overrides the container image used in the Plugin registry deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. |
|
|
Overrides the memory limit used in the Plugin registry deployment. |
|
|
Overrides the memory request used in the Plugin registry deployment. |
|
|
Overrides the image pull policy used in the Plugin registry deployment. |
|
the Operator sets the value automatically |
Public URL of the Plugin registry that serves sample ready-to-use devfiles. Set it only when using an external devfile registry (see the |
|
omit |
Password of the proxy server. Only use when proxy configuration is required. |
|
omit |
Port of the proxy server. Only use when configuring a proxy is required (see also the |
|
omit |
URL (protocol+host name) of the proxy server. This drives the appropriate changes in the |
|
omit |
User name of the proxy server. Only use when configuring a proxy is required (see also the |
|
|
Overrides the memory limit used in the Che server deployment. |
|
|
Overrides the memory request used in the Che server deployment. |
|
|
Instructs the Operator to deploy Che in TLS mode. |
Property | Default value | Description |
---|---|---|
|
|
PostgreSQL database name that the Che server uses to connect to the database. |
|
the Operator sets the value automatically |
PostgreSQL Database host name that the Che server uses to connect to. Defaults to |
|
auto-generated value |
PostgreSQL password that the Che server uses to connect to the database. |
|
|
PostgreSQL Database port that the Che server uses to connect to. Override this value only when using an external database (see field |
|
|
PostgreSQL user that the Che server uses to connect to the database. |
|
|
Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. If set to |
|
Always` for |
Overrides the image pull policy used in the PostgreSQL database deployment. |
|
omit |
Overrides the container image used in the PostgreSQL database deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. |
Property | Default value | Description |
---|---|---|
|
|
By default, a dedicated Identity Provider server is deployed as part of the Che installation. But if |
|
|
Overrides the name of the Identity Provider admin user. |
|
omit |
Name of an Identity provider (Keycloak) |
|
|
Overrides the image pull policy used in the Identity Provider (Keycloak) deployment. |
|
omit |
Overrides the container image used in the Identity Provider (Keycloak) deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. |
|
omit |
Overrides the password of Keycloak admin user. Override it only when using an external Identity Provider (see the |
|
the Operator sets the value automatically |
Password for The Identity Provider (Keycloak) to connect to the database. This is useful to override it ONLY if you use an external Identity Provider (see the |
|
omit |
Name of an Identity provider (Keycloak) realm. Override it only when using an external Identity Provider (see the |
|
the Operator sets the value automatically |
Instructs the Operator to deploy a dedicated Identity Provider (Keycloak instance). Public URL of the Identity Provider server (Keycloak server). Set it only when using an external Identity Provider (see the |
|
the Operator sets the value automatically |
Name of the OpenShift |
|
the Operator sets the value automatically |
Name of the secret set in the OpenShift |
|
|
Enables the integration of the identity provider (Keycloak / RHSSO) with OpenShift OAuth. This allows users to log in with their OpenShift login and have their workspaces created under personal OpenShift namespaces. The |
|
|
Forces the default |
Property | Default value | Description |
---|---|---|
|
omit |
Storage class for the Persistent Volume Claim dedicated to the PostgreSQL database. Omitted or leave empty to use a default storage class. |
|
|
Instructs the Che server to launch a special Pod to pre-create a subpath in the Persistent Volumes. Enable it according to the configuration of your K8S cluster. |
|
|
Size of the persistent volume claim for workspaces. |
|
omit |
Overrides the container image used to create sub-paths in the Persistent Volumes. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. See also the |
|
|
Available options:`common` (all workspaces PVCs in one volume), |
|
omit |
Storage class for the Persistent Volume Claims dedicated to the Che workspaces. Omit or leave empty to use a default storage class. |
Property | Default value | Description |
---|---|---|
|
|
Ingress class that defines which controller manages ingresses. |
|
omit |
Global ingress domain for a K8S cluster. This field must be explicitly specified. This drives the |
|
|
Strategy for ingress creation. This can be |
|
|
FSGroup the Che Pod and Workspace Pods containers run in. |
|
|
ID of the user the Che Pod and Workspace Pods containers run as. |
|
che-tls |
Name of a secret that is used to set ingress TLS termination if TLS is enabled. If the specified secret does not exist, a self-signed certificate will be created. If the value is empty or omitted, the default ingress controller certificate will be used. See also the |
Property | Description |
---|---|
|
Status of a Che installation. Can be |
|
Public URL to the Che server. |
|
Currently installed Che version. |
|
Indicates whether a PostgreSQL instance has been correctly provisioned. |
|
Public URL to the Devfile registry. |
|
A URL to where to find help related to the current Operator status. |
|
Indicates whether an Identity Provider instance (Keycloak / RH SSO) has been provisioned with realm, client and user. |
|
Public URL to the Identity Provider server (Keycloak / RH SSO). |
|
A human-readable message with details about why the Pod is in this state. |
|
Indicates whether an Identity Provider instance (Keycloak / RH SSO) has been configured to integrate with the OpenShift OAuth. |
|
Public URL to the Plugin registry. |
|
A brief CamelCase message with details about why the Pod is in this state. |