server settings related to the Che server
airGapContainerRegistryHostname-
Optional hostname or URL to an alternate container registry to pull images from. This value overrides the container registry hostname defined in all default container images involved in a Che deployment. This is particularly useful to install Che in an air-gapped environment.
airGapContainerRegistryOrganization-
Optional repository name of an alternate 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.
cheDebug-
Enables the debug mode for Che server. Defaults to
false. cheFlavor-
Flavor of the installation. The default value is
chefor upstream Che installations andcodereadyfor CodeReady Workspaces installation. cheHost-
Public hostname of the installed Che server. The Operator automatically sets the value.
cheImagePullPolicy-
Overrides the image pull policy used in Che deployment. Default value is
Alwaysfornightlyorlatestimages, andIfNotPresentin other cases. cheImageTag-
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.
cheImage-
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 defaut container image provided by the Operator.
cheLogLevel-
Log level for the Che server:
INFOorDEBUG. Defaults toINFO. cheWorkspaceClusterRole-
Custom cluster role bound to the user for the Che workspaces. Omit or leave empty to use the default roles.
customCheProperties-
Map of additional environment variables that will be applied in the generated
checonfig map to be used by the Che server, in addition to the values already generated from other fields of theCheClustercustom resource (CR). IfcustomChePropertiescontains a property that would be normally generated incheconfig map from other CR fields, then the value defined in thecustomChePropertieswill be used instead. devfileRegistryImage-
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.
devfileRegistryMemoryLimit-
Overrides the memory limit used in the Devfile registry deployment. Defaults to 256Mi.
devfileRegistryMemoryRequest-
Overrides the memory request used in the Devfile registry deployment. Defaults to 16Mi.
devfileRegistryPullPolicy-
Overrides the image pull policy used in the Devfile registry deployment. Default value is
Alwaysfornightlyorlatestimages, andIfNotPresentin other cases. devfileRegistryUrl-
Public URL of the Devfile registry that serves sample, ready-to-use devfiles. Set it if you use an external devfile registry (see the
externalDevfileRegistryfield). The Operator automatically sets the value. externalDevfileRegistry-
Instructs the Operator to deploy a dedicated Devfile registry server. By default a dedicated devfile registry server is started. If
externalDevfileRegistryset totrue, the Operator does not start a dedicated registry server automatically and you need to set thedevfileRegistryUrlfield manually. externalPluginRegistry-
Instructs the Operator to deploy a dedicated Plugin registry server. By default, a dedicated plug-in registry server is started. If
externalPluginRegistryset totrue, the Operator does not deploy a dedicated server automatically and you need to set thepluginRegistryUrlfield manually. nonProxyHosts-
List of hosts that should not use the configured proxy. Use
|`as delimiter, eglocalhost|my.host.com|123.42.12.32Only use when configuring a proxy is required (see also theproxyURLfield). pluginRegistryImage-
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.
pluginRegistryMemoryLimit-
Overrides the memory limit used in the Plugin registry deployment. Defaults to 256Mi.
pluginRegistryMemoryRequest-
Overrides the memory request used in the Plugin registry deployment. Defaults to 16Mi.
pluginRegistryPullPolicy-
Overrides the image pull policy used in the Plugin registry deployment. Default value is
Alwaysfornightlyorlatestimages, andIfNotPresentin other cases. pluginRegistryUrl-
Public URL of the Plugin registry that serves sample ready-to-use devfiles. Set it only when using an external devfile registry (see the
externalPluginRegistryfield). By default, the Operator sets the value automatically. proxyPassword-
Password of the proxy server. Only use when proxy configuration is required.
proxyPort-
Port of the proxy server. Only use when configuring a proxy is required (see also the
proxyURLfield). proxyURL-
URL (protocol+hostname) of the proxy server. This drives the appropriate changes in the
JAVA_OPTSandhttps(s)_proxyvariables in the Che server and workspaces containers. Only use when configuring a proxy is required. proxyUser-
User name of the proxy server. Only use when configuring a proxy is required (see also the
proxyURLfield). selfSignedCert-
Enables the support of OpenShift clusters with routers that use self-signed certificates. When enabled, the Operator retrieves the default self-signed certificate of OpenShift routes and adds it to the Java trust store of the Che server. Required when activating the
tlsSupportfield on demo OpenShift clusters that have not been setup with a valid certificate for the routes. Disabled by default. serverMemoryLimit-
Overrides the memory limit used in the Che server deployment. Defaults to 1Gi.
serverMemoryRequest-
Overrides the memory request used in the Che server deployment. Defaults to 512Mi.
tlsSupport-
Instructs the Operator to deploy Che in TLS mode. Disabled by default.
Enabling TLS requires enabling the selfSignedCertfield.
database configuration settings related to the database used by Che
chePostgresDb-
Postgres database name that the Che server uses to connect to the database. Defaults to
dbche. chePostgresHostName-
Postgres Database hostname that the Che server uses to connect to. Defaults to postgres. Override this value only when using an external database. (See the field
externalDb.) By default, the Operator sets the value automatically.chePostgresPasswordPostgres password that the Che server uses to connect to the database. Omit or leave empty to set an auto-generated value. chePostgresPort-
Postgres Database port that the Che server uses to connect to. Defaults to
5432. Override this value only when using an external database (see fieldexternalDb). By default, the Operator sets the value automatically. chePostgresUser-
Postgres user that the Che server uses to connect to the database. Defaults to
pgche. externalDb-
Instructs the Operator to deploy a dedicated database. By default, a dedicated Postgres database is deployed as part of the Che installation. If set to
true, the Operator does not deploy a dedicated database automatically, you need to provide connection details to an external database. See all the fields starting with:chePostgres. postgresImagePullPolicy-
Overrides the image pull policy used in the Postgres database deployment. Default value is
Alwaysfornightlyorlatestimages, andIfNotPresentin other cases. postgresImage-
Overrides the container image used in the Postgres database deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator.
auth configuration settings related to authentication used by Che installation
externalIdentityProvider-
By default, a dedicated Identity Provider server is deployed as part of the Che installation. But if
externalIdentityProvideristrue, then no dedicated identity provider will be deployed by the Operator and you might need to provide details about the external identity provider you want to use. See also all the other fields starting with:identityProvider.identityProviderAdminUserNameOverrides the name of the Identity Provider admin user. Defaults toadmin. identityProviderClientId-
Name of an Identity provider (Keycloak / RH SSO)
client-idthat should be used for Che. This is useful to override it ONLY if you use an external Identity Provider (see theexternalIdentityProviderfield). If omitted or left blank, it will be set to the value of theflavorfield suffixed with-public. identityProviderImagePullPolicy-
Overrides the image pull policy used in the Identity Provider (Keycloak / RH SSO) deployment. Default value is
Alwaysfornightlyorlatestimages, andIfNotPresentin other cases. identityProviderImage-
Overrides the container image used in the Identity Provider (Keycloak / RH SSO) deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator.
identityProviderPassword-
Overrides the password of Keycloak admin user. Override it only when using an external Identity Provider (see the
externalIdentityProviderfield). Omit or leave empty to set an auto-generated password. identityProviderPostgresPassword-
Password for The Identity Provider (Keycloak / RH SSO) to connect to the database. This is useful to override it ONLY if you use an external Identity Provider (see the
externalIdentityProviderfield). If omitted or left blank, it will be set to an auto-generated password. identityProviderRealm-
Name of an Identity provider (Keycloak / RH SSO) realm. Override it only when using an external Identity Provider (see the
externalIdentityProviderfield). Omit or leave empty blank to set it to the value of theflavorfield. identityProviderURL-
Instructs the Operator to deploy a dedicated Identity Provider (Keycloak or RH SSO instance). Public URL of the Identity Provider server (Keycloak / RH SSO server). Set it only when using an external Identity Provider (see the
externalIdentityProviderfield). By default, the Operator sets the value automatically. oAuthClientName-
Name of the OpenShift
OAuthClientresource used to setup identity federation on the OpenShift side. Auto-generated if left blank. See also theOpenShiftoAuthfield. oAuthSecret-
Name of the secret set in the OpenShift
OAuthClientresource used to setup identity federation on the OpenShift side. Auto-generated if left blank. See also theOAuthClientNamefield. openShiftoAuth-
Enables the integration of the identity provider (Keycloak / RHSSO) with OpenShift OAuth. Enabled by default on OpenShift. This allows users to login with their Openshift login and have their workspaces created under personnal OpenShift namespaces.
The kuebadminuser is not supported, and logging through does not allow access to the Che Dashboard. updateAdminPassword-
Forces the default
adminChe user to update password on first login. Defaults tofalse.
storage configuration settings related to persistent storage used by Che
postgresPVCStorageClassName-
Storage class for the Persistent Volume Claim dedicated to the Postgres database. Omitted or leave empty to use a default storage class.
preCreateSubPaths-
Instructs the Che server to launch a special Pod to pre-create a subpath in the Persistent Volumes. Defaults to
false. Enable it according to the configuration of your K8S cluster. pvcClaimSize-
Size of the persistent volume claim for workspaces. Defaults to
1Gi. pvcJobsImage-
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
preCreateSubPathsfield. pvcStrategy-
This Can be:`common` (all workspaces PVCs in one volume),
per-workspace(one PVC per workspace for all declared volumes) andunique(one PVC per declared volume). Defaults tocommon. workspacePVCStorageClassName-
Storage class for the Persistent Volume Claims dedicated to the Che workspaces. Omit or leave empty to use a default storage class.
k8s configuration settings specific to Che installations on Kubernetes
ingressClass-
Ingress class that defines which controller manages ingresses. Defaults to
nginx. ingressDomain-
Global ingress domain for a K8S cluster. No default values. This fiels must be explicitly specified.
This drives the is kubernetes.io/ingress.classannotation on Che-related ingresses. ingressStrategy-
Strategy for ingress creation. This can be
multi-host(host is explicitly provided in ingress),single-host(host is provided, path-based rules) anddefault-host.*(no host is provided, path-based rules). Defaults tomulti-host. securityContextFsGroup,omitempty-
FSGroup the Che Pod and Workspace Pods containers should run in. Defaults to
1724. securityContextRunAsUser-
ID of the user the Che Pod and Workspace Pods containers should run as. Defaults to
1724. tlsSecretName-
Name of a secret that is used to set ingress TLS termination if TLS is enabled. See also the
tlsSupportfield.
installation defines the observed state of Che installation
cheClusterRunning-
Status of a Che installation. Can be
Available,Unavailable, orAvailable, Rolling Update in Progress. cheURL-
Public URL to the Che server.
cheVersion-
Currently installed Che version.
dbProvisioned-
Indicates whether a Postgres instance has been correctly provisioned.
devfileRegistryURL-
Public URL to the Devfile registry.
helpLink-
A URL to where to find help related to the current Operator status.
keycloakProvisioned-
Indicates whether an Identity Provider instance (Keycloak / RH SSO) has been provisioned with realm, client and user.
keycloakURL-
Public URL to the Identity Provider server (Keycloak / RH SSO).
message-
A human-readable message with details about why the Pod is in this state.
openShiftoAuthProvisioned-
Indicates whether an Identity Provider instance (Keycloak / RH SSO) has been configured to integrate with the OpenShift OAuth.
pluginRegistryURL-
Public URL to the Plugin registry.
reason-
A brief CamelCase message with details about why the Pod is in this state.