Skip to content

Commit

Permalink
Added configMap concept module to the Che 7 docs
Browse files Browse the repository at this point in the history
Signed-off-by: Michal Maléř <mmaler@redhat.com>
  • Loading branch information
MichalMaler committed Sep 11, 2019
1 parent cc0f096 commit 93507af
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 31 deletions.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Advanced configuration options
keywords:
keywords:
tags: []
sidebar: che_7_docs
permalink: che-7/advanced-configuration-options.html
folder: che-7/installation-guide
summary:
summary:
---

:parent-context-of-advanced-configuration-options: {context}
Expand All @@ -15,45 +15,28 @@ summary:

:context: advanced-configuration-options

Following section describes advanced deployment and configuration methods for Eclipse Che.

This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on. Can include more than one paragraph. Consider using the information from the user story.
include::con_che-configmaps-and-their-behavior.adoc[leveloffset=+1]

[id='prerequisites-{context}']
== Prerequisites
// include::ref_che-configuration-reference-table.adoc[leveloffset=+1]

* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
* You can also link to other modules or assemblies the user must follow before starting this assembly.
* Delete the section title and bullets if the assembly has no prerequisites.
// include::proc_deploying-che-with-https-mode.adoc[leveloffset=+1]

// include::proc_deploying-che-without-keycloak.adoc[leveloffset=+1]

// include::proc_configuring-che-persistent-volumes-strategy.adoc[leveloffset=+1]

include::ref_che-configuration-reference-table.adoc[leveloffset=+1]
// include::proc_configuring-che-with-and-without-keycloak.adoc[leveloffset=+1]

include::proc_deploying-che-with-https-mode.adoc[leveloffset=+1]
// include::proc_configuring-private-docker-registries.adoc[leveloffset=+1]

include::proc_deploying-che-without-keycloak.adoc[leveloffset=+1]
// include::proc_configuring-email-notifications.adoc[leveloffset=+1]

include::proc_configuring-che-persistent-volumes-strategy.adoc[leveloffset=+1]
// include::proc_configuring-namespace-strategies.adoc[leveloffset=+1]

include::proc_configuring-che-with-and-without-keycloak.adoc[leveloffset=+1]
// include::proc_configuring-workspace-memory-settings.adoc[leveloffset=+1]

include::proc_configuring-private-docker-registries.adoc[leveloffset=+1]

include::proc_configuring-email-notifications.adoc[leveloffset=+1]

include::proc_configuring-namespace-strategies.adoc[leveloffset=+1]

include::proc_configuring-workspace-memory-settings.adoc[leveloffset=+1]

include::proc_configuring-che-with-openshift-oauth.adoc[leveloffset=+1]



[id='related-information-{context}']
== Related information

* A bulleted list of links to other material closely related to the contents of the concept module.
* For more details on writing assemblies, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
// include::proc_configuring-che-with-openshift-oauth.adoc[leveloffset=+1]

:context: {parent-context-of-advanced-configuration-options}
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// advanced-configuration-options

[id="che-configmaps-and-their-behavior_{context}"]
= Che configMaps and their behavior

The following section describes Che `configMaps` and how they behave.

A link:https://docs.openshift.com/container-platform/4.1/builds/setting-up-trusted-ca.html[`configMap`] is provided as an editable file that lists options to customize the Che environment. Based on the Che installation method, `configMaps` can be used to customize the working environment. The type of configMaps available in your Che environment varies based on the method used for installing Che.

== Che installed using the Operator

link:https://docs.openshift.com/container-platform/4.1/applications/operators/olm-what-operators-are.html[Operators] are software extensions to Kubernetes that use link:https://docs.openshift.com/container-platform/4.1/applications/crds/crd-managing-resources-from-crds.html[custom resources] to manage applications and their components.

When Che is installed using the Operator, this installation provides the user with two automatically generated `configMaps`: `che` (main) and `custom` (additional).

* The `che` `configMap` contains the main properties for the installation and is in sync with the information stored in the CheCluster Custom Resource file. If the user edits the `che` `configMap` after installing Che from the Operator, those changes are automatically overwritten by the values that the Operator obtains from the CheCluster Custom Resource.
To edit the `che` `configMap`, edit the Custom Resource manually.
The `configMap` derives values from the CheCluster field. If a user changes the CheCluster Custom Resource field, the Operator changes the attributes of the `che` `configMap` accordingly. Those `configMap` changes automatically trigger a restart of the Che pod.

* The secondary `custom` `configMap` is for additional properties customization that the user can edit manually. These properties include environment variables that are not already specified in the main che `configMap`. To apply the manual changes to the `custom` `configMap`, delete the Che pod to manually restart it.

== Che installed using a Helm Chart:

A (https://helm.sh/)[Helm Chart] is the Kubernetes extension for defining, installing, and upgrading Kubernetes applications.

* When Che is installed using a Helm Chart, the user configures Che manually by modifying the `configMap` object. The `configMap` object is called `che` and is generated as an editable template after the installation. To apply the manual changes to the `custom` `configMap`, delete the Che pod to manually restart it.
Alternatively, use the following command in the kubectl command-line interface:
+
----
$ kubectl rollout restart deployment/che
----
+
This avoids the downtime associated with deleting a pod, as it deploys and starts a new pod, and only then deletes the old pod.

////
.Additional resources
* A bulleted list of links to other material closely related to the contents of the concept module.
* Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.
* For more details on writing concept modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].

0 comments on commit 93507af

Please sign in to comment.