K8s ConfigMap 使用：配置信息与容器分离

各位观众老爷，各位技术大咖，各位屏幕前的靓仔靓女们，大家好！我是你们的老朋友，人称“代码诗人”的李白（虽然我写的是Java，不是诗😂）。今天咱们不聊风花雪月，咱们聊聊在 Kubernetes 这个云原生宇宙中，如何优雅地管理咱们的配置信息，让我们的容器像个听话的小乖乖，而不是一个动不动就罢工的熊孩子。

今天的主题是：K8s ConfigMap 使用：配置信息与容器分离，让你的应用不再闹脾气！

想象一下，你精心编写了一个应用，代码写的行云流水，逻辑清晰明了。但是！但是！当你要把它部署到不同的环境中（开发、测试、生产），你发现你需要修改大量的配置信息，比如数据库连接地址、API密钥、日志级别等等。

如果你直接把这些配置信息硬编码到你的代码里，那简直就是一场灾难！🤯 每次修改配置，你都要重新打包镜像，重新部署，简直是让人崩溃。这就像你买了辆豪车，但是每次换个城市，都要把发动机拆了重新组装一样，简直是脱裤子放屁，多此一举！

这时候，ConfigMap 就如同救世主一般闪亮登场了！它就像一个配置信息的百宝箱，可以将配置信息与容器解耦，让你的应用更加灵活、可维护。

一、什么是 ConfigMap？（ConfigMap 究竟是何方神圣？）

ConfigMap，顾名思义，就是用来存储配置信息的。它是一个 Kubernetes 对象，可以用来存储键值对、配置文件等数据。你可以把 ConfigMap 想象成一个字典，里面存储着各种配置信息，你的容器可以通过多种方式来访问这些配置信息。

官方定义： ConfigMap 将配置数据与应用程序代码解耦，从而提高了应用程序的可移植性和可重用性。

用更通俗的话来说，ConfigMap 就像一个快递，里面装着你的应用需要的各种配置信息。你的应用只需要知道快递的地址（ConfigMap 的名称），就可以轻松地拿到里面的配置信息，而不需要关心这些配置信息是怎么来的，存放在哪里。

二、ConfigMap 的特点（ConfigMap 有什么过人之处？）

ConfigMap 拥有诸多优点，让它在配置管理方面独领风骚：

• 解耦性强： 将配置信息与应用程序代码解耦，使得应用程序更加灵活、可维护。
• 可移植性高： 可以在不同的环境中轻松地部署应用程序，只需要修改 ConfigMap 中的配置信息即可。
• 易于管理： 可以使用 Kubernetes 的各种工具来管理 ConfigMap，比如 kubectl、Helm 等。
• 版本控制： ConfigMap 可以进行版本控制，方便回滚到之前的配置。
• 安全性高： 可以使用 Kubernetes 的 RBAC 机制来控制对 ConfigMap 的访问权限。

简单来说，ConfigMap 就是一个让你的应用不再闹脾气，让你的运维工作更加轻松的利器！

三、ConfigMap 的创建方式（ConfigMap 怎么才能到碗里来？）

创建 ConfigMap 的方式有很多种，就像通往罗马的路一样，条条大路通 ConfigMap。

1. 使用 kubectl create configmap 命令

   这是最简单快捷的方式，就像直接在命令行敲几个字，ConfigMap 就诞生了。

   • 从字面值创建：

     kubectl create configmap my-config --from-literal=key1=value1 --from-literal=key2=value2

     这个命令会创建一个名为 my-config 的 ConfigMap，其中包含两个键值对：key1=value1 和 key2=value2。

     你可以想象成你在命令行上直接写了两张小纸条，贴到了 ConfigMap 这个百宝箱里。

   • 从文件创建：

     kubectl create configmap my-config --from-file=myfile.properties

     这个命令会创建一个名为 my-config 的 ConfigMap，其中包含 myfile.properties 文件中的内容。

     这就像你把一个写满了配置信息的文件，直接扔到了 ConfigMap 这个百宝箱里。

     myfile.properties 的内容可以是这样的：

     database.url=jdbc:mysql://localhost:3306/mydb
     database.username=admin
     database.password=password

   • 从目录创建：

     kubectl create configmap my-config --from-file=config-files/

     这个命令会创建一个名为 my-config 的 ConfigMap，其中包含 config-files 目录下的所有文件。每个文件都会成为 ConfigMap 中的一个键值对，文件名作为键，文件内容作为值。

     这就像你把一个装满了配置文件的文件夹，一股脑地塞到了 ConfigMap 这个百宝箱里。

2. 使用 YAML 文件

   YAML 文件是一种常用的配置文件格式，它具有可读性强、易于编写等优点。

   创建一个名为 my-config.yaml 的文件，内容如下：

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: my-config
   data:
     database.url: jdbc:mysql://localhost:3306/mydb
     database.username: admin
     database.password: password
     application.properties: |
       # This is an example of a multi-line property
       logging.level.root=INFO
       server.port=8080

   然后使用 kubectl apply 命令创建 ConfigMap：

   kubectl apply -f my-config.yaml

   这种方式更加灵活，你可以使用 YAML 文件的各种特性来定义 ConfigMap。

   表格总结：创建 ConfigMap 的方式

   方式	命令/示例	说明
   kubectl create字面值	kubectl create configmap my-config --from-literal=key1=value1 --from-literal=key2=value2	从命令行直接创建键值对。
   kubectl create 文件	kubectl create configmap my-config --from-file=myfile.properties	从文件中读取配置信息。
   kubectl create 目录	kubectl create configmap my-config --from-file=config-files/	从目录下的所有文件中读取配置信息。
   YAML 文件	yaml apiVersion: v1 kind: ConfigMap metadata: name: my-config data: database.url: jdbc:mysql://localhost:3306/mydb database.username: admin database.password: password application.properties: | # This is an example of a multi-line property logging.level.root=INFO server.port=8080 kubectl apply -f my-config.yaml	使用 YAML 文件定义 ConfigMap，更加灵活，可以定义多行字符串等复杂配置。

四、在 Pod 中使用 ConfigMap（ConfigMap 怎么才能发挥作用？）

有了 ConfigMap，接下来就要让我们的 Pod 能够使用它。就像你有了快递，总得送到收货人手里才行。

1. 作为环境变量

   这是最常用的方式，就像把配置信息注入到你的应用中，让它随时可用。

   在 Pod 的 YAML 文件中，通过 env 字段引用 ConfigMap：

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-pod
   spec:
     containers:
       - name: my-container
         image: my-image
         env:
           - name: DATABASE_URL
             valueFrom:
               configMapKeyRef:
                 name: my-config
                 key: database.url
           - name: DATABASE_USERNAME
             valueFrom:
               configMapKeyRef:
                 name: my-config
                 key: database.username

   在这个例子中，我们定义了两个环境变量：DATABASE_URL 和 DATABASE_USERNAME。它们的值分别来自 my-config ConfigMap 中的 database.url 和 database.username 键。

   你的应用可以通过读取这两个环境变量来获取数据库连接信息。

   优点： 使用简单，易于理解。

   缺点： 只能传递单个键值对，对于复杂的配置文件不太方便。

2. 作为 Volume 挂载

   这种方式更加灵活，可以将 ConfigMap 中的所有数据挂载到容器的文件系统中，就像把整个百宝箱都搬到了你的容器里。

   在 Pod 的 YAML 文件中，通过 volumes 和 volumeMounts 字段引用 ConfigMap：

   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-config

   在这个例子中，我们将 my-config ConfigMap 挂载到了容器的 /etc/config 目录下。ConfigMap 中的每个键值对都会成为 /etc/config 目录下的一个文件，键作为文件名，值作为文件内容。

   例如，如果 my-config ConfigMap 中包含 database.url 键，那么容器中就会有一个文件 /etc/config/database.url，其内容为 jdbc:mysql://localhost:3306/mydb。

   你的应用可以通过读取这些文件来获取配置信息。

   优点： 可以传递复杂的配置文件，方便应用程序读取。

   缺点： 需要应用程序修改代码来读取文件，不如环境变量方便。

3. 作为命令行参数

   这种方式比较少见，但有时候也很有用。就像把配置信息直接写在命令里，简单粗暴。

   在 Pod 的 YAML 文件中，通过 command 字段引用 ConfigMap：

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-pod
   spec:
     containers:
       - name: my-container
         image: my-image
         command: ["/bin/my-app", "--database-url=$(DATABASE_URL)"]
         env:
           - name: DATABASE_URL
             valueFrom:
               configMapKeyRef:
                 name: my-config
                 key: database.url

   在这个例子中，我们将 database.url 的值作为命令行参数传递给应用程序。

   优点： 简单直接，适用于一些简单的配置场景。

   缺点： 不灵活，不适用于复杂的配置场景。

表格总结：在 Pod 中使用 ConfigMap 的方式

方式	YAML 示例	说明
环境变量	yaml apiVersion: v1 kind: Pod metadata: name: my-pod spec: containers: - name: my-container image: my-image env: - name: DATABASE_URL valueFrom: configMapKeyRef: name: my-config key: database.url - name: DATABASE_USERNAME valueFrom: configMapKeyRef: name: my-config key: database.username	将 ConfigMap 中的键值对作为环境变量传递给容器。
Volume 挂载	yaml 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-config	将 ConfigMap 中的所有数据挂载到容器的文件系统中，每个键值对都会成为目录下的一个文件。
命令行参数	yaml apiVersion: v1 kind: Pod metadata: name: my-pod spec: containers: - name: my-container image: my-image command: ["/bin/my-app", "--database-url=$(DATABASE_URL)"] env: - name: DATABASE_URL valueFrom: configMapKeyRef: name: my-config key: database.url	将 ConfigMap 中的值作为命令行参数传递给应用程序。

五、ConfigMap 的更新与热加载（ConfigMap 也需要与时俱进！）

配置信息并不是一成不变的，有时候我们需要修改配置，比如修改数据库连接地址、更新 API 密钥等等。ConfigMap 支持更新，并且可以实现热加载，让你的应用在运行时自动加载新的配置，而不需要重启。

1. 更新 ConfigMap

   你可以使用 kubectl edit 命令或者修改 YAML 文件来更新 ConfigMap。

   例如，使用 kubectl edit 命令修改 my-config ConfigMap：

   kubectl edit configmap my-config

   这会打开一个编辑器，你可以修改 ConfigMap 的内容，保存后 Kubernetes 会自动更新 ConfigMap。

2. 热加载

   热加载是指当 ConfigMap 更新时，应用程序能够自动加载新的配置，而不需要重启。

   • 环境变量方式： Kubernetes 会自动更新环境变量，但是应用程序需要监听环境变量的变化，并重新加载配置。

   • Volume 挂载方式： Kubernetes 会自动更新挂载的 ConfigMap，应用程序需要监听文件系统的变化，并重新读取配置文件。

   不同的编程语言和框架都有不同的方式来实现热加载，比如 Spring Boot 可以使用 @ConfigurationProperties 和 @RefreshScope 注解来实现配置的热加载。

   总而言之，ConfigMap 的更新和热加载可以让你的应用更加灵活，能够适应不断变化的环境。

六、ConfigMap 的最佳实践（ConfigMap 怎么才能用得更好？）

• 不要在 ConfigMap 中存储敏感信息： ConfigMap 默认是以明文存储的，不适合存储敏感信息，比如密码、密钥等。对于敏感信息，应该使用 Kubernetes Secrets。

• 使用合适的命名规范： 为 ConfigMap 使用清晰的命名规范，方便管理和维护。

• 尽量使用 Volume 挂载方式： Volume 挂载方式更加灵活，可以传递复杂的配置文件，方便应用程序读取。

• 考虑使用配置管理工具： 对于复杂的配置管理需求，可以考虑使用配置管理工具，比如 Helm、Kustomize 等。

七、ConfigMap 的常见问题与解决方案（ConfigMap 也会遇到麻烦！）

• Pod 无法读取 ConfigMap： 检查 ConfigMap 的名称是否正确，以及 Pod 中对 ConfigMap 的引用是否正确。

• ConfigMap 更新后，Pod 没有自动加载新的配置： 检查应用程序是否实现了热加载机制。

• ConfigMap 中的中文乱码： 确保 ConfigMap 的编码格式是 UTF-8。

总结（画上一个完美的句号！）

ConfigMap 是 Kubernetes 中一个非常重要的对象，它可以将配置信息与应用程序代码解耦，让你的应用更加灵活、可维护。掌握 ConfigMap 的使用方法，可以让你在 Kubernetes 的世界里游刃有余，轻松应对各种配置管理需求。

好了，今天的分享就到这里，希望能够帮助到大家。如果大家有什么问题，欢迎在评论区留言，我会尽力解答。

感谢大家的观看，下次再见！👋 (别忘了点赞，关注，投币哦！)