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

How to enable Dev Workspace engine #1895

Merged
merged 15 commits into from
Mar 14, 2021
1 change: 1 addition & 0 deletions modules/installation-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
** xref:switching-between-external-and-internal-communication.adoc[]
** xref:setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page.adoc[]
** xref:mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container.adoc[]
** xref:enabling-dev-workspace-engine.adoc[]

* xref:upgrading-che.adoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[id="enabling-dev-workspace-engine"]
// = Configuring Labels
:navtitle: Enabling Dev Workspace engine
:keywords: installation-guide, Dev Workspace
:page-aliases: .:enabling-dev-workspace-engine

include::partial$proc_enabling-dev-workspace-engine.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,6 @@ The next sections describe some specific user stories.

* xref:mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container.adoc[]

* xref:enabling-dev-workspace-engine.adoc[]

:context: {parent-context-of-configuring-che}
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@

[id="enabling-dev-workspace-engine_{context}"]
= Enabling Dev Workspace engine

This procedure describes how to enable the Dev Workspace engine to support the Devfile 2.0.0 file format and mentions how to do so on existing instances or those about to be installed.

.Prerequisites

* The `{orch-cli}` and `{prod-cli}` tools are available.


.Procedure

* For a new OperatorHub installation:
+
. Enter the {prod} Cluster using {ocp} and create CheCluster Custom Resource (CR). See, xref:installing-che-on-openshift-4-using-operatorhub#creating-an-instance-of-the-{prod-id-short}-operator_{context}[Creating an instance of the {prod} Operator]

+
. Set the following values in {prod-checluster} Custom Resource (CR):
+
[source,yaml,subs="+quotes"]
----
spec:
devWorkspace:
enable: true
----


* For a new `{prod-cli}` installation:
+
. Configure the the `{prod-cli}` installation using:
+
[subs="+quotes,+attributes"]
----
$ {prod-cli} server:deploy --che-operator-cr-patch-yaml=patch.yaml ...
----
+
`patch.yaml` must contain the following:
+
[source,yaml,subs="+quotes"]
----
spec:
devWorkspace:
enable: true
----

* For already existing {prod-short} installation:
+
. Update `{prod-checluster}` CR using the `{orch-cli}` tool:
+
[subs="+quotes,+attributes"]
----
$ {orch-cli} patch checluster {prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/devWorkspace/enable", "value": true}]'
----

.Additional resources

For information about installation methods mentioned in this chapter, see xref:installing-che.adoc[].