diff --git a/deploy/crds/org_v1_che_crd.yaml b/deploy/crds/org_v1_che_crd.yaml index 83435c854c..83ace4ae0f 100644 --- a/deploy/crds/org_v1_che_crd.yaml +++ b/deploy/crds/org_v1_che_crd.yaml @@ -66,10 +66,10 @@ spec: type: string identityProviderClientId: description: Name of a Identity provider, Keycloak or RH-SSO, `client-id` - that is used for Che. This is useful to override it ONLY if you - use an external Identity Provider. See the `externalIdentityProvider` - field. When omitted or left blank, it is set to the value of the - `flavour` field suffixed with `-public`. + that is used for Che. Override this when an external Identity + Provider is in use. See the `externalIdentityProvider` field. + When omitted or left blank, it is set to the value of the `flavour` + field suffixed with `-public`. type: string identityProviderContainerResources: description: Identity provider container custom settings. @@ -121,16 +121,15 @@ spec: type: object identityProviderPassword: description: Overrides the password of Keycloak administrator user. - This is useful to override it ONLY if you use an external Identity - Provider. See the `externalIdentityProvider` field. When omitted - or left blank, it is set to an auto-generated password. + Override this when an external Identity Provider is in use. See + the `externalIdentityProvider` field. When omitted or left blank, + it is set to an auto-generated password. type: string identityProviderPostgresPassword: description: Password for a Identity Provider, Keycloak or RH-SSO, - to connect to the database. This is useful to override it ONLY - if you use an external Identity Provider. See the `externalIdentityProvider` - field. When omitted or left blank, it is set to an auto-generated - password. + to connect to the database. Override this when an external Identity + Provider is in use. See the `externalIdentityProvider` field. + When omitted or left blank, it is set to an auto-generated password. type: string identityProviderPostgresSecret: description: 'The secret that contains `password` for the Identity @@ -145,10 +144,10 @@ spec: type: string identityProviderRealm: description: Name of a Identity provider, Keycloak or RH-SSO, realm - that is used for Che. This is useful to override it ONLY if you - use an external Identity Provider. See the `externalIdentityProvider` - field. When omitted or left blank, it is set to the value of the - `flavour` field. + that is used for Che. Override this when an external Identity + Provider is in use. See the `externalIdentityProvider` field. + When omitted or left blank, it is set to the value of the `flavour` + field. type: string identityProviderRoute: description: Route custom settings. @@ -180,12 +179,13 @@ spec: oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. Auto-generated - if left blank. See also the `OpenShiftoAuth` field. + when left blank. See also the `OpenShiftoAuth` field. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. - Auto-generated if left blank. See also the `OAuthClientName` field. + Auto-generated when left blank. See also the `OAuthClientName` + field. type: string openShiftoAuth: description: 'Enables the integration of the identity provider (Keycloak @@ -239,7 +239,7 @@ spec: type: string chePostgresHostName: description: PostgreSQL Database host name that the Che server uses - to connect to. Defaults to postgres. Override this value ONLY + to connect to. Defaults is `postgres`. Override this value ONLY when using an external database. See field `externalDb`. In the default case it will be automatically set by the Operator. type: string @@ -293,13 +293,14 @@ spec: properties: enable: description: "Install and configure the Community Supported Kubernetes - Image Puller Operator. If true and no spec is provided, it will - create a default KubernetesImagePuller object to be managed by - the Operator. If false, the KubernetesImagePuller object will - be deleted, and the Operator will be uninstalled, regardless of - whether a spec is provided. \n Note that while this the Operator - and its behavior is community-supported, its payload may be commercially-supported - if you use it for pulling commercially-supported images." + Image Puller Operator. When set to `true` and no spec is provided, + it will create a default KubernetesImagePuller object to be managed + by the Operator. When set to `false`, the KubernetesImagePuller + object will be deleted, and the Operator will be uninstalled, + regardless of whether a spec is provided. \n Note that while this + the Operator and its behavior is community-supported, its payload + may be commercially-supported for pulling commercially-supported + images." type: boolean spec: description: A KubernetesImagePullerSpec to configure the image @@ -337,8 +338,8 @@ spec: `kubernetes.io/ingress.class` annotation on Che-related ingresses.' type: string ingressDomain: - description: 'Global ingress domain for a K8S cluster. This MUST - be explicitly specified: there are no defaults.' + description: 'Global ingress domain for a Kubernetes cluster. This + MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: description: 'Strategy for ingress creation. Options are: `multi-host` @@ -363,9 +364,9 @@ spec: configured by this property. The possible values are `native`, which means that the server and workspaces are exposed using ingresses on K8s or `gateway` where the server and workspaces are exposed - using a custom gateway based on Traefik. All the endpoints whether - backed by the ingress or gateway `route` always point to the subpaths - on the same domain. Defaults to `native`. + using a custom gateway based on link:https://doc.traefik.io/traefik/[Traefik]. + All the endpoints whether backed by the ingress or gateway `route` + always point to the subpaths on the same domain. Defaults to `native`. type: string tlsSecretName: description: Name of a secret that will be used to setup ingress @@ -419,9 +420,9 @@ spec: type: string cheFlavor: description: Specifies a variation of the installation. The options - are `che` for upstream Che installations, or `codeready` for CodeReady - Workspaces installation. If not necessary, do not override the - default value. + are `che` for upstream Che installations, or `codeready` for link:https://developers.redhat.com/products/codeready-workspaces/overview[CodeReady + Workspaces] installation. Override the default value only on necessary + occasions. type: string cheHost: description: Public host name of the installed Che server. When @@ -470,17 +471,17 @@ spec: type: object cheWorkspaceClusterRole: description: Custom cluster role bound to the user for the Che workspaces. - The default roles are used if this is omitted or left blank. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string description: Map of additional environment variables that will be - applied in the generated `che` configMap to be used by the Che + applied in the generated `che` ConfigMap to be used by the Che server, in addition to the values already generated from other fields of the `CheCluster` custom resource (CR). When `customCheProperties` contains a property that would be normally generated in `che` - configMap from other CR fields, the value defined in the `customCheProperties` + ConfigMap from other CR fields, the value defined in the `customCheProperties` is used instead. type: object devfileRegistryCpuLimit: @@ -548,7 +549,7 @@ spec: type: boolean gitSelfSignedCert: description: When enabled, the certificate from `che-git-self-signed-cert` - configMap will be propagated to the Che components and provide + ConfigMap will be propagated to the Che components and provide particular configuration for Git. type: boolean nonProxyHosts: @@ -607,9 +608,9 @@ spec: type: object pluginRegistryUrl: description: Public URL of the plugin registry that serves sample - ready-to-use devfiles. Set this ONLY if a use of an external devfile - registry is needed. See the `externalPluginRegistry` field. By - default, this will be automatically calculated by the Operator. + ready-to-use devfiles. Set this ONLY when a use of an external + devfile registry is needed. See the `externalPluginRegistry` field. + By default, this will be automatically calculated by the Operator. type: string proxyPassword: description: Password of the proxy server. Only use when proxy configuration @@ -645,7 +646,7 @@ spec: type: string selfSignedCert: description: Deprecated. The value of this flag is ignored. The - Che Operator will automatically detect if the router certificate + Che Operator will automatically detect whether the router certificate is self-signed and propagate it to other components, such as the Che server. type: boolean @@ -678,7 +679,7 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: Name of the configMap with public certificates to add + description: Name of the ConfigMap with public certificates to add to Java trust store of the Che server. This is often required when adding the OpenShift OAuth provider, which has HTTPS endpoint signed with self-signed cert. The Che server must be aware of @@ -687,7 +688,7 @@ spec: singleHostGatewayConfigMapLabels: additionalProperties: type: string - description: The labels that need to be present in the configMaps + description: The labels that need to be present in the ConfigMaps representing the gateway configuration. type: object singleHostGatewayConfigSidecarImage: @@ -712,11 +713,10 @@ spec: type: boolean workspaceNamespaceDefault: description: Defines Kubernetes default namespace in which user's - workspaces are created if user does not override it. It's possible - to use ``,`` and `` placeholders, - such as che-workspace-. In that case, a new namespace - will be created for each user or workspace. Is used by OpenShift - infrastructure as well to specify Project. + workspaces are created for a case when a user does not override + it. It's possible to use ``, `` and `` + placeholders, such as che-workspace-. In that case, + a new namespace will be created for each user or workspace. type: string type: object storage: @@ -732,7 +732,7 @@ spec: description: Instructs the Che server to start a special Pod to pre-create a sub-path in the Persistent Volumes. Defaults to `false`, however it will need to enable it according to the configuration - of your K8S cluster. + of your Kubernetes cluster. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. diff --git a/deploy/olm-catalog/eclipse-che-preview-kubernetes/manifests/che-operator.clusterserviceversion.yaml b/deploy/olm-catalog/eclipse-che-preview-kubernetes/manifests/che-operator.clusterserviceversion.yaml index 66136f5871..2af8fb3018 100644 --- a/deploy/olm-catalog/eclipse-che-preview-kubernetes/manifests/che-operator.clusterserviceversion.yaml +++ b/deploy/olm-catalog/eclipse-che-preview-kubernetes/manifests/che-operator.clusterserviceversion.yaml @@ -84,13 +84,13 @@ metadata: categories: Developer Tools certified: "false" containerImage: quay.io/eclipse/che-operator:nightly - createdAt: "2021-02-10T17:04:13Z" + createdAt: "2021-02-12T09:38:09Z" description: A Kube-native development solution that delivers portable and collaborative developer workspaces. operatorframework.io/suggested-namespace: eclipse-che repository: https://github.com/eclipse/che-operator support: Eclipse Foundation - name: eclipse-che-preview-kubernetes.v7.26.0-92.nightly + name: eclipse-che-preview-kubernetes.v7.27.0-98.nightly namespace: placeholder spec: apiservicedefinitions: {} @@ -676,4 +676,4 @@ spec: maturity: stable provider: name: Eclipse Foundation - version: 7.26.0-92.nightly + version: 7.27.0-98.nightly diff --git a/deploy/olm-catalog/eclipse-che-preview-kubernetes/manifests/org_v1_che_crd.yaml b/deploy/olm-catalog/eclipse-che-preview-kubernetes/manifests/org_v1_che_crd.yaml index 83435c854c..83ace4ae0f 100644 --- a/deploy/olm-catalog/eclipse-che-preview-kubernetes/manifests/org_v1_che_crd.yaml +++ b/deploy/olm-catalog/eclipse-che-preview-kubernetes/manifests/org_v1_che_crd.yaml @@ -66,10 +66,10 @@ spec: type: string identityProviderClientId: description: Name of a Identity provider, Keycloak or RH-SSO, `client-id` - that is used for Che. This is useful to override it ONLY if you - use an external Identity Provider. See the `externalIdentityProvider` - field. When omitted or left blank, it is set to the value of the - `flavour` field suffixed with `-public`. + that is used for Che. Override this when an external Identity + Provider is in use. See the `externalIdentityProvider` field. + When omitted or left blank, it is set to the value of the `flavour` + field suffixed with `-public`. type: string identityProviderContainerResources: description: Identity provider container custom settings. @@ -121,16 +121,15 @@ spec: type: object identityProviderPassword: description: Overrides the password of Keycloak administrator user. - This is useful to override it ONLY if you use an external Identity - Provider. See the `externalIdentityProvider` field. When omitted - or left blank, it is set to an auto-generated password. + Override this when an external Identity Provider is in use. See + the `externalIdentityProvider` field. When omitted or left blank, + it is set to an auto-generated password. type: string identityProviderPostgresPassword: description: Password for a Identity Provider, Keycloak or RH-SSO, - to connect to the database. This is useful to override it ONLY - if you use an external Identity Provider. See the `externalIdentityProvider` - field. When omitted or left blank, it is set to an auto-generated - password. + to connect to the database. Override this when an external Identity + Provider is in use. See the `externalIdentityProvider` field. + When omitted or left blank, it is set to an auto-generated password. type: string identityProviderPostgresSecret: description: 'The secret that contains `password` for the Identity @@ -145,10 +144,10 @@ spec: type: string identityProviderRealm: description: Name of a Identity provider, Keycloak or RH-SSO, realm - that is used for Che. This is useful to override it ONLY if you - use an external Identity Provider. See the `externalIdentityProvider` - field. When omitted or left blank, it is set to the value of the - `flavour` field. + that is used for Che. Override this when an external Identity + Provider is in use. See the `externalIdentityProvider` field. + When omitted or left blank, it is set to the value of the `flavour` + field. type: string identityProviderRoute: description: Route custom settings. @@ -180,12 +179,13 @@ spec: oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. Auto-generated - if left blank. See also the `OpenShiftoAuth` field. + when left blank. See also the `OpenShiftoAuth` field. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. - Auto-generated if left blank. See also the `OAuthClientName` field. + Auto-generated when left blank. See also the `OAuthClientName` + field. type: string openShiftoAuth: description: 'Enables the integration of the identity provider (Keycloak @@ -239,7 +239,7 @@ spec: type: string chePostgresHostName: description: PostgreSQL Database host name that the Che server uses - to connect to. Defaults to postgres. Override this value ONLY + to connect to. Defaults is `postgres`. Override this value ONLY when using an external database. See field `externalDb`. In the default case it will be automatically set by the Operator. type: string @@ -293,13 +293,14 @@ spec: properties: enable: description: "Install and configure the Community Supported Kubernetes - Image Puller Operator. If true and no spec is provided, it will - create a default KubernetesImagePuller object to be managed by - the Operator. If false, the KubernetesImagePuller object will - be deleted, and the Operator will be uninstalled, regardless of - whether a spec is provided. \n Note that while this the Operator - and its behavior is community-supported, its payload may be commercially-supported - if you use it for pulling commercially-supported images." + Image Puller Operator. When set to `true` and no spec is provided, + it will create a default KubernetesImagePuller object to be managed + by the Operator. When set to `false`, the KubernetesImagePuller + object will be deleted, and the Operator will be uninstalled, + regardless of whether a spec is provided. \n Note that while this + the Operator and its behavior is community-supported, its payload + may be commercially-supported for pulling commercially-supported + images." type: boolean spec: description: A KubernetesImagePullerSpec to configure the image @@ -337,8 +338,8 @@ spec: `kubernetes.io/ingress.class` annotation on Che-related ingresses.' type: string ingressDomain: - description: 'Global ingress domain for a K8S cluster. This MUST - be explicitly specified: there are no defaults.' + description: 'Global ingress domain for a Kubernetes cluster. This + MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: description: 'Strategy for ingress creation. Options are: `multi-host` @@ -363,9 +364,9 @@ spec: configured by this property. The possible values are `native`, which means that the server and workspaces are exposed using ingresses on K8s or `gateway` where the server and workspaces are exposed - using a custom gateway based on Traefik. All the endpoints whether - backed by the ingress or gateway `route` always point to the subpaths - on the same domain. Defaults to `native`. + using a custom gateway based on link:https://doc.traefik.io/traefik/[Traefik]. + All the endpoints whether backed by the ingress or gateway `route` + always point to the subpaths on the same domain. Defaults to `native`. type: string tlsSecretName: description: Name of a secret that will be used to setup ingress @@ -419,9 +420,9 @@ spec: type: string cheFlavor: description: Specifies a variation of the installation. The options - are `che` for upstream Che installations, or `codeready` for CodeReady - Workspaces installation. If not necessary, do not override the - default value. + are `che` for upstream Che installations, or `codeready` for link:https://developers.redhat.com/products/codeready-workspaces/overview[CodeReady + Workspaces] installation. Override the default value only on necessary + occasions. type: string cheHost: description: Public host name of the installed Che server. When @@ -470,17 +471,17 @@ spec: type: object cheWorkspaceClusterRole: description: Custom cluster role bound to the user for the Che workspaces. - The default roles are used if this is omitted or left blank. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string description: Map of additional environment variables that will be - applied in the generated `che` configMap to be used by the Che + applied in the generated `che` ConfigMap to be used by the Che server, in addition to the values already generated from other fields of the `CheCluster` custom resource (CR). When `customCheProperties` contains a property that would be normally generated in `che` - configMap from other CR fields, the value defined in the `customCheProperties` + ConfigMap from other CR fields, the value defined in the `customCheProperties` is used instead. type: object devfileRegistryCpuLimit: @@ -548,7 +549,7 @@ spec: type: boolean gitSelfSignedCert: description: When enabled, the certificate from `che-git-self-signed-cert` - configMap will be propagated to the Che components and provide + ConfigMap will be propagated to the Che components and provide particular configuration for Git. type: boolean nonProxyHosts: @@ -607,9 +608,9 @@ spec: type: object pluginRegistryUrl: description: Public URL of the plugin registry that serves sample - ready-to-use devfiles. Set this ONLY if a use of an external devfile - registry is needed. See the `externalPluginRegistry` field. By - default, this will be automatically calculated by the Operator. + ready-to-use devfiles. Set this ONLY when a use of an external + devfile registry is needed. See the `externalPluginRegistry` field. + By default, this will be automatically calculated by the Operator. type: string proxyPassword: description: Password of the proxy server. Only use when proxy configuration @@ -645,7 +646,7 @@ spec: type: string selfSignedCert: description: Deprecated. The value of this flag is ignored. The - Che Operator will automatically detect if the router certificate + Che Operator will automatically detect whether the router certificate is self-signed and propagate it to other components, such as the Che server. type: boolean @@ -678,7 +679,7 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: Name of the configMap with public certificates to add + description: Name of the ConfigMap with public certificates to add to Java trust store of the Che server. This is often required when adding the OpenShift OAuth provider, which has HTTPS endpoint signed with self-signed cert. The Che server must be aware of @@ -687,7 +688,7 @@ spec: singleHostGatewayConfigMapLabels: additionalProperties: type: string - description: The labels that need to be present in the configMaps + description: The labels that need to be present in the ConfigMaps representing the gateway configuration. type: object singleHostGatewayConfigSidecarImage: @@ -712,11 +713,10 @@ spec: type: boolean workspaceNamespaceDefault: description: Defines Kubernetes default namespace in which user's - workspaces are created if user does not override it. It's possible - to use ``,`` and `` placeholders, - such as che-workspace-. In that case, a new namespace - will be created for each user or workspace. Is used by OpenShift - infrastructure as well to specify Project. + workspaces are created for a case when a user does not override + it. It's possible to use ``, `` and `` + placeholders, such as che-workspace-. In that case, + a new namespace will be created for each user or workspace. type: string type: object storage: @@ -732,7 +732,7 @@ spec: description: Instructs the Che server to start a special Pod to pre-create a sub-path in the Persistent Volumes. Defaults to `false`, however it will need to enable it according to the configuration - of your K8S cluster. + of your Kubernetes cluster. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. diff --git a/deploy/olm-catalog/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml b/deploy/olm-catalog/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml index 233a890123..8e7a2c5d1e 100644 --- a/deploy/olm-catalog/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml +++ b/deploy/olm-catalog/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml @@ -75,13 +75,13 @@ metadata: categories: Developer Tools, OpenShift Optional certified: "false" containerImage: quay.io/eclipse/che-operator:nightly - createdAt: "2021-02-10T17:04:25Z" + createdAt: "2021-02-12T09:38:18Z" description: A Kube-native development solution that delivers portable and collaborative developer workspaces in OpenShift. operatorframework.io/suggested-namespace: eclipse-che repository: https://github.com/eclipse/che-operator support: Eclipse Foundation - name: eclipse-che-preview-openshift.v7.26.0-92.nightly + name: eclipse-che-preview-openshift.v7.27.0-98.nightly namespace: placeholder spec: apiservicedefinitions: {} @@ -733,4 +733,4 @@ spec: maturity: stable provider: name: Eclipse Foundation - version: 7.26.0-92.nightly + version: 7.27.0-98.nightly diff --git a/deploy/olm-catalog/eclipse-che-preview-openshift/manifests/org_v1_che_crd.yaml b/deploy/olm-catalog/eclipse-che-preview-openshift/manifests/org_v1_che_crd.yaml index 622a488f5d..a5a2668f22 100644 --- a/deploy/olm-catalog/eclipse-che-preview-openshift/manifests/org_v1_che_crd.yaml +++ b/deploy/olm-catalog/eclipse-che-preview-openshift/manifests/org_v1_che_crd.yaml @@ -67,10 +67,10 @@ spec: type: string identityProviderClientId: description: Name of a Identity provider, Keycloak or RH-SSO, `client-id` - that is used for Che. This is useful to override it ONLY if you - use an external Identity Provider. See the `externalIdentityProvider` - field. When omitted or left blank, it is set to the value of the - `flavour` field suffixed with `-public`. + that is used for Che. Override this when an external Identity + Provider is in use. See the `externalIdentityProvider` field. + When omitted or left blank, it is set to the value of the `flavour` + field suffixed with `-public`. type: string identityProviderContainerResources: description: Identity provider container custom settings. @@ -122,16 +122,15 @@ spec: type: object identityProviderPassword: description: Overrides the password of Keycloak administrator user. - This is useful to override it ONLY if you use an external Identity - Provider. See the `externalIdentityProvider` field. When omitted - or left blank, it is set to an auto-generated password. + Override this when an external Identity Provider is in use. See + the `externalIdentityProvider` field. When omitted or left blank, + it is set to an auto-generated password. type: string identityProviderPostgresPassword: description: Password for a Identity Provider, Keycloak or RH-SSO, - to connect to the database. This is useful to override it ONLY - if you use an external Identity Provider. See the `externalIdentityProvider` - field. When omitted or left blank, it is set to an auto-generated - password. + to connect to the database. Override this when an external Identity + Provider is in use. See the `externalIdentityProvider` field. + When omitted or left blank, it is set to an auto-generated password. type: string identityProviderPostgresSecret: description: 'The secret that contains `password` for the Identity @@ -146,10 +145,10 @@ spec: type: string identityProviderRealm: description: Name of a Identity provider, Keycloak or RH-SSO, realm - that is used for Che. This is useful to override it ONLY if you - use an external Identity Provider. See the `externalIdentityProvider` - field. When omitted or left blank, it is set to the value of the - `flavour` field. + that is used for Che. Override this when an external Identity + Provider is in use. See the `externalIdentityProvider` field. + When omitted or left blank, it is set to the value of the `flavour` + field. type: string identityProviderRoute: description: Route custom settings. @@ -181,12 +180,13 @@ spec: oAuthClientName: description: Name of the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. Auto-generated - if left blank. See also the `OpenShiftoAuth` field. + when left blank. See also the `OpenShiftoAuth` field. type: string oAuthSecret: description: Name of the secret set in the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. - Auto-generated if left blank. See also the `OAuthClientName` field. + Auto-generated when left blank. See also the `OAuthClientName` + field. type: string openShiftoAuth: description: 'Enables the integration of the identity provider (Keycloak @@ -240,7 +240,7 @@ spec: type: string chePostgresHostName: description: PostgreSQL Database host name that the Che server uses - to connect to. Defaults to postgres. Override this value ONLY + to connect to. Defaults is `postgres`. Override this value ONLY when using an external database. See field `externalDb`. In the default case it will be automatically set by the Operator. type: string @@ -294,13 +294,13 @@ spec: properties: enable: description: "Install and configure the Community Supported Kubernetes\ - \ Image Puller Operator. If true and no spec is provided, it will\ - \ create a default KubernetesImagePuller object to be managed\ - \ by the Operator. If false, the KubernetesImagePuller object\ - \ will be deleted, and the Operator will be uninstalled, regardless\ - \ of whether a spec is provided. \n Note that while this the Operator\ - \ and its behavior is community-supported, its payload may be\ - \ commercially-supported if you use it for pulling commercially-supported\ + \ Image Puller Operator. When set to `true` and no spec is provided,\ + \ it will create a default KubernetesImagePuller object to be\ + \ managed by the Operator. When set to `false`, the KubernetesImagePuller\ + \ object will be deleted, and the Operator will be uninstalled,\ + \ regardless of whether a spec is provided. \n Note that while\ + \ this the Operator and its behavior is community-supported, its\ + \ payload may be commercially-supported for pulling commercially-supported\ \ images." type: boolean spec: @@ -339,8 +339,8 @@ spec: `kubernetes.io/ingress.class` annotation on Che-related ingresses.' type: string ingressDomain: - description: 'Global ingress domain for a K8S cluster. This MUST - be explicitly specified: there are no defaults.' + description: 'Global ingress domain for a Kubernetes cluster. This + MUST be explicitly specified: there are no defaults.' type: string ingressStrategy: description: 'Strategy for ingress creation. Options are: `multi-host` @@ -365,9 +365,9 @@ spec: configured by this property. The possible values are `native`, which means that the server and workspaces are exposed using ingresses on K8s or `gateway` where the server and workspaces are exposed - using a custom gateway based on Traefik. All the endpoints whether - backed by the ingress or gateway `route` always point to the subpaths - on the same domain. Defaults to `native`. + using a custom gateway based on link:https://doc.traefik.io/traefik/[Traefik]. + All the endpoints whether backed by the ingress or gateway `route` + always point to the subpaths on the same domain. Defaults to `native`. type: string tlsSecretName: description: Name of a secret that will be used to setup ingress @@ -421,9 +421,9 @@ spec: type: string cheFlavor: description: Specifies a variation of the installation. The options - are `che` for upstream Che installations, or `codeready` for CodeReady - Workspaces installation. If not necessary, do not override the - default value. + are `che` for upstream Che installations, or `codeready` for link:https://developers.redhat.com/products/codeready-workspaces/overview[CodeReady + Workspaces] installation. Override the default value only on necessary + occasions. type: string cheHost: description: Public host name of the installed Che server. When @@ -472,17 +472,17 @@ spec: type: object cheWorkspaceClusterRole: description: Custom cluster role bound to the user for the Che workspaces. - The default roles are used if this is omitted or left blank. + The default roles are used when omitted or left blank. type: string customCheProperties: additionalProperties: type: string description: Map of additional environment variables that will be - applied in the generated `che` configMap to be used by the Che + applied in the generated `che` ConfigMap to be used by the Che server, in addition to the values already generated from other fields of the `CheCluster` custom resource (CR). When `customCheProperties` contains a property that would be normally generated in `che` - configMap from other CR fields, the value defined in the `customCheProperties` + ConfigMap from other CR fields, the value defined in the `customCheProperties` is used instead. type: object devfileRegistryCpuLimit: @@ -550,7 +550,7 @@ spec: type: boolean gitSelfSignedCert: description: When enabled, the certificate from `che-git-self-signed-cert` - configMap will be propagated to the Che components and provide + ConfigMap will be propagated to the Che components and provide particular configuration for Git. type: boolean nonProxyHosts: @@ -609,9 +609,9 @@ spec: type: object pluginRegistryUrl: description: Public URL of the plugin registry that serves sample - ready-to-use devfiles. Set this ONLY if a use of an external devfile - registry is needed. See the `externalPluginRegistry` field. By - default, this will be automatically calculated by the Operator. + ready-to-use devfiles. Set this ONLY when a use of an external + devfile registry is needed. See the `externalPluginRegistry` field. + By default, this will be automatically calculated by the Operator. type: string proxyPassword: description: Password of the proxy server. Only use when proxy configuration @@ -647,7 +647,7 @@ spec: type: string selfSignedCert: description: Deprecated. The value of this flag is ignored. The - Che Operator will automatically detect if the router certificate + Che Operator will automatically detect whether the router certificate is self-signed and propagate it to other components, such as the Che server. type: boolean @@ -680,7 +680,7 @@ spec: deployment. Defaults to 512Mi. type: string serverTrustStoreConfigMapName: - description: Name of the configMap with public certificates to add + description: Name of the ConfigMap with public certificates to add to Java trust store of the Che server. This is often required when adding the OpenShift OAuth provider, which has HTTPS endpoint signed with self-signed cert. The Che server must be aware of @@ -689,7 +689,7 @@ spec: singleHostGatewayConfigMapLabels: additionalProperties: type: string - description: The labels that need to be present in the configMaps + description: The labels that need to be present in the ConfigMaps representing the gateway configuration. type: object singleHostGatewayConfigSidecarImage: @@ -714,11 +714,10 @@ spec: type: boolean workspaceNamespaceDefault: description: Defines Kubernetes default namespace in which user's - workspaces are created if user does not override it. It's possible - to use ``,`` and `` placeholders, - such as che-workspace-. In that case, a new namespace - will be created for each user or workspace. Is used by OpenShift - infrastructure as well to specify Project. + workspaces are created for a case when a user does not override + it. It's possible to use ``, `` and `` + placeholders, such as che-workspace-. In that case, + a new namespace will be created for each user or workspace. type: string type: object storage: @@ -734,7 +733,7 @@ spec: description: Instructs the Che server to start a special Pod to pre-create a sub-path in the Persistent Volumes. Defaults to `false`, however it will need to enable it according to the configuration - of your K8S cluster. + of your Kubernetes cluster. type: boolean pvcClaimSize: description: Size of the persistent volume claim for workspaces. diff --git a/pkg/apis/org/v1/che_types.go b/pkg/apis/org/v1/che_types.go index 6c908be33c..b698404299 100644 --- a/pkg/apis/org/v1/che_types.go +++ b/pkg/apis/org/v1/che_types.go @@ -82,8 +82,8 @@ type CheClusterSpecServer struct { // Default value is `Always` for `nightly` or `latest` images, and `IfNotPresent` in other cases. // +optional CheImagePullPolicy corev1.PullPolicy `json:"cheImagePullPolicy,omitempty"` - // Specifies a variation of the installation. The options are `che` for upstream Che installations, or `codeready` for CodeReady Workspaces installation. - // If not necessary, do not override the default value. + // Specifies a variation of the installation. The options are `che` for upstream Che installations, or `codeready` for link:https://developers.redhat.com/products/codeready-workspaces/overview[CodeReady Workspaces] installation. + // Override the default value only on necessary occasions. // +optional CheFlavor string `json:"cheFlavor,omitempty"` // Public host name of the installed Che server. When value is omitted, the value it will be automatically set by the Operator. @@ -105,12 +105,12 @@ type CheClusterSpecServer struct { // +optional CheClusterRoles string `json:"cheClusterRoles,omitempty"` // Custom cluster role bound to the user for the Che workspaces. - // The default roles are used if this is omitted or left blank. + // The default roles are used when omitted or left blank. // +optional CheWorkspaceClusterRole string `json:"cheWorkspaceClusterRole,omitempty"` - // Defines Kubernetes default namespace in which user's workspaces are created if user does not override it. - // It's possible to use ``,`` and `` placeholders, such as che-workspace-. - // In that case, a new namespace will be created for each user or workspace. Is used by OpenShift infrastructure as well to specify Project. + // Defines Kubernetes default namespace in which user's workspaces are created for a case when a user does not override it. + // It's possible to use ``, `` and `` placeholders, such as che-workspace-. + // In that case, a new namespace will be created for each user or workspace. // +optional WorkspaceNamespaceDefault string `json:"workspaceNamespaceDefault,omitempty"` // Defines that a user is allowed to specify a Kubernetes namespace, or an OpenShift project, which differs from the default. @@ -118,15 +118,15 @@ type CheClusterSpecServer struct { // +optional AllowUserDefinedWorkspaceNamespaces bool `json:"allowUserDefinedWorkspaceNamespaces"` // Deprecated. The value of this flag is ignored. - // The Che Operator will automatically detect if the router certificate is self-signed and propagate it to other components, such as the Che server. + // The Che Operator will automatically detect whether the router certificate is self-signed and propagate it to other components, such as the Che server. // +optional SelfSignedCert bool `json:"selfSignedCert"` - // Name of the configMap with public certificates to add to Java trust store of the Che server. + // Name of the ConfigMap with public certificates to add to Java trust store of the Che server. // This is often required when adding the OpenShift OAuth provider, which has HTTPS endpoint signed with self-signed cert. // The Che server must be aware of its CA cert to be able to request it. This is disabled by default. // +optional ServerTrustStoreConfigMapName string `json:"serverTrustStoreConfigMapName,omitempty"` - // When enabled, the certificate from `che-git-self-signed-cert` configMap will be propagated to the Che components and provide particular configuration for Git. + // When enabled, the certificate from `che-git-self-signed-cert` ConfigMap will be propagated to the Che components and provide particular configuration for Git. // +optional GitSelfSignedCert bool `json:"gitSelfSignedCert"` // Deprecated. Instructs the Operator to deploy Che in TLS mode. This is enabled by default. Disabling TLS sometimes cause malfunction of some Che components. @@ -178,7 +178,7 @@ type CheClusterSpecServer struct { // +optional ExternalDevfileRegistry bool `json:"externalDevfileRegistry"` // Public URL of the plugin registry that serves sample ready-to-use devfiles. - // Set this ONLY if a use of an external devfile registry is needed. + // Set this ONLY when a use of an external devfile registry is needed. // See the `externalPluginRegistry` field. By default, this will be automatically calculated by the Operator. // +optional PluginRegistryUrl string `json:"pluginRegistryUrl,omitempty"` @@ -215,9 +215,9 @@ type CheClusterSpecServer struct { // will be started by the Operator and you will have to manually set the `pluginRegistryUrl` field. // +optional ExternalPluginRegistry bool `json:"externalPluginRegistry"` - // Map of additional environment variables that will be applied in the generated `che` configMap to be used by the Che server, + // Map of additional environment variables that will be applied in the generated `che` ConfigMap to be used by the Che server, // in addition to the values already generated from other fields of the `CheCluster` custom resource (CR). - // When `customCheProperties` contains a property that would be normally generated in `che` configMap from other CR fields, + // When `customCheProperties` contains a property that would be normally generated in `che` ConfigMap from other CR fields, // the value defined in the `customCheProperties` is used instead. // +optional CustomCheProperties map[string]string `json:"customCheProperties,omitempty"` @@ -226,8 +226,7 @@ type CheClusterSpecServer struct { // Only use when configuring a proxy is required. Operator respects OpenShift cluster wide proxy configuration // and no additional configuration is required, but defining `proxyUrl` in a custom resource leads to overrides the cluster proxy configuration // with fields `proxyUrl`, `proxyPort`, `proxyUser` and `proxyPassword` from the custom resource. - // See the doc https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html). - // See also the `proxyPort` and `nonProxyHosts` fields. + // See the doc https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html). See also the `proxyPort` and `nonProxyHosts` fields. // +optional ProxyURL string `json:"proxyURL,omitempty"` // Port of the proxy server. Only use when configuring a proxy is required. See also the `proxyURL` and `nonProxyHosts` fields. @@ -237,11 +236,9 @@ type CheClusterSpecServer struct { // Specify wild card domain use the following form `.` and `|` as delimiter, for example: `localhost|.my.host.com|123.42.12.32` // Only use when configuring a proxy is required. Operator respects OpenShift cluster wide proxy configuration and no additional configuration is required, // but defining `nonProxyHosts` in a custom resource leads to merging non proxy hosts lists from the cluster proxy configuration and ones defined in the custom resources. - // See the doc https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html). - // See also the `proxyURL` fields. + // See the doc https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html). See also the `proxyURL` fields. NonProxyHosts string `json:"nonProxyHosts,omitempty"` - // User name of the proxy server. Only use when configuring a proxy is required. - // See also the `proxyURL`, `proxyPassword` and `proxySecret` fields. + // User name of the proxy server. Only use when configuring a proxy is required. See also the `proxyURL`, `proxyPassword` and `proxySecret` fields. // +optional ProxyUser string `json:"proxyUser,omitempty"` // Password of the proxy server. @@ -279,7 +276,7 @@ type CheClusterSpecServer struct { // The image used for the gateway sidecar that provides configuration to the gateway. Omit it or leave it empty to use the default container image provided by the Operator. // +optional SingleHostGatewayConfigSidecarImage string `json:"singleHostGatewayConfigSidecarImage,omitempty"` - // The labels that need to be present in the configMaps representing the gateway configuration. + // The labels that need to be present in the ConfigMaps representing the gateway configuration. // +optional SingleHostGatewayConfigMapLabels labels.Set `json:"singleHostGatewayConfigMapLabels,omitempty"` // The Che server ingress custom settings. @@ -299,7 +296,7 @@ type CheClusterSpecDB struct { // +optional ExternalDb bool `json:"externalDb"` // PostgreSQL Database host name that the Che server uses to connect to. - // Defaults to postgres. Override this value ONLY when using an external database. See field `externalDb`. + // Defaults is `postgres`. Override this value ONLY when using an external database. See field `externalDb`. // In the default case it will be automatically set by the Operator. // +optional ChePostgresHostName string `json:"chePostgresHostName,omitempty"` @@ -353,7 +350,7 @@ type CheClusterSpecAuth struct { // +optional IdentityProviderAdminUserName string `json:"identityProviderAdminUserName,omitempty"` // Overrides the password of Keycloak administrator user. - // This is useful to override it ONLY if you use an external Identity Provider. See the `externalIdentityProvider` field. + // Override this when an external Identity Provider is in use. See the `externalIdentityProvider` field. // When omitted or left blank, it is set to an auto-generated password. // +optional IdentityProviderPassword string `json:"identityProviderPassword,omitempty"` @@ -366,17 +363,17 @@ type CheClusterSpecAuth struct { // +optional IdentityProviderSecret string `json:"identityProviderSecret,omitempty"` // Name of a Identity provider, Keycloak or RH-SSO, realm that is used for Che. - // This is useful to override it ONLY if you use an external Identity Provider. See the `externalIdentityProvider` field. + // Override this when an external Identity Provider is in use. See the `externalIdentityProvider` field. // When omitted or left blank, it is set to the value of the `flavour` field. // +optional IdentityProviderRealm string `json:"identityProviderRealm,omitempty"` // Name of a Identity provider, Keycloak or RH-SSO, `client-id` that is used for Che. - // This is useful to override it ONLY if you use an external Identity Provider. See the `externalIdentityProvider` field. + // Override this when an external Identity Provider is in use. See the `externalIdentityProvider` field. // When omitted or left blank, it is set to the value of the `flavour` field suffixed with `-public`. // +optional IdentityProviderClientId string `json:"identityProviderClientId,omitempty"` // Password for a Identity Provider, Keycloak or RH-SSO, to connect to the database. - // This is useful to override it ONLY if you use an external Identity Provider. See the `externalIdentityProvider` field. + // Override this when an external Identity Provider is in use. See the `externalIdentityProvider` field. // When omitted or left blank, it is set to an auto-generated password. // +optional IdentityProviderPostgresPassword string `json:"identityProviderPostgresPassword,omitempty"` @@ -395,10 +392,10 @@ type CheClusterSpecAuth struct { // WARNING: the `kubeadmin` user is NOT supported, and logging through it will NOT allow accessing the Che Dashboard. // +optional OpenShiftoAuth *bool `json:"openShiftoAuth,omitempty"` - // Name of the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. Auto-generated if left blank. See also the `OpenShiftoAuth` field. + // Name of the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. Auto-generated when left blank. See also the `OpenShiftoAuth` field. // +optional OAuthClientName string `json:"oAuthClientName,omitempty"` - // Name of the secret set in the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. Auto-generated if left blank. See also the `OAuthClientName` field. + // Name of the secret set in the OpenShift `OAuthClient` resource used to setup identity federation on the OpenShift side. Auto-generated when left blank. See also the `OAuthClientName` field. // +optional OAuthSecret string `json:"oAuthSecret,omitempty"` // Overrides the container image used in the Identity Provider, Keycloak or RH-SSO, deployment. @@ -465,7 +462,7 @@ type CheClusterSpecStorage struct { // +optional PvcClaimSize string `json:"pvcClaimSize,omitempty"` // Instructs the Che server to start a special Pod to pre-create a sub-path in the Persistent Volumes. - // Defaults to `false`, however it will need to enable it according to the configuration of your K8S cluster. + // Defaults to `false`, however it will need to enable it according to the configuration of your Kubernetes cluster. // +optional PreCreateSubPaths bool `json:"preCreateSubPaths"` // Overrides the container image used to create sub-paths in the Persistent Volumes. @@ -483,7 +480,7 @@ type CheClusterSpecStorage struct { // +k8s:openapi-gen=true // Configuration settings specific to Che installations made on upstream Kubernetes. type CheClusterSpecK8SOnly struct { - // Global ingress domain for a K8S cluster. This MUST be explicitly specified: there are no defaults. + // Global ingress domain for a Kubernetes cluster. This MUST be explicitly specified: there are no defaults. IngressDomain string `json:"ingressDomain,omitempty"` // Strategy for ingress creation. Options are: `multi-host` (host is explicitly provided in ingress), // `single-host` (host is provided, path-based rules) and `default-host` (no host is provided, path-based rules). @@ -507,7 +504,7 @@ type CheClusterSpecK8SOnly struct { SecurityContextRunAsUser string `json:"securityContextRunAsUser,omitempty"` // When the serverExposureStrategy is set to `single-host`, the way the server, registries and workspaces are exposed is further configured by this property. // The possible values are `native`, which means that the server and workspaces are exposed using ingresses on K8s - // or `gateway` where the server and workspaces are exposed using a custom gateway based on Traefik. + // or `gateway` where the server and workspaces are exposed using a custom gateway based on link:https://doc.traefik.io/traefik/[Traefik]. // All the endpoints whether backed by the ingress or gateway `route` always point to the subpaths on the same domain. Defaults to `native`. // +optional SingleHostExposureType string `json:"singleHostExposureType,omitempty"` @@ -523,13 +520,13 @@ type CheClusterSpecMetrics struct { // Configuration settings for installation and configuration of the Kubernetes Image Puller // See https://github.com/che-incubator/kubernetes-image-puller-operator type CheClusterSpecImagePuller struct { - // Install and configure the Community Supported Kubernetes Image Puller Operator. If true and no spec is provided, + // Install and configure the Community Supported Kubernetes Image Puller Operator. When set to `true` and no spec is provided, // it will create a default KubernetesImagePuller object to be managed by the Operator. - // If false, the KubernetesImagePuller object will be deleted, and the Operator will be uninstalled, + // When set to `false`, the KubernetesImagePuller object will be deleted, and the Operator will be uninstalled, // regardless of whether a spec is provided. // // Note that while this the Operator and its behavior is community-supported, its payload may be commercially-supported - // if you use it for pulling commercially-supported images. + // for pulling commercially-supported images. Enable bool `json:"enable"` // A KubernetesImagePullerSpec to configure the image puller in the CheCluster // +optional