Mounting ConfigMaps

To mount non-confidential configuration data into your workspaces, use Kubernetes ConfigMaps.

Using Kubernetes ConfigMaps, you can mount non-sensitive data such as configuration values for an application.

Mount Kubernetes ConfigMaps to the DevWorkspace containers in the Kubernetes cluster of your organization’s Che instance.

Prerequisites

An active kubectl session with administrative permissions to the destination Kubernetes cluster. See Overview of kubectl.
In your user namespace, you created a new ConfigMap or determined an existing ConfigMap to mount to all DevWorkspace containers.

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.

Procedure

Add the labels, which are required for mounting the ConfigMap, to the ConfigMap.

$ kubectl label configmap <ConfigMap_name> \
        controller.devfile.io/mount-to-devworkspace=true \
        controller.devfile.io/watch-configmap=true

Optional: Use the annotations to configure how the ConfigMap is mounted.

Table 1. Optional annotations
Annotation	Description
`controller.devfile.io/mount-path:`	Specifies the mount path. Defaults to `/etc/config/<ConfigMap_name>`.
`controller.devfile.io/mount-as:`	Specifies how the resource should be mounted: `file`, `subpath`, or `env`. Defaults to `file`. `mount-as:file` mounts the keys and values as files within the mount path. `mount-as:subpath` mounts the keys and values within the mount path using subpath volume mounts. `mount-as:env` mounts the keys and values as environment variables in all `DevWorkspace` containers.

Example 1. Mounting a ConfigMap as environment variables

kind: ConfigMap
apiVersion: v1
metadata:
  name: my-settings
  labels:
    controller.devfile.io/mount-to-devworkspace: 'true'
    controller.devfile.io/watch-configmap: 'true'
  annotations:
    controller.devfile.io/mount-as: env
data:
  <env_var_1>: <value_1>
  <env_var_2>: <value_2>

When you start a workspace, the <env_var_1> and <env_var_2> environment variables will be available in the DevWorkspace containers.