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

procedures: Configuring workspace target namespace, Provisioning namespaces #2301

Merged
merged 18 commits into from
Apr 27, 2022
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
8749f61
procedures: Configuring workspace target namespace, Provisioning name…
themr0c Apr 21, 2022
3cdaf8f
Update modules/administration-guide/pages/configuring-workspaces-glob…
themr0c Apr 21, 2022
08409c9
Updat"es after testing on Minikube
themr0c Apr 22, 2022
751fe5f
adding example values
themr0c Apr 22, 2022
8c6ff64
edit privilege is enough
themr0c Apr 22, 2022
bee4bdf
Streamlining after tests on Minikube
themr0c Apr 22, 2022
b2268ff
fix: formatting, consistency
themr0c Apr 25, 2022
76dc9ab
fix: apply suggestions
themr0c Apr 26, 2022
25a1efb
Update modules/administration-guide/pages/provisioning-namespaces-in-…
themr0c Apr 27, 2022
96ee360
Update modules/administration-guide/pages/configuring-workspace-targe…
themr0c Apr 27, 2022
cc1eeff
Update modules/administration-guide/pages/provisioning-namespaces-in-…
themr0c Apr 27, 2022
af24a92
Update modules/administration-guide/pages/configuring-workspace-targe…
themr0c Apr 27, 2022
53cb414
Update modules/administration-guide/pages/configuring-workspace-targe…
themr0c Apr 27, 2022
d524876
Update modules/administration-guide/pages/configuring-workspace-targe…
themr0c Apr 27, 2022
038a2f1
Update modules/administration-guide/pages/configuring-workspace-targe…
themr0c Apr 27, 2022
ec3377b
Update modules/administration-guide/pages/configuring-workspace-targe…
themr0c Apr 27, 2022
b29ab73
Update modules/administration-guide/pages/configuring-namespace-provi…
themr0c Apr 27, 2022
90a5ce6
Update modules/administration-guide/pages/configuring-workspace-targe…
themr0c Apr 27, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ asciidoc:
prod-operator-image-name: che-operator
prod-operator: che-operator
prod-prev-ver: "previous minor version"
prod-service-account: che
prod-short: Che
prod-stable-channel: stable
prod-stable-channel-catalog-source: community-operators
Expand Down
3 changes: 2 additions & 1 deletion modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@
** xref:configuring-workspaces-globally.adoc[]
*** xref:configuring-the-number-of-workspaces-that-a-user-can-create.adoc[]
*** xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]
*** xref:configuring-namespace-strategies.adoc[]
*** xref:configuring-workspace-target-namespace.adoc[]
*** xref:provisioning-namespaces.adoc[]
*** xref:configuring-workspaces-nodeselector.adoc[]
** xref:caching-images-for-faster-workspace-start.adoc[]
*** xref:defining-the-list-of-images-to-pull.adoc[]
Expand Down
26 changes: 1 addition & 25 deletions modules/administration-guide/pages/configuring-che.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,5 @@
[id="configuring-che_{context}"]
= Configuring {prod-short}

The following chapter describes configuration methods and options for {prod}.

* xref:advanced-configuration-options-for-the-che-server-component.adoc[] describes advanced configuration methods to use when the previous method is not applicable.

Specific use-cases:

* xref:configuring-namespace-strategies.adoc[]

* xref:configuring-the-number-of-workspaces-that-a-user-can-create.adoc[]

* xref:configuring-workspaces-nodeselector.adoc[]

* xref:configuring-che-hostname.adoc[]

* xref:configuring-ingresses.adoc[]

* xref:configuring-routes.adoc[]

* xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]

* xref:installing-che-using-storage-classes.adoc[]

* xref:importing-untrusted-tls-certificates.adoc[]

* xref:mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container.adoc[]
This section describes configuration methods and options for {prod}.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
:_content-type: CONCEPT
:navtitle: Configuring workspace target {orch-namespace}
:keywords: administration guide, configuring, namespace
:page-aliases: installation-guide:configuring-namespace-strategies, configuring-namespace-strategies

[id="configuring-workspace-target-namespace_{context}"]
= Configuring workspace target {orch-namespace}

For each user, {prod-short} isolates the workspaces in a {orch-namespace}.
You can configure the {orch-namespace} name template.
themr0c marked this conversation as resolved.
Show resolved Hide resolved

{prod-short} server checks usernames and IDs for compatibility with {orch-name} objects naming convention before creating a {orch-namespace} from a template:

* The `<username>` or `<userid>` placeholder is mandatory.
* Incompatible usernames or IDs are reduced to the nearest valid name by replacing groups of unsuitable symbols with the `-` symbol.
* The `<userid>` placeholder is evaluated into a 14 character long string.
* When using `<userid>`, the addition of a random 6-symbol suffix prevents IDs from collisions. The result is stored in preferences for reuse.
* {kubernetes} limits the length of a {orch-namespace} name to 63 characters (this includes the evaluated placeholders). Additionally, the names (after placeholder evaluation) must be valid DNS names.
* OpenShift limits the length further to 49 characters.

.User workspaces {orch-namespace} name template examples
====
[%header,cols="1,1"]
|===
|User workspaces {orch-namespace} name template
|Resulting {orch-namespace} example

|`<username>-{prod-id-short}` (default)
|user1-{prod-id-short}

|`<userid>-namespace`
|`cge1egvsb2nhba-namespace-ul1411`

|`<userid>-aka-<username>-namespace`
|`cgezegvsb2nhba-aka-user1-namespace-6m2w2b`
|===
====


.Procedure

* Set the `server.workspaceNamespaceDefault` property in CheCluster Custom Resource:
+
[source,yaml,subs="+quotes,+attributes"]
----
kind: CheCluster
apiVersion: org.eclipse.che/v1
# ...
spec:
server:
workspaceNamespaceDefault: __<workspaceNamespaceDefault_value>__
# ...
----

.Additional resources

* xref:understanding-the-checluster-custom-resource.adoc[]

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,14 @@
[id="configuring-workspaces-globally_{context}"]
= Configuring workspaces globally

This section describes how an administrator can configure workspaces globally.

* xref:configuring-the-number-of-workspaces-that-a-user-can-create.adoc[]

* xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]
* xref:configuring-namespace-strategies.adoc[]

* xref:configuring-workspace-target-namespace.adoc[]

* xref:provisioning-namespaces.adoc[]

* xref:configuring-workspaces-nodeselector.adoc[]
Loading