Kubernetes ConfigMap 实战指南

精选原创

IvwDcwSo 2023-12-20 14:55:20 博主文章分类：云原生 ©著作权

文章标签 ConfigMap k8s 云原生配置管理解耦 文章分类 运维 yyds干货盘点

©著作权归作者所有：来自51CTO博客作者IvwDcwSo的原创作品，请联系作者获取转载授权，否则将追究法律责任

ConfigMap 是 Kubernetes 中一种用于存储配置信息的资源对象，它允许您将配置与应用程序解耦，轻松管理和更新配置。在这个实战指南中，我们将涵盖创建、更新、删除 ConfigMap，并探讨其原理、优点、不足。最后，我们将通过一个实际案例演示如何在 Node.js 应用程序中使用 ConfigMap。

ConfigMap 的原理、优点和不足

ConfigMap 原理

ConfigMap 的原理基于 Kubernetes 提供的键值对存储机制。它将配置数据存储为键值对，并以 API 对象的形式存在于 Kubernetes 集群中。Pod 在需要使用 ConfigMap 中的配置数据时，可以通过卷挂载或环境变量的方式将配置数据注入到 Pod 内部。

ConfigMap 优点

解耦配置和应用程序： ConfigMap 允许将配置数据与应用程序分离，使得配置的变更不会影响应用程序的代码。这提高了配置的灵活性和可维护性。
共享相同的应用程序镜像： 通过在不同环境中使用相同的应用程序镜像，但使用不同的 ConfigMap 进行配置，可以轻松实现跨多个环境的部署，减少了维护成本。
动态更新配置： ConfigMap 支持动态更新，可以在运行中的 Pod 中实时应用配置的变更，而不需要重新启动 Pod。

ConfigMap 不足

不适用于敏感数据： ConfigMap 存储的配置数据不加密，不适用于存储敏感数据，如密码和密钥等。对于敏感数据的存储，建议使用 Kubernetes 的 Secret 对象。
无法实时监控配置变更： 虽然支持动态更新，但 ConfigMap 无法实时监控配置变更。需要应用程序内部实现相应的机制来检测配置的变更并重新加载。

通过深入理解 ConfigMap 的原理、优点和不足，我们能更好地利用这一 Kubernetes 资源对象，实现应用程序配置的灵活管理和可配置化部署。希望这个实战指南对您的 Kubernetes 部署和配置管理有所帮助。

创建 ConfigMap

通过 YAML 文件创建 ConfigMap

首先，我们可以通过一个简单的 YAML 文件创建 ConfigMap。假设我们有一个应用程序需要以下配置信息：

数据库连接字符串: mongodb://mongo-server:27017/mydatabase
API 密钥: my-api-key

apiVersion: v1
kind: ConfigMap
metadata:
  name: my-app-config
data:
  database-url: "mongodb://mongo-server:27017/mydatabase"
  api-key: "my-api-key"

保存上述 YAML 为 configmap.yaml 文件，并通过以下命令将其应用到 Kubernetes 集群：

kubectl apply -f configmap.yaml

使用 kubectl 命令创建 ConfigMap

另一种创建 ConfigMap 的方式是使用 kubectl create configmap 命令：

kubectl create configmap my-app-config --from-literal=database-url=mongodb://mongo-server:27017/mydatabase --from-literal=api-key=my-api-key

这样，我们就创建了一个名为 my-app-config 的 ConfigMap，并添加了数据库连接信息和 API 密钥。

在 Pod 中使用 ConfigMap

通过卷挂载方式使用 ConfigMap

在 Pod 中使用 ConfigMap 最常见的方式之一是通过卷挂载。以下是一个 Pod 的 YAML 示例，演示了如何将 ConfigMap 挂载到容器内部：

apiVersion: v1
kind: Pod
metadata:
  name: mypod
spec:
  containers:
  - name: mycontainer
    image: my-app-image
    volumeMounts:
    - name: config-volume
      mountPath: /etc/config
  volumes:
  - name: config-volume
    configMap:
      name: my-app-config

这个示例中，我们创建了一个名为 mypod 的 Pod，其中包含了一个名为 mycontainer 的容器。我们通过卷挂载的方式将 ConfigMap 挂载到容器内部的 /etc/config 目录下，使应用程序可以读取配置文件。

通过环境变量方式使用 ConfigMap

另一种常见的方式是通过环境变量注入配置。以下是相应的 Pod YAML 示例：

apiVersion: v1
kind: Pod
metadata:
  name: mypod
spec:
  containers:
  - name: mycontainer
    image: my-app-image
    envFrom:
    - configMapRef:
        name: my-app-config

这个示例中，我们使用了 envFrom 字段，通过环境变量的方式注入 ConfigMap 中的所有键值对。这使得应用程序可以通过环境变量直接访问配置信息。

更新和删除 ConfigMap

要更新 ConfigMap，可以通过修改 ConfigMap 对象的 YAML 文件或使用 kubectl create configmap 命令。例如，通过命令行动态更新 ConfigMap 中的数据：

kubectl create configmap my-app-config --from-literal=database-url=mongodb://new-server:27017/mydatabase --dry-run=client -o yaml | kubectl apply -f -

要删除 ConfigMap，可以使用 kubectl delete configmap 命令：

kubectl delete configmap my-app-config

在 Java、Python、Node.js 应用程序中使用 ConfigMap

创建 Java 应用程序 Deployment

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-java-app
spec:
  replicas: 1
  selector:
    matchLabels:
      app: my-java-app
  template:
    metadata:
      labels:
        app: my-java-app
    spec:
      containers:
      - name: my-container
        image: my-java-app-image
        volumeMounts:
        - name: config-volume
          mountPath: /etc/config
      env:
        - name: DATABASE_URL
          valueFrom:
            configMapKeyRef:
              name: my-app-config
              key: database-url
        - name: API_KEY
          valueFrom:
            configMapKeyRef:
              name: my-app-config
              key: api-key
      volumes:
      - name: config-volume
        configMap:
          name: my-app-config

创建 Python 应用程序 Deployment

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-python-app
spec:
  replicas: 1
  selector:
    matchLabels:
      app: my-python-app
  template:
    metadata:
      labels:
        app: my-python-app
    spec:
      containers:
      - name: my-container
        image: my-python-app-image
        volumeMounts:
        - name: config-volume
          mountPath: /etc/config
      env:
        - name: DATABASE_URL
          valueFrom:
            configMapKeyRef:
              name: my-app-config
              key: database-url
        - name: API_KEY
          valueFrom:
            configMapKeyRef:
              name: my-app-config
              key: api-key
      volumes:
      - name: config-volume
        configMap:
          name: my-app-config

创建 Node.js 应用程序 Deployment

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-nodejs-app
spec:
  replicas: 1
  selector:
    matchLabels:
      app: my-nodejs-app
  template:
    metadata:
      labels:
        app: my-nodejs-app
    spec:
      containers:
      - name: my-container
        image: my-nodejs-app-image
        volumeMounts:
        - name: config-volume
          mountPath: /etc/config
      env:
        - name: DATABASE_URL
          valueFrom:
            configMapKeyRef:
              name: my-app-config
              key: database-url
        - name: API_KEY
          valueFrom:
            configMapKeyRef:
              name: my-app-config
              key: api-key
      volumes:
      - name: config-volume
        configMap:
          name: my-app-config

这些 Deployment 文件为 Java、Python 和 Node.js 应用程序创建了容器，并通过卷挂载的方式将 ConfigMap 中的配置信息注入到 /etc/config 目录下。此外，通过环境变量的方式将 ConfigMap 中的配置信息传递给应用程序。

Java 应用程序中读取配置

// MyJavaApp.java
String databaseUrl = System.getenv("DATABASE_URL");
String apiKey = System.getenv("API_KEY");

// 使用配置信息连接数据库等操作

Python 应用程序中读取配置

# my_python_app.py
import os

database_url = os.environ.get("DATABASE_URL")
api_key = os.environ.get("API_KEY")

# 使用配置信息连接数据库等操作

Node.js 应用程序中读取配置

// index.js (Node.js application)
const databaseUrl = process.env.DATABASE_URL;
const apiKey = process.env.API_KEY;

// 使用配置信息连接数据库等操作

以上代码展示了在 Java、Python 和 Node.js 应用程序中如何通过环境变量的方式获取 ConfigMap 中的配置信息。通过这种方式，应用程序能够轻松读取 ConfigMap 中的配置，实现了配置和应用程序的解耦。这提高了应用程序的灵活性和可维护性，使得配置变更不再需要修改应用程序代码。