The following example shows how to use a ConfigMap.
apiVersion: v1 kind: ConfigMap metadata: name: cce-configmap data: SPECIAL_LEVEL: Hello SPECIAL_TYPE: CCE
For a ConfigMap data volume mounted in subPath mode, Kubernetes cannot automatically update data in the data volume when the ConfigMap is updated.
Using the CCE console
When creating a workload, click Environment Variables in the Container Settings area, and click Add Variable.
For example, after you import the value Hello of SPECIAL_LEVEL in ConfigMap cce-configmap as the value of workload environment variable SPECIAL_LEVEL, an environment variable named SPECIAL_LEVEL with its value Hello exists in the container.
After the workload runs properly, log in to the container and run the following statement to check whether the ConfigMap has been set as an environment variable of the workload:
printenv SPECIAL_LEVEL
The example output is as follows:
Hello
Using kubectl
vi nginx-configmap.yaml
Content of the YAML file:
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-configmap
spec:
replicas: 1
selector:
matchLabels:
app: nginx-configmap
template:
metadata:
labels:
app: nginx-configmap
spec:
containers:
- name: container-1
image: nginx:latest
envFrom: # Use envFrom to specify a ConfigMap to be referenced by environment variables.
- configMapRef:
name: cce-configmap # Name of the referenced ConfigMap.
imagePullSecrets:
- name: default-secret
apiVersion: apps/v1 kind: Deployment metadata: name: nginx-configmap spec: replicas: 1 selector: matchLabels: app: nginx-configmap template: metadata: labels: app: nginx-configmap spec: containers: - name: container-1 image: nginx:latest env: # Set the environment variable in the workload. - name: SPECIAL_LEVEL # Name of the environment variable in the workload. valueFrom: # Specify a ConfigMap to be referenced by the environment variable. configMapKeyRef: name: cce-configmap # Name of the referenced ConfigMap. key: SPECIAL_LEVEL # Key in the referenced ConfigMap. - name: SPECIAL_TYPE # Add multiple environment variables to import them at the same time. valueFrom: configMapKeyRef: name: cce-configmap key: SPECIAL_TYPE imagePullSecrets: - name: default-secret
kubectl apply -f nginx-configmap.yaml
kubectl get pod | grep nginx-configmap
nginx-configmap-*** 1/1 Running 0 2m18s
kubectl exec nginx-configmap-*** -- printenv SPECIAL_LEVEL SPECIAL_TYPE
Expected output:
Hello CCE
The ConfigMap has been set as environment variables of the workload.
You can use a ConfigMap as an environment variable to set commands or parameter values for a container by using the environment variable substitution syntax $(VAR_NAME).
Using the CCE console
When creating a workload, click Environment Variables in the Container Settings area, and click Add Variable. In this example, select Added from ConfigMap.
/bin/bash -c echo $SPECIAL_LEVEL $SPECIAL_TYPE > /usr/share/nginx/html/index.html
After the workload runs properly, log in to the container and run the following statement to check whether the ConfigMap has been set as an environment variable of the workload:
cat /usr/share/nginx/html/index.html
The example output is as follows:
Hello CCE
Using kubectl
vi nginx-configmap.yaml
apiVersion: apps/v1 kind: Deployment metadata: name: nginx-configmap spec: replicas: 1 selector: matchLabels: app: nginx-configmap template: metadata: labels: app: nginx-configmap spec: containers: - name: container-1 image: nginx:latest lifecycle: postStart: exec: command: [ "/bin/sh", "-c", "echo $SPECIAL_LEVEL $SPECIAL_TYPE > /usr/share/nginx/html/index.html" ] envFrom: # Use envFrom to specify a ConfigMap to be referenced by environment variables. - configMapRef: name: cce-configmap # Name of the referenced ConfigMap. imagePullSecrets: - name: default-secret
kubectl apply -f nginx-configmap.yaml
kubectl get pod | grep nginx-configmap
nginx-configmap-*** 1/1 Running 0 2m18s
kubectl exec nginx-configmap-*** -- cat /usr/share/nginx/html/index.html
Expected output:
Hello CCE
The data stored in a ConfigMap can be referenced in a volume of type ConfigMap. You can mount such a volume to a specified container path. The platform supports the separation of workload codes and configuration files. ConfigMap volumes are used to store workload configuration parameters. Before that, create ConfigMaps in advance. For details, see Creating a ConfigMap.
Using the CCE console
When creating a workload, click Data Storage in the Container Settings area. Click Add Volume and select ConfigMap from the drop-down list.
Parameter |
Description |
---|---|
ConfigMap |
Select the desired ConfigMap. A ConfigMap must be created beforehand. For details, see Creating a ConfigMap. |
Mount Path |
Enter a mount point. After the ConfigMap volume is mounted, a configuration file with the key as the file name and value as the file content is generated in the mount path of the container. This parameter specifies a container path to which a data volume will be mounted. Do not mount the volume to a system directory such as / or /var/run. This may lead to container errors. Mount the volume to an empty directory. If the directory is not empty, ensure that there are no files that affect container startup. Otherwise, the files will be replaced, which leads to a container startup failure or workload creation failure.
NOTICE:
If the container is mounted to a high-risk directory, use an account with minimum permissions to start the container. Otherwise, high-risk files on the host may be damaged. |
Subpath |
Enter a subpath of the mount path.
|
Permission |
Read-only, indicating that data volume in the path is read-only. |
After the workload runs properly, the SPECIAL_LEVEL and SPECIAL_TYPE files will be generated in the /etc/config directory in this example. The contents of the files are Hello and CCE, respectively.
Access the container and run the following statement to view the SPECIAL_LEVEL or SPECIAL_TYPE file in the container:
cat /etc/config/SPECIAL_LEVEL
Expected output:
Hello
Using kubectl
vi nginx-configmap.yaml
As shown in the following example, after the ConfigMap volume is mounted, a configuration file with the key as the file name and value as the file content is generated in the /etc/config directory of the container.
apiVersion: apps/v1 kind: Deployment metadata: name: nginx-configmap spec: replicas: 1 selector: matchLabels: app: nginx-configmap template: metadata: labels: app: nginx-configmap spec: containers: - name: container-1 image: nginx:latest volumeMounts: - name: config-volume mountPath: /etc/config # Mount to the /etc/config directory. readOnly: true volumes: - name: config-volume configMap: name: cce-configmap # Name of the referenced ConfigMap.
kubectl apply -f nginx-configmap.yaml
kubectl get pod | grep nginx-configmap
nginx-configmap-*** 1/1 Running 0 2m18s
kubectl exec nginx-configmap-*** -- cat /etc/config/SPECIAL_LEVEL
Expected output:
Hello