Skip to content

docs: Add article for configuring direct namespace creation on OpenShift #3046

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.

Sign up for GitHub

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

Closed
tolusha wants to merge 1 commit into from
Closed

docs: Add article for configuring direct namespace creation on OpenShift #3046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 modules/administration-guide/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
*** xref:configuring-workspace-target-namespace.adoc[]
*** xref:provisioning-namespaces-in-advance.adoc[]
*** xref:configuring-a-user-namespace.adoc[]
*** xref:configuring-direct-namespace-creation-on-openshift.adoc[]
** xref:configuring-server-components.adoc[]
*** xref:mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container.adoc[]
*** xref:advanced-configuration-options-for-the-che-server-component.adoc[]
Expand Down
52 changes: 52 additions & 0 deletions ...inistration-guide/pages/configuring-direct-namespace-creation-on-openshift.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
:_content-type: PROCEDURE
:description: Configuring {prod-short} to create standard {orch-namespace}s directly on OpenShift instead of using the ProjectRequest API
:keywords: administration-guide, configuring, namespace, openshift, project, direct
:navtitle: Configuring direct namespace creation on OpenShift
:page-aliases:

[id="configuring-direct-namespace-creation-on-openshift"]
= Configuring direct namespace creation on OpenShift

By default, on OpenShift, {prod-short} uses the ProjectRequest API to create user namespaces. This triggers any cluster-specific Project Templates configured by the OpenShift administrator.

If you want {prod-short} to create standard {orch-namespace}s directly, bypassing the ProjectRequest API and Project Templates, you can enable direct namespace creation. This is useful when Project Templates are not needed or when you want to avoid the overhead of the ProjectRequest workflow.

Check failure on line 12 in modules/administration-guide/pages/configuring-direct-namespace-creation-on-openshift.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[CheDocs.Attributes] Use the AsciiDoc attribute {orch-namespace}, {platforms-namespace}, or {namespace} rather than ' namespace .'

Raw Output:
{"message": "[CheDocs.Attributes] Use the AsciiDoc attribute {orch-namespace}, {platforms-namespace}, or {namespace} rather than ' namespace .'", "location": {"path": "modules/administration-guide/pages/configuring-direct-namespace-creation-on-openshift.adoc", "range": {"start": {"line": 12, "column": 150}}}, "severity": "ERROR"}

NOTE: This setting applies only to OpenShift clusters and has no effect on {orch-name}.

.Prerequisites

* An active `{orch-cli}` session with administrative permissions to the OpenShift cluster. See {orch-cli-link}.

* An existing {prod} installation.

.Procedure

. Set the `createNamespaceDirectly` field to `true` in the `spec.devEnvironments.defaultNamespace` section of the CheCluster custom resource.
+
====
[source,yaml,subs="+quotes,+attributes"]
----
kind: CheCluster
apiVersion: org.eclipse.che/v2
spec:
devEnvironments:
defaultNamespace:
createNamespaceDirectly: true
----
====

.Verification

* Start a new workspace and verify that the user {orch-namespace} is created as a standard {orch-namespace} rather than an OpenShift Project.
+
[subs="+attributes,+quotes"]
----
$ {orch-cli} get namespace __<user-namespace>__ -o jsonpath='{.metadata.labels}'
----
+
A directly created {orch-namespace} will not contain OpenShift Project-specific labels.

.Additional resources

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