Skip to content

Commit

Permalink
Fix typos, improve docs (#671)
Browse files Browse the repository at this point in the history 
* Fix typos, improve docs

Signed-off-by: Anatolii Bazko <abazko@redhat.com>
  • Loading branch information
@tolusha
tolusha committed Feb 12, 2021
1 parent 17cefa8 commit dc8d3ef
Show file tree
Hide file tree
Showing 6 changed files with 181 additions and 185 deletions.
98 changes: 49 additions & 49 deletions deploy/crds/org_v1_che_crd.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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 `<username>`,`<userid>` and `<workspaceid>` placeholders,
such as che-workspace-<username>. 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 `<username>`, `<userid>` and `<workspaceid>`
placeholders, such as che-workspace-<username>. In that case,
a new namespace will be created for each user or workspace.
type: string
type: object
storage:
Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions ...-catalog/eclipse-che-preview-kubernetes/manifests/che-operator.clusterserviceversion.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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: {}
Expand Down Expand Up @@ -676,4 +676,4 @@ spec:
maturity: stable
provider:
name: Eclipse Foundation
version: 7.26.0-92.nightly
version: 7.27.0-98.nightly
Loading

0 comments on commit dc8d3ef

Please sign in to comment.