From d8f7199439a2f8aea5bb22e6b7f2b8d6775669cc Mon Sep 17 00:00:00 2001 From: Jana Vrbkova Date: Thu, 16 Jun 2022 13:11:10 +0200 Subject: [PATCH] 2nd proofreading of api/v2/checluster_types.go (grammar, interpunction, clarity etc.) (#1404) * 2nd proofreading * Update dev resources Signed-off-by: Anatolii Bazko Co-authored-by: Anatolii Bazko --- api/v2/checluster_types.go | 68 ++++----- .../che-operator.clusterserviceversion.yaml | 18 +-- .../org.eclipse.che_checlusters.yaml | 136 +++++++++--------- .../bases/org.eclipse.che_checlusters.yaml | 133 +++++++++-------- .../che-operator.clusterserviceversion.yaml | 14 +- deploy/deployment/kubernetes/combined.yaml | 82 +++++------ ....eclipse.che.CustomResourceDefinition.yaml | 82 +++++------ deploy/deployment/openshift/combined.yaml | 82 +++++------ ....eclipse.che.CustomResourceDefinition.yaml | 82 +++++------ ....eclipse.che.CustomResourceDefinition.yaml | 82 +++++------ 10 files changed, 389 insertions(+), 390 deletions(-) diff --git a/api/v2/checluster_types.go b/api/v2/checluster_types.go index 9b34d706e..acd9889d5 100644 --- a/api/v2/checluster_types.go +++ b/api/v2/checluster_types.go @@ -39,7 +39,7 @@ type CheClusterSpec struct { // +operator-sdk:csv:customresourcedefinitions:type=spec,order=2 // +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Components" Components CheClusterComponents `json:"components"` - // Networking, Che authentication and TLS configuration. + // Networking, Che authentication, and TLS configuration. // +optional // +operator-sdk:csv:customresourcedefinitions:type=spec,order=3 // +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Networking" @@ -57,7 +57,7 @@ type CheClusterDevEnvironments struct { // Workspaces persistent storage. // +optional Storage WorkspaceStorage `json:"storage"` - // Default plug-ins applied to Dev Workspaces. + // Default plug-ins applied to DevWorkspaces. // +optional DefaultPlugins []WorkspaceDefaultPlugins `json:"defaultPlugins,omitempty"` // The node selector limits the nodes that can run the workspace pods. @@ -77,7 +77,7 @@ type CheClusterDevEnvironments struct { // Che components configuration. // +k8s:openapi-gen=true type CheClusterComponents struct { - // DevWorkspace operator configuration. + // DevWorkspace Operator configuration. // +optional DevWorkspace DevWorkspace `json:"devWorkspace"` // General configuration settings related to the Che server. @@ -86,13 +86,13 @@ type CheClusterComponents struct { // Configuration settings related to the plug-in registry used by the Che installation. // +optional PluginRegistry PluginRegistry `json:"pluginRegistry"` - // Configuration settings related to the Devfile registry used by the Che installation. + // Configuration settings related to the devfile registry used by the Che installation. // +optional DevfileRegistry DevfileRegistry `json:"devfileRegistry"` // Configuration settings related to the database used by the Che installation. // +optional Database Database `json:"database"` - // Configuration settings related to the Dashboard used by the Che installation. + // Configuration settings related to the dashboard used by the Che installation. // +optional Dashboard Dashboard `json:"dashboard"` // Kubernetes Image Puller configuration. @@ -103,13 +103,13 @@ type CheClusterComponents struct { Metrics ServerMetrics `json:"metrics"` } -// Configuration settings related to the Networking used by the Che installation. +// Configuration settings related to the networking used by the Che installation. // +k8s:openapi-gen=true type CheClusterSpecNetworking struct { - // Defines labels which will be set to an ingress (a route for OpenShift platform). + // Defines labels which will be set for an Ingress (a route for OpenShift platform). // +optional Labels map[string]string `json:"labels,omitempty"` - // Defines annotations which will be set to an ingress (a route for OpenShift platform). + // 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", @@ -117,10 +117,10 @@ type CheClusterSpecNetworking struct { // nginx.ingress.kubernetes.io/ssl-redirect: "true" // +optional Annotations map[string]string `json:"annotations,omitempty"` - // For an OpenShift cluster, the Operator uses the domain to generate a hostname for a route. + // 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 a conjunction with labels it creates a route, which is served by a non-default Ingress controller. - // For Kubernetes cluster it contains a global ingress domain. This MUST be explicitly specified: there are no defaults. + // 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. // +optional Domain string `json:"domain,omitempty"` // The public hostname of the installed Che server. @@ -178,9 +178,9 @@ type CheServer struct { // By specifying these settings for the OpenShift cluster, you override the OpenShift proxy configuration. // +optional Proxy Proxy `json:"proxy"` - // A map of additional environment variables applied in the generated `che` ConfigMap to be used by the Che server, + // 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` fields contains a property normally generated in `che` ConfigMap from other CR fields, + // 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. // +optional ExtraProperties map[string]string `json:"extraProperties,omitempty"` @@ -211,7 +211,7 @@ type PluginRegistry struct { ExternalPluginRegistries []ExternalPluginRegistry `json:"externalPluginRegistries,omitempty"` } -// Configuration settings related to the devfile Registry used by the Che installation. +// Configuration settings related to the devfile registry used by the Che installation. // +k8s:openapi-gen=true type DevfileRegistry struct { // Deployment override options. @@ -231,7 +231,7 @@ type Database struct { // Instructs the Operator to deploy a dedicated database. // By default, a dedicated PostgreSQL database is deployed as part of the Che installation. // When `externalDb` is set as `true`, no dedicated database is deployed by the - // Operator and you need to provide connection details to the external DB you want to use. + // Operator and you need to provide connection details about the external database you want to use. // +optional ExternalDb bool `json:"externalDb"` // Deployment override options. @@ -247,11 +247,11 @@ type Database struct { // +optional // +kubebuilder:default:="5432" PostgresPort string `json:"postgresPort,omitempty"` - // PostgreSQL database name that the Che server uses to connect to the DB. + // PostgreSQL database name that the Che server uses to connect to the database. // +optional // +kubebuilder:default:="dbche" PostgresDb string `json:"postgresDb,omitempty"` - // The secret that contains PostgreSQL `user` and `password` that the Che server uses to connect to the DB. + // The secret that contains PostgreSQL `user` and `password` that the Che server uses to connect to the database. // The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. // +optional // +kubebuilder:default:="postgres-credentials" @@ -282,12 +282,12 @@ type ImagePuller struct { // Note that while this Operator and its behavior is community-supported, its payload may be commercially-supported // for pulling commercially-supported images. Enable bool `json:"enable"` - // A Kubernetes Image Puller spec to configure the image puller in the CheCluster + // A Kubernetes Image Puller spec to configure the image puller in the CheCluster. // +optional Spec imagepullerv1alpha1.KubernetesImagePullerSpec `json:"spec"` } -// Settings for installation and configuration of the DevWorkspace operator +// Settings for installation and configuration of the DevWorkspace Operator // See https://github.com/devfile/devworkspace-operator // +k8s:openapi-gen=true type DevWorkspace struct { @@ -300,7 +300,7 @@ type DevWorkspace struct { } type DefaultNamespace struct { - // If you don't create user namespaces in advance, this field defines the Kubernetes namespace created when you start your first workspace. + // 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-. // +optional Template string `json:"template,omitempty"` @@ -329,7 +329,7 @@ type WorkspaceStorage struct { // +optional Pvc PVC `json:"pvc,omitempty"` // Persistent volume claim strategy for the Che server. - // Only the `common` strategy is supported (all workspaces PVCs in one volume). + // Only the `common` strategy (all workspaces PVCs in one volume) is supported . // For details, see https://github.com/eclipse/che/issues/21185. // +optional // +kubebuilder:default:="common" @@ -337,7 +337,7 @@ type WorkspaceStorage struct { } type WorkspaceDefaultPlugins struct { - // The editor id to specify default plug-ins for. + // The editor ID to specify default plug-ins for. Editor string `json:"editor,omitempty"` // Default plug-in URIs for the specified editor. Plugins []string `json:"plugins,omitempty"` @@ -374,7 +374,7 @@ type Gateway struct { // Proxy server configuration. type Proxy struct { // URL (protocol+hostname) of the proxy server. - // Use only when a proxy configuration is required. Operator respects OpenShift cluster-wide proxy configuration, + // 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields. // +optional @@ -387,7 +387,7 @@ type Proxy struct { // - localhost // - my.host.com // - 123.42.12.32 - // Use only when a proxy configuration is required. Operator respects OpenShift cluster-wide proxy configuration, + // 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields. NonProxyHosts []string `json:"nonProxyHosts,omitempty"` @@ -399,7 +399,7 @@ type Proxy struct { // PersistentVolumeClaim custom settings. type PVC struct { - // Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + // Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. // +optional ClaimSize string `json:"claimSize,omitempty"` // Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -449,10 +449,10 @@ type Container struct { // Describes the compute resource requirements. type ResourceRequirements struct { - // Request describes the minimum amount of compute resources required. + // Describes the minimum amount of compute resources required. // +optional Requests ResourceList `json:"request,omitempty"` - // Limits describe the maximum amount of compute resources allowed. + // Describes the maximum amount of compute resources allowed. // +optional Limits ResourceList `json:"limits,omitempty"` } @@ -504,13 +504,13 @@ type CheClusterStatus struct { // +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Gateway phase" // +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors="urn:alm:descriptor:text" GatewayPhase GatewayPhase `json:"gatewayPhase,omitempty"` - // Current installed Che version. + // Currently installed Che version. // +optional // +operator-sdk:csv:customresourcedefinitions:type=status // +operator-sdk:csv:customresourcedefinitions:type=status,displayName="displayName: Eclipse Che version" // +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors="urn:alm:descriptor:text" CheVersion string `json:"cheVersion"` - // Public URL to the Che server. + // Public URL of the Che server. // +optional // +operator-sdk:csv:customresourcedefinitions:type=status // +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Eclipse Che URL" @@ -522,25 +522,25 @@ type CheClusterStatus struct { // +operator-sdk:csv:customresourcedefinitions:type=status,displayName="ChePhase" // +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors="urn:alm:descriptor:text" ChePhase CheClusterPhase `json:"chePhase,omitempty"` - // The public URL to the internal devfile registry. + // The public URL of the internal devfile registry. // +optional // +operator-sdk:csv:customresourcedefinitions:type=status // +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Devfile registry URL" // +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors="urn:alm:descriptor:org.w3:link" DevfileRegistryURL string `json:"devfileRegistryURL"` - // The public URL to the internal plug-in registry. + // The public URL of the internal plug-in registry. // +optional // +operator-sdk:csv:customresourcedefinitions:type=status // +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Plugin registry URL" // +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors="urn:alm:descriptor:org.w3:link" PluginRegistryURL string `json:"pluginRegistryURL"` - // A human readable message indicating details about why the Che deployment is in current phase. + // A human readable message indicating details about why the Che deployment is in the current phase. // +optional // +operator-sdk:csv:customresourcedefinitions:type=status // +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Message" // +operator-sdk:csv:customresourcedefinitions:type=status,xDescriptors="urn:alm:descriptor:text" Message string `json:"message,omitempty"` - // A brief CamelCase message indicating details about why the Che deployment is in current phase. + // A brief CamelCase message indicating details about why the Che deployment is in the current phase. // +optional // +operator-sdk:csv:customresourcedefinitions:type=status // +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Reason" @@ -581,7 +581,7 @@ type CheCluster struct { // Desired configuration of Eclipse Che installation. Spec CheClusterSpec `json:"spec,omitempty"` - // CheClusterStatus defines the observed state of Che installation. + // Defines the observed state of Che installation. Status CheClusterStatus `json:"status,omitempty"` } diff --git a/bundle/next/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml b/bundle/next/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml index b1178c084..e1e72affb 100644 --- a/bundle/next/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml +++ b/bundle/next/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml @@ -97,7 +97,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-preview-openshift.v7.50.0-566.next + name: eclipse-che-preview-openshift.v7.50.0-567.next namespace: placeholder spec: apiservicedefinitions: {} @@ -150,7 +150,7 @@ spec: - description: Che components configuration. displayName: Components path: components - - description: Networking, Che authentication and TLS configuration. + - description: Networking, Che authentication, and TLS configuration. displayName: Networking path: networking - description: Configuration of an alternative registry that stores Che @@ -163,17 +163,17 @@ spec: path: chePhase x-descriptors: - urn:alm:descriptor:text - - description: Public URL to the Che server. + - description: Public URL of the Che server. displayName: Eclipse Che URL path: cheURL x-descriptors: - urn:alm:descriptor:org.w3:link - - description: Current installed Che version. + - description: Currently installed Che version. displayName: 'displayName: Eclipse Che version' path: cheVersion x-descriptors: - urn:alm:descriptor:text - - description: The public URL to the internal devfile registry. + - description: The public URL of the internal devfile registry. displayName: Devfile registry URL path: devfileRegistryURL x-descriptors: @@ -184,12 +184,12 @@ spec: x-descriptors: - urn:alm:descriptor:text - description: A human readable message indicating details about why the - Che deployment is in current phase. + Che deployment is in the current phase. displayName: Message path: message x-descriptors: - urn:alm:descriptor:text - - description: The public URL to the internal plug-in registry. + - description: The public URL of the internal plug-in registry. displayName: Plugin registry URL path: pluginRegistryURL x-descriptors: @@ -200,7 +200,7 @@ spec: x-descriptors: - urn:alm:descriptor:text - description: A brief CamelCase message indicating details about why the - Che deployment is in current phase. + Che deployment is in the current phase. displayName: Reason path: reason x-descriptors: @@ -1408,7 +1408,7 @@ spec: maturity: stable provider: name: Eclipse Foundation - version: 7.50.0-566.next + version: 7.50.0-567.next webhookdefinitions: - admissionReviewVersions: - v1 diff --git a/bundle/next/eclipse-che-preview-openshift/manifests/org.eclipse.che_checlusters.yaml b/bundle/next/eclipse-che-preview-openshift/manifests/org.eclipse.che_checlusters.yaml index fd9d211c2..b1b599b59 100644 --- a/bundle/next/eclipse-che-preview-openshift/manifests/org.eclipse.che_checlusters.yaml +++ b/bundle/next/eclipse-che-preview-openshift/manifests/org.eclipse.che_checlusters.yaml @@ -1319,7 +1319,7 @@ spec: container. properties: limits: - description: Limits describe the maximum amount + description: Describes the maximum amount of compute resources allowed. properties: cpu: @@ -1340,8 +1340,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum - amount of compute resources required. + description: Describes the minimum amount + of compute resources required. properties: cpu: anyOf: @@ -1384,9 +1384,9 @@ spec: 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 + server in addition to the values already generated from other fields of the `CheCluster` custom resource (CR). - If the `extraProperties` fields contains a property normally + 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 @@ -1411,12 +1411,12 @@ spec: 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. 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/4.4/networking/enable-cluster-wide-proxy.html. + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' items: type: string @@ -1426,8 +1426,8 @@ spec: type: string url: description: 'URL (protocol+hostname) of the proxy server. - Use only when a proxy configuration is required. Operator - respects OpenShift cluster-wide proxy configuration, + 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/4.4/networking/enable-cluster-wide-proxy.html. @@ -1436,7 +1436,7 @@ spec: type: object type: object dashboard: - description: Configuration settings related to the Dashboard + description: Configuration settings related to the dashboard used by the Che installation. properties: deployment: @@ -1465,7 +1465,7 @@ spec: container. properties: limits: - description: Limits describe the maximum amount + description: Describes the maximum amount of compute resources allowed. properties: cpu: @@ -1486,8 +1486,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum - amount of compute resources required. + description: Describes the minimum amount + of compute resources required. properties: cpu: anyOf: @@ -1544,7 +1544,7 @@ spec: default: postgres-credentials description: The secret that contains PostgreSQL `user` and `password` that the Che server uses to connect to - the DB. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` + the database. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string deployment: @@ -1573,7 +1573,7 @@ spec: container. properties: limits: - description: Limits describe the maximum amount + description: Describes the maximum amount of compute resources allowed. properties: cpu: @@ -1594,8 +1594,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum - amount of compute resources required. + description: Describes the minimum amount + of compute resources required. properties: cpu: anyOf: @@ -1639,12 +1639,12 @@ spec: is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details - to the external DB you want to use. + about the external database you want to use. type: boolean postgresDb: default: dbche description: PostgreSQL database name that the Che server - uses to connect to the DB. + uses to connect to the database. type: string postgresHostName: default: postgres @@ -1663,8 +1663,8 @@ spec: properties: claimSize: description: Persistent Volume Claim size. To update - the claim size, Storage class that provisions it must - support resize. + the claim size, the storage class that provisions + it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume @@ -1674,7 +1674,7 @@ spec: type: object type: object devWorkspace: - description: DevWorkspace operator configuration. + description: DevWorkspace Operator configuration. properties: deployment: description: Deployment override options. @@ -1702,7 +1702,7 @@ spec: container. properties: limits: - description: Limits describe the maximum amount + description: Describes the maximum amount of compute resources allowed. properties: cpu: @@ -1723,8 +1723,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum - amount of compute resources required. + description: Describes the minimum amount + of compute resources required. properties: cpu: anyOf: @@ -1768,7 +1768,7 @@ spec: type: string type: object devfileRegistry: - description: Configuration settings related to the Devfile registry + description: Configuration settings related to the devfile registry used by the Che installation. properties: deployment: @@ -1797,7 +1797,7 @@ spec: container. properties: limits: - description: Limits describe the maximum amount + description: Describes the maximum amount of compute resources allowed. properties: cpu: @@ -1818,8 +1818,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum - amount of compute resources required. + description: Describes the minimum amount + of compute resources required. properties: cpu: anyOf: @@ -1891,8 +1891,8 @@ spec: for pulling commercially-supported images. type: boolean spec: - description: A Kubernetes Image Puller spec to configure - the image puller in the CheCluster + description: A Kubernetes Image Puller spec to configure + the image puller in the CheCluster. properties: affinity: type: string @@ -1962,7 +1962,7 @@ spec: container. properties: limits: - description: Limits describe the maximum amount + description: Describes the maximum amount of compute resources allowed. properties: cpu: @@ -1983,8 +1983,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum - amount of compute resources required. + description: Describes the minimum amount + of compute resources required. properties: cpu: anyOf: @@ -2063,18 +2063,18 @@ spec: description: User's default namespace. properties: template: - description: If you don't create user namespaces in advance, - this field defines the Kubernetes namespace created when - you start your first workspace. You can use ``, + 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-. type: string type: object defaultPlugins: - description: Default plug-ins applied to Dev Workspaces. + description: Default plug-ins applied to DevWorkspaces. items: properties: editor: - description: The editor id to specify default plug-ins + description: The editor ID to specify default plug-ins for. type: string plugins: @@ -2098,8 +2098,8 @@ spec: properties: claimSize: description: Persistent Volume Claim size. To update - the claim size, Storage class that provisions it must - support resize. + the claim size, the storage class that provisions + it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume @@ -2110,8 +2110,8 @@ spec: pvcStrategy: default: common description: Persistent volume claim strategy for the Che - server. Only the `common` strategy is supported (all workspaces - PVCs in one volume). For details, see https://github.com/eclipse/che/issues/21185. + server. Only the `common` strategy (all workspaces PVCs + in one volume) is supported . For details, see https://github.com/eclipse/che/issues/21185. type: string type: object tolerations: @@ -2170,12 +2170,12 @@ spec: type: object type: object networking: - description: Networking, Che authentication and TLS configuration. + description: Networking, Che authentication, and TLS configuration. properties: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set to an ingress + 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"' @@ -2220,8 +2220,8 @@ spec: this container. properties: limits: - description: Limits describe the maximum - amount of compute resources allowed. + description: Describes the maximum amount + of compute resources allowed. properties: cpu: anyOf: @@ -2241,8 +2241,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum - amount of compute resources required. + description: Describes the minimum amount + of compute resources required. properties: cpu: anyOf: @@ -2298,13 +2298,13 @@ spec: type: object domain: description: 'For an OpenShift cluster, the Operator uses the - domain to generate a hostname for a route. The generated hostname - follows this pattern: che-.. The - is the namespace where the CheCluster CRD is created. In a - conjunction with labels it creates a route, which is served - by a non-default Ingress controller. For Kubernetes cluster - it contains a global ingress domain. This MUST be explicitly - specified: there are no defaults.' + 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. @@ -2312,7 +2312,7 @@ spec: labels: additionalProperties: type: string - description: Defines labels which will be set to an ingress + description: Defines labels which will be set for an Ingress (a route for OpenShift platform). type: object tlsSecretName: @@ -2324,36 +2324,36 @@ spec: type: object type: object status: - description: CheClusterStatus defines the observed state of Che installation. + description: Defines the observed state of Che installation. properties: chePhase: description: Specifies the current phase of the Che deployment. type: string cheURL: - description: Public URL to the Che server. + description: Public URL of the Che server. type: string cheVersion: - description: Current installed Che version. + description: Currently installed Che version. type: string devfileRegistryURL: - description: The public URL to the internal devfile registry. + description: The public URL of the internal devfile registry. type: string gatewayPhase: description: Specifies the current phase of the gateway deployment. type: string message: description: A human readable message indicating details about why - the Che deployment is in current phase. + the Che deployment is in the current phase. type: string pluginRegistryURL: - description: The public URL to the internal plug-in registry. + description: The public URL of the internal plug-in registry. type: string postgresVersion: description: The PostgreSQL version of the image in use. type: string reason: description: A brief CamelCase message indicating details about - why the Che deployment is in current phase. + why the Che deployment is in the current phase. type: string workspaceBaseDomain: description: The resolved workspace base domain. This is either diff --git a/config/crd/bases/org.eclipse.che_checlusters.yaml b/config/crd/bases/org.eclipse.che_checlusters.yaml index 5c0fb24f9..a1004acdc 100644 --- a/config/crd/bases/org.eclipse.che_checlusters.yaml +++ b/config/crd/bases/org.eclipse.che_checlusters.yaml @@ -1280,8 +1280,8 @@ spec: container. properties: limits: - description: Limits describe the maximum amount - of compute resources allowed. + description: Describes the maximum amount of + compute resources allowed. properties: cpu: anyOf: @@ -1300,8 +1300,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount - of compute resources required. + description: Describes the minimum amount of + compute resources required. properties: cpu: anyOf: @@ -1342,10 +1342,10 @@ spec: additionalProperties: type: string description: A map of additional environment variables applied - in the generated `che` ConfigMap to be used by the Che server, + 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` - fields contains a property normally generated in `che` ConfigMap + field contains a property normally generated in `che` ConfigMap from other CR fields, the value defined in the `extraProperties` is used instead. type: object @@ -1370,7 +1370,7 @@ spec: 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. Operator respects OpenShift + 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 @@ -1385,8 +1385,8 @@ spec: type: string url: description: 'URL (protocol+hostname) of the proxy server. - Use only when a proxy configuration is required. Operator - respects OpenShift cluster-wide proxy configuration, + 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/4.4/networking/enable-cluster-wide-proxy.html. @@ -1395,7 +1395,7 @@ spec: type: object type: object dashboard: - description: Configuration settings related to the Dashboard used + description: Configuration settings related to the dashboard used by the Che installation. properties: deployment: @@ -1424,8 +1424,8 @@ spec: container. properties: limits: - description: Limits describe the maximum amount - of compute resources allowed. + description: Describes the maximum amount of + compute resources allowed. properties: cpu: anyOf: @@ -1444,8 +1444,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount - of compute resources required. + description: Describes the minimum amount of + compute resources required. properties: cpu: anyOf: @@ -1500,7 +1500,7 @@ spec: credentialsSecretName: default: postgres-credentials description: The secret that contains PostgreSQL `user` and - `password` that the Che server uses to connect to the DB. + `password` that the Che server uses to connect to the database. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string @@ -1530,8 +1530,8 @@ spec: container. properties: limits: - description: Limits describe the maximum amount - of compute resources allowed. + description: Describes the maximum amount of + compute resources allowed. properties: cpu: anyOf: @@ -1550,8 +1550,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount - of compute resources required. + description: Describes the minimum amount of + compute resources required. properties: cpu: anyOf: @@ -1593,13 +1593,13 @@ spec: database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the - Operator and you need to provide connection details to the - external DB you want to use. + Operator and you need to provide connection details about + the external database you want to use. type: boolean postgresDb: default: dbche description: PostgreSQL database name that the Che server - uses to connect to the DB. + uses to connect to the database. type: string postgresHostName: default: postgres @@ -1618,8 +1618,8 @@ spec: properties: claimSize: description: Persistent Volume Claim size. To update the - claim size, Storage class that provisions it must support - resize. + claim size, the storage class that provisions it must + support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. @@ -1629,7 +1629,7 @@ spec: type: object type: object devWorkspace: - description: DevWorkspace operator configuration. + description: DevWorkspace Operator configuration. properties: deployment: description: Deployment override options. @@ -1657,8 +1657,8 @@ spec: container. properties: limits: - description: Limits describe the maximum amount - of compute resources allowed. + description: Describes the maximum amount of + compute resources allowed. properties: cpu: anyOf: @@ -1677,8 +1677,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount - of compute resources required. + description: Describes the minimum amount of + compute resources required. properties: cpu: anyOf: @@ -1721,7 +1721,7 @@ spec: type: string type: object devfileRegistry: - description: Configuration settings related to the Devfile registry + description: Configuration settings related to the devfile registry used by the Che installation. properties: deployment: @@ -1750,8 +1750,8 @@ spec: container. properties: limits: - description: Limits describe the maximum amount - of compute resources allowed. + description: Describes the maximum amount of + compute resources allowed. properties: cpu: anyOf: @@ -1770,8 +1770,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount - of compute resources required. + description: Describes the minimum amount of + compute resources required. properties: cpu: anyOf: @@ -1842,8 +1842,8 @@ spec: images. type: boolean spec: - description: A Kubernetes Image Puller spec to configure - the image puller in the CheCluster + description: A Kubernetes Image Puller spec to configure the + image puller in the CheCluster. properties: affinity: type: string @@ -1913,8 +1913,8 @@ spec: container. properties: limits: - description: Limits describe the maximum amount - of compute resources allowed. + description: Describes the maximum amount of + compute resources allowed. properties: cpu: anyOf: @@ -1933,8 +1933,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount - of compute resources required. + description: Describes the minimum amount of + compute resources required. properties: cpu: anyOf: @@ -2012,18 +2012,18 @@ spec: description: User's default namespace. properties: template: - description: If you don't create user namespaces in advance, + 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-. type: string type: object defaultPlugins: - description: Default plug-ins applied to Dev Workspaces. + description: Default plug-ins applied to DevWorkspaces. items: properties: editor: - description: The editor id to specify default plug-ins for. + description: The editor ID to specify default plug-ins for. type: string plugins: description: Default plug-in URIs for the specified editor. @@ -2046,8 +2046,8 @@ spec: properties: claimSize: description: Persistent Volume Claim size. To update the - claim size, Storage class that provisions it must support - resize. + claim size, the storage class that provisions it must + support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. @@ -2058,8 +2058,8 @@ spec: pvcStrategy: default: common description: Persistent volume claim strategy for the Che - server. Only the `common` strategy is supported (all workspaces - PVCs in one volume). For details, see https://github.com/eclipse/che/issues/21185. + server. Only the `common` strategy (all workspaces PVCs + in one volume) is supported . For details, see https://github.com/eclipse/che/issues/21185. type: string type: object tolerations: @@ -2117,12 +2117,12 @@ spec: type: object type: object networking: - description: Networking, Che authentication and TLS configuration. + description: Networking, Che authentication, and TLS configuration. properties: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set to an ingress + 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"' @@ -2167,8 +2167,8 @@ spec: container. properties: limits: - description: Limits describe the maximum - amount of compute resources allowed. + description: Describes the maximum amount + of compute resources allowed. properties: cpu: anyOf: @@ -2188,8 +2188,8 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum - amount of compute resources required. + description: Describes the minimum amount + of compute resources required. properties: cpu: anyOf: @@ -2244,13 +2244,12 @@ spec: type: object domain: description: 'For an OpenShift cluster, the Operator uses the - domain to generate a hostname for a route. The generated hostname + 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 a conjunction - with labels it creates a route, which is served by a non-default - Ingress controller. For Kubernetes cluster it contains a global - ingress domain. This MUST be explicitly specified: there are - no defaults.' + 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. @@ -2258,7 +2257,7 @@ spec: labels: additionalProperties: type: string - description: Defines labels which will be set to an ingress (a + description: Defines labels which will be set for an Ingress (a route for OpenShift platform). type: object tlsSecretName: @@ -2270,36 +2269,36 @@ spec: type: object type: object status: - description: CheClusterStatus defines the observed state of Che installation. + description: Defines the observed state of Che installation. properties: chePhase: description: Specifies the current phase of the Che deployment. type: string cheURL: - description: Public URL to the Che server. + description: Public URL of the Che server. type: string cheVersion: - description: Current installed Che version. + description: Currently installed Che version. type: string devfileRegistryURL: - description: The public URL to the internal devfile registry. + description: The public URL of the internal devfile registry. type: string gatewayPhase: description: Specifies the current phase of the gateway deployment. type: string message: description: A human readable message indicating details about why - the Che deployment is in current phase. + the Che deployment is in the current phase. type: string pluginRegistryURL: - description: The public URL to the internal plug-in registry. + description: The public URL of the internal plug-in registry. type: string postgresVersion: description: The PostgreSQL version of the image in use. type: string reason: description: A brief CamelCase message indicating details about why - the Che deployment is in current phase. + the Che deployment is in the current phase. type: string workspaceBaseDomain: description: The resolved workspace base domain. This is either the diff --git a/config/manifests/bases/che-operator.clusterserviceversion.yaml b/config/manifests/bases/che-operator.clusterserviceversion.yaml index a5398ab3b..38e07973a 100644 --- a/config/manifests/bases/che-operator.clusterserviceversion.yaml +++ b/config/manifests/bases/che-operator.clusterserviceversion.yaml @@ -79,7 +79,7 @@ spec: - description: Che components configuration. displayName: Components path: components - - description: Networking, Che authentication and TLS configuration. + - description: Networking, Che authentication, and TLS configuration. displayName: Networking path: networking - description: Configuration of an alternative registry that stores Che images. @@ -91,17 +91,17 @@ spec: path: chePhase x-descriptors: - urn:alm:descriptor:text - - description: Public URL to the Che server. + - description: Public URL of the Che server. displayName: Eclipse Che URL path: cheURL x-descriptors: - urn:alm:descriptor:org.w3:link - - description: Current installed Che version. + - description: Currently installed Che version. displayName: 'displayName: Eclipse Che version' path: cheVersion x-descriptors: - urn:alm:descriptor:text - - description: The public URL to the internal devfile registry. + - description: The public URL of the internal devfile registry. displayName: Devfile registry URL path: devfileRegistryURL x-descriptors: @@ -112,12 +112,12 @@ spec: x-descriptors: - urn:alm:descriptor:text - description: A human readable message indicating details about why the Che - deployment is in current phase. + deployment is in the current phase. displayName: Message path: message x-descriptors: - urn:alm:descriptor:text - - description: The public URL to the internal plug-in registry. + - description: The public URL of the internal plug-in registry. displayName: Plugin registry URL path: pluginRegistryURL x-descriptors: @@ -128,7 +128,7 @@ spec: x-descriptors: - urn:alm:descriptor:text - description: A brief CamelCase message indicating details about why the Che - deployment is in current phase. + deployment is in the current phase. displayName: Reason path: reason x-descriptors: diff --git a/deploy/deployment/kubernetes/combined.yaml b/deploy/deployment/kubernetes/combined.yaml index 5fa20b32e..c5740bc7f 100644 --- a/deploy/deployment/kubernetes/combined.yaml +++ b/deploy/deployment/kubernetes/combined.yaml @@ -823,7 +823,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -841,7 +841,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -877,7 +877,7 @@ 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` fields 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 @@ -890,7 +890,7 @@ spec: 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. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' items: type: string type: array @@ -898,12 +898,12 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. Use only when a proxy configuration is required. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' type: string type: object type: object dashboard: - description: Configuration settings related to the Dashboard used by the Che installation. + description: Configuration settings related to the dashboard used by the Che installation. properties: deployment: description: Deployment override options. @@ -926,7 +926,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -944,7 +944,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -993,7 +993,7 @@ spec: properties: credentialsSecretName: default: postgres-credentials - description: The secret that contains PostgreSQL `user` and `password` that the Che server uses to connect to the DB. The secret must have a `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 database. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string deployment: description: Deployment override options. @@ -1016,7 +1016,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1034,7 +1034,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1068,11 +1068,11 @@ spec: type: object type: object externalDb: - description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details to the external DB you want to use. + description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details about the external database you want to use. type: boolean postgresDb: default: dbche - description: PostgreSQL database name that the Che server uses to connect to the DB. + description: PostgreSQL database name that the Che server uses to connect to the database. type: string postgresHostName: default: postgres @@ -1086,7 +1086,7 @@ spec: description: PVC settings for PostgreSQL database. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1094,7 +1094,7 @@ spec: type: object type: object devWorkspace: - description: DevWorkspace operator configuration. + description: DevWorkspace Operator configuration. properties: deployment: description: Deployment override options. @@ -1117,7 +1117,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1135,7 +1135,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1173,7 +1173,7 @@ spec: type: string type: object devfileRegistry: - description: Configuration settings related to the Devfile registry used by the Che installation. + description: Configuration settings related to the devfile registry used by the Che installation. properties: deployment: description: Deployment override options. @@ -1196,7 +1196,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1214,7 +1214,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1268,7 +1268,7 @@ spec: 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 image puller in the CheCluster + description: A Kubernetes Image Puller spec to configure the image puller in the CheCluster. properties: affinity: type: string @@ -1332,7 +1332,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1350,7 +1350,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1415,15 +1415,15 @@ spec: description: User's default namespace. properties: template: - description: If you don't create 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-. type: string type: object defaultPlugins: - description: Default plug-ins applied to Dev Workspaces. + description: Default plug-ins applied to DevWorkspaces. items: properties: editor: - description: The editor id to specify default plug-ins for. + description: The editor ID to specify default plug-ins for. type: string plugins: description: Default plug-in URIs for the specified editor. @@ -1444,7 +1444,7 @@ spec: description: PVC settings. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1452,7 +1452,7 @@ spec: type: object pvcStrategy: default: common - description: Persistent volume claim strategy for the Che server. Only the `common` strategy is supported (all workspaces PVCs in one volume). For details, see https://github.com/eclipse/che/issues/21185. + description: Persistent volume claim strategy for the Che server. Only the `common` strategy (all workspaces PVCs in one volume) is supported . For details, see https://github.com/eclipse/che/issues/21185. type: string type: object tolerations: @@ -1487,12 +1487,12 @@ spec: type: object type: object networking: - description: Networking, Che authentication and TLS configuration. + description: Networking, Che authentication, and TLS configuration. properties: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set to 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: description: Authentication settings. @@ -1526,7 +1526,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1544,7 +1544,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1589,7 +1589,7 @@ spec: type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the domain to generate a hostname for a route. The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. In a conjunction with labels it creates a route, which is served by a non-default Ingress controller. For Kubernetes cluster it contains a global ingress domain. This MUST be explicitly specified: there are no defaults.' + 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. @@ -1597,7 +1597,7 @@ spec: labels: additionalProperties: type: string - description: Defines labels which will be set to an ingress (a route for OpenShift platform). + description: Defines labels which will be set for an Ingress (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. @@ -1605,34 +1605,34 @@ spec: type: object type: object status: - description: CheClusterStatus defines the observed state of Che installation. + description: Defines the observed state of Che installation. properties: chePhase: description: Specifies the current phase of the Che deployment. type: string cheURL: - description: Public URL to the Che server. + description: Public URL of the Che server. type: string cheVersion: - description: Current installed Che version. + description: Currently installed Che version. type: string devfileRegistryURL: - description: The public URL to the internal devfile registry. + description: The public URL of the internal devfile registry. type: string gatewayPhase: description: Specifies the current phase of the gateway deployment. type: string message: - description: A human readable message indicating details about why the Che deployment is in current phase. + description: A human readable message indicating details about why the Che deployment is in the current phase. type: string pluginRegistryURL: - description: The public URL to the internal plug-in registry. + description: The public URL of the internal plug-in registry. type: string postgresVersion: description: The PostgreSQL version of the image in use. type: string reason: - description: A brief CamelCase message indicating details about why the Che deployment is in current phase. + description: A brief CamelCase message indicating details about 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. 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 72a4ef439..65f38c392 100644 --- a/deploy/deployment/kubernetes/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml +++ b/deploy/deployment/kubernetes/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml @@ -818,7 +818,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -836,7 +836,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -872,7 +872,7 @@ 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` fields 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 @@ -885,7 +885,7 @@ spec: 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. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' items: type: string type: array @@ -893,12 +893,12 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. Use only when a proxy configuration is required. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' type: string type: object type: object dashboard: - description: Configuration settings related to the Dashboard used by the Che installation. + description: Configuration settings related to the dashboard used by the Che installation. properties: deployment: description: Deployment override options. @@ -921,7 +921,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -939,7 +939,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -988,7 +988,7 @@ spec: properties: credentialsSecretName: default: postgres-credentials - description: The secret that contains PostgreSQL `user` and `password` that the Che server uses to connect to the DB. The secret must have a `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 database. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string deployment: description: Deployment override options. @@ -1011,7 +1011,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1029,7 +1029,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1063,11 +1063,11 @@ spec: type: object type: object externalDb: - description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details to the external DB you want to use. + description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details about the external database you want to use. type: boolean postgresDb: default: dbche - description: PostgreSQL database name that the Che server uses to connect to the DB. + description: PostgreSQL database name that the Che server uses to connect to the database. type: string postgresHostName: default: postgres @@ -1081,7 +1081,7 @@ spec: description: PVC settings for PostgreSQL database. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1089,7 +1089,7 @@ spec: type: object type: object devWorkspace: - description: DevWorkspace operator configuration. + description: DevWorkspace Operator configuration. properties: deployment: description: Deployment override options. @@ -1112,7 +1112,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1130,7 +1130,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1168,7 +1168,7 @@ spec: type: string type: object devfileRegistry: - description: Configuration settings related to the Devfile registry used by the Che installation. + description: Configuration settings related to the devfile registry used by the Che installation. properties: deployment: description: Deployment override options. @@ -1191,7 +1191,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1209,7 +1209,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1263,7 +1263,7 @@ spec: 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 image puller in the CheCluster + description: A Kubernetes Image Puller spec to configure the image puller in the CheCluster. properties: affinity: type: string @@ -1327,7 +1327,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1345,7 +1345,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1410,15 +1410,15 @@ spec: description: User's default namespace. properties: template: - description: If you don't create 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-. type: string type: object defaultPlugins: - description: Default plug-ins applied to Dev Workspaces. + description: Default plug-ins applied to DevWorkspaces. items: properties: editor: - description: The editor id to specify default plug-ins for. + description: The editor ID to specify default plug-ins for. type: string plugins: description: Default plug-in URIs for the specified editor. @@ -1439,7 +1439,7 @@ spec: description: PVC settings. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1447,7 +1447,7 @@ spec: type: object pvcStrategy: default: common - description: Persistent volume claim strategy for the Che server. Only the `common` strategy is supported (all workspaces PVCs in one volume). For details, see https://github.com/eclipse/che/issues/21185. + description: Persistent volume claim strategy for the Che server. Only the `common` strategy (all workspaces PVCs in one volume) is supported . For details, see https://github.com/eclipse/che/issues/21185. type: string type: object tolerations: @@ -1482,12 +1482,12 @@ spec: type: object type: object networking: - description: Networking, Che authentication and TLS configuration. + description: Networking, Che authentication, and TLS configuration. properties: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set to 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: description: Authentication settings. @@ -1521,7 +1521,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1539,7 +1539,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1584,7 +1584,7 @@ spec: type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the domain to generate a hostname for a route. The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. In a conjunction with labels it creates a route, which is served by a non-default Ingress controller. For Kubernetes cluster it contains a global ingress domain. This MUST be explicitly specified: there are no defaults.' + 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. @@ -1592,7 +1592,7 @@ spec: labels: additionalProperties: type: string - description: Defines labels which will be set to an ingress (a route for OpenShift platform). + description: Defines labels which will be set for an Ingress (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. @@ -1600,34 +1600,34 @@ spec: type: object type: object status: - description: CheClusterStatus defines the observed state of Che installation. + description: Defines the observed state of Che installation. properties: chePhase: description: Specifies the current phase of the Che deployment. type: string cheURL: - description: Public URL to the Che server. + description: Public URL of the Che server. type: string cheVersion: - description: Current installed Che version. + description: Currently installed Che version. type: string devfileRegistryURL: - description: The public URL to the internal devfile registry. + description: The public URL of the internal devfile registry. type: string gatewayPhase: description: Specifies the current phase of the gateway deployment. type: string message: - description: A human readable message indicating details about why the Che deployment is in current phase. + description: A human readable message indicating details about why the Che deployment is in the current phase. type: string pluginRegistryURL: - description: The public URL to the internal plug-in registry. + description: The public URL of the internal plug-in registry. type: string postgresVersion: description: The PostgreSQL version of the image in use. type: string reason: - description: A brief CamelCase message indicating details about why the Che deployment is in current phase. + description: A brief CamelCase message indicating details about 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. diff --git a/deploy/deployment/openshift/combined.yaml b/deploy/deployment/openshift/combined.yaml index 068ec399b..50ddc4159 100644 --- a/deploy/deployment/openshift/combined.yaml +++ b/deploy/deployment/openshift/combined.yaml @@ -823,7 +823,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -841,7 +841,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -877,7 +877,7 @@ 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` fields 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 @@ -890,7 +890,7 @@ spec: 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. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' items: type: string type: array @@ -898,12 +898,12 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. Use only when a proxy configuration is required. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' type: string type: object type: object dashboard: - description: Configuration settings related to the Dashboard used by the Che installation. + description: Configuration settings related to the dashboard used by the Che installation. properties: deployment: description: Deployment override options. @@ -926,7 +926,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -944,7 +944,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -993,7 +993,7 @@ spec: properties: credentialsSecretName: default: postgres-credentials - description: The secret that contains PostgreSQL `user` and `password` that the Che server uses to connect to the DB. The secret must have a `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 database. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string deployment: description: Deployment override options. @@ -1016,7 +1016,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1034,7 +1034,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1068,11 +1068,11 @@ spec: type: object type: object externalDb: - description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details to the external DB you want to use. + description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details about the external database you want to use. type: boolean postgresDb: default: dbche - description: PostgreSQL database name that the Che server uses to connect to the DB. + description: PostgreSQL database name that the Che server uses to connect to the database. type: string postgresHostName: default: postgres @@ -1086,7 +1086,7 @@ spec: description: PVC settings for PostgreSQL database. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1094,7 +1094,7 @@ spec: type: object type: object devWorkspace: - description: DevWorkspace operator configuration. + description: DevWorkspace Operator configuration. properties: deployment: description: Deployment override options. @@ -1117,7 +1117,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1135,7 +1135,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1173,7 +1173,7 @@ spec: type: string type: object devfileRegistry: - description: Configuration settings related to the Devfile registry used by the Che installation. + description: Configuration settings related to the devfile registry used by the Che installation. properties: deployment: description: Deployment override options. @@ -1196,7 +1196,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1214,7 +1214,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1268,7 +1268,7 @@ spec: 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 image puller in the CheCluster + description: A Kubernetes Image Puller spec to configure the image puller in the CheCluster. properties: affinity: type: string @@ -1332,7 +1332,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1350,7 +1350,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1415,15 +1415,15 @@ spec: description: User's default namespace. properties: template: - description: If you don't create 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-. type: string type: object defaultPlugins: - description: Default plug-ins applied to Dev Workspaces. + description: Default plug-ins applied to DevWorkspaces. items: properties: editor: - description: The editor id to specify default plug-ins for. + description: The editor ID to specify default plug-ins for. type: string plugins: description: Default plug-in URIs for the specified editor. @@ -1444,7 +1444,7 @@ spec: description: PVC settings. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1452,7 +1452,7 @@ spec: type: object pvcStrategy: default: common - description: Persistent volume claim strategy for the Che server. Only the `common` strategy is supported (all workspaces PVCs in one volume). For details, see https://github.com/eclipse/che/issues/21185. + description: Persistent volume claim strategy for the Che server. Only the `common` strategy (all workspaces PVCs in one volume) is supported . For details, see https://github.com/eclipse/che/issues/21185. type: string type: object tolerations: @@ -1487,12 +1487,12 @@ spec: type: object type: object networking: - description: Networking, Che authentication and TLS configuration. + description: Networking, Che authentication, and TLS configuration. properties: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set to 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: description: Authentication settings. @@ -1526,7 +1526,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1544,7 +1544,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1589,7 +1589,7 @@ spec: type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the domain to generate a hostname for a route. The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. In a conjunction with labels it creates a route, which is served by a non-default Ingress controller. For Kubernetes cluster it contains a global ingress domain. This MUST be explicitly specified: there are no defaults.' + 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. @@ -1597,7 +1597,7 @@ spec: labels: additionalProperties: type: string - description: Defines labels which will be set to an ingress (a route for OpenShift platform). + description: Defines labels which will be set for an Ingress (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. @@ -1605,34 +1605,34 @@ spec: type: object type: object status: - description: CheClusterStatus defines the observed state of Che installation. + description: Defines the observed state of Che installation. properties: chePhase: description: Specifies the current phase of the Che deployment. type: string cheURL: - description: Public URL to the Che server. + description: Public URL of the Che server. type: string cheVersion: - description: Current installed Che version. + description: Currently installed Che version. type: string devfileRegistryURL: - description: The public URL to the internal devfile registry. + description: The public URL of the internal devfile registry. type: string gatewayPhase: description: Specifies the current phase of the gateway deployment. type: string message: - description: A human readable message indicating details about why the Che deployment is in current phase. + description: A human readable message indicating details about why the Che deployment is in the current phase. type: string pluginRegistryURL: - description: The public URL to the internal plug-in registry. + description: The public URL of the internal plug-in registry. type: string postgresVersion: description: The PostgreSQL version of the image in use. type: string reason: - description: A brief CamelCase message indicating details about why the Che deployment is in current phase. + description: A brief CamelCase message indicating details about 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. 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 85f625996..d82ecbc8c 100644 --- a/deploy/deployment/openshift/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml +++ b/deploy/deployment/openshift/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml @@ -818,7 +818,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -836,7 +836,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -872,7 +872,7 @@ 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` fields 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 @@ -885,7 +885,7 @@ spec: 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. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' items: type: string type: array @@ -893,12 +893,12 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. Use only when a proxy configuration is required. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' type: string type: object type: object dashboard: - description: Configuration settings related to the Dashboard used by the Che installation. + description: Configuration settings related to the dashboard used by the Che installation. properties: deployment: description: Deployment override options. @@ -921,7 +921,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -939,7 +939,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -988,7 +988,7 @@ spec: properties: credentialsSecretName: default: postgres-credentials - description: The secret that contains PostgreSQL `user` and `password` that the Che server uses to connect to the DB. The secret must have a `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 database. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string deployment: description: Deployment override options. @@ -1011,7 +1011,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1029,7 +1029,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1063,11 +1063,11 @@ spec: type: object type: object externalDb: - description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details to the external DB you want to use. + description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details about the external database you want to use. type: boolean postgresDb: default: dbche - description: PostgreSQL database name that the Che server uses to connect to the DB. + description: PostgreSQL database name that the Che server uses to connect to the database. type: string postgresHostName: default: postgres @@ -1081,7 +1081,7 @@ spec: description: PVC settings for PostgreSQL database. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1089,7 +1089,7 @@ spec: type: object type: object devWorkspace: - description: DevWorkspace operator configuration. + description: DevWorkspace Operator configuration. properties: deployment: description: Deployment override options. @@ -1112,7 +1112,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1130,7 +1130,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1168,7 +1168,7 @@ spec: type: string type: object devfileRegistry: - description: Configuration settings related to the Devfile registry used by the Che installation. + description: Configuration settings related to the devfile registry used by the Che installation. properties: deployment: description: Deployment override options. @@ -1191,7 +1191,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1209,7 +1209,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1263,7 +1263,7 @@ spec: 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 image puller in the CheCluster + description: A Kubernetes Image Puller spec to configure the image puller in the CheCluster. properties: affinity: type: string @@ -1327,7 +1327,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1345,7 +1345,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1410,15 +1410,15 @@ spec: description: User's default namespace. properties: template: - description: If you don't create 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-. type: string type: object defaultPlugins: - description: Default plug-ins applied to Dev Workspaces. + description: Default plug-ins applied to DevWorkspaces. items: properties: editor: - description: The editor id to specify default plug-ins for. + description: The editor ID to specify default plug-ins for. type: string plugins: description: Default plug-in URIs for the specified editor. @@ -1439,7 +1439,7 @@ spec: description: PVC settings. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1447,7 +1447,7 @@ spec: type: object pvcStrategy: default: common - description: Persistent volume claim strategy for the Che server. Only the `common` strategy is supported (all workspaces PVCs in one volume). For details, see https://github.com/eclipse/che/issues/21185. + description: Persistent volume claim strategy for the Che server. Only the `common` strategy (all workspaces PVCs in one volume) is supported . For details, see https://github.com/eclipse/che/issues/21185. type: string type: object tolerations: @@ -1482,12 +1482,12 @@ spec: type: object type: object networking: - description: Networking, Che authentication and TLS configuration. + description: Networking, Che authentication, and TLS configuration. properties: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set to 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: description: Authentication settings. @@ -1521,7 +1521,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1539,7 +1539,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1584,7 +1584,7 @@ spec: type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the domain to generate a hostname for a route. The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. In a conjunction with labels it creates a route, which is served by a non-default Ingress controller. For Kubernetes cluster it contains a global ingress domain. This MUST be explicitly specified: there are no defaults.' + 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. @@ -1592,7 +1592,7 @@ spec: labels: additionalProperties: type: string - description: Defines labels which will be set to an ingress (a route for OpenShift platform). + description: Defines labels which will be set for an Ingress (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. @@ -1600,34 +1600,34 @@ spec: type: object type: object status: - description: CheClusterStatus defines the observed state of Che installation. + description: Defines the observed state of Che installation. properties: chePhase: description: Specifies the current phase of the Che deployment. type: string cheURL: - description: Public URL to the Che server. + description: Public URL of the Che server. type: string cheVersion: - description: Current installed Che version. + description: Currently installed Che version. type: string devfileRegistryURL: - description: The public URL to the internal devfile registry. + description: The public URL of the internal devfile registry. type: string gatewayPhase: description: Specifies the current phase of the gateway deployment. type: string message: - description: A human readable message indicating details about why the Che deployment is in current phase. + description: A human readable message indicating details about why the Che deployment is in the current phase. type: string pluginRegistryURL: - description: The public URL to the internal plug-in registry. + description: The public URL of the internal plug-in registry. type: string postgresVersion: description: The PostgreSQL version of the image in use. type: string reason: - description: A brief CamelCase message indicating details about why the Che deployment is in current phase. + description: A brief CamelCase message indicating details about 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. diff --git a/helmcharts/next/crds/checlusters.org.eclipse.che.CustomResourceDefinition.yaml b/helmcharts/next/crds/checlusters.org.eclipse.che.CustomResourceDefinition.yaml index 72a4ef439..65f38c392 100644 --- a/helmcharts/next/crds/checlusters.org.eclipse.che.CustomResourceDefinition.yaml +++ b/helmcharts/next/crds/checlusters.org.eclipse.che.CustomResourceDefinition.yaml @@ -818,7 +818,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -836,7 +836,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -872,7 +872,7 @@ 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` fields 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 @@ -885,7 +885,7 @@ spec: 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. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyURL` fields.' items: type: string type: array @@ -893,12 +893,12 @@ spec: description: Proxy server port. type: string url: - description: 'URL (protocol+hostname) of the proxy server. Use only when a proxy configuration is required. 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' + 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/4.4/networking/enable-cluster-wide-proxy.html. See also the `proxyPort` and `nonProxyHosts` fields.' type: string type: object type: object dashboard: - description: Configuration settings related to the Dashboard used by the Che installation. + description: Configuration settings related to the dashboard used by the Che installation. properties: deployment: description: Deployment override options. @@ -921,7 +921,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -939,7 +939,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -988,7 +988,7 @@ spec: properties: credentialsSecretName: default: postgres-credentials - description: The secret that contains PostgreSQL `user` and `password` that the Che server uses to connect to the DB. The secret must have a `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 database. The secret must have a `app.kubernetes.io/part-of=che.eclipse.org` label. type: string deployment: description: Deployment override options. @@ -1011,7 +1011,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1029,7 +1029,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1063,11 +1063,11 @@ spec: type: object type: object externalDb: - description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details to the external DB you want to use. + description: Instructs the Operator to deploy a dedicated database. By default, a dedicated PostgreSQL database is deployed as part of the Che installation. When `externalDb` is set as `true`, no dedicated database is deployed by the Operator and you need to provide connection details about the external database you want to use. type: boolean postgresDb: default: dbche - description: PostgreSQL database name that the Che server uses to connect to the DB. + description: PostgreSQL database name that the Che server uses to connect to the database. type: string postgresHostName: default: postgres @@ -1081,7 +1081,7 @@ spec: description: PVC settings for PostgreSQL database. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1089,7 +1089,7 @@ spec: type: object type: object devWorkspace: - description: DevWorkspace operator configuration. + description: DevWorkspace Operator configuration. properties: deployment: description: Deployment override options. @@ -1112,7 +1112,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1130,7 +1130,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1168,7 +1168,7 @@ spec: type: string type: object devfileRegistry: - description: Configuration settings related to the Devfile registry used by the Che installation. + description: Configuration settings related to the devfile registry used by the Che installation. properties: deployment: description: Deployment override options. @@ -1191,7 +1191,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1209,7 +1209,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1263,7 +1263,7 @@ spec: 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 image puller in the CheCluster + description: A Kubernetes Image Puller spec to configure the image puller in the CheCluster. properties: affinity: type: string @@ -1327,7 +1327,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1345,7 +1345,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1410,15 +1410,15 @@ spec: description: User's default namespace. properties: template: - description: If you don't create 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-. type: string type: object defaultPlugins: - description: Default plug-ins applied to Dev Workspaces. + description: Default plug-ins applied to DevWorkspaces. items: properties: editor: - description: The editor id to specify default plug-ins for. + description: The editor ID to specify default plug-ins for. type: string plugins: description: Default plug-in URIs for the specified editor. @@ -1439,7 +1439,7 @@ spec: description: PVC settings. properties: claimSize: - description: Persistent Volume Claim size. To update the claim size, Storage class that provisions it must support resize. + description: Persistent Volume Claim size. To update the claim size, the storage class that provisions it must support resizing. type: string storageClass: description: Storage class for the Persistent Volume Claim. When omitted or left blank, a default storage class is used. @@ -1447,7 +1447,7 @@ spec: type: object pvcStrategy: default: common - description: Persistent volume claim strategy for the Che server. Only the `common` strategy is supported (all workspaces PVCs in one volume). For details, see https://github.com/eclipse/che/issues/21185. + description: Persistent volume claim strategy for the Che server. Only the `common` strategy (all workspaces PVCs in one volume) is supported . For details, see https://github.com/eclipse/che/issues/21185. type: string type: object tolerations: @@ -1482,12 +1482,12 @@ spec: type: object type: object networking: - description: Networking, Che authentication and TLS configuration. + description: Networking, Che authentication, and TLS configuration. properties: annotations: additionalProperties: type: string - description: 'Defines annotations which will be set to 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: description: Authentication settings. @@ -1521,7 +1521,7 @@ spec: description: Compute resources required by this container. properties: limits: - description: Limits describe the maximum amount of compute resources allowed. + description: Describes the maximum amount of compute resources allowed. properties: cpu: anyOf: @@ -1539,7 +1539,7 @@ spec: x-kubernetes-int-or-string: true type: object request: - description: Request describes the minimum amount of compute resources required. + description: Describes the minimum amount of compute resources required. properties: cpu: anyOf: @@ -1584,7 +1584,7 @@ spec: type: string type: object domain: - description: 'For an OpenShift cluster, the Operator uses the domain to generate a hostname for a route. The generated hostname follows this pattern: che-.. The is the namespace where the CheCluster CRD is created. In a conjunction with labels it creates a route, which is served by a non-default Ingress controller. For Kubernetes cluster it contains a global ingress domain. This MUST be explicitly specified: there are no defaults.' + 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. @@ -1592,7 +1592,7 @@ spec: labels: additionalProperties: type: string - description: Defines labels which will be set to an ingress (a route for OpenShift platform). + description: Defines labels which will be set for an Ingress (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. @@ -1600,34 +1600,34 @@ spec: type: object type: object status: - description: CheClusterStatus defines the observed state of Che installation. + description: Defines the observed state of Che installation. properties: chePhase: description: Specifies the current phase of the Che deployment. type: string cheURL: - description: Public URL to the Che server. + description: Public URL of the Che server. type: string cheVersion: - description: Current installed Che version. + description: Currently installed Che version. type: string devfileRegistryURL: - description: The public URL to the internal devfile registry. + description: The public URL of the internal devfile registry. type: string gatewayPhase: description: Specifies the current phase of the gateway deployment. type: string message: - description: A human readable message indicating details about why the Che deployment is in current phase. + description: A human readable message indicating details about why the Che deployment is in the current phase. type: string pluginRegistryURL: - description: The public URL to the internal plug-in registry. + description: The public URL of the internal plug-in registry. type: string postgresVersion: description: The PostgreSQL version of the image in use. type: string reason: - description: A brief CamelCase message indicating details about why the Che deployment is in current phase. + description: A brief CamelCase message indicating details about 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.