Skip to content

Commit ce41a88

Browse files
gtrivedi88tolusha
andauthored
Fixup doc (#3088) (#3116)
Signed-off-by: Anatolii Bazko <abazko@redhat.com> Co-authored-by: Anatolii Bazko <abazko@redhat.com>
1 parent fbcb09f commit ce41a88

3 files changed

Lines changed: 32 additions & 18 deletions

File tree

modules/administration-guide/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
*** xref:configuring-workspace-target-namespace.adoc[]
4646
*** xref:provisioning-namespaces-in-advance.adoc[]
4747
*** xref:configuring-a-user-namespace.adoc[]
48-
*** xref:configuring-direct-namespace-creation-on-openshift.adoc[]
48+
*** xref:configuring-kubernetes-namespace-creation-on-openshift.adoc[]
4949
** xref:configuring-server-components.adoc[]
5050
*** xref:mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container.adoc[]
5151
*** xref:advanced-configuration-options-for-the-che-server-component.adoc[]

modules/administration-guide/pages/configuring-a-user-namespace.adoc

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ In reverse, if a {kubernetes} resource is modified in a user namespace,
2020

2121
[WARNING]
2222
====
23-
Applying or modifying a `Secret` or `ConfigMap` with the `controller.devfile.io/mount-to-devworkspace: 'true'` label restarts all running workspaces in the {namespace}. Ensure that users save their work before you apply these changes.
23+
Applying or modifying a `Secret` or `ConfigMap` with the `controller.devfile.io/mount-to-devworkspace: 'true'` label restarts all running workspaces in the {namespace}.
24+
25+
To mount the `Secret` or `ConfigMap` only at workspace start and prevent automatic restarts, add the `controller.devfile.io/mount-on-start: 'true'` annotation.
2426
====
2527

2628
.Procedure
@@ -44,21 +46,23 @@ data:
4446
====
4547
To enhance the configurability, you can customize the `ConfigMap` by adding additional labels and annotations.
4648
+
47-
Add the following labels if you do not want the ConfigMap to be mounted automatically:
49+
Add the annotation below if you want the ConfigMap to be retained in a user {namespace}
50+
after being deleted from {prod-namespace} namespace:
4851
+
4952
[source,yaml,subs="+attributes,+quotes"]
5053
----
51-
controller.devfile.io/watch-configmap: "false"
52-
controller.devfile.io/mount-to-devworkspace: "false"
54+
che.eclipse.org/sync-retain-on-delete: "true"
5355
----
5456
+
55-
Add the annotation below if you want the ConfigMap to be retained in a user {namespace}
56-
after being deleted from {prod-namespace} namespace:
57+
Add the following annotation to prevent workspace restarts when the ConfigMap is created:
5758
+
5859
[source,yaml,subs="+attributes,+quotes"]
5960
----
60-
che.eclipse.org/sync-retain-on-delete: "true"
61+
controller.devfile.io/mount-on-start: "true"
6162
----
63+
+
64+
With this annotation, the ConfigMap is mounted only at workspace start.
65+
+
6266
For example, to mount a default SSH configuration into every workspace, you must create a ConfigMap:
6367
+
6468
====
@@ -104,22 +108,23 @@ stringData:
104108
====
105109
To enhance the configurability, you can customize the `Secret` by adding additional labels and annotations.
106110
+
107-
Add the labels if you do not want the Secret to be mounted automatically:
111+
Add the annotation below if you want the Secret to be retained in a user {namespace}
112+
after being deleted from {prod-namespace} namespace:
108113
+
109114
[source,yaml,subs="+attributes,+quotes"]
110115
----
111-
controller.devfile.io/watch-secret: "false"
112-
controller.devfile.io/mount-to-devworkspace: "false"
116+
che.eclipse.org/sync-retain-on-delete: "true"
113117
----
114118
+
115-
Add the annotation below if you want the Secret to be retained in a user {namespace}
116-
after being deleted from {prod-namespace} namespace:
119+
Add the following annotation to prevent workspace restarts when the Secret is created:
117120
+
118121
[source,yaml,subs="+attributes,+quotes"]
119122
----
120-
che.eclipse.org/sync-retain-on-delete: "true"
123+
controller.devfile.io/mount-on-start: "true"
121124
----
122125
+
126+
With this annotation, the Secret is mounted only at workspace start.
127+
+
123128
See the link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#automatically-mounting-volumes-configmaps-and-secrets[mounting volumes, configmaps, and secrets]
124129
for other possible labels and annotations.
125130

@@ -151,6 +156,15 @@ Add the annotation below if you want the `PersistentVolumeClaim` to be deleted i
151156
che.eclipse.org/sync-retain-on-delete: "false"
152157
----
153158
+
159+
Add the following annotation to prevent workspace restarts when the `PersistentVolumeClaim` is created:
160+
+
161+
[source,yaml,subs="+attributes,+quotes"]
162+
----
163+
controller.devfile.io/mount-on-start: "true"
164+
----
165+
+
166+
With this annotation, the `PersistentVolumeClaim` is mounted only at workspace start.
167+
+
154168
See the link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#automatically-mounting-volumes-configmaps-and-secrets[mounting volumes, configmaps, and secrets]
155169
for other possible labels and annotations.
156170
+

modules/administration-guide/pages/configuring-direct-namespace-creation-on-openshift.adoc renamed to modules/administration-guide/pages/configuring-kubernetes-namespace-creation-on-openshift.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
:navtitle: Configuring direct namespace creation on OpenShift
55
:page-aliases:
66

7-
[id="configuring-direct-namespace-creation-on-openshift"]
8-
= Configuring direct namespace creation on OpenShift
7+
[id="configuring-kubernetes-namespace-creation-on-openshift"]
8+
= Configuring {kubernetes} namespace creation on OpenShift
99

1010
By default, on {ocp} clusters, {prod-short} uses the ProjectRequest API to create projects. This triggers cluster-specific link:https://docs.openshift.com/container-platform/latest/applications/projects/configuring-project-creation.html[Project Templates], which can apply additional resources or policies.
1111

@@ -17,7 +17,7 @@ On {ocp}, you can bypass Project Templates and create standard {kubernetes} Name
1717

1818
.Procedure
1919

20-
. Set the `createNamespaceDirectly` field to `true`:
20+
. Set the `createKubernetesNamespaces` field to `true`:
2121
+
2222
[source,shell,subs="+quotes,+attributes,+macros"]
2323
----
@@ -28,7 +28,7 @@ On {ocp}, you can bypass Project Templates and create standard {kubernetes} Name
2828
"spec": {
2929
"devEnvironments": {
3030
"defaultNamespace": {
31-
"createNamespaceDirectly": true
31+
"createKubernetesNamespaces": true
3232
}
3333
}
3434
}

0 commit comments

Comments
 (0)