Kubernetes ConfigMap 详解：配置与应用分离的最佳实践-CSDN博客

Kubernetes ConfigMap 详解：配置与应用分离的最佳实践

website Kubernetes website and documentation repo: 项目地址: https://gitcode.com/gh_mirrors/webs/website

什么是 ConfigMap

ConfigMap 是 Kubernetes 中一种用于存储非机密配置数据的 API 对象。它允许你将配置信息与容器镜像分离，从而实现配置的灵活管理和应用的可移植性。

ConfigMap 的主要特点包括：

以键值对形式存储配置数据
可以包含整个配置文件内容
支持 UTF-8 字符串和二进制数据
与 Pod 解耦，可以被多个 Pod 共享使用

重要安全提示：ConfigMap 不提供任何加密或保密功能，如果需要存储敏感信息，请使用 Secret 对象。

为什么需要 ConfigMap

配置与代码分离

在现代应用开发中，配置与代码分离是一个重要原则。ConfigMap 允许你将应用配置从容器镜像中抽离出来，这样你可以：

使用相同的容器镜像在不同环境（开发、测试、生产）中运行
通过修改 ConfigMap 来改变应用行为，而无需重新构建镜像
更安全地管理配置变更，减少因配置错误导致的部署问题

多环境适配示例

假设你开发的应用需要连接数据库，在开发环境中使用 localhost 作为数据库地址，而在生产环境中使用 Kubernetes Service。通过 ConfigMap，你可以：

在开发环境的 ConfigMap 中设置 DATABASE_HOST=localhost
在生产环境的 ConfigMap 中设置 DATABASE_HOST=production-db-service
应用代码始终读取 DATABASE_HOST 环境变量，无需为不同环境修改代码

ConfigMap 对象详解

数据结构

ConfigMap 使用两个主要字段存储数据：

data：用于存储 UTF-8 字符串

data:
  game.properties: |
    enemy.types=aliens,monsters
    player.maximum-lives=5

binaryData：用于存储 base64 编码的二进制数据
```
binaryData:
  secret.bin: <base64 encoded data>
```

命名规则

名称必须是合法的 DNS 子域名
键名只能包含字母数字字符、-、_ 或 .
data 和 binaryData 中的键不能重复

不可变 ConfigMap

从 Kubernetes v1.19 开始，你可以创建不可变的 ConfigMap：

immutable: true

不可变 ConfigMap 的优势：

防止意外修改导致应用中断
减少 API 服务器负载，提高集群性能
特别适合大规模集群中使用

在 Pod 中使用 ConfigMap

ConfigMap 可以通过四种方式在 Pod 中使用：

1. 作为环境变量

将 ConfigMap 的值注入为容器环境变量：

env:
- name: PLAYER_LIVES
  valueFrom:
    configMapKeyRef:
      name: game-config
      key: player_initial_lives

2. 作为命令行参数

通过环境变量间接将 ConfigMap 值作为容器启动参数：

args:
- "--lives=$(PLAYER_LIVES)"
env:
- name: PLAYER_LIVES
  valueFrom:
    configMapKeyRef:
      name: game-config
      key: player_initial_lives

3. 作为卷挂载

将 ConfigMap 作为文件挂载到容器中：

volumes:
- name: config-volume
  configMap:
    name: game-config
volumeMounts:
- name: config-volume
  mountPath: /etc/config

4. 通过 Kubernetes API 直接读取

应用代码可以直接调用 Kubernetes API 读取 ConfigMap，这种方式最灵活但需要编写更多代码。

最佳实践与注意事项

大小限制：单个 ConfigMap 不能超过 1MiB，大配置应考虑使用卷或外部存储
热更新：
- 作为卷挂载的 ConfigMap 会自动更新（有一定延迟）
- 作为环境变量的 ConfigMap 需要重启 Pod 才能更新
命名空间：ConfigMap 与使用它的 Pod 必须在同一命名空间
不可变 ConfigMap：生产环境建议使用，可提高稳定性
配置验证：在应用代码中添加配置验证逻辑

实际应用示例

游戏服务器配置

apiVersion: v1
kind: ConfigMap
metadata:
  name: game-config
data:
  # 简单键值
  difficulty: "hard"
  max_players: "8"
  
  # 配置文件内容
  game.properties: |
    enemy.types=aliens,monsters
    player.maximum-lives=5
    level.difficulty=hard

使用该 ConfigMap 的 Pod

apiVersion: v1
kind: Pod
metadata:
  name: game-server
spec:
  containers:
  - name: server
    image: game-server:1.0
    env:
    - name: DIFFICULTY
      valueFrom:
        configMapKeyRef:
          name: game-config
          key: difficulty
    volumeMounts:
    - name: config-volume
      mountPath: /etc/game
  volumes:
  - name: config-volume
    configMap:
      name: game-config
      items:
      - key: "game.properties"
        path: "game.properties"