Documentation ¶
Overview ¶
Copyright (c) 2012-2019 Red Hat, Inc. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
Red Hat, Inc. - initial API and implementation
Copyright (c) 2012-2019 Red Hat, Inc. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
Red Hat, Inc. - initial API and implementation
Package v1 contains API Schema definitions for the org v1 API group +k8s:deepcopy-gen=package,register +groupName=org.eclipse.che
Package v1 contains API Schema definitions for the org v1 API group +k8s:deepcopy-gen=package,register +groupName=org.eclipse.che
Index ¶
- Variables
- type CheCluster
- type CheClusterList
- type CheClusterSpec
- type CheClusterSpecAuth
- type CheClusterSpecDB
- type CheClusterSpecDevWorkspace
- type CheClusterSpecImagePuller
- type CheClusterSpecK8SOnly
- type CheClusterSpecMetrics
- type CheClusterSpecServer
- type CheClusterSpecStorage
- type CheClusterStatus
- type IngressCustomSettings
- type Resources
- type ResourcesCustomSettings
- type RouteCustomSettings
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "org.eclipse.che", Version: "v1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
This section is empty.
Types ¶
type CheCluster ¶
type CheCluster struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Desired configuration of the Che installation. // Based on these settings, the Operator automatically creates and maintains // several ConfigMaps that will contain the appropriate environment variables // the various components of the Che installation. // These generated ConfigMaps must NOT be updated manually. Spec CheClusterSpec `json:"spec,omitempty"` // CheClusterStatus defines the observed state of Che installation Status CheClusterStatus `json:"status,omitempty"` }
The `CheCluster` custom resource allows defining and managing a Che server installation +k8s:openapi-gen=true +kubebuilder:subresource:status +operator-sdk:gen-csv:customresourcedefinitions.displayName="Eclipse Che Cluster"
func (*CheCluster) DeepCopy ¶
func (in *CheCluster) DeepCopy() *CheCluster
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheCluster.
func (*CheCluster) DeepCopyInto ¶
func (in *CheCluster) DeepCopyInto(out *CheCluster)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CheCluster) DeepCopyObject ¶
func (in *CheCluster) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*CheCluster) IsAirGapMode ¶
func (c *CheCluster) IsAirGapMode() bool
func (*CheCluster) IsImagePullerSpecEmpty ¶
func (c *CheCluster) IsImagePullerSpecEmpty() bool
type CheClusterList ¶
type CheClusterList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []CheCluster `json:"items"` }
CheClusterList contains a list of CheCluster
func (*CheClusterList) DeepCopy ¶
func (in *CheClusterList) DeepCopy() *CheClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterList.
func (*CheClusterList) DeepCopyInto ¶
func (in *CheClusterList) DeepCopyInto(out *CheClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CheClusterList) DeepCopyObject ¶
func (in *CheClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CheClusterSpec ¶
type CheClusterSpec struct { // General configuration settings related to the Che server // and the plugin and devfile registries // +optional Server CheClusterSpecServer `json:"server"` // Configuration settings related to the database used by the Che installation. // +optional Database CheClusterSpecDB `json:"database"` // Configuration settings related to the Authentication used by the Che installation. // +optional Auth CheClusterSpecAuth `json:"auth"` // Configuration settings related to the persistent storage used by the Che installation. // +optional Storage CheClusterSpecStorage `json:"storage"` // Configuration settings related to the metrics collection used by the Che installation. // +optional Metrics CheClusterSpecMetrics `json:"metrics"` // Configuration settings specific to Che installations made on upstream Kubernetes. // +optional K8s CheClusterSpecK8SOnly `json:"k8s"` // Kubernetes Image Puller configuration // +optional ImagePuller CheClusterSpecImagePuller `json:"imagePuller"` // Dev Workspace operator configuration // +optional DevWorkspace CheClusterSpecDevWorkspace `json:"devWorkspace"` }
+k8s:openapi-gen=true Desired configuration of the Che installation. Based on these settings, the Operator automatically creates and maintains several ConfigMaps that will contain the appropriate environment variables the various components of the Che installation. These generated ConfigMaps must NOT be updated manually.
func (*CheClusterSpec) DeepCopy ¶
func (in *CheClusterSpec) DeepCopy() *CheClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterSpec.
func (*CheClusterSpec) DeepCopyInto ¶
func (in *CheClusterSpec) DeepCopyInto(out *CheClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CheClusterSpecAuth ¶
type CheClusterSpecAuth struct { // For operating with the OpenShift OAuth authentication, create a new user account since the kubeadmin can not be used. // If the value is true, then a new OpenShift OAuth user will be created for the HTPasswd identity provider. // If the value is false and the user has already been created, then it will be removed. // If value is an empty, then do nothing. // The user's credentials are stored in the `openshift-oauth-user-credentials` secret by Operator. // Note that this solution is Openshift 4 platform-specific. InitialOpenShiftOAuthUser *bool `json:"initialOpenShiftOAuthUser,omitempty"` // Instructs the Operator on whether or not to deploy a dedicated Identity Provider (Keycloak or RH SSO instance). // Instructs the Operator on whether to deploy a dedicated Identity Provider (Keycloak or RH-SSO instance). // By default, a dedicated Identity Provider server is deployed as part of the Che installation. When `externalIdentityProvider` is `true`, // no dedicated identity provider will be deployed by the Operator and you will need to provide details about the external identity provider you are about to use. // See also all the other fields starting with: `identityProvider`. // +optional ExternalIdentityProvider bool `json:"externalIdentityProvider"` // Public URL of the Identity Provider server (Keycloak / RH-SSO server). // Set this ONLY when a use of an external Identity Provider is needed. // See the `externalIdentityProvider` field. By default, this will be automatically calculated and set by the Operator. // +optional IdentityProviderURL string `json:"identityProviderURL,omitempty"` // Overrides the name of the Identity Provider administrator user. Defaults to `admin`. // +optional IdentityProviderAdminUserName string `json:"identityProviderAdminUserName,omitempty"` // Overrides the password of Keycloak administrator user. // Override this when an external Identity Provider is in use. See the `externalIdentityProvider` field. // When omitted or left blank, it is set to an auto-generated password. // +optional IdentityProviderPassword string `json:"identityProviderPassword,omitempty"` // The secret that contains `user` and `password` for Identity Provider. // When the secret is defined, the `identityProviderAdminUserName` and `identityProviderPassword` are ignored. // When the value is omitted or left blank, the one of following scenarios applies: // 1. `identityProviderAdminUserName` and `identityProviderPassword` are defined, then they will be used. // 2. `identityProviderAdminUserName` or `identityProviderPassword` are not defined, then a new secret with the name // `che-identity-secret` will be created with default value `admin` for `user` and with an auto-generated value for `password`. // +optional IdentityProviderSecret string `json:"identityProviderSecret,omitempty"` // Name of a Identity provider, Keycloak or RH-SSO, realm that is used for Che. // Override this when an external Identity Provider is in use. See the `externalIdentityProvider` field. // When omitted or left blank, it is set to the value of the `flavour` field. // +optional IdentityProviderRealm string `json:"identityProviderRealm,omitempty"` // Name of a Identity provider, Keycloak or RH-SSO, `client-id` that is used for Che. // Override this when an external Identity Provider is in use. See the `externalIdentityProvider` field. // When omitted or left blank, it is set to the value of the `flavour` field suffixed with `-public`. // +optional IdentityProviderClientId string `json:"identityProviderClientId,omitempty"` // Password for a Identity Provider, Keycloak or RH-SSO, to connect to the database. // Override this when an external Identity Provider is in use. See the `externalIdentityProvider` field. // When omitted or left blank, it is set to an auto-generated password. // +optional IdentityProviderPostgresPassword string `json:"identityProviderPostgresPassword,omitempty"` // The secret that contains `password` for the Identity Provider, Keycloak or RH-SSO, to connect to the database. // When the secret is defined, the `identityProviderPostgresPassword` is ignored. When the value is omitted or left blank, the one of following scenarios applies: // 1. `identityProviderPostgresPassword` is defined, then it will be used to connect to the database. // 2. `identityProviderPostgresPassword` is not defined, then a new secret with the name `che-identity-postgres-secret` will be created with an auto-generated value for `password`. // +optional IdentityProviderPostgresSecret string `json:"identityProviderPostgresSecret,omitempty"` // Forces the default `admin` Che user to update password on first login. Defaults to `false`. // +optional UpdateAdminPassword bool `json:"updateAdminPassword"` // Enables the integration of the identity provider (Keycloak / RHSSO) with OpenShift OAuth. // Empty value on OpenShift by default. This will allow users to directly login with their OpenShift user through the OpenShift login, // and have their workspaces created under personal OpenShift namespaces. // WARNING: the `kubeadmin` user is NOT supported, and logging through it will NOT allow accessing the Che Dashboard. // +optional OpenShiftoAuth *bool `json:"openShiftoAuth,omitempty"` // Name of the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. Auto-generated when left blank. See also the `OpenShiftoAuth` field. // +optional OAuthClientName string `json:"oAuthClientName,omitempty"` // Name of the secret set in the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. Auto-generated when left blank. See also the `OAuthClientName` field. // +optional OAuthSecret string `json:"oAuthSecret,omitempty"` // Overrides the container image used in the Identity Provider, Keycloak or RH-SSO, deployment. // This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. // +optional IdentityProviderImage string `json:"identityProviderImage,omitempty"` // Overrides the image pull policy used in the Identity Provider, Keycloak or RH-SSO, deployment. // Default value is `Always` for `nightly` or `latest` images, and `IfNotPresent` in other cases. // +optional IdentityProviderImagePullPolicy corev1.PullPolicy `json:"identityProviderImagePullPolicy,omitempty"` // Ingress custom settings. // +optional IdentityProviderIngress IngressCustomSettings `json:"identityProviderIngress,omitempty"` // Route custom settings. // +optional IdentityProviderRoute RouteCustomSettings `json:"identityProviderRoute,omitempty"` // Identity provider container custom settings. // +optional IdentityProviderContainerResources ResourcesCustomSettings `json:"identityProviderContainerResources,omitempty"` }
+k8s:openapi-gen=true Configuration settings related to the Authentication used by the Che installation.
func (*CheClusterSpecAuth) DeepCopy ¶
func (in *CheClusterSpecAuth) DeepCopy() *CheClusterSpecAuth
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterSpecAuth.
func (*CheClusterSpecAuth) DeepCopyInto ¶
func (in *CheClusterSpecAuth) DeepCopyInto(out *CheClusterSpecAuth)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CheClusterSpecDB ¶
type CheClusterSpecDB struct { // Instructs the Operator on whether to deploy a dedicated database. // By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is `true`, no dedicated database will be deployed by the // Operator and you will need to provide connection details to the external DB you are about to use. See also all the fields starting with: `chePostgres`. // +optional ExternalDb bool `json:"externalDb"` // PostgreSQL Database host name that the Che server uses to connect to. // Defaults is `postgres`. Override this value ONLY when using an external database. See field `externalDb`. // In the default case it will be automatically set by the Operator. // +optional ChePostgresHostName string `json:"chePostgresHostName,omitempty"` // PostgreSQL Database port that the Che server uses to connect to. Defaults to 5432. // Override this value ONLY when using an external database. See field `externalDb`. In the default case it will be automatically set by the Operator. // +optional ChePostgresPort string `json:"chePostgresPort,omitempty"` // PostgreSQL user that the Che server uses to connect to the DB. Defaults to `pgche`. // +optional ChePostgresUser string `json:"chePostgresUser,omitempty"` // PostgreSQL password that the Che server uses to connect to the DB. When omitted or left blank, it will be set to an automatically generated value. // +optional ChePostgresPassword string `json:"chePostgresPassword,omitempty"` // PostgreSQL database name that the Che server uses to connect to the DB. Defaults to `dbche`. // +optional ChePostgresDb string `json:"chePostgresDb,omitempty"` // The secret that contains PostgreSQL`user` and `password` that the Che server uses to connect to the DB. // When the secret is defined, the `chePostgresUser` and `chePostgresPassword` are ignored. // When the value is omitted or left blank, the one of following scenarios applies: // 1. `chePostgresUser` and `chePostgresPassword` are defined, then they will be used to connect to the DB. // 2. `chePostgresUser` or `chePostgresPassword` are not defined, then a new secret with the name `che-postgres-secret` // will be created with default value of `pgche` for `user` and with an auto-generated value for `password`. // +optional ChePostgresSecret string `json:"chePostgresSecret,omitempty"` // 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. // +optional PostgresImage string `json:"postgresImage,omitempty"` // Overrides the image pull policy used in the PostgreSQL database deployment. Default value is `Always` for `nightly` or `latest` images, and `IfNotPresent` in other cases. // +optional PostgresImagePullPolicy corev1.PullPolicy `json:"postgresImagePullPolicy,omitempty"` // PostgreSQL container custom settings // +optional ChePostgresContainerResources ResourcesCustomSettings `json:"chePostgresContainerResources,omitempty"` }
+k8s:openapi-gen=true Configuration settings related to the database used by the Che installation.
func (*CheClusterSpecDB) DeepCopy ¶
func (in *CheClusterSpecDB) DeepCopy() *CheClusterSpecDB
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterSpecDB.
func (*CheClusterSpecDB) DeepCopyInto ¶
func (in *CheClusterSpecDB) DeepCopyInto(out *CheClusterSpecDB)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CheClusterSpecDevWorkspace ¶
type CheClusterSpecDevWorkspace struct { // Deploys the DevWorkspace Operator in the cluster. // Does nothing when a matching version of the Operator is already installed. // Fails when a non-matching version of the Operator is already installed. // +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=false // +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Enable Dev Workspace operator" // +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:booleanSwitch" Enable bool `json:"enable"` }
+k8s:openapi-gen=true Settings for installation and configuration of the Dev Workspace operator See https://github.com/devfile/devworkspace-operator
func (*CheClusterSpecDevWorkspace) DeepCopy ¶
func (in *CheClusterSpecDevWorkspace) DeepCopy() *CheClusterSpecDevWorkspace
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterSpecDevWorkspace.
func (*CheClusterSpecDevWorkspace) DeepCopyInto ¶
func (in *CheClusterSpecDevWorkspace) DeepCopyInto(out *CheClusterSpecDevWorkspace)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CheClusterSpecImagePuller ¶
type CheClusterSpecImagePuller struct { // Install and configure the Community Supported Kubernetes Image Puller Operator. When set to `true` and no spec is provided, // it will create a default KubernetesImagePuller object to be managed by the Operator. // When set to `false`, the KubernetesImagePuller object will be deleted, and the Operator will be uninstalled, // regardless of whether a spec is provided. // // Note that while this the Operator and its behavior is community-supported, its payload may be commercially-supported // for pulling commercially-supported images. Enable bool `json:"enable"` // A KubernetesImagePullerSpec to configure the image puller in the CheCluster // +optional Spec chev1alpha1.KubernetesImagePullerSpec `json:"spec"` }
+k8s:openapi-gen=true Configuration settings for installation and configuration of the Kubernetes Image Puller See https://github.com/che-incubator/kubernetes-image-puller-operator
func (*CheClusterSpecImagePuller) DeepCopy ¶
func (in *CheClusterSpecImagePuller) DeepCopy() *CheClusterSpecImagePuller
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterSpecImagePuller.
func (*CheClusterSpecImagePuller) DeepCopyInto ¶
func (in *CheClusterSpecImagePuller) DeepCopyInto(out *CheClusterSpecImagePuller)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CheClusterSpecK8SOnly ¶
type CheClusterSpecK8SOnly struct { // Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults. IngressDomain string `json:"ingressDomain,omitempty"` // Strategy for ingress creation. Options are: `multi-host` (host is explicitly provided in ingress), // `single-host` (host is provided, path-based rules) and `default-host` (no host is provided, path-based rules). // Defaults to `multi-host` Deprecated in favor of `serverExposureStrategy` in the `server` section, // which defines this regardless of the cluster type. When both are defined, the `serverExposureStrategy` option takes precedence. // +optional IngressStrategy string `json:"ingressStrategy,omitempty"` // Ingress class that will define the which controller will manage ingresses. Defaults to `nginx`. // NB: This drives the `kubernetes.io/ingress.class` annotation on Che-related ingresses. // +optional IngressClass string `json:"ingressClass,omitempty"` // Name of a secret that will be used to setup ingress TLS termination when TLS is enabled. // When the field is empty string, the default cluster certificate will be used. See also the `tlsSupport` field. // +optional TlsSecretName string `json:"tlsSecretName,omitempty"` // The FSGroup in which the Che Pod and workspace Pods containers runs in. Default value is `1724`. // +optional SecurityContextFsGroup string `json:"securityContextFsGroup,omitempty"` // ID of the user the Che Pod and workspace Pods containers run as. Default value is `1724`. // +optional SecurityContextRunAsUser string `json:"securityContextRunAsUser,omitempty"` // When the serverExposureStrategy is set to `single-host`, the way the server, registries and workspaces are exposed is further configured by this property. // The possible values are `native`, which means that the server and workspaces are exposed using ingresses on K8s // or `gateway` where the server and workspaces are exposed using a custom gateway based on link:https://doc.traefik.io/traefik/[Traefik]. // All the endpoints whether backed by the ingress or gateway `route` always point to the subpaths on the same domain. Defaults to `native`. // +optional SingleHostExposureType string `json:"singleHostExposureType,omitempty"` }
+k8s:openapi-gen=true Configuration settings specific to Che installations made on upstream Kubernetes.
func (*CheClusterSpecK8SOnly) DeepCopy ¶
func (in *CheClusterSpecK8SOnly) DeepCopy() *CheClusterSpecK8SOnly
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterSpecK8SOnly.
func (*CheClusterSpecK8SOnly) DeepCopyInto ¶
func (in *CheClusterSpecK8SOnly) DeepCopyInto(out *CheClusterSpecK8SOnly)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CheClusterSpecMetrics ¶
type CheClusterSpecMetrics struct { // Enables `metrics` the Che server endpoint. Default to `true`. // +optional Enable bool `json:"enable"` }
func (*CheClusterSpecMetrics) DeepCopy ¶
func (in *CheClusterSpecMetrics) DeepCopy() *CheClusterSpecMetrics
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterSpecMetrics.
func (*CheClusterSpecMetrics) DeepCopyInto ¶
func (in *CheClusterSpecMetrics) DeepCopyInto(out *CheClusterSpecMetrics)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CheClusterSpecServer ¶
type CheClusterSpecServer struct { // Optional host name, or URL, to an alternate container registry to pull images from. // This value overrides the container registry host name defined in all the default container images involved in a Che deployment. // This is particularly useful to install Che in a restricted environment. // +optional AirGapContainerRegistryHostname string `json:"airGapContainerRegistryHostname,omitempty"` // 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 Eclipse Che in a restricted environment. // +optional AirGapContainerRegistryOrganization string `json:"airGapContainerRegistryOrganization,omitempty"` // 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. // +optional CheImage string `json:"cheImage,omitempty"` // 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. // +optional CheImageTag string `json:"cheImageTag,omitempty"` // Overrides the image pull policy used in Che deployment. // Default value is `Always` for `nightly` or `latest` images, and `IfNotPresent` in other cases. // +optional CheImagePullPolicy corev1.PullPolicy `json:"cheImagePullPolicy,omitempty"` // Specifies a variation of the installation. The options are `che` for upstream Che installations, or `codeready` for link:https://developers.redhat.com/products/codeready-workspaces/overview[CodeReady Workspaces] installation. // Override the default value only on necessary occasions. // +optional CheFlavor string `json:"cheFlavor,omitempty"` // Public host name of the installed Che server. When value is omitted, the value it will be automatically set by the Operator. // See the `cheHostTLSSecret` field. // +optional CheHost string `json:"cheHost,omitempty"` // Name of a secret containing certificates to secure ingress or route for the custom host name of the installed Che server. // See the `cheHost` field. // +optional CheHostTLSSecret string `json:"cheHostTLSSecret,omitempty"` // Log level for the Che server: `INFO` or `DEBUG`. Defaults to `INFO`. // +optional CheLogLevel string `json:"cheLogLevel,omitempty"` // Enables the debug mode for Che server. Defaults to `false`. // +optional CheDebug string `json:"cheDebug,omitempty"` // A comma-separated list of ClusterRoles that will be assigned to Che ServiceAccount. // Be aware that the Che Operator has to already have all permissions in these ClusterRoles to grant them. // +optional CheClusterRoles string `json:"cheClusterRoles,omitempty"` // Custom cluster role bound to the user for the Che workspaces. // The default roles are used when omitted or left blank. // +optional CheWorkspaceClusterRole string `json:"cheWorkspaceClusterRole,omitempty"` // Defines Kubernetes default namespace in which user's workspaces are created for a case when a user does not override it. // It's possible to use `<username>`, `<userid>` and `<workspaceid>` placeholders, such as che-workspace-<username>. // In that case, a new namespace will be created for each user or workspace. // +optional WorkspaceNamespaceDefault string `json:"workspaceNamespaceDefault,omitempty"` // Defines that a user is allowed to specify a Kubernetes namespace, or an OpenShift project, which differs from the default. // It's NOT RECOMMENDED to set to `true` without OpenShift OAuth configured. The OpenShift infrastructure also uses this property. // +optional AllowUserDefinedWorkspaceNamespaces bool `json:"allowUserDefinedWorkspaceNamespaces"` // Deprecated. The value of this flag is ignored. // The Che Operator will automatically detect whether the router certificate is self-signed and propagate it to other components, such as the Che server. // +optional SelfSignedCert bool `json:"selfSignedCert"` // Name of the ConfigMap with public certificates to add to Java trust store of the Che server. // This is often required when adding the OpenShift OAuth provider, which has HTTPS endpoint signed with self-signed cert. // The Che server must be aware of its CA cert to be able to request it. This is disabled by default. // +optional ServerTrustStoreConfigMapName string `json:"serverTrustStoreConfigMapName,omitempty"` // When enabled, the certificate from `che-git-self-signed-cert` ConfigMap will be propagated to the Che components and provide particular configuration for Git. // +optional GitSelfSignedCert bool `json:"gitSelfSignedCert"` // Deprecated. Instructs the Operator to deploy Che in TLS mode. This is enabled by default. Disabling TLS sometimes cause malfunction of some Che components. // +optional TlsSupport bool `json:"tlsSupport"` // Use internal cluster SVC names to communicate between components to speed up the traffic and avoid proxy issues. // The default value is `true`. // +optional UseInternalClusterSVCNames bool `json:"useInternalClusterSVCNames"` // Public URL of the devfile registry, that serves sample, ready-to-use devfiles. // Set this ONLY when a use of an external devfile registry is needed. See the `externalDevfileRegistry` field. // By default, this will be automatically calculated by the Operator. // +optional DevfileRegistryUrl string `json:"devfileRegistryUrl,omitempty"` // 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. // +optional DevfileRegistryImage string `json:"devfileRegistryImage,omitempty"` // Overrides the image pull policy used in the devfile registry deployment. // Default value is `Always` for `nightly` or `latest` images, and `IfNotPresent` in other cases. // +optional DevfileRegistryPullPolicy corev1.PullPolicy `json:"devfileRegistryPullPolicy,omitempty"` // Overrides the memory limit used in the devfile registry deployment. Defaults to 256Mi. // +optional DevfileRegistryMemoryLimit string `json:"devfileRegistryMemoryLimit,omitempty"` // Overrides the memory request used in the devfile registry deployment. Defaults to 16Mi. // +optional DevfileRegistryMemoryRequest string `json:"devfileRegistryMemoryRequest,omitempty"` // Overrides the CPU limit used in the devfile registry deployment. // In cores. (500m = .5 cores). Default to 500m. // +optional DevfileRegistryCpuLimit string `json:"devfileRegistryCpuLimit,omitempty"` // Overrides the CPU request used in the devfile registry deployment. // In cores. (500m = .5 cores). Default to 100m. // +optional DevfileRegistryCpuRequest string `json:"devfileRegistryCpuRequest,omitempty"` // The devfile registry ingress custom settings. // +optional DevfileRegistryIngress IngressCustomSettings `json:"devfileRegistryIngress,omitempty"` // The devfile registry route custom settings. // +optional DevfileRegistryRoute RouteCustomSettings `json:"devfileRegistryRoute,omitempty"` // Instructs the Operator on whether to deploy a dedicated devfile registry server. // By default, a dedicated devfile registry server is started. When `externalDevfileRegistry` is `true`, no such dedicated server // will be started by the Operator and you will have to manually set the `devfileRegistryUrl` field // +optional ExternalDevfileRegistry bool `json:"externalDevfileRegistry"` // Public URL of the plugin registry that serves sample ready-to-use devfiles. // Set this ONLY when a use of an external devfile registry is needed. // See the `externalPluginRegistry` field. By default, this will be automatically calculated by the Operator. // +optional PluginRegistryUrl string `json:"pluginRegistryUrl,omitempty"` // 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. // +optional PluginRegistryImage string `json:"pluginRegistryImage,omitempty"` // Overrides the image pull policy used in the plugin registry deployment. // Default value is `Always` for `nightly` or `latest` images, and `IfNotPresent` in other cases. // +optional PluginRegistryPullPolicy corev1.PullPolicy `json:"pluginRegistryPullPolicy,omitempty"` // Overrides the memory limit used in the plugin registry deployment. Defaults to 256Mi. // +optional PluginRegistryMemoryLimit string `json:"pluginRegistryMemoryLimit,omitempty"` // Overrides the memory request used in the plugin registry deployment. Defaults to 16Mi. // +optional PluginRegistryMemoryRequest string `json:"pluginRegistryMemoryRequest,omitempty"` // Overrides the CPU limit used in the plugin registry deployment. // In cores. (500m = .5 cores). Default to 500m. // +optional PluginRegistryCpuLimit string `json:"pluginRegistryCpuLimit,omitempty"` // Overrides the CPU request used in the plugin registry deployment. // In cores. (500m = .5 cores). Default to 100m. // +optional PluginRegistryCpuRequest string `json:"pluginRegistryCpuRequest,omitempty"` // Plugin registry ingress custom settings. // +optional PluginRegistryIngress IngressCustomSettings `json:"pluginRegistryIngress,omitempty"` // Plugin registry route custom settings. // +optional PluginRegistryRoute RouteCustomSettings `json:"pluginRegistryRoute,omitempty"` // Instructs the Operator on whether to deploy a dedicated plugin registry server. // By default, a dedicated plugin registry server is started. When `externalPluginRegistry` is `true`, no such dedicated server // will be started by the Operator and you will have to manually set the `pluginRegistryUrl` field. // +optional ExternalPluginRegistry bool `json:"externalPluginRegistry"` // Map of additional environment variables that will be applied in the generated `che` ConfigMap to be used by the Che server, // in addition to the values already generated from other fields of the `CheCluster` custom resource (CR). // When `customCheProperties` contains a property that would be normally generated in `che` ConfigMap from other CR fields, // the value defined in the `customCheProperties` is used instead. // +optional CustomCheProperties map[string]string `json:"customCheProperties,omitempty"` // URL (protocol+host name) of the proxy server. This drives the appropriate changes in the `JAVA_OPTS` and `https(s)_proxy` variables // in the Che server and workspaces containers. // Only use when configuring a proxy is required. Operator respects OpenShift cluster wide proxy configuration // and no additional configuration is required, but defining `proxyUrl` in a custom resource leads to overrides the cluster proxy configuration // with fields `proxyUrl`, `proxyPort`, `proxyUser` and `proxyPassword` from the custom resource. // See the doc https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields. // +optional ProxyURL string `json:"proxyURL,omitempty"` // Port of the proxy server. Only use when configuring a proxy is required. See also the `proxyURL` and `nonProxyHosts` fields. // +optional ProxyPort string `json:"proxyPort,omitempty"` // List of hosts that will be reached directly, bypassing the proxy. // Specify wild card domain use the following form `.<DOMAIN>` and `|` as delimiter, for example: `localhost|.my.host.com|123.42.12.32` // Only use when configuring a proxy is required. Operator respects OpenShift cluster wide proxy configuration and no additional configuration is required, // but defining `nonProxyHosts` in a custom resource leads to merging non proxy hosts lists from the cluster proxy configuration and ones defined in the custom resources. // See the doc https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields. NonProxyHosts string `json:"nonProxyHosts,omitempty"` // User name of the proxy server. Only use when configuring a proxy is required. See also the `proxyURL`, `proxyPassword` and `proxySecret` fields. // +optional ProxyUser string `json:"proxyUser,omitempty"` // Password of the proxy server. // Only use when proxy configuration is required. See the `proxyURL`, `proxyUser` and `proxySecret` fields. // +optional ProxyPassword string `json:"proxyPassword,omitempty"` // The secret that contains `user` and `password` for a proxy server. When the secret is defined, the `proxyUser` and `proxyPassword` are ignored. // +optional ProxySecret string `json:"proxySecret,omitempty"` // Overrides the memory request used in the Che server deployment. Defaults to 512Mi. // +optional ServerMemoryRequest string `json:"serverMemoryRequest,omitempty"` // Overrides the memory limit used in the Che server deployment. Defaults to 1Gi. // +optional ServerMemoryLimit string `json:"serverMemoryLimit,omitempty"` // Overrides the CPU limit used in the Che server deployment // In cores. (500m = .5 cores). Default to 1. // +optional ServerCpuLimit string `json:"serverCpuLimit,omitempty"` // Overrides the CPU request used in the Che server deployment // In cores. (500m = .5 cores). Default to 100m. // +optional ServerCpuRequest string `json:"serverCpuRequest,omitempty"` // Sets the server and workspaces exposure type. // Possible values are `multi-host`, `single-host`, `default-host`. Defaults to `multi-host`, which creates a separate ingress, or OpenShift routes, for every required endpoint. // `single-host` makes Che exposed on a single host name with workspaces exposed on subpaths. // Read the docs to learn about the limitations of this approach. // Also consult the `singleHostExposureType` property to further configure how the Operator and the Che server make that happen on Kubernetes. // `default-host` exposes the Che server on the host of the cluster. Read the docs to learn about the limitations of this approach. // +optional ServerExposureStrategy string `json:"serverExposureStrategy,omitempty"` // The image used for the gateway in the single host mode. Omit it or leave it empty to use the default container image provided by the Operator. // +optional SingleHostGatewayImage string `json:"singleHostGatewayImage,omitempty"` // The image used for the gateway sidecar that provides configuration to the gateway. Omit it or leave it empty to use the default container image provided by the Operator. // +optional SingleHostGatewayConfigSidecarImage string `json:"singleHostGatewayConfigSidecarImage,omitempty"` // The labels that need to be present in the ConfigMaps representing the gateway configuration. // +optional SingleHostGatewayConfigMapLabels labels.Set `json:"singleHostGatewayConfigMapLabels,omitempty"` // The Che server ingress custom settings. // +optional CheServerIngress IngressCustomSettings `json:"cheServerIngress,omitempty"` // The Che server route custom settings. // +optional CheServerRoute RouteCustomSettings `json:"cheServerRoute,omitempty"` }
+k8s:openapi-gen=true General configuration settings related to the Che server and the plugin and devfile registries.
func (*CheClusterSpecServer) DeepCopy ¶
func (in *CheClusterSpecServer) DeepCopy() *CheClusterSpecServer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterSpecServer.
func (*CheClusterSpecServer) DeepCopyInto ¶
func (in *CheClusterSpecServer) DeepCopyInto(out *CheClusterSpecServer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CheClusterSpecStorage ¶
type CheClusterSpecStorage struct { // Persistent volume claim strategy for the Che server. This Can be:`common` (all workspaces PVCs in one volume), // `per-workspace` (one PVC per workspace for all declared volumes) and `unique` (one PVC per declared volume). Defaults to `common`. // +optional PvcStrategy string `json:"pvcStrategy,omitempty"` // Size of the persistent volume claim for workspaces. Defaults to `1Gi`. // +optional PvcClaimSize string `json:"pvcClaimSize,omitempty"` // Instructs the Che server to start a special Pod to pre-create a sub-path in the Persistent Volumes. // Defaults to `false`, however it will need to enable it according to the configuration of your Kubernetes cluster. // +optional PreCreateSubPaths bool `json:"preCreateSubPaths"` // 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 `preCreateSubPaths` field. // +optional PvcJobsImage string `json:"pvcJobsImage,omitempty"` // Storage class for the Persistent Volume Claim dedicated to the PostgreSQL database. When omitted or left blank, a default storage class is used. // +optional PostgresPVCStorageClassName string `json:"postgresPVCStorageClassName,omitempty"` // Storage class for the Persistent Volume Claims dedicated to the Che workspaces. When omitted or left blank, a default storage class is used. // +optional WorkspacePVCStorageClassName string `json:"workspacePVCStorageClassName,omitempty"` }
+k8s:openapi-gen=true Configuration settings related to the persistent storage used by the Che installation.
func (*CheClusterSpecStorage) DeepCopy ¶
func (in *CheClusterSpecStorage) DeepCopy() *CheClusterSpecStorage
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterSpecStorage.
func (*CheClusterSpecStorage) DeepCopyInto ¶
func (in *CheClusterSpecStorage) DeepCopyInto(out *CheClusterSpecStorage)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CheClusterStatus ¶
type CheClusterStatus struct { // OpenShift OAuth secret that contains user credentials for HTPasswd identity provider. // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="OpenShift OAuth secret that contains user credentials for HTPasswd identity provider." // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:text" OpenShiftOAuthUserCredentialsSecret string `json:"openShiftOAuthUserCredentialsSecret"` // Indicates that a PostgreSQL instance has been correctly provisioned or not. // Indicates that a PostgreSQL instance has been correctly provisioned or not. // +optional DbProvisoned bool `json:"dbProvisioned"` // Indicates whether an Identity Provider instance, Keycloak or RH-SSO, has been provisioned with realm, client and user. // +optional KeycloakProvisoned bool `json:"keycloakProvisioned"` // Indicates whether an Identity Provider instance, Keycloak or RH-SSO, has been configured to integrate with the OpenShift OAuth. // +optional OpenShiftoAuthProvisioned bool `json:"openShiftoAuthProvisioned"` // Indicates whether an Identity Provider instance, Keycloak or RH-SSO, has been configured to integrate with the GitHub OAuth. // +optional GitHubOAuthProvisioned bool `json:"gitHubOAuthProvisioned"` // Status of a Che installation. Can be `Available`, `Unavailable`, or `Available, Rolling Update in Progress`. // +optional // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="Status" // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:io.kubernetes.phase" CheClusterRunning string `json:"cheClusterRunning"` // Current installed Che version. // +optional // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="displayName: Eclipse Che version" // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:org.w3:link" CheVersion string `json:"cheVersion"` // Public URL to the Che server. // +optional // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="Eclipse Che URL" // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:org.w3:link" CheURL string `json:"cheURL"` // Public URL to the Identity Provider server, Keycloak or RH-SSO,. // +optional // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="Keycloak Admin Console URL" // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:org.w3:link" KeycloakURL string `json:"keycloakURL"` // Public URL to the devfile registry. // +optional // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="Devfile registry URL" // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:org.w3:link" DevfileRegistryURL string `json:"devfileRegistryURL"` // Public URL to the plugin registry. // +optional // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="Plugin registry URL" // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:org.w3:link" PluginRegistryURL string `json:"pluginRegistryURL"` // A human readable message indicating details about why the Pod is in this condition. // +optional // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="Message" // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:text" Message string `json:"message,omitempty"` // A brief CamelCase message indicating details about why the Pod is in this state. // +optional // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="Reason" // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:text" Reason string `json:"reason,omitempty"` // A URL that points to some URL where to find help related to the current Operator status. // +optional // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors=true // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.displayName="Help link" // +operator-sdk:gen-csv:customresourcedefinitions.statusDescriptors.x-descriptors="urn:alm:descriptor:org.w3:link" HelpLink string `json:"helpLink,omitempty"` }
CheClusterStatus defines the observed state of Che installation
func (*CheClusterStatus) DeepCopy ¶
func (in *CheClusterStatus) DeepCopy() *CheClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheClusterStatus.
func (*CheClusterStatus) DeepCopyInto ¶
func (in *CheClusterStatus) DeepCopyInto(out *CheClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IngressCustomSettings ¶
type IngressCustomSettings struct { // Comma separated list of labels that can be used to organize and categorize objects by scoping and selecting. // +optional Labels string `json:"labels,omitempty"` }
Ingress custom settings, can be extended in the future
func (*IngressCustomSettings) DeepCopy ¶
func (in *IngressCustomSettings) DeepCopy() *IngressCustomSettings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressCustomSettings.
func (*IngressCustomSettings) DeepCopyInto ¶
func (in *IngressCustomSettings) DeepCopyInto(out *IngressCustomSettings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Resources ¶
type Resources struct { // Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) // +optional Memory string `json:"memory,omitempty"` // CPU, in cores. (500m = .5 cores) // +optional Cpu string `json:"cpu,omitempty"` }
List of resources
func (*Resources) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resources.
func (*Resources) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ResourcesCustomSettings ¶
type ResourcesCustomSettings struct { // Requests describes the minimum amount of compute resources required. // +optional Requests Resources `json:"request,omitempty"` // Limits describes the maximum amount of compute resources allowed. // +optional Limits Resources `json:"limits,omitempty"` }
ResourceRequirements describes the compute resource requirements.
func (*ResourcesCustomSettings) DeepCopy ¶
func (in *ResourcesCustomSettings) DeepCopy() *ResourcesCustomSettings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourcesCustomSettings.
func (*ResourcesCustomSettings) DeepCopyInto ¶
func (in *ResourcesCustomSettings) DeepCopyInto(out *ResourcesCustomSettings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouteCustomSettings ¶
type RouteCustomSettings struct { // Comma separated list of labels that can be used to organize and categorize objects by scoping and selecting. // +optional Labels string `json:"labels,omitempty"` // Operator uses the domain to generate a hostname for a route. // In a conjunction with labels it creates a route, which is served by a non-default Ingress controller. // The generated host name will follow this pattern: `<route-name>-<route-namespace>.<domain>`. // +optional Domain string `json:"domain,omitempty"` }
Route custom settings, can be extended in the future
func (*RouteCustomSettings) DeepCopy ¶
func (in *RouteCustomSettings) DeepCopy() *RouteCustomSettings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteCustomSettings.
func (*RouteCustomSettings) DeepCopyInto ¶
func (in *RouteCustomSettings) DeepCopyInto(out *RouteCustomSettings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.