fix: Add a note about the importance of the namespace labels for DevWorkspaces. (#286)

Signed-off-by: Lukas Krejci <lkrejci@redhat.com>
pull/301/head
Lukas Krejci 2022-05-02 16:02:45 +02:00 committed by GitHub
parent 2eb0a6e018
commit d64d9a1ac3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions

View File

@ -306,6 +306,14 @@ che.infra.kubernetes.namespace.creation_allowed=true
che.infra.kubernetes.namespace.default=<username>-che
# Defines whether che-server should try to label the workspace namespaces.
# NOTE: It is strongly recommended to keep the value of this property set to true. If false, the new workspace namespaces will not be labeled
# automatically and therefore not recognized by the Che operator making some features of DevWorkspaces not working.
# If false, an administrator is required to label the namespaces manually using the labels specified in che.infra.kubernetes.namespace.labels.
# If you want to manage the namespaces yourself, make sure to follow
# https://www.eclipse.org/che/docs/stable/administration-guide/provisioning-namespaces-in-advance/.
# Any additional labels present on the namespace are kept in place and do not affect the functionality.
# Also note that the the administrator is free to pre-create and label the namespaces manually even if this property is
# true. No updates to the namespaces are done if they already conform to the labeling requirements.
che.infra.kubernetes.namespace.label=true
# Defines whether che-server should try to annotate the workspace namespaces.
@ -315,6 +323,10 @@ che.infra.kubernetes.namespace.annotate=true
# 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.
# NOTE: It is strongly recommended not to change the value of this property because the Che operator relies on these labels
# and their precise values when reconciling DevWorkspaces. If this configuration is changed, the namespaces will not be automatically
# recognized by the Che operator as workspace namespaces unless manually labeled as such using the default labels and values.
# Additional labels on the namespace do not affect the functionality.
che.infra.kubernetes.namespace.labels=app.kubernetes.io/part-of=che.eclipse.org,app.kubernetes.io/component=workspaces-namespace
# List of annotations to find {orch-namespace} prepared for {prod-short} users workspaces.