实战 K8s ConfigMap：打造动态可配置的云原生应用

🐇明明跟你说过：个人主页

🏅个人专栏：《Kubernetes航线图：从船长到K8s掌舵者》 🏅

🔖行路有良友，便是天堂🔖

一、前言

1、k8s简介

2、ConfigMap简介

二、ConfigMap的使用场景

1、环境变量配置

2、配置文件挂载

三、ConfigMap实践

1、ConfigMap YAML文件语法

2、与Pod的结合使用

3、ConfigMap的命名规范

四、ConfigMap核心价值总结

在上一章节中，我们讲述了configmap的介绍、定义、原理等，本期我们将详细介绍configmap在k8s中的实际应用

一、前言

1、k8s简介

Kubernetes单词起源于希腊语, 是“舵手”或者“领航员、飞行员”的意思。

Kubernetes（简称K8s）的前世今生可以追溯到谷歌（Google）内部的一个项目，它起源于2003年，当时谷歌正面临着不断增长的应用程序和服务的管理挑战。这个项目最初被称为"Borg"，是一个早期的容器编排系统。Borg 的成功经验成为 Kubernetes 开发的契机。

有关k8s起源的介绍，请参考《初识K8s之前世今生、架构、组件、前景》这篇文章

Kubernetes的优点包括可移植性、可伸缩性和扩展性。它使用轻型的YAML清单文件实现声明性部署方法，对于应用程序更新，无需重新构建基础结构。管理员可以计划和部署容器，根据需要扩展容器并管理其生命周期。借助Kubernetes的开放源代码API，用户可以通过首选编程语言、操作系统、库和消息传递总线来构建应用程序，还可以将现有持续集成和持续交付（CI/CD）工具集成。

2、ConfigMap简介

K8s的ConfigMap是一种用于存储配置数据的API对象，属于Kubernetes中的核心对象。它用于将应用程序的配置信息与容器镜像分离，以便在不重新构建镜像的情况下进行配置的修改和更新。ConfigMap可以存储键值对、文本文件或者以特定格式组织的配置文件，例如环境变量、命令行参数等。

ConfigMap的主要作用是提供一个集中管理和传递配置信息的机制，让应用程序能够从ConfigMap中获取配置数据。这样，在不修改容器镜像的前提下，可以根据需要动态地修改应用程序的配置参数。通过kubectl命令行工具或Kubernetes API，可以创建、更新和删除ConfigMap。

在使用K8s部署应用时，将配置信息写入代码会导致一个问题，即每次更新配置时都需要重新打包镜像。而ConfigMap则可以将配置信息和Docker镜像解耦，解决了这个问题。此外，在微服务架构中，多个服务可能共享相同的配置，使用ConfigMap可以方便地实现配置共享。

二、ConfigMap的使用场景

1、环境变量配置

ConfigMap 在 Kubernetes 中有多种使用场景，其中之一就是配置环境变量。通过将配置数据存储在 ConfigMap 中，可以轻松地将这些数据注入到 Pod 的容器中作为环境变量使用。

这样做的好处包括：

解耦配置与容器镜像: 将配置数据与容器镜像分离，使得容器镜像更加通用和可复用，而配置数据可以根据需要进行灵活调整。
动态配置: 可以在不重新构建容器镜像的情况下，通过更新 ConfigMap 来动态地更改容器的配置。
适用于不同环境: 可以为不同的环境（例如开发、测试、生产）创建不同的 ConfigMap，从而实现环境间配置的隔离和管理。

使用 ConfigMap 配置环境变量的一般步骤包括：

创建一个包含配置数据的 ConfigMap 对象，其中键值对代表了环境变量的名称和值。
在 Pod 的配置文件中，将 ConfigMap 挂载为一个卷。
配置容器镜像中的应用程序，使其使用 ConfigMap 中定义的环境变量。

下面是一个示例 YAML 文件，展示了如何在 Kubernetes 中使用 ConfigMap 配置环境变量：

apiVersion: v1
kind: ConfigMap
metadata:
  name: my-configmap
data:
  DATABASE_URL: "mysql://user:password@mysql-service:3306/mydatabase"
  API_KEY: "my-secret-api-key"

---

apiVersion: v1
kind: Pod
metadata:
  name: my-pod
spec:
  containers:
    - name: my-container
      image: my-image
      envFrom:
        - configMapRef:
            name: my-configmap

在这个示例中，my-configmap 是一个包含了 DATABASE_URL 和 API_KEY 两个键值对的 ConfigMap。然后，my-pod Pod 使用了这个 ConfigMap，并将其注入到了容器的环境变量中。

2、配置文件挂载

ConfigMap 在 Kubernetes 中的另一个常见用途是挂载配置文件。通过将配置文件存储在 ConfigMap 中，并将其挂载到 Pod 的文件系统中，可以实现对应用程序配置文件的动态更新，而无需重新启动容器。

使用 ConfigMap 挂载配置文件的一般步骤包括：

创建一个包含配置文件内容的 ConfigMap 对象，其中键值对代表了配置文件的文件名和内容。
在 Pod 的配置文件中，将 ConfigMap 挂载为一个卷，并指定挂载路径。
在容器的配置中，将配置文件路径指向挂载的卷中的文件。

下面是一个示例 YAML 文件，展示了如何在 Kubernetes 中使用 ConfigMap 挂载配置文件：

apiVersion: v1
kind: ConfigMap
metadata:
  name: my-configmap
data:
  app.properties: |
    key1=value1
    key2=value2
    key3=value3

---

apiVersion: v1
kind: Pod
metadata:
  name: my-pod
spec:
  containers:
    - name: my-container
      image: my-image
      volumeMounts:
        - name: config-volume
          mountPath: /etc/config
  volumes:
    - name: config-volume
      configMap:
        name: my-configmap

在这个示例中，my-configmap 是一个包含了 app.properties 键值对的 ConfigMap，其中包含了应用程序的配置文件内容。然后，my-pod Pod 使用了这个 ConfigMap，并将其挂载为一个卷到容器的 /etc/config 路径下。这样一来，应用程序就可以直接读取挂载的配置文件，而配置文件的内容可以通过更新 ConfigMap 来动态变更，无需重启容器。

三、ConfigMap实践

1、ConfigMap YAML文件语法

ConfigMap 的 YAML 文件语法与其他 Kubernetes 资源的 YAML 文件语法类似，主要包括以下几个部分：

apiVersion: 表示要使用的 Kubernetes API 版本。
kind: 表示要创建的资源类型，这里是 ConfigMap。
metadata: 元数据，包括资源的名称和其他属性。
data: 配置数据的键值对，可以包含多个键值对，每个键值对表示一个配置项。

下面是一个示例 ConfigMap 的 YAML 文件：

apiVersion: v1
kind: ConfigMap
metadata:
  name: example-configmap
data:
  key1: value1
  key2: value2
  key3: value3

在这个示例中，我们定义了一个名为 example-configmap 的 ConfigMap，其中包含了三个键值对，分别是 key1: value1、key2: value2 和 key3: value3。

2、与Pod的结合使用

在 Kubernetes 中，可以使用 ConfigMap 将配置文件挂载到 Pod 中，以便在容器内部使用。下面是一个示例 YAML 文件，用于创建一个使用 nginx 镜像的 Pod，并将配置文件通过 ConfigMap 挂载进去：

apiVersion: v1
kind: ConfigMap
metadata:
  name: nginx-config
data:
  nginx.conf: |
    server {
        listen       80;
        server_name  localhost;

        location / {
            root   /usr/share/nginx/html;
            index  index.html index.htm;
        }
    }
---
apiVersion: v1
kind: Pod
metadata:
  name: nginx-pod
spec:
  containers:
  - name: nginx-container
    image: nginx
    volumeMounts:
    - name: nginx-config-volume
      mountPath: /etc/nginx/nginx.conf
      subPath: nginx.conf
  volumes:
  - name: nginx-config-volume
    configMap:
      name: nginx-config

这个 YAML 文件定义了一个名为 nginx-config 的 ConfigMap，其中包含了一个 nginx.conf 的配置文件。然后定义了一个名为 nginx-pod 的 Pod，使用了 nginx 镜像，并通过 ConfigMap 将 nginx.conf 配置文件挂载到了容器内的 /etc/nginx/nginx.conf 路径下。

通过这种方式，Pod 内的 nginx 容器就可以使用 ConfigMap 中定义的配置文件来配置 nginx 服务器了。

3、ConfigMap的命名规范

ConfigMap 的命名规范通常遵循 Kubernetes 资源的命名规范，主要包括以下几点：

名称长度: ConfigMap 的名称应尽量简短，但要具有描述性，以便易于理解和识别。
字符集: 名称可以包含小写字母、数字和连字符（-）。
唯一性: 在同一个命名空间内，ConfigMap 的名称必须是唯一的，不允许存在重复的名称。
名称规范: 推荐使用有意义的名称，以反映 ConfigMap 存储的配置信息的用途或内容。

例如，如果 ConfigMap 存储了用于配置应用程序的信息，可以使用应用程序名称作为 ConfigMap 的一部分。以下是一个示例：

app-configmap

根据实际情况，您还可以在名称中添加其他信息，以进一步描述 ConfigMap 的内容。例如：

nginx-configmap
database-configmap

四、ConfigMap核心价值总结

配置集中管理: ConfigMap 允许将应用程序配置从容器镜像中分离出来，使得配置可以独立于容器进行管理。这样做可以降低容器镜像的耦合度，并更方便地管理和更新配置。
容器化应用程序的配置: 通过将配置信息存储在 ConfigMap 中，可以轻松地将这些配置注入到容器化的应用程序中。这样做可以使得应用程序更加灵活，并且更容易在不同环境中进行部署和运行。
动态配置更新: ConfigMap 中的配置可以随时更新，而不需要重新部署应用程序。这样可以实现动态配置更新，使得应用程序可以在不停止运行的情况下更新配置，提高了系统的可用性和灵活性。
与环境变量和卷挂载结合: ConfigMap 的配置可以通过环境变量或卷挂载的方式注入到容器中，从而实现容器内部的动态配置。这样可以使得应用程序可以轻松地访问配置信息，并且可以根据需要进行动态调整。
与其他资源的集成: ConfigMap 可以与其他 Kubernetes 资源进行集成，例如 Deployment、StatefulSet、DaemonSet 等。这样可以实现对整个应用程序的配置管理，使得应用程序的部署和运行更加便捷和可控。