From 66b3732894e1611b5d24f6e3f55620ad0d0e353d Mon Sep 17 00:00:00 2001 From: Anatolii Bazko Date: Tue, 4 Jun 2024 12:58:20 +0200 Subject: [PATCH] chore: Update controller-gen tool version to 0.14.0 Signed-off-by: Anatolii Bazko --- Makefile | 2 +- api/v1/zz_generated.deepcopy.go | 1 - api/v2/zz_generated.deepcopy.go | 1 - .../che-operator.clusterserviceversion.yaml | 4 +- .../org.eclipse.che_checlusters.yaml | 5607 ++++++++--------- .../bases/org.eclipse.che_checlusters.yaml | 5443 ++++++++-------- deploy/deployment/kubernetes/combined.yaml | 5441 ++++++++-------- ....eclipse.che.CustomResourceDefinition.yaml | 5441 ++++++++-------- deploy/deployment/openshift/combined.yaml | 5441 ++++++++-------- ....eclipse.che.CustomResourceDefinition.yaml | 5441 ++++++++-------- ....eclipse.che.CustomResourceDefinition.yaml | 5441 ++++++++-------- 11 files changed, 19521 insertions(+), 18742 deletions(-) diff --git a/Makefile b/Makefile index 8200b666e..4aa3cb54b 100644 --- a/Makefile +++ b/Makefile @@ -566,7 +566,7 @@ download-opm: ## Download opm tool CONTROLLER_GEN = $(shell pwd)/bin/controller-gen download-controller-gen: ## Download controller-gen tool - $(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.7.0) + $(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.14.0) KUSTOMIZE = $(shell pwd)/bin/kustomize download-kustomize: ## Download kustomize tool diff --git a/api/v1/zz_generated.deepcopy.go b/api/v1/zz_generated.deepcopy.go index 2dd04068f..5eb13be5b 100644 --- a/api/v1/zz_generated.deepcopy.go +++ b/api/v1/zz_generated.deepcopy.go @@ -1,5 +1,4 @@ //go:build !ignore_autogenerated -// +build !ignore_autogenerated // // Copyright (c) 2019-2024 Red Hat, Inc. diff --git a/api/v2/zz_generated.deepcopy.go b/api/v2/zz_generated.deepcopy.go index a563f3ea2..0c55c3010 100644 --- a/api/v2/zz_generated.deepcopy.go +++ b/api/v2/zz_generated.deepcopy.go @@ -1,5 +1,4 @@ //go:build !ignore_autogenerated -// +build !ignore_autogenerated // // Copyright (c) 2019-2024 Red Hat, Inc. diff --git a/bundle/next/eclipse-che/manifests/che-operator.clusterserviceversion.yaml b/bundle/next/eclipse-che/manifests/che-operator.clusterserviceversion.yaml index 7c56affa6..cb45f3f16 100644 --- a/bundle/next/eclipse-che/manifests/che-operator.clusterserviceversion.yaml +++ b/bundle/next/eclipse-che/manifests/che-operator.clusterserviceversion.yaml @@ -104,7 +104,7 @@ metadata: operators.operatorframework.io/project_layout: go.kubebuilder.io/v3 repository: https://github.com/eclipse-che/che-operator support: Eclipse Foundation - name: eclipse-che.v7.87.0-871.next + name: eclipse-che.v7.87.0-872.next namespace: placeholder spec: apiservicedefinitions: {} @@ -1036,7 +1036,7 @@ spec: minKubeVersion: 1.19.0 provider: name: Eclipse Foundation - version: 7.87.0-871.next + version: 7.87.0-872.next webhookdefinitions: - admissionReviewVersions: - v1 diff --git a/bundle/next/eclipse-che/manifests/org.eclipse.che_checlusters.yaml b/bundle/next/eclipse-che/manifests/org.eclipse.che_checlusters.yaml index ea75e1f70..8fff1027b 100644 --- a/bundle/next/eclipse-che/manifests/org.eclipse.che_checlusters.yaml +++ b/bundle/next/eclipse-che/manifests/org.eclipse.che_checlusters.yaml @@ -14,7 +14,7 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.14.0 creationTimestamp: null labels: app.kubernetes.io/instance: che @@ -52,55 +52,57 @@ spec: a Che server installation properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource - this object represents. Servers may infer this from the endpoint the - client submits requests to. Cannot be updated. In CamelCase. More - info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: - description: Desired configuration of the Che installation. Based on - these settings, the Operator automatically creates and maintains + description: |- + 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. + the various components of the Che installation. + These generated ConfigMaps must NOT be updated manually. properties: auth: description: Configuration settings related to the Authentication used by the Che installation. properties: debug: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. Debug internal identity provider. type: boolean externalIdentityProvider: - description: 'Deprecated. The value of this flag is ignored. - 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`.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: boolean gatewayAuthenticationSidecarImage: - description: Gateway sidecar responsible for authentication - when NativeUserMode is enabled. See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] - or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. + description: |- + Gateway sidecar responsible for authentication when NativeUserMode is enabled. + See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. type: string gatewayAuthorizationSidecarImage: - description: Gateway sidecar responsible for authorization when - NativeUserMode is enabled. See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] - or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] + description: |- + Gateway sidecar responsible for authorization when NativeUserMode is enabled. + See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] type: string gatewayConfigBumpEnv: description: List of environment variables to set in the Configbump @@ -114,16 +116,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -136,10 +138,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -148,12 +150,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -166,12 +167,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -191,6 +191,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -200,10 +201,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -212,6 +213,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -229,16 +231,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -251,10 +253,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -263,12 +265,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -281,12 +282,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -306,6 +306,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -315,10 +316,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -327,6 +328,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -348,16 +350,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -370,10 +372,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -382,12 +384,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -400,12 +401,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -425,6 +425,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -434,10 +435,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -446,6 +447,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -463,16 +465,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -485,10 +487,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -497,12 +499,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -515,12 +516,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -540,6 +540,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -549,10 +550,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -561,26 +562,27 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array identityProviderAdminUserName: - description: Deprecated. The value of this flag is ignored. - Overrides the name of the Identity Provider administrator - user. Defaults to `admin`. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the name of the Identity Provider administrator user. Defaults to `admin`. type: string identityProviderClientId: - description: Deprecated. The value of this flag is ignored. - 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string identityProviderContainerResources: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. Identity provider container custom settings. properties: limits: @@ -609,21 +611,20 @@ spec: type: object type: object identityProviderImage: - description: Deprecated. The value of this flag is ignored. - 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderImagePullPolicy: - description: Deprecated. The value of this flag is ignored. - Overrides the image pull policy used in the Identity Provider, - Keycloak or RH-SSO, deployment. Default value is `Always` - for `nightly`, `next` or `latest` images, and `IfNotPresent` - in other cases. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the image pull policy used in the Identity Provider, Keycloak or RH-SSO, deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string identityProviderIngress: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. Ingress custom settings. properties: annotations: @@ -640,43 +641,38 @@ spec: type: string type: object identityProviderPassword: - description: Deprecated. The value of this flag is ignored. - 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresPassword: - description: Deprecated. The value of this flag is ignored. - 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresSecret: - description: 'Deprecated. The value of this flag is ignored. - 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`. - The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderRealm: - description: Deprecated. The value of this flag is ignored. - 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderRoute: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. Route custom settings. properties: annotations: @@ -687,10 +683,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be @@ -699,49 +695,43 @@ spec: type: string type: object identityProviderSecret: - description: 'Deprecated. The value of this flag is ignored. - 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`. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderURL: - description: 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. + description: |- + 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. type: string identityToken: - description: 'Identity token to be passed to upstream. There - are two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string initialOpenShiftOAuthUser: - description: Deprecated. The value of this flag is ignored. - 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 in 'openshift-config' namespace by Operator. Note that - this solution is Openshift 4 platform-specific. + description: |- + Deprecated. The value of this flag is ignored. + 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 in 'openshift-config' namespace by Operator. + Note that this solution is Openshift 4 platform-specific. type: boolean nativeUserMode: - description: Deprecated. The value of this flag is ignored. - Enables native user mode. Currently works only on OpenShift - and DevWorkspace engine. Native User mode uses OpenShift OAuth - directly as identity provider, without Keycloak. + description: |- + Deprecated. The value of this flag is ignored. + Enables native user mode. Currently works only on OpenShift and DevWorkspace engine. + Native User mode uses OpenShift OAuth directly as identity provider, without Keycloak. type: boolean oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used @@ -749,8 +739,9 @@ spec: when left blank. See also the `OpenShiftoAuth` field. type: string oAuthScope: - description: Access Token Scope. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` @@ -759,19 +750,17 @@ spec: field. type: string openShiftoAuth: - description: 'Deprecated. The value of this flag is ignored. - 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean updateAdminPassword: - description: Deprecated. The value of this flag is ignored. - Forces the default `admin` Che user to update password on - first login. Defaults to `false`. + description: |- + Deprecated. The value of this flag is ignored. + Forces the default `admin` Che user to update password on first login. Defaults to `false`. type: boolean type: object dashboard: @@ -820,9 +809,9 @@ spec: to connect to the DB. Defaults to `dbche`. type: string chePostgresHostName: - description: 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`. + description: |- + 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. type: string chePostgresPassword: @@ -831,36 +820,29 @@ spec: set to an automatically generated value. type: string chePostgresPort: - description: 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. + description: |- + 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. type: string chePostgresSecret: - description: '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 `postgres-credentials` - will be created with default value of `pgche` for `user` and - with an auto-generated value for `password`. The secret must - have `app.kubernetes.io/part-of=che.eclipse.org` label.' + description: |- + 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 `postgres-credentials` + will be created with default value of `pgche` for `user` and with an auto-generated value for `password`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string chePostgresUser: description: PostgreSQL user that the Che server uses to connect to the DB. Defaults to `pgche`. type: string externalDb: - description: '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`.' + description: |- + 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`. type: boolean postgresEnv: description: List of environment variables to set in the PostgreSQL @@ -874,16 +856,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -896,10 +878,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -908,12 +890,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -926,12 +907,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -951,6 +931,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -960,10 +941,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -972,6 +953,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -989,30 +971,29 @@ spec: `next` or `latest` images, and `IfNotPresent` in other cases. type: string postgresVersion: - description: 'Indicates a PostgreSQL version image to use. Allowed - values are: `9.6` and `13.3`. Migrate your PostgreSQL database - to switch from one version to another.' + description: |- + Indicates a PostgreSQL version image to use. Allowed values are: `9.6` and `13.3`. + Migrate your PostgreSQL database to switch from one version to another. type: string pvcClaimSize: - description: Size of the persistent volume claim for database. - Defaults to `1Gi`. To update pvc storageclass that provisions - it must support resize when Eclipse Che has been already deployed. + description: |- + Size of the persistent volume claim for database. Defaults to `1Gi`. + To update pvc storageclass that provisions it must support resize when Eclipse Che has been already deployed. type: string type: object devWorkspace: description: DevWorkspace operator configuration properties: controllerImage: - description: Overrides the container image used in the DevWorkspace - controller deployment. This includes the image tag. Omit it - or leave it empty to use the default container image provided - by the Operator. + description: |- + Overrides the container image used in the DevWorkspace controller deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string enable: - description: 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. + description: |- + 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. type: boolean env: description: List of environment variables to set in the DevWorkspace @@ -1026,16 +1007,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1048,10 +1029,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -1060,12 +1041,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1078,12 +1058,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1103,6 +1082,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1112,10 +1092,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -1124,6 +1104,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1134,17 +1115,18 @@ spec: type: string secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer required: @@ -1162,15 +1144,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -1184,14 +1167,15 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -1205,14 +1189,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client - secret. See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -1223,17 +1208,15 @@ spec: description: Kubernetes Image Puller configuration properties: enable: - description: 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. If the `spec.images` - field is empty, a set of recommended workspace-related images - will be automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + 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. + If the `spec.images` field is empty, a set of recommended workspace-related images will be automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A KubernetesImagePullerSpec to configure the image @@ -1274,24 +1257,21 @@ spec: made on upstream Kubernetes. properties: ingressClass: - description: '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.' + description: |- + 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. type: string ingressDomain: description: 'Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: - description: 'Deprecated. The value of this flag is ignored. - 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string securityContextFsGroup: description: The FSGroup in which the Che Pod and workspace @@ -1302,22 +1282,17 @@ spec: run as. Default value is `1724`. type: string singleHostExposureType: - description: Deprecated. The value of this flag is ignored. - 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string tlsSecretName: - description: 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. + description: |- + 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. type: string type: object metrics: @@ -1334,74 +1309,69 @@ spec: the plugin and devfile registries properties: airGapContainerRegistryHostname: - description: 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. + description: |- + 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. type: string airGapContainerRegistryOrganization: - description: 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. + description: |- + 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. type: string allowAutoProvisionUserNamespace: - description: Indicates if is allowed to automatically create - a user namespace. If it set to false, then user namespace - must be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean allowUserDefinedWorkspaceNamespaces: - description: Deprecated. The value of this flag is ignored. - 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean cheClusterRoles: - description: A comma-separated list of ClusterRoles that will - be assigned to Che ServiceAccount. Each role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. Be aware that the Che Operator has to already have - all permissions in these ClusterRoles to grant them. + description: |- + A comma-separated list of ClusterRoles that will be assigned to Che ServiceAccount. + Each role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + Be aware that the Che Operator has to already have all permissions in these ClusterRoles to grant them. type: string cheDebug: description: Enables the debug mode for Che server. Defaults to `false`. type: string cheFlavor: - description: Deprecated. The value of this flag is ignored. - Specifies a variation of the installation. The options are `che` - for upstream Che installations or `devspaces` for Red Hat - OpenShift Dev Spaces (formerly Red Hat CodeReady Workspaces) - installation + description: |- + Deprecated. The value of this flag is ignored. + Specifies a variation of the installation. The options are `che` for upstream Che installations or + `devspaces` for Red Hat OpenShift Dev Spaces (formerly Red Hat CodeReady Workspaces) installation type: string cheHost: - description: 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. + description: |- + 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. type: string cheHostTLSSecret: - description: Name of a secret containing certificates to secure - ingress or route for the custom host name of the installed - Che server. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. See the `cheHost` field. + description: |- + Name of a secret containing certificates to secure ingress or route for the custom host name of the installed Che server. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. + See the `cheHost` field. type: string cheImage: - description: 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. + description: |- + 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. type: string cheImagePullPolicy: - description: Overrides the image pull policy used in Che deployment. - Default value is `Always` for `nightly`, `next` or `latest` - images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in Che deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string cheImageTag: - description: 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. + description: |- + 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. type: string cheLogLevel: description: 'Log level for the Che server: `INFO` or `DEBUG`. @@ -1419,16 +1389,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1441,10 +1411,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -1453,12 +1423,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1471,12 +1440,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1496,6 +1464,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1505,10 +1474,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -1517,6 +1486,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1549,10 +1519,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be @@ -1561,28 +1531,29 @@ spec: type: string type: object cheWorkspaceClusterRole: - description: Custom cluster role bound to the user for the Che - workspaces. The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. The default roles are used when omitted or left blank. + description: |- + Custom cluster role bound to the user for the Che workspaces. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string - description: 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, + description: |- + 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. type: object dashboardCpuLimit: - description: Overrides the CPU limit used in the dashboard deployment. + description: |- + Overrides the CPU limit used in the dashboard deployment. In cores. (500m = .5 cores). Default to 500m. type: string dashboardCpuRequest: - description: Overrides the CPU request used in the dashboard - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the dashboard deployment. + In cores. (500m = .5 cores). Default to 100m. type: string dashboardEnv: description: List of environment variables to set in the dashboard @@ -1596,16 +1567,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1618,10 +1589,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -1630,12 +1601,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1648,12 +1618,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1673,6 +1642,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1682,10 +1652,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -1694,24 +1664,25 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array dashboardImage: - description: Overrides the container image used in the dashboard - deployment. This includes the image tag. Omit it or leave - it empty to use the default container image provided by the - Operator. + description: |- + Overrides the container image used in the dashboard deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string dashboardImagePullPolicy: - description: Overrides the image pull policy used in the dashboard - deployment. Default value is `Always` for `nightly`, `next` - or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the dashboard deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string dashboardIngress: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. Dashboard ingress custom settings. properties: annotations: @@ -1736,7 +1707,8 @@ spec: deployment. Defaults to 16Mi. type: string dashboardRoute: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. Dashboard route custom settings. properties: annotations: @@ -1747,10 +1719,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be @@ -1759,12 +1731,14 @@ spec: type: string type: object devfileRegistryCpuLimit: - description: Overrides the CPU limit used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string devfileRegistryCpuRequest: - description: Overrides the CPU request used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string devfileRegistryEnv: description: List of environment variables to set in the plugin @@ -1778,16 +1752,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1800,10 +1774,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -1812,12 +1786,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1830,12 +1803,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1855,6 +1827,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1864,10 +1837,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -1876,19 +1849,20 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array devfileRegistryImage: - description: 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. + description: |- + 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. type: string devfileRegistryIngress: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. The devfile registry ingress custom settings. properties: annotations: @@ -1913,12 +1887,13 @@ spec: registry deployment. Defaults to 16Mi. type: string devfileRegistryPullPolicy: - description: Overrides the image pull policy used in the devfile - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the devfile registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string devfileRegistryRoute: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. The devfile registry route custom settings. properties: annotations: @@ -1929,10 +1904,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be @@ -1945,14 +1920,14 @@ spec: fields. type: string disableInternalClusterSVCNames: - description: Deprecated. The value of this flag is ignored. - Disable internal cluster SVC names usage to communicate between - components to speed up the traffic and avoid proxy issues. + description: |- + Deprecated. The value of this flag is ignored. + Disable internal cluster SVC names usage to communicate between components to speed up the traffic and avoid proxy issues. type: boolean externalDevfileRegistries: - description: External devfile registries, that serves sample, - ready-to-use devfiles. Configure this in addition to a dedicated - devfile registry (when `externalDevfileRegistry` is `false`) + description: |- + External devfile registries, that serves sample, ready-to-use devfiles. + Configure this in addition to a dedicated devfile registry (when `externalDevfileRegistry` is `false`) or instead of it (when `externalDevfileRegistry` is `true`) items: description: Settings for a configuration of the external @@ -1964,50 +1939,44 @@ spec: type: object type: array externalDevfileRegistry: - description: 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 - configure at least one devfile registry with `externalDevfileRegistries` - field. + description: |- + 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 configure at least one + devfile registry with `externalDevfileRegistries` field. type: boolean externalPluginRegistry: - description: 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. + description: |- + 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. type: boolean gitSelfSignedCert: - description: When enabled, the certificate from `che-git-self-signed-cert` - ConfigMap will be propagated to the Che components and provide - particular configuration for Git. Note, the `che-git-self-signed-cert` - ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + When enabled, the certificate from `che-git-self-signed-cert` ConfigMap will be propagated to the Che components and provide particular configuration for Git. + Note, the `che-git-self-signed-cert` ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: boolean nonProxyHosts: - description: 'List of hosts that will be reached directly, bypassing - the proxy. Specify wild card domain use the following form - `.` 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.' + description: |- + List of hosts that will be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.` 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. type: string openVSXRegistryURL: description: Open VSX registry URL. If omitted an embedded instance will be used. type: string pluginRegistryCpuLimit: - description: Overrides the CPU limit used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string pluginRegistryCpuRequest: - description: Overrides the CPU request used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string pluginRegistryEnv: description: List of environment variables to set in the devfile @@ -2021,16 +1990,16 @@ spec: a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. - If a variable cannot be resolved, the reference in the - input string will be unchanged. Double $$ are reduced - to a single $, which allows for escaping the $(VAR_NAME) - syntax: i.e. "$$(VAR_NAME)" will produce the string - literal "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -2043,10 +2012,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -2055,12 +2024,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -2073,12 +2041,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -2098,6 +2065,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -2107,10 +2075,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -2119,19 +2087,20 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array pluginRegistryImage: - description: 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. + description: |- + 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. type: string pluginRegistryIngress: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. Plugin registry ingress custom settings. properties: annotations: @@ -2156,12 +2125,13 @@ spec: registry deployment. Defaults to 16Mi. type: string pluginRegistryPullPolicy: - description: Overrides the image pull policy used in the plugin - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the plugin registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string pluginRegistryRoute: - description: Deprecated. The value of this flag is ignored. + description: |- + Deprecated. The value of this flag is ignored. Plugin registry route custom settings. properties: annotations: @@ -2172,10 +2142,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be @@ -2184,16 +2154,15 @@ spec: type: string type: object pluginRegistryUrl: - description: 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. + description: |- + 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. type: string proxyPassword: - description: Password of the proxy server. Only use when proxy - configuration is required. See the `proxyURL`, `proxyUser` - and `proxySecret` fields. + description: |- + Password of the proxy server. + Only use when proxy configuration is required. See the `proxyURL`, `proxyUser` and `proxySecret` fields. type: string proxyPort: description: Port of the proxy server. Only use when configuring @@ -2201,22 +2170,18 @@ spec: fields. type: string proxySecret: - description: The secret that contains `user` and `password` - for a proxy server. When the secret is defined, the `proxyUser` - and `proxyPassword` are ignored. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The secret that contains `user` and `password` for a proxy server. When the secret is defined, the `proxyUser` and `proxyPassword` are ignored. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string proxyURL: - description: 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. + description: |- + 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. type: string proxyUser: description: User name of the proxy server. Only use when configuring @@ -2224,32 +2189,29 @@ spec: and `proxySecret` fields. type: string selfSignedCert: - description: 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. + description: |- + 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. type: boolean serverCpuLimit: - description: Overrides the CPU limit used in the Che server - deployment In cores. (500m = .5 cores). Default to 1. + description: |- + Overrides the CPU limit used in the Che server deployment + In cores. (500m = .5 cores). Default to 1. type: string serverCpuRequest: - description: Overrides the CPU request used in the Che server - deployment In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the Che server deployment + In cores. (500m = .5 cores). Default to 100m. type: string serverExposureStrategy: - description: Deprecated. The value of this flag is ignored. - 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. + 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. type: string serverMemoryLimit: description: Overrides the memory limit used in the Che server @@ -2260,13 +2222,11 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: 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. The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + 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. + The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string singleHostGatewayConfigMapLabels: additionalProperties: @@ -2293,9 +2253,9 @@ spec: description: Deprecated in favor of `disableInternalClusterSVCNames`. type: boolean workspaceDefaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile does - not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile does not contain any components. items: properties: attributes: @@ -2334,20 +2294,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command\ - \ running the dockerimage component. The arguments\ - \ are supplied either to the default command provided\ - \ in the image or to the overridden command. \n\ - \ Defaults to an empty array, meaning use whatever\ - \ is defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage\ - \ component instead of the default one provided\ - \ in the image. \n Defaults to an empty array, meaning\ - \ use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -2356,10 +2316,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in\ - \ its own separated pod, instead of running as part\ - \ of the main development environment pod. \n Default\ - \ value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -2371,29 +2333,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes. \n Examples\ - \ of Che-specific attributes: \n - cookiesAuthEnabled:\ - \ \"true\" / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should\ - \ be exposed on the network. \n - `public`\ - \ means that the endpoint will be exposed\ - \ on the public network, typically through\ - \ a K8S ingress or an OpenShift route. \n\ - \ - `internal` means that the endpoint will\ - \ be exposed internally outside of the main\ - \ devworkspace POD, typically by K8S services,\ - \ to be consumed by other elements running\ - \ on the same cloud internal network. \n -\ - \ `none` means that the endpoint will not\ - \ be exposed and will only be accessible inside\ - \ the main devworkspace POD, on a local address.\ - \ \n Default value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2408,26 +2380,31 @@ spec: type: string protocol: default: http - description: "Describes the application and\ - \ transport protocols of the traffic that\ - \ will go through this endpoint. \n - `http`:\ - \ Endpoint will have `http` traffic, typically\ - \ on a TCP connection. It will be automaticaly\ - \ promoted to `https` when the `secure` field\ - \ is set to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically on\ - \ a TCP connection. \n - `ws`: Endpoint will\ - \ have `ws` traffic, typically on a TCP connection.\ - \ It will be automaticaly promoted to `wss`\ - \ when the `secure` field is set to `true`.\ - \ \n - `wss`: Endpoint will have `wss` traffic,\ - \ typically on a TCP connection. \n - `tcp`:\ - \ Endpoint will have traffic on a TCP connection,\ - \ without specifying an application protocol.\ - \ \n - `udp`: Endpoint will have traffic on\ - \ an UDP connection, without specifying an\ - \ application protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2437,14 +2414,13 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot + description: |- + Port number to be used within the container component. The same port cannot be used by two different container components. type: integer required: @@ -2453,10 +2429,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container.\ - \ \n The following variables are reserved and cannot\ - \ be overridden via env: \n - `$PROJECTS_ROOT`\ - \ \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -2475,17 +2458,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source\ - \ code should be mounted in the component. \n Defaults\ - \ to true for all component types except plugins\ - \ and components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in - the container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the - default value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be @@ -2495,19 +2480,17 @@ spec: component container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then - they will reuse the same volume and will be - able to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not - path is mentioned, default path is the is - `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -2517,19 +2500,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through - some dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process - this command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -2542,8 +2526,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built\ - \ during startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -2563,19 +2550,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that - contains a Dockerfile. The src in the OCI - registry required for the Dockerfile build - will be downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull - the Dockerfile from when using the Devfile - Registry as Dockerfile src. To ensure the - Dockerfile gets resolved consistently in - different environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -2594,34 +2577,32 @@ spec: more than one remote configured type: string revision: - description: The revision to checkout - from. Should be branch name, tag or - commit id. Default branch is used if - missing or specified revision is not - found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in - the Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should - be initialized in the git project. Projects - must have at least one remote configured - while StarterProjects & Image Component's - Git source can only have at most one remote - configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder\ - \ pod is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -2631,9 +2612,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It - can be a full URL or a relative URI from the - current devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -2649,14 +2630,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed\ - \ during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2668,29 +2652,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes. \n Examples\ - \ of Che-specific attributes: \n - cookiesAuthEnabled:\ - \ \"true\" / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should\ - \ be exposed on the network. \n - `public`\ - \ means that the endpoint will be exposed\ - \ on the public network, typically through\ - \ a K8S ingress or an OpenShift route. \n\ - \ - `internal` means that the endpoint will\ - \ be exposed internally outside of the main\ - \ devworkspace POD, typically by K8S services,\ - \ to be consumed by other elements running\ - \ on the same cloud internal network. \n -\ - \ `none` means that the endpoint will not\ - \ be exposed and will only be accessible inside\ - \ the main devworkspace POD, on a local address.\ - \ \n Default value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2705,26 +2699,31 @@ spec: type: string protocol: default: http - description: "Describes the application and\ - \ transport protocols of the traffic that\ - \ will go through this endpoint. \n - `http`:\ - \ Endpoint will have `http` traffic, typically\ - \ on a TCP connection. It will be automaticaly\ - \ promoted to `https` when the `secure` field\ - \ is set to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically on\ - \ a TCP connection. \n - `ws`: Endpoint will\ - \ have `ws` traffic, typically on a TCP connection.\ - \ It will be automaticaly promoted to `wss`\ - \ when the `secure` field is set to `true`.\ - \ \n - `wss`: Endpoint will have `wss` traffic,\ - \ typically on a TCP connection. \n - `tcp`:\ - \ Endpoint will have traffic on a TCP connection,\ - \ without specifying an application protocol.\ - \ \n - `udp`: Endpoint will have traffic on\ - \ an UDP connection, without specifying an\ - \ application protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2734,14 +2733,13 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot + description: |- + Port number to be used within the container component. The same port cannot be used by two different container components. type: integer required: @@ -2763,22 +2761,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or - from an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For - example this allows reusing the OpenShift definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed\ - \ during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2790,29 +2791,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes. \n Examples\ - \ of Che-specific attributes: \n - cookiesAuthEnabled:\ - \ \"true\" / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should\ - \ be exposed on the network. \n - `public`\ - \ means that the endpoint will be exposed\ - \ on the public network, typically through\ - \ a K8S ingress or an OpenShift route. \n\ - \ - `internal` means that the endpoint will\ - \ be exposed internally outside of the main\ - \ devworkspace POD, typically by K8S services,\ - \ to be consumed by other elements running\ - \ on the same cloud internal network. \n -\ - \ `none` means that the endpoint will not\ - \ be exposed and will only be accessible inside\ - \ the main devworkspace POD, on a local address.\ - \ \n Default value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2827,26 +2838,31 @@ spec: type: string protocol: default: http - description: "Describes the application and\ - \ transport protocols of the traffic that\ - \ will go through this endpoint. \n - `http`:\ - \ Endpoint will have `http` traffic, typically\ - \ on a TCP connection. It will be automaticaly\ - \ promoted to `https` when the `secure` field\ - \ is set to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically on\ - \ a TCP connection. \n - `ws`: Endpoint will\ - \ have `ws` traffic, typically on a TCP connection.\ - \ It will be automaticaly promoted to `wss`\ - \ when the `secure` field is set to `true`.\ - \ \n - `wss`: Endpoint will have `wss` traffic,\ - \ typically on a TCP connection. \n - `tcp`:\ - \ Endpoint will have traffic on a TCP connection,\ - \ without specifying an application protocol.\ - \ \n - `udp`: Endpoint will have traffic on\ - \ an UDP connection, without specifying an\ - \ application protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2856,14 +2872,13 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot + description: |- + Port number to be used within the container component. The same port cannot be used by two different container components. type: integer required: @@ -2885,34 +2900,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are\ - \ mainly imported devfiles that contribute components,\ - \ commands and events as a consistent single unit. They\ - \ are defined in either YAML files following the devfile\ - \ syntax, or as `DevWorkspaceTemplate` Kubernetes Custom\ - \ Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in - a parent devfile or a plugin. Overriding is done - according to K8S strategic merge patch standard - rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying\ - \ a given component definition, typically\ - \ bound to a devworkspace event. \n For example,\ - \ when an `apply` command is bound to a `preStart`\ - \ event, and references a `container` component,\ - \ it will start the container as a K8S initContainer\ - \ in the devworkspace POD, unless the component\ - \ has its `dedicatedPod` field set to `true`.\ - \ \n When no `apply` command exist for a given\ - \ component, it is assumed the component will\ - \ be applied at devworkspace start by default,\ - \ unless `deployByDefault` for that component\ - \ is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -2938,9 +2955,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in - Editor UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -2956,9 +2973,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise @@ -2986,9 +3003,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in - Editor UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -3000,25 +3017,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string\ - \ \n Special variables that can be used:\ - \ \n - `$PROJECTS_ROOT`: A path where\ - \ projects sources are mounted as defined\ - \ by container component's sourceMapping.\ - \ \n - `$PROJECT_SOURCE`: A path to a\ - \ project source ($PROJECTS_ROOT/).\ - \ If there are multiple projects, this\ - \ will point to the directory of the first\ - \ one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -3049,42 +3067,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command\ - \ is restarted or not when the source\ - \ code changes. If set to `true` the command\ - \ won't be restarted. A *hotReloadCapable*\ - \ `run` or `debug` command is expected\ - \ to handle file changes on its own and\ - \ won't be restarted. A *hotReloadCapable*\ - \ `build` command is expected to be executed\ - \ only once and won't be executed again.\ - \ This field is taken into account only\ - \ for commands `build`, `run` and `debug`\ - \ with `isDefault` set to `true`. \n Default\ - \ value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in - Editor UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the\ - \ command should be executed \n Special\ - \ variables that can be used: \n - `$PROJECTS_ROOT`:\ - \ A path where projects sources are mounted\ - \ as defined by container component's\ - \ sourceMapping. \n - `$PROJECT_SOURCE`:\ - \ A path to a project source ($PROJECTS_ROOT/).\ - \ If there are multiple projects, this\ - \ will point to the directory of the first\ - \ one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -3093,10 +3109,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated - in a parent devfile or a plugin. Overriding is done - according to K8S strategic merge patch standard - rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -3135,22 +3150,20 @@ spec: type: object type: object args: - description: "The arguments to supply to\ - \ the command running the dockerimage\ - \ component. The arguments are supplied\ - \ either to the default command provided\ - \ in the image or to the overridden command.\ - \ \n Defaults to an empty array, meaning\ - \ use whatever is defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the\ - \ dockerimage component instead of the\ - \ default one provided in the image. \n\ - \ Defaults to an empty array, meaning\ - \ use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -3159,11 +3172,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should\ - \ run in its own separated pod, instead\ - \ of running as part of the main development\ - \ environment pod. \n Default value is\ - \ `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -3176,33 +3190,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes.\ - \ \n Examples of Che-specific attributes:\ - \ \n - cookiesAuthEnabled: \"true\"\ - \ / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint\ - \ should be exposed on the network.\ - \ \n - `public` means that the endpoint\ - \ will be exposed on the public\ - \ network, typically through a K8S\ - \ ingress or an OpenShift route.\ - \ \n - `internal` means that the\ - \ endpoint will be exposed internally\ - \ outside of the main devworkspace\ - \ POD, typically by K8S services,\ - \ to be consumed by other elements\ - \ running on the same cloud internal\ - \ network. \n - `none` means that\ - \ the endpoint will not be exposed\ - \ and will only be accessible inside\ - \ the main devworkspace POD, on\ - \ a local address. \n Default value\ - \ is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3217,32 +3236,31 @@ spec: URL type: string protocol: - description: "Describes the application\ - \ and transport protocols of the\ - \ traffic that will go through this\ - \ endpoint. \n - `http`: Endpoint\ - \ will have `http` traffic, typically\ - \ on a TCP connection. It will be\ - \ automaticaly promoted to `https`\ - \ when the `secure` field is set\ - \ to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically\ - \ on a TCP connection. \n - `ws`:\ - \ Endpoint will have `ws` traffic,\ - \ typically on a TCP connection.\ - \ It will be automaticaly promoted\ - \ to `wss` when the `secure` field\ - \ is set to `true`. \n - `wss`:\ - \ Endpoint will have `wss` traffic,\ - \ typically on a TCP connection.\ - \ \n - `tcp`: Endpoint will have\ - \ traffic on a TCP connection, without\ - \ specifying an application protocol.\ - \ \n - `udp`: Endpoint will have\ - \ traffic on an UDP connection,\ - \ without specifying an application\ - \ protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3252,28 +3270,31 @@ spec: - udp type: string secure: - description: Describes whether the - endpoint should be secured and protected - by some authentication process. - This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. - The same port cannot be used by - two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used\ - \ in this container. \n The following\ - \ variables are reserved and cannot be\ - \ overridden via env: \n - `$PROJECTS_ROOT`\ - \ \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -3291,19 +3312,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the\ - \ project source code should be mounted\ - \ in the component. \n Defaults to true\ - \ for all component types except plugins\ - \ and components that set `dedicatedPod`\ - \ to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that @@ -3313,21 +3333,17 @@ spec: to a component container properties: name: - description: The volume mount name - is the name of an existing `Volume` - component. If several containers - mount the same volume name then - they will reuse the same volume - and will be able to access to the - same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -3339,9 +3355,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should\ - \ be built during startup. \n Default\ - \ value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -3363,23 +3381,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will - be downloaded for building the - image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as - Dockerfile src. To ensure the - Dockerfile gets resolved consistently - in different environments, it - is recommended to always specify - the `devfileRegistryUrl` when - `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -3398,36 +3408,30 @@ spec: remote configured type: string revision: - description: The revision to - checkout from. Should be branch - name, tag or commit id. Default - branch is used if missing - or specified revision is not - found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at - least one remote configured while - StarterProjects & Image Component's - Git source can only have at most - one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged\ - \ builder pod is required. \n Default\ - \ value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -3437,10 +3441,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative - URI from the current devfile as the - base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -3455,16 +3458,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing - the Kubernetes definitions used to deploy - some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should\ - \ be deployed during startup. \n Default\ - \ value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3477,33 +3481,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes.\ - \ \n Examples of Che-specific attributes:\ - \ \n - cookiesAuthEnabled: \"true\"\ - \ / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint\ - \ should be exposed on the network.\ - \ \n - `public` means that the endpoint\ - \ will be exposed on the public\ - \ network, typically through a K8S\ - \ ingress or an OpenShift route.\ - \ \n - `internal` means that the\ - \ endpoint will be exposed internally\ - \ outside of the main devworkspace\ - \ POD, typically by K8S services,\ - \ to be consumed by other elements\ - \ running on the same cloud internal\ - \ network. \n - `none` means that\ - \ the endpoint will not be exposed\ - \ and will only be accessible inside\ - \ the main devworkspace POD, on\ - \ a local address. \n Default value\ - \ is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3518,32 +3527,31 @@ spec: URL type: string protocol: - description: "Describes the application\ - \ and transport protocols of the\ - \ traffic that will go through this\ - \ endpoint. \n - `http`: Endpoint\ - \ will have `http` traffic, typically\ - \ on a TCP connection. It will be\ - \ automaticaly promoted to `https`\ - \ when the `secure` field is set\ - \ to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically\ - \ on a TCP connection. \n - `ws`:\ - \ Endpoint will have `ws` traffic,\ - \ typically on a TCP connection.\ - \ It will be automaticaly promoted\ - \ to `wss` when the `secure` field\ - \ is set to `true`. \n - `wss`:\ - \ Endpoint will have `wss` traffic,\ - \ typically on a TCP connection.\ - \ \n - `tcp`: Endpoint will have\ - \ traffic on a TCP connection, without\ - \ specifying an application protocol.\ - \ \n - `udp`: Endpoint will have\ - \ traffic on an UDP connection,\ - \ without specifying an application\ - \ protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3553,17 +3561,14 @@ spec: - udp type: string secure: - description: Describes whether the - endpoint should be secured and protected - by some authentication process. - This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. - The same port cannot be used by - two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3584,25 +3589,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as - commands) or from an external devfile that - may reference this component through a parent - or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given - manifest. For example this allows reusing - the OpenShift definitions used to deploy some - runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should\ - \ be deployed during startup. \n Default\ - \ value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3615,33 +3620,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes.\ - \ \n Examples of Che-specific attributes:\ - \ \n - cookiesAuthEnabled: \"true\"\ - \ / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint\ - \ should be exposed on the network.\ - \ \n - `public` means that the endpoint\ - \ will be exposed on the public\ - \ network, typically through a K8S\ - \ ingress or an OpenShift route.\ - \ \n - `internal` means that the\ - \ endpoint will be exposed internally\ - \ outside of the main devworkspace\ - \ POD, typically by K8S services,\ - \ to be consumed by other elements\ - \ running on the same cloud internal\ - \ network. \n - `none` means that\ - \ the endpoint will not be exposed\ - \ and will only be accessible inside\ - \ the main devworkspace POD, on\ - \ a local address. \n Default value\ - \ is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3656,32 +3666,31 @@ spec: URL type: string protocol: - description: "Describes the application\ - \ and transport protocols of the\ - \ traffic that will go through this\ - \ endpoint. \n - `http`: Endpoint\ - \ will have `http` traffic, typically\ - \ on a TCP connection. It will be\ - \ automaticaly promoted to `https`\ - \ when the `secure` field is set\ - \ to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically\ - \ on a TCP connection. \n - `ws`:\ - \ Endpoint will have `ws` traffic,\ - \ typically on a TCP connection.\ - \ It will be automaticaly promoted\ - \ to `wss` when the `secure` field\ - \ is set to `true`. \n - `wss`:\ - \ Endpoint will have `wss` traffic,\ - \ typically on a TCP connection.\ - \ \n - `tcp`: Endpoint will have\ - \ traffic on a TCP connection, without\ - \ specifying an application protocol.\ - \ \n - `udp`: Endpoint will have\ - \ traffic on an UDP connection,\ - \ without specifying an application\ - \ protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3691,17 +3700,14 @@ spec: - udp type: string secure: - description: Describes whether the - endpoint should be secured and protected - by some authentication process. - This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. - The same port cannot be used by - two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3722,12 +3728,13 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults to false type: boolean size: @@ -3762,35 +3769,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in - different environments, it is recommended to always - specify the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull - the parent devfile from, when using id in the parent - reference. To specify `version`, `id` must be defined - and used as the import reference source. `version` - can be either a specific stack version, or `latest`. - If no `version` specified, default version will - be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3802,16 +3808,16 @@ spec: type: array workspaceDefaultEditor: default: che-incubator/che-code/latest - description: The default editor to workspace create with. It - could be a plugin ID or a URI. The plugin ID must have `publisher/plugin/version`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/plugin/version`. The URI must start from `http`. type: string workspaceNamespaceDefault: - description: 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 ``, `` and `` - placeholders, such as che-workspace-. In that case, - a new namespace will be created for each user or workspace. + description: |- + 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 ``, `` and `` placeholders, such as che-workspace-. + In that case, a new namespace will be created for each user or workspace. type: string workspacePodNodeSelector: additionalProperties: @@ -3823,42 +3829,39 @@ spec: description: The pod tolerations put on the workspace pods to limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, - allowed values are NoSchedule, PreferNoSchedule and - NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration - applies to. Empty means match all taint keys. If the - key is empty, operator must be Exists; this combination - means to match all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship - to the value. Valid operators are Exists and Equal. - Defaults to Equal. Exists is equivalent to wildcard - for value, so that a pod can tolerate all taints of - a particular category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the - taint forever (do not evict). Zero and negative values - will be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -3896,26 +3899,23 @@ spec: default storage class is used. type: string preCreateSubPaths: - description: 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. + description: |- + 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. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. Defaults to `10Gi`. type: string pvcJobsImage: - description: 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. + description: |- + 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. type: string pvcStrategy: - description: 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`. + description: |- + 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`. type: string workspacePVCStorageClassName: description: Storage class for the Persistent Volume Claims @@ -3948,15 +3948,14 @@ spec: description: The status of the Devworkspace subsystem properties: gatewayHost: - description: GatewayHost is the resolved host of the ingress/route. - This is equal to the Host in the spec on Kubernetes but contains - the actual host name of the route if Host is unspecified on - OpenShift. + description: |- + GatewayHost is the resolved host of the ingress/route. This is equal to the Host in the spec + on Kubernetes but contains the actual host name of the route if Host is unspecified on OpenShift. type: string gatewayPhase: - description: GatewayPhase specifies the phase in which the gateway - deployment currently is. If the gateway is disabled, the phase - is "Inactive". + description: |- + GatewayPhase specifies the phase in which the gateway deployment currently is. + If the gateway is disabled, the phase is "Inactive". type: string message: description: Message contains further human-readable info for @@ -3971,10 +3970,10 @@ spec: why the Che cluster is in this state. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either - the copy of the explicitly defined property of the same name - in the spec or, if it is undefined in the spec and we're running - on OpenShift, the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object gitHubOAuthProvisioned: @@ -4027,23 +4026,26 @@ spec: - name: v2 schema: openAPIV3Schema: - description: 'The `CheCluster` custom resource allows defining and managing - Eclipse Che server installation. Based on these settings, the Operator - automatically creates and maintains several ConfigMaps: `che`, `plugin-registry`, - `devfile-registry` that will contain the appropriate environment variables - of the various components of the installation. These generated ConfigMaps - must NOT be updated manually.' + description: |- + The `CheCluster` custom resource allows defining and managing Eclipse Che server installation. + Based on these settings, the Operator automatically creates and maintains several ConfigMaps: + `che`, `plugin-registry`, `devfile-registry` that will contain the appropriate environment variables + of the various components of the installation. These generated ConfigMaps must NOT be updated manually. properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource - this object represents. Servers may infer this from the endpoint the - client submits requests to. Cannot be updated. In CamelCase. More - info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object @@ -4067,14 +4069,15 @@ spec: server. properties: clusterRoles: - description: 'Additional ClusterRoles assigned to Che ServiceAccount. - Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. The defaults roles are: - `-cheworkspaces-clusterrole` + description: |- + Additional ClusterRoles assigned to Che ServiceAccount. + Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` label. + The defaults roles are: + - `-cheworkspaces-clusterrole` - `-cheworkspaces-namespaces-clusterrole` - `-cheworkspaces-devworkspace-clusterrole` - where the is the namespace where the CheCluster - CR is created. The Che Operator must already have all - permissions in these ClusterRoles to grant them.' + where the is the namespace where the CheCluster CR is created. + The Che Operator must already have all permissions in these ClusterRoles to grant them. items: type: string type: array @@ -4102,19 +4105,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to a - single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -4128,10 +4128,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -4140,12 +4140,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4159,13 +4158,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4188,6 +4185,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4198,10 +4196,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -4210,6 +4208,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4244,23 +4243,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 - cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, then - no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending on - the component. If value is `0`, then - no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4272,23 +4268,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 - cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, then - no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending on - the component. If value is `0`, then - no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4314,13 +4307,11 @@ spec: extraProperties: additionalProperties: type: string - description: A map of additional environment variables 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). - If the `extraProperties` field contains a property normally - generated in `che` ConfigMap from other CR fields, the - value defined in the `extraProperties` is used instead. + description: |- + A map of additional environment variables 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). + If the `extraProperties` field contains a property normally generated in `che` ConfigMap from other CR fields, + the value defined in the `extraProperties` is used instead. type: object logLevel: default: INFO @@ -4328,27 +4319,25 @@ spec: `DEBUG`.' type: string proxy: - description: Proxy server settings for Kubernetes cluster. - No additional configuration is required for OpenShift - cluster. By specifying these settings for the OpenShift - cluster, you override the OpenShift proxy configuration. + description: |- + Proxy server settings for Kubernetes cluster. No additional configuration is required for OpenShift cluster. + By specifying these settings for the OpenShift cluster, you override the OpenShift proxy configuration. properties: credentialsSecretName: - description: The secret name that contains `user` and - `password` for a proxy server. The secret must have - a `app.kubernetes.io/part-of=che.eclipse.org` label. + description: |- + The secret name that contains `user` and `password` for a proxy server. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string nonProxyHosts: - description: 'A list of hosts that can be reached directly, - bypassing the proxy. Specify wild card domain use - the following form `.`, for example: - - localhost - my.host.com - 123.42.12.32 Use only - when a proxy configuration is required. The Operator - respects OpenShift cluster-wide proxy configuration, - defining `nonProxyHosts` in a custom resource leads - to merging non-proxy hosts lists from the cluster - proxy configuration, and the ones defined in the custom - resources. See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + A list of hosts that can be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.`, for example: + - localhost + - my.host.com + - 123.42.12.32 + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `nonProxyHosts` in a custom resource leads to merging non-proxy hosts lists from the cluster proxy configuration, and the ones defined in the custom resources. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. items: type: string type: array @@ -4356,12 +4345,11 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. - Use only when a proxy configuration is required. The - Operator respects OpenShift cluster-wide proxy configuration, - defining `url` in a custom resource leads to overriding - the cluster proxy configuration. See the following - page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + URL (protocol+hostname) of the proxy server. + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `url` in a custom resource leads to overriding the cluster proxy configuration. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. type: string type: object type: object @@ -4404,19 +4392,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to a - single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -4430,10 +4415,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -4442,12 +4427,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4461,13 +4445,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4490,6 +4472,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4500,10 +4483,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -4512,6 +4495,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4546,23 +4530,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 - cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, then - no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending on - the component. If value is `0`, then - no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4574,23 +4555,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 - cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, then - no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending on - the component. If value is `0`, then - no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4640,7 +4618,8 @@ spec: description: DevWorkspace Operator configuration. properties: runningLimit: - description: Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` + description: |- + Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` The maximum number of running workspaces per user. type: string type: object @@ -4668,19 +4647,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to a - single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -4694,10 +4670,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -4706,12 +4682,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4725,13 +4700,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4754,6 +4727,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4764,10 +4738,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -4776,6 +4750,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4810,23 +4785,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 - cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, then - no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending on - the component. If value is `0`, then - no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4838,23 +4810,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 - cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, then - no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending on - the component. If value is `0`, then - no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4897,17 +4866,14 @@ spec: description: Kubernetes Image Puller configuration. properties: enable: - description: Install and configure the community supported - Kubernetes Image Puller Operator. When you set the value - to `true` without providing any specs, it creates a default - Kubernetes Image Puller object managed by the Operator. - When you set the value to `false`, the Kubernetes Image - Puller object is deleted, and the Operator uninstalled, - regardless of whether a spec is provided. If you leave - the `spec.images` field empty, a set of recommended workspace-related - images is automatically detected and pre-pulled after - installation. Note that while this Operator and its behavior - is community-supported, its payload may be commercially-supported + description: |- + Install and configure the community supported Kubernetes Image Puller Operator. When you set the value to `true` without providing any specs, + it creates a default Kubernetes Image Puller object managed by the Operator. + When you set the value to `false`, the Kubernetes Image Puller object is deleted, and the Operator uninstalled, + regardless of whether a spec is provided. + If you leave the `spec.images` field empty, a set of recommended workspace-related images is automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported for pulling commercially-supported images. type: boolean spec: @@ -4976,19 +4942,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to a - single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -5002,10 +4965,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -5014,12 +4977,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -5033,13 +4995,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -5062,6 +5022,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -5072,10 +5033,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -5084,6 +5045,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -5118,23 +5080,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 - cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, then - no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending on - the component. If value is `0`, then - no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5146,23 +5105,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 - cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, then - no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending on - the component. If value is `0`, then - no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5209,18 +5165,16 @@ spec: Che images. properties: hostname: - description: An optional hostname or URL of an alternative container - registry to pull images from. This value overrides the container - registry hostname defined in all the default container images - involved in a Che deployment. This is particularly useful - for installing Che in a restricted environment. + description: |- + An optional hostname or URL of an alternative container registry to pull images from. + This value overrides the container registry hostname defined in all the default container images involved in a Che deployment. + This is particularly useful for installing Che in a restricted environment. type: string organization: - description: An optional repository name of an alternative 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 for installing - Eclipse Che in a restricted environment. + description: |- + An optional repository name of an alternative 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 for installing Eclipse Che in a restricted environment. type: string type: object devEnvironments: @@ -5246,9 +5200,9 @@ spec: type: string type: object defaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile, that - does not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile, that does not contain any components. items: properties: attributes: @@ -5287,20 +5241,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command\ - \ running the dockerimage component. The arguments\ - \ are supplied either to the default command provided\ - \ in the image or to the overridden command. \n\ - \ Defaults to an empty array, meaning use whatever\ - \ is defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage\ - \ component instead of the default one provided\ - \ in the image. \n Defaults to an empty array, meaning\ - \ use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5309,10 +5263,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in\ - \ its own separated pod, instead of running as part\ - \ of the main development environment pod. \n Default\ - \ value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5324,29 +5280,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes. \n Examples\ - \ of Che-specific attributes: \n - cookiesAuthEnabled:\ - \ \"true\" / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should\ - \ be exposed on the network. \n - `public`\ - \ means that the endpoint will be exposed\ - \ on the public network, typically through\ - \ a K8S ingress or an OpenShift route. \n\ - \ - `internal` means that the endpoint will\ - \ be exposed internally outside of the main\ - \ devworkspace POD, typically by K8S services,\ - \ to be consumed by other elements running\ - \ on the same cloud internal network. \n -\ - \ `none` means that the endpoint will not\ - \ be exposed and will only be accessible inside\ - \ the main devworkspace POD, on a local address.\ - \ \n Default value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5361,26 +5327,31 @@ spec: type: string protocol: default: http - description: "Describes the application and\ - \ transport protocols of the traffic that\ - \ will go through this endpoint. \n - `http`:\ - \ Endpoint will have `http` traffic, typically\ - \ on a TCP connection. It will be automaticaly\ - \ promoted to `https` when the `secure` field\ - \ is set to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically on\ - \ a TCP connection. \n - `ws`: Endpoint will\ - \ have `ws` traffic, typically on a TCP connection.\ - \ It will be automaticaly promoted to `wss`\ - \ when the `secure` field is set to `true`.\ - \ \n - `wss`: Endpoint will have `wss` traffic,\ - \ typically on a TCP connection. \n - `tcp`:\ - \ Endpoint will have traffic on a TCP connection,\ - \ without specifying an application protocol.\ - \ \n - `udp`: Endpoint will have traffic on\ - \ an UDP connection, without specifying an\ - \ application protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5390,14 +5361,13 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot + description: |- + Port number to be used within the container component. The same port cannot be used by two different container components. type: integer required: @@ -5406,10 +5376,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container.\ - \ \n The following variables are reserved and cannot\ - \ be overridden via env: \n - `$PROJECTS_ROOT`\ - \ \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -5428,17 +5405,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source\ - \ code should be mounted in the component. \n Defaults\ - \ to true for all component types except plugins\ - \ and components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in - the container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the - default value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be @@ -5448,19 +5427,17 @@ spec: component container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then - they will reuse the same volume and will be - able to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not - path is mentioned, default path is the is - `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -5470,19 +5447,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through - some dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process - this command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -5495,8 +5473,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built\ - \ during startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -5516,19 +5497,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that - contains a Dockerfile. The src in the OCI - registry required for the Dockerfile build - will be downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull - the Dockerfile from when using the Devfile - Registry as Dockerfile src. To ensure the - Dockerfile gets resolved consistently in - different environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -5547,34 +5524,32 @@ spec: more than one remote configured type: string revision: - description: The revision to checkout - from. Should be branch name, tag or - commit id. Default branch is used if - missing or specified revision is not - found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in - the Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should - be initialized in the git project. Projects - must have at least one remote configured - while StarterProjects & Image Component's - Git source can only have at most one remote - configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder\ - \ pod is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -5584,9 +5559,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It - can be a full URL or a relative URI from the - current devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -5602,14 +5577,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed\ - \ during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5621,29 +5599,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes. \n Examples\ - \ of Che-specific attributes: \n - cookiesAuthEnabled:\ - \ \"true\" / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should\ - \ be exposed on the network. \n - `public`\ - \ means that the endpoint will be exposed\ - \ on the public network, typically through\ - \ a K8S ingress or an OpenShift route. \n\ - \ - `internal` means that the endpoint will\ - \ be exposed internally outside of the main\ - \ devworkspace POD, typically by K8S services,\ - \ to be consumed by other elements running\ - \ on the same cloud internal network. \n -\ - \ `none` means that the endpoint will not\ - \ be exposed and will only be accessible inside\ - \ the main devworkspace POD, on a local address.\ - \ \n Default value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5658,26 +5646,31 @@ spec: type: string protocol: default: http - description: "Describes the application and\ - \ transport protocols of the traffic that\ - \ will go through this endpoint. \n - `http`:\ - \ Endpoint will have `http` traffic, typically\ - \ on a TCP connection. It will be automaticaly\ - \ promoted to `https` when the `secure` field\ - \ is set to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically on\ - \ a TCP connection. \n - `ws`: Endpoint will\ - \ have `ws` traffic, typically on a TCP connection.\ - \ It will be automaticaly promoted to `wss`\ - \ when the `secure` field is set to `true`.\ - \ \n - `wss`: Endpoint will have `wss` traffic,\ - \ typically on a TCP connection. \n - `tcp`:\ - \ Endpoint will have traffic on a TCP connection,\ - \ without specifying an application protocol.\ - \ \n - `udp`: Endpoint will have traffic on\ - \ an UDP connection, without specifying an\ - \ application protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5687,14 +5680,13 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot + description: |- + Port number to be used within the container component. The same port cannot be used by two different container components. type: integer required: @@ -5716,22 +5708,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or - from an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For - example this allows reusing the OpenShift definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed\ - \ during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5743,29 +5738,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes. \n Examples\ - \ of Che-specific attributes: \n - cookiesAuthEnabled:\ - \ \"true\" / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should\ - \ be exposed on the network. \n - `public`\ - \ means that the endpoint will be exposed\ - \ on the public network, typically through\ - \ a K8S ingress or an OpenShift route. \n\ - \ - `internal` means that the endpoint will\ - \ be exposed internally outside of the main\ - \ devworkspace POD, typically by K8S services,\ - \ to be consumed by other elements running\ - \ on the same cloud internal network. \n -\ - \ `none` means that the endpoint will not\ - \ be exposed and will only be accessible inside\ - \ the main devworkspace POD, on a local address.\ - \ \n Default value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5780,26 +5785,31 @@ spec: type: string protocol: default: http - description: "Describes the application and\ - \ transport protocols of the traffic that\ - \ will go through this endpoint. \n - `http`:\ - \ Endpoint will have `http` traffic, typically\ - \ on a TCP connection. It will be automaticaly\ - \ promoted to `https` when the `secure` field\ - \ is set to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically on\ - \ a TCP connection. \n - `ws`: Endpoint will\ - \ have `ws` traffic, typically on a TCP connection.\ - \ It will be automaticaly promoted to `wss`\ - \ when the `secure` field is set to `true`.\ - \ \n - `wss`: Endpoint will have `wss` traffic,\ - \ typically on a TCP connection. \n - `tcp`:\ - \ Endpoint will have traffic on a TCP connection,\ - \ without specifying an application protocol.\ - \ \n - `udp`: Endpoint will have traffic on\ - \ an UDP connection, without specifying an\ - \ application protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5809,14 +5819,13 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot + description: |- + Port number to be used within the container component. The same port cannot be used by two different container components. type: integer required: @@ -5838,34 +5847,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are\ - \ mainly imported devfiles that contribute components,\ - \ commands and events as a consistent single unit. They\ - \ are defined in either YAML files following the devfile\ - \ syntax, or as `DevWorkspaceTemplate` Kubernetes Custom\ - \ Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in - a parent devfile or a plugin. Overriding is done - according to K8S strategic merge patch standard - rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying\ - \ a given component definition, typically\ - \ bound to a devworkspace event. \n For example,\ - \ when an `apply` command is bound to a `preStart`\ - \ event, and references a `container` component,\ - \ it will start the container as a K8S initContainer\ - \ in the devworkspace POD, unless the component\ - \ has its `dedicatedPod` field set to `true`.\ - \ \n When no `apply` command exist for a given\ - \ component, it is assumed the component will\ - \ be applied at devworkspace start by default,\ - \ unless `deployByDefault` for that component\ - \ is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -5891,9 +5902,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in - Editor UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -5909,9 +5920,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise @@ -5939,9 +5950,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in - Editor UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -5953,25 +5964,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string\ - \ \n Special variables that can be used:\ - \ \n - `$PROJECTS_ROOT`: A path where\ - \ projects sources are mounted as defined\ - \ by container component's sourceMapping.\ - \ \n - `$PROJECT_SOURCE`: A path to a\ - \ project source ($PROJECTS_ROOT/).\ - \ If there are multiple projects, this\ - \ will point to the directory of the first\ - \ one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -6002,42 +6014,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command\ - \ is restarted or not when the source\ - \ code changes. If set to `true` the command\ - \ won't be restarted. A *hotReloadCapable*\ - \ `run` or `debug` command is expected\ - \ to handle file changes on its own and\ - \ won't be restarted. A *hotReloadCapable*\ - \ `build` command is expected to be executed\ - \ only once and won't be executed again.\ - \ This field is taken into account only\ - \ for commands `build`, `run` and `debug`\ - \ with `isDefault` set to `true`. \n Default\ - \ value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in - Editor UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the\ - \ command should be executed \n Special\ - \ variables that can be used: \n - `$PROJECTS_ROOT`:\ - \ A path where projects sources are mounted\ - \ as defined by container component's\ - \ sourceMapping. \n - `$PROJECT_SOURCE`:\ - \ A path to a project source ($PROJECTS_ROOT/).\ - \ If there are multiple projects, this\ - \ will point to the directory of the first\ - \ one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -6046,10 +6056,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated - in a parent devfile or a plugin. Overriding is done - according to K8S strategic merge patch standard - rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -6088,22 +6097,20 @@ spec: type: object type: object args: - description: "The arguments to supply to\ - \ the command running the dockerimage\ - \ component. The arguments are supplied\ - \ either to the default command provided\ - \ in the image or to the overridden command.\ - \ \n Defaults to an empty array, meaning\ - \ use whatever is defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the\ - \ dockerimage component instead of the\ - \ default one provided in the image. \n\ - \ Defaults to an empty array, meaning\ - \ use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -6112,11 +6119,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should\ - \ run in its own separated pod, instead\ - \ of running as part of the main development\ - \ environment pod. \n Default value is\ - \ `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -6129,33 +6137,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes.\ - \ \n Examples of Che-specific attributes:\ - \ \n - cookiesAuthEnabled: \"true\"\ - \ / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint\ - \ should be exposed on the network.\ - \ \n - `public` means that the endpoint\ - \ will be exposed on the public\ - \ network, typically through a K8S\ - \ ingress or an OpenShift route.\ - \ \n - `internal` means that the\ - \ endpoint will be exposed internally\ - \ outside of the main devworkspace\ - \ POD, typically by K8S services,\ - \ to be consumed by other elements\ - \ running on the same cloud internal\ - \ network. \n - `none` means that\ - \ the endpoint will not be exposed\ - \ and will only be accessible inside\ - \ the main devworkspace POD, on\ - \ a local address. \n Default value\ - \ is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6170,32 +6183,31 @@ spec: URL type: string protocol: - description: "Describes the application\ - \ and transport protocols of the\ - \ traffic that will go through this\ - \ endpoint. \n - `http`: Endpoint\ - \ will have `http` traffic, typically\ - \ on a TCP connection. It will be\ - \ automaticaly promoted to `https`\ - \ when the `secure` field is set\ - \ to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically\ - \ on a TCP connection. \n - `ws`:\ - \ Endpoint will have `ws` traffic,\ - \ typically on a TCP connection.\ - \ It will be automaticaly promoted\ - \ to `wss` when the `secure` field\ - \ is set to `true`. \n - `wss`:\ - \ Endpoint will have `wss` traffic,\ - \ typically on a TCP connection.\ - \ \n - `tcp`: Endpoint will have\ - \ traffic on a TCP connection, without\ - \ specifying an application protocol.\ - \ \n - `udp`: Endpoint will have\ - \ traffic on an UDP connection,\ - \ without specifying an application\ - \ protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6205,28 +6217,31 @@ spec: - udp type: string secure: - description: Describes whether the - endpoint should be secured and protected - by some authentication process. - This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. - The same port cannot be used by - two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used\ - \ in this container. \n The following\ - \ variables are reserved and cannot be\ - \ overridden via env: \n - `$PROJECTS_ROOT`\ - \ \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -6244,19 +6259,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the\ - \ project source code should be mounted\ - \ in the component. \n Defaults to true\ - \ for all component types except plugins\ - \ and components that set `dedicatedPod`\ - \ to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that @@ -6266,21 +6280,17 @@ spec: to a component container properties: name: - description: The volume mount name - is the name of an existing `Volume` - component. If several containers - mount the same volume name then - they will reuse the same volume - and will be able to access to the - same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -6292,9 +6302,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should\ - \ be built during startup. \n Default\ - \ value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -6316,23 +6328,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will - be downloaded for building the - image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as - Dockerfile src. To ensure the - Dockerfile gets resolved consistently - in different environments, it - is recommended to always specify - the `devfileRegistryUrl` when - `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -6351,36 +6355,30 @@ spec: remote configured type: string revision: - description: The revision to - checkout from. Should be branch - name, tag or commit id. Default - branch is used if missing - or specified revision is not - found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at - least one remote configured while - StarterProjects & Image Component's - Git source can only have at most - one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged\ - \ builder pod is required. \n Default\ - \ value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -6390,10 +6388,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative - URI from the current devfile as the - base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -6408,16 +6405,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing - the Kubernetes definitions used to deploy - some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should\ - \ be deployed during startup. \n Default\ - \ value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6430,33 +6428,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes.\ - \ \n Examples of Che-specific attributes:\ - \ \n - cookiesAuthEnabled: \"true\"\ - \ / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint\ - \ should be exposed on the network.\ - \ \n - `public` means that the endpoint\ - \ will be exposed on the public\ - \ network, typically through a K8S\ - \ ingress or an OpenShift route.\ - \ \n - `internal` means that the\ - \ endpoint will be exposed internally\ - \ outside of the main devworkspace\ - \ POD, typically by K8S services,\ - \ to be consumed by other elements\ - \ running on the same cloud internal\ - \ network. \n - `none` means that\ - \ the endpoint will not be exposed\ - \ and will only be accessible inside\ - \ the main devworkspace POD, on\ - \ a local address. \n Default value\ - \ is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6471,32 +6474,31 @@ spec: URL type: string protocol: - description: "Describes the application\ - \ and transport protocols of the\ - \ traffic that will go through this\ - \ endpoint. \n - `http`: Endpoint\ - \ will have `http` traffic, typically\ - \ on a TCP connection. It will be\ - \ automaticaly promoted to `https`\ - \ when the `secure` field is set\ - \ to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically\ - \ on a TCP connection. \n - `ws`:\ - \ Endpoint will have `ws` traffic,\ - \ typically on a TCP connection.\ - \ It will be automaticaly promoted\ - \ to `wss` when the `secure` field\ - \ is set to `true`. \n - `wss`:\ - \ Endpoint will have `wss` traffic,\ - \ typically on a TCP connection.\ - \ \n - `tcp`: Endpoint will have\ - \ traffic on a TCP connection, without\ - \ specifying an application protocol.\ - \ \n - `udp`: Endpoint will have\ - \ traffic on an UDP connection,\ - \ without specifying an application\ - \ protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6506,17 +6508,14 @@ spec: - udp type: string secure: - description: Describes whether the - endpoint should be secured and protected - by some authentication process. - This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. - The same port cannot be used by - two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6537,25 +6536,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as - commands) or from an external devfile that - may reference this component through a parent - or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given - manifest. For example this allows reusing - the OpenShift definitions used to deploy some - runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should\ - \ be deployed during startup. \n Default\ - \ value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6568,33 +6567,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant\ - \ string-based free-form attributes.\ - \ \n Examples of Che-specific attributes:\ - \ \n - cookiesAuthEnabled: \"true\"\ - \ / \"false\", \n - type: \"terminal\"\ - \ / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint\ - \ should be exposed on the network.\ - \ \n - `public` means that the endpoint\ - \ will be exposed on the public\ - \ network, typically through a K8S\ - \ ingress or an OpenShift route.\ - \ \n - `internal` means that the\ - \ endpoint will be exposed internally\ - \ outside of the main devworkspace\ - \ POD, typically by K8S services,\ - \ to be consumed by other elements\ - \ running on the same cloud internal\ - \ network. \n - `none` means that\ - \ the endpoint will not be exposed\ - \ and will only be accessible inside\ - \ the main devworkspace POD, on\ - \ a local address. \n Default value\ - \ is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6609,32 +6613,31 @@ spec: URL type: string protocol: - description: "Describes the application\ - \ and transport protocols of the\ - \ traffic that will go through this\ - \ endpoint. \n - `http`: Endpoint\ - \ will have `http` traffic, typically\ - \ on a TCP connection. It will be\ - \ automaticaly promoted to `https`\ - \ when the `secure` field is set\ - \ to `true`. \n - `https`: Endpoint\ - \ will have `https` traffic, typically\ - \ on a TCP connection. \n - `ws`:\ - \ Endpoint will have `ws` traffic,\ - \ typically on a TCP connection.\ - \ It will be automaticaly promoted\ - \ to `wss` when the `secure` field\ - \ is set to `true`. \n - `wss`:\ - \ Endpoint will have `wss` traffic,\ - \ typically on a TCP connection.\ - \ \n - `tcp`: Endpoint will have\ - \ traffic on a TCP connection, without\ - \ specifying an application protocol.\ - \ \n - `udp`: Endpoint will have\ - \ traffic on an UDP connection,\ - \ without specifying an application\ - \ protocol. \n Default value is\ - \ `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6644,17 +6647,14 @@ spec: - udp type: string secure: - description: Describes whether the - endpoint should be secured and protected - by some authentication process. - This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. - The same port cannot be used by - two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6675,12 +6675,13 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults to false type: boolean size: @@ -6715,35 +6716,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in - different environments, it is recommended to always - specify the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull - the parent devfile from, when using id in the parent - reference. To specify `version`, `id` must be defined - and used as the import reference source. `version` - can be either a specific stack version, or `latest`. - If no `version` specified, default version will - be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6754,9 +6754,10 @@ spec: type: object type: array defaultEditor: - description: The default editor to workspace create with. It - could be a plugin ID or a URI. The plugin ID must have `publisher/name/version` - format. The URI must start from `http://` or `https://`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/name/version` format. + The URI must start from `http://` or `https://`. type: string defaultNamespace: default: @@ -6766,16 +6767,15 @@ spec: properties: autoProvision: default: true - description: Indicates if is allowed to automatically create - a user namespace. If it set to false, then user namespace - must be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean template: default: -che - description: If you don't create the user namespaces in - advance, this field defines the Kubernetes namespace created - when you start your first workspace. You can use `` - and `` placeholders, such as che-workspace-. + description: |- + If you don't create the user namespaces in advance, this field defines the Kubernetes namespace created when you start your first workspace. + You can use `` and `` placeholders, such as che-workspace-. pattern: | type: string type: object @@ -6784,9 +6784,9 @@ spec: items: properties: editor: - description: The editor ID to specify default plug-ins - for. The plugin ID must have `publisher/name/version` - format. + description: |- + The editor ID to specify default plug-ins for. + The plugin ID must have `publisher/name/version` format. type: string plugins: description: Default plug-in URIs for the specified editor. @@ -6796,25 +6796,30 @@ spec: type: object type: array deploymentStrategy: - description: DeploymentStrategy defines the deployment strategy - to use to replace existing workspace pods with new ones. The - available deployment stragies are `Recreate` and `RollingUpdate`. - With the `Recreate` deployment strategy, the existing workspace - pod is killed before the new one is created. With the `RollingUpdate` - deployment strategy, a new workspace pod is created and the - existing workspace pod is deleted only when the new workspace - pod is in a ready state. If not specified, the default `Recreate` - deployment strategy is used. + description: |- + DeploymentStrategy defines the deployment strategy to use to replace existing workspace pods + with new ones. The available deployment stragies are `Recreate` and `RollingUpdate`. + With the `Recreate` deployment strategy, the existing workspace pod is killed before the new one is created. + With the `RollingUpdate` deployment strategy, a new workspace pod is created and the existing workspace pod is deleted + only when the new workspace pod is in a ready state. + If not specified, the default `Recreate` deployment strategy is used. enum: - Recreate - RollingUpdate type: string disableContainerBuildCapabilities: - description: "Disables the container build capabilities. When\ - \ set to `false` (the default value), the devEnvironments.security.containerSecurityContext\ - \ field is ignored, and the following container SecurityContext\ - \ is applied: \n containerSecurityContext: allowPrivilegeEscalation:\ - \ true capabilities: add: - SETGID - SETUID" + description: |- + Disables the container build capabilities. + When set to `false` (the default value), the devEnvironments.security.containerSecurityContext + field is ignored, and the following container SecurityContext is applied: + + + containerSecurityContext: + allowPrivilegeEscalation: true + capabilities: + add: + - SETGID + - SETUID type: boolean gatewayContainer: description: GatewayContainer configuration. @@ -6831,17 +6836,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are - expanded using the previously defined environment - variables in the container and any service environment - variables. If a variable cannot be resolved, the - reference in the input string will be unchanged. - Double $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". Escaped - references will never be expanded, regardless of - whether the variable exists or not. Defaults to - "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -6854,10 +6858,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -6866,12 +6870,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6884,12 +6887,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for @@ -6909,6 +6911,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6918,10 +6921,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or @@ -6930,6 +6933,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -6962,21 +6966,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If - the value is not specified, then the default value - is set depending on the component. If value is - `0`, then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = - 500 * 1024 * 1024 * 1024) If the value is not - specified, then the default value is set depending - on the component. If value is `0`, then no value - is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -6988,21 +6991,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If - the value is not specified, then the default value - is set depending on the component. If value is - `0`, then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = - 500 * 1024 * 1024 * 1024) If the value is not - specified, then the default value is set depending - on the component. If value is `0`, then no value - is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -7017,17 +7019,17 @@ spec: - Never type: string maxNumberOfRunningWorkspacesPerUser: - description: The maximum number of running workspaces per user. - The value, -1, allows users to run an unlimited number of - workspaces. + description: |- + The maximum number of running workspaces per user. + The value, -1, allows users to run an unlimited number of workspaces. format: int64 minimum: -1 type: integer maxNumberOfWorkspacesPerUser: default: -1 - description: Total number of workspaces, both stopped and running, - that a user can keep. The value, -1, allows users to keep - an unlimited number of workspaces. + description: |- + Total number of workspaces, both stopped and running, that a user can keep. + The value, -1, allows users to keep an unlimited number of workspaces. format: int64 minimum: -1 type: integer @@ -7038,19 +7040,22 @@ spec: the workspace pods. type: object persistUserHome: - description: PersistUserHome defines configuration options for - persisting the user home directory in workspaces. + description: |- + PersistUserHome defines configuration options for persisting the + user home directory in workspaces. properties: enabled: - description: Determines whether the user home directory - in workspaces should persist between workspace shutdown - and startup. Must be used with the 'per-user' or 'per-workspace' - PVC strategy in order to take effect. Disabled by default. + description: |- + Determines whether the user home directory in workspaces should persist between + workspace shutdown and startup. + Must be used with the 'per-user' or 'per-workspace' PVC strategy in order to take effect. + Disabled by default. type: boolean type: object podSchedulerName: - description: Pod scheduler for the workspace pods. If not specified, - the pod scheduler is set to the default scheduler on the cluster. + description: |- + Pod scheduler for the workspace pods. + If not specified, the pod scheduler is set to the default scheduler on the cluster. type: string projectCloneContainer: description: Project clone container configuration. @@ -7067,17 +7072,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are - expanded using the previously defined environment - variables in the container and any service environment - variables. If a variable cannot be resolved, the - reference in the input string will be unchanged. - Double $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". Escaped - references will never be expanded, regardless of - whether the variable exists or not. Defaults to - "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -7090,10 +7094,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -7102,12 +7106,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -7120,12 +7123,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for @@ -7145,6 +7147,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -7154,10 +7157,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or @@ -7166,6 +7169,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7198,21 +7202,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If - the value is not specified, then the default value - is set depending on the component. If value is - `0`, then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = - 500 * 1024 * 1024 * 1024) If the value is not - specified, then the default value is set depending - on the component. If value is `0`, then no value - is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -7224,21 +7227,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If - the value is not specified, then the default value - is set depending on the component. If value is - `0`, then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = - 500 * 1024 * 1024 * 1024) If the value is not - specified, then the default value is set depending - on the component. If value is `0`, then no value - is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -7246,43 +7248,44 @@ spec: type: object secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer security: description: Workspace security configuration. properties: containerSecurityContext: - description: Container SecurityContext used by all workspace-related - containers. If set, defined values are merged into the - default Container SecurityContext configuration. Requires - devEnvironments.disableContainerBuildCapabilities to be - set to `true` in order to take effect. + description: |- + Container SecurityContext used by all workspace-related containers. + If set, defined values are merged into the default Container SecurityContext configuration. + Requires devEnvironments.disableContainerBuildCapabilities to be set to `true` in order to take effect. properties: allowPrivilegeEscalation: - description: 'AllowPrivilegeEscalation controls whether - a process can gain more privileges than its parent - process. This bool directly controls if the no_new_privs - flag will be set on the container process. AllowPrivilegeEscalation - is true always when the container is: 1) run as Privileged - 2) has CAP_SYS_ADMIN Note that this field cannot be - set when spec.os.name is windows.' + description: |- + AllowPrivilegeEscalation controls whether a process can gain more + privileges than its parent process. This bool directly controls if + the no_new_privs flag will be set on the container process. + AllowPrivilegeEscalation is true always when the container is: + 1) run as Privileged + 2) has CAP_SYS_ADMIN + Note that this field cannot be set when spec.os.name is windows. type: boolean capabilities: - description: The capabilities to add/drop when running - containers. Defaults to the default set of capabilities - granted by the container runtime. Note that this field - cannot be set when spec.os.name is windows. + description: |- + The capabilities to add/drop when running containers. + Defaults to the default set of capabilities granted by the container runtime. + Note that this field cannot be set when spec.os.name is windows. properties: add: description: Added capabilities @@ -7300,62 +7303,60 @@ spec: type: array type: object privileged: - description: Run container in privileged mode. Processes - in privileged containers are essentially equivalent - to root on the host. Defaults to false. Note that - this field cannot be set when spec.os.name is windows. + description: |- + Run container in privileged mode. + Processes in privileged containers are essentially equivalent to root on the host. + Defaults to false. + Note that this field cannot be set when spec.os.name is windows. type: boolean procMount: - description: procMount denotes the type of proc mount - to use for the containers. The default is DefaultProcMount - which uses the container runtime defaults for readonly - paths and masked paths. This requires the ProcMountType - feature flag to be enabled. Note that this field cannot - be set when spec.os.name is windows. + description: |- + procMount denotes the type of proc mount to use for the containers. + The default is DefaultProcMount which uses the container runtime defaults for + readonly paths and masked paths. + This requires the ProcMountType feature flag to be enabled. + Note that this field cannot be set when spec.os.name is windows. type: string readOnlyRootFilesystem: - description: Whether this container has a read-only - root filesystem. Default is false. Note that this - field cannot be set when spec.os.name is windows. + description: |- + Whether this container has a read-only root filesystem. + Default is false. + Note that this field cannot be set when spec.os.name is windows. type: boolean runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if - it does. If unset or false, no such validation will - be performed. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to the - container. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in PodSecurityContext. If set in both - SecurityContext and PodSecurityContext, the value - specified in SecurityContext takes precedence. Note - that this field cannot be set when spec.os.name is - windows. + description: |- + The SELinux context to be applied to the container. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7375,137 +7376,135 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by this container. - If seccomp options are provided at both the pod & - container level, the container options override the - pod options. Note that this field cannot be set when - spec.os.name is windows. + description: |- + The seccomp options to use by this container. If seccomp options are + provided at both the pod & container level, the container options + override the pod options. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. - The profile must be preconfigured on the node - to work. Must be a descending path, relative to - the kubelet's configured seccomp profile location. + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp\ - \ profile will be applied. Valid options are:\ - \ \n Localhost - a profile defined in a file on\ - \ the node should be used. RuntimeDefault - the\ - \ container runtime default profile should be\ - \ used. Unconfined - no profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options from the - PodSecurityContext will be used. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options from the PodSecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored - by components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the - Pod. All of a Pod's containers must have the same - effective HostProcess value (it is not allowed - to have a mix of HostProcess containers and non-HostProcess - containers). In addition, if HostProcess is true + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the - entrypoint of the container process. Defaults - to the user specified in image metadata if unspecified. - May also be set in PodSecurityContext. If set - in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object podSecurityContext: - description: PodSecurityContext used by all workspace-related - pods. If set, defined values are merged into the default - PodSecurityContext configuration. + description: |- + PodSecurityContext used by all workspace-related pods. + If set, defined values are merged into the default PodSecurityContext configuration. properties: fsGroup: - description: "A special supplemental group that applies\ - \ to all containers in a pod. Some volume types allow\ - \ the Kubelet to change the ownership of that volume\ - \ to be owned by the pod: \n 1. The owning GID will\ - \ be the FSGroup 2. The setgid bit is set (new files\ - \ created in the volume will be owned by FSGroup)\ - \ 3. The permission will not modify the ownership\ - \ and permissions of any volume. Note that this field\ - \ cannot be set when spec.os.name is windows." + description: |- + A special supplemental group that applies to all containers in a pod. + Some volume types allow the Kubelet to change the ownership of that volume + to be owned by the pod: + + + 1. The owning GID will be the FSGroup + 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) + + + If unset, the Kubelet will not modify the ownership and permissions of any volume. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer fsGroupChangePolicy: - description: 'fsGroupChangePolicy defines behavior of - changing ownership and permission of the volume before - being exposed inside Pod. This field will only apply - to volume types which support fsGroup based ownership(and - permissions). It will have no effect on ephemeral - volume types such as: secret, configmaps and emptydir. - Valid values are "OnRootMismatch" and "Always". If - not specified, "Always" is used. Note that this field - cannot be set when spec.os.name is windows.' + description: |- + fsGroupChangePolicy defines behavior of changing ownership and permission of the volume + before being exposed inside Pod. This field will only apply to + volume types which support fsGroup based ownership(and permissions). + It will have no effect on ephemeral volume types such as: secret, configmaps + and emptydir. + Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + Note that this field cannot be set when spec.os.name is windows. type: string runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if - it does. If unset or false, no such validation will - be performed. May also be set in SecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in SecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence - for that container. Note that this field cannot be - set when spec.os.name is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to all - containers. If unspecified, the container runtime - will allocate a random SELinux context for each container. May - also be set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The SELinux context to be applied to all containers. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in SecurityContext. If set in + both SecurityContext and PodSecurityContext, the value specified in SecurityContext + takes precedence for that container. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7525,50 +7524,48 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by the containers - in this pod. Note that this field cannot be set when - spec.os.name is windows. + description: |- + The seccomp options to use by the containers in this pod. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. - The profile must be preconfigured on the node - to work. Must be a descending path, relative to - the kubelet's configured seccomp profile location. + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp\ - \ profile will be applied. Valid options are:\ - \ \n Localhost - a profile defined in a file on\ - \ the node should be used. RuntimeDefault - the\ - \ container runtime default profile should be\ - \ used. Unconfined - no profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object supplementalGroups: - description: A list of groups applied to the first process - run in each container, in addition to the container's - primary GID, the fsGroup (if specified), and group - memberships defined in the container image for the - uid of the container process. If unspecified, no additional - groups are added to any container. Note that group - memberships defined in the container image for the - uid of the container process are still effective, - even if they are not included in this list. Note that - this field cannot be set when spec.os.name is windows. + description: |- + A list of groups applied to the first process run in each container, in addition + to the container's primary GID, the fsGroup (if specified), and group memberships + defined in the container image for the uid of the container process. If unspecified, + no additional groups are added to any container. Note that group memberships + defined in the container image for the uid of the container process are still effective, + even if they are not included in this list. + Note that this field cannot be set when spec.os.name is windows. items: format: int64 type: integer type: array sysctls: - description: Sysctls hold a list of namespaced sysctls - used for the pod. Pods with unsupported sysctls (by - the container runtime) might fail to launch. Note - that this field cannot be set when spec.os.name is - windows. + description: |- + Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported + sysctls (by the container runtime) might fail to launch. + Note that this field cannot be set when spec.os.name is windows. items: description: Sysctl defines a kernel parameter to be set @@ -7585,44 +7582,38 @@ spec: type: object type: array windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options within - a container's SecurityContext will be used. If set - in both SecurityContext and PodSecurityContext, the - value specified in SecurityContext takes precedence. - Note that this field cannot be set when spec.os.name - is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options within a container's SecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored - by components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the - Pod. All of a Pod's containers must have the same - effective HostProcess value (it is not allowed - to have a mix of HostProcess containers and non-HostProcess - containers). In addition, if HostProcess is true + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the - entrypoint of the container process. Defaults - to the user specified in image metadata if unspecified. - May also be set in PodSecurityContext. If set - in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object @@ -7639,38 +7630,39 @@ spec: items: properties: audience: - description: Audience is the intended audience of the - token. A recipient of a token must identify itself with - an identifier specified in the audience of the token, - and otherwise should reject the token. The audience - defaults to the identifier of the apiserver. + description: |- + Audience is the intended audience of the token. A recipient of a token + must identify itself with an identifier specified in the audience of the + token, and otherwise should reject the token. The audience defaults to the + identifier of the apiserver. type: string expirationSeconds: default: 3600 - description: ExpirationSeconds is the requested duration - of validity of the service account token. As the token - approaches expiration, the kubelet volume plugin will - proactively rotate the service account token. The kubelet - will start trying to rotate the token if the token is - older than 80 percent of its time to live or if the - token is older than 24 hours. Defaults to 1 hour and - must be at least 10 minutes. + description: |- + ExpirationSeconds is the requested duration of validity of the service + account token. As the token approaches expiration, the kubelet volume + plugin will proactively rotate the service account token. The kubelet will + start trying to rotate the token if the token is older than 80 percent of + its time to live or if the token is older than 24 hours. Defaults to 1 hour + and must be at least 10 minutes. format: int64 minimum: 600 type: integer mountPath: - description: Path within the workspace container at which - the token should be mounted. Must not contain ':'. + description: |- + Path within the workspace container at which the token should be mounted. Must + not contain ':'. type: string name: - description: Identifiable name of the ServiceAccount token. - If multiple ServiceAccount tokens use the same mount - path, a generic name will be used for the projected - volume instead. + description: |- + Identifiable name of the ServiceAccount token. + If multiple ServiceAccount tokens use the same mount path, a generic name will be used + for the projected volume instead. type: string path: - description: Path is the path relative to the mount point - of the file to project the token into. + description: |- + Path is the path relative to the mount point of the file to project the + token into. type: string required: - mountPath @@ -7680,10 +7672,10 @@ spec: type: array startTimeoutSeconds: default: 300 - description: StartTimeoutSeconds determines the maximum duration - (in seconds) that a workspace can take to start before it - is automatically failed. If not specified, the default value - of 300 seconds (5 minutes) is used. + description: |- + StartTimeoutSeconds determines the maximum duration (in seconds) that a workspace can take to start + before it is automatically failed. + If not specified, the default value of 300 seconds (5 minutes) is used. format: int32 minimum: 1 type: integer @@ -7724,12 +7716,12 @@ spec: type: object pvcStrategy: default: per-user - description: 'Persistent volume claim strategy for the Che - server. The supported strategies are: `per-user` (all - workspaces PVCs in one volume), `per-workspace` (each - workspace is given its own individual PVC) and `ephemeral` - (non-persistent storage where local changes will be lost - when the workspace is stopped.)' + description: |- + Persistent volume claim strategy for the Che server. + The supported strategies are: `per-user` (all workspaces PVCs in one volume), + `per-workspace` (each workspace is given its own individual PVC) + and `ephemeral` (non-persistent storage where local changes will be lost when + the workspace is stopped.) enum: - common - per-user @@ -7741,42 +7733,39 @@ spec: description: The pod tolerations of the workspace pods limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, - allowed values are NoSchedule, PreferNoSchedule and - NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration - applies to. Empty means match all taint keys. If the - key is empty, operator must be Exists; this combination - means to match all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship - to the value. Valid operators are Exists and Equal. - Defaults to Equal. Exists is equivalent to wildcard - for value, so that a pod can tolerate all taints of - a particular category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the - taint forever (do not evict). Zero and negative values - will be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -7784,20 +7773,19 @@ spec: description: Trusted certificate settings. properties: gitTrustedCertsConfigMapName: - description: 'The ConfigMap contains certificates to propagate - to the Che components and to provide a particular configuration - for Git. See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ - The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + The ConfigMap contains certificates to propagate to the Che components and to provide a particular configuration for Git. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ + The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object user: description: User configuration. properties: clusterRoles: - description: Additional ClusterRoles assigned to the user. - The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + Additional ClusterRoles assigned to the user. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. items: type: string type: array @@ -7815,9 +7803,9 @@ spec: repositories hosted on Azure DevOps Service (dev.azure.com). properties: secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Azure DevOps Service Application ID and Client Secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services' + description: |- + Kubernetes secret, that contains Base64-encoded Azure DevOps Service Application ID and Client Secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services type: string required: - secretName @@ -7831,15 +7819,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -7853,19 +7842,21 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: disableSubdomainIsolation: - description: 'Disables subdomain isolation. Deprecated - in favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` - annotation. See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Disables subdomain isolation. + Deprecated in favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: boolean endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -7879,14 +7870,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client - secret. See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -7905,10 +7897,13 @@ spec: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set for an Ingress - (a route for OpenShift platform). The defaults for kubernetes - platforms are: kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", nginx.ingress.kubernetes.io/proxy-connect-timeout: - "3600", nginx.ingress.kubernetes.io/ssl-redirect: "true"' + description: |- + Defines annotations which will be set for an Ingress (a route for OpenShift platform). + The defaults for kubernetes platforms are: + kubernetes.io/ingress.class: "nginx" + nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", + nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600", + nginx.ingress.kubernetes.io/ssl-redirect: "true" type: object auth: default: @@ -7919,15 +7914,12 @@ spec: description: Authentication settings. properties: advancedAuthorization: - description: Advance authorization settings. Determines - which users and groups are allowed to access Che. User - is allowed to access Che if he/she is either in the `allowUsers` - list or is member of group from `allowGroups` list and - not in neither the `denyUsers` list nor is member of group - from `denyGroups` list. If `allowUsers` and `allowGroups` - are empty, then all users are allowed to access Che. if - `denyUsers` and `denyGroups` are empty, then no users - are denied to access Che. + description: |- + Advance authorization settings. Determines which users and groups are allowed to access Che. + User is allowed to access Che if he/she is either in the `allowUsers` list or is member of group from `allowGroups` list + and not in neither the `denyUsers` list nor is member of group from `denyGroups` list. + If `allowUsers` and `allowGroups` are empty, then all users are allowed to access Che. + if `denyUsers` and `denyGroups` are empty, then no users are denied to access Che. properties: allowGroups: description: List of groups allowed to access Che (currently @@ -7968,10 +7960,13 @@ spec: description: Gateway configuration labels. type: object deployment: - description: 'Deployment override options. Since gateway - deployment consists of several containers, they must - be distinguished in the configuration by their names: - - `gateway` - `configbump` - `oauth-proxy` - `kube-rbac-proxy`' + description: |- + Deployment override options. + Since gateway deployment consists of several containers, they must be distinguished in the configuration by their names: + - `gateway` + - `configbump` + - `oauth-proxy` + - `kube-rbac-proxy` properties: containers: description: List of containers belonging to the @@ -7991,20 +7986,16 @@ spec: variable. Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously - defined environment variables in the - container and any service environment - variables. If a variable cannot be - resolved, the reference in the input - string will be unchanged. Double $$ - are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: - i.e. "$$(VAR_NAME)" will produce the - string literal "$(VAR_NAME)". Escaped - references will never be expanded, - regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -8019,10 +8010,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether @@ -8032,13 +8023,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of - the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the @@ -8053,14 +8042,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource - of the container: only resources - limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, - requests.cpu, requests.memory - and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: @@ -8083,6 +8069,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -8093,10 +8080,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether @@ -8106,6 +8093,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -8140,24 +8128,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m - = .5 cores) If the value is not - specified, then the default value - is set depending on the component. - If value is `0`, then no value is - set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -8169,24 +8153,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m - = .5 cores) If the value is not - specified, then the default value - is set depending on the component. - If value is `0`, then no value is - set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -8262,26 +8242,24 @@ spec: description: Public URL of the Identity Provider server. type: string identityToken: - description: 'Identity token to be passed to upstream. There - are two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to - Che installations made for Kubernetes only and ignored - for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. enum: - id_token - access_token type: string oAuthAccessTokenInactivityTimeoutSeconds: - description: Inactivity timeout for tokens to set in the - OpenShift `OAuthClient` resource used to set up identity - federation on the OpenShift side. 0 means tokens for this - client never time out. + description: |- + Inactivity timeout for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means tokens for this client never time out. format: int32 type: integer oAuthAccessTokenMaxAgeSeconds: - description: Access token max age for tokens to set in the - OpenShift `OAuthClient` resource used to set up identity - federation on the OpenShift side. 0 means no expiration. + description: |- + Access token max age for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means no expiration. format: int32 type: integer oAuthClientName: @@ -8289,38 +8267,33 @@ spec: used to set up identity federation on the OpenShift side. type: string oAuthScope: - description: Access Token Scope. This field is specific - to Che installations made for Kubernetes only and ignored - for OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: - description: 'Name of the secret set in the OpenShift `OAuthClient` - resource used to set up identity federation on the OpenShift - side. For Kubernetes, this can either be the plain text - oAuthSecret value, or the name of a kubernetes secret - which contains a key `oAuthSecret` and the value is the - secret. NOTE: this secret must exist in the same namespace - as the `CheCluster` resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`.' + description: |- + Name of the secret set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + For Kubernetes, this can either be the plain text oAuthSecret value, or the name of a kubernetes secret which contains a + key `oAuthSecret` and the value is the secret. NOTE: this secret must exist in the same namespace as the `CheCluster` + resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`. type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the - domain to generate a hostname for the route. The generated - hostname follows this pattern: che-.. - The is the namespace where the CheCluster - CRD is created. In conjunction with labels, it creates a route - served by a non-default Ingress controller. For a Kubernetes - cluster, it contains a global ingress domain. There are no - default values: you must specify them.' + description: |- + For an OpenShift cluster, the Operator uses the domain to generate a hostname for the route. + The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. + In conjunction with labels, it creates a route served by a non-default Ingress controller. + For a Kubernetes cluster, it contains a global ingress domain. There are no default values: you must specify them. type: string hostname: description: The public hostname of the installed Che server. type: string ingressClassName: - description: IngressClassName is the name of an IngressClass - cluster resource. If a class name is defined in both the `IngressClassName` - field and the `kubernetes.io/ingress.class` annotation, `IngressClassName` - field takes precedence. + description: |- + IngressClassName is the name of an IngressClass cluster resource. + If a class name is defined in both the `IngressClassName` field and the `kubernetes.io/ingress.class` annotation, + `IngressClassName` field takes precedence. type: string labels: additionalProperties: @@ -8329,10 +8302,10 @@ spec: (a route for OpenShift platform). type: object tlsSecretName: - description: The name of the secret used to set up Ingress TLS - termination. If the field is an empty string, the default - cluster certificate is used. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The name of the secret used to set up Ingress TLS termination. + If the field is an empty string, the default cluster certificate is used. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object type: object @@ -8366,10 +8339,10 @@ spec: why the Che deployment is in the current phase. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either - the copy of the explicitly defined property of the same name in - the spec or, if it is undefined in the spec and we're running - on OpenShift, the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object type: object @@ -8381,5 +8354,5 @@ status: acceptedNames: kind: "" plural: "" - conditions: [] - storedVersions: [] + conditions: null + storedVersions: null diff --git a/config/crd/bases/org.eclipse.che_checlusters.yaml b/config/crd/bases/org.eclipse.che_checlusters.yaml index ad9728b5c..37a683c80 100644 --- a/config/crd/bases/org.eclipse.che_checlusters.yaml +++ b/config/crd/bases/org.eclipse.che_checlusters.yaml @@ -10,13 +10,11 @@ # Red Hat, Inc. - initial API and implementation # - apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null + controller-gen.kubebuilder.io/version: v0.14.0 name: checlusters.org.eclipse.che spec: group: org.eclipse.che @@ -37,53 +35,57 @@ spec: a Che server installation properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: - description: 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. + description: |- + 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. properties: auth: description: Configuration settings related to the Authentication used by the Che installation. properties: debug: - description: Deprecated. The value of this flag is ignored. Debug - internal identity provider. + description: |- + Deprecated. The value of this flag is ignored. + Debug internal identity provider. type: boolean externalIdentityProvider: - description: 'Deprecated. The value of this flag is ignored. 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`.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: boolean gatewayAuthenticationSidecarImage: - description: Gateway sidecar responsible for authentication when - NativeUserMode is enabled. See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] - or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. + description: |- + Gateway sidecar responsible for authentication when NativeUserMode is enabled. + See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. type: string gatewayAuthorizationSidecarImage: - description: Gateway sidecar responsible for authorization when - NativeUserMode is enabled. See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] - or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] + description: |- + Gateway sidecar responsible for authorization when NativeUserMode is enabled. + See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] type: string gatewayConfigBumpEnv: description: List of environment variables to set in the Configbump @@ -97,15 +99,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -118,9 +121,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -129,12 +133,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -147,11 +150,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -171,6 +174,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -180,9 +184,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -191,6 +196,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -208,15 +214,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -229,9 +236,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -240,12 +248,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -258,11 +265,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -282,6 +289,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -291,9 +299,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -302,6 +311,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -323,15 +333,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -344,9 +355,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -355,12 +367,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -373,11 +384,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -397,6 +408,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -406,9 +418,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -417,6 +430,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -434,15 +448,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -455,9 +470,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -466,12 +482,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -484,11 +499,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -508,6 +523,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -517,9 +533,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -528,27 +545,28 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array identityProviderAdminUserName: - description: Deprecated. The value of this flag is ignored. Overrides - the name of the Identity Provider administrator user. Defaults - to `admin`. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the name of the Identity Provider administrator user. Defaults to `admin`. type: string identityProviderClientId: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string identityProviderContainerResources: - description: Deprecated. The value of this flag is ignored. Identity - provider container custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Identity provider container custom settings. properties: limits: description: Limits describes the maximum amount of compute @@ -576,21 +594,21 @@ spec: type: object type: object identityProviderImage: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderImagePullPolicy: - description: Deprecated. The value of this flag is ignored. Overrides - the image pull policy used in the Identity Provider, Keycloak - or RH-SSO, deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the image pull policy used in the Identity Provider, Keycloak or RH-SSO, deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string identityProviderIngress: - description: Deprecated. The value of this flag is ignored. Ingress - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Ingress custom settings. properties: annotations: additionalProperties: @@ -605,42 +623,39 @@ spec: type: string type: object identityProviderPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. - The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderRealm: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderRoute: - description: Deprecated. The value of this flag is ignored. Route - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Route custom settings. properties: annotations: additionalProperties: @@ -650,10 +665,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -661,49 +676,43 @@ spec: type: string type: object identityProviderSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderURL: - description: 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. + description: |- + 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. type: string identityToken: - description: 'Identity token to be passed to upstream. There are - two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che installations - made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string initialOpenShiftOAuthUser: - description: Deprecated. The value of this flag is ignored. 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 - in 'openshift-config' namespace by Operator. Note that this - solution is Openshift 4 platform-specific. + description: |- + Deprecated. The value of this flag is ignored. + 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 in 'openshift-config' namespace by Operator. + Note that this solution is Openshift 4 platform-specific. type: boolean nativeUserMode: - description: Deprecated. The value of this flag is ignored. Enables - native user mode. Currently works only on OpenShift and DevWorkspace - engine. Native User mode uses OpenShift OAuth directly as identity - provider, without Keycloak. + description: |- + Deprecated. The value of this flag is ignored. + Enables native user mode. Currently works only on OpenShift and DevWorkspace engine. + Native User mode uses OpenShift OAuth directly as identity provider, without Keycloak. type: boolean oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used @@ -711,8 +720,9 @@ spec: when left blank. See also the `OpenShiftoAuth` field. type: string oAuthScope: - description: Access Token Scope. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` @@ -721,19 +731,17 @@ spec: field. type: string openShiftoAuth: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean updateAdminPassword: - description: Deprecated. The value of this flag is ignored. Forces - the default `admin` Che user to update password on first login. - Defaults to `false`. + description: |- + Deprecated. The value of this flag is ignored. + Forces the default `admin` Che user to update password on first login. Defaults to `false`. type: boolean type: object dashboard: @@ -782,9 +790,9 @@ spec: to connect to the DB. Defaults to `dbche`. type: string chePostgresHostName: - description: 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`. + description: |- + 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. type: string chePostgresPassword: @@ -793,35 +801,29 @@ spec: automatically generated value. type: string chePostgresPort: - description: 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. + description: |- + 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. type: string chePostgresSecret: - description: '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 `postgres-credentials` will - be created with default value of `pgche` for `user` and with - an auto-generated value for `password`. The secret must have - `app.kubernetes.io/part-of=che.eclipse.org` label.' + description: |- + 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 `postgres-credentials` + will be created with default value of `pgche` for `user` and with an auto-generated value for `password`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string chePostgresUser: description: PostgreSQL user that the Che server uses to connect to the DB. Defaults to `pgche`. type: string externalDb: - description: '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`.' + description: |- + 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`. type: boolean postgresEnv: description: List of environment variables to set in the PostgreSQL @@ -835,15 +837,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -856,9 +859,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -867,12 +871,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -885,11 +888,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -909,6 +912,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -918,9 +922,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -929,6 +934,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -946,30 +952,29 @@ spec: `next` or `latest` images, and `IfNotPresent` in other cases. type: string postgresVersion: - description: 'Indicates a PostgreSQL version image to use. Allowed - values are: `9.6` and `13.3`. Migrate your PostgreSQL database - to switch from one version to another.' + description: |- + Indicates a PostgreSQL version image to use. Allowed values are: `9.6` and `13.3`. + Migrate your PostgreSQL database to switch from one version to another. type: string pvcClaimSize: - description: Size of the persistent volume claim for database. - Defaults to `1Gi`. To update pvc storageclass that provisions - it must support resize when Eclipse Che has been already deployed. + description: |- + Size of the persistent volume claim for database. Defaults to `1Gi`. + To update pvc storageclass that provisions it must support resize when Eclipse Che has been already deployed. type: string type: object devWorkspace: description: DevWorkspace operator configuration properties: controllerImage: - description: Overrides the container image used in the DevWorkspace - controller deployment. This includes the image tag. Omit it - or leave it empty to use the default container image provided - by the Operator. + description: |- + Overrides the container image used in the DevWorkspace controller deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string enable: - description: 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. + description: |- + 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. type: boolean env: description: List of environment variables to set in the DevWorkspace @@ -983,15 +988,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1004,9 +1010,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1015,12 +1022,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1033,11 +1039,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1057,6 +1063,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1066,9 +1073,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1077,6 +1085,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1087,17 +1096,18 @@ spec: type: string secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer required: @@ -1115,15 +1125,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -1137,14 +1148,15 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -1158,14 +1170,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -1176,17 +1189,15 @@ spec: description: Kubernetes Image Puller configuration properties: enable: - description: 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. If the `spec.images` - field is empty, a set of recommended workspace-related images - will be automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + 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. + If the `spec.images` field is empty, a set of recommended workspace-related images will be automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A KubernetesImagePullerSpec to configure the image @@ -1227,24 +1238,21 @@ spec: made on upstream Kubernetes. properties: ingressClass: - description: '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.' + description: |- + 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. type: string ingressDomain: description: 'Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string securityContextFsGroup: description: The FSGroup in which the Che Pod and workspace Pods @@ -1255,22 +1263,17 @@ spec: run as. Default value is `1724`. type: string singleHostExposureType: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string tlsSecretName: - description: 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. + description: |- + 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. type: string type: object metrics: @@ -1287,73 +1290,69 @@ spec: the plugin and devfile registries properties: airGapContainerRegistryHostname: - description: 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. + description: |- + 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. type: string airGapContainerRegistryOrganization: - description: 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. + description: |- + 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. type: string allowAutoProvisionUserNamespace: - description: Indicates if is allowed to automatically create a - user namespace. If it set to false, then user namespace must - be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean allowUserDefinedWorkspaceNamespaces: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean cheClusterRoles: - description: A comma-separated list of ClusterRoles that will - be assigned to Che ServiceAccount. Each role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. Be aware that the Che Operator has to already have all - permissions in these ClusterRoles to grant them. + description: |- + A comma-separated list of ClusterRoles that will be assigned to Che ServiceAccount. + Each role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + Be aware that the Che Operator has to already have all permissions in these ClusterRoles to grant them. type: string cheDebug: description: Enables the debug mode for Che server. Defaults to `false`. type: string cheFlavor: - description: Deprecated. The value of this flag is ignored. Specifies - a variation of the installation. The options are `che` for - upstream Che installations or `devspaces` for Red Hat OpenShift - Dev Spaces (formerly Red Hat CodeReady Workspaces) installation + description: |- + Deprecated. The value of this flag is ignored. + Specifies a variation of the installation. The options are `che` for upstream Che installations or + `devspaces` for Red Hat OpenShift Dev Spaces (formerly Red Hat CodeReady Workspaces) installation type: string cheHost: - description: 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. + description: |- + 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. type: string cheHostTLSSecret: - description: Name of a secret containing certificates to secure - ingress or route for the custom host name of the installed Che - server. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. See the `cheHost` field. + description: |- + Name of a secret containing certificates to secure ingress or route for the custom host name of the installed Che server. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. + See the `cheHost` field. type: string cheImage: - description: 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. + description: |- + 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. type: string cheImagePullPolicy: - description: Overrides the image pull policy used in Che deployment. - Default value is `Always` for `nightly`, `next` or `latest` - images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in Che deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string cheImageTag: - description: 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. + description: |- + 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. type: string cheLogLevel: description: 'Log level for the Che server: `INFO` or `DEBUG`. @@ -1371,15 +1370,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1392,9 +1392,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1403,12 +1404,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1421,11 +1421,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1445,6 +1445,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1454,9 +1455,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1465,6 +1467,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1496,10 +1499,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1507,27 +1510,28 @@ spec: type: string type: object cheWorkspaceClusterRole: - description: Custom cluster role bound to the user for the Che - workspaces. The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. The default roles are used when omitted or left blank. + description: |- + Custom cluster role bound to the user for the Che workspaces. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string - description: 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. + description: |- + 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. type: object dashboardCpuLimit: - description: Overrides the CPU limit used in the dashboard deployment. + description: |- + Overrides the CPU limit used in the dashboard deployment. In cores. (500m = .5 cores). Default to 500m. type: string dashboardCpuRequest: - description: Overrides the CPU request used in the dashboard deployment. + description: |- + Overrides the CPU request used in the dashboard deployment. In cores. (500m = .5 cores). Default to 100m. type: string dashboardEnv: @@ -1542,15 +1546,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1563,9 +1568,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1574,12 +1580,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1592,11 +1597,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1616,6 +1621,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1625,9 +1631,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1636,24 +1643,26 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array dashboardImage: - description: Overrides the container image used in the dashboard - deployment. This includes the image tag. Omit it or leave it - empty to use the default container image provided by the Operator. + description: |- + Overrides the container image used in the dashboard deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string dashboardImagePullPolicy: - description: Overrides the image pull policy used in the dashboard - deployment. Default value is `Always` for `nightly`, `next` - or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the dashboard deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string dashboardIngress: - description: Deprecated. The value of this flag is ignored. Dashboard - ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard ingress custom settings. properties: annotations: additionalProperties: @@ -1676,8 +1685,9 @@ spec: deployment. Defaults to 16Mi. type: string dashboardRoute: - description: Deprecated. The value of this flag is ignored. Dashboard - route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard route custom settings. properties: annotations: additionalProperties: @@ -1687,10 +1697,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1698,12 +1708,14 @@ spec: type: string type: object devfileRegistryCpuLimit: - description: Overrides the CPU limit used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string devfileRegistryCpuRequest: - description: Overrides the CPU request used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string devfileRegistryEnv: description: List of environment variables to set in the plugin @@ -1717,15 +1729,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1738,9 +1751,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1749,12 +1763,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1767,11 +1780,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1791,6 +1804,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1800,9 +1814,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1811,20 +1826,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array devfileRegistryImage: - description: 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. + description: |- + 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. type: string devfileRegistryIngress: - description: Deprecated. The value of this flag is ignored. The - devfile registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry ingress custom settings. properties: annotations: additionalProperties: @@ -1847,13 +1863,14 @@ spec: registry deployment. Defaults to 16Mi. type: string devfileRegistryPullPolicy: - description: Overrides the image pull policy used in the devfile - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the devfile registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string devfileRegistryRoute: - description: Deprecated. The value of this flag is ignored. The - devfile registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry route custom settings. properties: annotations: additionalProperties: @@ -1863,10 +1880,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1878,14 +1895,14 @@ spec: fields. type: string disableInternalClusterSVCNames: - description: Deprecated. The value of this flag is ignored. Disable - internal cluster SVC names usage to communicate between components - to speed up the traffic and avoid proxy issues. + description: |- + Deprecated. The value of this flag is ignored. + Disable internal cluster SVC names usage to communicate between components to speed up the traffic and avoid proxy issues. type: boolean externalDevfileRegistries: - description: External devfile registries, that serves sample, - ready-to-use devfiles. Configure this in addition to a dedicated - devfile registry (when `externalDevfileRegistry` is `false`) + description: |- + External devfile registries, that serves sample, ready-to-use devfiles. + Configure this in addition to a dedicated devfile registry (when `externalDevfileRegistry` is `false`) or instead of it (when `externalDevfileRegistry` is `true`) items: description: Settings for a configuration of the external devfile @@ -1897,50 +1914,44 @@ spec: type: object type: array externalDevfileRegistry: - description: 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 - configure at least one devfile registry with `externalDevfileRegistries` - field. + description: |- + 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 configure at least one + devfile registry with `externalDevfileRegistries` field. type: boolean externalPluginRegistry: - description: 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. + description: |- + 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. type: boolean gitSelfSignedCert: - description: When enabled, the certificate from `che-git-self-signed-cert` - ConfigMap will be propagated to the Che components and provide - particular configuration for Git. Note, the `che-git-self-signed-cert` - ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + When enabled, the certificate from `che-git-self-signed-cert` ConfigMap will be propagated to the Che components and provide particular configuration for Git. + Note, the `che-git-self-signed-cert` ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: boolean nonProxyHosts: - description: 'List of hosts that will be reached directly, bypassing - the proxy. Specify wild card domain use the following form `.` - 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.' + description: |- + List of hosts that will be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.` 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. type: string openVSXRegistryURL: description: Open VSX registry URL. If omitted an embedded instance will be used. type: string pluginRegistryCpuLimit: - description: Overrides the CPU limit used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string pluginRegistryCpuRequest: - description: Overrides the CPU request used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string pluginRegistryEnv: description: List of environment variables to set in the devfile @@ -1954,15 +1965,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1975,9 +1987,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1986,12 +1999,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -2004,11 +2016,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -2028,6 +2040,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -2037,9 +2050,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -2048,20 +2062,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array pluginRegistryImage: - description: 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. + description: |- + 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. type: string pluginRegistryIngress: - description: Deprecated. The value of this flag is ignored. Plugin - registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry ingress custom settings. properties: annotations: additionalProperties: @@ -2084,13 +2099,14 @@ spec: deployment. Defaults to 16Mi. type: string pluginRegistryPullPolicy: - description: Overrides the image pull policy used in the plugin - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the plugin registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string pluginRegistryRoute: - description: Deprecated. The value of this flag is ignored. Plugin - registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry route custom settings. properties: annotations: additionalProperties: @@ -2100,10 +2116,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -2111,16 +2127,15 @@ spec: type: string type: object pluginRegistryUrl: - description: 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. + description: |- + 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. type: string proxyPassword: - description: Password of the proxy server. Only use when proxy - configuration is required. See the `proxyURL`, `proxyUser` and - `proxySecret` fields. + description: |- + Password of the proxy server. + Only use when proxy configuration is required. See the `proxyURL`, `proxyUser` and `proxySecret` fields. type: string proxyPort: description: Port of the proxy server. Only use when configuring @@ -2128,22 +2143,18 @@ spec: fields. type: string proxySecret: - description: The secret that contains `user` and `password` for - a proxy server. When the secret is defined, the `proxyUser` - and `proxyPassword` are ignored. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The secret that contains `user` and `password` for a proxy server. When the secret is defined, the `proxyUser` and `proxyPassword` are ignored. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string proxyURL: - description: 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. + description: |- + 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. type: string proxyUser: description: User name of the proxy server. Only use when configuring @@ -2151,31 +2162,29 @@ spec: and `proxySecret` fields. type: string selfSignedCert: - description: 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. + description: |- + 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. type: boolean serverCpuLimit: - description: Overrides the CPU limit used in the Che server deployment + description: |- + Overrides the CPU limit used in the Che server deployment In cores. (500m = .5 cores). Default to 1. type: string serverCpuRequest: - description: Overrides the CPU request used in the Che server - deployment In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the Che server deployment + In cores. (500m = .5 cores). Default to 100m. type: string serverExposureStrategy: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string serverMemoryLimit: description: Overrides the memory limit used in the Che server @@ -2186,13 +2195,11 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: 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. - The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + 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. + The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string singleHostGatewayConfigMapLabels: additionalProperties: @@ -2219,9 +2226,9 @@ spec: description: Deprecated in favor of `disableInternalClusterSVCNames`. type: boolean workspaceDefaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile does - not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile does not contain any components. items: properties: attributes: @@ -2260,20 +2267,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -2282,10 +2289,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -2297,28 +2306,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2333,24 +2353,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2360,15 +2387,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2376,10 +2402,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -2398,17 +2431,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -2418,18 +2453,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -2439,19 +2473,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -2464,8 +2499,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -2485,18 +2523,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -2515,32 +2550,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -2550,9 +2585,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -2568,14 +2603,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2587,28 +2625,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2623,24 +2672,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2650,15 +2706,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2679,22 +2734,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2706,28 +2764,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2742,24 +2811,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2769,15 +2845,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2798,32 +2873,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -2849,9 +2928,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -2867,9 +2946,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -2897,9 +2976,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -2911,23 +2990,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -2958,40 +3040,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -3000,9 +3082,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -3041,21 +3123,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -3064,10 +3145,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -3080,31 +3163,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3118,29 +3208,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3150,27 +3242,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -3188,18 +3284,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -3209,20 +3305,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -3234,9 +3327,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -3258,21 +3353,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -3291,34 +3380,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -3328,10 +3413,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -3346,16 +3430,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3368,31 +3453,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3406,29 +3498,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3438,17 +3532,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3469,24 +3560,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3499,31 +3591,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3537,29 +3636,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3569,17 +3670,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3600,13 +3698,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3639,34 +3738,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3678,16 +3777,16 @@ spec: type: array workspaceDefaultEditor: default: che-incubator/che-code/latest - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/plugin/version`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/plugin/version`. The URI must start from `http`. type: string workspaceNamespaceDefault: - description: 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 ``, `` and `` - placeholders, such as che-workspace-. In that case, - a new namespace will be created for each user or workspace. + description: |- + 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 ``, `` and `` placeholders, such as che-workspace-. + In that case, a new namespace will be created for each user or workspace. type: string workspacePodNodeSelector: additionalProperties: @@ -3699,41 +3798,39 @@ spec: description: The pod tolerations put on the workspace pods to limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -3770,26 +3867,23 @@ spec: storage class is used. type: string preCreateSubPaths: - description: 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. + description: |- + 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. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. Defaults to `10Gi`. type: string pvcJobsImage: - description: 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. + description: |- + 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. type: string pvcStrategy: - description: 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`. + description: |- + 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`. type: string workspacePVCStorageClassName: description: Storage class for the Persistent Volume Claims dedicated @@ -3822,15 +3916,14 @@ spec: description: The status of the Devworkspace subsystem properties: gatewayHost: - description: GatewayHost is the resolved host of the ingress/route. - This is equal to the Host in the spec on Kubernetes but contains - the actual host name of the route if Host is unspecified on - OpenShift. + description: |- + GatewayHost is the resolved host of the ingress/route. This is equal to the Host in the spec + on Kubernetes but contains the actual host name of the route if Host is unspecified on OpenShift. type: string gatewayPhase: - description: GatewayPhase specifies the phase in which the gateway - deployment currently is. If the gateway is disabled, the phase - is "Inactive". + description: |- + GatewayPhase specifies the phase in which the gateway deployment currently is. + If the gateway is disabled, the phase is "Inactive". type: string message: description: Message contains further human-readable info for @@ -3845,10 +3938,10 @@ spec: why the Che cluster is in this state. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either - the copy of the explicitly defined property of the same name - in the spec or, if it is undefined in the spec and we're running - on OpenShift, the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object gitHubOAuthProvisioned: @@ -3899,22 +3992,26 @@ spec: - name: v2 schema: openAPIV3Schema: - description: 'The `CheCluster` custom resource allows defining and managing - Eclipse Che server installation. Based on these settings, the Operator - automatically creates and maintains several ConfigMaps: `che`, `plugin-registry`, - `devfile-registry` that will contain the appropriate environment variables - of the various components of the installation. These generated ConfigMaps - must NOT be updated manually.' + description: |- + The `CheCluster` custom resource allows defining and managing Eclipse Che server installation. + Based on these settings, the Operator automatically creates and maintains several ConfigMaps: + `che`, `plugin-registry`, `devfile-registry` that will contain the appropriate environment variables + of the various components of the installation. These generated ConfigMaps must NOT be updated manually. properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object @@ -3938,14 +4035,15 @@ spec: server. properties: clusterRoles: - description: 'Additional ClusterRoles assigned to Che ServiceAccount. - Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. The defaults roles are: - `-cheworkspaces-clusterrole` + description: |- + Additional ClusterRoles assigned to Che ServiceAccount. + Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` label. + The defaults roles are: + - `-cheworkspaces-clusterrole` - `-cheworkspaces-namespaces-clusterrole` - `-cheworkspaces-devworkspace-clusterrole` - where the is the namespace where the CheCluster - CR is created. The Che Operator must already have all permissions - in these ClusterRoles to grant them.' + where the is the namespace where the CheCluster CR is created. + The Che Operator must already have all permissions in these ClusterRoles to grant them. items: type: string type: array @@ -3973,18 +4071,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -3997,10 +4093,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4009,12 +4105,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4028,13 +4123,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4056,6 +4149,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4066,10 +4160,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4078,6 +4172,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4112,23 +4207,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4140,23 +4232,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4182,13 +4271,11 @@ spec: extraProperties: additionalProperties: type: string - description: A map of additional environment variables 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). If the `extraProperties` - field contains a property normally generated in `che` ConfigMap - from other CR fields, the value defined in the `extraProperties` - is used instead. + description: |- + A map of additional environment variables 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). + If the `extraProperties` field contains a property normally generated in `che` ConfigMap from other CR fields, + the value defined in the `extraProperties` is used instead. type: object logLevel: default: INFO @@ -4196,27 +4283,25 @@ spec: `DEBUG`.' type: string proxy: - description: Proxy server settings for Kubernetes cluster. - No additional configuration is required for OpenShift cluster. - By specifying these settings for the OpenShift cluster, - you override the OpenShift proxy configuration. + description: |- + Proxy server settings for Kubernetes cluster. No additional configuration is required for OpenShift cluster. + By specifying these settings for the OpenShift cluster, you override the OpenShift proxy configuration. properties: credentialsSecretName: - description: The secret name that contains `user` and - `password` for a proxy server. The secret must have - a `app.kubernetes.io/part-of=che.eclipse.org` label. + description: |- + The secret name that contains `user` and `password` for a proxy server. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string nonProxyHosts: - description: 'A list of hosts that can be reached directly, - bypassing the proxy. Specify wild card domain use the - following form `.`, for example: - localhost - - my.host.com - 123.42.12.32 Use only when a proxy - configuration is required. The Operator respects OpenShift - cluster-wide proxy configuration, defining `nonProxyHosts` - in a custom resource leads to merging non-proxy hosts - lists from the cluster proxy configuration, and the - ones defined in the custom resources. See the following - page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + A list of hosts that can be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.`, for example: + - localhost + - my.host.com + - 123.42.12.32 + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `nonProxyHosts` in a custom resource leads to merging non-proxy hosts lists from the cluster proxy configuration, and the ones defined in the custom resources. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. items: type: string type: array @@ -4224,12 +4309,11 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. - Use only when a proxy configuration is required. The - Operator respects OpenShift cluster-wide proxy configuration, - defining `url` in a custom resource leads to overriding - the cluster proxy configuration. See the following page: - https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + URL (protocol+hostname) of the proxy server. + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `url` in a custom resource leads to overriding the cluster proxy configuration. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. type: string type: object type: object @@ -4272,18 +4356,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4296,10 +4378,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4308,12 +4390,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4327,13 +4408,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4355,6 +4434,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4365,10 +4445,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4377,6 +4457,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4411,23 +4492,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4439,23 +4517,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4505,7 +4580,8 @@ spec: description: DevWorkspace Operator configuration. properties: runningLimit: - description: Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` + description: |- + Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` The maximum number of running workspaces per user. type: string type: object @@ -4533,18 +4609,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4557,10 +4631,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4569,12 +4643,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4588,13 +4661,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4616,6 +4687,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4626,10 +4698,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4638,6 +4710,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4672,23 +4745,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4700,23 +4770,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4759,18 +4826,15 @@ spec: description: Kubernetes Image Puller configuration. properties: enable: - description: Install and configure the community supported - Kubernetes Image Puller Operator. When you set the value - to `true` without providing any specs, it creates a default - Kubernetes Image Puller object managed by the Operator. - When you set the value to `false`, the Kubernetes Image - Puller object is deleted, and the Operator uninstalled, - regardless of whether a spec is provided. If you leave the - `spec.images` field empty, a set of recommended workspace-related - images is automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + Install and configure the community supported Kubernetes Image Puller Operator. When you set the value to `true` without providing any specs, + it creates a default Kubernetes Image Puller object managed by the Operator. + When you set the value to `false`, the Kubernetes Image Puller object is deleted, and the Operator uninstalled, + regardless of whether a spec is provided. + If you leave the `spec.images` field empty, a set of recommended workspace-related images is automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A Kubernetes Image Puller spec to configure the @@ -4838,18 +4902,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4862,10 +4924,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4874,12 +4936,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4893,13 +4954,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4921,6 +4980,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4931,10 +4991,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4943,6 +5003,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4977,23 +5038,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5005,23 +5063,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5068,18 +5123,16 @@ spec: Che images. properties: hostname: - description: An optional hostname or URL of an alternative container - registry to pull images from. This value overrides the container - registry hostname defined in all the default container images - involved in a Che deployment. This is particularly useful for - installing Che in a restricted environment. + description: |- + An optional hostname or URL of an alternative container registry to pull images from. + This value overrides the container registry hostname defined in all the default container images involved in a Che deployment. + This is particularly useful for installing Che in a restricted environment. type: string organization: - description: An optional repository name of an alternative 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 for installing - Eclipse Che in a restricted environment. + description: |- + An optional repository name of an alternative 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 for installing Eclipse Che in a restricted environment. type: string type: object devEnvironments: @@ -5105,9 +5158,9 @@ spec: type: string type: object defaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile, that - does not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile, that does not contain any components. items: properties: attributes: @@ -5146,20 +5199,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5168,10 +5221,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5183,28 +5238,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5219,24 +5285,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5246,15 +5319,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5262,10 +5334,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -5284,17 +5363,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -5304,18 +5385,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -5325,19 +5405,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -5350,8 +5431,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -5371,18 +5455,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -5401,32 +5482,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -5436,9 +5517,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -5454,14 +5535,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5473,28 +5557,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5509,24 +5604,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5536,15 +5638,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5565,22 +5666,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5592,28 +5696,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5628,24 +5743,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5655,15 +5777,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5684,32 +5805,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -5735,9 +5860,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -5753,9 +5878,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -5783,9 +5908,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -5797,23 +5922,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -5844,40 +5972,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -5886,9 +6014,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -5927,21 +6055,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5950,10 +6077,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5966,31 +6095,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6004,29 +6140,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6036,27 +6174,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -6074,18 +6216,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -6095,20 +6237,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -6120,9 +6259,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -6144,21 +6285,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -6177,34 +6312,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -6214,10 +6345,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -6232,16 +6362,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6254,31 +6385,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6292,29 +6430,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6324,17 +6464,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6355,24 +6492,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6385,31 +6523,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6423,29 +6568,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6455,17 +6602,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6486,13 +6630,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6525,34 +6670,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6563,9 +6708,10 @@ spec: type: object type: array defaultEditor: - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/name/version` - format. The URI must start from `http://` or `https://`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/name/version` format. + The URI must start from `http://` or `https://`. type: string defaultNamespace: default: @@ -6575,16 +6721,15 @@ spec: properties: autoProvision: default: true - description: Indicates if is allowed to automatically create - a user namespace. If it set to false, then user namespace - must be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean template: default: -che - description: If you don't create the user namespaces in advance, - this field defines the Kubernetes namespace created when - you start your first workspace. You can use `` - and `` placeholders, such as che-workspace-. + description: |- + If you don't create the user namespaces in advance, this field defines the Kubernetes namespace created when you start your first workspace. + You can use `` and `` placeholders, such as che-workspace-. pattern: | type: string type: object @@ -6593,7 +6738,8 @@ spec: items: properties: editor: - description: The editor ID to specify default plug-ins for. + description: |- + The editor ID to specify default plug-ins for. The plugin ID must have `publisher/name/version` format. type: string plugins: @@ -6604,25 +6750,30 @@ spec: type: object type: array deploymentStrategy: - description: DeploymentStrategy defines the deployment strategy - to use to replace existing workspace pods with new ones. The - available deployment stragies are `Recreate` and `RollingUpdate`. - With the `Recreate` deployment strategy, the existing workspace - pod is killed before the new one is created. With the `RollingUpdate` - deployment strategy, a new workspace pod is created and the - existing workspace pod is deleted only when the new workspace - pod is in a ready state. If not specified, the default `Recreate` - deployment strategy is used. + description: |- + DeploymentStrategy defines the deployment strategy to use to replace existing workspace pods + with new ones. The available deployment stragies are `Recreate` and `RollingUpdate`. + With the `Recreate` deployment strategy, the existing workspace pod is killed before the new one is created. + With the `RollingUpdate` deployment strategy, a new workspace pod is created and the existing workspace pod is deleted + only when the new workspace pod is in a ready state. + If not specified, the default `Recreate` deployment strategy is used. enum: - Recreate - RollingUpdate type: string disableContainerBuildCapabilities: - description: "Disables the container build capabilities. When - set to `false` (the default value), the devEnvironments.security.containerSecurityContext - field is ignored, and the following container SecurityContext - is applied: \n containerSecurityContext: allowPrivilegeEscalation: - true capabilities: add: - SETGID - SETUID" + description: |- + Disables the container build capabilities. + When set to `false` (the default value), the devEnvironments.security.containerSecurityContext + field is ignored, and the following container SecurityContext is applied: + + + containerSecurityContext: + allowPrivilegeEscalation: true + capabilities: + add: + - SETGID + - SETUID type: boolean gatewayContainer: description: GatewayContainer configuration. @@ -6638,16 +6789,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6660,10 +6811,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6672,12 +6823,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6690,12 +6840,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6715,6 +6864,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6724,10 +6874,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6736,6 +6886,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -6768,19 +6919,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6793,19 +6944,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6821,16 +6972,17 @@ spec: - Never type: string maxNumberOfRunningWorkspacesPerUser: - description: The maximum number of running workspaces per user. + description: |- + The maximum number of running workspaces per user. The value, -1, allows users to run an unlimited number of workspaces. format: int64 minimum: -1 type: integer maxNumberOfWorkspacesPerUser: default: -1 - description: Total number of workspaces, both stopped and running, - that a user can keep. The value, -1, allows users to keep an - unlimited number of workspaces. + description: |- + Total number of workspaces, both stopped and running, that a user can keep. + The value, -1, allows users to keep an unlimited number of workspaces. format: int64 minimum: -1 type: integer @@ -6841,19 +6993,22 @@ spec: workspace pods. type: object persistUserHome: - description: PersistUserHome defines configuration options for - persisting the user home directory in workspaces. + description: |- + PersistUserHome defines configuration options for persisting the + user home directory in workspaces. properties: enabled: - description: Determines whether the user home directory in - workspaces should persist between workspace shutdown and - startup. Must be used with the 'per-user' or 'per-workspace' - PVC strategy in order to take effect. Disabled by default. + description: |- + Determines whether the user home directory in workspaces should persist between + workspace shutdown and startup. + Must be used with the 'per-user' or 'per-workspace' PVC strategy in order to take effect. + Disabled by default. type: boolean type: object podSchedulerName: - description: Pod scheduler for the workspace pods. If not specified, - the pod scheduler is set to the default scheduler on the cluster. + description: |- + Pod scheduler for the workspace pods. + If not specified, the pod scheduler is set to the default scheduler on the cluster. type: string projectCloneContainer: description: Project clone container configuration. @@ -6869,16 +7024,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6891,10 +7046,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6903,12 +7058,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6921,12 +7075,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6946,6 +7099,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6955,10 +7109,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6967,6 +7121,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -6999,19 +7154,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7024,19 +7179,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7045,42 +7200,44 @@ spec: type: object secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer security: description: Workspace security configuration. properties: containerSecurityContext: - description: Container SecurityContext used by all workspace-related - containers. If set, defined values are merged into the default - Container SecurityContext configuration. Requires devEnvironments.disableContainerBuildCapabilities - to be set to `true` in order to take effect. + description: |- + Container SecurityContext used by all workspace-related containers. + If set, defined values are merged into the default Container SecurityContext configuration. + Requires devEnvironments.disableContainerBuildCapabilities to be set to `true` in order to take effect. properties: allowPrivilegeEscalation: - description: 'AllowPrivilegeEscalation controls whether - a process can gain more privileges than its parent process. - This bool directly controls if the no_new_privs flag - will be set on the container process. AllowPrivilegeEscalation - is true always when the container is: 1) run as Privileged - 2) has CAP_SYS_ADMIN Note that this field cannot be - set when spec.os.name is windows.' + description: |- + AllowPrivilegeEscalation controls whether a process can gain more + privileges than its parent process. This bool directly controls if + the no_new_privs flag will be set on the container process. + AllowPrivilegeEscalation is true always when the container is: + 1) run as Privileged + 2) has CAP_SYS_ADMIN + Note that this field cannot be set when spec.os.name is windows. type: boolean capabilities: - description: The capabilities to add/drop when running - containers. Defaults to the default set of capabilities - granted by the container runtime. Note that this field - cannot be set when spec.os.name is windows. + description: |- + The capabilities to add/drop when running containers. + Defaults to the default set of capabilities granted by the container runtime. + Note that this field cannot be set when spec.os.name is windows. properties: add: description: Added capabilities @@ -7098,61 +7255,60 @@ spec: type: array type: object privileged: - description: Run container in privileged mode. Processes - in privileged containers are essentially equivalent - to root on the host. Defaults to false. Note that this - field cannot be set when spec.os.name is windows. + description: |- + Run container in privileged mode. + Processes in privileged containers are essentially equivalent to root on the host. + Defaults to false. + Note that this field cannot be set when spec.os.name is windows. type: boolean procMount: - description: procMount denotes the type of proc mount - to use for the containers. The default is DefaultProcMount - which uses the container runtime defaults for readonly - paths and masked paths. This requires the ProcMountType - feature flag to be enabled. Note that this field cannot - be set when spec.os.name is windows. + description: |- + procMount denotes the type of proc mount to use for the containers. + The default is DefaultProcMount which uses the container runtime defaults for + readonly paths and masked paths. + This requires the ProcMountType feature flag to be enabled. + Note that this field cannot be set when spec.os.name is windows. type: string readOnlyRootFilesystem: - description: Whether this container has a read-only root - filesystem. Default is false. Note that this field cannot - be set when spec.os.name is windows. + description: |- + Whether this container has a read-only root filesystem. + Default is false. + Note that this field cannot be set when spec.os.name is windows. type: boolean runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to the - container. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The SELinux context to be applied to the container. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7172,137 +7328,135 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by this container. - If seccomp options are provided at both the pod & container - level, the container options override the pod options. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The seccomp options to use by this container. If seccomp options are + provided at both the pod & container level, the container options + override the pod options. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options from the - PodSecurityContext will be used. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options from the PodSecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object podSecurityContext: - description: PodSecurityContext used by all workspace-related - pods. If set, defined values are merged into the default - PodSecurityContext configuration. + description: |- + PodSecurityContext used by all workspace-related pods. + If set, defined values are merged into the default PodSecurityContext configuration. properties: fsGroup: - description: "A special supplemental group that applies - to all containers in a pod. Some volume types allow - the Kubelet to change the ownership of that volume to - be owned by the pod: \n 1. The owning GID will be the - FSGroup 2. The setgid bit is set (new files created - in the volume will be owned by FSGroup) 3. The permission - will not modify the ownership and permissions of any - volume. Note that this field cannot be set when spec.os.name - is windows." + description: |- + A special supplemental group that applies to all containers in a pod. + Some volume types allow the Kubelet to change the ownership of that volume + to be owned by the pod: + + + 1. The owning GID will be the FSGroup + 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) + + + If unset, the Kubelet will not modify the ownership and permissions of any volume. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer fsGroupChangePolicy: - description: 'fsGroupChangePolicy defines behavior of - changing ownership and permission of the volume before - being exposed inside Pod. This field will only apply - to volume types which support fsGroup based ownership(and - permissions). It will have no effect on ephemeral volume - types such as: secret, configmaps and emptydir. Valid - values are "OnRootMismatch" and "Always". If not specified, - "Always" is used. Note that this field cannot be set - when spec.os.name is windows.' + description: |- + fsGroupChangePolicy defines behavior of changing ownership and permission of the volume + before being exposed inside Pod. This field will only apply to + volume types which support fsGroup based ownership(and permissions). + It will have no effect on ephemeral volume types such as: secret, configmaps + and emptydir. + Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + Note that this field cannot be set when spec.os.name is windows. type: string runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in SecurityContext. If set - in both SecurityContext and PodSecurityContext, the - value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in SecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence - for that container. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to all - containers. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The SELinux context to be applied to all containers. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in SecurityContext. If set in + both SecurityContext and PodSecurityContext, the value specified in SecurityContext + takes precedence for that container. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7322,49 +7476,48 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by the containers - in this pod. Note that this field cannot be set when - spec.os.name is windows. + description: |- + The seccomp options to use by the containers in this pod. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object supplementalGroups: - description: A list of groups applied to the first process - run in each container, in addition to the container's - primary GID, the fsGroup (if specified), and group memberships - defined in the container image for the uid of the container - process. If unspecified, no additional groups are added - to any container. Note that group memberships defined - in the container image for the uid of the container - process are still effective, even if they are not included - in this list. Note that this field cannot be set when - spec.os.name is windows. + description: |- + A list of groups applied to the first process run in each container, in addition + to the container's primary GID, the fsGroup (if specified), and group memberships + defined in the container image for the uid of the container process. If unspecified, + no additional groups are added to any container. Note that group memberships + defined in the container image for the uid of the container process are still effective, + even if they are not included in this list. + Note that this field cannot be set when spec.os.name is windows. items: format: int64 type: integer type: array sysctls: - description: Sysctls hold a list of namespaced sysctls - used for the pod. Pods with unsupported sysctls (by - the container runtime) might fail to launch. Note that - this field cannot be set when spec.os.name is windows. + description: |- + Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported + sysctls (by the container runtime) might fail to launch. + Note that this field cannot be set when spec.os.name is windows. items: description: Sysctl defines a kernel parameter to be set @@ -7381,43 +7534,38 @@ spec: type: object type: array windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options within a - container's SecurityContext will be used. If set in - both SecurityContext and PodSecurityContext, the value - specified in SecurityContext takes precedence. Note - that this field cannot be set when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options within a container's SecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object @@ -7434,37 +7582,39 @@ spec: items: properties: audience: - description: Audience is the intended audience of the token. - A recipient of a token must identify itself with an identifier - specified in the audience of the token, and otherwise - should reject the token. The audience defaults to the + description: |- + Audience is the intended audience of the token. A recipient of a token + must identify itself with an identifier specified in the audience of the + token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. type: string expirationSeconds: default: 3600 - description: ExpirationSeconds is the requested duration - of validity of the service account token. As the token - approaches expiration, the kubelet volume plugin will - proactively rotate the service account token. The kubelet - will start trying to rotate the token if the token is - older than 80 percent of its time to live or if the token - is older than 24 hours. Defaults to 1 hour and must be - at least 10 minutes. + description: |- + ExpirationSeconds is the requested duration of validity of the service + account token. As the token approaches expiration, the kubelet volume + plugin will proactively rotate the service account token. The kubelet will + start trying to rotate the token if the token is older than 80 percent of + its time to live or if the token is older than 24 hours. Defaults to 1 hour + and must be at least 10 minutes. format: int64 minimum: 600 type: integer mountPath: - description: Path within the workspace container at which - the token should be mounted. Must not contain ':'. + description: |- + Path within the workspace container at which the token should be mounted. Must + not contain ':'. type: string name: - description: Identifiable name of the ServiceAccount token. - If multiple ServiceAccount tokens use the same mount path, - a generic name will be used for the projected volume instead. + description: |- + Identifiable name of the ServiceAccount token. + If multiple ServiceAccount tokens use the same mount path, a generic name will be used + for the projected volume instead. type: string path: - description: Path is the path relative to the mount point - of the file to project the token into. + description: |- + Path is the path relative to the mount point of the file to project the + token into. type: string required: - mountPath @@ -7474,10 +7624,10 @@ spec: type: array startTimeoutSeconds: default: 300 - description: StartTimeoutSeconds determines the maximum duration - (in seconds) that a workspace can take to start before it is - automatically failed. If not specified, the default value of - 300 seconds (5 minutes) is used. + description: |- + StartTimeoutSeconds determines the maximum duration (in seconds) that a workspace can take to start + before it is automatically failed. + If not specified, the default value of 300 seconds (5 minutes) is used. format: int32 minimum: 1 type: integer @@ -7517,12 +7667,12 @@ spec: type: object pvcStrategy: default: per-user - description: 'Persistent volume claim strategy for the Che - server. The supported strategies are: `per-user` (all workspaces - PVCs in one volume), `per-workspace` (each workspace is - given its own individual PVC) and `ephemeral` (non-persistent - storage where local changes will be lost when the workspace - is stopped.)' + description: |- + Persistent volume claim strategy for the Che server. + The supported strategies are: `per-user` (all workspaces PVCs in one volume), + `per-workspace` (each workspace is given its own individual PVC) + and `ephemeral` (non-persistent storage where local changes will be lost when + the workspace is stopped.) enum: - common - per-user @@ -7534,41 +7684,39 @@ spec: description: The pod tolerations of the workspace pods limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -7576,20 +7724,19 @@ spec: description: Trusted certificate settings. properties: gitTrustedCertsConfigMapName: - description: 'The ConfigMap contains certificates to propagate - to the Che components and to provide a particular configuration - for Git. See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ - The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + The ConfigMap contains certificates to propagate to the Che components and to provide a particular configuration for Git. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ + The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object user: description: User configuration. properties: clusterRoles: - description: Additional ClusterRoles assigned to the user. - The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + Additional ClusterRoles assigned to the user. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. items: type: string type: array @@ -7607,9 +7754,9 @@ spec: hosted on Azure DevOps Service (dev.azure.com). properties: secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Azure DevOps Service Application ID and Client Secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services' + description: |- + Kubernetes secret, that contains Base64-encoded Azure DevOps Service Application ID and Client Secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services type: string required: - secretName @@ -7623,15 +7770,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -7645,19 +7793,21 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: disableSubdomainIsolation: - description: 'Disables subdomain isolation. Deprecated in - favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` - annotation. See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Disables subdomain isolation. + Deprecated in favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: boolean endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -7671,14 +7821,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -7697,10 +7848,13 @@ spec: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set for an Ingress - (a route for OpenShift platform). The defaults for kubernetes - platforms are: kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", nginx.ingress.kubernetes.io/proxy-connect-timeout: - "3600", nginx.ingress.kubernetes.io/ssl-redirect: "true"' + description: |- + Defines annotations which will be set for an Ingress (a route for OpenShift platform). + The defaults for kubernetes platforms are: + kubernetes.io/ingress.class: "nginx" + nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", + nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600", + nginx.ingress.kubernetes.io/ssl-redirect: "true" type: object auth: default: @@ -7711,15 +7865,12 @@ spec: description: Authentication settings. properties: advancedAuthorization: - description: Advance authorization settings. Determines which - users and groups are allowed to access Che. User is allowed - to access Che if he/she is either in the `allowUsers` list - or is member of group from `allowGroups` list and not in - neither the `denyUsers` list nor is member of group from - `denyGroups` list. If `allowUsers` and `allowGroups` are - empty, then all users are allowed to access Che. if `denyUsers` - and `denyGroups` are empty, then no users are denied to - access Che. + description: |- + Advance authorization settings. Determines which users and groups are allowed to access Che. + User is allowed to access Che if he/she is either in the `allowUsers` list or is member of group from `allowGroups` list + and not in neither the `denyUsers` list nor is member of group from `denyGroups` list. + If `allowUsers` and `allowGroups` are empty, then all users are allowed to access Che. + if `denyUsers` and `denyGroups` are empty, then no users are denied to access Che. properties: allowGroups: description: List of groups allowed to access Che (currently @@ -7760,10 +7911,13 @@ spec: description: Gateway configuration labels. type: object deployment: - description: 'Deployment override options. Since gateway - deployment consists of several containers, they must - be distinguished in the configuration by their names: - - `gateway` - `configbump` - `oauth-proxy` - `kube-rbac-proxy`' + description: |- + Deployment override options. + Since gateway deployment consists of several containers, they must be distinguished in the configuration by their names: + - `gateway` + - `configbump` + - `oauth-proxy` + - `kube-rbac-proxy` properties: containers: description: List of containers belonging to the pod. @@ -7782,19 +7936,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to - a single $, which allows for escaping - the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -7808,10 +7959,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7821,12 +7972,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -7841,13 +7991,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: @@ -7870,6 +8018,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -7880,10 +8029,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7892,6 +8041,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7926,23 +8076,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -7954,23 +8101,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -8045,25 +8189,24 @@ spec: description: Public URL of the Identity Provider server. type: string identityToken: - description: 'Identity token to be passed to upstream. There - are two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. enum: - id_token - access_token type: string oAuthAccessTokenInactivityTimeoutSeconds: - description: Inactivity timeout for tokens to set in the OpenShift - `OAuthClient` resource used to set up identity federation - on the OpenShift side. 0 means tokens for this client never - time out. + description: |- + Inactivity timeout for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means tokens for this client never time out. format: int32 type: integer oAuthAccessTokenMaxAgeSeconds: - description: Access token max age for tokens to set in the - OpenShift `OAuthClient` resource used to set up identity - federation on the OpenShift side. 0 means no expiration. + description: |- + Access token max age for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means no expiration. format: int32 type: integer oAuthClientName: @@ -8071,37 +8214,33 @@ spec: used to set up identity federation on the OpenShift side. type: string oAuthScope: - description: Access Token Scope. This field is specific to - Che installations made for Kubernetes only and ignored for - OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: - description: 'Name of the secret set in the OpenShift `OAuthClient` - resource used to set up identity federation on the OpenShift - side. For Kubernetes, this can either be the plain text - oAuthSecret value, or the name of a kubernetes secret which - contains a key `oAuthSecret` and the value is the secret. - NOTE: this secret must exist in the same namespace as the - `CheCluster` resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`.' + description: |- + Name of the secret set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + For Kubernetes, this can either be the plain text oAuthSecret value, or the name of a kubernetes secret which contains a + key `oAuthSecret` and the value is the secret. NOTE: this secret must exist in the same namespace as the `CheCluster` + resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`. type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the - domain to generate a hostname for the route. The generated hostname - follows this pattern: che-.. The - is the namespace where the CheCluster CRD is created. In conjunction - with labels, it creates a route served by a non-default Ingress - controller. For a Kubernetes cluster, it contains a global ingress - domain. There are no default values: you must specify them.' + description: |- + For an OpenShift cluster, the Operator uses the domain to generate a hostname for the route. + The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. + In conjunction with labels, it creates a route served by a non-default Ingress controller. + For a Kubernetes cluster, it contains a global ingress domain. There are no default values: you must specify them. type: string hostname: description: The public hostname of the installed Che server. type: string ingressClassName: - description: IngressClassName is the name of an IngressClass cluster - resource. If a class name is defined in both the `IngressClassName` - field and the `kubernetes.io/ingress.class` annotation, `IngressClassName` - field takes precedence. + description: |- + IngressClassName is the name of an IngressClass cluster resource. + If a class name is defined in both the `IngressClassName` field and the `kubernetes.io/ingress.class` annotation, + `IngressClassName` field takes precedence. type: string labels: additionalProperties: @@ -8110,10 +8249,10 @@ spec: route for OpenShift platform). type: object tlsSecretName: - description: The name of the secret used to set up Ingress TLS - termination. If the field is an empty string, the default cluster - certificate is used. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The name of the secret used to set up Ingress TLS termination. + If the field is an empty string, the default cluster certificate is used. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object type: object @@ -8147,10 +8286,10 @@ spec: the Che deployment is in the current phase. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either the - copy of the explicitly defined property of the same name in the - spec or, if it is undefined in the spec and we're running on OpenShift, - the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object type: object @@ -8158,9 +8297,3 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] diff --git a/deploy/deployment/kubernetes/combined.yaml b/deploy/deployment/kubernetes/combined.yaml index 6bff83e6d..c58a11aae 100644 --- a/deploy/deployment/kubernetes/combined.yaml +++ b/deploy/deployment/kubernetes/combined.yaml @@ -20,7 +20,7 @@ kind: CustomResourceDefinition metadata: annotations: cert-manager.io/inject-ca-from: eclipse-che/che-operator-serving-cert - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.14.0 labels: app.kubernetes.io/instance: che app.kubernetes.io/name: che @@ -56,53 +56,57 @@ spec: a Che server installation properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: - description: 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. + description: |- + 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. properties: auth: description: Configuration settings related to the Authentication used by the Che installation. properties: debug: - description: Deprecated. The value of this flag is ignored. Debug - internal identity provider. + description: |- + Deprecated. The value of this flag is ignored. + Debug internal identity provider. type: boolean externalIdentityProvider: - description: 'Deprecated. The value of this flag is ignored. 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`.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: boolean gatewayAuthenticationSidecarImage: - description: Gateway sidecar responsible for authentication when - NativeUserMode is enabled. See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] - or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. + description: |- + Gateway sidecar responsible for authentication when NativeUserMode is enabled. + See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. type: string gatewayAuthorizationSidecarImage: - description: Gateway sidecar responsible for authorization when - NativeUserMode is enabled. See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] - or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] + description: |- + Gateway sidecar responsible for authorization when NativeUserMode is enabled. + See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] type: string gatewayConfigBumpEnv: description: List of environment variables to set in the Configbump @@ -116,15 +120,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -137,9 +142,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -148,12 +154,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -166,11 +171,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -190,6 +195,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -199,9 +205,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -210,6 +217,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -227,15 +235,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -248,9 +257,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -259,12 +269,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -277,11 +286,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -301,6 +310,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -310,9 +320,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -321,6 +332,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -342,15 +354,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -363,9 +376,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -374,12 +388,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -392,11 +405,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -416,6 +429,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -425,9 +439,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -436,6 +451,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -453,15 +469,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -474,9 +491,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -485,12 +503,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -503,11 +520,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -527,6 +544,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -536,9 +554,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -547,27 +566,28 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array identityProviderAdminUserName: - description: Deprecated. The value of this flag is ignored. Overrides - the name of the Identity Provider administrator user. Defaults - to `admin`. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the name of the Identity Provider administrator user. Defaults to `admin`. type: string identityProviderClientId: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string identityProviderContainerResources: - description: Deprecated. The value of this flag is ignored. Identity - provider container custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Identity provider container custom settings. properties: limits: description: Limits describes the maximum amount of compute @@ -595,21 +615,21 @@ spec: type: object type: object identityProviderImage: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderImagePullPolicy: - description: Deprecated. The value of this flag is ignored. Overrides - the image pull policy used in the Identity Provider, Keycloak - or RH-SSO, deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the image pull policy used in the Identity Provider, Keycloak or RH-SSO, deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string identityProviderIngress: - description: Deprecated. The value of this flag is ignored. Ingress - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Ingress custom settings. properties: annotations: additionalProperties: @@ -624,42 +644,39 @@ spec: type: string type: object identityProviderPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. - The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderRealm: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderRoute: - description: Deprecated. The value of this flag is ignored. Route - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Route custom settings. properties: annotations: additionalProperties: @@ -669,10 +686,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -680,49 +697,43 @@ spec: type: string type: object identityProviderSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderURL: - description: 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. + description: |- + 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. type: string identityToken: - description: 'Identity token to be passed to upstream. There are - two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che installations - made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string initialOpenShiftOAuthUser: - description: Deprecated. The value of this flag is ignored. 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 - in 'openshift-config' namespace by Operator. Note that this - solution is Openshift 4 platform-specific. + description: |- + Deprecated. The value of this flag is ignored. + 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 in 'openshift-config' namespace by Operator. + Note that this solution is Openshift 4 platform-specific. type: boolean nativeUserMode: - description: Deprecated. The value of this flag is ignored. Enables - native user mode. Currently works only on OpenShift and DevWorkspace - engine. Native User mode uses OpenShift OAuth directly as identity - provider, without Keycloak. + description: |- + Deprecated. The value of this flag is ignored. + Enables native user mode. Currently works only on OpenShift and DevWorkspace engine. + Native User mode uses OpenShift OAuth directly as identity provider, without Keycloak. type: boolean oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used @@ -730,8 +741,9 @@ spec: when left blank. See also the `OpenShiftoAuth` field. type: string oAuthScope: - description: Access Token Scope. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` @@ -740,19 +752,17 @@ spec: field. type: string openShiftoAuth: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean updateAdminPassword: - description: Deprecated. The value of this flag is ignored. Forces - the default `admin` Che user to update password on first login. - Defaults to `false`. + description: |- + Deprecated. The value of this flag is ignored. + Forces the default `admin` Che user to update password on first login. Defaults to `false`. type: boolean type: object dashboard: @@ -801,9 +811,9 @@ spec: to connect to the DB. Defaults to `dbche`. type: string chePostgresHostName: - description: 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`. + description: |- + 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. type: string chePostgresPassword: @@ -812,35 +822,29 @@ spec: automatically generated value. type: string chePostgresPort: - description: 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. + description: |- + 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. type: string chePostgresSecret: - description: '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 `postgres-credentials` will - be created with default value of `pgche` for `user` and with - an auto-generated value for `password`. The secret must have - `app.kubernetes.io/part-of=che.eclipse.org` label.' + description: |- + 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 `postgres-credentials` + will be created with default value of `pgche` for `user` and with an auto-generated value for `password`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string chePostgresUser: description: PostgreSQL user that the Che server uses to connect to the DB. Defaults to `pgche`. type: string externalDb: - description: '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`.' + description: |- + 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`. type: boolean postgresEnv: description: List of environment variables to set in the PostgreSQL @@ -854,15 +858,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -875,9 +880,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -886,12 +892,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -904,11 +909,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -928,6 +933,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -937,9 +943,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -948,6 +955,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -965,30 +973,29 @@ spec: `next` or `latest` images, and `IfNotPresent` in other cases. type: string postgresVersion: - description: 'Indicates a PostgreSQL version image to use. Allowed - values are: `9.6` and `13.3`. Migrate your PostgreSQL database - to switch from one version to another.' + description: |- + Indicates a PostgreSQL version image to use. Allowed values are: `9.6` and `13.3`. + Migrate your PostgreSQL database to switch from one version to another. type: string pvcClaimSize: - description: Size of the persistent volume claim for database. - Defaults to `1Gi`. To update pvc storageclass that provisions - it must support resize when Eclipse Che has been already deployed. + description: |- + Size of the persistent volume claim for database. Defaults to `1Gi`. + To update pvc storageclass that provisions it must support resize when Eclipse Che has been already deployed. type: string type: object devWorkspace: description: DevWorkspace operator configuration properties: controllerImage: - description: Overrides the container image used in the DevWorkspace - controller deployment. This includes the image tag. Omit it - or leave it empty to use the default container image provided - by the Operator. + description: |- + Overrides the container image used in the DevWorkspace controller deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string enable: - description: 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. + description: |- + 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. type: boolean env: description: List of environment variables to set in the DevWorkspace @@ -1002,15 +1009,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1023,9 +1031,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1034,12 +1043,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1052,11 +1060,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1076,6 +1084,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1085,9 +1094,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1096,6 +1106,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1106,17 +1117,18 @@ spec: type: string secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer required: @@ -1134,15 +1146,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -1156,14 +1169,15 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -1177,14 +1191,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -1195,17 +1210,15 @@ spec: description: Kubernetes Image Puller configuration properties: enable: - description: 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. If the `spec.images` - field is empty, a set of recommended workspace-related images - will be automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + 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. + If the `spec.images` field is empty, a set of recommended workspace-related images will be automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A KubernetesImagePullerSpec to configure the image @@ -1246,24 +1259,21 @@ spec: made on upstream Kubernetes. properties: ingressClass: - description: '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.' + description: |- + 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. type: string ingressDomain: description: 'Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string securityContextFsGroup: description: The FSGroup in which the Che Pod and workspace Pods @@ -1274,22 +1284,17 @@ spec: run as. Default value is `1724`. type: string singleHostExposureType: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string tlsSecretName: - description: 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. + description: |- + 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. type: string type: object metrics: @@ -1306,73 +1311,69 @@ spec: the plugin and devfile registries properties: airGapContainerRegistryHostname: - description: 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. + description: |- + 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. type: string airGapContainerRegistryOrganization: - description: 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. + description: |- + 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. type: string allowAutoProvisionUserNamespace: - description: Indicates if is allowed to automatically create a - user namespace. If it set to false, then user namespace must - be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean allowUserDefinedWorkspaceNamespaces: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean cheClusterRoles: - description: A comma-separated list of ClusterRoles that will - be assigned to Che ServiceAccount. Each role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. Be aware that the Che Operator has to already have all - permissions in these ClusterRoles to grant them. + description: |- + A comma-separated list of ClusterRoles that will be assigned to Che ServiceAccount. + Each role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + Be aware that the Che Operator has to already have all permissions in these ClusterRoles to grant them. type: string cheDebug: description: Enables the debug mode for Che server. Defaults to `false`. type: string cheFlavor: - description: Deprecated. The value of this flag is ignored. Specifies - a variation of the installation. The options are `che` for - upstream Che installations or `devspaces` for Red Hat OpenShift - Dev Spaces (formerly Red Hat CodeReady Workspaces) installation + description: |- + Deprecated. The value of this flag is ignored. + Specifies a variation of the installation. The options are `che` for upstream Che installations or + `devspaces` for Red Hat OpenShift Dev Spaces (formerly Red Hat CodeReady Workspaces) installation type: string cheHost: - description: 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. + description: |- + 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. type: string cheHostTLSSecret: - description: Name of a secret containing certificates to secure - ingress or route for the custom host name of the installed Che - server. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. See the `cheHost` field. + description: |- + Name of a secret containing certificates to secure ingress or route for the custom host name of the installed Che server. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. + See the `cheHost` field. type: string cheImage: - description: 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. + description: |- + 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. type: string cheImagePullPolicy: - description: Overrides the image pull policy used in Che deployment. - Default value is `Always` for `nightly`, `next` or `latest` - images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in Che deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string cheImageTag: - description: 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. + description: |- + 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. type: string cheLogLevel: description: 'Log level for the Che server: `INFO` or `DEBUG`. @@ -1390,15 +1391,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1411,9 +1413,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1422,12 +1425,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1440,11 +1442,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1464,6 +1466,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1473,9 +1476,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1484,6 +1488,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1515,10 +1520,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1526,27 +1531,28 @@ spec: type: string type: object cheWorkspaceClusterRole: - description: Custom cluster role bound to the user for the Che - workspaces. The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. The default roles are used when omitted or left blank. + description: |- + Custom cluster role bound to the user for the Che workspaces. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string - description: 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. + description: |- + 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. type: object dashboardCpuLimit: - description: Overrides the CPU limit used in the dashboard deployment. + description: |- + Overrides the CPU limit used in the dashboard deployment. In cores. (500m = .5 cores). Default to 500m. type: string dashboardCpuRequest: - description: Overrides the CPU request used in the dashboard deployment. + description: |- + Overrides the CPU request used in the dashboard deployment. In cores. (500m = .5 cores). Default to 100m. type: string dashboardEnv: @@ -1561,15 +1567,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1582,9 +1589,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1593,12 +1601,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1611,11 +1618,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1635,6 +1642,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1644,9 +1652,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1655,24 +1664,26 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array dashboardImage: - description: Overrides the container image used in the dashboard - deployment. This includes the image tag. Omit it or leave it - empty to use the default container image provided by the Operator. + description: |- + Overrides the container image used in the dashboard deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string dashboardImagePullPolicy: - description: Overrides the image pull policy used in the dashboard - deployment. Default value is `Always` for `nightly`, `next` - or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the dashboard deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string dashboardIngress: - description: Deprecated. The value of this flag is ignored. Dashboard - ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard ingress custom settings. properties: annotations: additionalProperties: @@ -1695,8 +1706,9 @@ spec: deployment. Defaults to 16Mi. type: string dashboardRoute: - description: Deprecated. The value of this flag is ignored. Dashboard - route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard route custom settings. properties: annotations: additionalProperties: @@ -1706,10 +1718,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1717,12 +1729,14 @@ spec: type: string type: object devfileRegistryCpuLimit: - description: Overrides the CPU limit used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string devfileRegistryCpuRequest: - description: Overrides the CPU request used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string devfileRegistryEnv: description: List of environment variables to set in the plugin @@ -1736,15 +1750,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1757,9 +1772,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1768,12 +1784,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1786,11 +1801,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1810,6 +1825,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1819,9 +1835,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1830,20 +1847,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array devfileRegistryImage: - description: 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. + description: |- + 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. type: string devfileRegistryIngress: - description: Deprecated. The value of this flag is ignored. The - devfile registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry ingress custom settings. properties: annotations: additionalProperties: @@ -1866,13 +1884,14 @@ spec: registry deployment. Defaults to 16Mi. type: string devfileRegistryPullPolicy: - description: Overrides the image pull policy used in the devfile - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the devfile registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string devfileRegistryRoute: - description: Deprecated. The value of this flag is ignored. The - devfile registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry route custom settings. properties: annotations: additionalProperties: @@ -1882,10 +1901,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1897,14 +1916,14 @@ spec: fields. type: string disableInternalClusterSVCNames: - description: Deprecated. The value of this flag is ignored. Disable - internal cluster SVC names usage to communicate between components - to speed up the traffic and avoid proxy issues. + description: |- + Deprecated. The value of this flag is ignored. + Disable internal cluster SVC names usage to communicate between components to speed up the traffic and avoid proxy issues. type: boolean externalDevfileRegistries: - description: External devfile registries, that serves sample, - ready-to-use devfiles. Configure this in addition to a dedicated - devfile registry (when `externalDevfileRegistry` is `false`) + description: |- + External devfile registries, that serves sample, ready-to-use devfiles. + Configure this in addition to a dedicated devfile registry (when `externalDevfileRegistry` is `false`) or instead of it (when `externalDevfileRegistry` is `true`) items: description: Settings for a configuration of the external devfile @@ -1916,50 +1935,44 @@ spec: type: object type: array externalDevfileRegistry: - description: 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 - configure at least one devfile registry with `externalDevfileRegistries` - field. + description: |- + 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 configure at least one + devfile registry with `externalDevfileRegistries` field. type: boolean externalPluginRegistry: - description: 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. + description: |- + 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. type: boolean gitSelfSignedCert: - description: When enabled, the certificate from `che-git-self-signed-cert` - ConfigMap will be propagated to the Che components and provide - particular configuration for Git. Note, the `che-git-self-signed-cert` - ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + When enabled, the certificate from `che-git-self-signed-cert` ConfigMap will be propagated to the Che components and provide particular configuration for Git. + Note, the `che-git-self-signed-cert` ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: boolean nonProxyHosts: - description: 'List of hosts that will be reached directly, bypassing - the proxy. Specify wild card domain use the following form `.` - 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.' + description: |- + List of hosts that will be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.` 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. type: string openVSXRegistryURL: description: Open VSX registry URL. If omitted an embedded instance will be used. type: string pluginRegistryCpuLimit: - description: Overrides the CPU limit used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string pluginRegistryCpuRequest: - description: Overrides the CPU request used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string pluginRegistryEnv: description: List of environment variables to set in the devfile @@ -1973,15 +1986,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1994,9 +2008,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -2005,12 +2020,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -2023,11 +2037,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -2047,6 +2061,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -2056,9 +2071,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -2067,20 +2083,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array pluginRegistryImage: - description: 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. + description: |- + 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. type: string pluginRegistryIngress: - description: Deprecated. The value of this flag is ignored. Plugin - registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry ingress custom settings. properties: annotations: additionalProperties: @@ -2103,13 +2120,14 @@ spec: deployment. Defaults to 16Mi. type: string pluginRegistryPullPolicy: - description: Overrides the image pull policy used in the plugin - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the plugin registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string pluginRegistryRoute: - description: Deprecated. The value of this flag is ignored. Plugin - registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry route custom settings. properties: annotations: additionalProperties: @@ -2119,10 +2137,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -2130,16 +2148,15 @@ spec: type: string type: object pluginRegistryUrl: - description: 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. + description: |- + 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. type: string proxyPassword: - description: Password of the proxy server. Only use when proxy - configuration is required. See the `proxyURL`, `proxyUser` and - `proxySecret` fields. + description: |- + Password of the proxy server. + Only use when proxy configuration is required. See the `proxyURL`, `proxyUser` and `proxySecret` fields. type: string proxyPort: description: Port of the proxy server. Only use when configuring @@ -2147,22 +2164,18 @@ spec: fields. type: string proxySecret: - description: The secret that contains `user` and `password` for - a proxy server. When the secret is defined, the `proxyUser` - and `proxyPassword` are ignored. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The secret that contains `user` and `password` for a proxy server. When the secret is defined, the `proxyUser` and `proxyPassword` are ignored. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string proxyURL: - description: 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. + description: |- + 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. type: string proxyUser: description: User name of the proxy server. Only use when configuring @@ -2170,31 +2183,29 @@ spec: and `proxySecret` fields. type: string selfSignedCert: - description: 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. + description: |- + 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. type: boolean serverCpuLimit: - description: Overrides the CPU limit used in the Che server deployment + description: |- + Overrides the CPU limit used in the Che server deployment In cores. (500m = .5 cores). Default to 1. type: string serverCpuRequest: - description: Overrides the CPU request used in the Che server - deployment In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the Che server deployment + In cores. (500m = .5 cores). Default to 100m. type: string serverExposureStrategy: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string serverMemoryLimit: description: Overrides the memory limit used in the Che server @@ -2205,13 +2216,11 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: 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. - The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + 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. + The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string singleHostGatewayConfigMapLabels: additionalProperties: @@ -2238,9 +2247,9 @@ spec: description: Deprecated in favor of `disableInternalClusterSVCNames`. type: boolean workspaceDefaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile does - not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile does not contain any components. items: properties: attributes: @@ -2279,20 +2288,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -2301,10 +2310,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -2316,28 +2327,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2352,24 +2374,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2379,15 +2408,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2395,10 +2423,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -2417,17 +2452,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -2437,18 +2474,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -2458,19 +2494,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -2483,8 +2520,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -2504,18 +2544,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -2534,32 +2571,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -2569,9 +2606,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -2587,14 +2624,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2606,28 +2646,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2642,24 +2693,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2669,15 +2727,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2698,22 +2755,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2725,28 +2785,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2761,24 +2832,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2788,15 +2866,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2817,32 +2894,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -2868,9 +2949,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -2886,9 +2967,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -2916,9 +2997,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -2930,23 +3011,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -2977,40 +3061,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -3019,9 +3103,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -3060,21 +3144,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -3083,10 +3166,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -3099,31 +3184,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3137,29 +3229,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3169,27 +3263,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -3207,18 +3305,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -3228,20 +3326,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -3253,9 +3348,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -3277,21 +3374,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -3310,34 +3401,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -3347,10 +3434,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -3365,16 +3451,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3387,31 +3474,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3425,29 +3519,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3457,17 +3553,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3488,24 +3581,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3518,31 +3612,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3556,29 +3657,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3588,17 +3691,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3619,13 +3719,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3658,34 +3759,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3697,16 +3798,16 @@ spec: type: array workspaceDefaultEditor: default: che-incubator/che-code/latest - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/plugin/version`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/plugin/version`. The URI must start from `http`. type: string workspaceNamespaceDefault: - description: 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 ``, `` and `` - placeholders, such as che-workspace-. In that case, - a new namespace will be created for each user or workspace. + description: |- + 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 ``, `` and `` placeholders, such as che-workspace-. + In that case, a new namespace will be created for each user or workspace. type: string workspacePodNodeSelector: additionalProperties: @@ -3718,41 +3819,39 @@ spec: description: The pod tolerations put on the workspace pods to limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -3789,26 +3888,23 @@ spec: storage class is used. type: string preCreateSubPaths: - description: 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. + description: |- + 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. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. Defaults to `10Gi`. type: string pvcJobsImage: - description: 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. + description: |- + 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. type: string pvcStrategy: - description: 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`. + description: |- + 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`. type: string workspacePVCStorageClassName: description: Storage class for the Persistent Volume Claims dedicated @@ -3841,15 +3937,14 @@ spec: description: The status of the Devworkspace subsystem properties: gatewayHost: - description: GatewayHost is the resolved host of the ingress/route. - This is equal to the Host in the spec on Kubernetes but contains - the actual host name of the route if Host is unspecified on - OpenShift. + description: |- + GatewayHost is the resolved host of the ingress/route. This is equal to the Host in the spec + on Kubernetes but contains the actual host name of the route if Host is unspecified on OpenShift. type: string gatewayPhase: - description: GatewayPhase specifies the phase in which the gateway - deployment currently is. If the gateway is disabled, the phase - is "Inactive". + description: |- + GatewayPhase specifies the phase in which the gateway deployment currently is. + If the gateway is disabled, the phase is "Inactive". type: string message: description: Message contains further human-readable info for @@ -3864,10 +3959,10 @@ spec: why the Che cluster is in this state. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either - the copy of the explicitly defined property of the same name - in the spec or, if it is undefined in the spec and we're running - on OpenShift, the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object gitHubOAuthProvisioned: @@ -3918,22 +4013,26 @@ spec: - name: v2 schema: openAPIV3Schema: - description: 'The `CheCluster` custom resource allows defining and managing - Eclipse Che server installation. Based on these settings, the Operator - automatically creates and maintains several ConfigMaps: `che`, `plugin-registry`, - `devfile-registry` that will contain the appropriate environment variables - of the various components of the installation. These generated ConfigMaps - must NOT be updated manually.' + description: |- + The `CheCluster` custom resource allows defining and managing Eclipse Che server installation. + Based on these settings, the Operator automatically creates and maintains several ConfigMaps: + `che`, `plugin-registry`, `devfile-registry` that will contain the appropriate environment variables + of the various components of the installation. These generated ConfigMaps must NOT be updated manually. properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object @@ -3957,14 +4056,15 @@ spec: server. properties: clusterRoles: - description: 'Additional ClusterRoles assigned to Che ServiceAccount. - Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. The defaults roles are: - `-cheworkspaces-clusterrole` + description: |- + Additional ClusterRoles assigned to Che ServiceAccount. + Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` label. + The defaults roles are: + - `-cheworkspaces-clusterrole` - `-cheworkspaces-namespaces-clusterrole` - `-cheworkspaces-devworkspace-clusterrole` - where the is the namespace where the CheCluster - CR is created. The Che Operator must already have all permissions - in these ClusterRoles to grant them.' + where the is the namespace where the CheCluster CR is created. + The Che Operator must already have all permissions in these ClusterRoles to grant them. items: type: string type: array @@ -3992,18 +4092,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4016,10 +4114,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4028,12 +4126,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4047,13 +4144,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4075,6 +4170,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4085,10 +4181,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4097,6 +4193,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4131,23 +4228,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4159,23 +4253,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4201,13 +4292,11 @@ spec: extraProperties: additionalProperties: type: string - description: A map of additional environment variables 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). If the `extraProperties` - field contains a property normally generated in `che` ConfigMap - from other CR fields, the value defined in the `extraProperties` - is used instead. + description: |- + A map of additional environment variables 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). + If the `extraProperties` field contains a property normally generated in `che` ConfigMap from other CR fields, + the value defined in the `extraProperties` is used instead. type: object logLevel: default: INFO @@ -4215,27 +4304,25 @@ spec: `DEBUG`.' type: string proxy: - description: Proxy server settings for Kubernetes cluster. - No additional configuration is required for OpenShift cluster. - By specifying these settings for the OpenShift cluster, - you override the OpenShift proxy configuration. + description: |- + Proxy server settings for Kubernetes cluster. No additional configuration is required for OpenShift cluster. + By specifying these settings for the OpenShift cluster, you override the OpenShift proxy configuration. properties: credentialsSecretName: - description: The secret name that contains `user` and - `password` for a proxy server. The secret must have - a `app.kubernetes.io/part-of=che.eclipse.org` label. + description: |- + The secret name that contains `user` and `password` for a proxy server. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string nonProxyHosts: - description: 'A list of hosts that can be reached directly, - bypassing the proxy. Specify wild card domain use the - following form `.`, for example: - localhost - - my.host.com - 123.42.12.32 Use only when a proxy - configuration is required. The Operator respects OpenShift - cluster-wide proxy configuration, defining `nonProxyHosts` - in a custom resource leads to merging non-proxy hosts - lists from the cluster proxy configuration, and the - ones defined in the custom resources. See the following - page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + A list of hosts that can be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.`, for example: + - localhost + - my.host.com + - 123.42.12.32 + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `nonProxyHosts` in a custom resource leads to merging non-proxy hosts lists from the cluster proxy configuration, and the ones defined in the custom resources. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. items: type: string type: array @@ -4243,12 +4330,11 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. - Use only when a proxy configuration is required. The - Operator respects OpenShift cluster-wide proxy configuration, - defining `url` in a custom resource leads to overriding - the cluster proxy configuration. See the following page: - https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + URL (protocol+hostname) of the proxy server. + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `url` in a custom resource leads to overriding the cluster proxy configuration. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. type: string type: object type: object @@ -4291,18 +4377,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4315,10 +4399,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4327,12 +4411,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4346,13 +4429,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4374,6 +4455,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4384,10 +4466,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4396,6 +4478,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4430,23 +4513,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4458,23 +4538,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4524,7 +4601,8 @@ spec: description: DevWorkspace Operator configuration. properties: runningLimit: - description: Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` + description: |- + Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` The maximum number of running workspaces per user. type: string type: object @@ -4552,18 +4630,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4576,10 +4652,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4588,12 +4664,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4607,13 +4682,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4635,6 +4708,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4645,10 +4719,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4657,6 +4731,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4691,23 +4766,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4719,23 +4791,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4778,18 +4847,15 @@ spec: description: Kubernetes Image Puller configuration. properties: enable: - description: Install and configure the community supported - Kubernetes Image Puller Operator. When you set the value - to `true` without providing any specs, it creates a default - Kubernetes Image Puller object managed by the Operator. - When you set the value to `false`, the Kubernetes Image - Puller object is deleted, and the Operator uninstalled, - regardless of whether a spec is provided. If you leave the - `spec.images` field empty, a set of recommended workspace-related - images is automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + Install and configure the community supported Kubernetes Image Puller Operator. When you set the value to `true` without providing any specs, + it creates a default Kubernetes Image Puller object managed by the Operator. + When you set the value to `false`, the Kubernetes Image Puller object is deleted, and the Operator uninstalled, + regardless of whether a spec is provided. + If you leave the `spec.images` field empty, a set of recommended workspace-related images is automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A Kubernetes Image Puller spec to configure the @@ -4857,18 +4923,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4881,10 +4945,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4893,12 +4957,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4912,13 +4975,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4940,6 +5001,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4950,10 +5012,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4962,6 +5024,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4996,23 +5059,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5024,23 +5084,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5087,18 +5144,16 @@ spec: Che images. properties: hostname: - description: An optional hostname or URL of an alternative container - registry to pull images from. This value overrides the container - registry hostname defined in all the default container images - involved in a Che deployment. This is particularly useful for - installing Che in a restricted environment. + description: |- + An optional hostname or URL of an alternative container registry to pull images from. + This value overrides the container registry hostname defined in all the default container images involved in a Che deployment. + This is particularly useful for installing Che in a restricted environment. type: string organization: - description: An optional repository name of an alternative 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 for installing - Eclipse Che in a restricted environment. + description: |- + An optional repository name of an alternative 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 for installing Eclipse Che in a restricted environment. type: string type: object devEnvironments: @@ -5124,9 +5179,9 @@ spec: type: string type: object defaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile, that - does not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile, that does not contain any components. items: properties: attributes: @@ -5165,20 +5220,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5187,10 +5242,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5202,28 +5259,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5238,24 +5306,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5265,15 +5340,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5281,10 +5355,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -5303,17 +5384,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -5323,18 +5406,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -5344,19 +5426,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -5369,8 +5452,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -5390,18 +5476,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -5420,32 +5503,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -5455,9 +5538,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -5473,14 +5556,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5492,28 +5578,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5528,24 +5625,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5555,15 +5659,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5584,22 +5687,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5611,28 +5717,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5647,24 +5764,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5674,15 +5798,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5703,32 +5826,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -5754,9 +5881,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -5772,9 +5899,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -5802,9 +5929,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -5816,23 +5943,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -5863,40 +5993,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -5905,9 +6035,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -5946,21 +6076,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5969,10 +6098,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5985,31 +6116,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6023,29 +6161,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6055,27 +6195,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -6093,18 +6237,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -6114,20 +6258,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -6139,9 +6280,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -6163,21 +6306,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -6196,34 +6333,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -6233,10 +6366,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -6251,16 +6383,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6273,31 +6406,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6311,29 +6451,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6343,17 +6485,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6374,24 +6513,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6404,31 +6544,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6442,29 +6589,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6474,17 +6623,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6505,13 +6651,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6544,34 +6691,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6582,9 +6729,10 @@ spec: type: object type: array defaultEditor: - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/name/version` - format. The URI must start from `http://` or `https://`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/name/version` format. + The URI must start from `http://` or `https://`. type: string defaultNamespace: default: @@ -6594,16 +6742,15 @@ spec: properties: autoProvision: default: true - description: Indicates if is allowed to automatically create - a user namespace. If it set to false, then user namespace - must be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean template: default: -che - description: If you don't create the user namespaces in advance, - this field defines the Kubernetes namespace created when - you start your first workspace. You can use `` - and `` placeholders, such as che-workspace-. + description: |- + If you don't create the user namespaces in advance, this field defines the Kubernetes namespace created when you start your first workspace. + You can use `` and `` placeholders, such as che-workspace-. pattern: | type: string type: object @@ -6612,7 +6759,8 @@ spec: items: properties: editor: - description: The editor ID to specify default plug-ins for. + description: |- + The editor ID to specify default plug-ins for. The plugin ID must have `publisher/name/version` format. type: string plugins: @@ -6623,25 +6771,30 @@ spec: type: object type: array deploymentStrategy: - description: DeploymentStrategy defines the deployment strategy - to use to replace existing workspace pods with new ones. The - available deployment stragies are `Recreate` and `RollingUpdate`. - With the `Recreate` deployment strategy, the existing workspace - pod is killed before the new one is created. With the `RollingUpdate` - deployment strategy, a new workspace pod is created and the - existing workspace pod is deleted only when the new workspace - pod is in a ready state. If not specified, the default `Recreate` - deployment strategy is used. + description: |- + DeploymentStrategy defines the deployment strategy to use to replace existing workspace pods + with new ones. The available deployment stragies are `Recreate` and `RollingUpdate`. + With the `Recreate` deployment strategy, the existing workspace pod is killed before the new one is created. + With the `RollingUpdate` deployment strategy, a new workspace pod is created and the existing workspace pod is deleted + only when the new workspace pod is in a ready state. + If not specified, the default `Recreate` deployment strategy is used. enum: - Recreate - RollingUpdate type: string disableContainerBuildCapabilities: - description: "Disables the container build capabilities. When - set to `false` (the default value), the devEnvironments.security.containerSecurityContext - field is ignored, and the following container SecurityContext - is applied: \n containerSecurityContext: allowPrivilegeEscalation: - true capabilities: add: - SETGID - SETUID" + description: |- + Disables the container build capabilities. + When set to `false` (the default value), the devEnvironments.security.containerSecurityContext + field is ignored, and the following container SecurityContext is applied: + + + containerSecurityContext: + allowPrivilegeEscalation: true + capabilities: + add: + - SETGID + - SETUID type: boolean gatewayContainer: description: GatewayContainer configuration. @@ -6657,16 +6810,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6679,10 +6832,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6691,12 +6844,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6709,12 +6861,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6734,6 +6885,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6743,10 +6895,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6755,6 +6907,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -6787,19 +6940,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6812,19 +6965,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6840,16 +6993,17 @@ spec: - Never type: string maxNumberOfRunningWorkspacesPerUser: - description: The maximum number of running workspaces per user. + description: |- + The maximum number of running workspaces per user. The value, -1, allows users to run an unlimited number of workspaces. format: int64 minimum: -1 type: integer maxNumberOfWorkspacesPerUser: default: -1 - description: Total number of workspaces, both stopped and running, - that a user can keep. The value, -1, allows users to keep an - unlimited number of workspaces. + description: |- + Total number of workspaces, both stopped and running, that a user can keep. + The value, -1, allows users to keep an unlimited number of workspaces. format: int64 minimum: -1 type: integer @@ -6860,19 +7014,22 @@ spec: workspace pods. type: object persistUserHome: - description: PersistUserHome defines configuration options for - persisting the user home directory in workspaces. + description: |- + PersistUserHome defines configuration options for persisting the + user home directory in workspaces. properties: enabled: - description: Determines whether the user home directory in - workspaces should persist between workspace shutdown and - startup. Must be used with the 'per-user' or 'per-workspace' - PVC strategy in order to take effect. Disabled by default. + description: |- + Determines whether the user home directory in workspaces should persist between + workspace shutdown and startup. + Must be used with the 'per-user' or 'per-workspace' PVC strategy in order to take effect. + Disabled by default. type: boolean type: object podSchedulerName: - description: Pod scheduler for the workspace pods. If not specified, - the pod scheduler is set to the default scheduler on the cluster. + description: |- + Pod scheduler for the workspace pods. + If not specified, the pod scheduler is set to the default scheduler on the cluster. type: string projectCloneContainer: description: Project clone container configuration. @@ -6888,16 +7045,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6910,10 +7067,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6922,12 +7079,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6940,12 +7096,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6965,6 +7120,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6974,10 +7130,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6986,6 +7142,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7018,19 +7175,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7043,19 +7200,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7064,42 +7221,44 @@ spec: type: object secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer security: description: Workspace security configuration. properties: containerSecurityContext: - description: Container SecurityContext used by all workspace-related - containers. If set, defined values are merged into the default - Container SecurityContext configuration. Requires devEnvironments.disableContainerBuildCapabilities - to be set to `true` in order to take effect. + description: |- + Container SecurityContext used by all workspace-related containers. + If set, defined values are merged into the default Container SecurityContext configuration. + Requires devEnvironments.disableContainerBuildCapabilities to be set to `true` in order to take effect. properties: allowPrivilegeEscalation: - description: 'AllowPrivilegeEscalation controls whether - a process can gain more privileges than its parent process. - This bool directly controls if the no_new_privs flag - will be set on the container process. AllowPrivilegeEscalation - is true always when the container is: 1) run as Privileged - 2) has CAP_SYS_ADMIN Note that this field cannot be - set when spec.os.name is windows.' + description: |- + AllowPrivilegeEscalation controls whether a process can gain more + privileges than its parent process. This bool directly controls if + the no_new_privs flag will be set on the container process. + AllowPrivilegeEscalation is true always when the container is: + 1) run as Privileged + 2) has CAP_SYS_ADMIN + Note that this field cannot be set when spec.os.name is windows. type: boolean capabilities: - description: The capabilities to add/drop when running - containers. Defaults to the default set of capabilities - granted by the container runtime. Note that this field - cannot be set when spec.os.name is windows. + description: |- + The capabilities to add/drop when running containers. + Defaults to the default set of capabilities granted by the container runtime. + Note that this field cannot be set when spec.os.name is windows. properties: add: description: Added capabilities @@ -7117,61 +7276,60 @@ spec: type: array type: object privileged: - description: Run container in privileged mode. Processes - in privileged containers are essentially equivalent - to root on the host. Defaults to false. Note that this - field cannot be set when spec.os.name is windows. + description: |- + Run container in privileged mode. + Processes in privileged containers are essentially equivalent to root on the host. + Defaults to false. + Note that this field cannot be set when spec.os.name is windows. type: boolean procMount: - description: procMount denotes the type of proc mount - to use for the containers. The default is DefaultProcMount - which uses the container runtime defaults for readonly - paths and masked paths. This requires the ProcMountType - feature flag to be enabled. Note that this field cannot - be set when spec.os.name is windows. + description: |- + procMount denotes the type of proc mount to use for the containers. + The default is DefaultProcMount which uses the container runtime defaults for + readonly paths and masked paths. + This requires the ProcMountType feature flag to be enabled. + Note that this field cannot be set when spec.os.name is windows. type: string readOnlyRootFilesystem: - description: Whether this container has a read-only root - filesystem. Default is false. Note that this field cannot - be set when spec.os.name is windows. + description: |- + Whether this container has a read-only root filesystem. + Default is false. + Note that this field cannot be set when spec.os.name is windows. type: boolean runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to the - container. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The SELinux context to be applied to the container. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7191,137 +7349,135 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by this container. - If seccomp options are provided at both the pod & container - level, the container options override the pod options. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The seccomp options to use by this container. If seccomp options are + provided at both the pod & container level, the container options + override the pod options. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options from the - PodSecurityContext will be used. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options from the PodSecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object podSecurityContext: - description: PodSecurityContext used by all workspace-related - pods. If set, defined values are merged into the default - PodSecurityContext configuration. + description: |- + PodSecurityContext used by all workspace-related pods. + If set, defined values are merged into the default PodSecurityContext configuration. properties: fsGroup: - description: "A special supplemental group that applies - to all containers in a pod. Some volume types allow - the Kubelet to change the ownership of that volume to - be owned by the pod: \n 1. The owning GID will be the - FSGroup 2. The setgid bit is set (new files created - in the volume will be owned by FSGroup) 3. The permission - will not modify the ownership and permissions of any - volume. Note that this field cannot be set when spec.os.name - is windows." + description: |- + A special supplemental group that applies to all containers in a pod. + Some volume types allow the Kubelet to change the ownership of that volume + to be owned by the pod: + + + 1. The owning GID will be the FSGroup + 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) + + + If unset, the Kubelet will not modify the ownership and permissions of any volume. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer fsGroupChangePolicy: - description: 'fsGroupChangePolicy defines behavior of - changing ownership and permission of the volume before - being exposed inside Pod. This field will only apply - to volume types which support fsGroup based ownership(and - permissions). It will have no effect on ephemeral volume - types such as: secret, configmaps and emptydir. Valid - values are "OnRootMismatch" and "Always". If not specified, - "Always" is used. Note that this field cannot be set - when spec.os.name is windows.' + description: |- + fsGroupChangePolicy defines behavior of changing ownership and permission of the volume + before being exposed inside Pod. This field will only apply to + volume types which support fsGroup based ownership(and permissions). + It will have no effect on ephemeral volume types such as: secret, configmaps + and emptydir. + Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + Note that this field cannot be set when spec.os.name is windows. type: string runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in SecurityContext. If set - in both SecurityContext and PodSecurityContext, the - value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in SecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence - for that container. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to all - containers. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The SELinux context to be applied to all containers. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in SecurityContext. If set in + both SecurityContext and PodSecurityContext, the value specified in SecurityContext + takes precedence for that container. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7341,49 +7497,48 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by the containers - in this pod. Note that this field cannot be set when - spec.os.name is windows. + description: |- + The seccomp options to use by the containers in this pod. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object supplementalGroups: - description: A list of groups applied to the first process - run in each container, in addition to the container's - primary GID, the fsGroup (if specified), and group memberships - defined in the container image for the uid of the container - process. If unspecified, no additional groups are added - to any container. Note that group memberships defined - in the container image for the uid of the container - process are still effective, even if they are not included - in this list. Note that this field cannot be set when - spec.os.name is windows. + description: |- + A list of groups applied to the first process run in each container, in addition + to the container's primary GID, the fsGroup (if specified), and group memberships + defined in the container image for the uid of the container process. If unspecified, + no additional groups are added to any container. Note that group memberships + defined in the container image for the uid of the container process are still effective, + even if they are not included in this list. + Note that this field cannot be set when spec.os.name is windows. items: format: int64 type: integer type: array sysctls: - description: Sysctls hold a list of namespaced sysctls - used for the pod. Pods with unsupported sysctls (by - the container runtime) might fail to launch. Note that - this field cannot be set when spec.os.name is windows. + description: |- + Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported + sysctls (by the container runtime) might fail to launch. + Note that this field cannot be set when spec.os.name is windows. items: description: Sysctl defines a kernel parameter to be set @@ -7400,43 +7555,38 @@ spec: type: object type: array windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options within a - container's SecurityContext will be used. If set in - both SecurityContext and PodSecurityContext, the value - specified in SecurityContext takes precedence. Note - that this field cannot be set when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options within a container's SecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object @@ -7453,37 +7603,39 @@ spec: items: properties: audience: - description: Audience is the intended audience of the token. - A recipient of a token must identify itself with an identifier - specified in the audience of the token, and otherwise - should reject the token. The audience defaults to the + description: |- + Audience is the intended audience of the token. A recipient of a token + must identify itself with an identifier specified in the audience of the + token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. type: string expirationSeconds: default: 3600 - description: ExpirationSeconds is the requested duration - of validity of the service account token. As the token - approaches expiration, the kubelet volume plugin will - proactively rotate the service account token. The kubelet - will start trying to rotate the token if the token is - older than 80 percent of its time to live or if the token - is older than 24 hours. Defaults to 1 hour and must be - at least 10 minutes. + description: |- + ExpirationSeconds is the requested duration of validity of the service + account token. As the token approaches expiration, the kubelet volume + plugin will proactively rotate the service account token. The kubelet will + start trying to rotate the token if the token is older than 80 percent of + its time to live or if the token is older than 24 hours. Defaults to 1 hour + and must be at least 10 minutes. format: int64 minimum: 600 type: integer mountPath: - description: Path within the workspace container at which - the token should be mounted. Must not contain ':'. + description: |- + Path within the workspace container at which the token should be mounted. Must + not contain ':'. type: string name: - description: Identifiable name of the ServiceAccount token. - If multiple ServiceAccount tokens use the same mount path, - a generic name will be used for the projected volume instead. + description: |- + Identifiable name of the ServiceAccount token. + If multiple ServiceAccount tokens use the same mount path, a generic name will be used + for the projected volume instead. type: string path: - description: Path is the path relative to the mount point - of the file to project the token into. + description: |- + Path is the path relative to the mount point of the file to project the + token into. type: string required: - mountPath @@ -7493,10 +7645,10 @@ spec: type: array startTimeoutSeconds: default: 300 - description: StartTimeoutSeconds determines the maximum duration - (in seconds) that a workspace can take to start before it is - automatically failed. If not specified, the default value of - 300 seconds (5 minutes) is used. + description: |- + StartTimeoutSeconds determines the maximum duration (in seconds) that a workspace can take to start + before it is automatically failed. + If not specified, the default value of 300 seconds (5 minutes) is used. format: int32 minimum: 1 type: integer @@ -7536,12 +7688,12 @@ spec: type: object pvcStrategy: default: per-user - description: 'Persistent volume claim strategy for the Che - server. The supported strategies are: `per-user` (all workspaces - PVCs in one volume), `per-workspace` (each workspace is - given its own individual PVC) and `ephemeral` (non-persistent - storage where local changes will be lost when the workspace - is stopped.)' + description: |- + Persistent volume claim strategy for the Che server. + The supported strategies are: `per-user` (all workspaces PVCs in one volume), + `per-workspace` (each workspace is given its own individual PVC) + and `ephemeral` (non-persistent storage where local changes will be lost when + the workspace is stopped.) enum: - common - per-user @@ -7553,41 +7705,39 @@ spec: description: The pod tolerations of the workspace pods limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -7595,20 +7745,19 @@ spec: description: Trusted certificate settings. properties: gitTrustedCertsConfigMapName: - description: 'The ConfigMap contains certificates to propagate - to the Che components and to provide a particular configuration - for Git. See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ - The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + The ConfigMap contains certificates to propagate to the Che components and to provide a particular configuration for Git. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ + The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object user: description: User configuration. properties: clusterRoles: - description: Additional ClusterRoles assigned to the user. - The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + Additional ClusterRoles assigned to the user. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. items: type: string type: array @@ -7626,9 +7775,9 @@ spec: hosted on Azure DevOps Service (dev.azure.com). properties: secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Azure DevOps Service Application ID and Client Secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services' + description: |- + Kubernetes secret, that contains Base64-encoded Azure DevOps Service Application ID and Client Secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services type: string required: - secretName @@ -7642,15 +7791,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -7664,19 +7814,21 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: disableSubdomainIsolation: - description: 'Disables subdomain isolation. Deprecated in - favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` - annotation. See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Disables subdomain isolation. + Deprecated in favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: boolean endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -7690,14 +7842,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -7716,10 +7869,13 @@ spec: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set for an Ingress - (a route for OpenShift platform). The defaults for kubernetes - platforms are: kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", nginx.ingress.kubernetes.io/proxy-connect-timeout: - "3600", nginx.ingress.kubernetes.io/ssl-redirect: "true"' + description: |- + Defines annotations which will be set for an Ingress (a route for OpenShift platform). + The defaults for kubernetes platforms are: + kubernetes.io/ingress.class: "nginx" + nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", + nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600", + nginx.ingress.kubernetes.io/ssl-redirect: "true" type: object auth: default: @@ -7730,15 +7886,12 @@ spec: description: Authentication settings. properties: advancedAuthorization: - description: Advance authorization settings. Determines which - users and groups are allowed to access Che. User is allowed - to access Che if he/she is either in the `allowUsers` list - or is member of group from `allowGroups` list and not in - neither the `denyUsers` list nor is member of group from - `denyGroups` list. If `allowUsers` and `allowGroups` are - empty, then all users are allowed to access Che. if `denyUsers` - and `denyGroups` are empty, then no users are denied to - access Che. + description: |- + Advance authorization settings. Determines which users and groups are allowed to access Che. + User is allowed to access Che if he/she is either in the `allowUsers` list or is member of group from `allowGroups` list + and not in neither the `denyUsers` list nor is member of group from `denyGroups` list. + If `allowUsers` and `allowGroups` are empty, then all users are allowed to access Che. + if `denyUsers` and `denyGroups` are empty, then no users are denied to access Che. properties: allowGroups: description: List of groups allowed to access Che (currently @@ -7779,10 +7932,13 @@ spec: description: Gateway configuration labels. type: object deployment: - description: 'Deployment override options. Since gateway - deployment consists of several containers, they must - be distinguished in the configuration by their names: - - `gateway` - `configbump` - `oauth-proxy` - `kube-rbac-proxy`' + description: |- + Deployment override options. + Since gateway deployment consists of several containers, they must be distinguished in the configuration by their names: + - `gateway` + - `configbump` + - `oauth-proxy` + - `kube-rbac-proxy` properties: containers: description: List of containers belonging to the pod. @@ -7801,19 +7957,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to - a single $, which allows for escaping - the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -7827,10 +7980,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7840,12 +7993,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -7860,13 +8012,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: @@ -7889,6 +8039,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -7899,10 +8050,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7911,6 +8062,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7945,23 +8097,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -7973,23 +8122,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -8064,25 +8210,24 @@ spec: description: Public URL of the Identity Provider server. type: string identityToken: - description: 'Identity token to be passed to upstream. There - are two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. enum: - id_token - access_token type: string oAuthAccessTokenInactivityTimeoutSeconds: - description: Inactivity timeout for tokens to set in the OpenShift - `OAuthClient` resource used to set up identity federation - on the OpenShift side. 0 means tokens for this client never - time out. + description: |- + Inactivity timeout for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means tokens for this client never time out. format: int32 type: integer oAuthAccessTokenMaxAgeSeconds: - description: Access token max age for tokens to set in the - OpenShift `OAuthClient` resource used to set up identity - federation on the OpenShift side. 0 means no expiration. + description: |- + Access token max age for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means no expiration. format: int32 type: integer oAuthClientName: @@ -8090,37 +8235,33 @@ spec: used to set up identity federation on the OpenShift side. type: string oAuthScope: - description: Access Token Scope. This field is specific to - Che installations made for Kubernetes only and ignored for - OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: - description: 'Name of the secret set in the OpenShift `OAuthClient` - resource used to set up identity federation on the OpenShift - side. For Kubernetes, this can either be the plain text - oAuthSecret value, or the name of a kubernetes secret which - contains a key `oAuthSecret` and the value is the secret. - NOTE: this secret must exist in the same namespace as the - `CheCluster` resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`.' + description: |- + Name of the secret set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + For Kubernetes, this can either be the plain text oAuthSecret value, or the name of a kubernetes secret which contains a + key `oAuthSecret` and the value is the secret. NOTE: this secret must exist in the same namespace as the `CheCluster` + resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`. type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the - domain to generate a hostname for the route. The generated hostname - follows this pattern: che-.. The - is the namespace where the CheCluster CRD is created. In conjunction - with labels, it creates a route served by a non-default Ingress - controller. For a Kubernetes cluster, it contains a global ingress - domain. There are no default values: you must specify them.' + description: |- + For an OpenShift cluster, the Operator uses the domain to generate a hostname for the route. + The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. + In conjunction with labels, it creates a route served by a non-default Ingress controller. + For a Kubernetes cluster, it contains a global ingress domain. There are no default values: you must specify them. type: string hostname: description: The public hostname of the installed Che server. type: string ingressClassName: - description: IngressClassName is the name of an IngressClass cluster - resource. If a class name is defined in both the `IngressClassName` - field and the `kubernetes.io/ingress.class` annotation, `IngressClassName` - field takes precedence. + description: |- + IngressClassName is the name of an IngressClass cluster resource. + If a class name is defined in both the `IngressClassName` field and the `kubernetes.io/ingress.class` annotation, + `IngressClassName` field takes precedence. type: string labels: additionalProperties: @@ -8129,10 +8270,10 @@ spec: route for OpenShift platform). type: object tlsSecretName: - description: The name of the secret used to set up Ingress TLS - termination. If the field is an empty string, the default cluster - certificate is used. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The name of the secret used to set up Ingress TLS termination. + If the field is an empty string, the default cluster certificate is used. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object type: object @@ -8166,10 +8307,10 @@ spec: the Che deployment is in the current phase. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either the - copy of the explicitly defined property of the same name in the - spec or, if it is undefined in the spec and we're running on OpenShift, - the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object type: object @@ -8177,12 +8318,6 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: v1 kind: ServiceAccount diff --git a/deploy/deployment/kubernetes/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml b/deploy/deployment/kubernetes/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml index 2814afb18..cec9a14d6 100644 --- a/deploy/deployment/kubernetes/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml +++ b/deploy/deployment/kubernetes/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml @@ -15,7 +15,7 @@ kind: CustomResourceDefinition metadata: annotations: cert-manager.io/inject-ca-from: eclipse-che/che-operator-serving-cert - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.14.0 labels: app.kubernetes.io/instance: che app.kubernetes.io/name: che @@ -51,53 +51,57 @@ spec: a Che server installation properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: - description: 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. + description: |- + 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. properties: auth: description: Configuration settings related to the Authentication used by the Che installation. properties: debug: - description: Deprecated. The value of this flag is ignored. Debug - internal identity provider. + description: |- + Deprecated. The value of this flag is ignored. + Debug internal identity provider. type: boolean externalIdentityProvider: - description: 'Deprecated. The value of this flag is ignored. 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`.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: boolean gatewayAuthenticationSidecarImage: - description: Gateway sidecar responsible for authentication when - NativeUserMode is enabled. See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] - or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. + description: |- + Gateway sidecar responsible for authentication when NativeUserMode is enabled. + See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. type: string gatewayAuthorizationSidecarImage: - description: Gateway sidecar responsible for authorization when - NativeUserMode is enabled. See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] - or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] + description: |- + Gateway sidecar responsible for authorization when NativeUserMode is enabled. + See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] type: string gatewayConfigBumpEnv: description: List of environment variables to set in the Configbump @@ -111,15 +115,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -132,9 +137,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -143,12 +149,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -161,11 +166,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -185,6 +190,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -194,9 +200,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -205,6 +212,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -222,15 +230,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -243,9 +252,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -254,12 +264,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -272,11 +281,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -296,6 +305,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -305,9 +315,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -316,6 +327,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -337,15 +349,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -358,9 +371,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -369,12 +383,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -387,11 +400,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -411,6 +424,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -420,9 +434,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -431,6 +446,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -448,15 +464,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -469,9 +486,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -480,12 +498,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -498,11 +515,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -522,6 +539,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -531,9 +549,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -542,27 +561,28 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array identityProviderAdminUserName: - description: Deprecated. The value of this flag is ignored. Overrides - the name of the Identity Provider administrator user. Defaults - to `admin`. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the name of the Identity Provider administrator user. Defaults to `admin`. type: string identityProviderClientId: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string identityProviderContainerResources: - description: Deprecated. The value of this flag is ignored. Identity - provider container custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Identity provider container custom settings. properties: limits: description: Limits describes the maximum amount of compute @@ -590,21 +610,21 @@ spec: type: object type: object identityProviderImage: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderImagePullPolicy: - description: Deprecated. The value of this flag is ignored. Overrides - the image pull policy used in the Identity Provider, Keycloak - or RH-SSO, deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the image pull policy used in the Identity Provider, Keycloak or RH-SSO, deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string identityProviderIngress: - description: Deprecated. The value of this flag is ignored. Ingress - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Ingress custom settings. properties: annotations: additionalProperties: @@ -619,42 +639,39 @@ spec: type: string type: object identityProviderPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. - The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderRealm: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderRoute: - description: Deprecated. The value of this flag is ignored. Route - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Route custom settings. properties: annotations: additionalProperties: @@ -664,10 +681,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -675,49 +692,43 @@ spec: type: string type: object identityProviderSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderURL: - description: 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. + description: |- + 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. type: string identityToken: - description: 'Identity token to be passed to upstream. There are - two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che installations - made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string initialOpenShiftOAuthUser: - description: Deprecated. The value of this flag is ignored. 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 - in 'openshift-config' namespace by Operator. Note that this - solution is Openshift 4 platform-specific. + description: |- + Deprecated. The value of this flag is ignored. + 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 in 'openshift-config' namespace by Operator. + Note that this solution is Openshift 4 platform-specific. type: boolean nativeUserMode: - description: Deprecated. The value of this flag is ignored. Enables - native user mode. Currently works only on OpenShift and DevWorkspace - engine. Native User mode uses OpenShift OAuth directly as identity - provider, without Keycloak. + description: |- + Deprecated. The value of this flag is ignored. + Enables native user mode. Currently works only on OpenShift and DevWorkspace engine. + Native User mode uses OpenShift OAuth directly as identity provider, without Keycloak. type: boolean oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used @@ -725,8 +736,9 @@ spec: when left blank. See also the `OpenShiftoAuth` field. type: string oAuthScope: - description: Access Token Scope. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` @@ -735,19 +747,17 @@ spec: field. type: string openShiftoAuth: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean updateAdminPassword: - description: Deprecated. The value of this flag is ignored. Forces - the default `admin` Che user to update password on first login. - Defaults to `false`. + description: |- + Deprecated. The value of this flag is ignored. + Forces the default `admin` Che user to update password on first login. Defaults to `false`. type: boolean type: object dashboard: @@ -796,9 +806,9 @@ spec: to connect to the DB. Defaults to `dbche`. type: string chePostgresHostName: - description: 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`. + description: |- + 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. type: string chePostgresPassword: @@ -807,35 +817,29 @@ spec: automatically generated value. type: string chePostgresPort: - description: 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. + description: |- + 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. type: string chePostgresSecret: - description: '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 `postgres-credentials` will - be created with default value of `pgche` for `user` and with - an auto-generated value for `password`. The secret must have - `app.kubernetes.io/part-of=che.eclipse.org` label.' + description: |- + 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 `postgres-credentials` + will be created with default value of `pgche` for `user` and with an auto-generated value for `password`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string chePostgresUser: description: PostgreSQL user that the Che server uses to connect to the DB. Defaults to `pgche`. type: string externalDb: - description: '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`.' + description: |- + 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`. type: boolean postgresEnv: description: List of environment variables to set in the PostgreSQL @@ -849,15 +853,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -870,9 +875,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -881,12 +887,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -899,11 +904,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -923,6 +928,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -932,9 +938,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -943,6 +950,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -960,30 +968,29 @@ spec: `next` or `latest` images, and `IfNotPresent` in other cases. type: string postgresVersion: - description: 'Indicates a PostgreSQL version image to use. Allowed - values are: `9.6` and `13.3`. Migrate your PostgreSQL database - to switch from one version to another.' + description: |- + Indicates a PostgreSQL version image to use. Allowed values are: `9.6` and `13.3`. + Migrate your PostgreSQL database to switch from one version to another. type: string pvcClaimSize: - description: Size of the persistent volume claim for database. - Defaults to `1Gi`. To update pvc storageclass that provisions - it must support resize when Eclipse Che has been already deployed. + description: |- + Size of the persistent volume claim for database. Defaults to `1Gi`. + To update pvc storageclass that provisions it must support resize when Eclipse Che has been already deployed. type: string type: object devWorkspace: description: DevWorkspace operator configuration properties: controllerImage: - description: Overrides the container image used in the DevWorkspace - controller deployment. This includes the image tag. Omit it - or leave it empty to use the default container image provided - by the Operator. + description: |- + Overrides the container image used in the DevWorkspace controller deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string enable: - description: 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. + description: |- + 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. type: boolean env: description: List of environment variables to set in the DevWorkspace @@ -997,15 +1004,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1018,9 +1026,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1029,12 +1038,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1047,11 +1055,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1071,6 +1079,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1080,9 +1089,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1091,6 +1101,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1101,17 +1112,18 @@ spec: type: string secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer required: @@ -1129,15 +1141,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -1151,14 +1164,15 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -1172,14 +1186,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -1190,17 +1205,15 @@ spec: description: Kubernetes Image Puller configuration properties: enable: - description: 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. If the `spec.images` - field is empty, a set of recommended workspace-related images - will be automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + 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. + If the `spec.images` field is empty, a set of recommended workspace-related images will be automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A KubernetesImagePullerSpec to configure the image @@ -1241,24 +1254,21 @@ spec: made on upstream Kubernetes. properties: ingressClass: - description: '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.' + description: |- + 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. type: string ingressDomain: description: 'Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string securityContextFsGroup: description: The FSGroup in which the Che Pod and workspace Pods @@ -1269,22 +1279,17 @@ spec: run as. Default value is `1724`. type: string singleHostExposureType: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string tlsSecretName: - description: 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. + description: |- + 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. type: string type: object metrics: @@ -1301,73 +1306,69 @@ spec: the plugin and devfile registries properties: airGapContainerRegistryHostname: - description: 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. + description: |- + 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. type: string airGapContainerRegistryOrganization: - description: 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. + description: |- + 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. type: string allowAutoProvisionUserNamespace: - description: Indicates if is allowed to automatically create a - user namespace. If it set to false, then user namespace must - be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean allowUserDefinedWorkspaceNamespaces: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean cheClusterRoles: - description: A comma-separated list of ClusterRoles that will - be assigned to Che ServiceAccount. Each role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. Be aware that the Che Operator has to already have all - permissions in these ClusterRoles to grant them. + description: |- + A comma-separated list of ClusterRoles that will be assigned to Che ServiceAccount. + Each role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + Be aware that the Che Operator has to already have all permissions in these ClusterRoles to grant them. type: string cheDebug: description: Enables the debug mode for Che server. Defaults to `false`. type: string cheFlavor: - description: Deprecated. The value of this flag is ignored. Specifies - a variation of the installation. The options are `che` for - upstream Che installations or `devspaces` for Red Hat OpenShift - Dev Spaces (formerly Red Hat CodeReady Workspaces) installation + description: |- + Deprecated. The value of this flag is ignored. + Specifies a variation of the installation. The options are `che` for upstream Che installations or + `devspaces` for Red Hat OpenShift Dev Spaces (formerly Red Hat CodeReady Workspaces) installation type: string cheHost: - description: 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. + description: |- + 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. type: string cheHostTLSSecret: - description: Name of a secret containing certificates to secure - ingress or route for the custom host name of the installed Che - server. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. See the `cheHost` field. + description: |- + Name of a secret containing certificates to secure ingress or route for the custom host name of the installed Che server. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. + See the `cheHost` field. type: string cheImage: - description: 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. + description: |- + 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. type: string cheImagePullPolicy: - description: Overrides the image pull policy used in Che deployment. - Default value is `Always` for `nightly`, `next` or `latest` - images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in Che deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string cheImageTag: - description: 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. + description: |- + 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. type: string cheLogLevel: description: 'Log level for the Che server: `INFO` or `DEBUG`. @@ -1385,15 +1386,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1406,9 +1408,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1417,12 +1420,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1435,11 +1437,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1459,6 +1461,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1468,9 +1471,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1479,6 +1483,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1510,10 +1515,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1521,27 +1526,28 @@ spec: type: string type: object cheWorkspaceClusterRole: - description: Custom cluster role bound to the user for the Che - workspaces. The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. The default roles are used when omitted or left blank. + description: |- + Custom cluster role bound to the user for the Che workspaces. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string - description: 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. + description: |- + 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. type: object dashboardCpuLimit: - description: Overrides the CPU limit used in the dashboard deployment. + description: |- + Overrides the CPU limit used in the dashboard deployment. In cores. (500m = .5 cores). Default to 500m. type: string dashboardCpuRequest: - description: Overrides the CPU request used in the dashboard deployment. + description: |- + Overrides the CPU request used in the dashboard deployment. In cores. (500m = .5 cores). Default to 100m. type: string dashboardEnv: @@ -1556,15 +1562,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1577,9 +1584,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1588,12 +1596,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1606,11 +1613,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1630,6 +1637,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1639,9 +1647,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1650,24 +1659,26 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array dashboardImage: - description: Overrides the container image used in the dashboard - deployment. This includes the image tag. Omit it or leave it - empty to use the default container image provided by the Operator. + description: |- + Overrides the container image used in the dashboard deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string dashboardImagePullPolicy: - description: Overrides the image pull policy used in the dashboard - deployment. Default value is `Always` for `nightly`, `next` - or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the dashboard deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string dashboardIngress: - description: Deprecated. The value of this flag is ignored. Dashboard - ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard ingress custom settings. properties: annotations: additionalProperties: @@ -1690,8 +1701,9 @@ spec: deployment. Defaults to 16Mi. type: string dashboardRoute: - description: Deprecated. The value of this flag is ignored. Dashboard - route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard route custom settings. properties: annotations: additionalProperties: @@ -1701,10 +1713,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1712,12 +1724,14 @@ spec: type: string type: object devfileRegistryCpuLimit: - description: Overrides the CPU limit used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string devfileRegistryCpuRequest: - description: Overrides the CPU request used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string devfileRegistryEnv: description: List of environment variables to set in the plugin @@ -1731,15 +1745,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1752,9 +1767,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1763,12 +1779,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1781,11 +1796,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1805,6 +1820,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1814,9 +1830,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1825,20 +1842,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array devfileRegistryImage: - description: 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. + description: |- + 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. type: string devfileRegistryIngress: - description: Deprecated. The value of this flag is ignored. The - devfile registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry ingress custom settings. properties: annotations: additionalProperties: @@ -1861,13 +1879,14 @@ spec: registry deployment. Defaults to 16Mi. type: string devfileRegistryPullPolicy: - description: Overrides the image pull policy used in the devfile - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the devfile registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string devfileRegistryRoute: - description: Deprecated. The value of this flag is ignored. The - devfile registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry route custom settings. properties: annotations: additionalProperties: @@ -1877,10 +1896,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1892,14 +1911,14 @@ spec: fields. type: string disableInternalClusterSVCNames: - description: Deprecated. The value of this flag is ignored. Disable - internal cluster SVC names usage to communicate between components - to speed up the traffic and avoid proxy issues. + description: |- + Deprecated. The value of this flag is ignored. + Disable internal cluster SVC names usage to communicate between components to speed up the traffic and avoid proxy issues. type: boolean externalDevfileRegistries: - description: External devfile registries, that serves sample, - ready-to-use devfiles. Configure this in addition to a dedicated - devfile registry (when `externalDevfileRegistry` is `false`) + description: |- + External devfile registries, that serves sample, ready-to-use devfiles. + Configure this in addition to a dedicated devfile registry (when `externalDevfileRegistry` is `false`) or instead of it (when `externalDevfileRegistry` is `true`) items: description: Settings for a configuration of the external devfile @@ -1911,50 +1930,44 @@ spec: type: object type: array externalDevfileRegistry: - description: 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 - configure at least one devfile registry with `externalDevfileRegistries` - field. + description: |- + 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 configure at least one + devfile registry with `externalDevfileRegistries` field. type: boolean externalPluginRegistry: - description: 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. + description: |- + 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. type: boolean gitSelfSignedCert: - description: When enabled, the certificate from `che-git-self-signed-cert` - ConfigMap will be propagated to the Che components and provide - particular configuration for Git. Note, the `che-git-self-signed-cert` - ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + When enabled, the certificate from `che-git-self-signed-cert` ConfigMap will be propagated to the Che components and provide particular configuration for Git. + Note, the `che-git-self-signed-cert` ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: boolean nonProxyHosts: - description: 'List of hosts that will be reached directly, bypassing - the proxy. Specify wild card domain use the following form `.` - 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.' + description: |- + List of hosts that will be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.` 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. type: string openVSXRegistryURL: description: Open VSX registry URL. If omitted an embedded instance will be used. type: string pluginRegistryCpuLimit: - description: Overrides the CPU limit used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string pluginRegistryCpuRequest: - description: Overrides the CPU request used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string pluginRegistryEnv: description: List of environment variables to set in the devfile @@ -1968,15 +1981,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1989,9 +2003,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -2000,12 +2015,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -2018,11 +2032,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -2042,6 +2056,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -2051,9 +2066,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -2062,20 +2078,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array pluginRegistryImage: - description: 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. + description: |- + 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. type: string pluginRegistryIngress: - description: Deprecated. The value of this flag is ignored. Plugin - registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry ingress custom settings. properties: annotations: additionalProperties: @@ -2098,13 +2115,14 @@ spec: deployment. Defaults to 16Mi. type: string pluginRegistryPullPolicy: - description: Overrides the image pull policy used in the plugin - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the plugin registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string pluginRegistryRoute: - description: Deprecated. The value of this flag is ignored. Plugin - registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry route custom settings. properties: annotations: additionalProperties: @@ -2114,10 +2132,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -2125,16 +2143,15 @@ spec: type: string type: object pluginRegistryUrl: - description: 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. + description: |- + 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. type: string proxyPassword: - description: Password of the proxy server. Only use when proxy - configuration is required. See the `proxyURL`, `proxyUser` and - `proxySecret` fields. + description: |- + Password of the proxy server. + Only use when proxy configuration is required. See the `proxyURL`, `proxyUser` and `proxySecret` fields. type: string proxyPort: description: Port of the proxy server. Only use when configuring @@ -2142,22 +2159,18 @@ spec: fields. type: string proxySecret: - description: The secret that contains `user` and `password` for - a proxy server. When the secret is defined, the `proxyUser` - and `proxyPassword` are ignored. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The secret that contains `user` and `password` for a proxy server. When the secret is defined, the `proxyUser` and `proxyPassword` are ignored. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string proxyURL: - description: 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. + description: |- + 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. type: string proxyUser: description: User name of the proxy server. Only use when configuring @@ -2165,31 +2178,29 @@ spec: and `proxySecret` fields. type: string selfSignedCert: - description: 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. + description: |- + 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. type: boolean serverCpuLimit: - description: Overrides the CPU limit used in the Che server deployment + description: |- + Overrides the CPU limit used in the Che server deployment In cores. (500m = .5 cores). Default to 1. type: string serverCpuRequest: - description: Overrides the CPU request used in the Che server - deployment In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the Che server deployment + In cores. (500m = .5 cores). Default to 100m. type: string serverExposureStrategy: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string serverMemoryLimit: description: Overrides the memory limit used in the Che server @@ -2200,13 +2211,11 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: 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. - The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + 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. + The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string singleHostGatewayConfigMapLabels: additionalProperties: @@ -2233,9 +2242,9 @@ spec: description: Deprecated in favor of `disableInternalClusterSVCNames`. type: boolean workspaceDefaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile does - not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile does not contain any components. items: properties: attributes: @@ -2274,20 +2283,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -2296,10 +2305,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -2311,28 +2322,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2347,24 +2369,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2374,15 +2403,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2390,10 +2418,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -2412,17 +2447,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -2432,18 +2469,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -2453,19 +2489,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -2478,8 +2515,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -2499,18 +2539,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -2529,32 +2566,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -2564,9 +2601,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -2582,14 +2619,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2601,28 +2641,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2637,24 +2688,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2664,15 +2722,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2693,22 +2750,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2720,28 +2780,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2756,24 +2827,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2783,15 +2861,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2812,32 +2889,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -2863,9 +2944,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -2881,9 +2962,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -2911,9 +2992,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -2925,23 +3006,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -2972,40 +3056,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -3014,9 +3098,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -3055,21 +3139,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -3078,10 +3161,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -3094,31 +3179,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3132,29 +3224,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3164,27 +3258,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -3202,18 +3300,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -3223,20 +3321,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -3248,9 +3343,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -3272,21 +3369,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -3305,34 +3396,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -3342,10 +3429,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -3360,16 +3446,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3382,31 +3469,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3420,29 +3514,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3452,17 +3548,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3483,24 +3576,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3513,31 +3607,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3551,29 +3652,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3583,17 +3686,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3614,13 +3714,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3653,34 +3754,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3692,16 +3793,16 @@ spec: type: array workspaceDefaultEditor: default: che-incubator/che-code/latest - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/plugin/version`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/plugin/version`. The URI must start from `http`. type: string workspaceNamespaceDefault: - description: 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 ``, `` and `` - placeholders, such as che-workspace-. In that case, - a new namespace will be created for each user or workspace. + description: |- + 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 ``, `` and `` placeholders, such as che-workspace-. + In that case, a new namespace will be created for each user or workspace. type: string workspacePodNodeSelector: additionalProperties: @@ -3713,41 +3814,39 @@ spec: description: The pod tolerations put on the workspace pods to limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -3784,26 +3883,23 @@ spec: storage class is used. type: string preCreateSubPaths: - description: 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. + description: |- + 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. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. Defaults to `10Gi`. type: string pvcJobsImage: - description: 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. + description: |- + 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. type: string pvcStrategy: - description: 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`. + description: |- + 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`. type: string workspacePVCStorageClassName: description: Storage class for the Persistent Volume Claims dedicated @@ -3836,15 +3932,14 @@ spec: description: The status of the Devworkspace subsystem properties: gatewayHost: - description: GatewayHost is the resolved host of the ingress/route. - This is equal to the Host in the spec on Kubernetes but contains - the actual host name of the route if Host is unspecified on - OpenShift. + description: |- + GatewayHost is the resolved host of the ingress/route. This is equal to the Host in the spec + on Kubernetes but contains the actual host name of the route if Host is unspecified on OpenShift. type: string gatewayPhase: - description: GatewayPhase specifies the phase in which the gateway - deployment currently is. If the gateway is disabled, the phase - is "Inactive". + description: |- + GatewayPhase specifies the phase in which the gateway deployment currently is. + If the gateway is disabled, the phase is "Inactive". type: string message: description: Message contains further human-readable info for @@ -3859,10 +3954,10 @@ spec: why the Che cluster is in this state. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either - the copy of the explicitly defined property of the same name - in the spec or, if it is undefined in the spec and we're running - on OpenShift, the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object gitHubOAuthProvisioned: @@ -3913,22 +4008,26 @@ spec: - name: v2 schema: openAPIV3Schema: - description: 'The `CheCluster` custom resource allows defining and managing - Eclipse Che server installation. Based on these settings, the Operator - automatically creates and maintains several ConfigMaps: `che`, `plugin-registry`, - `devfile-registry` that will contain the appropriate environment variables - of the various components of the installation. These generated ConfigMaps - must NOT be updated manually.' + description: |- + The `CheCluster` custom resource allows defining and managing Eclipse Che server installation. + Based on these settings, the Operator automatically creates and maintains several ConfigMaps: + `che`, `plugin-registry`, `devfile-registry` that will contain the appropriate environment variables + of the various components of the installation. These generated ConfigMaps must NOT be updated manually. properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object @@ -3952,14 +4051,15 @@ spec: server. properties: clusterRoles: - description: 'Additional ClusterRoles assigned to Che ServiceAccount. - Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. The defaults roles are: - `-cheworkspaces-clusterrole` + description: |- + Additional ClusterRoles assigned to Che ServiceAccount. + Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` label. + The defaults roles are: + - `-cheworkspaces-clusterrole` - `-cheworkspaces-namespaces-clusterrole` - `-cheworkspaces-devworkspace-clusterrole` - where the is the namespace where the CheCluster - CR is created. The Che Operator must already have all permissions - in these ClusterRoles to grant them.' + where the is the namespace where the CheCluster CR is created. + The Che Operator must already have all permissions in these ClusterRoles to grant them. items: type: string type: array @@ -3987,18 +4087,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4011,10 +4109,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4023,12 +4121,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4042,13 +4139,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4070,6 +4165,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4080,10 +4176,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4092,6 +4188,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4126,23 +4223,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4154,23 +4248,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4196,13 +4287,11 @@ spec: extraProperties: additionalProperties: type: string - description: A map of additional environment variables 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). If the `extraProperties` - field contains a property normally generated in `che` ConfigMap - from other CR fields, the value defined in the `extraProperties` - is used instead. + description: |- + A map of additional environment variables 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). + If the `extraProperties` field contains a property normally generated in `che` ConfigMap from other CR fields, + the value defined in the `extraProperties` is used instead. type: object logLevel: default: INFO @@ -4210,27 +4299,25 @@ spec: `DEBUG`.' type: string proxy: - description: Proxy server settings for Kubernetes cluster. - No additional configuration is required for OpenShift cluster. - By specifying these settings for the OpenShift cluster, - you override the OpenShift proxy configuration. + description: |- + Proxy server settings for Kubernetes cluster. No additional configuration is required for OpenShift cluster. + By specifying these settings for the OpenShift cluster, you override the OpenShift proxy configuration. properties: credentialsSecretName: - description: The secret name that contains `user` and - `password` for a proxy server. The secret must have - a `app.kubernetes.io/part-of=che.eclipse.org` label. + description: |- + The secret name that contains `user` and `password` for a proxy server. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string nonProxyHosts: - description: 'A list of hosts that can be reached directly, - bypassing the proxy. Specify wild card domain use the - following form `.`, for example: - localhost - - my.host.com - 123.42.12.32 Use only when a proxy - configuration is required. The Operator respects OpenShift - cluster-wide proxy configuration, defining `nonProxyHosts` - in a custom resource leads to merging non-proxy hosts - lists from the cluster proxy configuration, and the - ones defined in the custom resources. See the following - page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + A list of hosts that can be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.`, for example: + - localhost + - my.host.com + - 123.42.12.32 + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `nonProxyHosts` in a custom resource leads to merging non-proxy hosts lists from the cluster proxy configuration, and the ones defined in the custom resources. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. items: type: string type: array @@ -4238,12 +4325,11 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. - Use only when a proxy configuration is required. The - Operator respects OpenShift cluster-wide proxy configuration, - defining `url` in a custom resource leads to overriding - the cluster proxy configuration. See the following page: - https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + URL (protocol+hostname) of the proxy server. + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `url` in a custom resource leads to overriding the cluster proxy configuration. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. type: string type: object type: object @@ -4286,18 +4372,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4310,10 +4394,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4322,12 +4406,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4341,13 +4424,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4369,6 +4450,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4379,10 +4461,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4391,6 +4473,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4425,23 +4508,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4453,23 +4533,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4519,7 +4596,8 @@ spec: description: DevWorkspace Operator configuration. properties: runningLimit: - description: Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` + description: |- + Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` The maximum number of running workspaces per user. type: string type: object @@ -4547,18 +4625,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4571,10 +4647,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4583,12 +4659,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4602,13 +4677,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4630,6 +4703,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4640,10 +4714,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4652,6 +4726,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4686,23 +4761,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4714,23 +4786,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4773,18 +4842,15 @@ spec: description: Kubernetes Image Puller configuration. properties: enable: - description: Install and configure the community supported - Kubernetes Image Puller Operator. When you set the value - to `true` without providing any specs, it creates a default - Kubernetes Image Puller object managed by the Operator. - When you set the value to `false`, the Kubernetes Image - Puller object is deleted, and the Operator uninstalled, - regardless of whether a spec is provided. If you leave the - `spec.images` field empty, a set of recommended workspace-related - images is automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + Install and configure the community supported Kubernetes Image Puller Operator. When you set the value to `true` without providing any specs, + it creates a default Kubernetes Image Puller object managed by the Operator. + When you set the value to `false`, the Kubernetes Image Puller object is deleted, and the Operator uninstalled, + regardless of whether a spec is provided. + If you leave the `spec.images` field empty, a set of recommended workspace-related images is automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A Kubernetes Image Puller spec to configure the @@ -4852,18 +4918,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4876,10 +4940,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4888,12 +4952,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4907,13 +4970,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4935,6 +4996,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4945,10 +5007,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4957,6 +5019,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4991,23 +5054,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5019,23 +5079,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5082,18 +5139,16 @@ spec: Che images. properties: hostname: - description: An optional hostname or URL of an alternative container - registry to pull images from. This value overrides the container - registry hostname defined in all the default container images - involved in a Che deployment. This is particularly useful for - installing Che in a restricted environment. + description: |- + An optional hostname or URL of an alternative container registry to pull images from. + This value overrides the container registry hostname defined in all the default container images involved in a Che deployment. + This is particularly useful for installing Che in a restricted environment. type: string organization: - description: An optional repository name of an alternative 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 for installing - Eclipse Che in a restricted environment. + description: |- + An optional repository name of an alternative 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 for installing Eclipse Che in a restricted environment. type: string type: object devEnvironments: @@ -5119,9 +5174,9 @@ spec: type: string type: object defaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile, that - does not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile, that does not contain any components. items: properties: attributes: @@ -5160,20 +5215,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5182,10 +5237,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5197,28 +5254,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5233,24 +5301,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5260,15 +5335,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5276,10 +5350,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -5298,17 +5379,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -5318,18 +5401,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -5339,19 +5421,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -5364,8 +5447,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -5385,18 +5471,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -5415,32 +5498,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -5450,9 +5533,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -5468,14 +5551,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5487,28 +5573,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5523,24 +5620,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5550,15 +5654,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5579,22 +5682,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5606,28 +5712,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5642,24 +5759,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5669,15 +5793,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5698,32 +5821,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -5749,9 +5876,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -5767,9 +5894,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -5797,9 +5924,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -5811,23 +5938,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -5858,40 +5988,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -5900,9 +6030,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -5941,21 +6071,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5964,10 +6093,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5980,31 +6111,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6018,29 +6156,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6050,27 +6190,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -6088,18 +6232,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -6109,20 +6253,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -6134,9 +6275,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -6158,21 +6301,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -6191,34 +6328,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -6228,10 +6361,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -6246,16 +6378,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6268,31 +6401,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6306,29 +6446,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6338,17 +6480,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6369,24 +6508,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6399,31 +6539,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6437,29 +6584,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6469,17 +6618,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6500,13 +6646,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6539,34 +6686,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6577,9 +6724,10 @@ spec: type: object type: array defaultEditor: - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/name/version` - format. The URI must start from `http://` or `https://`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/name/version` format. + The URI must start from `http://` or `https://`. type: string defaultNamespace: default: @@ -6589,16 +6737,15 @@ spec: properties: autoProvision: default: true - description: Indicates if is allowed to automatically create - a user namespace. If it set to false, then user namespace - must be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean template: default: -che - description: If you don't create the user namespaces in advance, - this field defines the Kubernetes namespace created when - you start your first workspace. You can use `` - and `` placeholders, such as che-workspace-. + description: |- + If you don't create the user namespaces in advance, this field defines the Kubernetes namespace created when you start your first workspace. + You can use `` and `` placeholders, such as che-workspace-. pattern: | type: string type: object @@ -6607,7 +6754,8 @@ spec: items: properties: editor: - description: The editor ID to specify default plug-ins for. + description: |- + The editor ID to specify default plug-ins for. The plugin ID must have `publisher/name/version` format. type: string plugins: @@ -6618,25 +6766,30 @@ spec: type: object type: array deploymentStrategy: - description: DeploymentStrategy defines the deployment strategy - to use to replace existing workspace pods with new ones. The - available deployment stragies are `Recreate` and `RollingUpdate`. - With the `Recreate` deployment strategy, the existing workspace - pod is killed before the new one is created. With the `RollingUpdate` - deployment strategy, a new workspace pod is created and the - existing workspace pod is deleted only when the new workspace - pod is in a ready state. If not specified, the default `Recreate` - deployment strategy is used. + description: |- + DeploymentStrategy defines the deployment strategy to use to replace existing workspace pods + with new ones. The available deployment stragies are `Recreate` and `RollingUpdate`. + With the `Recreate` deployment strategy, the existing workspace pod is killed before the new one is created. + With the `RollingUpdate` deployment strategy, a new workspace pod is created and the existing workspace pod is deleted + only when the new workspace pod is in a ready state. + If not specified, the default `Recreate` deployment strategy is used. enum: - Recreate - RollingUpdate type: string disableContainerBuildCapabilities: - description: "Disables the container build capabilities. When - set to `false` (the default value), the devEnvironments.security.containerSecurityContext - field is ignored, and the following container SecurityContext - is applied: \n containerSecurityContext: allowPrivilegeEscalation: - true capabilities: add: - SETGID - SETUID" + description: |- + Disables the container build capabilities. + When set to `false` (the default value), the devEnvironments.security.containerSecurityContext + field is ignored, and the following container SecurityContext is applied: + + + containerSecurityContext: + allowPrivilegeEscalation: true + capabilities: + add: + - SETGID + - SETUID type: boolean gatewayContainer: description: GatewayContainer configuration. @@ -6652,16 +6805,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6674,10 +6827,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6686,12 +6839,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6704,12 +6856,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6729,6 +6880,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6738,10 +6890,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6750,6 +6902,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -6782,19 +6935,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6807,19 +6960,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6835,16 +6988,17 @@ spec: - Never type: string maxNumberOfRunningWorkspacesPerUser: - description: The maximum number of running workspaces per user. + description: |- + The maximum number of running workspaces per user. The value, -1, allows users to run an unlimited number of workspaces. format: int64 minimum: -1 type: integer maxNumberOfWorkspacesPerUser: default: -1 - description: Total number of workspaces, both stopped and running, - that a user can keep. The value, -1, allows users to keep an - unlimited number of workspaces. + description: |- + Total number of workspaces, both stopped and running, that a user can keep. + The value, -1, allows users to keep an unlimited number of workspaces. format: int64 minimum: -1 type: integer @@ -6855,19 +7009,22 @@ spec: workspace pods. type: object persistUserHome: - description: PersistUserHome defines configuration options for - persisting the user home directory in workspaces. + description: |- + PersistUserHome defines configuration options for persisting the + user home directory in workspaces. properties: enabled: - description: Determines whether the user home directory in - workspaces should persist between workspace shutdown and - startup. Must be used with the 'per-user' or 'per-workspace' - PVC strategy in order to take effect. Disabled by default. + description: |- + Determines whether the user home directory in workspaces should persist between + workspace shutdown and startup. + Must be used with the 'per-user' or 'per-workspace' PVC strategy in order to take effect. + Disabled by default. type: boolean type: object podSchedulerName: - description: Pod scheduler for the workspace pods. If not specified, - the pod scheduler is set to the default scheduler on the cluster. + description: |- + Pod scheduler for the workspace pods. + If not specified, the pod scheduler is set to the default scheduler on the cluster. type: string projectCloneContainer: description: Project clone container configuration. @@ -6883,16 +7040,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6905,10 +7062,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6917,12 +7074,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6935,12 +7091,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6960,6 +7115,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6969,10 +7125,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6981,6 +7137,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7013,19 +7170,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7038,19 +7195,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7059,42 +7216,44 @@ spec: type: object secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer security: description: Workspace security configuration. properties: containerSecurityContext: - description: Container SecurityContext used by all workspace-related - containers. If set, defined values are merged into the default - Container SecurityContext configuration. Requires devEnvironments.disableContainerBuildCapabilities - to be set to `true` in order to take effect. + description: |- + Container SecurityContext used by all workspace-related containers. + If set, defined values are merged into the default Container SecurityContext configuration. + Requires devEnvironments.disableContainerBuildCapabilities to be set to `true` in order to take effect. properties: allowPrivilegeEscalation: - description: 'AllowPrivilegeEscalation controls whether - a process can gain more privileges than its parent process. - This bool directly controls if the no_new_privs flag - will be set on the container process. AllowPrivilegeEscalation - is true always when the container is: 1) run as Privileged - 2) has CAP_SYS_ADMIN Note that this field cannot be - set when spec.os.name is windows.' + description: |- + AllowPrivilegeEscalation controls whether a process can gain more + privileges than its parent process. This bool directly controls if + the no_new_privs flag will be set on the container process. + AllowPrivilegeEscalation is true always when the container is: + 1) run as Privileged + 2) has CAP_SYS_ADMIN + Note that this field cannot be set when spec.os.name is windows. type: boolean capabilities: - description: The capabilities to add/drop when running - containers. Defaults to the default set of capabilities - granted by the container runtime. Note that this field - cannot be set when spec.os.name is windows. + description: |- + The capabilities to add/drop when running containers. + Defaults to the default set of capabilities granted by the container runtime. + Note that this field cannot be set when spec.os.name is windows. properties: add: description: Added capabilities @@ -7112,61 +7271,60 @@ spec: type: array type: object privileged: - description: Run container in privileged mode. Processes - in privileged containers are essentially equivalent - to root on the host. Defaults to false. Note that this - field cannot be set when spec.os.name is windows. + description: |- + Run container in privileged mode. + Processes in privileged containers are essentially equivalent to root on the host. + Defaults to false. + Note that this field cannot be set when spec.os.name is windows. type: boolean procMount: - description: procMount denotes the type of proc mount - to use for the containers. The default is DefaultProcMount - which uses the container runtime defaults for readonly - paths and masked paths. This requires the ProcMountType - feature flag to be enabled. Note that this field cannot - be set when spec.os.name is windows. + description: |- + procMount denotes the type of proc mount to use for the containers. + The default is DefaultProcMount which uses the container runtime defaults for + readonly paths and masked paths. + This requires the ProcMountType feature flag to be enabled. + Note that this field cannot be set when spec.os.name is windows. type: string readOnlyRootFilesystem: - description: Whether this container has a read-only root - filesystem. Default is false. Note that this field cannot - be set when spec.os.name is windows. + description: |- + Whether this container has a read-only root filesystem. + Default is false. + Note that this field cannot be set when spec.os.name is windows. type: boolean runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to the - container. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The SELinux context to be applied to the container. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7186,137 +7344,135 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by this container. - If seccomp options are provided at both the pod & container - level, the container options override the pod options. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The seccomp options to use by this container. If seccomp options are + provided at both the pod & container level, the container options + override the pod options. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options from the - PodSecurityContext will be used. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options from the PodSecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object podSecurityContext: - description: PodSecurityContext used by all workspace-related - pods. If set, defined values are merged into the default - PodSecurityContext configuration. + description: |- + PodSecurityContext used by all workspace-related pods. + If set, defined values are merged into the default PodSecurityContext configuration. properties: fsGroup: - description: "A special supplemental group that applies - to all containers in a pod. Some volume types allow - the Kubelet to change the ownership of that volume to - be owned by the pod: \n 1. The owning GID will be the - FSGroup 2. The setgid bit is set (new files created - in the volume will be owned by FSGroup) 3. The permission - will not modify the ownership and permissions of any - volume. Note that this field cannot be set when spec.os.name - is windows." + description: |- + A special supplemental group that applies to all containers in a pod. + Some volume types allow the Kubelet to change the ownership of that volume + to be owned by the pod: + + + 1. The owning GID will be the FSGroup + 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) + + + If unset, the Kubelet will not modify the ownership and permissions of any volume. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer fsGroupChangePolicy: - description: 'fsGroupChangePolicy defines behavior of - changing ownership and permission of the volume before - being exposed inside Pod. This field will only apply - to volume types which support fsGroup based ownership(and - permissions). It will have no effect on ephemeral volume - types such as: secret, configmaps and emptydir. Valid - values are "OnRootMismatch" and "Always". If not specified, - "Always" is used. Note that this field cannot be set - when spec.os.name is windows.' + description: |- + fsGroupChangePolicy defines behavior of changing ownership and permission of the volume + before being exposed inside Pod. This field will only apply to + volume types which support fsGroup based ownership(and permissions). + It will have no effect on ephemeral volume types such as: secret, configmaps + and emptydir. + Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + Note that this field cannot be set when spec.os.name is windows. type: string runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in SecurityContext. If set - in both SecurityContext and PodSecurityContext, the - value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in SecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence - for that container. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to all - containers. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The SELinux context to be applied to all containers. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in SecurityContext. If set in + both SecurityContext and PodSecurityContext, the value specified in SecurityContext + takes precedence for that container. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7336,49 +7492,48 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by the containers - in this pod. Note that this field cannot be set when - spec.os.name is windows. + description: |- + The seccomp options to use by the containers in this pod. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object supplementalGroups: - description: A list of groups applied to the first process - run in each container, in addition to the container's - primary GID, the fsGroup (if specified), and group memberships - defined in the container image for the uid of the container - process. If unspecified, no additional groups are added - to any container. Note that group memberships defined - in the container image for the uid of the container - process are still effective, even if they are not included - in this list. Note that this field cannot be set when - spec.os.name is windows. + description: |- + A list of groups applied to the first process run in each container, in addition + to the container's primary GID, the fsGroup (if specified), and group memberships + defined in the container image for the uid of the container process. If unspecified, + no additional groups are added to any container. Note that group memberships + defined in the container image for the uid of the container process are still effective, + even if they are not included in this list. + Note that this field cannot be set when spec.os.name is windows. items: format: int64 type: integer type: array sysctls: - description: Sysctls hold a list of namespaced sysctls - used for the pod. Pods with unsupported sysctls (by - the container runtime) might fail to launch. Note that - this field cannot be set when spec.os.name is windows. + description: |- + Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported + sysctls (by the container runtime) might fail to launch. + Note that this field cannot be set when spec.os.name is windows. items: description: Sysctl defines a kernel parameter to be set @@ -7395,43 +7550,38 @@ spec: type: object type: array windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options within a - container's SecurityContext will be used. If set in - both SecurityContext and PodSecurityContext, the value - specified in SecurityContext takes precedence. Note - that this field cannot be set when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options within a container's SecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object @@ -7448,37 +7598,39 @@ spec: items: properties: audience: - description: Audience is the intended audience of the token. - A recipient of a token must identify itself with an identifier - specified in the audience of the token, and otherwise - should reject the token. The audience defaults to the + description: |- + Audience is the intended audience of the token. A recipient of a token + must identify itself with an identifier specified in the audience of the + token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. type: string expirationSeconds: default: 3600 - description: ExpirationSeconds is the requested duration - of validity of the service account token. As the token - approaches expiration, the kubelet volume plugin will - proactively rotate the service account token. The kubelet - will start trying to rotate the token if the token is - older than 80 percent of its time to live or if the token - is older than 24 hours. Defaults to 1 hour and must be - at least 10 minutes. + description: |- + ExpirationSeconds is the requested duration of validity of the service + account token. As the token approaches expiration, the kubelet volume + plugin will proactively rotate the service account token. The kubelet will + start trying to rotate the token if the token is older than 80 percent of + its time to live or if the token is older than 24 hours. Defaults to 1 hour + and must be at least 10 minutes. format: int64 minimum: 600 type: integer mountPath: - description: Path within the workspace container at which - the token should be mounted. Must not contain ':'. + description: |- + Path within the workspace container at which the token should be mounted. Must + not contain ':'. type: string name: - description: Identifiable name of the ServiceAccount token. - If multiple ServiceAccount tokens use the same mount path, - a generic name will be used for the projected volume instead. + description: |- + Identifiable name of the ServiceAccount token. + If multiple ServiceAccount tokens use the same mount path, a generic name will be used + for the projected volume instead. type: string path: - description: Path is the path relative to the mount point - of the file to project the token into. + description: |- + Path is the path relative to the mount point of the file to project the + token into. type: string required: - mountPath @@ -7488,10 +7640,10 @@ spec: type: array startTimeoutSeconds: default: 300 - description: StartTimeoutSeconds determines the maximum duration - (in seconds) that a workspace can take to start before it is - automatically failed. If not specified, the default value of - 300 seconds (5 minutes) is used. + description: |- + StartTimeoutSeconds determines the maximum duration (in seconds) that a workspace can take to start + before it is automatically failed. + If not specified, the default value of 300 seconds (5 minutes) is used. format: int32 minimum: 1 type: integer @@ -7531,12 +7683,12 @@ spec: type: object pvcStrategy: default: per-user - description: 'Persistent volume claim strategy for the Che - server. The supported strategies are: `per-user` (all workspaces - PVCs in one volume), `per-workspace` (each workspace is - given its own individual PVC) and `ephemeral` (non-persistent - storage where local changes will be lost when the workspace - is stopped.)' + description: |- + Persistent volume claim strategy for the Che server. + The supported strategies are: `per-user` (all workspaces PVCs in one volume), + `per-workspace` (each workspace is given its own individual PVC) + and `ephemeral` (non-persistent storage where local changes will be lost when + the workspace is stopped.) enum: - common - per-user @@ -7548,41 +7700,39 @@ spec: description: The pod tolerations of the workspace pods limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -7590,20 +7740,19 @@ spec: description: Trusted certificate settings. properties: gitTrustedCertsConfigMapName: - description: 'The ConfigMap contains certificates to propagate - to the Che components and to provide a particular configuration - for Git. See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ - The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + The ConfigMap contains certificates to propagate to the Che components and to provide a particular configuration for Git. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ + The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object user: description: User configuration. properties: clusterRoles: - description: Additional ClusterRoles assigned to the user. - The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + Additional ClusterRoles assigned to the user. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. items: type: string type: array @@ -7621,9 +7770,9 @@ spec: hosted on Azure DevOps Service (dev.azure.com). properties: secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Azure DevOps Service Application ID and Client Secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services' + description: |- + Kubernetes secret, that contains Base64-encoded Azure DevOps Service Application ID and Client Secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services type: string required: - secretName @@ -7637,15 +7786,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -7659,19 +7809,21 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: disableSubdomainIsolation: - description: 'Disables subdomain isolation. Deprecated in - favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` - annotation. See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Disables subdomain isolation. + Deprecated in favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: boolean endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -7685,14 +7837,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -7711,10 +7864,13 @@ spec: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set for an Ingress - (a route for OpenShift platform). The defaults for kubernetes - platforms are: kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", nginx.ingress.kubernetes.io/proxy-connect-timeout: - "3600", nginx.ingress.kubernetes.io/ssl-redirect: "true"' + description: |- + Defines annotations which will be set for an Ingress (a route for OpenShift platform). + The defaults for kubernetes platforms are: + kubernetes.io/ingress.class: "nginx" + nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", + nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600", + nginx.ingress.kubernetes.io/ssl-redirect: "true" type: object auth: default: @@ -7725,15 +7881,12 @@ spec: description: Authentication settings. properties: advancedAuthorization: - description: Advance authorization settings. Determines which - users and groups are allowed to access Che. User is allowed - to access Che if he/she is either in the `allowUsers` list - or is member of group from `allowGroups` list and not in - neither the `denyUsers` list nor is member of group from - `denyGroups` list. If `allowUsers` and `allowGroups` are - empty, then all users are allowed to access Che. if `denyUsers` - and `denyGroups` are empty, then no users are denied to - access Che. + description: |- + Advance authorization settings. Determines which users and groups are allowed to access Che. + User is allowed to access Che if he/she is either in the `allowUsers` list or is member of group from `allowGroups` list + and not in neither the `denyUsers` list nor is member of group from `denyGroups` list. + If `allowUsers` and `allowGroups` are empty, then all users are allowed to access Che. + if `denyUsers` and `denyGroups` are empty, then no users are denied to access Che. properties: allowGroups: description: List of groups allowed to access Che (currently @@ -7774,10 +7927,13 @@ spec: description: Gateway configuration labels. type: object deployment: - description: 'Deployment override options. Since gateway - deployment consists of several containers, they must - be distinguished in the configuration by their names: - - `gateway` - `configbump` - `oauth-proxy` - `kube-rbac-proxy`' + description: |- + Deployment override options. + Since gateway deployment consists of several containers, they must be distinguished in the configuration by their names: + - `gateway` + - `configbump` + - `oauth-proxy` + - `kube-rbac-proxy` properties: containers: description: List of containers belonging to the pod. @@ -7796,19 +7952,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to - a single $, which allows for escaping - the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -7822,10 +7975,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7835,12 +7988,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -7855,13 +8007,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: @@ -7884,6 +8034,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -7894,10 +8045,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7906,6 +8057,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7940,23 +8092,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -7968,23 +8117,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -8059,25 +8205,24 @@ spec: description: Public URL of the Identity Provider server. type: string identityToken: - description: 'Identity token to be passed to upstream. There - are two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. enum: - id_token - access_token type: string oAuthAccessTokenInactivityTimeoutSeconds: - description: Inactivity timeout for tokens to set in the OpenShift - `OAuthClient` resource used to set up identity federation - on the OpenShift side. 0 means tokens for this client never - time out. + description: |- + Inactivity timeout for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means tokens for this client never time out. format: int32 type: integer oAuthAccessTokenMaxAgeSeconds: - description: Access token max age for tokens to set in the - OpenShift `OAuthClient` resource used to set up identity - federation on the OpenShift side. 0 means no expiration. + description: |- + Access token max age for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means no expiration. format: int32 type: integer oAuthClientName: @@ -8085,37 +8230,33 @@ spec: used to set up identity federation on the OpenShift side. type: string oAuthScope: - description: Access Token Scope. This field is specific to - Che installations made for Kubernetes only and ignored for - OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: - description: 'Name of the secret set in the OpenShift `OAuthClient` - resource used to set up identity federation on the OpenShift - side. For Kubernetes, this can either be the plain text - oAuthSecret value, or the name of a kubernetes secret which - contains a key `oAuthSecret` and the value is the secret. - NOTE: this secret must exist in the same namespace as the - `CheCluster` resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`.' + description: |- + Name of the secret set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + For Kubernetes, this can either be the plain text oAuthSecret value, or the name of a kubernetes secret which contains a + key `oAuthSecret` and the value is the secret. NOTE: this secret must exist in the same namespace as the `CheCluster` + resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`. type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the - domain to generate a hostname for the route. The generated hostname - follows this pattern: che-.. The - is the namespace where the CheCluster CRD is created. In conjunction - with labels, it creates a route served by a non-default Ingress - controller. For a Kubernetes cluster, it contains a global ingress - domain. There are no default values: you must specify them.' + description: |- + For an OpenShift cluster, the Operator uses the domain to generate a hostname for the route. + The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. + In conjunction with labels, it creates a route served by a non-default Ingress controller. + For a Kubernetes cluster, it contains a global ingress domain. There are no default values: you must specify them. type: string hostname: description: The public hostname of the installed Che server. type: string ingressClassName: - description: IngressClassName is the name of an IngressClass cluster - resource. If a class name is defined in both the `IngressClassName` - field and the `kubernetes.io/ingress.class` annotation, `IngressClassName` - field takes precedence. + description: |- + IngressClassName is the name of an IngressClass cluster resource. + If a class name is defined in both the `IngressClassName` field and the `kubernetes.io/ingress.class` annotation, + `IngressClassName` field takes precedence. type: string labels: additionalProperties: @@ -8124,10 +8265,10 @@ spec: route for OpenShift platform). type: object tlsSecretName: - description: The name of the secret used to set up Ingress TLS - termination. If the field is an empty string, the default cluster - certificate is used. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The name of the secret used to set up Ingress TLS termination. + If the field is an empty string, the default cluster certificate is used. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object type: object @@ -8161,10 +8302,10 @@ spec: the Che deployment is in the current phase. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either the - copy of the explicitly defined property of the same name in the - spec or, if it is undefined in the spec and we're running on OpenShift, - the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object type: object @@ -8172,9 +8313,3 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] diff --git a/deploy/deployment/openshift/combined.yaml b/deploy/deployment/openshift/combined.yaml index a9c36588f..864912dfd 100644 --- a/deploy/deployment/openshift/combined.yaml +++ b/deploy/deployment/openshift/combined.yaml @@ -19,7 +19,7 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.14.0 service.beta.openshift.io/inject-cabundle: "true" labels: app.kubernetes.io/instance: che @@ -56,53 +56,57 @@ spec: a Che server installation properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: - description: 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. + description: |- + 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. properties: auth: description: Configuration settings related to the Authentication used by the Che installation. properties: debug: - description: Deprecated. The value of this flag is ignored. Debug - internal identity provider. + description: |- + Deprecated. The value of this flag is ignored. + Debug internal identity provider. type: boolean externalIdentityProvider: - description: 'Deprecated. The value of this flag is ignored. 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`.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: boolean gatewayAuthenticationSidecarImage: - description: Gateway sidecar responsible for authentication when - NativeUserMode is enabled. See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] - or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. + description: |- + Gateway sidecar responsible for authentication when NativeUserMode is enabled. + See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. type: string gatewayAuthorizationSidecarImage: - description: Gateway sidecar responsible for authorization when - NativeUserMode is enabled. See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] - or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] + description: |- + Gateway sidecar responsible for authorization when NativeUserMode is enabled. + See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] type: string gatewayConfigBumpEnv: description: List of environment variables to set in the Configbump @@ -116,15 +120,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -137,9 +142,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -148,12 +154,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -166,11 +171,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -190,6 +195,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -199,9 +205,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -210,6 +217,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -227,15 +235,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -248,9 +257,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -259,12 +269,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -277,11 +286,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -301,6 +310,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -310,9 +320,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -321,6 +332,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -342,15 +354,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -363,9 +376,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -374,12 +388,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -392,11 +405,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -416,6 +429,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -425,9 +439,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -436,6 +451,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -453,15 +469,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -474,9 +491,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -485,12 +503,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -503,11 +520,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -527,6 +544,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -536,9 +554,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -547,27 +566,28 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array identityProviderAdminUserName: - description: Deprecated. The value of this flag is ignored. Overrides - the name of the Identity Provider administrator user. Defaults - to `admin`. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the name of the Identity Provider administrator user. Defaults to `admin`. type: string identityProviderClientId: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string identityProviderContainerResources: - description: Deprecated. The value of this flag is ignored. Identity - provider container custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Identity provider container custom settings. properties: limits: description: Limits describes the maximum amount of compute @@ -595,21 +615,21 @@ spec: type: object type: object identityProviderImage: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderImagePullPolicy: - description: Deprecated. The value of this flag is ignored. Overrides - the image pull policy used in the Identity Provider, Keycloak - or RH-SSO, deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the image pull policy used in the Identity Provider, Keycloak or RH-SSO, deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string identityProviderIngress: - description: Deprecated. The value of this flag is ignored. Ingress - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Ingress custom settings. properties: annotations: additionalProperties: @@ -624,42 +644,39 @@ spec: type: string type: object identityProviderPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. - The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderRealm: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderRoute: - description: Deprecated. The value of this flag is ignored. Route - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Route custom settings. properties: annotations: additionalProperties: @@ -669,10 +686,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -680,49 +697,43 @@ spec: type: string type: object identityProviderSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderURL: - description: 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. + description: |- + 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. type: string identityToken: - description: 'Identity token to be passed to upstream. There are - two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che installations - made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string initialOpenShiftOAuthUser: - description: Deprecated. The value of this flag is ignored. 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 - in 'openshift-config' namespace by Operator. Note that this - solution is Openshift 4 platform-specific. + description: |- + Deprecated. The value of this flag is ignored. + 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 in 'openshift-config' namespace by Operator. + Note that this solution is Openshift 4 platform-specific. type: boolean nativeUserMode: - description: Deprecated. The value of this flag is ignored. Enables - native user mode. Currently works only on OpenShift and DevWorkspace - engine. Native User mode uses OpenShift OAuth directly as identity - provider, without Keycloak. + description: |- + Deprecated. The value of this flag is ignored. + Enables native user mode. Currently works only on OpenShift and DevWorkspace engine. + Native User mode uses OpenShift OAuth directly as identity provider, without Keycloak. type: boolean oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used @@ -730,8 +741,9 @@ spec: when left blank. See also the `OpenShiftoAuth` field. type: string oAuthScope: - description: Access Token Scope. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` @@ -740,19 +752,17 @@ spec: field. type: string openShiftoAuth: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean updateAdminPassword: - description: Deprecated. The value of this flag is ignored. Forces - the default `admin` Che user to update password on first login. - Defaults to `false`. + description: |- + Deprecated. The value of this flag is ignored. + Forces the default `admin` Che user to update password on first login. Defaults to `false`. type: boolean type: object dashboard: @@ -801,9 +811,9 @@ spec: to connect to the DB. Defaults to `dbche`. type: string chePostgresHostName: - description: 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`. + description: |- + 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. type: string chePostgresPassword: @@ -812,35 +822,29 @@ spec: automatically generated value. type: string chePostgresPort: - description: 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. + description: |- + 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. type: string chePostgresSecret: - description: '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 `postgres-credentials` will - be created with default value of `pgche` for `user` and with - an auto-generated value for `password`. The secret must have - `app.kubernetes.io/part-of=che.eclipse.org` label.' + description: |- + 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 `postgres-credentials` + will be created with default value of `pgche` for `user` and with an auto-generated value for `password`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string chePostgresUser: description: PostgreSQL user that the Che server uses to connect to the DB. Defaults to `pgche`. type: string externalDb: - description: '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`.' + description: |- + 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`. type: boolean postgresEnv: description: List of environment variables to set in the PostgreSQL @@ -854,15 +858,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -875,9 +880,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -886,12 +892,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -904,11 +909,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -928,6 +933,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -937,9 +943,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -948,6 +955,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -965,30 +973,29 @@ spec: `next` or `latest` images, and `IfNotPresent` in other cases. type: string postgresVersion: - description: 'Indicates a PostgreSQL version image to use. Allowed - values are: `9.6` and `13.3`. Migrate your PostgreSQL database - to switch from one version to another.' + description: |- + Indicates a PostgreSQL version image to use. Allowed values are: `9.6` and `13.3`. + Migrate your PostgreSQL database to switch from one version to another. type: string pvcClaimSize: - description: Size of the persistent volume claim for database. - Defaults to `1Gi`. To update pvc storageclass that provisions - it must support resize when Eclipse Che has been already deployed. + description: |- + Size of the persistent volume claim for database. Defaults to `1Gi`. + To update pvc storageclass that provisions it must support resize when Eclipse Che has been already deployed. type: string type: object devWorkspace: description: DevWorkspace operator configuration properties: controllerImage: - description: Overrides the container image used in the DevWorkspace - controller deployment. This includes the image tag. Omit it - or leave it empty to use the default container image provided - by the Operator. + description: |- + Overrides the container image used in the DevWorkspace controller deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string enable: - description: 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. + description: |- + 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. type: boolean env: description: List of environment variables to set in the DevWorkspace @@ -1002,15 +1009,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1023,9 +1031,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1034,12 +1043,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1052,11 +1060,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1076,6 +1084,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1085,9 +1094,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1096,6 +1106,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1106,17 +1117,18 @@ spec: type: string secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer required: @@ -1134,15 +1146,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -1156,14 +1169,15 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -1177,14 +1191,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -1195,17 +1210,15 @@ spec: description: Kubernetes Image Puller configuration properties: enable: - description: 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. If the `spec.images` - field is empty, a set of recommended workspace-related images - will be automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + 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. + If the `spec.images` field is empty, a set of recommended workspace-related images will be automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A KubernetesImagePullerSpec to configure the image @@ -1246,24 +1259,21 @@ spec: made on upstream Kubernetes. properties: ingressClass: - description: '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.' + description: |- + 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. type: string ingressDomain: description: 'Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string securityContextFsGroup: description: The FSGroup in which the Che Pod and workspace Pods @@ -1274,22 +1284,17 @@ spec: run as. Default value is `1724`. type: string singleHostExposureType: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string tlsSecretName: - description: 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. + description: |- + 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. type: string type: object metrics: @@ -1306,73 +1311,69 @@ spec: the plugin and devfile registries properties: airGapContainerRegistryHostname: - description: 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. + description: |- + 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. type: string airGapContainerRegistryOrganization: - description: 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. + description: |- + 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. type: string allowAutoProvisionUserNamespace: - description: Indicates if is allowed to automatically create a - user namespace. If it set to false, then user namespace must - be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean allowUserDefinedWorkspaceNamespaces: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean cheClusterRoles: - description: A comma-separated list of ClusterRoles that will - be assigned to Che ServiceAccount. Each role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. Be aware that the Che Operator has to already have all - permissions in these ClusterRoles to grant them. + description: |- + A comma-separated list of ClusterRoles that will be assigned to Che ServiceAccount. + Each role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + Be aware that the Che Operator has to already have all permissions in these ClusterRoles to grant them. type: string cheDebug: description: Enables the debug mode for Che server. Defaults to `false`. type: string cheFlavor: - description: Deprecated. The value of this flag is ignored. Specifies - a variation of the installation. The options are `che` for - upstream Che installations or `devspaces` for Red Hat OpenShift - Dev Spaces (formerly Red Hat CodeReady Workspaces) installation + description: |- + Deprecated. The value of this flag is ignored. + Specifies a variation of the installation. The options are `che` for upstream Che installations or + `devspaces` for Red Hat OpenShift Dev Spaces (formerly Red Hat CodeReady Workspaces) installation type: string cheHost: - description: 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. + description: |- + 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. type: string cheHostTLSSecret: - description: Name of a secret containing certificates to secure - ingress or route for the custom host name of the installed Che - server. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. See the `cheHost` field. + description: |- + Name of a secret containing certificates to secure ingress or route for the custom host name of the installed Che server. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. + See the `cheHost` field. type: string cheImage: - description: 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. + description: |- + 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. type: string cheImagePullPolicy: - description: Overrides the image pull policy used in Che deployment. - Default value is `Always` for `nightly`, `next` or `latest` - images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in Che deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string cheImageTag: - description: 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. + description: |- + 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. type: string cheLogLevel: description: 'Log level for the Che server: `INFO` or `DEBUG`. @@ -1390,15 +1391,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1411,9 +1413,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1422,12 +1425,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1440,11 +1442,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1464,6 +1466,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1473,9 +1476,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1484,6 +1488,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1515,10 +1520,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1526,27 +1531,28 @@ spec: type: string type: object cheWorkspaceClusterRole: - description: Custom cluster role bound to the user for the Che - workspaces. The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. The default roles are used when omitted or left blank. + description: |- + Custom cluster role bound to the user for the Che workspaces. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string - description: 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. + description: |- + 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. type: object dashboardCpuLimit: - description: Overrides the CPU limit used in the dashboard deployment. + description: |- + Overrides the CPU limit used in the dashboard deployment. In cores. (500m = .5 cores). Default to 500m. type: string dashboardCpuRequest: - description: Overrides the CPU request used in the dashboard deployment. + description: |- + Overrides the CPU request used in the dashboard deployment. In cores. (500m = .5 cores). Default to 100m. type: string dashboardEnv: @@ -1561,15 +1567,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1582,9 +1589,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1593,12 +1601,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1611,11 +1618,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1635,6 +1642,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1644,9 +1652,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1655,24 +1664,26 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array dashboardImage: - description: Overrides the container image used in the dashboard - deployment. This includes the image tag. Omit it or leave it - empty to use the default container image provided by the Operator. + description: |- + Overrides the container image used in the dashboard deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string dashboardImagePullPolicy: - description: Overrides the image pull policy used in the dashboard - deployment. Default value is `Always` for `nightly`, `next` - or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the dashboard deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string dashboardIngress: - description: Deprecated. The value of this flag is ignored. Dashboard - ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard ingress custom settings. properties: annotations: additionalProperties: @@ -1695,8 +1706,9 @@ spec: deployment. Defaults to 16Mi. type: string dashboardRoute: - description: Deprecated. The value of this flag is ignored. Dashboard - route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard route custom settings. properties: annotations: additionalProperties: @@ -1706,10 +1718,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1717,12 +1729,14 @@ spec: type: string type: object devfileRegistryCpuLimit: - description: Overrides the CPU limit used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string devfileRegistryCpuRequest: - description: Overrides the CPU request used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string devfileRegistryEnv: description: List of environment variables to set in the plugin @@ -1736,15 +1750,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1757,9 +1772,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1768,12 +1784,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1786,11 +1801,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1810,6 +1825,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1819,9 +1835,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1830,20 +1847,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array devfileRegistryImage: - description: 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. + description: |- + 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. type: string devfileRegistryIngress: - description: Deprecated. The value of this flag is ignored. The - devfile registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry ingress custom settings. properties: annotations: additionalProperties: @@ -1866,13 +1884,14 @@ spec: registry deployment. Defaults to 16Mi. type: string devfileRegistryPullPolicy: - description: Overrides the image pull policy used in the devfile - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the devfile registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string devfileRegistryRoute: - description: Deprecated. The value of this flag is ignored. The - devfile registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry route custom settings. properties: annotations: additionalProperties: @@ -1882,10 +1901,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1897,14 +1916,14 @@ spec: fields. type: string disableInternalClusterSVCNames: - description: Deprecated. The value of this flag is ignored. Disable - internal cluster SVC names usage to communicate between components - to speed up the traffic and avoid proxy issues. + description: |- + Deprecated. The value of this flag is ignored. + Disable internal cluster SVC names usage to communicate between components to speed up the traffic and avoid proxy issues. type: boolean externalDevfileRegistries: - description: External devfile registries, that serves sample, - ready-to-use devfiles. Configure this in addition to a dedicated - devfile registry (when `externalDevfileRegistry` is `false`) + description: |- + External devfile registries, that serves sample, ready-to-use devfiles. + Configure this in addition to a dedicated devfile registry (when `externalDevfileRegistry` is `false`) or instead of it (when `externalDevfileRegistry` is `true`) items: description: Settings for a configuration of the external devfile @@ -1916,50 +1935,44 @@ spec: type: object type: array externalDevfileRegistry: - description: 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 - configure at least one devfile registry with `externalDevfileRegistries` - field. + description: |- + 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 configure at least one + devfile registry with `externalDevfileRegistries` field. type: boolean externalPluginRegistry: - description: 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. + description: |- + 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. type: boolean gitSelfSignedCert: - description: When enabled, the certificate from `che-git-self-signed-cert` - ConfigMap will be propagated to the Che components and provide - particular configuration for Git. Note, the `che-git-self-signed-cert` - ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + When enabled, the certificate from `che-git-self-signed-cert` ConfigMap will be propagated to the Che components and provide particular configuration for Git. + Note, the `che-git-self-signed-cert` ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: boolean nonProxyHosts: - description: 'List of hosts that will be reached directly, bypassing - the proxy. Specify wild card domain use the following form `.` - 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.' + description: |- + List of hosts that will be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.` 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. type: string openVSXRegistryURL: description: Open VSX registry URL. If omitted an embedded instance will be used. type: string pluginRegistryCpuLimit: - description: Overrides the CPU limit used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string pluginRegistryCpuRequest: - description: Overrides the CPU request used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string pluginRegistryEnv: description: List of environment variables to set in the devfile @@ -1973,15 +1986,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1994,9 +2008,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -2005,12 +2020,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -2023,11 +2037,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -2047,6 +2061,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -2056,9 +2071,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -2067,20 +2083,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array pluginRegistryImage: - description: 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. + description: |- + 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. type: string pluginRegistryIngress: - description: Deprecated. The value of this flag is ignored. Plugin - registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry ingress custom settings. properties: annotations: additionalProperties: @@ -2103,13 +2120,14 @@ spec: deployment. Defaults to 16Mi. type: string pluginRegistryPullPolicy: - description: Overrides the image pull policy used in the plugin - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the plugin registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string pluginRegistryRoute: - description: Deprecated. The value of this flag is ignored. Plugin - registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry route custom settings. properties: annotations: additionalProperties: @@ -2119,10 +2137,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -2130,16 +2148,15 @@ spec: type: string type: object pluginRegistryUrl: - description: 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. + description: |- + 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. type: string proxyPassword: - description: Password of the proxy server. Only use when proxy - configuration is required. See the `proxyURL`, `proxyUser` and - `proxySecret` fields. + description: |- + Password of the proxy server. + Only use when proxy configuration is required. See the `proxyURL`, `proxyUser` and `proxySecret` fields. type: string proxyPort: description: Port of the proxy server. Only use when configuring @@ -2147,22 +2164,18 @@ spec: fields. type: string proxySecret: - description: The secret that contains `user` and `password` for - a proxy server. When the secret is defined, the `proxyUser` - and `proxyPassword` are ignored. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The secret that contains `user` and `password` for a proxy server. When the secret is defined, the `proxyUser` and `proxyPassword` are ignored. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string proxyURL: - description: 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. + description: |- + 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. type: string proxyUser: description: User name of the proxy server. Only use when configuring @@ -2170,31 +2183,29 @@ spec: and `proxySecret` fields. type: string selfSignedCert: - description: 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. + description: |- + 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. type: boolean serverCpuLimit: - description: Overrides the CPU limit used in the Che server deployment + description: |- + Overrides the CPU limit used in the Che server deployment In cores. (500m = .5 cores). Default to 1. type: string serverCpuRequest: - description: Overrides the CPU request used in the Che server - deployment In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the Che server deployment + In cores. (500m = .5 cores). Default to 100m. type: string serverExposureStrategy: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string serverMemoryLimit: description: Overrides the memory limit used in the Che server @@ -2205,13 +2216,11 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: 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. - The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + 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. + The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string singleHostGatewayConfigMapLabels: additionalProperties: @@ -2238,9 +2247,9 @@ spec: description: Deprecated in favor of `disableInternalClusterSVCNames`. type: boolean workspaceDefaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile does - not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile does not contain any components. items: properties: attributes: @@ -2279,20 +2288,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -2301,10 +2310,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -2316,28 +2327,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2352,24 +2374,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2379,15 +2408,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2395,10 +2423,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -2417,17 +2452,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -2437,18 +2474,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -2458,19 +2494,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -2483,8 +2520,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -2504,18 +2544,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -2534,32 +2571,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -2569,9 +2606,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -2587,14 +2624,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2606,28 +2646,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2642,24 +2693,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2669,15 +2727,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2698,22 +2755,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2725,28 +2785,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2761,24 +2832,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2788,15 +2866,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2817,32 +2894,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -2868,9 +2949,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -2886,9 +2967,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -2916,9 +2997,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -2930,23 +3011,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -2977,40 +3061,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -3019,9 +3103,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -3060,21 +3144,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -3083,10 +3166,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -3099,31 +3184,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3137,29 +3229,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3169,27 +3263,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -3207,18 +3305,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -3228,20 +3326,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -3253,9 +3348,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -3277,21 +3374,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -3310,34 +3401,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -3347,10 +3434,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -3365,16 +3451,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3387,31 +3474,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3425,29 +3519,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3457,17 +3553,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3488,24 +3581,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3518,31 +3612,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3556,29 +3657,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3588,17 +3691,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3619,13 +3719,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3658,34 +3759,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3697,16 +3798,16 @@ spec: type: array workspaceDefaultEditor: default: che-incubator/che-code/latest - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/plugin/version`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/plugin/version`. The URI must start from `http`. type: string workspaceNamespaceDefault: - description: 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 ``, `` and `` - placeholders, such as che-workspace-. In that case, - a new namespace will be created for each user or workspace. + description: |- + 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 ``, `` and `` placeholders, such as che-workspace-. + In that case, a new namespace will be created for each user or workspace. type: string workspacePodNodeSelector: additionalProperties: @@ -3718,41 +3819,39 @@ spec: description: The pod tolerations put on the workspace pods to limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -3789,26 +3888,23 @@ spec: storage class is used. type: string preCreateSubPaths: - description: 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. + description: |- + 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. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. Defaults to `10Gi`. type: string pvcJobsImage: - description: 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. + description: |- + 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. type: string pvcStrategy: - description: 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`. + description: |- + 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`. type: string workspacePVCStorageClassName: description: Storage class for the Persistent Volume Claims dedicated @@ -3841,15 +3937,14 @@ spec: description: The status of the Devworkspace subsystem properties: gatewayHost: - description: GatewayHost is the resolved host of the ingress/route. - This is equal to the Host in the spec on Kubernetes but contains - the actual host name of the route if Host is unspecified on - OpenShift. + description: |- + GatewayHost is the resolved host of the ingress/route. This is equal to the Host in the spec + on Kubernetes but contains the actual host name of the route if Host is unspecified on OpenShift. type: string gatewayPhase: - description: GatewayPhase specifies the phase in which the gateway - deployment currently is. If the gateway is disabled, the phase - is "Inactive". + description: |- + GatewayPhase specifies the phase in which the gateway deployment currently is. + If the gateway is disabled, the phase is "Inactive". type: string message: description: Message contains further human-readable info for @@ -3864,10 +3959,10 @@ spec: why the Che cluster is in this state. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either - the copy of the explicitly defined property of the same name - in the spec or, if it is undefined in the spec and we're running - on OpenShift, the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object gitHubOAuthProvisioned: @@ -3918,22 +4013,26 @@ spec: - name: v2 schema: openAPIV3Schema: - description: 'The `CheCluster` custom resource allows defining and managing - Eclipse Che server installation. Based on these settings, the Operator - automatically creates and maintains several ConfigMaps: `che`, `plugin-registry`, - `devfile-registry` that will contain the appropriate environment variables - of the various components of the installation. These generated ConfigMaps - must NOT be updated manually.' + description: |- + The `CheCluster` custom resource allows defining and managing Eclipse Che server installation. + Based on these settings, the Operator automatically creates and maintains several ConfigMaps: + `che`, `plugin-registry`, `devfile-registry` that will contain the appropriate environment variables + of the various components of the installation. These generated ConfigMaps must NOT be updated manually. properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object @@ -3957,14 +4056,15 @@ spec: server. properties: clusterRoles: - description: 'Additional ClusterRoles assigned to Che ServiceAccount. - Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. The defaults roles are: - `-cheworkspaces-clusterrole` + description: |- + Additional ClusterRoles assigned to Che ServiceAccount. + Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` label. + The defaults roles are: + - `-cheworkspaces-clusterrole` - `-cheworkspaces-namespaces-clusterrole` - `-cheworkspaces-devworkspace-clusterrole` - where the is the namespace where the CheCluster - CR is created. The Che Operator must already have all permissions - in these ClusterRoles to grant them.' + where the is the namespace where the CheCluster CR is created. + The Che Operator must already have all permissions in these ClusterRoles to grant them. items: type: string type: array @@ -3992,18 +4092,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4016,10 +4114,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4028,12 +4126,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4047,13 +4144,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4075,6 +4170,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4085,10 +4181,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4097,6 +4193,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4131,23 +4228,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4159,23 +4253,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4201,13 +4292,11 @@ spec: extraProperties: additionalProperties: type: string - description: A map of additional environment variables 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). If the `extraProperties` - field contains a property normally generated in `che` ConfigMap - from other CR fields, the value defined in the `extraProperties` - is used instead. + description: |- + A map of additional environment variables 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). + If the `extraProperties` field contains a property normally generated in `che` ConfigMap from other CR fields, + the value defined in the `extraProperties` is used instead. type: object logLevel: default: INFO @@ -4215,27 +4304,25 @@ spec: `DEBUG`.' type: string proxy: - description: Proxy server settings for Kubernetes cluster. - No additional configuration is required for OpenShift cluster. - By specifying these settings for the OpenShift cluster, - you override the OpenShift proxy configuration. + description: |- + Proxy server settings for Kubernetes cluster. No additional configuration is required for OpenShift cluster. + By specifying these settings for the OpenShift cluster, you override the OpenShift proxy configuration. properties: credentialsSecretName: - description: The secret name that contains `user` and - `password` for a proxy server. The secret must have - a `app.kubernetes.io/part-of=che.eclipse.org` label. + description: |- + The secret name that contains `user` and `password` for a proxy server. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string nonProxyHosts: - description: 'A list of hosts that can be reached directly, - bypassing the proxy. Specify wild card domain use the - following form `.`, for example: - localhost - - my.host.com - 123.42.12.32 Use only when a proxy - configuration is required. The Operator respects OpenShift - cluster-wide proxy configuration, defining `nonProxyHosts` - in a custom resource leads to merging non-proxy hosts - lists from the cluster proxy configuration, and the - ones defined in the custom resources. See the following - page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + A list of hosts that can be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.`, for example: + - localhost + - my.host.com + - 123.42.12.32 + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `nonProxyHosts` in a custom resource leads to merging non-proxy hosts lists from the cluster proxy configuration, and the ones defined in the custom resources. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. items: type: string type: array @@ -4243,12 +4330,11 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. - Use only when a proxy configuration is required. The - Operator respects OpenShift cluster-wide proxy configuration, - defining `url` in a custom resource leads to overriding - the cluster proxy configuration. See the following page: - https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + URL (protocol+hostname) of the proxy server. + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `url` in a custom resource leads to overriding the cluster proxy configuration. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. type: string type: object type: object @@ -4291,18 +4377,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4315,10 +4399,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4327,12 +4411,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4346,13 +4429,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4374,6 +4455,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4384,10 +4466,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4396,6 +4478,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4430,23 +4513,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4458,23 +4538,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4524,7 +4601,8 @@ spec: description: DevWorkspace Operator configuration. properties: runningLimit: - description: Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` + description: |- + Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` The maximum number of running workspaces per user. type: string type: object @@ -4552,18 +4630,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4576,10 +4652,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4588,12 +4664,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4607,13 +4682,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4635,6 +4708,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4645,10 +4719,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4657,6 +4731,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4691,23 +4766,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4719,23 +4791,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4778,18 +4847,15 @@ spec: description: Kubernetes Image Puller configuration. properties: enable: - description: Install and configure the community supported - Kubernetes Image Puller Operator. When you set the value - to `true` without providing any specs, it creates a default - Kubernetes Image Puller object managed by the Operator. - When you set the value to `false`, the Kubernetes Image - Puller object is deleted, and the Operator uninstalled, - regardless of whether a spec is provided. If you leave the - `spec.images` field empty, a set of recommended workspace-related - images is automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + Install and configure the community supported Kubernetes Image Puller Operator. When you set the value to `true` without providing any specs, + it creates a default Kubernetes Image Puller object managed by the Operator. + When you set the value to `false`, the Kubernetes Image Puller object is deleted, and the Operator uninstalled, + regardless of whether a spec is provided. + If you leave the `spec.images` field empty, a set of recommended workspace-related images is automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A Kubernetes Image Puller spec to configure the @@ -4857,18 +4923,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4881,10 +4945,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4893,12 +4957,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4912,13 +4975,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4940,6 +5001,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4950,10 +5012,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4962,6 +5024,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4996,23 +5059,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5024,23 +5084,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5087,18 +5144,16 @@ spec: Che images. properties: hostname: - description: An optional hostname or URL of an alternative container - registry to pull images from. This value overrides the container - registry hostname defined in all the default container images - involved in a Che deployment. This is particularly useful for - installing Che in a restricted environment. + description: |- + An optional hostname or URL of an alternative container registry to pull images from. + This value overrides the container registry hostname defined in all the default container images involved in a Che deployment. + This is particularly useful for installing Che in a restricted environment. type: string organization: - description: An optional repository name of an alternative 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 for installing - Eclipse Che in a restricted environment. + description: |- + An optional repository name of an alternative 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 for installing Eclipse Che in a restricted environment. type: string type: object devEnvironments: @@ -5124,9 +5179,9 @@ spec: type: string type: object defaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile, that - does not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile, that does not contain any components. items: properties: attributes: @@ -5165,20 +5220,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5187,10 +5242,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5202,28 +5259,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5238,24 +5306,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5265,15 +5340,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5281,10 +5355,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -5303,17 +5384,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -5323,18 +5406,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -5344,19 +5426,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -5369,8 +5452,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -5390,18 +5476,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -5420,32 +5503,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -5455,9 +5538,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -5473,14 +5556,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5492,28 +5578,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5528,24 +5625,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5555,15 +5659,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5584,22 +5687,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5611,28 +5717,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5647,24 +5764,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5674,15 +5798,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5703,32 +5826,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -5754,9 +5881,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -5772,9 +5899,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -5802,9 +5929,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -5816,23 +5943,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -5863,40 +5993,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -5905,9 +6035,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -5946,21 +6076,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5969,10 +6098,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5985,31 +6116,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6023,29 +6161,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6055,27 +6195,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -6093,18 +6237,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -6114,20 +6258,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -6139,9 +6280,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -6163,21 +6306,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -6196,34 +6333,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -6233,10 +6366,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -6251,16 +6383,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6273,31 +6406,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6311,29 +6451,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6343,17 +6485,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6374,24 +6513,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6404,31 +6544,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6442,29 +6589,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6474,17 +6623,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6505,13 +6651,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6544,34 +6691,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6582,9 +6729,10 @@ spec: type: object type: array defaultEditor: - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/name/version` - format. The URI must start from `http://` or `https://`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/name/version` format. + The URI must start from `http://` or `https://`. type: string defaultNamespace: default: @@ -6594,16 +6742,15 @@ spec: properties: autoProvision: default: true - description: Indicates if is allowed to automatically create - a user namespace. If it set to false, then user namespace - must be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean template: default: -che - description: If you don't create the user namespaces in advance, - this field defines the Kubernetes namespace created when - you start your first workspace. You can use `` - and `` placeholders, such as che-workspace-. + description: |- + If you don't create the user namespaces in advance, this field defines the Kubernetes namespace created when you start your first workspace. + You can use `` and `` placeholders, such as che-workspace-. pattern: | type: string type: object @@ -6612,7 +6759,8 @@ spec: items: properties: editor: - description: The editor ID to specify default plug-ins for. + description: |- + The editor ID to specify default plug-ins for. The plugin ID must have `publisher/name/version` format. type: string plugins: @@ -6623,25 +6771,30 @@ spec: type: object type: array deploymentStrategy: - description: DeploymentStrategy defines the deployment strategy - to use to replace existing workspace pods with new ones. The - available deployment stragies are `Recreate` and `RollingUpdate`. - With the `Recreate` deployment strategy, the existing workspace - pod is killed before the new one is created. With the `RollingUpdate` - deployment strategy, a new workspace pod is created and the - existing workspace pod is deleted only when the new workspace - pod is in a ready state. If not specified, the default `Recreate` - deployment strategy is used. + description: |- + DeploymentStrategy defines the deployment strategy to use to replace existing workspace pods + with new ones. The available deployment stragies are `Recreate` and `RollingUpdate`. + With the `Recreate` deployment strategy, the existing workspace pod is killed before the new one is created. + With the `RollingUpdate` deployment strategy, a new workspace pod is created and the existing workspace pod is deleted + only when the new workspace pod is in a ready state. + If not specified, the default `Recreate` deployment strategy is used. enum: - Recreate - RollingUpdate type: string disableContainerBuildCapabilities: - description: "Disables the container build capabilities. When - set to `false` (the default value), the devEnvironments.security.containerSecurityContext - field is ignored, and the following container SecurityContext - is applied: \n containerSecurityContext: allowPrivilegeEscalation: - true capabilities: add: - SETGID - SETUID" + description: |- + Disables the container build capabilities. + When set to `false` (the default value), the devEnvironments.security.containerSecurityContext + field is ignored, and the following container SecurityContext is applied: + + + containerSecurityContext: + allowPrivilegeEscalation: true + capabilities: + add: + - SETGID + - SETUID type: boolean gatewayContainer: description: GatewayContainer configuration. @@ -6657,16 +6810,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6679,10 +6832,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6691,12 +6844,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6709,12 +6861,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6734,6 +6885,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6743,10 +6895,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6755,6 +6907,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -6787,19 +6940,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6812,19 +6965,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6840,16 +6993,17 @@ spec: - Never type: string maxNumberOfRunningWorkspacesPerUser: - description: The maximum number of running workspaces per user. + description: |- + The maximum number of running workspaces per user. The value, -1, allows users to run an unlimited number of workspaces. format: int64 minimum: -1 type: integer maxNumberOfWorkspacesPerUser: default: -1 - description: Total number of workspaces, both stopped and running, - that a user can keep. The value, -1, allows users to keep an - unlimited number of workspaces. + description: |- + Total number of workspaces, both stopped and running, that a user can keep. + The value, -1, allows users to keep an unlimited number of workspaces. format: int64 minimum: -1 type: integer @@ -6860,19 +7014,22 @@ spec: workspace pods. type: object persistUserHome: - description: PersistUserHome defines configuration options for - persisting the user home directory in workspaces. + description: |- + PersistUserHome defines configuration options for persisting the + user home directory in workspaces. properties: enabled: - description: Determines whether the user home directory in - workspaces should persist between workspace shutdown and - startup. Must be used with the 'per-user' or 'per-workspace' - PVC strategy in order to take effect. Disabled by default. + description: |- + Determines whether the user home directory in workspaces should persist between + workspace shutdown and startup. + Must be used with the 'per-user' or 'per-workspace' PVC strategy in order to take effect. + Disabled by default. type: boolean type: object podSchedulerName: - description: Pod scheduler for the workspace pods. If not specified, - the pod scheduler is set to the default scheduler on the cluster. + description: |- + Pod scheduler for the workspace pods. + If not specified, the pod scheduler is set to the default scheduler on the cluster. type: string projectCloneContainer: description: Project clone container configuration. @@ -6888,16 +7045,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6910,10 +7067,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6922,12 +7079,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6940,12 +7096,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6965,6 +7120,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6974,10 +7130,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6986,6 +7142,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7018,19 +7175,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7043,19 +7200,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7064,42 +7221,44 @@ spec: type: object secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer security: description: Workspace security configuration. properties: containerSecurityContext: - description: Container SecurityContext used by all workspace-related - containers. If set, defined values are merged into the default - Container SecurityContext configuration. Requires devEnvironments.disableContainerBuildCapabilities - to be set to `true` in order to take effect. + description: |- + Container SecurityContext used by all workspace-related containers. + If set, defined values are merged into the default Container SecurityContext configuration. + Requires devEnvironments.disableContainerBuildCapabilities to be set to `true` in order to take effect. properties: allowPrivilegeEscalation: - description: 'AllowPrivilegeEscalation controls whether - a process can gain more privileges than its parent process. - This bool directly controls if the no_new_privs flag - will be set on the container process. AllowPrivilegeEscalation - is true always when the container is: 1) run as Privileged - 2) has CAP_SYS_ADMIN Note that this field cannot be - set when spec.os.name is windows.' + description: |- + AllowPrivilegeEscalation controls whether a process can gain more + privileges than its parent process. This bool directly controls if + the no_new_privs flag will be set on the container process. + AllowPrivilegeEscalation is true always when the container is: + 1) run as Privileged + 2) has CAP_SYS_ADMIN + Note that this field cannot be set when spec.os.name is windows. type: boolean capabilities: - description: The capabilities to add/drop when running - containers. Defaults to the default set of capabilities - granted by the container runtime. Note that this field - cannot be set when spec.os.name is windows. + description: |- + The capabilities to add/drop when running containers. + Defaults to the default set of capabilities granted by the container runtime. + Note that this field cannot be set when spec.os.name is windows. properties: add: description: Added capabilities @@ -7117,61 +7276,60 @@ spec: type: array type: object privileged: - description: Run container in privileged mode. Processes - in privileged containers are essentially equivalent - to root on the host. Defaults to false. Note that this - field cannot be set when spec.os.name is windows. + description: |- + Run container in privileged mode. + Processes in privileged containers are essentially equivalent to root on the host. + Defaults to false. + Note that this field cannot be set when spec.os.name is windows. type: boolean procMount: - description: procMount denotes the type of proc mount - to use for the containers. The default is DefaultProcMount - which uses the container runtime defaults for readonly - paths and masked paths. This requires the ProcMountType - feature flag to be enabled. Note that this field cannot - be set when spec.os.name is windows. + description: |- + procMount denotes the type of proc mount to use for the containers. + The default is DefaultProcMount which uses the container runtime defaults for + readonly paths and masked paths. + This requires the ProcMountType feature flag to be enabled. + Note that this field cannot be set when spec.os.name is windows. type: string readOnlyRootFilesystem: - description: Whether this container has a read-only root - filesystem. Default is false. Note that this field cannot - be set when spec.os.name is windows. + description: |- + Whether this container has a read-only root filesystem. + Default is false. + Note that this field cannot be set when spec.os.name is windows. type: boolean runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to the - container. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The SELinux context to be applied to the container. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7191,137 +7349,135 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by this container. - If seccomp options are provided at both the pod & container - level, the container options override the pod options. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The seccomp options to use by this container. If seccomp options are + provided at both the pod & container level, the container options + override the pod options. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options from the - PodSecurityContext will be used. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options from the PodSecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object podSecurityContext: - description: PodSecurityContext used by all workspace-related - pods. If set, defined values are merged into the default - PodSecurityContext configuration. + description: |- + PodSecurityContext used by all workspace-related pods. + If set, defined values are merged into the default PodSecurityContext configuration. properties: fsGroup: - description: "A special supplemental group that applies - to all containers in a pod. Some volume types allow - the Kubelet to change the ownership of that volume to - be owned by the pod: \n 1. The owning GID will be the - FSGroup 2. The setgid bit is set (new files created - in the volume will be owned by FSGroup) 3. The permission - will not modify the ownership and permissions of any - volume. Note that this field cannot be set when spec.os.name - is windows." + description: |- + A special supplemental group that applies to all containers in a pod. + Some volume types allow the Kubelet to change the ownership of that volume + to be owned by the pod: + + + 1. The owning GID will be the FSGroup + 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) + + + If unset, the Kubelet will not modify the ownership and permissions of any volume. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer fsGroupChangePolicy: - description: 'fsGroupChangePolicy defines behavior of - changing ownership and permission of the volume before - being exposed inside Pod. This field will only apply - to volume types which support fsGroup based ownership(and - permissions). It will have no effect on ephemeral volume - types such as: secret, configmaps and emptydir. Valid - values are "OnRootMismatch" and "Always". If not specified, - "Always" is used. Note that this field cannot be set - when spec.os.name is windows.' + description: |- + fsGroupChangePolicy defines behavior of changing ownership and permission of the volume + before being exposed inside Pod. This field will only apply to + volume types which support fsGroup based ownership(and permissions). + It will have no effect on ephemeral volume types such as: secret, configmaps + and emptydir. + Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + Note that this field cannot be set when spec.os.name is windows. type: string runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in SecurityContext. If set - in both SecurityContext and PodSecurityContext, the - value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in SecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence - for that container. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to all - containers. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The SELinux context to be applied to all containers. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in SecurityContext. If set in + both SecurityContext and PodSecurityContext, the value specified in SecurityContext + takes precedence for that container. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7341,49 +7497,48 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by the containers - in this pod. Note that this field cannot be set when - spec.os.name is windows. + description: |- + The seccomp options to use by the containers in this pod. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object supplementalGroups: - description: A list of groups applied to the first process - run in each container, in addition to the container's - primary GID, the fsGroup (if specified), and group memberships - defined in the container image for the uid of the container - process. If unspecified, no additional groups are added - to any container. Note that group memberships defined - in the container image for the uid of the container - process are still effective, even if they are not included - in this list. Note that this field cannot be set when - spec.os.name is windows. + description: |- + A list of groups applied to the first process run in each container, in addition + to the container's primary GID, the fsGroup (if specified), and group memberships + defined in the container image for the uid of the container process. If unspecified, + no additional groups are added to any container. Note that group memberships + defined in the container image for the uid of the container process are still effective, + even if they are not included in this list. + Note that this field cannot be set when spec.os.name is windows. items: format: int64 type: integer type: array sysctls: - description: Sysctls hold a list of namespaced sysctls - used for the pod. Pods with unsupported sysctls (by - the container runtime) might fail to launch. Note that - this field cannot be set when spec.os.name is windows. + description: |- + Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported + sysctls (by the container runtime) might fail to launch. + Note that this field cannot be set when spec.os.name is windows. items: description: Sysctl defines a kernel parameter to be set @@ -7400,43 +7555,38 @@ spec: type: object type: array windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options within a - container's SecurityContext will be used. If set in - both SecurityContext and PodSecurityContext, the value - specified in SecurityContext takes precedence. Note - that this field cannot be set when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options within a container's SecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object @@ -7453,37 +7603,39 @@ spec: items: properties: audience: - description: Audience is the intended audience of the token. - A recipient of a token must identify itself with an identifier - specified in the audience of the token, and otherwise - should reject the token. The audience defaults to the + description: |- + Audience is the intended audience of the token. A recipient of a token + must identify itself with an identifier specified in the audience of the + token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. type: string expirationSeconds: default: 3600 - description: ExpirationSeconds is the requested duration - of validity of the service account token. As the token - approaches expiration, the kubelet volume plugin will - proactively rotate the service account token. The kubelet - will start trying to rotate the token if the token is - older than 80 percent of its time to live or if the token - is older than 24 hours. Defaults to 1 hour and must be - at least 10 minutes. + description: |- + ExpirationSeconds is the requested duration of validity of the service + account token. As the token approaches expiration, the kubelet volume + plugin will proactively rotate the service account token. The kubelet will + start trying to rotate the token if the token is older than 80 percent of + its time to live or if the token is older than 24 hours. Defaults to 1 hour + and must be at least 10 minutes. format: int64 minimum: 600 type: integer mountPath: - description: Path within the workspace container at which - the token should be mounted. Must not contain ':'. + description: |- + Path within the workspace container at which the token should be mounted. Must + not contain ':'. type: string name: - description: Identifiable name of the ServiceAccount token. - If multiple ServiceAccount tokens use the same mount path, - a generic name will be used for the projected volume instead. + description: |- + Identifiable name of the ServiceAccount token. + If multiple ServiceAccount tokens use the same mount path, a generic name will be used + for the projected volume instead. type: string path: - description: Path is the path relative to the mount point - of the file to project the token into. + description: |- + Path is the path relative to the mount point of the file to project the + token into. type: string required: - mountPath @@ -7493,10 +7645,10 @@ spec: type: array startTimeoutSeconds: default: 300 - description: StartTimeoutSeconds determines the maximum duration - (in seconds) that a workspace can take to start before it is - automatically failed. If not specified, the default value of - 300 seconds (5 minutes) is used. + description: |- + StartTimeoutSeconds determines the maximum duration (in seconds) that a workspace can take to start + before it is automatically failed. + If not specified, the default value of 300 seconds (5 minutes) is used. format: int32 minimum: 1 type: integer @@ -7536,12 +7688,12 @@ spec: type: object pvcStrategy: default: per-user - description: 'Persistent volume claim strategy for the Che - server. The supported strategies are: `per-user` (all workspaces - PVCs in one volume), `per-workspace` (each workspace is - given its own individual PVC) and `ephemeral` (non-persistent - storage where local changes will be lost when the workspace - is stopped.)' + description: |- + Persistent volume claim strategy for the Che server. + The supported strategies are: `per-user` (all workspaces PVCs in one volume), + `per-workspace` (each workspace is given its own individual PVC) + and `ephemeral` (non-persistent storage where local changes will be lost when + the workspace is stopped.) enum: - common - per-user @@ -7553,41 +7705,39 @@ spec: description: The pod tolerations of the workspace pods limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -7595,20 +7745,19 @@ spec: description: Trusted certificate settings. properties: gitTrustedCertsConfigMapName: - description: 'The ConfigMap contains certificates to propagate - to the Che components and to provide a particular configuration - for Git. See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ - The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + The ConfigMap contains certificates to propagate to the Che components and to provide a particular configuration for Git. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ + The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object user: description: User configuration. properties: clusterRoles: - description: Additional ClusterRoles assigned to the user. - The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + Additional ClusterRoles assigned to the user. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. items: type: string type: array @@ -7626,9 +7775,9 @@ spec: hosted on Azure DevOps Service (dev.azure.com). properties: secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Azure DevOps Service Application ID and Client Secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services' + description: |- + Kubernetes secret, that contains Base64-encoded Azure DevOps Service Application ID and Client Secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services type: string required: - secretName @@ -7642,15 +7791,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -7664,19 +7814,21 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: disableSubdomainIsolation: - description: 'Disables subdomain isolation. Deprecated in - favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` - annotation. See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Disables subdomain isolation. + Deprecated in favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: boolean endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -7690,14 +7842,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -7716,10 +7869,13 @@ spec: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set for an Ingress - (a route for OpenShift platform). The defaults for kubernetes - platforms are: kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", nginx.ingress.kubernetes.io/proxy-connect-timeout: - "3600", nginx.ingress.kubernetes.io/ssl-redirect: "true"' + description: |- + Defines annotations which will be set for an Ingress (a route for OpenShift platform). + The defaults for kubernetes platforms are: + kubernetes.io/ingress.class: "nginx" + nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", + nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600", + nginx.ingress.kubernetes.io/ssl-redirect: "true" type: object auth: default: @@ -7730,15 +7886,12 @@ spec: description: Authentication settings. properties: advancedAuthorization: - description: Advance authorization settings. Determines which - users and groups are allowed to access Che. User is allowed - to access Che if he/she is either in the `allowUsers` list - or is member of group from `allowGroups` list and not in - neither the `denyUsers` list nor is member of group from - `denyGroups` list. If `allowUsers` and `allowGroups` are - empty, then all users are allowed to access Che. if `denyUsers` - and `denyGroups` are empty, then no users are denied to - access Che. + description: |- + Advance authorization settings. Determines which users and groups are allowed to access Che. + User is allowed to access Che if he/she is either in the `allowUsers` list or is member of group from `allowGroups` list + and not in neither the `denyUsers` list nor is member of group from `denyGroups` list. + If `allowUsers` and `allowGroups` are empty, then all users are allowed to access Che. + if `denyUsers` and `denyGroups` are empty, then no users are denied to access Che. properties: allowGroups: description: List of groups allowed to access Che (currently @@ -7779,10 +7932,13 @@ spec: description: Gateway configuration labels. type: object deployment: - description: 'Deployment override options. Since gateway - deployment consists of several containers, they must - be distinguished in the configuration by their names: - - `gateway` - `configbump` - `oauth-proxy` - `kube-rbac-proxy`' + description: |- + Deployment override options. + Since gateway deployment consists of several containers, they must be distinguished in the configuration by their names: + - `gateway` + - `configbump` + - `oauth-proxy` + - `kube-rbac-proxy` properties: containers: description: List of containers belonging to the pod. @@ -7801,19 +7957,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to - a single $, which allows for escaping - the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -7827,10 +7980,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7840,12 +7993,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -7860,13 +8012,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: @@ -7889,6 +8039,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -7899,10 +8050,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7911,6 +8062,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7945,23 +8097,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -7973,23 +8122,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -8064,25 +8210,24 @@ spec: description: Public URL of the Identity Provider server. type: string identityToken: - description: 'Identity token to be passed to upstream. There - are two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. enum: - id_token - access_token type: string oAuthAccessTokenInactivityTimeoutSeconds: - description: Inactivity timeout for tokens to set in the OpenShift - `OAuthClient` resource used to set up identity federation - on the OpenShift side. 0 means tokens for this client never - time out. + description: |- + Inactivity timeout for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means tokens for this client never time out. format: int32 type: integer oAuthAccessTokenMaxAgeSeconds: - description: Access token max age for tokens to set in the - OpenShift `OAuthClient` resource used to set up identity - federation on the OpenShift side. 0 means no expiration. + description: |- + Access token max age for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means no expiration. format: int32 type: integer oAuthClientName: @@ -8090,37 +8235,33 @@ spec: used to set up identity federation on the OpenShift side. type: string oAuthScope: - description: Access Token Scope. This field is specific to - Che installations made for Kubernetes only and ignored for - OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: - description: 'Name of the secret set in the OpenShift `OAuthClient` - resource used to set up identity federation on the OpenShift - side. For Kubernetes, this can either be the plain text - oAuthSecret value, or the name of a kubernetes secret which - contains a key `oAuthSecret` and the value is the secret. - NOTE: this secret must exist in the same namespace as the - `CheCluster` resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`.' + description: |- + Name of the secret set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + For Kubernetes, this can either be the plain text oAuthSecret value, or the name of a kubernetes secret which contains a + key `oAuthSecret` and the value is the secret. NOTE: this secret must exist in the same namespace as the `CheCluster` + resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`. type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the - domain to generate a hostname for the route. The generated hostname - follows this pattern: che-.. The - is the namespace where the CheCluster CRD is created. In conjunction - with labels, it creates a route served by a non-default Ingress - controller. For a Kubernetes cluster, it contains a global ingress - domain. There are no default values: you must specify them.' + description: |- + For an OpenShift cluster, the Operator uses the domain to generate a hostname for the route. + The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. + In conjunction with labels, it creates a route served by a non-default Ingress controller. + For a Kubernetes cluster, it contains a global ingress domain. There are no default values: you must specify them. type: string hostname: description: The public hostname of the installed Che server. type: string ingressClassName: - description: IngressClassName is the name of an IngressClass cluster - resource. If a class name is defined in both the `IngressClassName` - field and the `kubernetes.io/ingress.class` annotation, `IngressClassName` - field takes precedence. + description: |- + IngressClassName is the name of an IngressClass cluster resource. + If a class name is defined in both the `IngressClassName` field and the `kubernetes.io/ingress.class` annotation, + `IngressClassName` field takes precedence. type: string labels: additionalProperties: @@ -8129,10 +8270,10 @@ spec: route for OpenShift platform). type: object tlsSecretName: - description: The name of the secret used to set up Ingress TLS - termination. If the field is an empty string, the default cluster - certificate is used. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The name of the secret used to set up Ingress TLS termination. + If the field is an empty string, the default cluster certificate is used. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object type: object @@ -8166,10 +8307,10 @@ spec: the Che deployment is in the current phase. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either the - copy of the explicitly defined property of the same name in the - spec or, if it is undefined in the spec and we're running on OpenShift, - the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object type: object @@ -8177,12 +8318,6 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: v1 kind: ServiceAccount diff --git a/deploy/deployment/openshift/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml b/deploy/deployment/openshift/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml index 55160f8bd..635fd14d7 100644 --- a/deploy/deployment/openshift/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml +++ b/deploy/deployment/openshift/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml @@ -14,7 +14,7 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.14.0 service.beta.openshift.io/inject-cabundle: "true" labels: app.kubernetes.io/instance: che @@ -51,53 +51,57 @@ spec: a Che server installation properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: - description: 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. + description: |- + 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. properties: auth: description: Configuration settings related to the Authentication used by the Che installation. properties: debug: - description: Deprecated. The value of this flag is ignored. Debug - internal identity provider. + description: |- + Deprecated. The value of this flag is ignored. + Debug internal identity provider. type: boolean externalIdentityProvider: - description: 'Deprecated. The value of this flag is ignored. 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`.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: boolean gatewayAuthenticationSidecarImage: - description: Gateway sidecar responsible for authentication when - NativeUserMode is enabled. See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] - or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. + description: |- + Gateway sidecar responsible for authentication when NativeUserMode is enabled. + See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. type: string gatewayAuthorizationSidecarImage: - description: Gateway sidecar responsible for authorization when - NativeUserMode is enabled. See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] - or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] + description: |- + Gateway sidecar responsible for authorization when NativeUserMode is enabled. + See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] type: string gatewayConfigBumpEnv: description: List of environment variables to set in the Configbump @@ -111,15 +115,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -132,9 +137,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -143,12 +149,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -161,11 +166,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -185,6 +190,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -194,9 +200,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -205,6 +212,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -222,15 +230,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -243,9 +252,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -254,12 +264,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -272,11 +281,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -296,6 +305,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -305,9 +315,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -316,6 +327,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -337,15 +349,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -358,9 +371,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -369,12 +383,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -387,11 +400,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -411,6 +424,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -420,9 +434,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -431,6 +446,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -448,15 +464,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -469,9 +486,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -480,12 +498,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -498,11 +515,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -522,6 +539,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -531,9 +549,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -542,27 +561,28 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array identityProviderAdminUserName: - description: Deprecated. The value of this flag is ignored. Overrides - the name of the Identity Provider administrator user. Defaults - to `admin`. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the name of the Identity Provider administrator user. Defaults to `admin`. type: string identityProviderClientId: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string identityProviderContainerResources: - description: Deprecated. The value of this flag is ignored. Identity - provider container custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Identity provider container custom settings. properties: limits: description: Limits describes the maximum amount of compute @@ -590,21 +610,21 @@ spec: type: object type: object identityProviderImage: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderImagePullPolicy: - description: Deprecated. The value of this flag is ignored. Overrides - the image pull policy used in the Identity Provider, Keycloak - or RH-SSO, deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the image pull policy used in the Identity Provider, Keycloak or RH-SSO, deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string identityProviderIngress: - description: Deprecated. The value of this flag is ignored. Ingress - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Ingress custom settings. properties: annotations: additionalProperties: @@ -619,42 +639,39 @@ spec: type: string type: object identityProviderPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. - The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderRealm: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderRoute: - description: Deprecated. The value of this flag is ignored. Route - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Route custom settings. properties: annotations: additionalProperties: @@ -664,10 +681,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -675,49 +692,43 @@ spec: type: string type: object identityProviderSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderURL: - description: 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. + description: |- + 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. type: string identityToken: - description: 'Identity token to be passed to upstream. There are - two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che installations - made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string initialOpenShiftOAuthUser: - description: Deprecated. The value of this flag is ignored. 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 - in 'openshift-config' namespace by Operator. Note that this - solution is Openshift 4 platform-specific. + description: |- + Deprecated. The value of this flag is ignored. + 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 in 'openshift-config' namespace by Operator. + Note that this solution is Openshift 4 platform-specific. type: boolean nativeUserMode: - description: Deprecated. The value of this flag is ignored. Enables - native user mode. Currently works only on OpenShift and DevWorkspace - engine. Native User mode uses OpenShift OAuth directly as identity - provider, without Keycloak. + description: |- + Deprecated. The value of this flag is ignored. + Enables native user mode. Currently works only on OpenShift and DevWorkspace engine. + Native User mode uses OpenShift OAuth directly as identity provider, without Keycloak. type: boolean oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used @@ -725,8 +736,9 @@ spec: when left blank. See also the `OpenShiftoAuth` field. type: string oAuthScope: - description: Access Token Scope. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` @@ -735,19 +747,17 @@ spec: field. type: string openShiftoAuth: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean updateAdminPassword: - description: Deprecated. The value of this flag is ignored. Forces - the default `admin` Che user to update password on first login. - Defaults to `false`. + description: |- + Deprecated. The value of this flag is ignored. + Forces the default `admin` Che user to update password on first login. Defaults to `false`. type: boolean type: object dashboard: @@ -796,9 +806,9 @@ spec: to connect to the DB. Defaults to `dbche`. type: string chePostgresHostName: - description: 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`. + description: |- + 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. type: string chePostgresPassword: @@ -807,35 +817,29 @@ spec: automatically generated value. type: string chePostgresPort: - description: 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. + description: |- + 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. type: string chePostgresSecret: - description: '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 `postgres-credentials` will - be created with default value of `pgche` for `user` and with - an auto-generated value for `password`. The secret must have - `app.kubernetes.io/part-of=che.eclipse.org` label.' + description: |- + 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 `postgres-credentials` + will be created with default value of `pgche` for `user` and with an auto-generated value for `password`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string chePostgresUser: description: PostgreSQL user that the Che server uses to connect to the DB. Defaults to `pgche`. type: string externalDb: - description: '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`.' + description: |- + 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`. type: boolean postgresEnv: description: List of environment variables to set in the PostgreSQL @@ -849,15 +853,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -870,9 +875,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -881,12 +887,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -899,11 +904,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -923,6 +928,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -932,9 +938,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -943,6 +950,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -960,30 +968,29 @@ spec: `next` or `latest` images, and `IfNotPresent` in other cases. type: string postgresVersion: - description: 'Indicates a PostgreSQL version image to use. Allowed - values are: `9.6` and `13.3`. Migrate your PostgreSQL database - to switch from one version to another.' + description: |- + Indicates a PostgreSQL version image to use. Allowed values are: `9.6` and `13.3`. + Migrate your PostgreSQL database to switch from one version to another. type: string pvcClaimSize: - description: Size of the persistent volume claim for database. - Defaults to `1Gi`. To update pvc storageclass that provisions - it must support resize when Eclipse Che has been already deployed. + description: |- + Size of the persistent volume claim for database. Defaults to `1Gi`. + To update pvc storageclass that provisions it must support resize when Eclipse Che has been already deployed. type: string type: object devWorkspace: description: DevWorkspace operator configuration properties: controllerImage: - description: Overrides the container image used in the DevWorkspace - controller deployment. This includes the image tag. Omit it - or leave it empty to use the default container image provided - by the Operator. + description: |- + Overrides the container image used in the DevWorkspace controller deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string enable: - description: 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. + description: |- + 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. type: boolean env: description: List of environment variables to set in the DevWorkspace @@ -997,15 +1004,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1018,9 +1026,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1029,12 +1038,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1047,11 +1055,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1071,6 +1079,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1080,9 +1089,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1091,6 +1101,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1101,17 +1112,18 @@ spec: type: string secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer required: @@ -1129,15 +1141,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -1151,14 +1164,15 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -1172,14 +1186,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -1190,17 +1205,15 @@ spec: description: Kubernetes Image Puller configuration properties: enable: - description: 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. If the `spec.images` - field is empty, a set of recommended workspace-related images - will be automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + 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. + If the `spec.images` field is empty, a set of recommended workspace-related images will be automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A KubernetesImagePullerSpec to configure the image @@ -1241,24 +1254,21 @@ spec: made on upstream Kubernetes. properties: ingressClass: - description: '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.' + description: |- + 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. type: string ingressDomain: description: 'Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string securityContextFsGroup: description: The FSGroup in which the Che Pod and workspace Pods @@ -1269,22 +1279,17 @@ spec: run as. Default value is `1724`. type: string singleHostExposureType: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string tlsSecretName: - description: 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. + description: |- + 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. type: string type: object metrics: @@ -1301,73 +1306,69 @@ spec: the plugin and devfile registries properties: airGapContainerRegistryHostname: - description: 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. + description: |- + 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. type: string airGapContainerRegistryOrganization: - description: 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. + description: |- + 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. type: string allowAutoProvisionUserNamespace: - description: Indicates if is allowed to automatically create a - user namespace. If it set to false, then user namespace must - be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean allowUserDefinedWorkspaceNamespaces: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean cheClusterRoles: - description: A comma-separated list of ClusterRoles that will - be assigned to Che ServiceAccount. Each role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. Be aware that the Che Operator has to already have all - permissions in these ClusterRoles to grant them. + description: |- + A comma-separated list of ClusterRoles that will be assigned to Che ServiceAccount. + Each role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + Be aware that the Che Operator has to already have all permissions in these ClusterRoles to grant them. type: string cheDebug: description: Enables the debug mode for Che server. Defaults to `false`. type: string cheFlavor: - description: Deprecated. The value of this flag is ignored. Specifies - a variation of the installation. The options are `che` for - upstream Che installations or `devspaces` for Red Hat OpenShift - Dev Spaces (formerly Red Hat CodeReady Workspaces) installation + description: |- + Deprecated. The value of this flag is ignored. + Specifies a variation of the installation. The options are `che` for upstream Che installations or + `devspaces` for Red Hat OpenShift Dev Spaces (formerly Red Hat CodeReady Workspaces) installation type: string cheHost: - description: 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. + description: |- + 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. type: string cheHostTLSSecret: - description: Name of a secret containing certificates to secure - ingress or route for the custom host name of the installed Che - server. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. See the `cheHost` field. + description: |- + Name of a secret containing certificates to secure ingress or route for the custom host name of the installed Che server. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. + See the `cheHost` field. type: string cheImage: - description: 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. + description: |- + 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. type: string cheImagePullPolicy: - description: Overrides the image pull policy used in Che deployment. - Default value is `Always` for `nightly`, `next` or `latest` - images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in Che deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string cheImageTag: - description: 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. + description: |- + 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. type: string cheLogLevel: description: 'Log level for the Che server: `INFO` or `DEBUG`. @@ -1385,15 +1386,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1406,9 +1408,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1417,12 +1420,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1435,11 +1437,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1459,6 +1461,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1468,9 +1471,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1479,6 +1483,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1510,10 +1515,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1521,27 +1526,28 @@ spec: type: string type: object cheWorkspaceClusterRole: - description: Custom cluster role bound to the user for the Che - workspaces. The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. The default roles are used when omitted or left blank. + description: |- + Custom cluster role bound to the user for the Che workspaces. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string - description: 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. + description: |- + 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. type: object dashboardCpuLimit: - description: Overrides the CPU limit used in the dashboard deployment. + description: |- + Overrides the CPU limit used in the dashboard deployment. In cores. (500m = .5 cores). Default to 500m. type: string dashboardCpuRequest: - description: Overrides the CPU request used in the dashboard deployment. + description: |- + Overrides the CPU request used in the dashboard deployment. In cores. (500m = .5 cores). Default to 100m. type: string dashboardEnv: @@ -1556,15 +1562,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1577,9 +1584,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1588,12 +1596,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1606,11 +1613,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1630,6 +1637,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1639,9 +1647,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1650,24 +1659,26 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array dashboardImage: - description: Overrides the container image used in the dashboard - deployment. This includes the image tag. Omit it or leave it - empty to use the default container image provided by the Operator. + description: |- + Overrides the container image used in the dashboard deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string dashboardImagePullPolicy: - description: Overrides the image pull policy used in the dashboard - deployment. Default value is `Always` for `nightly`, `next` - or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the dashboard deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string dashboardIngress: - description: Deprecated. The value of this flag is ignored. Dashboard - ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard ingress custom settings. properties: annotations: additionalProperties: @@ -1690,8 +1701,9 @@ spec: deployment. Defaults to 16Mi. type: string dashboardRoute: - description: Deprecated. The value of this flag is ignored. Dashboard - route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard route custom settings. properties: annotations: additionalProperties: @@ -1701,10 +1713,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1712,12 +1724,14 @@ spec: type: string type: object devfileRegistryCpuLimit: - description: Overrides the CPU limit used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string devfileRegistryCpuRequest: - description: Overrides the CPU request used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string devfileRegistryEnv: description: List of environment variables to set in the plugin @@ -1731,15 +1745,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1752,9 +1767,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1763,12 +1779,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1781,11 +1796,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1805,6 +1820,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1814,9 +1830,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1825,20 +1842,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array devfileRegistryImage: - description: 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. + description: |- + 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. type: string devfileRegistryIngress: - description: Deprecated. The value of this flag is ignored. The - devfile registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry ingress custom settings. properties: annotations: additionalProperties: @@ -1861,13 +1879,14 @@ spec: registry deployment. Defaults to 16Mi. type: string devfileRegistryPullPolicy: - description: Overrides the image pull policy used in the devfile - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the devfile registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string devfileRegistryRoute: - description: Deprecated. The value of this flag is ignored. The - devfile registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry route custom settings. properties: annotations: additionalProperties: @@ -1877,10 +1896,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1892,14 +1911,14 @@ spec: fields. type: string disableInternalClusterSVCNames: - description: Deprecated. The value of this flag is ignored. Disable - internal cluster SVC names usage to communicate between components - to speed up the traffic and avoid proxy issues. + description: |- + Deprecated. The value of this flag is ignored. + Disable internal cluster SVC names usage to communicate between components to speed up the traffic and avoid proxy issues. type: boolean externalDevfileRegistries: - description: External devfile registries, that serves sample, - ready-to-use devfiles. Configure this in addition to a dedicated - devfile registry (when `externalDevfileRegistry` is `false`) + description: |- + External devfile registries, that serves sample, ready-to-use devfiles. + Configure this in addition to a dedicated devfile registry (when `externalDevfileRegistry` is `false`) or instead of it (when `externalDevfileRegistry` is `true`) items: description: Settings for a configuration of the external devfile @@ -1911,50 +1930,44 @@ spec: type: object type: array externalDevfileRegistry: - description: 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 - configure at least one devfile registry with `externalDevfileRegistries` - field. + description: |- + 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 configure at least one + devfile registry with `externalDevfileRegistries` field. type: boolean externalPluginRegistry: - description: 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. + description: |- + 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. type: boolean gitSelfSignedCert: - description: When enabled, the certificate from `che-git-self-signed-cert` - ConfigMap will be propagated to the Che components and provide - particular configuration for Git. Note, the `che-git-self-signed-cert` - ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + When enabled, the certificate from `che-git-self-signed-cert` ConfigMap will be propagated to the Che components and provide particular configuration for Git. + Note, the `che-git-self-signed-cert` ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: boolean nonProxyHosts: - description: 'List of hosts that will be reached directly, bypassing - the proxy. Specify wild card domain use the following form `.` - 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.' + description: |- + List of hosts that will be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.` 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. type: string openVSXRegistryURL: description: Open VSX registry URL. If omitted an embedded instance will be used. type: string pluginRegistryCpuLimit: - description: Overrides the CPU limit used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string pluginRegistryCpuRequest: - description: Overrides the CPU request used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string pluginRegistryEnv: description: List of environment variables to set in the devfile @@ -1968,15 +1981,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1989,9 +2003,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -2000,12 +2015,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -2018,11 +2032,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -2042,6 +2056,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -2051,9 +2066,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -2062,20 +2078,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array pluginRegistryImage: - description: 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. + description: |- + 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. type: string pluginRegistryIngress: - description: Deprecated. The value of this flag is ignored. Plugin - registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry ingress custom settings. properties: annotations: additionalProperties: @@ -2098,13 +2115,14 @@ spec: deployment. Defaults to 16Mi. type: string pluginRegistryPullPolicy: - description: Overrides the image pull policy used in the plugin - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the plugin registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string pluginRegistryRoute: - description: Deprecated. The value of this flag is ignored. Plugin - registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry route custom settings. properties: annotations: additionalProperties: @@ -2114,10 +2132,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -2125,16 +2143,15 @@ spec: type: string type: object pluginRegistryUrl: - description: 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. + description: |- + 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. type: string proxyPassword: - description: Password of the proxy server. Only use when proxy - configuration is required. See the `proxyURL`, `proxyUser` and - `proxySecret` fields. + description: |- + Password of the proxy server. + Only use when proxy configuration is required. See the `proxyURL`, `proxyUser` and `proxySecret` fields. type: string proxyPort: description: Port of the proxy server. Only use when configuring @@ -2142,22 +2159,18 @@ spec: fields. type: string proxySecret: - description: The secret that contains `user` and `password` for - a proxy server. When the secret is defined, the `proxyUser` - and `proxyPassword` are ignored. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The secret that contains `user` and `password` for a proxy server. When the secret is defined, the `proxyUser` and `proxyPassword` are ignored. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string proxyURL: - description: 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. + description: |- + 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. type: string proxyUser: description: User name of the proxy server. Only use when configuring @@ -2165,31 +2178,29 @@ spec: and `proxySecret` fields. type: string selfSignedCert: - description: 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. + description: |- + 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. type: boolean serverCpuLimit: - description: Overrides the CPU limit used in the Che server deployment + description: |- + Overrides the CPU limit used in the Che server deployment In cores. (500m = .5 cores). Default to 1. type: string serverCpuRequest: - description: Overrides the CPU request used in the Che server - deployment In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the Che server deployment + In cores. (500m = .5 cores). Default to 100m. type: string serverExposureStrategy: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string serverMemoryLimit: description: Overrides the memory limit used in the Che server @@ -2200,13 +2211,11 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: 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. - The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + 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. + The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string singleHostGatewayConfigMapLabels: additionalProperties: @@ -2233,9 +2242,9 @@ spec: description: Deprecated in favor of `disableInternalClusterSVCNames`. type: boolean workspaceDefaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile does - not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile does not contain any components. items: properties: attributes: @@ -2274,20 +2283,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -2296,10 +2305,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -2311,28 +2322,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2347,24 +2369,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2374,15 +2403,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2390,10 +2418,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -2412,17 +2447,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -2432,18 +2469,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -2453,19 +2489,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -2478,8 +2515,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -2499,18 +2539,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -2529,32 +2566,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -2564,9 +2601,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -2582,14 +2619,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2601,28 +2641,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2637,24 +2688,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2664,15 +2722,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2693,22 +2750,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2720,28 +2780,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2756,24 +2827,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2783,15 +2861,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2812,32 +2889,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -2863,9 +2944,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -2881,9 +2962,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -2911,9 +2992,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -2925,23 +3006,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -2972,40 +3056,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -3014,9 +3098,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -3055,21 +3139,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -3078,10 +3161,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -3094,31 +3179,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3132,29 +3224,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3164,27 +3258,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -3202,18 +3300,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -3223,20 +3321,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -3248,9 +3343,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -3272,21 +3369,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -3305,34 +3396,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -3342,10 +3429,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -3360,16 +3446,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3382,31 +3469,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3420,29 +3514,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3452,17 +3548,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3483,24 +3576,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3513,31 +3607,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3551,29 +3652,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3583,17 +3686,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3614,13 +3714,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3653,34 +3754,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3692,16 +3793,16 @@ spec: type: array workspaceDefaultEditor: default: che-incubator/che-code/latest - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/plugin/version`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/plugin/version`. The URI must start from `http`. type: string workspaceNamespaceDefault: - description: 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 ``, `` and `` - placeholders, such as che-workspace-. In that case, - a new namespace will be created for each user or workspace. + description: |- + 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 ``, `` and `` placeholders, such as che-workspace-. + In that case, a new namespace will be created for each user or workspace. type: string workspacePodNodeSelector: additionalProperties: @@ -3713,41 +3814,39 @@ spec: description: The pod tolerations put on the workspace pods to limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -3784,26 +3883,23 @@ spec: storage class is used. type: string preCreateSubPaths: - description: 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. + description: |- + 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. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. Defaults to `10Gi`. type: string pvcJobsImage: - description: 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. + description: |- + 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. type: string pvcStrategy: - description: 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`. + description: |- + 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`. type: string workspacePVCStorageClassName: description: Storage class for the Persistent Volume Claims dedicated @@ -3836,15 +3932,14 @@ spec: description: The status of the Devworkspace subsystem properties: gatewayHost: - description: GatewayHost is the resolved host of the ingress/route. - This is equal to the Host in the spec on Kubernetes but contains - the actual host name of the route if Host is unspecified on - OpenShift. + description: |- + GatewayHost is the resolved host of the ingress/route. This is equal to the Host in the spec + on Kubernetes but contains the actual host name of the route if Host is unspecified on OpenShift. type: string gatewayPhase: - description: GatewayPhase specifies the phase in which the gateway - deployment currently is. If the gateway is disabled, the phase - is "Inactive". + description: |- + GatewayPhase specifies the phase in which the gateway deployment currently is. + If the gateway is disabled, the phase is "Inactive". type: string message: description: Message contains further human-readable info for @@ -3859,10 +3954,10 @@ spec: why the Che cluster is in this state. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either - the copy of the explicitly defined property of the same name - in the spec or, if it is undefined in the spec and we're running - on OpenShift, the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object gitHubOAuthProvisioned: @@ -3913,22 +4008,26 @@ spec: - name: v2 schema: openAPIV3Schema: - description: 'The `CheCluster` custom resource allows defining and managing - Eclipse Che server installation. Based on these settings, the Operator - automatically creates and maintains several ConfigMaps: `che`, `plugin-registry`, - `devfile-registry` that will contain the appropriate environment variables - of the various components of the installation. These generated ConfigMaps - must NOT be updated manually.' + description: |- + The `CheCluster` custom resource allows defining and managing Eclipse Che server installation. + Based on these settings, the Operator automatically creates and maintains several ConfigMaps: + `che`, `plugin-registry`, `devfile-registry` that will contain the appropriate environment variables + of the various components of the installation. These generated ConfigMaps must NOT be updated manually. properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object @@ -3952,14 +4051,15 @@ spec: server. properties: clusterRoles: - description: 'Additional ClusterRoles assigned to Che ServiceAccount. - Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. The defaults roles are: - `-cheworkspaces-clusterrole` + description: |- + Additional ClusterRoles assigned to Che ServiceAccount. + Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` label. + The defaults roles are: + - `-cheworkspaces-clusterrole` - `-cheworkspaces-namespaces-clusterrole` - `-cheworkspaces-devworkspace-clusterrole` - where the is the namespace where the CheCluster - CR is created. The Che Operator must already have all permissions - in these ClusterRoles to grant them.' + where the is the namespace where the CheCluster CR is created. + The Che Operator must already have all permissions in these ClusterRoles to grant them. items: type: string type: array @@ -3987,18 +4087,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4011,10 +4109,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4023,12 +4121,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4042,13 +4139,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4070,6 +4165,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4080,10 +4176,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4092,6 +4188,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4126,23 +4223,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4154,23 +4248,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4196,13 +4287,11 @@ spec: extraProperties: additionalProperties: type: string - description: A map of additional environment variables 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). If the `extraProperties` - field contains a property normally generated in `che` ConfigMap - from other CR fields, the value defined in the `extraProperties` - is used instead. + description: |- + A map of additional environment variables 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). + If the `extraProperties` field contains a property normally generated in `che` ConfigMap from other CR fields, + the value defined in the `extraProperties` is used instead. type: object logLevel: default: INFO @@ -4210,27 +4299,25 @@ spec: `DEBUG`.' type: string proxy: - description: Proxy server settings for Kubernetes cluster. - No additional configuration is required for OpenShift cluster. - By specifying these settings for the OpenShift cluster, - you override the OpenShift proxy configuration. + description: |- + Proxy server settings for Kubernetes cluster. No additional configuration is required for OpenShift cluster. + By specifying these settings for the OpenShift cluster, you override the OpenShift proxy configuration. properties: credentialsSecretName: - description: The secret name that contains `user` and - `password` for a proxy server. The secret must have - a `app.kubernetes.io/part-of=che.eclipse.org` label. + description: |- + The secret name that contains `user` and `password` for a proxy server. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string nonProxyHosts: - description: 'A list of hosts that can be reached directly, - bypassing the proxy. Specify wild card domain use the - following form `.`, for example: - localhost - - my.host.com - 123.42.12.32 Use only when a proxy - configuration is required. The Operator respects OpenShift - cluster-wide proxy configuration, defining `nonProxyHosts` - in a custom resource leads to merging non-proxy hosts - lists from the cluster proxy configuration, and the - ones defined in the custom resources. See the following - page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + A list of hosts that can be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.`, for example: + - localhost + - my.host.com + - 123.42.12.32 + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `nonProxyHosts` in a custom resource leads to merging non-proxy hosts lists from the cluster proxy configuration, and the ones defined in the custom resources. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. items: type: string type: array @@ -4238,12 +4325,11 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. - Use only when a proxy configuration is required. The - Operator respects OpenShift cluster-wide proxy configuration, - defining `url` in a custom resource leads to overriding - the cluster proxy configuration. See the following page: - https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + URL (protocol+hostname) of the proxy server. + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `url` in a custom resource leads to overriding the cluster proxy configuration. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. type: string type: object type: object @@ -4286,18 +4372,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4310,10 +4394,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4322,12 +4406,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4341,13 +4424,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4369,6 +4450,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4379,10 +4461,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4391,6 +4473,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4425,23 +4508,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4453,23 +4533,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4519,7 +4596,8 @@ spec: description: DevWorkspace Operator configuration. properties: runningLimit: - description: Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` + description: |- + Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` The maximum number of running workspaces per user. type: string type: object @@ -4547,18 +4625,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4571,10 +4647,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4583,12 +4659,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4602,13 +4677,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4630,6 +4703,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4640,10 +4714,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4652,6 +4726,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4686,23 +4761,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4714,23 +4786,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4773,18 +4842,15 @@ spec: description: Kubernetes Image Puller configuration. properties: enable: - description: Install and configure the community supported - Kubernetes Image Puller Operator. When you set the value - to `true` without providing any specs, it creates a default - Kubernetes Image Puller object managed by the Operator. - When you set the value to `false`, the Kubernetes Image - Puller object is deleted, and the Operator uninstalled, - regardless of whether a spec is provided. If you leave the - `spec.images` field empty, a set of recommended workspace-related - images is automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + Install and configure the community supported Kubernetes Image Puller Operator. When you set the value to `true` without providing any specs, + it creates a default Kubernetes Image Puller object managed by the Operator. + When you set the value to `false`, the Kubernetes Image Puller object is deleted, and the Operator uninstalled, + regardless of whether a spec is provided. + If you leave the `spec.images` field empty, a set of recommended workspace-related images is automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A Kubernetes Image Puller spec to configure the @@ -4852,18 +4918,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4876,10 +4940,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4888,12 +4952,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4907,13 +4970,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4935,6 +4996,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4945,10 +5007,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4957,6 +5019,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4991,23 +5054,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5019,23 +5079,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5082,18 +5139,16 @@ spec: Che images. properties: hostname: - description: An optional hostname or URL of an alternative container - registry to pull images from. This value overrides the container - registry hostname defined in all the default container images - involved in a Che deployment. This is particularly useful for - installing Che in a restricted environment. + description: |- + An optional hostname or URL of an alternative container registry to pull images from. + This value overrides the container registry hostname defined in all the default container images involved in a Che deployment. + This is particularly useful for installing Che in a restricted environment. type: string organization: - description: An optional repository name of an alternative 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 for installing - Eclipse Che in a restricted environment. + description: |- + An optional repository name of an alternative 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 for installing Eclipse Che in a restricted environment. type: string type: object devEnvironments: @@ -5119,9 +5174,9 @@ spec: type: string type: object defaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile, that - does not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile, that does not contain any components. items: properties: attributes: @@ -5160,20 +5215,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5182,10 +5237,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5197,28 +5254,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5233,24 +5301,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5260,15 +5335,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5276,10 +5350,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -5298,17 +5379,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -5318,18 +5401,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -5339,19 +5421,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -5364,8 +5447,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -5385,18 +5471,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -5415,32 +5498,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -5450,9 +5533,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -5468,14 +5551,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5487,28 +5573,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5523,24 +5620,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5550,15 +5654,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5579,22 +5682,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5606,28 +5712,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5642,24 +5759,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5669,15 +5793,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5698,32 +5821,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -5749,9 +5876,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -5767,9 +5894,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -5797,9 +5924,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -5811,23 +5938,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -5858,40 +5988,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -5900,9 +6030,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -5941,21 +6071,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5964,10 +6093,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5980,31 +6111,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6018,29 +6156,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6050,27 +6190,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -6088,18 +6232,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -6109,20 +6253,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -6134,9 +6275,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -6158,21 +6301,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -6191,34 +6328,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -6228,10 +6361,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -6246,16 +6378,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6268,31 +6401,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6306,29 +6446,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6338,17 +6480,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6369,24 +6508,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6399,31 +6539,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6437,29 +6584,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6469,17 +6618,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6500,13 +6646,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6539,34 +6686,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6577,9 +6724,10 @@ spec: type: object type: array defaultEditor: - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/name/version` - format. The URI must start from `http://` or `https://`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/name/version` format. + The URI must start from `http://` or `https://`. type: string defaultNamespace: default: @@ -6589,16 +6737,15 @@ spec: properties: autoProvision: default: true - description: Indicates if is allowed to automatically create - a user namespace. If it set to false, then user namespace - must be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean template: default: -che - description: If you don't create the user namespaces in advance, - this field defines the Kubernetes namespace created when - you start your first workspace. You can use `` - and `` placeholders, such as che-workspace-. + description: |- + If you don't create the user namespaces in advance, this field defines the Kubernetes namespace created when you start your first workspace. + You can use `` and `` placeholders, such as che-workspace-. pattern: | type: string type: object @@ -6607,7 +6754,8 @@ spec: items: properties: editor: - description: The editor ID to specify default plug-ins for. + description: |- + The editor ID to specify default plug-ins for. The plugin ID must have `publisher/name/version` format. type: string plugins: @@ -6618,25 +6766,30 @@ spec: type: object type: array deploymentStrategy: - description: DeploymentStrategy defines the deployment strategy - to use to replace existing workspace pods with new ones. The - available deployment stragies are `Recreate` and `RollingUpdate`. - With the `Recreate` deployment strategy, the existing workspace - pod is killed before the new one is created. With the `RollingUpdate` - deployment strategy, a new workspace pod is created and the - existing workspace pod is deleted only when the new workspace - pod is in a ready state. If not specified, the default `Recreate` - deployment strategy is used. + description: |- + DeploymentStrategy defines the deployment strategy to use to replace existing workspace pods + with new ones. The available deployment stragies are `Recreate` and `RollingUpdate`. + With the `Recreate` deployment strategy, the existing workspace pod is killed before the new one is created. + With the `RollingUpdate` deployment strategy, a new workspace pod is created and the existing workspace pod is deleted + only when the new workspace pod is in a ready state. + If not specified, the default `Recreate` deployment strategy is used. enum: - Recreate - RollingUpdate type: string disableContainerBuildCapabilities: - description: "Disables the container build capabilities. When - set to `false` (the default value), the devEnvironments.security.containerSecurityContext - field is ignored, and the following container SecurityContext - is applied: \n containerSecurityContext: allowPrivilegeEscalation: - true capabilities: add: - SETGID - SETUID" + description: |- + Disables the container build capabilities. + When set to `false` (the default value), the devEnvironments.security.containerSecurityContext + field is ignored, and the following container SecurityContext is applied: + + + containerSecurityContext: + allowPrivilegeEscalation: true + capabilities: + add: + - SETGID + - SETUID type: boolean gatewayContainer: description: GatewayContainer configuration. @@ -6652,16 +6805,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6674,10 +6827,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6686,12 +6839,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6704,12 +6856,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6729,6 +6880,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6738,10 +6890,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6750,6 +6902,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -6782,19 +6935,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6807,19 +6960,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6835,16 +6988,17 @@ spec: - Never type: string maxNumberOfRunningWorkspacesPerUser: - description: The maximum number of running workspaces per user. + description: |- + The maximum number of running workspaces per user. The value, -1, allows users to run an unlimited number of workspaces. format: int64 minimum: -1 type: integer maxNumberOfWorkspacesPerUser: default: -1 - description: Total number of workspaces, both stopped and running, - that a user can keep. The value, -1, allows users to keep an - unlimited number of workspaces. + description: |- + Total number of workspaces, both stopped and running, that a user can keep. + The value, -1, allows users to keep an unlimited number of workspaces. format: int64 minimum: -1 type: integer @@ -6855,19 +7009,22 @@ spec: workspace pods. type: object persistUserHome: - description: PersistUserHome defines configuration options for - persisting the user home directory in workspaces. + description: |- + PersistUserHome defines configuration options for persisting the + user home directory in workspaces. properties: enabled: - description: Determines whether the user home directory in - workspaces should persist between workspace shutdown and - startup. Must be used with the 'per-user' or 'per-workspace' - PVC strategy in order to take effect. Disabled by default. + description: |- + Determines whether the user home directory in workspaces should persist between + workspace shutdown and startup. + Must be used with the 'per-user' or 'per-workspace' PVC strategy in order to take effect. + Disabled by default. type: boolean type: object podSchedulerName: - description: Pod scheduler for the workspace pods. If not specified, - the pod scheduler is set to the default scheduler on the cluster. + description: |- + Pod scheduler for the workspace pods. + If not specified, the pod scheduler is set to the default scheduler on the cluster. type: string projectCloneContainer: description: Project clone container configuration. @@ -6883,16 +7040,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6905,10 +7062,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6917,12 +7074,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6935,12 +7091,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6960,6 +7115,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6969,10 +7125,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6981,6 +7137,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7013,19 +7170,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7038,19 +7195,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7059,42 +7216,44 @@ spec: type: object secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer security: description: Workspace security configuration. properties: containerSecurityContext: - description: Container SecurityContext used by all workspace-related - containers. If set, defined values are merged into the default - Container SecurityContext configuration. Requires devEnvironments.disableContainerBuildCapabilities - to be set to `true` in order to take effect. + description: |- + Container SecurityContext used by all workspace-related containers. + If set, defined values are merged into the default Container SecurityContext configuration. + Requires devEnvironments.disableContainerBuildCapabilities to be set to `true` in order to take effect. properties: allowPrivilegeEscalation: - description: 'AllowPrivilegeEscalation controls whether - a process can gain more privileges than its parent process. - This bool directly controls if the no_new_privs flag - will be set on the container process. AllowPrivilegeEscalation - is true always when the container is: 1) run as Privileged - 2) has CAP_SYS_ADMIN Note that this field cannot be - set when spec.os.name is windows.' + description: |- + AllowPrivilegeEscalation controls whether a process can gain more + privileges than its parent process. This bool directly controls if + the no_new_privs flag will be set on the container process. + AllowPrivilegeEscalation is true always when the container is: + 1) run as Privileged + 2) has CAP_SYS_ADMIN + Note that this field cannot be set when spec.os.name is windows. type: boolean capabilities: - description: The capabilities to add/drop when running - containers. Defaults to the default set of capabilities - granted by the container runtime. Note that this field - cannot be set when spec.os.name is windows. + description: |- + The capabilities to add/drop when running containers. + Defaults to the default set of capabilities granted by the container runtime. + Note that this field cannot be set when spec.os.name is windows. properties: add: description: Added capabilities @@ -7112,61 +7271,60 @@ spec: type: array type: object privileged: - description: Run container in privileged mode. Processes - in privileged containers are essentially equivalent - to root on the host. Defaults to false. Note that this - field cannot be set when spec.os.name is windows. + description: |- + Run container in privileged mode. + Processes in privileged containers are essentially equivalent to root on the host. + Defaults to false. + Note that this field cannot be set when spec.os.name is windows. type: boolean procMount: - description: procMount denotes the type of proc mount - to use for the containers. The default is DefaultProcMount - which uses the container runtime defaults for readonly - paths and masked paths. This requires the ProcMountType - feature flag to be enabled. Note that this field cannot - be set when spec.os.name is windows. + description: |- + procMount denotes the type of proc mount to use for the containers. + The default is DefaultProcMount which uses the container runtime defaults for + readonly paths and masked paths. + This requires the ProcMountType feature flag to be enabled. + Note that this field cannot be set when spec.os.name is windows. type: string readOnlyRootFilesystem: - description: Whether this container has a read-only root - filesystem. Default is false. Note that this field cannot - be set when spec.os.name is windows. + description: |- + Whether this container has a read-only root filesystem. + Default is false. + Note that this field cannot be set when spec.os.name is windows. type: boolean runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to the - container. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The SELinux context to be applied to the container. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7186,137 +7344,135 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by this container. - If seccomp options are provided at both the pod & container - level, the container options override the pod options. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The seccomp options to use by this container. If seccomp options are + provided at both the pod & container level, the container options + override the pod options. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options from the - PodSecurityContext will be used. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options from the PodSecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object podSecurityContext: - description: PodSecurityContext used by all workspace-related - pods. If set, defined values are merged into the default - PodSecurityContext configuration. + description: |- + PodSecurityContext used by all workspace-related pods. + If set, defined values are merged into the default PodSecurityContext configuration. properties: fsGroup: - description: "A special supplemental group that applies - to all containers in a pod. Some volume types allow - the Kubelet to change the ownership of that volume to - be owned by the pod: \n 1. The owning GID will be the - FSGroup 2. The setgid bit is set (new files created - in the volume will be owned by FSGroup) 3. The permission - will not modify the ownership and permissions of any - volume. Note that this field cannot be set when spec.os.name - is windows." + description: |- + A special supplemental group that applies to all containers in a pod. + Some volume types allow the Kubelet to change the ownership of that volume + to be owned by the pod: + + + 1. The owning GID will be the FSGroup + 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) + + + If unset, the Kubelet will not modify the ownership and permissions of any volume. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer fsGroupChangePolicy: - description: 'fsGroupChangePolicy defines behavior of - changing ownership and permission of the volume before - being exposed inside Pod. This field will only apply - to volume types which support fsGroup based ownership(and - permissions). It will have no effect on ephemeral volume - types such as: secret, configmaps and emptydir. Valid - values are "OnRootMismatch" and "Always". If not specified, - "Always" is used. Note that this field cannot be set - when spec.os.name is windows.' + description: |- + fsGroupChangePolicy defines behavior of changing ownership and permission of the volume + before being exposed inside Pod. This field will only apply to + volume types which support fsGroup based ownership(and permissions). + It will have no effect on ephemeral volume types such as: secret, configmaps + and emptydir. + Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + Note that this field cannot be set when spec.os.name is windows. type: string runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in SecurityContext. If set - in both SecurityContext and PodSecurityContext, the - value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in SecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence - for that container. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to all - containers. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The SELinux context to be applied to all containers. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in SecurityContext. If set in + both SecurityContext and PodSecurityContext, the value specified in SecurityContext + takes precedence for that container. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7336,49 +7492,48 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by the containers - in this pod. Note that this field cannot be set when - spec.os.name is windows. + description: |- + The seccomp options to use by the containers in this pod. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object supplementalGroups: - description: A list of groups applied to the first process - run in each container, in addition to the container's - primary GID, the fsGroup (if specified), and group memberships - defined in the container image for the uid of the container - process. If unspecified, no additional groups are added - to any container. Note that group memberships defined - in the container image for the uid of the container - process are still effective, even if they are not included - in this list. Note that this field cannot be set when - spec.os.name is windows. + description: |- + A list of groups applied to the first process run in each container, in addition + to the container's primary GID, the fsGroup (if specified), and group memberships + defined in the container image for the uid of the container process. If unspecified, + no additional groups are added to any container. Note that group memberships + defined in the container image for the uid of the container process are still effective, + even if they are not included in this list. + Note that this field cannot be set when spec.os.name is windows. items: format: int64 type: integer type: array sysctls: - description: Sysctls hold a list of namespaced sysctls - used for the pod. Pods with unsupported sysctls (by - the container runtime) might fail to launch. Note that - this field cannot be set when spec.os.name is windows. + description: |- + Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported + sysctls (by the container runtime) might fail to launch. + Note that this field cannot be set when spec.os.name is windows. items: description: Sysctl defines a kernel parameter to be set @@ -7395,43 +7550,38 @@ spec: type: object type: array windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options within a - container's SecurityContext will be used. If set in - both SecurityContext and PodSecurityContext, the value - specified in SecurityContext takes precedence. Note - that this field cannot be set when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options within a container's SecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object @@ -7448,37 +7598,39 @@ spec: items: properties: audience: - description: Audience is the intended audience of the token. - A recipient of a token must identify itself with an identifier - specified in the audience of the token, and otherwise - should reject the token. The audience defaults to the + description: |- + Audience is the intended audience of the token. A recipient of a token + must identify itself with an identifier specified in the audience of the + token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. type: string expirationSeconds: default: 3600 - description: ExpirationSeconds is the requested duration - of validity of the service account token. As the token - approaches expiration, the kubelet volume plugin will - proactively rotate the service account token. The kubelet - will start trying to rotate the token if the token is - older than 80 percent of its time to live or if the token - is older than 24 hours. Defaults to 1 hour and must be - at least 10 minutes. + description: |- + ExpirationSeconds is the requested duration of validity of the service + account token. As the token approaches expiration, the kubelet volume + plugin will proactively rotate the service account token. The kubelet will + start trying to rotate the token if the token is older than 80 percent of + its time to live or if the token is older than 24 hours. Defaults to 1 hour + and must be at least 10 minutes. format: int64 minimum: 600 type: integer mountPath: - description: Path within the workspace container at which - the token should be mounted. Must not contain ':'. + description: |- + Path within the workspace container at which the token should be mounted. Must + not contain ':'. type: string name: - description: Identifiable name of the ServiceAccount token. - If multiple ServiceAccount tokens use the same mount path, - a generic name will be used for the projected volume instead. + description: |- + Identifiable name of the ServiceAccount token. + If multiple ServiceAccount tokens use the same mount path, a generic name will be used + for the projected volume instead. type: string path: - description: Path is the path relative to the mount point - of the file to project the token into. + description: |- + Path is the path relative to the mount point of the file to project the + token into. type: string required: - mountPath @@ -7488,10 +7640,10 @@ spec: type: array startTimeoutSeconds: default: 300 - description: StartTimeoutSeconds determines the maximum duration - (in seconds) that a workspace can take to start before it is - automatically failed. If not specified, the default value of - 300 seconds (5 minutes) is used. + description: |- + StartTimeoutSeconds determines the maximum duration (in seconds) that a workspace can take to start + before it is automatically failed. + If not specified, the default value of 300 seconds (5 minutes) is used. format: int32 minimum: 1 type: integer @@ -7531,12 +7683,12 @@ spec: type: object pvcStrategy: default: per-user - description: 'Persistent volume claim strategy for the Che - server. The supported strategies are: `per-user` (all workspaces - PVCs in one volume), `per-workspace` (each workspace is - given its own individual PVC) and `ephemeral` (non-persistent - storage where local changes will be lost when the workspace - is stopped.)' + description: |- + Persistent volume claim strategy for the Che server. + The supported strategies are: `per-user` (all workspaces PVCs in one volume), + `per-workspace` (each workspace is given its own individual PVC) + and `ephemeral` (non-persistent storage where local changes will be lost when + the workspace is stopped.) enum: - common - per-user @@ -7548,41 +7700,39 @@ spec: description: The pod tolerations of the workspace pods limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -7590,20 +7740,19 @@ spec: description: Trusted certificate settings. properties: gitTrustedCertsConfigMapName: - description: 'The ConfigMap contains certificates to propagate - to the Che components and to provide a particular configuration - for Git. See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ - The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + The ConfigMap contains certificates to propagate to the Che components and to provide a particular configuration for Git. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ + The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object user: description: User configuration. properties: clusterRoles: - description: Additional ClusterRoles assigned to the user. - The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + Additional ClusterRoles assigned to the user. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. items: type: string type: array @@ -7621,9 +7770,9 @@ spec: hosted on Azure DevOps Service (dev.azure.com). properties: secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Azure DevOps Service Application ID and Client Secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services' + description: |- + Kubernetes secret, that contains Base64-encoded Azure DevOps Service Application ID and Client Secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services type: string required: - secretName @@ -7637,15 +7786,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -7659,19 +7809,21 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: disableSubdomainIsolation: - description: 'Disables subdomain isolation. Deprecated in - favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` - annotation. See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Disables subdomain isolation. + Deprecated in favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: boolean endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -7685,14 +7837,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -7711,10 +7864,13 @@ spec: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set for an Ingress - (a route for OpenShift platform). The defaults for kubernetes - platforms are: kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", nginx.ingress.kubernetes.io/proxy-connect-timeout: - "3600", nginx.ingress.kubernetes.io/ssl-redirect: "true"' + description: |- + Defines annotations which will be set for an Ingress (a route for OpenShift platform). + The defaults for kubernetes platforms are: + kubernetes.io/ingress.class: "nginx" + nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", + nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600", + nginx.ingress.kubernetes.io/ssl-redirect: "true" type: object auth: default: @@ -7725,15 +7881,12 @@ spec: description: Authentication settings. properties: advancedAuthorization: - description: Advance authorization settings. Determines which - users and groups are allowed to access Che. User is allowed - to access Che if he/she is either in the `allowUsers` list - or is member of group from `allowGroups` list and not in - neither the `denyUsers` list nor is member of group from - `denyGroups` list. If `allowUsers` and `allowGroups` are - empty, then all users are allowed to access Che. if `denyUsers` - and `denyGroups` are empty, then no users are denied to - access Che. + description: |- + Advance authorization settings. Determines which users and groups are allowed to access Che. + User is allowed to access Che if he/she is either in the `allowUsers` list or is member of group from `allowGroups` list + and not in neither the `denyUsers` list nor is member of group from `denyGroups` list. + If `allowUsers` and `allowGroups` are empty, then all users are allowed to access Che. + if `denyUsers` and `denyGroups` are empty, then no users are denied to access Che. properties: allowGroups: description: List of groups allowed to access Che (currently @@ -7774,10 +7927,13 @@ spec: description: Gateway configuration labels. type: object deployment: - description: 'Deployment override options. Since gateway - deployment consists of several containers, they must - be distinguished in the configuration by their names: - - `gateway` - `configbump` - `oauth-proxy` - `kube-rbac-proxy`' + description: |- + Deployment override options. + Since gateway deployment consists of several containers, they must be distinguished in the configuration by their names: + - `gateway` + - `configbump` + - `oauth-proxy` + - `kube-rbac-proxy` properties: containers: description: List of containers belonging to the pod. @@ -7796,19 +7952,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to - a single $, which allows for escaping - the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -7822,10 +7975,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7835,12 +7988,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -7855,13 +8007,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: @@ -7884,6 +8034,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -7894,10 +8045,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7906,6 +8057,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7940,23 +8092,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -7968,23 +8117,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -8059,25 +8205,24 @@ spec: description: Public URL of the Identity Provider server. type: string identityToken: - description: 'Identity token to be passed to upstream. There - are two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. enum: - id_token - access_token type: string oAuthAccessTokenInactivityTimeoutSeconds: - description: Inactivity timeout for tokens to set in the OpenShift - `OAuthClient` resource used to set up identity federation - on the OpenShift side. 0 means tokens for this client never - time out. + description: |- + Inactivity timeout for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means tokens for this client never time out. format: int32 type: integer oAuthAccessTokenMaxAgeSeconds: - description: Access token max age for tokens to set in the - OpenShift `OAuthClient` resource used to set up identity - federation on the OpenShift side. 0 means no expiration. + description: |- + Access token max age for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means no expiration. format: int32 type: integer oAuthClientName: @@ -8085,37 +8230,33 @@ spec: used to set up identity federation on the OpenShift side. type: string oAuthScope: - description: Access Token Scope. This field is specific to - Che installations made for Kubernetes only and ignored for - OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: - description: 'Name of the secret set in the OpenShift `OAuthClient` - resource used to set up identity federation on the OpenShift - side. For Kubernetes, this can either be the plain text - oAuthSecret value, or the name of a kubernetes secret which - contains a key `oAuthSecret` and the value is the secret. - NOTE: this secret must exist in the same namespace as the - `CheCluster` resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`.' + description: |- + Name of the secret set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + For Kubernetes, this can either be the plain text oAuthSecret value, or the name of a kubernetes secret which contains a + key `oAuthSecret` and the value is the secret. NOTE: this secret must exist in the same namespace as the `CheCluster` + resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`. type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the - domain to generate a hostname for the route. The generated hostname - follows this pattern: che-.. The - is the namespace where the CheCluster CRD is created. In conjunction - with labels, it creates a route served by a non-default Ingress - controller. For a Kubernetes cluster, it contains a global ingress - domain. There are no default values: you must specify them.' + description: |- + For an OpenShift cluster, the Operator uses the domain to generate a hostname for the route. + The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. + In conjunction with labels, it creates a route served by a non-default Ingress controller. + For a Kubernetes cluster, it contains a global ingress domain. There are no default values: you must specify them. type: string hostname: description: The public hostname of the installed Che server. type: string ingressClassName: - description: IngressClassName is the name of an IngressClass cluster - resource. If a class name is defined in both the `IngressClassName` - field and the `kubernetes.io/ingress.class` annotation, `IngressClassName` - field takes precedence. + description: |- + IngressClassName is the name of an IngressClass cluster resource. + If a class name is defined in both the `IngressClassName` field and the `kubernetes.io/ingress.class` annotation, + `IngressClassName` field takes precedence. type: string labels: additionalProperties: @@ -8124,10 +8265,10 @@ spec: route for OpenShift platform). type: object tlsSecretName: - description: The name of the secret used to set up Ingress TLS - termination. If the field is an empty string, the default cluster - certificate is used. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The name of the secret used to set up Ingress TLS termination. + If the field is an empty string, the default cluster certificate is used. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object type: object @@ -8161,10 +8302,10 @@ spec: the Che deployment is in the current phase. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either the - copy of the explicitly defined property of the same name in the - spec or, if it is undefined in the spec and we're running on OpenShift, - the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object type: object @@ -8172,9 +8313,3 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] diff --git a/helmcharts/next/crds/checlusters.org.eclipse.che.CustomResourceDefinition.yaml b/helmcharts/next/crds/checlusters.org.eclipse.che.CustomResourceDefinition.yaml index 2814afb18..cec9a14d6 100644 --- a/helmcharts/next/crds/checlusters.org.eclipse.che.CustomResourceDefinition.yaml +++ b/helmcharts/next/crds/checlusters.org.eclipse.che.CustomResourceDefinition.yaml @@ -15,7 +15,7 @@ kind: CustomResourceDefinition metadata: annotations: cert-manager.io/inject-ca-from: eclipse-che/che-operator-serving-cert - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.14.0 labels: app.kubernetes.io/instance: che app.kubernetes.io/name: che @@ -51,53 +51,57 @@ spec: a Che server installation properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: - description: 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. + description: |- + 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. properties: auth: description: Configuration settings related to the Authentication used by the Che installation. properties: debug: - description: Deprecated. The value of this flag is ignored. Debug - internal identity provider. + description: |- + Deprecated. The value of this flag is ignored. + Debug internal identity provider. type: boolean externalIdentityProvider: - description: 'Deprecated. The value of this flag is ignored. 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`.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: boolean gatewayAuthenticationSidecarImage: - description: Gateway sidecar responsible for authentication when - NativeUserMode is enabled. See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] - or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. + description: |- + Gateway sidecar responsible for authentication when NativeUserMode is enabled. + See link:https://github.com/oauth2-proxy/oauth2-proxy[oauth2-proxy] or link:https://github.com/openshift/oauth-proxy[openshift/oauth-proxy]. type: string gatewayAuthorizationSidecarImage: - description: Gateway sidecar responsible for authorization when - NativeUserMode is enabled. See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] - or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] + description: |- + Gateway sidecar responsible for authorization when NativeUserMode is enabled. + See link:https://github.com/brancz/kube-rbac-proxy[kube-rbac-proxy] or link:https://github.com/openshift/kube-rbac-proxy[openshift/kube-rbac-proxy] type: string gatewayConfigBumpEnv: description: List of environment variables to set in the Configbump @@ -111,15 +115,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -132,9 +137,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -143,12 +149,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -161,11 +166,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -185,6 +190,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -194,9 +200,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -205,6 +212,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -222,15 +230,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -243,9 +252,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -254,12 +264,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -272,11 +281,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -296,6 +305,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -305,9 +315,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -316,6 +327,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -337,15 +349,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -358,9 +371,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -369,12 +383,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -387,11 +400,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -411,6 +424,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -420,9 +434,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -431,6 +446,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -448,15 +464,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -469,9 +486,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -480,12 +498,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -498,11 +515,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -522,6 +539,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -531,9 +549,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -542,27 +561,28 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array identityProviderAdminUserName: - description: Deprecated. The value of this flag is ignored. Overrides - the name of the Identity Provider administrator user. Defaults - to `admin`. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the name of the Identity Provider administrator user. Defaults to `admin`. type: string identityProviderClientId: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string identityProviderContainerResources: - description: Deprecated. The value of this flag is ignored. Identity - provider container custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Identity provider container custom settings. properties: limits: description: Limits describes the maximum amount of compute @@ -590,21 +610,21 @@ spec: type: object type: object identityProviderImage: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderImagePullPolicy: - description: Deprecated. The value of this flag is ignored. Overrides - the image pull policy used in the Identity Provider, Keycloak - or RH-SSO, deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Deprecated. The value of this flag is ignored. + Overrides the image pull policy used in the Identity Provider, Keycloak or RH-SSO, deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string identityProviderIngress: - description: Deprecated. The value of this flag is ignored. Ingress - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Ingress custom settings. properties: annotations: additionalProperties: @@ -619,42 +639,39 @@ spec: type: string type: object identityProviderPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresPassword: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderPostgresSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. - The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderRealm: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string identityProviderRoute: - description: Deprecated. The value of this flag is ignored. Route - custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Route custom settings. properties: annotations: additionalProperties: @@ -664,10 +681,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -675,49 +692,43 @@ spec: type: string type: object identityProviderSecret: - description: 'Deprecated. The value of this flag is ignored. 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`. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + Deprecated. The value of this flag is ignored. + 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`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string identityProviderURL: - description: 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. + description: |- + 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. type: string identityToken: - description: 'Identity token to be passed to upstream. There are - two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che installations - made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string initialOpenShiftOAuthUser: - description: Deprecated. The value of this flag is ignored. 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 - in 'openshift-config' namespace by Operator. Note that this - solution is Openshift 4 platform-specific. + description: |- + Deprecated. The value of this flag is ignored. + 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 in 'openshift-config' namespace by Operator. + Note that this solution is Openshift 4 platform-specific. type: boolean nativeUserMode: - description: Deprecated. The value of this flag is ignored. Enables - native user mode. Currently works only on OpenShift and DevWorkspace - engine. Native User mode uses OpenShift OAuth directly as identity - provider, without Keycloak. + description: |- + Deprecated. The value of this flag is ignored. + Enables native user mode. Currently works only on OpenShift and DevWorkspace engine. + Native User mode uses OpenShift OAuth directly as identity provider, without Keycloak. type: boolean oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used @@ -725,8 +736,9 @@ spec: when left blank. See also the `OpenShiftoAuth` field. type: string oAuthScope: - description: Access Token Scope. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` @@ -735,19 +747,17 @@ spec: field. type: string openShiftoAuth: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean updateAdminPassword: - description: Deprecated. The value of this flag is ignored. Forces - the default `admin` Che user to update password on first login. - Defaults to `false`. + description: |- + Deprecated. The value of this flag is ignored. + Forces the default `admin` Che user to update password on first login. Defaults to `false`. type: boolean type: object dashboard: @@ -796,9 +806,9 @@ spec: to connect to the DB. Defaults to `dbche`. type: string chePostgresHostName: - description: 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`. + description: |- + 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. type: string chePostgresPassword: @@ -807,35 +817,29 @@ spec: automatically generated value. type: string chePostgresPort: - description: 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. + description: |- + 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. type: string chePostgresSecret: - description: '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 `postgres-credentials` will - be created with default value of `pgche` for `user` and with - an auto-generated value for `password`. The secret must have - `app.kubernetes.io/part-of=che.eclipse.org` label.' + description: |- + 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 `postgres-credentials` + will be created with default value of `pgche` for `user` and with an auto-generated value for `password`. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string chePostgresUser: description: PostgreSQL user that the Che server uses to connect to the DB. Defaults to `pgche`. type: string externalDb: - description: '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`.' + description: |- + 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`. type: boolean postgresEnv: description: List of environment variables to set in the PostgreSQL @@ -849,15 +853,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -870,9 +875,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -881,12 +887,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -899,11 +904,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -923,6 +928,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -932,9 +938,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -943,6 +950,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -960,30 +968,29 @@ spec: `next` or `latest` images, and `IfNotPresent` in other cases. type: string postgresVersion: - description: 'Indicates a PostgreSQL version image to use. Allowed - values are: `9.6` and `13.3`. Migrate your PostgreSQL database - to switch from one version to another.' + description: |- + Indicates a PostgreSQL version image to use. Allowed values are: `9.6` and `13.3`. + Migrate your PostgreSQL database to switch from one version to another. type: string pvcClaimSize: - description: Size of the persistent volume claim for database. - Defaults to `1Gi`. To update pvc storageclass that provisions - it must support resize when Eclipse Che has been already deployed. + description: |- + Size of the persistent volume claim for database. Defaults to `1Gi`. + To update pvc storageclass that provisions it must support resize when Eclipse Che has been already deployed. type: string type: object devWorkspace: description: DevWorkspace operator configuration properties: controllerImage: - description: Overrides the container image used in the DevWorkspace - controller deployment. This includes the image tag. Omit it - or leave it empty to use the default container image provided - by the Operator. + description: |- + Overrides the container image used in the DevWorkspace controller deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string enable: - description: 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. + description: |- + 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. type: boolean env: description: List of environment variables to set in the DevWorkspace @@ -997,15 +1004,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1018,9 +1026,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1029,12 +1038,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1047,11 +1055,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1071,6 +1079,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1080,9 +1089,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1091,6 +1101,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1101,17 +1112,18 @@ spec: type: string secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer required: @@ -1129,15 +1141,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -1151,14 +1164,15 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -1172,14 +1186,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -1190,17 +1205,15 @@ spec: description: Kubernetes Image Puller configuration properties: enable: - description: 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. If the `spec.images` - field is empty, a set of recommended workspace-related images - will be automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + 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. + If the `spec.images` field is empty, a set of recommended workspace-related images will be automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A KubernetesImagePullerSpec to configure the image @@ -1241,24 +1254,21 @@ spec: made on upstream Kubernetes. properties: ingressClass: - description: '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.' + description: |- + 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. type: string ingressDomain: description: 'Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: - description: 'Deprecated. The value of this flag is ignored. 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.' + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string securityContextFsGroup: description: The FSGroup in which the Che Pod and workspace Pods @@ -1269,22 +1279,17 @@ spec: run as. Default value is `1724`. type: string singleHostExposureType: - description: Deprecated. The value of this flag is ignored. 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`. + description: |- + Deprecated. The value of this flag is ignored. + 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`. type: string tlsSecretName: - description: 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. + description: |- + 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. type: string type: object metrics: @@ -1301,73 +1306,69 @@ spec: the plugin and devfile registries properties: airGapContainerRegistryHostname: - description: 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. + description: |- + 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. type: string airGapContainerRegistryOrganization: - description: 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. + description: |- + 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. type: string allowAutoProvisionUserNamespace: - description: Indicates if is allowed to automatically create a - user namespace. If it set to false, then user namespace must - be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean allowUserDefinedWorkspaceNamespaces: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: boolean cheClusterRoles: - description: A comma-separated list of ClusterRoles that will - be assigned to Che ServiceAccount. Each role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. Be aware that the Che Operator has to already have all - permissions in these ClusterRoles to grant them. + description: |- + A comma-separated list of ClusterRoles that will be assigned to Che ServiceAccount. + Each role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + Be aware that the Che Operator has to already have all permissions in these ClusterRoles to grant them. type: string cheDebug: description: Enables the debug mode for Che server. Defaults to `false`. type: string cheFlavor: - description: Deprecated. The value of this flag is ignored. Specifies - a variation of the installation. The options are `che` for - upstream Che installations or `devspaces` for Red Hat OpenShift - Dev Spaces (formerly Red Hat CodeReady Workspaces) installation + description: |- + Deprecated. The value of this flag is ignored. + Specifies a variation of the installation. The options are `che` for upstream Che installations or + `devspaces` for Red Hat OpenShift Dev Spaces (formerly Red Hat CodeReady Workspaces) installation type: string cheHost: - description: 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. + description: |- + 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. type: string cheHostTLSSecret: - description: Name of a secret containing certificates to secure - ingress or route for the custom host name of the installed Che - server. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. See the `cheHost` field. + description: |- + Name of a secret containing certificates to secure ingress or route for the custom host name of the installed Che server. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. + See the `cheHost` field. type: string cheImage: - description: 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. + description: |- + 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. type: string cheImagePullPolicy: - description: Overrides the image pull policy used in Che deployment. - Default value is `Always` for `nightly`, `next` or `latest` - images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in Che deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string cheImageTag: - description: 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. + description: |- + 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. type: string cheLogLevel: description: 'Log level for the Che server: `INFO` or `DEBUG`. @@ -1385,15 +1386,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1406,9 +1408,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1417,12 +1420,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1435,11 +1437,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1459,6 +1461,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1468,9 +1471,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1479,6 +1483,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -1510,10 +1515,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1521,27 +1526,28 @@ spec: type: string type: object cheWorkspaceClusterRole: - description: Custom cluster role bound to the user for the Che - workspaces. The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. The default roles are used when omitted or left blank. + description: |- + Custom cluster role bound to the user for the Che workspaces. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string - description: 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. + description: |- + 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. type: object dashboardCpuLimit: - description: Overrides the CPU limit used in the dashboard deployment. + description: |- + Overrides the CPU limit used in the dashboard deployment. In cores. (500m = .5 cores). Default to 500m. type: string dashboardCpuRequest: - description: Overrides the CPU request used in the dashboard deployment. + description: |- + Overrides the CPU request used in the dashboard deployment. In cores. (500m = .5 cores). Default to 100m. type: string dashboardEnv: @@ -1556,15 +1562,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1577,9 +1584,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1588,12 +1596,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1606,11 +1613,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1630,6 +1637,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1639,9 +1647,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1650,24 +1659,26 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array dashboardImage: - description: Overrides the container image used in the dashboard - deployment. This includes the image tag. Omit it or leave it - empty to use the default container image provided by the Operator. + description: |- + Overrides the container image used in the dashboard deployment. + This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator. type: string dashboardImagePullPolicy: - description: Overrides the image pull policy used in the dashboard - deployment. Default value is `Always` for `nightly`, `next` - or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the dashboard deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string dashboardIngress: - description: Deprecated. The value of this flag is ignored. Dashboard - ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard ingress custom settings. properties: annotations: additionalProperties: @@ -1690,8 +1701,9 @@ spec: deployment. Defaults to 16Mi. type: string dashboardRoute: - description: Deprecated. The value of this flag is ignored. Dashboard - route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Dashboard route custom settings. properties: annotations: additionalProperties: @@ -1701,10 +1713,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1712,12 +1724,14 @@ spec: type: string type: object devfileRegistryCpuLimit: - description: Overrides the CPU limit used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string devfileRegistryCpuRequest: - description: Overrides the CPU request used in the devfile registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the devfile registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string devfileRegistryEnv: description: List of environment variables to set in the plugin @@ -1731,15 +1745,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1752,9 +1767,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -1763,12 +1779,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -1781,11 +1796,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -1805,6 +1820,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -1814,9 +1830,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -1825,20 +1842,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array devfileRegistryImage: - description: 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. + description: |- + 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. type: string devfileRegistryIngress: - description: Deprecated. The value of this flag is ignored. The - devfile registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry ingress custom settings. properties: annotations: additionalProperties: @@ -1861,13 +1879,14 @@ spec: registry deployment. Defaults to 16Mi. type: string devfileRegistryPullPolicy: - description: Overrides the image pull policy used in the devfile - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the devfile registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string devfileRegistryRoute: - description: Deprecated. The value of this flag is ignored. The - devfile registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + The devfile registry route custom settings. properties: annotations: additionalProperties: @@ -1877,10 +1896,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -1892,14 +1911,14 @@ spec: fields. type: string disableInternalClusterSVCNames: - description: Deprecated. The value of this flag is ignored. Disable - internal cluster SVC names usage to communicate between components - to speed up the traffic and avoid proxy issues. + description: |- + Deprecated. The value of this flag is ignored. + Disable internal cluster SVC names usage to communicate between components to speed up the traffic and avoid proxy issues. type: boolean externalDevfileRegistries: - description: External devfile registries, that serves sample, - ready-to-use devfiles. Configure this in addition to a dedicated - devfile registry (when `externalDevfileRegistry` is `false`) + description: |- + External devfile registries, that serves sample, ready-to-use devfiles. + Configure this in addition to a dedicated devfile registry (when `externalDevfileRegistry` is `false`) or instead of it (when `externalDevfileRegistry` is `true`) items: description: Settings for a configuration of the external devfile @@ -1911,50 +1930,44 @@ spec: type: object type: array externalDevfileRegistry: - description: 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 - configure at least one devfile registry with `externalDevfileRegistries` - field. + description: |- + 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 configure at least one + devfile registry with `externalDevfileRegistries` field. type: boolean externalPluginRegistry: - description: 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. + description: |- + 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. type: boolean gitSelfSignedCert: - description: When enabled, the certificate from `che-git-self-signed-cert` - ConfigMap will be propagated to the Che components and provide - particular configuration for Git. Note, the `che-git-self-signed-cert` - ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + When enabled, the certificate from `che-git-self-signed-cert` ConfigMap will be propagated to the Che components and provide particular configuration for Git. + Note, the `che-git-self-signed-cert` ConfigMap must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: boolean nonProxyHosts: - description: 'List of hosts that will be reached directly, bypassing - the proxy. Specify wild card domain use the following form `.` - 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.' + description: |- + List of hosts that will be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.` 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. type: string openVSXRegistryURL: description: Open VSX registry URL. If omitted an embedded instance will be used. type: string pluginRegistryCpuLimit: - description: Overrides the CPU limit used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 500m. + description: |- + Overrides the CPU limit used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 500m. type: string pluginRegistryCpuRequest: - description: Overrides the CPU request used in the plugin registry - deployment. In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the plugin registry deployment. + In cores. (500m = .5 cores). Default to 100m. type: string pluginRegistryEnv: description: List of environment variables to set in the devfile @@ -1968,15 +1981,16 @@ spec: C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables in - the container and any service environment variables. If - a variable cannot be resolved, the reference in the input - string will be unchanged. Double $$ are reduced to a single - $, which allows for escaping the $(VAR_NAME) syntax: i.e. + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, regardless - of whether the variable exists or not. Defaults to "".' + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -1989,9 +2003,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or its @@ -2000,12 +2015,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports metadata.name, - metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -2018,11 +2032,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: only - resources limits and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, requests.memory - and requests.ephemeral-storage) are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -2042,6 +2056,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -2051,9 +2066,10 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, - uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its key @@ -2062,20 +2078,21 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name type: object type: array pluginRegistryImage: - description: 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. + description: |- + 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. type: string pluginRegistryIngress: - description: Deprecated. The value of this flag is ignored. Plugin - registry ingress custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry ingress custom settings. properties: annotations: additionalProperties: @@ -2098,13 +2115,14 @@ spec: deployment. Defaults to 16Mi. type: string pluginRegistryPullPolicy: - description: Overrides the image pull policy used in the plugin - registry deployment. Default value is `Always` for `nightly`, - `next` or `latest` images, and `IfNotPresent` in other cases. + description: |- + Overrides the image pull policy used in the plugin registry deployment. + Default value is `Always` for `nightly`, `next` or `latest` images, and `IfNotPresent` in other cases. type: string pluginRegistryRoute: - description: Deprecated. The value of this flag is ignored. Plugin - registry route custom settings. + description: |- + Deprecated. The value of this flag is ignored. + Plugin registry route custom settings. properties: annotations: additionalProperties: @@ -2114,10 +2132,10 @@ spec: arbitrary metadata. type: object domain: - description: '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: `-.`.' + description: |- + 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: `-.`. type: string labels: description: Comma separated list of labels that can be used @@ -2125,16 +2143,15 @@ spec: type: string type: object pluginRegistryUrl: - description: 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. + description: |- + 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. type: string proxyPassword: - description: Password of the proxy server. Only use when proxy - configuration is required. See the `proxyURL`, `proxyUser` and - `proxySecret` fields. + description: |- + Password of the proxy server. + Only use when proxy configuration is required. See the `proxyURL`, `proxyUser` and `proxySecret` fields. type: string proxyPort: description: Port of the proxy server. Only use when configuring @@ -2142,22 +2159,18 @@ spec: fields. type: string proxySecret: - description: The secret that contains `user` and `password` for - a proxy server. When the secret is defined, the `proxyUser` - and `proxyPassword` are ignored. The secret must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The secret that contains `user` and `password` for a proxy server. When the secret is defined, the `proxyUser` and `proxyPassword` are ignored. + The secret must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string proxyURL: - description: 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. + description: |- + 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. type: string proxyUser: description: User name of the proxy server. Only use when configuring @@ -2165,31 +2178,29 @@ spec: and `proxySecret` fields. type: string selfSignedCert: - description: 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. + description: |- + 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. type: boolean serverCpuLimit: - description: Overrides the CPU limit used in the Che server deployment + description: |- + Overrides the CPU limit used in the Che server deployment In cores. (500m = .5 cores). Default to 1. type: string serverCpuRequest: - description: Overrides the CPU request used in the Che server - deployment In cores. (500m = .5 cores). Default to 100m. + description: |- + Overrides the CPU request used in the Che server deployment + In cores. (500m = .5 cores). Default to 100m. type: string serverExposureStrategy: - description: Deprecated. The value of this flag is ignored. 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. + description: |- + Deprecated. The value of this flag is ignored. + 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. type: string serverMemoryLimit: description: Overrides the memory limit used in the Che server @@ -2200,13 +2211,11 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: 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. - The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + 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. + The Config Map must have `app.kubernetes.io/part-of=che.eclipse.org` label. type: string singleHostGatewayConfigMapLabels: additionalProperties: @@ -2233,9 +2242,9 @@ spec: description: Deprecated in favor of `disableInternalClusterSVCNames`. type: boolean workspaceDefaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile does - not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile does not contain any components. items: properties: attributes: @@ -2274,20 +2283,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -2296,10 +2305,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -2311,28 +2322,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2347,24 +2369,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2374,15 +2403,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2390,10 +2418,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -2412,17 +2447,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -2432,18 +2469,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -2453,19 +2489,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -2478,8 +2515,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -2499,18 +2539,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -2529,32 +2566,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -2564,9 +2601,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -2582,14 +2619,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2601,28 +2641,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2637,24 +2688,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2664,15 +2722,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2693,22 +2750,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -2720,28 +2780,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -2756,24 +2827,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -2783,15 +2861,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -2812,32 +2889,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -2863,9 +2944,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -2881,9 +2962,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -2911,9 +2992,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -2925,23 +3006,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -2972,40 +3056,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -3014,9 +3098,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -3055,21 +3139,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -3078,10 +3161,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -3094,31 +3179,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3132,29 +3224,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3164,27 +3258,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -3202,18 +3300,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -3223,20 +3321,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -3248,9 +3343,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -3272,21 +3369,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -3305,34 +3396,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -3342,10 +3429,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -3360,16 +3446,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3382,31 +3469,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3420,29 +3514,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3452,17 +3548,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3483,24 +3576,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -3513,31 +3607,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -3551,29 +3652,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -3583,17 +3686,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -3614,13 +3714,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3653,34 +3754,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -3692,16 +3793,16 @@ spec: type: array workspaceDefaultEditor: default: che-incubator/che-code/latest - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/plugin/version`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/plugin/version`. The URI must start from `http`. type: string workspaceNamespaceDefault: - description: 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 ``, `` and `` - placeholders, such as che-workspace-. In that case, - a new namespace will be created for each user or workspace. + description: |- + 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 ``, `` and `` placeholders, such as che-workspace-. + In that case, a new namespace will be created for each user or workspace. type: string workspacePodNodeSelector: additionalProperties: @@ -3713,41 +3814,39 @@ spec: description: The pod tolerations put on the workspace pods to limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -3784,26 +3883,23 @@ spec: storage class is used. type: string preCreateSubPaths: - description: 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. + description: |- + 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. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. Defaults to `10Gi`. type: string pvcJobsImage: - description: 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. + description: |- + 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. type: string pvcStrategy: - description: 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`. + description: |- + 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`. type: string workspacePVCStorageClassName: description: Storage class for the Persistent Volume Claims dedicated @@ -3836,15 +3932,14 @@ spec: description: The status of the Devworkspace subsystem properties: gatewayHost: - description: GatewayHost is the resolved host of the ingress/route. - This is equal to the Host in the spec on Kubernetes but contains - the actual host name of the route if Host is unspecified on - OpenShift. + description: |- + GatewayHost is the resolved host of the ingress/route. This is equal to the Host in the spec + on Kubernetes but contains the actual host name of the route if Host is unspecified on OpenShift. type: string gatewayPhase: - description: GatewayPhase specifies the phase in which the gateway - deployment currently is. If the gateway is disabled, the phase - is "Inactive". + description: |- + GatewayPhase specifies the phase in which the gateway deployment currently is. + If the gateway is disabled, the phase is "Inactive". type: string message: description: Message contains further human-readable info for @@ -3859,10 +3954,10 @@ spec: why the Che cluster is in this state. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either - the copy of the explicitly defined property of the same name - in the spec or, if it is undefined in the spec and we're running - on OpenShift, the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object gitHubOAuthProvisioned: @@ -3913,22 +4008,26 @@ spec: - name: v2 schema: openAPIV3Schema: - description: 'The `CheCluster` custom resource allows defining and managing - Eclipse Che server installation. Based on these settings, the Operator - automatically creates and maintains several ConfigMaps: `che`, `plugin-registry`, - `devfile-registry` that will contain the appropriate environment variables - of the various components of the installation. These generated ConfigMaps - must NOT be updated manually.' + description: |- + The `CheCluster` custom resource allows defining and managing Eclipse Che server installation. + Based on these settings, the Operator automatically creates and maintains several ConfigMaps: + `che`, `plugin-registry`, `devfile-registry` that will contain the appropriate environment variables + of the various components of the installation. These generated ConfigMaps must NOT be updated manually. properties: apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object @@ -3952,14 +4051,15 @@ spec: server. properties: clusterRoles: - description: 'Additional ClusterRoles assigned to Che ServiceAccount. - Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. The defaults roles are: - `-cheworkspaces-clusterrole` + description: |- + Additional ClusterRoles assigned to Che ServiceAccount. + Each role must have a `app.kubernetes.io/part-of=che.eclipse.org` label. + The defaults roles are: + - `-cheworkspaces-clusterrole` - `-cheworkspaces-namespaces-clusterrole` - `-cheworkspaces-devworkspace-clusterrole` - where the is the namespace where the CheCluster - CR is created. The Che Operator must already have all permissions - in these ClusterRoles to grant them.' + where the is the namespace where the CheCluster CR is created. + The Che Operator must already have all permissions in these ClusterRoles to grant them. items: type: string type: array @@ -3987,18 +4087,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4011,10 +4109,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4023,12 +4121,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4042,13 +4139,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4070,6 +4165,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4080,10 +4176,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4092,6 +4188,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4126,23 +4223,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4154,23 +4248,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4196,13 +4287,11 @@ spec: extraProperties: additionalProperties: type: string - description: A map of additional environment variables 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). If the `extraProperties` - field contains a property normally generated in `che` ConfigMap - from other CR fields, the value defined in the `extraProperties` - is used instead. + description: |- + A map of additional environment variables 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). + If the `extraProperties` field contains a property normally generated in `che` ConfigMap from other CR fields, + the value defined in the `extraProperties` is used instead. type: object logLevel: default: INFO @@ -4210,27 +4299,25 @@ spec: `DEBUG`.' type: string proxy: - description: Proxy server settings for Kubernetes cluster. - No additional configuration is required for OpenShift cluster. - By specifying these settings for the OpenShift cluster, - you override the OpenShift proxy configuration. + description: |- + Proxy server settings for Kubernetes cluster. No additional configuration is required for OpenShift cluster. + By specifying these settings for the OpenShift cluster, you override the OpenShift proxy configuration. properties: credentialsSecretName: - description: The secret name that contains `user` and - `password` for a proxy server. The secret must have - a `app.kubernetes.io/part-of=che.eclipse.org` label. + description: |- + The secret name that contains `user` and `password` for a proxy server. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string nonProxyHosts: - description: 'A list of hosts that can be reached directly, - bypassing the proxy. Specify wild card domain use the - following form `.`, for example: - localhost - - my.host.com - 123.42.12.32 Use only when a proxy - configuration is required. The Operator respects OpenShift - cluster-wide proxy configuration, defining `nonProxyHosts` - in a custom resource leads to merging non-proxy hosts - lists from the cluster proxy configuration, and the - ones defined in the custom resources. See the following - page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + A list of hosts that can be reached directly, bypassing the proxy. + Specify wild card domain use the following form `.`, for example: + - localhost + - my.host.com + - 123.42.12.32 + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `nonProxyHosts` in a custom resource leads to merging non-proxy hosts lists from the cluster proxy configuration, and the ones defined in the custom resources. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. items: type: string type: array @@ -4238,12 +4325,11 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. - Use only when a proxy configuration is required. The - Operator respects OpenShift cluster-wide proxy configuration, - defining `url` in a custom resource leads to overriding - the cluster proxy configuration. See the following page: - https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html.' + description: |- + URL (protocol+hostname) of the proxy server. + Use only when a proxy configuration is required. The Operator respects OpenShift cluster-wide proxy configuration, + defining `url` in a custom resource leads to overriding the cluster proxy configuration. + See the following page: https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html. type: string type: object type: object @@ -4286,18 +4372,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4310,10 +4394,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4322,12 +4406,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4341,13 +4424,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4369,6 +4450,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4379,10 +4461,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4391,6 +4473,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4425,23 +4508,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4453,23 +4533,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4519,7 +4596,8 @@ spec: description: DevWorkspace Operator configuration. properties: runningLimit: - description: Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` + description: |- + Deprecated in favor of `MaxNumberOfRunningWorkspacesPerUser` The maximum number of running workspaces per user. type: string type: object @@ -4547,18 +4625,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4571,10 +4647,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4583,12 +4659,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4602,13 +4677,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4630,6 +4703,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4640,10 +4714,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4652,6 +4726,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4686,23 +4761,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4714,23 +4786,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -4773,18 +4842,15 @@ spec: description: Kubernetes Image Puller configuration. properties: enable: - description: Install and configure the community supported - Kubernetes Image Puller Operator. When you set the value - to `true` without providing any specs, it creates a default - Kubernetes Image Puller object managed by the Operator. - When you set the value to `false`, the Kubernetes Image - Puller object is deleted, and the Operator uninstalled, - regardless of whether a spec is provided. If you leave the - `spec.images` field empty, a set of recommended workspace-related - images is automatically detected and pre-pulled after installation. - Note that while this Operator and its behavior is community-supported, - its payload may be commercially-supported for pulling commercially-supported - images. + description: |- + Install and configure the community supported Kubernetes Image Puller Operator. When you set the value to `true` without providing any specs, + it creates a default Kubernetes Image Puller object managed by the Operator. + When you set the value to `false`, the Kubernetes Image Puller object is deleted, and the Operator uninstalled, + regardless of whether a spec is provided. + If you leave the `spec.images` field empty, a set of recommended workspace-related images is automatically detected and + pre-pulled after installation. + Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported + for pulling commercially-supported images. type: boolean spec: description: A Kubernetes Image Puller spec to configure the @@ -4852,18 +4918,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container and - any service environment variables. If a - variable cannot be resolved, the reference - in the input string will be unchanged. Double - $$ are reduced to a single $, which allows - for escaping the $(VAR_NAME) syntax: i.e. - "$$(VAR_NAME)" will produce the string literal - "$(VAR_NAME)". Escaped references will never - be expanded, regardless of whether the variable - exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's @@ -4876,10 +4940,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap @@ -4888,12 +4952,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: - supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -4907,13 +4970,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the - container: only resources limits and - requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required @@ -4935,6 +4996,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -4945,10 +5007,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret @@ -4957,6 +5019,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -4991,23 +5054,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5019,23 +5079,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) - If the value is not specified, then the - default value is set depending on the - component. If value is `0`, then no value - is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = - 500GiB = 500 * 1024 * 1024 * 1024) If - the value is not specified, then the default - value is set depending on the component. - If value is `0`, then no value is set - for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -5082,18 +5139,16 @@ spec: Che images. properties: hostname: - description: An optional hostname or URL of an alternative container - registry to pull images from. This value overrides the container - registry hostname defined in all the default container images - involved in a Che deployment. This is particularly useful for - installing Che in a restricted environment. + description: |- + An optional hostname or URL of an alternative container registry to pull images from. + This value overrides the container registry hostname defined in all the default container images involved in a Che deployment. + This is particularly useful for installing Che in a restricted environment. type: string organization: - description: An optional repository name of an alternative 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 for installing - Eclipse Che in a restricted environment. + description: |- + An optional repository name of an alternative 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 for installing Eclipse Che in a restricted environment. type: string type: object devEnvironments: @@ -5119,9 +5174,9 @@ spec: type: string type: object defaultComponents: - description: Default components applied to DevWorkspaces. These - default components are meant to be used when a Devfile, that - does not contain any components. + description: |- + Default components applied to DevWorkspaces. + These default components are meant to be used when a Devfile, that does not contain any components. items: properties: attributes: @@ -5160,20 +5215,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the command - running the dockerimage component. The arguments are - supplied either to the default command provided in - the image or to the overridden command. \n Defaults - to an empty array, meaning use whatever is defined - in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided in the - image. \n Defaults to an empty array, meaning use - whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5182,10 +5237,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should run in its - own separated pod, instead of running as part of the - main development environment pod. \n Default value - is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5197,28 +5254,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5233,24 +5301,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5260,15 +5335,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5276,10 +5350,17 @@ spec: type: object type: array env: - description: "Environment variables used in this container. - \n The following variables are reserved and cannot - be overridden via env: \n - `$PROJECTS_ROOT` \n - - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -5298,17 +5379,19 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project source - code should be mounted in the component. \n Defaults - to true for all component types except plugins and - components that set `dedicatedPod` to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: default: /projects - description: Optional specification of the path in the - container where project sources should be transferred/mounted - when `mountSources` is `true`. When omitted, the default - value of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should be mounted @@ -5318,18 +5401,17 @@ spec: container properties: name: - description: The volume mount name is the name - of an existing `Volume` component. If several - containers mount the same volume name then they - will reuse the same volume and will be able - to access to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component container - where the volume should be mounted. If not path - is mentioned, default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -5339,19 +5421,20 @@ spec: - image type: object custom: - description: Custom component whose logic is implementation-dependant - and should be provided by the user possibly through some - dedicated controller + description: |- + Custom component whose logic is implementation-dependant + and should be provided by the user + possibly through some dedicated controller properties: componentClass: - description: Class of component that the associated - implementation controller should use to process this - command with the appropriate logic + description: |- + Class of component that the associated implementation controller + should use to process this command with the appropriate logic type: string embeddedResource: - description: Additional free-form configuration for - this custom component that the implementation controller - will know how to use + description: |- + Additional free-form configuration for this custom component + that the implementation controller will know how to use type: object x-kubernetes-embedded-resource: true x-kubernetes-preserve-unknown-fields: true @@ -5364,8 +5447,11 @@ spec: for outer loop builds properties: autoBuild: - description: "Defines if the image should be built during - startup. \n Default value is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile type build @@ -5385,18 +5471,15 @@ spec: description: Dockerfile's Devfile Registry source properties: id: - description: Id in a devfile registry that contains - a Dockerfile. The src in the OCI registry - required for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL to pull the - Dockerfile from when using the Devfile Registry - as Dockerfile src. To ensure the Dockerfile - gets resolved consistently in different environments, - it is recommended to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string required: - id @@ -5415,32 +5498,32 @@ spec: one remote configured type: string revision: - description: The revision to checkout from. - Should be branch name, tag or commit id. - Default branch is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile in the - Git repository when using git as Dockerfile - src. Defaults to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which should be - initialized in the git project. Projects must - have at least one remote configured while - StarterProjects & Image Component's Git source - can only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object required: - remotes type: object rootRequired: - description: "Specify if a privileged builder pod - is required. \n Default value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -5450,9 +5533,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. It can - be a full URL or a relative URI from the current - devfile as the base URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -5468,14 +5551,17 @@ spec: - imageName type: object kubernetes: - description: Allows importing into the devworkspace the - Kubernetes resources defined in a given manifest. For - example this allows reusing the Kubernetes definitions - used to deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5487,28 +5573,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5523,24 +5620,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5550,15 +5654,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5579,22 +5682,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing the - component from other elements (such as commands) or from - an external devfile that may reference this component - through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace the - OpenShift resources defined in a given manifest. For example - this allows reusing the OpenShift definitions used to - deploy some runtime components in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should be deployed - during startup. \n Default value is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -5606,28 +5712,39 @@ spec: Ingress or Openshift Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. \n Examples - of Che-specific attributes: \n - cookiesAuthEnabled: - \"true\" / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: default: public - description: "Describes how the endpoint should - be exposed on the network. \n - `public` means - that the endpoint will be exposed on the public - network, typically through a K8S ingress or - an OpenShift route. \n - `internal` means that - the endpoint will be exposed internally outside - of the main devworkspace POD, typically by K8S - services, to be consumed by other elements running - on the same cloud internal network. \n - `none` - means that the endpoint will not be exposed - and will only be accessible inside the main - devworkspace POD, on a local address. \n Default - value is `public`" + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running + on the same cloud internal network. + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -5642,24 +5759,31 @@ spec: type: string protocol: default: http - description: "Describes the application and transport - protocols of the traffic that will go through - this endpoint. \n - `http`: Endpoint will have - `http` traffic, typically on a TCP connection. - It will be automaticaly promoted to `https` - when the `secure` field is set to `true`. \n - - `https`: Endpoint will have `https` traffic, - typically on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically on a TCP connection. - It will be automaticaly promoted to `wss` when - the `secure` field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, typically - on a TCP connection. \n - `tcp`: Endpoint will - have traffic on a TCP connection, without specifying - an application protocol. \n - `udp`: Endpoint - will have traffic on an UDP connection, without - specifying an application protocol. \n Default - value is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -5669,15 +5793,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint should - be secured and protected by some authentication - process. This requires a protocol of `https` - or `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used within the - container component. The same port cannot be - used by two different container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -5698,32 +5821,36 @@ spec: type: string type: object plugin: - description: "Allows importing a plugin. \n Plugins are - mainly imported devfiles that contribute components, commands - and events as a consistent single unit. They are defined - in either YAML files following the devfile syntax, or - as `DevWorkspaceTemplate` Kubernetes Custom Resources" + description: |- + Allows importing a plugin. + + + Plugins are mainly imported devfiles that contribute components, commands + and events as a consistent single unit. They are defined in either YAML files + following the devfile syntax, + or as `DevWorkspaceTemplate` Kubernetes Custom Resources properties: commands: - description: Overrides of commands encapsulated in a - parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of commands encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: apply: - description: "Command that consists in applying - a given component definition, typically bound - to a devworkspace event. \n For example, when - an `apply` command is bound to a `preStart` - event, and references a `container` component, - it will start the container as a K8S initContainer - in the devworkspace POD, unless the component - has its `dedicatedPod` field set to `true`. - \n When no `apply` command exist for a given - component, it is assumed the component will - be applied at devworkspace start by default, - unless `deployByDefault` for that component - is set to false." + description: |- + Command that consists in applying a given component definition, + typically bound to a devworkspace event. + + + For example, when an `apply` command is bound to a `preStart` event, + and references a `container` component, it will start the container as a + K8S initContainer in the devworkspace POD, unless the component has its + `dedicatedPod` field set to `true`. + + + When no `apply` command exist for a given component, + it is assumed the component will be applied at devworkspace start + by default, unless `deployByDefault` for that component is set to false. properties: component: description: Describes component that will @@ -5749,9 +5876,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string type: object attributes: @@ -5767,9 +5894,9 @@ spec: - Composite type: string composite: - description: Composite command that allows executing - several sub-commands either sequentially or - concurrently + description: |- + Composite command that allows executing several sub-commands + either sequentially or concurrently properties: commands: description: The commands that comprise this @@ -5797,9 +5924,9 @@ spec: type: string type: object label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string parallel: description: Indicates if the sub-commands @@ -5811,23 +5938,26 @@ spec: component container properties: commandLine: - description: "The actual command-line string - \n Special variables that can be used: \n - \ - `$PROJECTS_ROOT`: A path where projects - sources are mounted as defined by container - component's sourceMapping. \n - `$PROJECT_SOURCE`: - A path to a project source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + The actual command-line string + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string component: description: Describes component to which given action relates type: string env: - description: Optional list of environment - variables that have to be set before running - the command + description: |- + Optional list of environment variables that have to be set + before running the command items: properties: name: @@ -5858,40 +5988,40 @@ spec: type: string type: object hotReloadCapable: - description: "Specify whether the command - is restarted or not when the source code - changes. If set to `true` the command won't - be restarted. A *hotReloadCapable* `run` - or `debug` command is expected to handle - file changes on its own and won't be restarted. - A *hotReloadCapable* `build` command is - expected to be executed only once and won't - be executed again. This field is taken into - account only for commands `build`, `run` - and `debug` with `isDefault` set to `true`. - \n Default value is `false`" + description: |- + Specify whether the command is restarted or not when the source code changes. + If set to `true` the command won't be restarted. + A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted. + A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again. + This field is taken into account only for commands `build`, `run` and `debug` with `isDefault` set to `true`. + + + Default value is `false` type: boolean label: - description: Optional label that provides - a label for this command to be used in Editor - UI menus for example + description: |- + Optional label that provides a label for this command + to be used in Editor UI menus for example type: string workingDir: - description: "Working directory where the - command should be executed \n Special variables - that can be used: \n - `$PROJECTS_ROOT`: - A path where projects sources are mounted - as defined by container component's sourceMapping. - \n - `$PROJECT_SOURCE`: A path to a project - source ($PROJECTS_ROOT/). - If there are multiple projects, this will - point to the directory of the first one." + description: |- + Working directory where the command should be executed + + + Special variables that can be used: + + + - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping. + + + - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one. type: string type: object id: - description: Mandatory identifier that allows - referencing this command in composite commands, - from a parent, or in events. + description: |- + Mandatory identifier that allows referencing + this command in composite commands, from + a parent, or in events. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string @@ -5900,9 +6030,9 @@ spec: type: object type: array components: - description: Overrides of components encapsulated in - a parent devfile or a plugin. Overriding is done according - to K8S strategic merge patch standard rules. + description: |- + Overrides of components encapsulated in a parent devfile or a plugin. + Overriding is done according to K8S strategic merge patch standard rules. items: properties: attributes: @@ -5941,21 +6071,20 @@ spec: type: object type: object args: - description: "The arguments to supply to the - command running the dockerimage component. - The arguments are supplied either to the - default command provided in the image or - to the overridden command. \n Defaults to - an empty array, meaning use whatever is - defined in the image." + description: |- + The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array command: - description: "The command to run in the dockerimage - component instead of the default one provided - in the image. \n Defaults to an empty array, - meaning use whatever is defined in the image." + description: |- + The command to run in the dockerimage component instead of the default one provided in the image. + + + Defaults to an empty array, meaning use whatever is defined in the image. items: type: string type: array @@ -5964,10 +6093,12 @@ spec: cpuRequest: type: string dedicatedPod: - description: "Specify if a container should - run in its own separated pod, instead of - running as part of the main development - environment pod. \n Default value is `false`" + description: |- + Specify if a container should run in its own separated pod, + instead of running as part of the main development environment pod. + + + Default value is `false` type: boolean endpoints: items: @@ -5980,31 +6111,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6018,29 +6156,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6050,27 +6190,31 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name type: object type: array env: - description: "Environment variables used in - this container. \n The following variables - are reserved and cannot be overridden via - env: \n - `$PROJECTS_ROOT` \n - `$PROJECT_SOURCE`" + description: |- + Environment variables used in this container. + + + The following variables are reserved and cannot be overridden via env: + + + - `$PROJECTS_ROOT` + + + - `$PROJECT_SOURCE` items: properties: name: @@ -6088,18 +6232,18 @@ spec: memoryRequest: type: string mountSources: - description: "Toggles whether or not the project - source code should be mounted in the component. - \n Defaults to true for all component types - except plugins and components that set `dedicatedPod` - to true." + description: |- + Toggles whether or not the project source code should + be mounted in the component. + + + Defaults to true for all component types except plugins and components that set `dedicatedPod` to true. type: boolean sourceMapping: - description: Optional specification of the - path in the container where project sources - should be transferred/mounted when `mountSources` - is `true`. When omitted, the default value - of /projects is used. + description: |- + Optional specification of the path in the container where + project sources should be transferred/mounted when `mountSources` is `true`. + When omitted, the default value of /projects is used. type: string volumeMounts: description: List of volumes mounts that should @@ -6109,20 +6253,17 @@ spec: to a component container properties: name: - description: The volume mount name is - the name of an existing `Volume` component. - If several containers mount the same - volume name then they will reuse the - same volume and will be able to access - to the same files. + description: |- + The volume mount name is the name of an existing `Volume` component. + If several containers mount the same volume name + then they will reuse the same volume and will be able to access to the same files. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string path: - description: The path in the component - container where the volume should - be mounted. If not path is mentioned, - default path is the is `/`. + description: |- + The path in the component container where the volume should be mounted. + If not path is mentioned, default path is the is `/`. type: string required: - name @@ -6134,9 +6275,11 @@ spec: of an image for outer loop builds properties: autoBuild: - description: "Defines if the image should - be built during startup. \n Default value - is `false`" + description: |- + Defines if the image should be built during startup. + + + Default value is `false` type: boolean dockerfile: description: Allows specifying dockerfile @@ -6158,21 +6301,15 @@ spec: source properties: id: - description: Id in a devfile registry - that contains a Dockerfile. The - src in the OCI registry required - for the Dockerfile build will be - downloaded for building the image. + description: |- + Id in a devfile registry that contains a Dockerfile. The src in the OCI registry + required for the Dockerfile build will be downloaded for building the image. type: string registryUrl: - description: Devfile Registry URL - to pull the Dockerfile from when - using the Devfile Registry as Dockerfile - src. To ensure the Dockerfile gets - resolved consistently in different - environments, it is recommended - to always specify the `devfileRegistryUrl` - when `Id` is used. + description: |- + Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. + To ensure the Dockerfile gets resolved consistently in different environments, + it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. type: string type: object git: @@ -6191,34 +6328,30 @@ spec: configured type: string revision: - description: The revision to checkout - from. Should be branch name, - tag or commit id. Default branch - is used if missing or specified - revision is not found. + description: |- + The revision to checkout from. Should be branch name, tag or commit id. + Default branch is used if missing or specified revision is not found. type: string type: object fileLocation: - description: Location of the Dockerfile - in the Git repository when using - git as Dockerfile src. Defaults - to Dockerfile. + description: |- + Location of the Dockerfile in the Git repository when using git as Dockerfile src. + Defaults to Dockerfile. type: string remotes: additionalProperties: type: string - description: The remotes map which - should be initialized in the git - project. Projects must have at least - one remote configured while StarterProjects - & Image Component's Git source can - only have at most one remote configured. + description: |- + The remotes map which should be initialized in the git project. + Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. type: object type: object rootRequired: - description: "Specify if a privileged - builder pod is required. \n Default - value is `false`" + description: |- + Specify if a privileged builder pod is required. + + + Default value is `false` type: boolean srcType: description: Type of Dockerfile src @@ -6228,10 +6361,9 @@ spec: - Git type: string uri: - description: URI Reference of a Dockerfile. - It can be a full URL or a relative URI - from the current devfile as the base - URI. + description: |- + URI Reference of a Dockerfile. + It can be a full URL or a relative URI from the current devfile as the base URI. type: string type: object imageName: @@ -6246,16 +6378,17 @@ spec: type: string type: object kubernetes: - description: Allows importing into the devworkspace - the Kubernetes resources defined in a given - manifest. For example this allows reusing the - Kubernetes definitions used to deploy some runtime - components in production. + description: |- + Allows importing into the devworkspace the Kubernetes resources + defined in a given manifest. For example this allows reusing the Kubernetes + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6268,31 +6401,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6306,29 +6446,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6338,17 +6480,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6369,24 +6508,25 @@ spec: type: string type: object name: - description: Mandatory name that allows referencing - the component from other elements (such as commands) - or from an external devfile that may reference - this component through a parent or a plugin. + description: |- + Mandatory name that allows referencing the component + from other elements (such as commands) or from an external + devfile that may reference this component through a parent or a plugin. maxLength: 63 pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the devworkspace - the OpenShift resources defined in a given manifest. - For example this allows reusing the OpenShift - definitions used to deploy some runtime components - in production. + description: |- + Allows importing into the devworkspace the OpenShift resources + defined in a given manifest. For example this allows reusing the OpenShift + definitions used to deploy some runtime components in production. properties: deployByDefault: - description: "Defines if the component should - be deployed during startup. \n Default value - is `false`" + description: |- + Defines if the component should be deployed during startup. + + + Default value is `false` type: boolean endpoints: items: @@ -6399,31 +6539,38 @@ spec: Route type: object attributes: - description: "Map of implementation-dependant - string-based free-form attributes. - \n Examples of Che-specific attributes: - \n - cookiesAuthEnabled: \"true\" - / \"false\", \n - type: \"terminal\" - / \"ide\" / \"ide-dev\"," + description: |- + Map of implementation-dependant string-based free-form attributes. + + + Examples of Che-specific attributes: + + + - cookiesAuthEnabled: "true" / "false", + + + - type: "terminal" / "ide" / "ide-dev", type: object x-kubernetes-preserve-unknown-fields: true exposure: - description: "Describes how the endpoint - should be exposed on the network. - \n - `public` means that the endpoint - will be exposed on the public network, - typically through a K8S ingress or - an OpenShift route. \n - `internal` - means that the endpoint will be exposed - internally outside of the main devworkspace - POD, typically by K8S services, to - be consumed by other elements running + description: |- + Describes how the endpoint should be exposed on the network. + + + - `public` means that the endpoint will be exposed on the public network, typically through + a K8S ingress or an OpenShift route. + + + - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, + typically by K8S services, to be consumed by other elements running on the same cloud internal network. - \n - `none` means that the endpoint - will not be exposed and will only - be accessible inside the main devworkspace - POD, on a local address. \n Default - value is `public`" + + + - `none` means that the endpoint will not be exposed and will only be accessible + inside the main devworkspace POD, on a local address. + + + Default value is `public` enum: - public - internal @@ -6437,29 +6584,31 @@ spec: description: Path of the endpoint URL type: string protocol: - description: "Describes the application - and transport protocols of the traffic - that will go through this endpoint. - \n - `http`: Endpoint will have `http` - traffic, typically on a TCP connection. - It will be automaticaly promoted to - `https` when the `secure` field is - set to `true`. \n - `https`: Endpoint - will have `https` traffic, typically - on a TCP connection. \n - `ws`: Endpoint - will have `ws` traffic, typically - on a TCP connection. It will be automaticaly - promoted to `wss` when the `secure` - field is set to `true`. \n - `wss`: - Endpoint will have `wss` traffic, - typically on a TCP connection. \n - - `tcp`: Endpoint will have traffic - on a TCP connection, without specifying - an application protocol. \n - `udp`: - Endpoint will have traffic on an UDP - connection, without specifying an - application protocol. \n Default value - is `http`" + description: |- + Describes the application and transport protocols of the traffic that will go through this endpoint. + + + - `http`: Endpoint will have `http` traffic, typically on a TCP connection. + It will be automaticaly promoted to `https` when the `secure` field is set to `true`. + + + - `https`: Endpoint will have `https` traffic, typically on a TCP connection. + + + - `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. + It will be automaticaly promoted to `wss` when the `secure` field is set to `true`. + + + - `wss`: Endpoint will have `wss` traffic, typically on a TCP connection. + + + - `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol. + + + - `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol. + + + Default value is `http` enum: - http - https @@ -6469,17 +6618,14 @@ spec: - udp type: string secure: - description: Describes whether the endpoint - should be secured and protected by - some authentication process. This - requires a protocol of `https` or - `wss`. + description: |- + Describes whether the endpoint should be secured and protected by some + authentication process. This requires a protocol of `https` or `wss`. type: boolean targetPort: - description: Port number to be used - within the container component. The - same port cannot be used by two different - container components. + description: |- + Port number to be used within the container component. The same port cannot + be used by two different container components. type: integer required: - name @@ -6500,13 +6646,14 @@ spec: type: string type: object volume: - description: Allows specifying the definition - of a volume shared by several other components + description: |- + Allows specifying the definition of a volume + shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored - persistently across restarts. Defaults to - false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6539,34 +6686,34 @@ spec: - name type: object registryUrl: - description: Registry URL to pull the parent devfile - from when using id in the parent reference. To ensure - the parent devfile gets resolved consistently in different - environments, it is recommended to always specify - the `registryUrl` when `id` is used. + description: |- + Registry URL to pull the parent devfile from when using id in the parent reference. + To ensure the parent devfile gets resolved consistently in different environments, + it is recommended to always specify the `registryUrl` when `id` is used. type: string uri: - description: URI Reference of a parent devfile YAML - file. It can be a full URL or a relative URI with - the current devfile as the base URI. + description: |- + URI Reference of a parent devfile YAML file. + It can be a full URL or a relative URI with the current devfile as the base URI. type: string version: - description: Specific stack/sample version to pull the - parent devfile from, when using id in the parent reference. - To specify `version`, `id` must be defined and used - as the import reference source. `version` can be either - a specific stack version, or `latest`. If no `version` - specified, default version will be used. + description: |- + Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. + To specify `version`, `id` must be defined and used as the import reference source. + `version` can be either a specific stack version, or `latest`. + If no `version` specified, default version will be used. pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$ type: string type: object volume: - description: Allows specifying the definition of a volume + description: |- + Allows specifying the definition of a volume shared by several other components properties: ephemeral: - description: Ephemeral volumes are not stored persistently - across restarts. Defaults to false + description: |- + Ephemeral volumes are not stored persistently across restarts. Defaults + to false type: boolean size: description: Size of the volume @@ -6577,9 +6724,10 @@ spec: type: object type: array defaultEditor: - description: The default editor to workspace create with. It could - be a plugin ID or a URI. The plugin ID must have `publisher/name/version` - format. The URI must start from `http://` or `https://`. + description: |- + The default editor to workspace create with. It could be a plugin ID or a URI. + The plugin ID must have `publisher/name/version` format. + The URI must start from `http://` or `https://`. type: string defaultNamespace: default: @@ -6589,16 +6737,15 @@ spec: properties: autoProvision: default: true - description: Indicates if is allowed to automatically create - a user namespace. If it set to false, then user namespace - must be pre-created by a cluster administrator. + description: |- + Indicates if is allowed to automatically create a user namespace. + If it set to false, then user namespace must be pre-created by a cluster administrator. type: boolean template: default: -che - description: If you don't create the user namespaces in advance, - this field defines the Kubernetes namespace created when - you start your first workspace. You can use `` - and `` placeholders, such as che-workspace-. + description: |- + If you don't create the user namespaces in advance, this field defines the Kubernetes namespace created when you start your first workspace. + You can use `` and `` placeholders, such as che-workspace-. pattern: | type: string type: object @@ -6607,7 +6754,8 @@ spec: items: properties: editor: - description: The editor ID to specify default plug-ins for. + description: |- + The editor ID to specify default plug-ins for. The plugin ID must have `publisher/name/version` format. type: string plugins: @@ -6618,25 +6766,30 @@ spec: type: object type: array deploymentStrategy: - description: DeploymentStrategy defines the deployment strategy - to use to replace existing workspace pods with new ones. The - available deployment stragies are `Recreate` and `RollingUpdate`. - With the `Recreate` deployment strategy, the existing workspace - pod is killed before the new one is created. With the `RollingUpdate` - deployment strategy, a new workspace pod is created and the - existing workspace pod is deleted only when the new workspace - pod is in a ready state. If not specified, the default `Recreate` - deployment strategy is used. + description: |- + DeploymentStrategy defines the deployment strategy to use to replace existing workspace pods + with new ones. The available deployment stragies are `Recreate` and `RollingUpdate`. + With the `Recreate` deployment strategy, the existing workspace pod is killed before the new one is created. + With the `RollingUpdate` deployment strategy, a new workspace pod is created and the existing workspace pod is deleted + only when the new workspace pod is in a ready state. + If not specified, the default `Recreate` deployment strategy is used. enum: - Recreate - RollingUpdate type: string disableContainerBuildCapabilities: - description: "Disables the container build capabilities. When - set to `false` (the default value), the devEnvironments.security.containerSecurityContext - field is ignored, and the following container SecurityContext - is applied: \n containerSecurityContext: allowPrivilegeEscalation: - true capabilities: add: - SETGID - SETUID" + description: |- + Disables the container build capabilities. + When set to `false` (the default value), the devEnvironments.security.containerSecurityContext + field is ignored, and the following container SecurityContext is applied: + + + containerSecurityContext: + allowPrivilegeEscalation: true + capabilities: + add: + - SETGID + - SETUID type: boolean gatewayContainer: description: GatewayContainer configuration. @@ -6652,16 +6805,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6674,10 +6827,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6686,12 +6839,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6704,12 +6856,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6729,6 +6880,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6738,10 +6890,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6750,6 +6902,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -6782,19 +6935,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6807,19 +6960,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -6835,16 +6988,17 @@ spec: - Never type: string maxNumberOfRunningWorkspacesPerUser: - description: The maximum number of running workspaces per user. + description: |- + The maximum number of running workspaces per user. The value, -1, allows users to run an unlimited number of workspaces. format: int64 minimum: -1 type: integer maxNumberOfWorkspacesPerUser: default: -1 - description: Total number of workspaces, both stopped and running, - that a user can keep. The value, -1, allows users to keep an - unlimited number of workspaces. + description: |- + Total number of workspaces, both stopped and running, that a user can keep. + The value, -1, allows users to keep an unlimited number of workspaces. format: int64 minimum: -1 type: integer @@ -6855,19 +7009,22 @@ spec: workspace pods. type: object persistUserHome: - description: PersistUserHome defines configuration options for - persisting the user home directory in workspaces. + description: |- + PersistUserHome defines configuration options for persisting the + user home directory in workspaces. properties: enabled: - description: Determines whether the user home directory in - workspaces should persist between workspace shutdown and - startup. Must be used with the 'per-user' or 'per-workspace' - PVC strategy in order to take effect. Disabled by default. + description: |- + Determines whether the user home directory in workspaces should persist between + workspace shutdown and startup. + Must be used with the 'per-user' or 'per-workspace' PVC strategy in order to take effect. + Disabled by default. type: boolean type: object podSchedulerName: - description: Pod scheduler for the workspace pods. If not specified, - the pod scheduler is set to the default scheduler on the cluster. + description: |- + Pod scheduler for the workspace pods. + If not specified, the pod scheduler is set to the default scheduler on the cluster. type: string projectCloneContainer: description: Project clone container configuration. @@ -6883,16 +7040,16 @@ spec: be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) are expanded - using the previously defined environment variables - in the container and any service environment variables. - If a variable cannot be resolved, the reference in - the input string will be unchanged. Double $$ are - reduced to a single $, which allows for escaping the - $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce - the string literal "$(VAR_NAME)". Escaped references - will never be expanded, regardless of whether the - variable exists or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment variable's value. @@ -6905,10 +7062,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the ConfigMap or @@ -6917,12 +7074,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the pod: supports - metadata.name, metadata.namespace, `metadata.labels['''']`, - `metadata.annotations['''']`, spec.nodeName, - spec.serviceAccountName, status.hostIP, status.podIP, - status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema the FieldPath @@ -6935,12 +7091,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of the container: - only resources limits and requests (limits.cpu, - limits.memory, limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: required for volumes, @@ -6960,6 +7115,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -6969,10 +7125,10 @@ spec: from. Must be a valid secret key. type: string name: - description: 'Name of the referent. More info: - https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + description: |- + Name of the referent. + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the Secret or its @@ -6981,6 +7137,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7013,19 +7170,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7038,19 +7195,19 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = .5 cores) If the - value is not specified, then the default value is - set depending on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi = 500GiB = 500 - * 1024 * 1024 * 1024) If the value is not specified, - then the default value is set depending on the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true @@ -7059,42 +7216,44 @@ spec: type: object secondsOfInactivityBeforeIdling: default: 1800 - description: Idle timeout for workspaces in seconds. This timeout - is the duration after which a workspace will be idled if there - is no activity. To disable workspace idling due to inactivity, - set this value to -1. + description: |- + Idle timeout for workspaces in seconds. + This timeout is the duration after which a workspace will be idled if there is no activity. + To disable workspace idling due to inactivity, set this value to -1. format: int32 type: integer secondsOfRunBeforeIdling: default: -1 - description: Run timeout for workspaces in seconds. This timeout - is the maximum duration a workspace runs. To disable workspace - run timeout, set this value to -1. + description: |- + Run timeout for workspaces in seconds. + This timeout is the maximum duration a workspace runs. + To disable workspace run timeout, set this value to -1. format: int32 type: integer security: description: Workspace security configuration. properties: containerSecurityContext: - description: Container SecurityContext used by all workspace-related - containers. If set, defined values are merged into the default - Container SecurityContext configuration. Requires devEnvironments.disableContainerBuildCapabilities - to be set to `true` in order to take effect. + description: |- + Container SecurityContext used by all workspace-related containers. + If set, defined values are merged into the default Container SecurityContext configuration. + Requires devEnvironments.disableContainerBuildCapabilities to be set to `true` in order to take effect. properties: allowPrivilegeEscalation: - description: 'AllowPrivilegeEscalation controls whether - a process can gain more privileges than its parent process. - This bool directly controls if the no_new_privs flag - will be set on the container process. AllowPrivilegeEscalation - is true always when the container is: 1) run as Privileged - 2) has CAP_SYS_ADMIN Note that this field cannot be - set when spec.os.name is windows.' + description: |- + AllowPrivilegeEscalation controls whether a process can gain more + privileges than its parent process. This bool directly controls if + the no_new_privs flag will be set on the container process. + AllowPrivilegeEscalation is true always when the container is: + 1) run as Privileged + 2) has CAP_SYS_ADMIN + Note that this field cannot be set when spec.os.name is windows. type: boolean capabilities: - description: The capabilities to add/drop when running - containers. Defaults to the default set of capabilities - granted by the container runtime. Note that this field - cannot be set when spec.os.name is windows. + description: |- + The capabilities to add/drop when running containers. + Defaults to the default set of capabilities granted by the container runtime. + Note that this field cannot be set when spec.os.name is windows. properties: add: description: Added capabilities @@ -7112,61 +7271,60 @@ spec: type: array type: object privileged: - description: Run container in privileged mode. Processes - in privileged containers are essentially equivalent - to root on the host. Defaults to false. Note that this - field cannot be set when spec.os.name is windows. + description: |- + Run container in privileged mode. + Processes in privileged containers are essentially equivalent to root on the host. + Defaults to false. + Note that this field cannot be set when spec.os.name is windows. type: boolean procMount: - description: procMount denotes the type of proc mount - to use for the containers. The default is DefaultProcMount - which uses the container runtime defaults for readonly - paths and masked paths. This requires the ProcMountType - feature flag to be enabled. Note that this field cannot - be set when spec.os.name is windows. + description: |- + procMount denotes the type of proc mount to use for the containers. + The default is DefaultProcMount which uses the container runtime defaults for + readonly paths and masked paths. + This requires the ProcMountType feature flag to be enabled. + Note that this field cannot be set when spec.os.name is windows. type: string readOnlyRootFilesystem: - description: Whether this container has a read-only root - filesystem. Default is false. Note that this field cannot - be set when spec.os.name is windows. + description: |- + Whether this container has a read-only root filesystem. + Default is false. + Note that this field cannot be set when spec.os.name is windows. type: boolean runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in PodSecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to the - container. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The SELinux context to be applied to the container. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7186,137 +7344,135 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by this container. - If seccomp options are provided at both the pod & container - level, the container options override the pod options. - Note that this field cannot be set when spec.os.name - is windows. + description: |- + The seccomp options to use by this container. If seccomp options are + provided at both the pod & container level, the container options + override the pod options. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options from the - PodSecurityContext will be used. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. Note that this field cannot be set - when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options from the PodSecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object podSecurityContext: - description: PodSecurityContext used by all workspace-related - pods. If set, defined values are merged into the default - PodSecurityContext configuration. + description: |- + PodSecurityContext used by all workspace-related pods. + If set, defined values are merged into the default PodSecurityContext configuration. properties: fsGroup: - description: "A special supplemental group that applies - to all containers in a pod. Some volume types allow - the Kubelet to change the ownership of that volume to - be owned by the pod: \n 1. The owning GID will be the - FSGroup 2. The setgid bit is set (new files created - in the volume will be owned by FSGroup) 3. The permission - will not modify the ownership and permissions of any - volume. Note that this field cannot be set when spec.os.name - is windows." + description: |- + A special supplemental group that applies to all containers in a pod. + Some volume types allow the Kubelet to change the ownership of that volume + to be owned by the pod: + + + 1. The owning GID will be the FSGroup + 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) + + + If unset, the Kubelet will not modify the ownership and permissions of any volume. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer fsGroupChangePolicy: - description: 'fsGroupChangePolicy defines behavior of - changing ownership and permission of the volume before - being exposed inside Pod. This field will only apply - to volume types which support fsGroup based ownership(and - permissions). It will have no effect on ephemeral volume - types such as: secret, configmaps and emptydir. Valid - values are "OnRootMismatch" and "Always". If not specified, - "Always" is used. Note that this field cannot be set - when spec.os.name is windows.' + description: |- + fsGroupChangePolicy defines behavior of changing ownership and permission of the volume + before being exposed inside Pod. This field will only apply to + volume types which support fsGroup based ownership(and permissions). + It will have no effect on ephemeral volume types such as: secret, configmaps + and emptydir. + Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + Note that this field cannot be set when spec.os.name is windows. type: string runAsGroup: - description: The GID to run the entrypoint of the container - process. Uses runtime default if unset. May also be - set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer runAsNonRoot: - description: Indicates that the container must run as - a non-root user. If true, the Kubelet will validate - the image at runtime to ensure that it does not run - as UID 0 (root) and fail to start the container if it - does. If unset or false, no such validation will be - performed. May also be set in SecurityContext. If set - in both SecurityContext and PodSecurityContext, the - value specified in SecurityContext takes precedence. + description: |- + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it + does not run as UID 0 (root) and fail to start the container if it does. + If unset or false, no such validation will be performed. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: boolean runAsUser: - description: The UID to run the entrypoint of the container - process. Defaults to user specified in image metadata - if unspecified. May also be set in SecurityContext. If - set in both SecurityContext and PodSecurityContext, - the value specified in SecurityContext takes precedence - for that container. Note that this field cannot be set - when spec.os.name is windows. + description: |- + The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. format: int64 type: integer seLinuxOptions: - description: The SELinux context to be applied to all - containers. If unspecified, the container runtime will - allocate a random SELinux context for each container. May - also be set in SecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. Note that this - field cannot be set when spec.os.name is windows. + description: |- + The SELinux context to be applied to all containers. + If unspecified, the container runtime will allocate a random SELinux context for each + container. May also be set in SecurityContext. If set in + both SecurityContext and PodSecurityContext, the value specified in SecurityContext + takes precedence for that container. + Note that this field cannot be set when spec.os.name is windows. properties: level: description: Level is SELinux level label that applies @@ -7336,49 +7492,48 @@ spec: type: string type: object seccompProfile: - description: The seccomp options to use by the containers - in this pod. Note that this field cannot be set when - spec.os.name is windows. + description: |- + The seccomp options to use by the containers in this pod. + Note that this field cannot be set when spec.os.name is windows. properties: localhostProfile: - description: localhostProfile indicates a profile - defined in a file on the node should be used. The - profile must be preconfigured on the node to work. - Must be a descending path, relative to the kubelet's - configured seccomp profile location. Must only be - set if type is "Localhost". + description: |- + localhostProfile indicates a profile defined in a file on the node should be used. + The profile must be preconfigured on the node to work. + Must be a descending path, relative to the kubelet's configured seccomp profile location. + Must only be set if type is "Localhost". type: string type: - description: "type indicates which kind of seccomp - profile will be applied. Valid options are: \n Localhost - - a profile defined in a file on the node should - be used. RuntimeDefault - the container runtime - default profile should be used. Unconfined - no - profile should be applied." + description: |- + type indicates which kind of seccomp profile will be applied. + Valid options are: + + + Localhost - a profile defined in a file on the node should be used. + RuntimeDefault - the container runtime default profile should be used. + Unconfined - no profile should be applied. type: string required: - type type: object supplementalGroups: - description: A list of groups applied to the first process - run in each container, in addition to the container's - primary GID, the fsGroup (if specified), and group memberships - defined in the container image for the uid of the container - process. If unspecified, no additional groups are added - to any container. Note that group memberships defined - in the container image for the uid of the container - process are still effective, even if they are not included - in this list. Note that this field cannot be set when - spec.os.name is windows. + description: |- + A list of groups applied to the first process run in each container, in addition + to the container's primary GID, the fsGroup (if specified), and group memberships + defined in the container image for the uid of the container process. If unspecified, + no additional groups are added to any container. Note that group memberships + defined in the container image for the uid of the container process are still effective, + even if they are not included in this list. + Note that this field cannot be set when spec.os.name is windows. items: format: int64 type: integer type: array sysctls: - description: Sysctls hold a list of namespaced sysctls - used for the pod. Pods with unsupported sysctls (by - the container runtime) might fail to launch. Note that - this field cannot be set when spec.os.name is windows. + description: |- + Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported + sysctls (by the container runtime) might fail to launch. + Note that this field cannot be set when spec.os.name is windows. items: description: Sysctl defines a kernel parameter to be set @@ -7395,43 +7550,38 @@ spec: type: object type: array windowsOptions: - description: The Windows specific settings applied to - all containers. If unspecified, the options within a - container's SecurityContext will be used. If set in - both SecurityContext and PodSecurityContext, the value - specified in SecurityContext takes precedence. Note - that this field cannot be set when spec.os.name is linux. + description: |- + The Windows specific settings applied to all containers. + If unspecified, the options within a container's SecurityContext will be used. + If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + Note that this field cannot be set when spec.os.name is linux. properties: gmsaCredentialSpec: - description: GMSACredentialSpec is where the GMSA - admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) - inlines the contents of the GMSA credential spec - named by the GMSACredentialSpecName field. + description: |- + GMSACredentialSpec is where the GMSA admission webhook + (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the + GMSA credential spec named by the GMSACredentialSpecName field. type: string gmsaCredentialSpecName: description: GMSACredentialSpecName is the name of the GMSA credential spec to use. type: string hostProcess: - description: HostProcess determines if a container - should be run as a 'Host Process' container. This - field is alpha-level and will only be honored by - components that enable the WindowsHostProcessContainers - feature flag. Setting this field without the feature - flag will result in errors when validating the Pod. - All of a Pod's containers must have the same effective - HostProcess value (it is not allowed to have a mix - of HostProcess containers and non-HostProcess containers). In - addition, if HostProcess is true then HostNetwork - must also be set to true. + description: |- + HostProcess determines if a container should be run as a 'Host Process' container. + This field is alpha-level and will only be honored by components that enable the + WindowsHostProcessContainers feature flag. Setting this field without the feature + flag will result in errors when validating the Pod. All of a Pod's containers must + have the same effective HostProcess value (it is not allowed to have a mix of HostProcess + containers and non-HostProcess containers). In addition, if HostProcess is true + then HostNetwork must also be set to true. type: boolean runAsUserName: - description: The UserName in Windows to run the entrypoint - of the container process. Defaults to the user specified - in image metadata if unspecified. May also be set - in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext - takes precedence. + description: |- + The UserName in Windows to run the entrypoint of the container process. + Defaults to the user specified in image metadata if unspecified. + May also be set in PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence. type: string type: object type: object @@ -7448,37 +7598,39 @@ spec: items: properties: audience: - description: Audience is the intended audience of the token. - A recipient of a token must identify itself with an identifier - specified in the audience of the token, and otherwise - should reject the token. The audience defaults to the + description: |- + Audience is the intended audience of the token. A recipient of a token + must identify itself with an identifier specified in the audience of the + token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. type: string expirationSeconds: default: 3600 - description: ExpirationSeconds is the requested duration - of validity of the service account token. As the token - approaches expiration, the kubelet volume plugin will - proactively rotate the service account token. The kubelet - will start trying to rotate the token if the token is - older than 80 percent of its time to live or if the token - is older than 24 hours. Defaults to 1 hour and must be - at least 10 minutes. + description: |- + ExpirationSeconds is the requested duration of validity of the service + account token. As the token approaches expiration, the kubelet volume + plugin will proactively rotate the service account token. The kubelet will + start trying to rotate the token if the token is older than 80 percent of + its time to live or if the token is older than 24 hours. Defaults to 1 hour + and must be at least 10 minutes. format: int64 minimum: 600 type: integer mountPath: - description: Path within the workspace container at which - the token should be mounted. Must not contain ':'. + description: |- + Path within the workspace container at which the token should be mounted. Must + not contain ':'. type: string name: - description: Identifiable name of the ServiceAccount token. - If multiple ServiceAccount tokens use the same mount path, - a generic name will be used for the projected volume instead. + description: |- + Identifiable name of the ServiceAccount token. + If multiple ServiceAccount tokens use the same mount path, a generic name will be used + for the projected volume instead. type: string path: - description: Path is the path relative to the mount point - of the file to project the token into. + description: |- + Path is the path relative to the mount point of the file to project the + token into. type: string required: - mountPath @@ -7488,10 +7640,10 @@ spec: type: array startTimeoutSeconds: default: 300 - description: StartTimeoutSeconds determines the maximum duration - (in seconds) that a workspace can take to start before it is - automatically failed. If not specified, the default value of - 300 seconds (5 minutes) is used. + description: |- + StartTimeoutSeconds determines the maximum duration (in seconds) that a workspace can take to start + before it is automatically failed. + If not specified, the default value of 300 seconds (5 minutes) is used. format: int32 minimum: 1 type: integer @@ -7531,12 +7683,12 @@ spec: type: object pvcStrategy: default: per-user - description: 'Persistent volume claim strategy for the Che - server. The supported strategies are: `per-user` (all workspaces - PVCs in one volume), `per-workspace` (each workspace is - given its own individual PVC) and `ephemeral` (non-persistent - storage where local changes will be lost when the workspace - is stopped.)' + description: |- + Persistent volume claim strategy for the Che server. + The supported strategies are: `per-user` (all workspaces PVCs in one volume), + `per-workspace` (each workspace is given its own individual PVC) + and `ephemeral` (non-persistent storage where local changes will be lost when + the workspace is stopped.) enum: - common - per-user @@ -7548,41 +7700,39 @@ spec: description: The pod tolerations of the workspace pods limit where the workspace pods can run. items: - description: The pod this Toleration is attached to tolerates - any taint that matches the triple using - the matching operator . + description: |- + The pod this Toleration is attached to tolerates any taint that matches + the triple using the matching operator . properties: effect: - description: Effect indicates the taint effect to match. - Empty means match all taint effects. When specified, allowed - values are NoSchedule, PreferNoSchedule and NoExecute. + description: |- + Effect indicates the taint effect to match. Empty means match all taint effects. + When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. type: string key: - description: Key is the taint key that the toleration applies - to. Empty means match all taint keys. If the key is empty, - operator must be Exists; this combination means to match - all values and all keys. + description: |- + Key is the taint key that the toleration applies to. Empty means match all taint keys. + If the key is empty, operator must be Exists; this combination means to match all values and all keys. type: string operator: - description: Operator represents a key's relationship to - the value. Valid operators are Exists and Equal. Defaults - to Equal. Exists is equivalent to wildcard for value, - so that a pod can tolerate all taints of a particular - category. + description: |- + Operator represents a key's relationship to the value. + Valid operators are Exists and Equal. Defaults to Equal. + Exists is equivalent to wildcard for value, so that a pod can + tolerate all taints of a particular category. type: string tolerationSeconds: - description: TolerationSeconds represents the period of - time the toleration (which must be of effect NoExecute, - otherwise this field is ignored) tolerates the taint. - By default, it is not set, which means tolerate the taint - forever (do not evict). Zero and negative values will - be treated as 0 (evict immediately) by the system. + description: |- + TolerationSeconds represents the period of time the toleration (which must be + of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, + it is not set, which means tolerate the taint forever (do not evict). Zero and + negative values will be treated as 0 (evict immediately) by the system. format: int64 type: integer value: - description: Value is the taint value the toleration matches - to. If the operator is Exists, the value should be empty, - otherwise just a regular string. + description: |- + Value is the taint value the toleration matches to. + If the operator is Exists, the value should be empty, otherwise just a regular string. type: string type: object type: array @@ -7590,20 +7740,19 @@ spec: description: Trusted certificate settings. properties: gitTrustedCertsConfigMapName: - description: 'The ConfigMap contains certificates to propagate - to the Che components and to provide a particular configuration - for Git. See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ - The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` - label.' + description: |- + The ConfigMap contains certificates to propagate to the Che components and to provide a particular configuration for Git. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ + The ConfigMap must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object user: description: User configuration. properties: clusterRoles: - description: Additional ClusterRoles assigned to the user. - The role must have `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + Additional ClusterRoles assigned to the user. + The role must have `app.kubernetes.io/part-of=che.eclipse.org` label. items: type: string type: array @@ -7621,9 +7770,9 @@ spec: hosted on Azure DevOps Service (dev.azure.com). properties: secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Azure DevOps Service Application ID and Client Secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services' + description: |- + Kubernetes secret, that contains Base64-encoded Azure DevOps Service Application ID and Client Secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services type: string required: - secretName @@ -7637,15 +7786,16 @@ spec: hosted on Bitbucket (bitbucket.org or self-hosted). properties: endpoint: - description: 'Bitbucket server endpoint URL. Deprecated - in favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/.' + description: |- + Bitbucket server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - Bitbucket OAuth 1.0 or OAuth 2.0 data. See the following - pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ - and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/.' + description: |- + Kubernetes secret, that contains Base64-encoded Bitbucket OAuth 1.0 or OAuth 2.0 data. + See the following pages for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ + and https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/. type: string required: - secretName @@ -7659,19 +7809,21 @@ spec: hosted on GitHub (GitHub.com or GitHub Enterprise). properties: disableSubdomainIsolation: - description: 'Disables subdomain isolation. Deprecated in - favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` - annotation. See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Disables subdomain isolation. + Deprecated in favor of `che.eclipse.org/scm-github-disable-subdomain-isolation` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: boolean endpoint: - description: 'GitHub server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + GitHub server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub OAuth Client id and GitHub OAuth Client secret. - See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub OAuth Client id and GitHub OAuth Client secret. + See the following page for details: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/. type: string required: - secretName @@ -7685,14 +7837,15 @@ spec: hosted on GitLab (gitlab.com or self-hosted). properties: endpoint: - description: 'GitLab server endpoint URL. Deprecated in - favor of `che.eclipse.org/scm-server-endpoint` annotation. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + GitLab server endpoint URL. + Deprecated in favor of `che.eclipse.org/scm-server-endpoint` annotation. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string secretName: - description: 'Kubernetes secret, that contains Base64-encoded - GitHub Application id and GitLab Application Client secret. - See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/.' + description: |- + Kubernetes secret, that contains Base64-encoded GitHub Application id and GitLab Application Client secret. + See the following page: https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/. type: string required: - secretName @@ -7711,10 +7864,13 @@ spec: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set for an Ingress - (a route for OpenShift platform). The defaults for kubernetes - platforms are: kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", nginx.ingress.kubernetes.io/proxy-connect-timeout: - "3600", nginx.ingress.kubernetes.io/ssl-redirect: "true"' + description: |- + Defines annotations which will be set for an Ingress (a route for OpenShift platform). + The defaults for kubernetes platforms are: + kubernetes.io/ingress.class: "nginx" + nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", + nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600", + nginx.ingress.kubernetes.io/ssl-redirect: "true" type: object auth: default: @@ -7725,15 +7881,12 @@ spec: description: Authentication settings. properties: advancedAuthorization: - description: Advance authorization settings. Determines which - users and groups are allowed to access Che. User is allowed - to access Che if he/she is either in the `allowUsers` list - or is member of group from `allowGroups` list and not in - neither the `denyUsers` list nor is member of group from - `denyGroups` list. If `allowUsers` and `allowGroups` are - empty, then all users are allowed to access Che. if `denyUsers` - and `denyGroups` are empty, then no users are denied to - access Che. + description: |- + Advance authorization settings. Determines which users and groups are allowed to access Che. + User is allowed to access Che if he/she is either in the `allowUsers` list or is member of group from `allowGroups` list + and not in neither the `denyUsers` list nor is member of group from `denyGroups` list. + If `allowUsers` and `allowGroups` are empty, then all users are allowed to access Che. + if `denyUsers` and `denyGroups` are empty, then no users are denied to access Che. properties: allowGroups: description: List of groups allowed to access Che (currently @@ -7774,10 +7927,13 @@ spec: description: Gateway configuration labels. type: object deployment: - description: 'Deployment override options. Since gateway - deployment consists of several containers, they must - be distinguished in the configuration by their names: - - `gateway` - `configbump` - `oauth-proxy` - `kube-rbac-proxy`' + description: |- + Deployment override options. + Since gateway deployment consists of several containers, they must be distinguished in the configuration by their names: + - `gateway` + - `configbump` + - `oauth-proxy` + - `kube-rbac-proxy` properties: containers: description: List of containers belonging to the pod. @@ -7796,19 +7952,16 @@ spec: Must be a C_IDENTIFIER. type: string value: - description: 'Variable references $(VAR_NAME) - are expanded using the previously defined - environment variables in the container - and any service environment variables. - If a variable cannot be resolved, the - reference in the input string will be - unchanged. Double $$ are reduced to - a single $, which allows for escaping - the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" - will produce the string literal "$(VAR_NAME)". - Escaped references will never be expanded, - regardless of whether the variable exists - or not. Defaults to "".' + description: |- + Variable references $(VAR_NAME) are expanded + using the previously defined environment variables in the container and + any service environment variables. If a variable cannot be resolved, + the reference in the input string will be unchanged. Double $$ are reduced + to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. + "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". + Escaped references will never be expanded, regardless of whether the variable + exists or not. + Defaults to "". type: string valueFrom: description: Source for the environment @@ -7822,10 +7975,10 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7835,12 +7988,11 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic fieldRef: - description: 'Selects a field of the - pod: supports metadata.name, metadata.namespace, - `metadata.labels['''']`, `metadata.annotations['''']`, - spec.nodeName, spec.serviceAccountName, - status.hostIP, status.podIP, status.podIPs.' + description: |- + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, + spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. properties: apiVersion: description: Version of the schema @@ -7855,13 +8007,11 @@ spec: required: - fieldPath type: object + x-kubernetes-map-type: atomic resourceFieldRef: - description: 'Selects a resource of - the container: only resources limits - and requests (limits.cpu, limits.memory, - limits.ephemeral-storage, requests.cpu, - requests.memory and requests.ephemeral-storage) - are currently supported.' + description: |- + Selects a resource of the container: only resources limits and requests + (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. properties: containerName: description: 'Container name: @@ -7884,6 +8034,7 @@ spec: required: - resource type: object + x-kubernetes-map-type: atomic secretKeyRef: description: Selects a key of a secret in the pod's namespace @@ -7894,10 +8045,10 @@ spec: secret key. type: string name: - description: 'Name of the referent. + description: |- + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Add other useful fields. apiVersion, kind, uid? type: string optional: description: Specify whether the @@ -7906,6 +8057,7 @@ spec: required: - key type: object + x-kubernetes-map-type: atomic type: object required: - name @@ -7940,23 +8092,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -7968,23 +8117,20 @@ spec: anyOf: - type: integer - type: string - description: CPU, in cores. (500m = - .5 cores) If the value is not specified, - then the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + CPU, in cores. (500m = .5 cores) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true memory: anyOf: - type: integer - type: string - description: Memory, in bytes. (500Gi - = 500GiB = 500 * 1024 * 1024 * 1024) - If the value is not specified, then - the default value is set depending - on the component. If value is `0`, - then no value is set for the component. + description: |- + Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024) + If the value is not specified, then the default value is set depending on the component. + If value is `0`, then no value is set for the component. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true type: object @@ -8059,25 +8205,24 @@ spec: description: Public URL of the Identity Provider server. type: string identityToken: - description: 'Identity token to be passed to upstream. There - are two types of tokens supported: `id_token` and `access_token`. - Default value is `id_token`. This field is specific to Che - installations made for Kubernetes only and ignored for OpenShift.' + description: |- + Identity token to be passed to upstream. There are two types of tokens supported: `id_token` and `access_token`. + Default value is `id_token`. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. enum: - id_token - access_token type: string oAuthAccessTokenInactivityTimeoutSeconds: - description: Inactivity timeout for tokens to set in the OpenShift - `OAuthClient` resource used to set up identity federation - on the OpenShift side. 0 means tokens for this client never - time out. + description: |- + Inactivity timeout for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means tokens for this client never time out. format: int32 type: integer oAuthAccessTokenMaxAgeSeconds: - description: Access token max age for tokens to set in the - OpenShift `OAuthClient` resource used to set up identity - federation on the OpenShift side. 0 means no expiration. + description: |- + Access token max age for tokens to set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + 0 means no expiration. format: int32 type: integer oAuthClientName: @@ -8085,37 +8230,33 @@ spec: used to set up identity federation on the OpenShift side. type: string oAuthScope: - description: Access Token Scope. This field is specific to - Che installations made for Kubernetes only and ignored for - OpenShift. + description: |- + Access Token Scope. + This field is specific to Che installations made for Kubernetes only and ignored for OpenShift. type: string oAuthSecret: - description: 'Name of the secret set in the OpenShift `OAuthClient` - resource used to set up identity federation on the OpenShift - side. For Kubernetes, this can either be the plain text - oAuthSecret value, or the name of a kubernetes secret which - contains a key `oAuthSecret` and the value is the secret. - NOTE: this secret must exist in the same namespace as the - `CheCluster` resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`.' + description: |- + Name of the secret set in the OpenShift `OAuthClient` resource used to set up identity federation on the OpenShift side. + For Kubernetes, this can either be the plain text oAuthSecret value, or the name of a kubernetes secret which contains a + key `oAuthSecret` and the value is the secret. NOTE: this secret must exist in the same namespace as the `CheCluster` + resource and contain the label `app.kubernetes.io/part-of=che.eclipse.org`. type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the - domain to generate a hostname for the route. The generated hostname - follows this pattern: che-.. The - is the namespace where the CheCluster CRD is created. In conjunction - with labels, it creates a route served by a non-default Ingress - controller. For a Kubernetes cluster, it contains a global ingress - domain. There are no default values: you must specify them.' + description: |- + For an OpenShift cluster, the Operator uses the domain to generate a hostname for the route. + The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. + In conjunction with labels, it creates a route served by a non-default Ingress controller. + For a Kubernetes cluster, it contains a global ingress domain. There are no default values: you must specify them. type: string hostname: description: The public hostname of the installed Che server. type: string ingressClassName: - description: IngressClassName is the name of an IngressClass cluster - resource. If a class name is defined in both the `IngressClassName` - field and the `kubernetes.io/ingress.class` annotation, `IngressClassName` - field takes precedence. + description: |- + IngressClassName is the name of an IngressClass cluster resource. + If a class name is defined in both the `IngressClassName` field and the `kubernetes.io/ingress.class` annotation, + `IngressClassName` field takes precedence. type: string labels: additionalProperties: @@ -8124,10 +8265,10 @@ spec: route for OpenShift platform). type: object tlsSecretName: - description: The name of the secret used to set up Ingress TLS - termination. If the field is an empty string, the default cluster - certificate is used. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` - label. + description: |- + The name of the secret used to set up Ingress TLS termination. + If the field is an empty string, the default cluster certificate is used. + The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string type: object type: object @@ -8161,10 +8302,10 @@ spec: the Che deployment is in the current phase. type: string workspaceBaseDomain: - description: The resolved workspace base domain. This is either the - copy of the explicitly defined property of the same name in the - spec or, if it is undefined in the spec and we're running on OpenShift, - the automatically resolved basedomain for routes. + description: |- + The resolved workspace base domain. This is either the copy of the explicitly defined property of the + same name in the spec or, if it is undefined in the spec and we're running on OpenShift, the automatically + resolved basedomain for routes. type: string type: object type: object @@ -8172,9 +8313,3 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: []