Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Refresh checluster-properties.adoc and system-variables.adoc #1982

Merged
merged 4 commits into from
May 17, 2021
Merged

fix: Refresh checluster-properties.adoc and system-variables.adoc #1982

merged 4 commits into from
May 17, 2021

Conversation

themr0c
Copy link
Contributor

@themr0c themr0c commented May 11, 2021

Putting the committed source code in sync with what is published.

./tools/checluster_docs_gen.sh 
./tools/environment_docs_gen.sh

Edits in this PR are pretty much irrelevant, at this point we need to fix the upstream instead.

@themr0c themr0c requested review from yhontyk, MichalMaler, rkratky and a team as code owners May 11, 2021 09:47
@themr0c themr0c requested a review from ericwill May 11, 2021 09:47
`+CHE_WORKSPACE_HTTP__PROXY+`,"","Configures proxies used by runtimes powering workspaces."
`+CHE_WORKSPACE_HTTPS__PROXY+`,"","Configuresproxies used by runtimes powering workspaces."
`+CHE_WORKSPACE_NO__PROXY+`,"","Configuresproxiesused by runtimes powering workspaces."
`+CHE_WORKSPACE_HTTP__PROXY+`,"","Configures environment variable HTTP_PROXY to a specified value in containers powering workspaces."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sets HTTP_PROXY environment variable to specified value in containers used for workspaces ?

`+CHE_WORKSPACE_SIDECAR_DEFAULT__CPU__LIMIT__CORES+`,"`+-1+`","CPU limit and request default for each sidecar that has no CPU settings in the {prod-short} plug-in configuration. Specify either in floating point cores number, for example, `0.125`, or using the Kubernetes format, integer millicores, for example, `125m`. Value less or equal to 0 is interpreted as disabling the limit."
`+CHE_WORKSPACE_SIDECAR_DEFAULT__CPU__REQUEST__CORES+`,"`+-1+`","CPUlimit and request default for each sidecar that has no CPU settings in the {prod-short} plug-in configuration. Specify either in floating point cores number, for example, `0.125`, or using the Kubernetes format, integer millicores, for example, `125m`. Value less or equal to 0 is interpreted as disabling the limit."
`+CHE_WORKSPACE_SIDECAR_DEFAULT__MEMORY__LIMIT__MB+`,"`+128+`","RAM limit for each sidecar that has no RAM settings in the {prod-short} plug-in configuration. Value less or equal to 0 is interpreted as disabling the limit."
`+CHE_WORKSPACE_SIDECAR_DEFAULT__MEMORY__REQUEST__MB+`,"`+64+`","RAM request for each sidecar that has no RAM settings in the {prod-short} plug-in configuration."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Default RAM for each sidecar where plug-ins do not set an override value. ?

Comment on lines +35 to 36
`+CHE_WORKSPACE_SIDECAR_DEFAULT__CPU__REQUEST__CORES+`,"`+-1+`","CPU request default for each sidecar that has no CPU settings in the {prod-short} plug-in configuration. Specify either in floating point cores number, for example, `0.125`, or using the Kubernetes format, integer millicores, for example, `125m`."
`+CHE_WORKSPACE_SIDECAR_IMAGE__PULL__POLICY+`,"`+Always+`","Defines image-pulling strategy for sidecars. Possible values are: `Always`, `Never`, `IfNotPresent`. For any other value, `Always` is assumed for images with the `:latest` tag, or `IfNotPresent` for all other cases."
Copy link
Contributor

@nickboldt nickboldt May 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Default number of millicore CPUs for each sidecar where plug-ins do not set an override value, for example,125m. ?

`+CHE_WORKSPACE_SIDECAR_IMAGE__PULL__POLICY+`,"`+Always+`","Defines image-pulling strategy for sidecars. Possible values are: `Always`, `Never`, `IfNotPresent`. For any other value, `Always` is assumed for images with the `:latest` tag, or `IfNotPresent` for all other cases."
`+CHE_WORKSPACE_ACTIVITY__CHECK__SCHEDULER__PERIOD__S+`,"`+60+`","Period of inactive workspaces suspend job execution."
`+CHE_WORKSPACE_ACTIVITY__CLEANUP__SCHEDULER__PERIOD__S+`,"`+3600+`","The period of the cleanup of the activity table. The activity table can contain invalid or stale data if some unforeseen errors happen, like a server crash at a peculiar point in time. The default is to run the cleanup job every hour."
`+CHE_WORKSPACE_ACTIVITY__CLEANUP__SCHEDULER__PERIOD__S+`,"`+3600+`","The period of the cleanup of the activity table. The activity table can contain invalid or stale data if some unforeseen errors happen, as a server failure at a peculiar point in time. The default is to run the cleanup job every hour."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

such as a server failure at a particular point in time. "Peculiar" means something else entirely.

`+CHE_WORKSPACE_CLEANUP__TEMPORARY__INITIAL__DELAY__MIN+`,"`+5+`","Period of stopped temporary workspaces cleanup job execution."
`+CHE_WORKSPACE_CLEANUP__TEMPORARY__PERIOD__MIN+`,"`+180+`","Periodof stopped temporary workspaces cleanup job execution."
`+CHE_WORKSPACE_SERVER_PING__SUCCESS__THRESHOLD+`,"`+1+`","Number of sequential successful pings to server after which it is treated as available. Note: the property is common for all servers e.g. workspace agent, terminal, exec etc."
`+CHE_WORKSPACE_CLEANUP__TEMPORARY__INITIAL__DELAY__MIN+`,"`+5+`","Time period to delay the first execution of temporary workspaces cleanup job."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initial delay before first execution of...

`+CHE_WORKSPACE_CLEANUP__TEMPORARY__PERIOD__MIN+`,"`+180+`","Periodof stopped temporary workspaces cleanup job execution."
`+CHE_WORKSPACE_SERVER_PING__SUCCESS__THRESHOLD+`,"`+1+`","Number of sequential successful pings to server after which it is treated as available. Note: the property is common for all servers e.g. workspace agent, terminal, exec etc."
`+CHE_WORKSPACE_CLEANUP__TEMPORARY__INITIAL__DELAY__MIN+`,"`+5+`","Time period to delay the first execution of temporary workspaces cleanup job."
`+CHE_WORKSPACE_CLEANUP__TEMPORARY__PERIOD__MIN+`,"`+180+`","Time period delay between the termination of one execution and the commencement of the next execution of temporary workspaces cleanup job"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interval between the end of a run and the start of the next run of the temporary workspaces cleanup job

`+CHE_WORKSPACE_SERVER_PING__INTERVAL__MILLISECONDS+`,"`+3000+`","Interval, in milliseconds, between successive pings to workspace server."
`+CHE_WORKSPACE_SERVER_LIVENESS__PROBES+`,"`+wsagent/http,exec-agent/http,terminal,theia,jupyter,dirigible,cloud-shell,intellij+`","List of servers names which require liveness probes"
`+CHE_WORKSPACE_STARTUP__DEBUG__LOG__LIMIT__BYTES+`,"`+10485760+`","Limit size of the logs collected from single container that can be observed by che-server when debugging workspace startup. default 10MB=10485760"
`+CHE_WORKSPACE_STOP_ROLE_ENABLED+`,"`+true+`","If true, 'stop-workspace' role with the edit privileges will be granted to the 'che' ServiceAccount if OpenShift OAuth is enabled. This configuration is mainly required for workspace idling when the OpenShift OAuth is enabled."
`+CHE_DEVWORKSPACES_ENABLED+`,"`+false+`","Specifies whether che is deployed with DevWorkspaces enabled. This property is set by the {prod-short} operator if it also installed the support for DevWorkspaces. This property is used to advertise this fact to the {prod-short} dashboard. It does not make sense to change the value of this property manually."
`+CHE_DEVWORKSPACES_ENABLED+`,"`+false+`","Specifies whether {prod-short} is deployed with DevWorkspaces enabled. This property is set by the {prod-short} Operator if it also installed the support for DevWorkspaces. This property is used to advertise this fact to the {prod-short} dashboard. It does not make sense to change the value of this property manually."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Set by the {prod-short} Operator if support for DevWorkspaces is enabled - only used to identify DevWorkspaces support in the dashboard. There is no reason to override this property manually.

`+DB_SCHEMA_FLYWAY_SCRIPTS_VERSION__SEPARATOR+`,"`+__+`","DBinitializationandmigrationconfiguration"
`+DB_SCHEMA_FLYWAY_SCRIPTS_LOCATIONS+`,"`+classpath:che-schema+`","DBinitializationandmigrationconfiguration"
`+DB_SCHEMA_FLYWAY_BASELINE_ENABLED+`,"`+true+`","DB initialization and migration configuration If true, ignore scripts up to the version configured by baseline.version."
`+DB_SCHEMA_FLYWAY_BASELINE_VERSION+`,"`+5.0.0.8.1+`","Scripts with version up to this are ignored. Note that scripts with version equal to baseline version are also ignored."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Scripts with version up to and including this version are ignored.

`+DB_SCHEMA_FLYWAY_SCRIPTS_SUFFIX+`,"`+.sql+`","DBinitializationandmigration configuration"
`+DB_SCHEMA_FLYWAY_SCRIPTS_VERSION__SEPARATOR+`,"`+__+`","DBinitializationandmigrationconfiguration"
`+DB_SCHEMA_FLYWAY_SCRIPTS_LOCATIONS+`,"`+classpath:che-schema+`","DBinitializationandmigrationconfiguration"
`+DB_SCHEMA_FLYWAY_BASELINE_ENABLED+`,"`+true+`","DB initialization and migration configuration If true, ignore scripts up to the version configured by baseline.version."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If true, ignore scripts up to and including the value of DB_SCHEMA_FLYWAY_BASELINE_VERSION

`+CHE_INFRA_KUBERNETES_MASTER__URL+`,"","Configuration of Kubernetes client master URL that Infra will use."
`+CHE_INFRA_KUBERNETES_TRUST__CERTS+`,"`+false+`","Boolean to configure Kubernetes client to use trusted certificates."
`+CHE_INFRA_KUBERNETES_SERVER__STRATEGY+`,"`+multi-host+`","Defines the way how servers are exposed to the world in Kubernetes infra. List of strategies implemented in {prod-short}: `default-host`, `multi-host`, `single-host`."
`+CHE_INFRA_KUBERNETES_SINGLEHOST_WORKSPACE_EXPOSURE+`,"`+native+`","Defines the way in which the workspace plugins and editors are exposed in the single-host mode. Supported exposures: `native`:: Exposes servers using Kubernetes Ingresses. Works only on Kubernetes. `gateway`:: Exposes servers using reverse-proxy gateway."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aren't we extracting "Kubernetes" as a {something-variable} in all occurrences now?

`+CHE_INFRA_KUBERNETES_NAMESPACE_LABELS+`,"`+app.kubernetes.io/part-of=che.eclipse.org,app.kubernetes.io/component=workspaces-namespace+`","List of labels to find {orch-namespace} that are used for {prod-short} Workspaces. They are used to: - find prepared {orch-namespace} for users in combination with `che.infra.kubernetes.namespace.annotations`. - actively label {orch-namespace} with any workspace."
`+CHE_INFRA_KUBERNETES_NAMESPACE_ANNOTATIONS+`,"`+che.eclipse.org/username=<username>+`","List of annotations to find {orch-namespace} prepared for {prod-short} users workspaces. Only {orch-namespace} matching the `che.infra.kubernetes.namespace.labels` will be matched against these annotations. {orch-namespace} that matches both `che.infra.kubernetes.namespace.labels` and `che.infra.kubernetes.namespace.annotations` will be preferentially used for User's workspaces. It's possible to use `<username>` placeholder to specify the {orch-namespace} to concrete user."
`+CHE_INFRA_KUBERNETES_NAMESPACE_ALLOW__USER__DEFINED+`,"`+false+`","Defines if a user is able to specify {orch-namespace} different from the default. It's NOT RECOMMENDED to configured true without OAuth configured. This property is also used by the OpenShift infra."
`+CHE_INFRA_KUBERNETES_SERVICE__ACCOUNT__NAME+`,"`+NULL+`","Defines Kubernetes Service Account name which should be specified to be bound to all workspaces Pods. the {prod-short} Operator that Kubernetes Infrastructure will not create the service account and it should exist. OpenShift infrastructure will check if project is predefined(if `che.infra.openshift.project` is not empty): - if it is predefined then service account must exist there - if it is 'NULL' or empty string then infrastructure will create new OpenShift project per workspace and prepare workspace service account with needed roles there"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: "the {prod-short} Operator..." should be "The {prod-short} Operator..." (start of a sentence)

`+CHE_INFRA_KUBERNETES_WORKSPACE__UNRECOVERABLE__EVENTS+`,"`+FailedMount,FailedScheduling,MountVolume.SetUpfailed,Failed to pull image,FailedCreate,ReplicaSetCreateError+`","If during workspace startup an unrecoverable event defined in the property occurs, stop the workspace immediately rather than waiting until timeout. the {prod-short} Operator that this SHOULD NOT include a mere 'Failed' reason, because that might catch events that are not unrecoverable. A failed container startup is handled explicitly by {prod-short} server."
`+CHE_INFRA_KUBERNETES_PVC_ENABLED+`,"`+true+`","Defines whether use the Persistent Volume Claim for {prod-short} workspace needs, for example: backup projects, logs, or disable it."
`+CHE_INFRA_KUBERNETES_PVC_STRATEGY+`,"`+common+`","Defined which strategy will be used while choosing PVC for workspaces. Supported strategies: `common`:: All workspaces in the same {orch-namespace} will reuse the same PVC. Name of PVC may be configured with `che.infra.kubernetes.pvc.name`. Existing PVC will be used or a new one will be created if it does not exist. `unique`:: Separate PVC for each workspace's volume will be used. Name of PVC is evaluated as `'{che.infra.kubernetes.pvc.name} + '-' + {generated_8_chars}'`. Existing PVC will be used or a new one will be created if it does not exist. `per-workspace`:: Separate PVC for each workspace will be used. Name of PVC is evaluated as `'{che.infra.kubernetes.pvc.name} + '-' + {WORKSPACE_ID}'`. Existing PVC will be used or a new one will be created if it doesn't exist."
`+CHE_INFRA_KUBERNETES_PVC_PRECREATE__SUBPATHS+`,"`+true+`","Defines whether to run a job that creates workspace's subpath directories in persistent volume for the `common` strategy before launching a workspace. Necessary in some versions of {orch-name} as workspace subpath volume mounts are created with root permissions, and therefore cannot be modified by workspaces running as a user (presents an error importing projects into a workspace in {prod-short}). The default is `true`, but should be set to `false` if the version of {orch-name} creates subdirectories with user permissions. Relevant issue: \https://github.com/kubernetes/kubernetes/issues/41638 the {prod-short} Operator that this property has effect only if the `common` PVC strategy used."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Relevant issue: \kubernetes/kubernetes#41638 the {prod-short} Operator"

should that \ before the URL be there? also if that's a new sentence, should "The" be capitalized?

`+CHE_INFRA_KUBERNETES_PVC_ENABLED+`,"`+true+`","Defines whether use the Persistent Volume Claim for {prod-short} workspace needs, for example: backup projects, logs, or disable it."
`+CHE_INFRA_KUBERNETES_PVC_STRATEGY+`,"`+common+`","Defined which strategy will be used while choosing PVC for workspaces. Supported strategies: `common`:: All workspaces in the same {orch-namespace} will reuse the same PVC. Name of PVC may be configured with `che.infra.kubernetes.pvc.name`. Existing PVC will be used or a new one will be created if it does not exist. `unique`:: Separate PVC for each workspace's volume will be used. Name of PVC is evaluated as `'{che.infra.kubernetes.pvc.name} + '-' + {generated_8_chars}'`. Existing PVC will be used or a new one will be created if it does not exist. `per-workspace`:: Separate PVC for each workspace will be used. Name of PVC is evaluated as `'{che.infra.kubernetes.pvc.name} + '-' + {WORKSPACE_ID}'`. Existing PVC will be used or a new one will be created if it doesn't exist."
`+CHE_INFRA_KUBERNETES_PVC_PRECREATE__SUBPATHS+`,"`+true+`","Defines whether to run a job that creates workspace's subpath directories in persistent volume for the `common` strategy before launching a workspace. Necessary in some versions of {orch-name} as workspace subpath volume mounts are created with root permissions, and therefore cannot be modified by workspaces running as a user (presents an error importing projects into a workspace in {prod-short}). The default is `true`, but should be set to `false` if the version of {orch-name} creates subdirectories with user permissions. Relevant issue: \https://github.com/kubernetes/kubernetes/issues/41638 the {prod-short} Operator that this property has effect only if the `common` PVC strategy used."
`+CHE_INFRA_KUBERNETES_PVC_NAME+`,"`+claim-che-workspace+`","Defines the settings of PVC name for {prod-short} workspaces. Each PVC strategy supplies this value differently. See documentation for `che.infra.kubernetes.pvc.strategy` property"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we LINK to the doc instead of leaving the googling for it as an exercise for the reader?

`+CHE_INFRA_KUBERNETES_PVC_QUANTITY+`,"`+10Gi+`","Defines the size of Persistent Volume Claim of che workspace. Format described here: \https://docs.openshift.com/container-platform/4.4/storage/understanding-persistent-storage.html"
`+CHE_INFRA_KUBERNETES_PVC_JOBS_IMAGE+`,"`+centos:centos7+`","Pod that is launched when performing persistent volume claim maintenance jobs on OpenShift"
`+CHE_INFRA_KUBERNETES_PVC_QUANTITY+`,"`+10Gi+`","Defines the size of Persistent Volume Claim of {prod-short} workspace. Format described here: \https://docs.openshift.com/container-platform/4.4/storage/understanding-persistent-storage.html"
`+CHE_INFRA_KUBERNETES_PVC_JOBS_IMAGE+`,"`+registry.access.redhat.com/ubi8-minimal:8.3-230+`","Pod that is launched when performing persistent volume claim maintenance jobs on OpenShift"
Copy link
Contributor

@nickboldt nickboldt May 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note that this value will change periodically as new versions are released (8.4 is out soon!) ... perhaps just using registry.access.redhat.com/ubi8-minimal as a pointer to the latest one is better?

`+CHE_INFRA_KUBERNETES_TRUSTED__CA_DEST__CONFIGMAP+`,"`+ca-certs+`",""
`+CHE_INFRA_KUBERNETES_TRUSTED__CA_MOUNT__PATH+`,"`+/public-certs+`","Configures path on workspace containers where the CA bundle should be mount. Content of config map specified by che.infra.kubernetes.trusted_ca.dest_configmap is mounted."
`+CHE_INFRA_KUBERNETES_TRUSTED__CA_DEST__CONFIGMAP__LABELS+`,"","Comma separated list of labels to add to the CA certificates config map in user workspace. See che.infra.kubernetes.trusted_ca.dest_configmap property."
`+CHE_INFRA_KUBERNETES_POD_SECURITY__CONTEXT_RUN__AS__USER+`,"`+NULL+`","Defines security context for Pods that will be created by Kubernetes Infra This is ignored by OpenShift infra"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing a period in "Kubernetes Infra This is ignored by OpenShift infra"

Also I see you have "Kubernetes Infra" (uppercase I) and "OpenShift infra" (lowercase i). Might be worth a global f&r on those to make them all consistently cased.

`+CHE_INFRA_KUBERNETES_TRUSTED__CA_DEST__CONFIGMAP__LABELS+`,"","Comma separated list of labels to add to the CA certificates config map in user workspace. See che.infra.kubernetes.trusted_ca.dest_configmap property."
`+CHE_INFRA_KUBERNETES_POD_SECURITY__CONTEXT_RUN__AS__USER+`,"`+NULL+`","Defines security context for Pods that will be created by Kubernetes Infra This is ignored by OpenShift infra"
`+CHE_INFRA_KUBERNETES_POD_SECURITY__CONTEXT_FS__GROUP+`,"`+NULL+`","Defines security context for Pods that will be created by Kubernetes Infra. A special supplemental group that applies to all containers in a Pod. This is ignored by OpenShift infra."
`+CHE_INFRA_KUBERNETES_POD_TERMINATION__GRACE__PERIOD__SEC+`,"`+0+`","Defines grace termination period for Pods that will be created by {orch-name} infrastructures. Default value: `0`. It allows to stop Pods quickly and significantly decrease the time required for stopping a workspace. the {prod-short} Operator: if `terminationGracePeriodSeconds` have been explicitly set in {orch-name} recipe it will not be overridden."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another sentence starting with lower case "t". Suggest a global find and replace for ". the {prod-short}"

@@ -155,10 +153,10 @@ pass:[<!-- vale off -->]
,===
Environment Variable Name,Default value, Description

`+CHE_INFRA_OPENSHIFT_PROJECT+`,"","DEPRECATED - please do not change the value of this property otherwise the existing workspaces will loose data. Do not set it on new installations. Defines OpenShift namespace in which all workspaces will be created. If not set, every workspace will be created in a new project, where project name = workspace id It's possible to use <username> and <userid> placeholders (e.g.: che-workspace-<username>). In that case, new project will be created for each user. OpenShift oauth or service account with permission to create new projects must be used. If the project pointed to by this property exists, it will be used for all workspaces. If it does not exist, the namespace specified by the che.infra.kubernetes.namespace.default will be created and used."
`+CHE_INFRA_OPENSHIFT_TRUSTED__CA_DEST__CONFIGMAP__LABELS+`,"`+config.openshift.io/inject-trusted-cabundle=true+`","Comma separated list of labels to add to the CA certificates config map in user workspace. See che.infra.kubernetes.trusted_ca.dest_configmap property. This default value is used for automatic cluster CA bundle injection in Openshift 4."
`+CHE_INFRA_OPENSHIFT_PROJECT+`,"","DEPRECATED - Do not change the value of this property otherwise the existing workspaces will loose data. Do not set it on new installations. Defines OpenShift namespace in which all workspaces will be created. If not set, every workspace will be created in a new project, where project name = workspace id It's possible to use `<username>` and `<userid>` placeholders (for example: `che-workspace-<username>`). In that case, new project will be created for each user. OpenShift OAuth or service account with permission to create new projects must be used. If the project pointed to by this property exists, it will be used for all workspaces. If it does not exist, the namespace specified by the `che.infra.kubernetes.namespace.default` will be created and used. This parameter is subject to removal in future releases. Legacy workspaces located in this namespace may become unreachable in future releases. See the documentation for possible next steps."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we link to the doc referenced here? or to a GH issue / JIRA about deprecation / removal?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also "loose data" -> should be "lose data".

Loose ... opposite of tight
Lose ... verb meaning to misplace

`+CHE_WORKSPACE_PLUGIN__BROKER_DEFAULT__MERGE__PLUGINS+`,"`+false+`","Configures the default behavior of the plugin brokers when provisioning plugins into a workspace. If set to true, the plugin brokers will attempt to merge plugins when possible (i.e. they run in the same sidecar image and do not have conflicting settings). This value is the default setting used when the devfile does not specify otherwise, via the 'mergePlugins' attribute."
`+CHE_WORKSPACE_PLUGIN__BROKER_PULL__POLICY+`,"`+Always+`","Docker image of {prod-short} plugin broker app that resolves workspace tooling configuration and copies plugins dependencies to a workspace"
`+CHE_WORKSPACE_PLUGIN__BROKER_METADATA_IMAGE+`,"`+quay.io/eclipse/che-plugin-metadata-broker:v3.4.0+`","Docker image of {prod-short} plugin broker app that resolves workspace tools configuration and copies plugins dependencies to a workspace. The {prod-short} Operator overrides these images by default. Changing the images here will not have an effect if {prod-short} is installed using the Operator."
`+CHE_WORKSPACE_PLUGIN__BROKER_ARTIFACTS_IMAGE+`,"`+quay.io/eclipse/che-plugin-artifacts-broker:v3.4.0+`","Docker image of {prod-short} plugin artifacts broker. This broker runs as an init container on the workspace Pod. Its job is to take in a list of plugin identifiers (either references to a plugin in the registry or a link to a plugin meta.yaml) and ensure that the correct .vsix and .theia extensions are downloaded into the /plugins directory, for each plugin requested for the workspace."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if this is upstream doc only, great. If this is downstreamed, then the CHE_WORKSPACE_PLUGIN__BROKER_ARTIFACTS_IMAGE has a different value in CRW.

Latest CRW pluginbroker images are https://catalog.redhat.com/software/containers/search?q=pluginbroker&p=1

`+CHE_SERVER_SECURE__EXPOSER_JWTPROXY_TOKEN_ISSUER+`,"`+wsmaster+`","`Jwtproxy` issuer string, token lifetime, and optional auth page path to route unsigned requests to."
`+CHE_SERVER_SECURE__EXPOSER_JWTPROXY_TOKEN_TTL+`,"`+8800h+`","JWTProxy issuer token lifetime."
`+CHE_SERVER_SECURE__EXPOSER_JWTPROXY_AUTH_LOADER_PATH+`,"`+/_app/loader.html+`","Optional authentication page path to route unsigned requests to."
`+CHE_SERVER_SECURE__EXPOSER_JWTPROXY_IMAGE+`,"`+quay.io/eclipse/che-jwtproxy:0.10.0+`","JWTProxy image."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

f this is upstream doc only, great. If this is downstreamed, then the CHE_SERVER_SECURE__EXPOSER_JWTPROXY_IMAGE has a different value in CRW.

Latest CRW jwtproxy image is https://catalog.redhat.com/software/containers/codeready-workspaces/jwtproxy-rhel8/5da62cd1d70cc5164489e7a9

customCheProperties: Map of additional environment variables that will be applied in the generated `che` ConfigMap to be used by the {prod-short} server, in addition to the values already generated from other fields of the `CheCluster` custom resource (CR). When `customCheProperties` contains a property that would be normally generated in `che` ConfigMap from other CR fields, the value defined in the `customCheProperties` is used instead.
:===
Property: Description
airGapContainerRegistryHostname: Optional host name, or URL, to an alternate container registry to pull images from. This value overrides the container registry host name defined in all the default container images involved in a Che deployment. This is particularly useful to install Che in a restricted environment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't these "Che" occurrences be {prod-short} ?

useInternalClusterSVCNames: Use internal cluster SVC names to communicate between components to speed up the traffic and avoid proxy issues. The default value is `true`.
workspaceNamespaceDefault: Defines default {platforms-namespace} in which user's workspaces are created for a case when a user does not override it. It's possible to use `<username>`, `<userid>` and `<workspaceid>` placeholders, such as `che-workspace-<username>`. In that case, a new {platforms-namespace} will be created for each user or workspace.
:===
workspaceNamespaceDefault: Defines Kubernetes default namespace in which user's workspaces are created for a case when a user does not override it. It's possible to use `<username>`, `<userid>` and `<workspaceid>` placeholders, such as che-workspace-<username>. In that case, a new namespace will be created for each user or workspace.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as you changed it above, this could be EITHER a Kubernetes namespace or an OpenShift project.

identityProviderAdminUserName: Overrides the name of the Identity Provider administrator user. Defaults to `admin`.
identityProviderClientId: Name of a Identity provider, Keycloak or RH-SSO, `client-id` that is used for Che. Override this when an external Identity Provider is in use. See the `externalIdentityProvider` field. When omitted or left blank, it is set to the value of the `flavour` field suffixed with `-public`.
identityProviderContainerResources: Identity provider container custom settings.
identityProviderImage: Overrides the container image used in the Identity Provider, Keycloak or RH-SSO, deployment. This includes the image tag. Omit it or leave it empty to use the default container image provided by the Operator.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this Identity Provider, Keycloak or RH-SSO, when 4 lines earlier you have Identity Provider (Keycloak or RH SSO instance) ?

themr0c and others added 3 commits May 17, 2021 13:13
* Removed mentions of namespace strategies other than per-user

* fixup! Removed mentions of namespace strategies other than per-user

Signed-off-by: Sergii Kabashniuk <[email protected]>

* fixup! Merge remote-tracking branch 'origin/che19536' into che19536

Signed-off-by: Sergii Kabashniuk <[email protected]>

Co-authored-by: Fabrice Flore-Thébault <[email protected]>
@themr0c
Copy link
Contributor Author

themr0c commented May 17, 2021

Additionally:

  • Fix the version in antora-playbook.yml (should be strings, not decimal).
  • Fix missing attributes errors.

@themr0c
Copy link
Contributor Author

themr0c commented May 17, 2021

@themr0c themr0c merged commit fd7a699 into eclipse-che:master May 17, 2021
@themr0c themr0c deleted the update-genrated-docs branch May 17, 2021 11:50
@themr0c themr0c changed the title Refresh checluster-properties.adoc and system-variables.adoc chore: Refresh checluster-properties.adoc and system-variables.adoc Jun 3, 2021
@themr0c themr0c added this to the 7.30.x milestone Jun 3, 2021
themr0c added a commit that referenced this pull request Jun 3, 2021
* Outcome of ./tools/checluster_docs_gen.sh ; ./tools/environment_docs_gen.sh

* Fix attribute in id

* Removed mentions of namespace strategies other than per-user (#1983)

* Removed mentions of namespace strategies other than per-user

* fixup! Removed mentions of namespace strategies other than per-user

Signed-off-by: Sergii Kabashniuk <[email protected]>

* fixup! Merge remote-tracking branch 'origin/che19536' into che19536

Signed-off-by: Sergii Kabashniuk <[email protected]>

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Ignore vale on checluster-properties.adoc

Co-authored-by: Sergii Kabashniuk <[email protected]>
@themr0c themr0c changed the title chore: Refresh checluster-properties.adoc and system-variables.adoc fix: Refresh checluster-properties.adoc and system-variables.adoc Jun 3, 2021
zeibura added a commit to zeibura/che-docs that referenced this pull request Jan 5, 2022
* Increasing the usage time limit to 30 days (#1916)

* Configure labels and domains to work with router sharding (#1887)

* Configure labels and domains to work with router sharding

Signed-off-by: Anatolii Bazko <[email protected]>

* Add missing files

Signed-off-by: Anatolii Bazko <[email protected]>

* improvements

Signed-off-by: Anatolii Bazko <[email protected]>

* Fix

Signed-off-by: Anatolii Bazko <[email protected]>

Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>

* feat(java-lombok): Add documentation how to enable Lombok in Java workspaces (#1912)

* feat(java-lombok): Add documentation how to enable Lombok in Java workspaces

Signed-off-by: sutan <[email protected]>

* fixup: vale errors

Signed-off-by: sutan <[email protected]>

* Update modules/extensions/partials/proc_java-lombok.adoc

Co-authored-by: Eric Williams <[email protected]>

* Update modules/extensions/partials/proc_java-lombok.adoc

Co-authored-by: Eric Williams <[email protected]>

* Update modules/extensions/partials/proc_java-lombok.adoc

Co-authored-by: Eric Williams <[email protected]>

* Update modules/extensions/partials/proc_java-lombok.adoc

Co-authored-by: Eric Williams <[email protected]>

* removing lombok project description

Signed-off-by: sutan <[email protected]>

* fix source type

Signed-off-by: sutan <[email protected]>

* Create proc_java-lombok.adoc

* Update proc_java-lombok.adoc

* Update proc_java-lombok.adoc

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Eric Williams <[email protected]>

* Update the step. (#1913)

Co-authored-by: Michal Maléř <[email protected]>

* fix (#1918)

Signed-off-by: Michal Maléř <[email protected]>

* move implementation details from admin guide closer to code (#1909)

* remove implementation details from admin guide

Signed-off-by: xbaran4 <[email protected]>

* removed includes

Signed-off-by: xbaran4 <[email protected]>

* trigger gh action

Signed-off-by: xbaran4 <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* Fix id containing a dot (#1919)

* Followup on rename of making-a-workspace-portable-using-a-devfile into configuring-a-workspace-using-a-devfile (#1920)

* Update vale rules. (#1914)

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Fix - use attribute in id (#1921)

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Yana Hontyk <[email protected]>

* [release] Bump to 7.27.1 in master (#1911)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Nick Boldt <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* RHDEVDOCS-2510 Updating the che.openshift.io links to workspaces.openshift.com (#1866)

* Removing Hosted Che EOL warning

Signed-off-by: Ilya Buziuk <[email protected]>

* Updating the che.openshift.io referenes to workspaces.openshift.com

Signed-off-by: Ilya Buziuk <[email protected]>

* Update modules/end-user-guide/partials/proc_allowing-users-to-define-workspace-deployment-labels-and-annotations.adoc

* Update modules/end-user-guide/partials/proc_allowing-users-to-define-workspace-deployment-labels-and-annotations.adoc

* Update modules/end-user-guide/partials/proc_creating-a-workspace-from-with-a-publicly-accessible-standalone-devfile-using-http.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update CONTRIBUTING.adoc

* Update modules/end-user-guide/partials/proc_allowing-users-to-define-workspace-deployment-labels-and-annotations.adoc

* Update modules/end-user-guide/partials/proc_allowing-users-to-define-workspace-deployment-labels-and-annotations.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_allowing-users-to-define-workspace-deployment-labels-and-annotations.adoc

* Update modules/end-user-guide/partials/proc_allowing-users-to-define-workspace-deployment-labels-and-annotations.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

* Update modules/end-user-guide/partials/proc_using-a-badge-to-link-to-workspaces.adoc

* Update modules/end-user-guide/partials/proc_using-a-badge-to-link-to-workspaces.adoc

* Apply suggestions from code review

f?url=

Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Yana Hontyk <[email protected]>

* Add a note about full CA chain requirement for Che (#1922)

Add a note about full CA chain requirement for Che

Signed-off-by: Mykola Morhun <[email protected]>

* A new procedure + fixes (#1923)

* A new procedure + fixes

Signed-off-by: Michal Maléř <[email protected]>

* tuning

Signed-off-by: Michal Maléř <[email protected]>

* Igor's feedback

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Use htmltest instead of linkchecker (#1926)

* Add htmltest in container

* htmltest configuration

* Fix empty hash error

* Linkchecker configuration

* use htmlcheck in tools

* Use htmltest in GH Action

* Ignore .ash_history

* Use htmlcheck in devfile

* Remove linkchecker scripts, rename podman scripts into runner scripts

* Fix GitHub error: The workflow is not valid. The workflow must contain at least one job with no dependencies.

* Add symlinks for old scripts

* Fix a link

* This links should not be active

* typo

* Fix Error: EACCES: permission denied, lstat '/projects/build'

* GitHub Workflows reorganization. (#1927)

* Use build artifact for link checker

* Looking at the behaviour of GitHub Actions, what takes the most time is to wait for a runner for a workflow.

Once the workflow has a runner, we spend less time waiting for executors for each job.

As a consequence, it makes sense to limit the number of *workflows* as much as possible, and to use the *jobs* for a proper reporting in GitHub.

This commit is an attempt to have one workflow for PR, and one workflow for push.

It implies some duplication of code but I guess this is the price to pay for less wait time.

* Minimize the number of workflows AND jobs

* Remove che.yml workflow which is not functional

* Fixes

* Fixes

* Fix job name

* Fix htmltest errors (#1929)

* One job on push. Count vale errors. (#1930)

* fix broken-ID (#1931)

* broken-ID

Signed-off-by: Michal Maléř <[email protected]>

* fix

Signed-off-by: Michal Maléř <[email protected]>

* fix

Signed-off-by: Michal Maléř <[email protected]>

* fix

Signed-off-by: Michal Maléř <[email protected]>

* Refactor devfile reference. (#1863)

* Refactor devfile reference.

* Vale error fixes.

* review

Signed-off-by: Michal Maléř <[email protected]>

* Update ref_devfile-reference.adoc

Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>

* Added documentation section about using private container registries (#1925)

* added documenting procedure

Signed-off-by: Pavol Baran <[email protected]>

* fixing vale errors

Signed-off-by: Pavol Baran <[email protected]>

* additional resources added

Signed-off-by: Pavol Baran <[email protected]>

* Apply suggestions from code review

YHontyk's feedback

Co-authored-by: Yana Hontyk <[email protected]>

* changed the section location

Signed-off-by: Pavol Baran <[email protected]>

* vale/attribute-fix

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Yana Hontyk <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>

* Fix TOC overflow (#1932)

* Fix TOC overflow

* Fix preview

* Fix preview take 2

* Fix preview take 3

* Update .github/workflows/publish-netlify.yml

* Update .github/workflows/publish-netlify.yml

Co-authored-by: Michal Maléř <[email protected]>

* disableConcurrentBuilds as followup of https://bugs.eclipse.org/bugs/show_bug.cgi?id=572415 (#1933)

* Fix language errors in assembly_introduction-to-eclipse-che.adoc. 676 to 662 errors in complete codebase (#1934)

* Add Gitlab authentication procedure using personal tokens (#1924)

* Add Gitlab authentication procedure using personal tokens

* Missing files

* Fixups

* Rename doc

* review-part-1

Signed-off-by: Michal Maléř <[email protected]>

* review

Signed-off-by: Michal Maléř <[email protected]>

* Fixup filename and remove old

* Fixup file

* Add renamed file

* Fixup

* vale

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* Fix language in end-user-guide (#1938)

* Fix a typo

* Fix vale errors. Refresh description from https://docs.openshift.com/container-platform/4.7/web_console/odc-about-developer-perspective.html

* Fix language

* Fix language

* Fix language and modularity

* Fix language

* Vale config changes

* Vale config changes

* Fix language on modules/end-user-guide/partials/assembly_che-theia-remote-plugin-image.adoc

* Fix language on modules/end-user-guide/partials/assembly_what-is-a-che-theia-plug-in.adoc

* Fix language on modules/end-user-guide/partials/proc_creating-a-workspace-from-the-default-branch-of-a-git-repository.adoc

* Fix language on modules/end-user-guide/partials/proc_defining-a-launch-remote-plug-in-endpoint-using-dockerfile.adoc

* Fix language on modules/end-user-guide/partials/proc_downloading-different-versions-of-gradle.adoc

* Fix language on modules/end-user-guide/partials/proc_finding-the-gopath.adoc

* Fix language on modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc

* Fix language on modules/end-user-guide/partials/proc_logging-the-intelephense-client-server-communication.adoc

* Fix language on modules/end-user-guide/partials/proc_running-and-debugging.adoc

* Fix language on modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.adoc

* Fix language on modules/end-user-guide/partials/proc_viewing-logs-for-php-debug.adoc

* Fix vale errors in modules/end-user-guide/examples/snip_bitbucket-personal-access-token-secret.adoc

* Fix language on modules/end-user-guide/examples/che-adding-a-git-project-into-a-workspace-using-a-devfile.adoc

* Fix language on modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-an-variable.adoc

* Fix language on modules/end-user-guide/examples/che-ref_git-credential-file-as-kubernetes-secret-into-the-file.adoc

* Accept Webview

* Fix language on modules/end-user-guide/partials/assembly_differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode.adoc

* Fix language on modules/end-user-guide/partials/proc_defining-maven-settings-xml-file-across-workspaces.adoc

* Fix language on modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-a-file.adoc

* Fix language on modules/end-user-guide/partials/proc_defining-a-launch-remote-plug-in-endpoint-in-a-meta-yaml-file.adoc

* Accept Omnisharp

* Fix language on modules/end-user-guide/partials/con_che-theia-plug-in-lifecycle.adoc

* Fix language on modules/end-user-guide/partials/con_che-theia-task-types.adoc

* Fix language on modules/end-user-guide/partials/proc_configuring-go-to-use-a-non-standard-registry.adoc

* Use 'OmniSharp'

* Fix language on modules/end-user-guide/partials/proc_accessing-workspaces-remotely-using-kubectl.adoc

* Fix language on modules/end-user-guide/partials/proc_detecting-memory-problems.adoc

* Fix language on modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc

* Fix language on modules/end-user-guide/partials/proc_editing-a-task-and-a-launch-configuration.adoc

* Fix language on modules/end-user-guide/partials/proc_provisioning-jetbrains-activation-code-for-offline-use.adoc

* Decreasing the severity of the IBM.Annotations rule, as [NOTE] is a legit admonition statement in AsciiDoc

* Fix language on modules/end-user-guide/partials/proc_accessing-che-from-red-hat-applications-menu.adoc

* More vale config

* Fix language on modules/end-user-guide/partials/assembly_differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode.adoc

* Fix language on modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc

* Fix language on modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html

* deleted:    modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html

* More vale config again

* Fix language on modules/end-user-guide/partials/proc_managing-git-configuration-identity.adoc

* Fix language on modules/end-user-guide/examples/che-ref_annotations-description.adoc

* Fix language on modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-an-variable.adoc

* Fix vale rules in administration guide (#1941)

* Fix vale errors. Refresh description from https://docs.openshift.com/container-platform/4.7/web_console/odc-about-developer-perspective.html

* Fix language

* Vale config changes

* Vale config changes

* Fix language on modules/end-user-guide/partials/proc_importing-certificates-to-browsers.adoc

* Accept Webview

* Accept Omnisharp

* Use 'OmniSharp'

* Fix language on modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc

* Decreasing the severity of the IBM.Annotations rule, as [NOTE] is a legit admonition statement in AsciiDoc

* More vale config

* Fix language on modules/end-user-guide/partials/proc_viewing-netcoredebugoutput-plug-in-logs-in-the-output-panel.adoc

* Fix language on modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html

* deleted:    modules/end-user-guide/partials/proc_verifying-the-state-of-the-yaml-language-server.html

* More vale config again

* Vale config

* Rename example to fix vale errors

* Fix language on modules/administration-guide/examples/prometheus-config.adoc

* Fix language on modules/administration-guide/examples/snip_che-cloning-image-puller-project.adoc

* Fix language on modules/administration-guide/examples/snip_che-devfile-meta.adoc

* Fix language on modules/administration-guide/examples/snip_che-plug-in-tree.adoc

* Fix language on modules/administration-guide/partials/assembly_tracing-che.adoc

* Fix language on modules/administration-guide/partials/con_caching-images-for-faster-workspace-start.adoc

* Fix language on modules/administration-guide/partials/con_che-user-runtimes.adoc

* Fix language on modules/administration-guide/partials/con_che-workspaces-architecture.adoc

* Fix language on modules/administration-guide/partials/con_controller-requirements.adoc

* Fix language on modules/administration-guide/partials/proc_building-a-custom-devfile-registry-image.adoc

* Fix language on modules/administration-guide/partials/proc_building-a-custom-plug-in-registry-image.adoc

* Fix language on modules/administration-guide/partials/proc_collecting-che-metrics-with-prometheus.adoc

* Fix language on modules/administration-guide/partials/proc_configuring_bitbucket_servers.adoc

* Fix language on modules/administration-guide/partials/proc_installing-image-puller-on-kubernetes-using-the-image-puller-operator.adoc

* Fix language on modules/administration-guide/partials/proc_installing-image-puller-using-helm.adoc

* Fix language on modules/administration-guide/partials/proc_viewing-che-metrics-on-grafana-dashboards.adoc

* Fix language on modules/administration-guide/partials/proc_viewing-che-traces-in-jaeger-ui.adoc

* Fix language on modules/administration-guide/partials/proc_viewing-keycloak-server-logs.adoc

* Fix language on modules/administration-guide/partials/proc_viewing-postgresql-server-logs.adoc

* Fix language on modules/administration-guide/partials/proc_viewing-the-state-of-the-che-cluster-deployment-using-openshift-4-cli-tools.adoc

* Fix language on modules/administration-guide/partials/prometheus-config.adoc

* Fix language on modules/administration-guide/partials/ref_grafana-dashboards-for-che.adoc

* New attributes

* RHDEVDOCS-2804 Removing the low level details from the image puller landing page (#1940)

Signed-off-by: Ilya Buziuk <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* Fix vale rules in installation guide (#1942)

* New attributes

* Vale config

* Vale config, new attributes

* Fix language on modules/installation-guide/pages/configuring-labels-for-ingresses.adoc

* Fix language on modules/installation-guide/partials/con_security-considerations.adoc

* Fix language on modules/installation-guide/partials/con_understanding-che-server-advanced-configuration-using-the-operator.adoc

* Fix language on modules/installation-guide/partials/con_workspace-exposure-strategies.adoc

* Fix language on modules/installation-guide/partials/proc_configuring-dns-on-azure.adoc

* Fix language on modules/installation-guide/partials/proc_configuring-labels-for-ingresses.adoc

* Fix language on modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc

* Fix language on modules/installation-guide/partials/proc_configuring-storage-types.adoc

* Fix language on modules/installation-guide/partials/proc_configuring-the-che-operator-checluster-resource-with-kubectl.adoc

* Fix language on modules/installation-guide/partials/proc_creating-a-google-kubernetes-engine-instance.adoc

* Fix language on modules/installation-guide/partials/proc_deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc

* Fix language on modules/installation-guide/partials/proc_enabling-dev-workspace-engine.adoc

* Fix language on modules/installation-guide/partials/proc_importing-untrusted-tls-certificates-old.adoc

* Fix language on modules/installation-guide/partials/proc_installing-dns-on-google-cloud-platform.adoc

* Fix language on modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc

* Fix language on modules/installation-guide/partials/proc_setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc

* Fix language on modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc

* Fix language on modules/installation-guide/partials/proc_using-minishift-to-set-up-openshift-3.adoc

* Fix language on modules/installation-guide/partials/proc_sizing-google-cloud-node-pools-for-your-eclipse-che-workspaces.adoc

* Fix language on .vale/styles/Vocab/Che/accept.txt

* Fix language on modules/installation-guide/partials/proc_preparing-the-aws-system-for-installing-che.adoc

* Fix language on modules/installation-guide/examples/checluster-properties.adoc

* Fix language on modules/installation-guide/partials/con_persistent-volume-configuration.adoc

* Fix language on modules/installation-guide/partials/proc_using-kubespray-to-set-up-kubernetes.adoc

* Fix language on modules/installation-guide/examples/ref_che-supported-platforms-and-installation-methods.adoc

* Fix language on modules/installation-guide/partials/proc_installing-che-on-kind-using-chectl.adoc

* Fix language on modules/installation-guide/partials/proc_installing-cert-manager-on-kubernetes.adoc

Co-authored-by: Michal Maléř <[email protected]>

* Fix doc (#1945)

Signed-off-by: Anatolii Bazko <[email protected]>

* [release] Bump to 7.28.0 in master (#1946)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>

* Deprecate namespace strategies other than 'per user' (#1936)

* Deprecate namespace strategies other than 'per user'

Co-authored-by: Yana Hontyk <[email protected]>

* Document upstream plugin registry changes (#1917)

* Plugin model revamping

* Add details about adding che-theia-plugins.yaml entries on the page
  "Building custom registries"
* Contribute a new upstream specific article on how to write che-theia-plugins.yaml
  entries
* Small fixes to other articles
* Restored deps needed for local development to package.json

Signed-off-by: Eric Williams <[email protected]>

* Update modules/end-user-guide/partials/proc_adding-a-vs-code-extension-to-the-che-plugin-registry.adoc

Co-authored-by: Anatolii Bazko <[email protected]>

* Plugin model revamping

* Add details about adding che-theia-plugins.yaml entries on the page
  "Building custom registries"
* Contribute a new upstream specific article on how to write che-theia-plugins.yaml
  entries
* Small fixes to other articles
* Restored deps needed for local development to package.json

Signed-off-by: Eric Williams <[email protected]>

* Update modules/end-user-guide/partials/proc_adding-a-vs-code-extension-to-the-che-plugin-registry.adoc

Co-authored-by: Anatolii Bazko <[email protected]>

* Review for this fantastic work! :)

Signed-off-by: Michal Maléř <[email protected]>

* vale

Signed-off-by: Michal Maléř <[email protected]>

* Update ref_che-theia-plug-in-metadata.adoc

Co-authored-by: Anatolii Bazko <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Yana Hontyk <[email protected]>

* [release] Bump to 7.28.1 in master (#1947)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Yana Hontyk <[email protected]>

* Refresh modules/installation-guide/examples/system-variables.adoc and skip vale checks on it. We need to fix things in che.properties. (#1944)

Co-authored-by: Yana Hontyk <[email protected]>

* Putting examples in boxes, adding missing verification steps (#1937)

* Putting examples in boxes, adding missing verification steps

Signed-off-by: Michal Maléř <[email protected]>

* Putting examples in boxes, adding missing verification steps

Signed-off-by: Michal Maléř <[email protected]>

* Verification steps

Signed-off-by: Michal Maléř <[email protected]>

* missing step

Signed-off-by: Michal Maléř <[email protected]>

* conflict

Signed-off-by: Michal Maléř <[email protected]>

* conflict

Signed-off-by: Michal Maléř <[email protected]>

* the old friend Vale

Signed-off-by: Michal Maléř <[email protected]>

* Update modules/end-user-guide/partials/proc_overriding-devfile-values-using-factory-parameters.adoc

Co-authored-by: Serhii Leshchenko <[email protected]>

Co-authored-by: Serhii Leshchenko <[email protected]>
Co-authored-by: Yana Hontyk <[email protected]>

* Report breakdown of vale errors per module (#1943)

* Report breakdown of vale errors per module

* Add license. Fix shellcheck error.

* Don't validate language on YAML files

* External script to validate language on files change

* Fix behaviour

* Fix language on hosted che (#1950)

* Fix language on modules/hosted-che/partials/proc_creating-a-workspace-from-template-in-hosted-che.adoc

* Fix language on modules/hosted-che/partials/proc_creating-a-workspace-from-the-user-dashboard.adoc

* Fix language on modules/hosted-che/partials/proc_registering-to-hosted-che.adoc

* Fix language on modules/hosted-che/partials/ref_about-hosted-che.adoc

* IntelliJ in an exiting workspace (#1948)

* Add a proc on how to configure a workspace to use InteeliJ IDEA

* Update modules/end-user-guide/partials/proc_configuring-an-existing-workspace-to-use-intellij-idea.adoc

Co-authored-by: Serhii Leshchenko <[email protected]>

Co-authored-by: Serhii Leshchenko <[email protected]>

* Fix language errors in extensions (#1949)

* Fix language on .vale/styles/Vocab/Che/accept.txt

* Fix language on modules/extensions/partials/assembly_openshift-connector-overview.adoc

* Fix language on modules/extensions/partials/con_features-of-openshift-connector.adoc

* Fix language on modules/extensions/partials/proc_creating-a-telemetry-plugin.adoc

* Fix language on modules/extensions/partials/proc_creating-components-with-openshift-connector-in-che.adoc

* Fix language on modules/extensions/partials/proc_installing-openshift-connector-in-che.adoc

* Fix language on modules/extensions/partials/ref_the-woopra-telemetry-plugin.adoc

* Update modules/extensions/partials/proc_creating-a-telemetry-plugin.adoc

* Fix language on contributor guide (#1951)

* Fix language on .vale/styles/Vocab/Che/accept.txt

* Fix language on modules/contributor-guide/partials/assembly_testing-che-theia-plug-ins.adoc

* Fix language on modules/contributor-guide/partials/con_che-extension-points.adoc

* Fix language on modules/contributor-guide/partials/proc_adding-support-for-a-new-debugger.adoc

* Fix language on modules/contributor-guide/partials/proc_bootstrapping-che-theia-plug-in-development-with-yeoman.adoc

* Fix language on modules/contributor-guide/partials/proc_defining-custom-branding-values-for-che-theia.adoc

* Fix language on modules/contributor-guide/partials/ref_che-theia-plug-in-api.adoc

* Changes in vale configuration to parse che.properties (#1953)

* Fix small formatting issues (#1955)

* Language review and Vale rules update (#1954)

Adapt vale configuration:

* Skip validation on metadata (:attribute: and `id` statements).
* Use the new `CheDocs.TechnicalTerms` rule to define capitalization rules, with severity error, instead of the Vocab (`accept.txt`, `reject.txt`).
* Use the Vocab (`accept.txt`, `reject.txt`) only to expand the dictionary (words triggering Spelling errors).
* Raise the severity of the `CheDocs.Attributes` substitution rule.

Fix the content.

* [release] Bump to 7.29.0 in master (#1956)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Add IMAGE_PULL_SECRETS to image puller parameters (#1957)

* Add IMAGE_PULL_SECRETS to image puller parameters

* Update con_caching-images-for-faster-workspace-start.adoc

* Fix vale errors and suggestions

* Fix URL to kubectl docsfix. (#1960)

* Add AFFINITY to image puller parameters (#1959)

Co-authored-by: Yana Hontyk <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>

* Make checluster_docs_gen.sh script compatible with CRD v1 (#1961)

* Make checluster_docs_gen.sh script compatible with CRD v1

Signed-off-by: Anatolii Bazko <[email protected]>

* Fix broken link (#1963)

Fix broken link to blog about installing on Docker Desktop
Co-authored-by:    Eric Rizzo <[email protected]

* Update doc to mention that inital user credentials are stored into openshift-config namespace (#1964)

Signed-off-by: Anatolii Bazko <[email protected]>

* Eclipse Che hosted by Red Hat: Updating the IDE link to the  developer-sandbox (#1968)

Signed-off-by: Ilya Buziuk <[email protected]>

* Add GiLab OAuth configuration manual (#1952)

* Add GiLab OAuth pages;

* Fixup language

Co-authored-by: Yana Hontyk <[email protected]>

* Fixup language

Co-authored-by: Yana Hontyk <[email protected]>

* Fixup language

Co-authored-by: Yana Hontyk <[email protected]>

* Fixup review comments

* Fixup

* Update proc_configuring-gitlab-oauth2.adoc

Co-authored-by: Yana Hontyk <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* annotation-fix (#1970)

Signed-off-by: Michal Maléř <[email protected]>

* [release] Bump to 7.29.1 in master (#1966)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>

* Fix asciidoc warnings. (#1969)

Co-authored-by: Michal Maléř <[email protected]>

* Clarify 'per user' project strategy in case if users didn't have enough privileges (#1967)

* Clarify 'per user' project strategy in case if users didn't had enough privileges

* Update modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc

Co-authored-by: Yana Hontyk <[email protected]>

* fixup! Merge branch 'master' into che19572

Signed-off-by: Sergii Kabashniuk <[email protected]>

* Update proc_configuring-namespace-strategies.adoc

* Update proc_configuring-namespace-strategies.adoc

* Update proc_configuring-namespace-strategies.adoc

vale

Co-authored-by: Yana Hontyk <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>

* Fix inconsistent capitalization (#1972)

* Update PULL_REQUEST_TEMPLATE.md (#1971)

* Update PULL_REQUEST_TEMPLATE.md

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Fix inconsistent capitalization (#1974)

* missing unit (#1973)

Signed-off-by: Michal Maléř <[email protected]>

* adding interval example (#1976)

* adding interval example

Signed-off-by: Michal Maléř <[email protected]>

* consistent fix for the OC patch command

Signed-off-by: Michal Maléř <[email protected]>

* consistent commands

Signed-off-by: Michal Maléř <[email protected]>

* Update proc_removing-initial-openshift-user.adoc

* Add missed paragraphs about servers configuration property (#1977)

* Add missed paragraphs about servers configuration property

* Add missed paragraphs about servers configuration property

* Fix include statement (#1980)

* instead of sed to remove spaces, use tr to remove spaces AND quotes (#1979)

* instead of sed to remove spaces, use tr to remove spaces AND quotes

Change-Id: I5384aa9a3bc25e5423ab0efb719e6b3e839a4fb7
Signed-off-by: nickboldt <[email protected]>

* instead of sed to remove spaces, use tr to remove spaces AND quotes (more complete solution for both types of quotes)

Change-Id: I920aeb211d7f4d027ee4bd37efdf3a54ed2f15a4
Signed-off-by: nickboldt <[email protected]>

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Use attributes for Kubernetes occurences (#1888)

* Use attributes for Kubernetes occurences

* Update modules/installation-guide/examples/checluster-properties.adoc

* Update modules/installation-guide/pages/configuring-labels-for-ingresses.adoc

* Update modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc

* Update modules/end-user-guide/partials/proc_mounting-a-secret-as-an-environment-variable-into-a-workspace-container.adoc

Co-authored-by: Yana Hontyk <[email protected]>

* Update modules/administration-guide/partials/proc_configuring-bitbucket-server-oauth1.adoc

* Update modules/installation-guide/examples/checluster-properties.adoc

* Update modules/installation-guide/partials/proc_configuring-workspace-exposure-strategies-using-a-helm-chart.adoc

* Update modules/installation-guide/examples/system-variables.adoc

* Apply suggestions from code review

* Update modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc

* Update modules/installation-guide/examples/system-variables.adoc

* Apply suggestions from code review

Revert Kubernetes edits.

* Update modules/installation-guide/examples/system-variables.adoc

* Apply suggestions from code review

Co-authored-by: Yana Hontyk <[email protected]>

* [release] Bump to 7.30.0 in master (#1978)

* [release] Bump to 7.30.0 in master

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

* Fix https://github.com/eclipse/che/issues/19776

* The scripts don't handle well the presence of ""

* put back quotes around "7.30" 

put back quotes around "7.30" so it doesn't resolve to 7.3

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Nick Boldt <[email protected]>

* Evaluate version in tools/checluster_docs_gen.sh: remove spaces, single and double quotes from the value of prod-ver, then append x. (#1981)

* che-19271 Adding a note about support of both product & project devfiles on Eclipse Che hosted by Red Hat (#1986)

Signed-off-by: Ilya Buziuk <[email protected]>

* Removed mentions of namespace strategies other than per-user (#1983)

* Removed mentions of namespace strategies other than per-user

* fixup! Removed mentions of namespace strategies other than per-user

Signed-off-by: Sergii Kabashniuk <[email protected]>

* fixup! Merge remote-tracking branch 'origin/che19536' into che19536

Signed-off-by: Sergii Kabashniuk <[email protected]>

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Remove references to outdated parts of dashboard (#1984)

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Fix formatting. (#1989)

* [release] Bump to 7.30.1 in master (#1988)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>

* Refresh checluster-properties.adoc and system-variables.adoc  (#1982)

* Outcome of ./tools/checluster_docs_gen.sh ; ./tools/environment_docs_gen.sh

* Fix attribute in id

* Removed mentions of namespace strategies other than per-user (#1983)

* Removed mentions of namespace strategies other than per-user

* fixup! Removed mentions of namespace strategies other than per-user

Signed-off-by: Sergii Kabashniuk <[email protected]>

* fixup! Merge remote-tracking branch 'origin/che19536' into che19536

Signed-off-by: Sergii Kabashniuk <[email protected]>

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Ignore vale on checluster-properties.adoc

Co-authored-by: Sergii Kabashniuk <[email protected]>

* Add hyphen to compound adjective, change wording (#1990)

Signed-off-by: David Kwon <[email protected]>

Co-authored-by: David <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Fix metadata (#1997)

* Enable upstream plugin registry changes in downstream (#1996)

Enables fixes from https://github.com/eclipse/che-docs/pull/1917
downstream. This PR will need to be backported to 7.30.x

Fixes RHDEVDOCS-2647

Signed-off-by: Eric Williams <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* review of a review (#1994)

* review of a review

Signed-off-by: Michal Maléř <[email protected]>

* html test fix

Signed-off-by: Michal Maléř <[email protected]>

* a little fix (#1995)

Signed-off-by: Michal Maléř <[email protected]>

* Fail on asciidoctorjs warning (#1993)

* Fix typos (#1999)

Signed-off-by: David Kwon <[email protected]>

Co-authored-by: Yana Hontyk <[email protected]>

* Review accept.txt, do not use it for capitalization unless necessary (#2001)

* [release] Bump to 7.30.2 in master (#2000)

* [release] Bump to 7.30.2 in master

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

* Update antora-playbook.yml

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Fix links after che-server repository move (#2002)

* More robust links (#2003)

* More robust links:

* Repositories relocation
* Use raw.githubusercontent
* Use {prod-ver-patch} tag when available

* plugin -> plug-in

* Image puller: do not use an attribute for the ServiceAccount name, change download URL for che-operator.clusterserviceversion.yaml, images is not a placeholder (#1985)

* image-puller-stuff

Signed-off-by: Michal Maléř <[email protected]>

* renaming the snip

Signed-off-by: Michal Maléř <[email protected]>

* attribute

Signed-off-by: Michal Maléř <[email protected]>

* attribute fix

Signed-off-by: Michal Maléř <[email protected]>

* fix

Signed-off-by: Michal Maléř <[email protected]>

* removing

Signed-off-by: Michal Maléř <[email protected]>

* removing

Signed-off-by: Michal Maléř <[email protected]>

* Update modules/administration-guide/examples/snip_che-getting-the-list-of-relevant-images.adoc

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Update contributing.adoc (#2005)

* Update CONTRIBUTING.adoc

Co-authored-by: tstastna <[email protected]>

* The reference to che-theia-plugins.yaml is specific to upstream. (#2006)

* [release] Bump to 7.31.0 in master (#2008)

* [release] Bump to 7.31.0 in master

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

* Ensure version numbers are always strings.

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Fix link for downstream (#2009)

* Fix link for downstream

* Update modules/end-user-guide/partials/con_che-theia-task-types.adoc

Co-authored-by: Robert Krátký <[email protected]>

Co-authored-by: Robert Krátký <[email protected]>

* Fix repository location. Update generated docs after version bump. (#2011)

* Chore - Changes in Docs Team (#2010)

* Remove @boczkowska from CODEOWNERS

* Add Max Leonov to CODEOWNERS

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Configuring the number of workspaces (#2004)

* Running multiple workspaces simultaneously first draft

* Updating the Operator procedure and doing small fixes

* Fix context in assembly

* Rename the files and improve the content

* Improve language, reorganize content

* Improve language

* Update modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Update modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Sergii Kabashniuk <[email protected]>

* Authoring devfile version 1 and 2 (#2012)

* devfile

* Update modules/end-user-guide/pages/authoring-devfiles-version-2.adoc

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Update modules/end-user-guide/pages/authoring-devfiles-version-1.adoc

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Update modules/end-user-guide/pages/authoring-devfiles-version-1.adoc

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* nav

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* fix: metadata on assembly_authoring-devfiles-version-2.adoc (#2014)

* docs: fix metadata on assembly_authoring-devfiles-version-2.adoc

* Fix: page name change

* Fix: page name change fixes

* fix: deploying Eclipse Che on GCP (#2018)

* fix: deploying Eclipse Che on GCP

Signed-off-by: Anatolii Bazko <[email protected]>

* Update proc_installing-che-on-kubernetes_using_chectl_and_helm.adoc

edits

Co-authored-by: Michal Maléř <[email protected]>

* fix: configuring custom che hostname (#2019)

* fix: configuring custom che hostname

Signed-off-by: Anatolii Bazko <[email protected]>

* Remove unused image

Signed-off-by: Anatolii Bazko <[email protected]>

* Update proc_configuring-che-hostname.adoc

Co-authored-by: Michal Maléř <[email protected]>

* chore: [release] Bump to 7.31.1 in master (#2016)

* [release] Bump to 7.31.1 in master

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

* Adding back the quotes. Version numbers should always be strings, not decimal.

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>

* fix: vocabulary (#2017)

Co-authored-by: Michal Maléř <[email protected]>

* Fix language (#2021)

* Fix language

* Update proc_configuring-namespace-strategies.adoc

* Update proc_configuring-namespace-strategies.adoc

Co-authored-by: Michal Maléř <[email protected]>

* docs: Add note about common PVC deletion (#2015)

* Merge branch 'master' into che-18369

* Merge branch 'master' into che-18369

* review of #2015

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>

* chore: [release] Bump to 7.31.2 in master (#2026)

* [release] Bump to 7.31.2 in master

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

* fix: Don't remove quotes to version attributes.

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* docs: add how to configure annotations (#2023)

* fix: add how to configure annotations

Signed-off-by: Anatolii Bazko <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* Corrected a typo in url of role_binding.yaml (#2025)

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* chore(docs): update che-theia-plugins.yaml fields (#2030)

Brings us up-to-date with the latest upstream format.

Fixes eclipse/che#19780

Signed-off-by: Eric Williams <[email protected]>

* chore: prepare vale infringements counter for vale warnings hunt. (#2028)

* chore: prepare vale infringements counter for vale warnings hunt.

* fix: vale errors

* fix: Kubernetes Image Puller namespace (#2029)

Signed-off-by: David Kwon <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* fix: Fixup of Configuring GitLab OAuth2 procedure. (#2031)

Signed-off-by: rhopp <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* fix: missing prereq step for an OCP3 installation (#2027)

* missing prereq step for an OCP3 installation

Signed-off-by: Michal Maléř <[email protected]>

* Update modules/installation-guide/partials/proc_installing-che-on-openshift-3-using-the-operator.adoc

Co-authored-by: Robert Krátký <[email protected]>

* Update proc_installing-che-on-openshift-3-using-the-operator.adoc

* Update proc_installing-che-on-openshift-3-using-the-operator.adoc

* Update proc_installing-che-on-openshift-3-using-the-operator.adoc

* Update proc_installing-che-on-openshift-3-using-the-operator.adoc

Co-authored-by: Robert Krátký <[email protected]>

* docs: procedure: Adding a topic about the factory workspace-creation policy (#2032)

* Add topic about factory workspace creation policy

* Update proc_allowing-users-to-define-workspace-creation-strategy.adoc

* Update modules/end-user-guide/partials/proc_allowing-users-to-define-workspace-creation-strategy.adoc

Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>

* Update proc_allowing-users-to-define-workspace-creation-strategy.adoc

* Update modules/end-user-guide/partials/proc_allowing-users-to-define-workspace-creation-strategy.adoc

Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>

* Update proc_allowing-users-to-define-workspace-creation-strategy.adoc

* Update proc_allowing-users-to-define-workspace-creation-strategy.adoc

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>

* fix: check and update of intelliJ docs (#2035)

* check and update of intelliJ docs

Signed-off-by: Michal Maléř <[email protected]>

* cloning

Signed-off-by: Michal Maléř <[email protected]>

* fix: Use double quotes for bumped versions during release (#2036)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

* [release] Bump to 7.32.0 in master (#2037)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>

* chore: Adding Tereza Stastna to code owners (#2040)

Co-authored-by: Nick Boldt <[email protected]>

* procedure: removing an unnecesary procedure step for the Image Puller (#2039)

* removing an unnecesary procedure step for Che/CRW

Signed-off-by: Michal Maléř <[email protected]>

* cleaning

Signed-off-by: Michal Maléř <[email protected]>

* fixed an inaccurate figure description (#2034)

Signed-off-by: xbaran4 <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* feat(docs): better describe custom plugin scenarios (#2044)

* feat(docs): better describe custom plugin scenarios

Do a better job explaining how custom plugins relate to authoring
devfiles. Also removed versioning from plugin `id` fields and replaced
them with `latest`.

Fixes RHDEVDOCS-2853

Signed-off-by: Eric Williams <[email protected]>

* Update ref_devfile-reference.adoc

* vale fix

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* typo (#2047)

Signed-off-by: Michal Maléř <[email protected]>

* fix: Add a step for explicit configuration of GitLab OAuth2 endpoints; 

Co-authored-by: Michal Maléř <[email protected]>

* fix: adapt docs to dashboard pages renaming (#2033)

* fix: adapt docs to dashboard pages renaming

* fixup! fix: adapt docs to dashboard pages renaming

* fix: remove outdated screenshots

* review

Signed-off-by: Michal Maléř <[email protected]>

* Nick's suggestions

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* procedure: use organization instead of github-handle to explain fork … (#2042)

* procedure: use organization instead of github-handle to explain fork URL. Add back prerequisite step to have a fork as the GitHub extension does not propose to create a fork

* Update CONTRIBUTING.adoc

Co-authored-by: Robert Krátký <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Robert Krátký <[email protected]>

* fix: Configuring the number of workspaces that a user can create (#2024)

* Add first draft

* Add module to navigation

* Update proc_configuring-the-number-of-workspaces-a-user-can-create-using-configmap.adoc

* Typo and formatting fixes

* Fix language

* Improve language, rename files

* Fix a broken link

* Change related procedure to be consistent

* Fix broken links

* Implement suggestions from the reviewer

* Fix vale errors

* Fix formatting issue

* Implement suggestions from reviewer

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Nick Boldt <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* replaced destroy with removed in modules/contributor-guide/partials/con_che-extension-points.adoc (#2052)

* namepsace stragegies: Updated (#2049)

* namepsace stragegies: Updated

Signed-off-by: Michal Maléř <[email protected]>

* Update modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc

Co-authored-by: Michal Vala <[email protected]>

Co-authored-by: Michal Vala <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* feat: Add Github PAT-based auth configuration example 

Signed-off-by: Max Shaposhnik <[email protected]>

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* fix: Deploying Che with support for Git repositories with self-signed certificates (#2053)

Signed-off-by: Anatolii Bazko <[email protected]>

* pvcClaimSize-update (#2057)

Signed-off-by: Michal Maléř <[email protected]>

* feat: update doc accordingly to che-operator changes (#2056)

Signed-off-by: Anatolii Bazko <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* Fix: Improve installation guide for CodeReady Containers (#2048)

* Improve installation guide for CodeReady Containers

* Fix formatting

* review

Signed-off-by: Michal Maléř <[email protected]>

* edits

Signed-off-by: Michal Maléř <[email protected]>

* Fix typo

* additional review

Signed-off-by: Michal Maléř <[email protected]>

* Fix a typo

* update-qe-review

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* update of the TLS-certificate importing procedure (#2058)

Signed-off-by: Michal Maléř <[email protected]>

* Update Installing Che on OpenShift 4 using OperatorHub (#2059)

* Update Installing Che on OpenShift 4

* Update proc_creating-an-instance-of-the-che-operator.adoc

review-mmaler

* fixes

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* chore: Update mounting secrets and configmap into container (#2064)

* chore: Update mounting secrets and configmap into container

Signed-off-by: Anatolii Bazko <[email protected]>

* mmaler-review

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* feat: Enable Devworkspaces on k8s (#2063)

* Enable Devworkspaces on k8s

Signed-off-by: Sergii Kabashniuk <[email protected]>

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* fix: remarks (#2066)

* fix: remarks

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* [release] Bump to 7.33.2 in master (#2070)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>

* feat: document image puller default image workflow (#2065)

* Remove usages of "you" and "your"

Signed-off-by: David Kwon <[email protected]>

* Remove usages of "you" and "your"

Signed-off-by: David Kwon <[email protected]>

* review

Signed-off-by: Michal Maléř <[email protected]>

* fix

Signed-off-by: Michal Maléř <[email protected]>

* Delete unnecessary file

Signed-off-by: David Kwon <[email protected]>

* Combine ImagePuller enable instructions

Signed-off-by: David Kwon <[email protected]>

* link fix

Signed-off-by: Michal Maléř <[email protected]>

* link fix

Signed-off-by: Michal Maléř <[email protected]>

* vale

Signed-off-by: Michal Maléř <[email protected]>

* vale-2

Signed-off-by: Michal Maléř <[email protected]>

* vale-terms

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Ilya Buziuk <[email protected]>

* removed link:, OpenShift3 and Openshift4 from square brackets, square brackets (#2061)

Co-authored-by: Michal Maléř <[email protected]>

* chore: Problematic language -- replace master w/ main (#2068)

Change-Id: I3e1f7d7e6613ca310af4063caf3cda759960c872
Signed-off-by: nickboldt <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* fix: Prerequisites and Procedure (#2071)

* Replaced OpenShift with platforms-name

* [2654] fix

Based on comments in https://github.com/eclipse/che/issues/18514
1. replaced OpenShift with {platforms-name}
in Prerequisites,
2. added the `update` step,
3. rewrote the upgrade step description.

Bug: https://issues.redhat.com/browse/RHDEVDOCS-2654

* [2654] fix

Removed italics and angle brackets from the following command block:
$ chectl server:update -n eclipse-che

Bug: https://issues.redhat.com/browse/RHDEVDOCS-2654

* [2654] fix

removed the redundant word 'instance' from the following line in Prerequisites:
* And administrative account on an OpenShift instance.
* An administrative account on an instance of {platforms-name}.

Bug: https://issues.redhat.com/browse/RHDEVDOCS-2654

* rewrote step 3 in the procedure

* aligned the code block in step 3

* added ifeval for step 3

* rephrased

* mmaler-review

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* procedure: BitBucket links and info (#2074)

* links and info

Signed-off-by: Michal Maléř <[email protected]>

* vale fix

Signed-off-by: Michal Maléř <[email protected]>

* suggestions from the review

Signed-off-by: Michal Maléř <[email protected]>

* fix: update image puller docs and csv link (#2073)

* fix: update image puller docs and csv link

Signed-off-by: David Kwon <[email protected]>

* Update proc_defining-the-list-of-images-to-pull.adoc

* Update proc_defining-the-list-of-images-to-pull.adoc

* edits

Signed-off-by: Michal Maléř <[email protected]>

* Add another workspace startup image, mention OpenShift and che-machine-exec image

* fix

Signed-off-by: Michal Maléř <[email protected]>

* update

Signed-off-by: Michal Maléř <[email protected]>

* Nick's review

Signed-off-by: Michal Maléř <[email protected]>

* snip file with images for the upstream repo

Signed-off-by: Michal Maléř <[email protected]>

* edit

Signed-off-by: Michal Maléř <[email protected]>

* Edit image examples, OpenShift version

Signed-off-by: David Kwon <[email protected]>

* Update proc_defining-the-list-of-images-to-pull.adoc

Co-authored-by: Michal Maléř <[email protected]>

* chore: Bump to 7.34.0 in master (#2076)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>

* fix: Use semantic commit message for the release (#2077)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* fix: Use new URL for downloading and parsing CRD (#2079)

* Update checluster_docs_gen.sh

* Update checluster_docs_gen.sh

* chore: Bump to 7.34.1 in master (#2082)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>

* fix: Updating Hosted Che 'Troubleshooting' section. Adding a warning about currently disabled upstream devfile registry (#2081)

* fix: Updating Hosted Che 'Troubleshooting' section. Adding a warning about currently disabled upstream devfile registry

Signed-off-by: Ilya Buziuk <[email protected]>

* Update ref_about-hosted-che.adoc

Review

* Update ref_hosted-che-faq-and-troubleshooting.adoc

* Update ref_hosted-che-faq-and-troubleshooting.adoc

* Update ref_hosted-che-faq-and-troubleshooting.adoc

Co-authored-by: Michal Maléř <[email protected]>

* fix: metadata consistency in assembly_mounting-secrets-or-a-configmap-as-file-or-env-variable-in-container.adoc (#2067)

Co-authored-by: Michal Maléř <[email protected]>

* fix: removing references to (previous) versions of Che in two .adoc files (#2062)

* first draft

* rewrote two example files

* replaced comma with brackets and reworded

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-a-file.adoc

Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-a-file.adoc

Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-a-file.adoc

Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-a-file.adoc

Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>

* rewrote a few sentences

* forgot an *

* fixed one sentence, added a comment line

* fixed a few lines

* Update che-ref_a-kubernetes-secret-as-a-file.adoc

* Update che-ref_a-kubernetes-secret-as-an-variable.adoc

* Update che-ref_a-kubernetes-secret-as-a-file.adoc

* work in progress on the final NOTE

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-a-file.adoc

Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>

* Update che-ref_a-kubernetes-secret-as-a-file.adoc

* Update che-ref_a-kubernetes-secret-as-a-file.adoc

* Update che-ref_a-kubernetes-secret-as-a-file.adoc

* Update che-ref_a-kubernetes-secret-as-a-file.adoc

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-an-variable.adoc

Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>

* Update che-ref_a-kubernetes-secret-as-a-file.adoc

* Rewrote one paragraph

* test

* added a missing `data` to `data key`

* minor fixes

* minor fix

* reordered sentences and preview test

* run-on ul item

* added missing apostrophes

* adding missing apostrophes

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-a-file.adoc

Co-authored-by: Robert Krátký <[email protected]>

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-a-file.adoc

Co-authored-by: Robert Krátký <[email protected]>

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-a-file.adoc

Co-authored-by: Robert Krátký <[email protected]>

* Update modules/end-user-guide/examples/che-ref_a-kubernetes-secret-as-an-variable.adoc

Co-authored-by: Robert Krátký <[email protected]>

* removed one comment line

* removed a comment line

* removed a comment line

Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Robert Krátký <[email protected]>

* Add Backup / Restore docs (#2072)

* Add Backup / Restore docs

Signed-off-by: Mykola Morhun <[email protected]>

* Che 19962 mmaler review (#2080)

review after a review

Signed-off-by: Michal Maléř <[email protected]>

* Apply suggestions from @rkratky's code review

Co-authored-by: Robert Krátký <[email protected]>

* Fix links and nav

Signed-off-by: Mykola Morhun <[email protected]>

* Rephrase word 'passwordless' to make vale check passing

Signed-off-by: Mykola Morhun <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Anatolii Bazko <[email protected]>
Co-authored-by: Robert Krátký <[email protected]>

* fix: clarified that a parameter is optional (#2086)

* fixed the table entry

* feat: document image puller default image workflow (#2065)

* Remove usages of "you" and "your"

Signed-off-by: David Kwon <[email protected]>

* Remove usages of "you" and "your"

Signed-off-by: David Kwon <[email protected]>

* review

Signed-off-by: Michal Maléř <[email protected]>

* fix

Signed-off-by: Michal Maléř <[email protected]>

* Delete unnecessary file

Signed-off-by: David Kwon <[email protected]>

* Combine ImagePuller enable instructions

Signed-off-by: David Kwon <[email protected]>

* link fix

Signed-off-by: Michal Maléř <[email protected]>

* link fix

Signed-off-by: Michal Maléř <[email protected]>

* vale

Signed-off-by: Michal Maléř <[email protected]>

* vale-2

Signed-off-by: Michal Maléř <[email protected]>

* vale-terms

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Ilya Buziuk <[email protected]>

* removed link:, OpenShift3 and Openshift4 from square brackets, square brackets (#2061)

Co-authored-by: Michal Maléř <[email protected]>

Co-authored-by: David Kwon <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>
Co-authored-by: Ilya Buziuk <[email protected]>

* chore: set minimal kubernetes version to 1.19 (#2085)

* chore: set minimal kubernetes version to 1.19

Signed-off-by: Anatolii Bazko <[email protected]>

* new attribute for minimal version of Kubernetes - 1.19

Signed-off-by: Michal Maléř <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* chore: Mark helmcharts deprecated (#2089)

Signed-off-by: Anatolii Bazko <[email protected]>

Co-authored-by: Michal Maléř <[email protected]>

* Fix vale warnings in End-user Guide (#2078)

* Fix vale warnings in end user guide

* Fix a typo

* Implement review suggestions

* Small fixes

* Link Vale fix

Signed-off-by: Michal Maléř <[email protected]>

* Fix hyphenation

Co-authored-by: Michal Maléř <[email protected]>

* Install on azure (#2087)

* added more details on getting a domain name from a registrar

* updated cert-manager version. Changed clusterissuer definition to work with chectl deploy

* Update proc_configuring-dns-on-azure.adoc

Changed case on GoDaddy to remediate failing check from vale

Co-authored-by: oakmin <[email protected]>
Co-authored-by: Michal Maléř <[email protected]>

* Fix vale warnings (#2075)

* Fix vale warnings

* Fix vale warnings in the administration guide

* Fix warnings in the administration guide

* Update assembly_configuring-authorization.adoc

* Update assembly_understanding-che-workspaces-architecture.adoc

* Fix vale warnings in hosted che and installation guide

* Fix readability grade

* Fix a typo

* Fix readability grade

* Fix readability grade

* Reverting a file changed by mistake

* Add lead-in sentences

* Improve language

* Implement suggestions from peer review

* Fix vale error

* intro

Signed-off-by: Michal Maléř <[email protected]>

* vale error

Signed-off-by: Michal Maléř <[email protected]>

* Typo fix, small changes in lead-in sentences

* Implement review suggestions

* Small fix

* Improve language

Co-authored-by: Michal Maléř <[email protected]>

* fix: capitalization (#2094)

* Fix capitalization

* Fix capitalization

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* chore: Bump to 7.34.2 in master (#2096)

Signed-off-by: Mykhailo Kuznietsov <[email protected]>

Co-authored-by: Mykhailo Kuznietsov <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Fix: references to the 'Get Started' UI label (#2051)

* salvaging earlier versions of some of modified files after the vale > wipeout

* removing the files deleted during editing as part of the salvage operation

* pre-Vale, salvaged and rewritten

* fixed editing-the-commands-after-importing-a-project

* fixing a missed {prod-short}

* merging upstream changes

* renamed  as

* minor word fixes

* replaced one word in a section title

* minor text fixes to some files

* Update assembly_creating-a-workspace-from-included-options.adoc
…
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants