spring boot 使用 k8s 的 configMap 作为外部配置

Posted 2023-03-04

参考技术A

spring boot 应用以容器的方式运行在 k8s 集群上面是非常方便的，但是不同的环境需要不同的配置文件，我们可以使用外部的配置中心，比如 nacos 、 apollo 。 k8s 也提供了 configMap 用来将环境配置信息和容器镜像解耦，便于应用配置的修改。本文主要从以下几个方面介绍 spring boot 使用 k8s 的 configMap 作为外部配置的使用方法：

当应用程序启动时，Spring Boot 会自动从以下位置查找并加载 application.properties 和 application.yaml 文件。

配置文件优先级从高到底的顺序如下：

高优先级配置会覆盖低优先级配置

如果我们运行时想指定运行哪个环境的配置文件，可以有三种方式：

ConfigMap 是一种 API 对象，用来将非机密性的数据保存到键值对中。使用时 pod 可以将其用作环境变量、命令行参数或者存储卷中的配置文件。

创建 configMap 的几种方式：

从前面的介绍我们可以知道，spring boot 加载配置文件的最高优先级是 项目根路径下的 /config 子目录 ，所以可以将 configMap 中的配置文件挂载到容器中的项目根路径下的 config 子目录中。

当卷中使用的 configMap 被更新时，所投射的键最终也会被更新。 kubelet 组件会在每次周期性同步时检查所挂载的 configMap 是否为最新。 不过，kubelet 使用的是其本地的高速缓存来获得 configMap 的当前值。 高速缓存的类型可以通过 KubeletConfiguration 结构 的 ConfigMapAndSecretChangeDetectionStrategy 字段来配置。

configMap 既可以通过 watch 操作实现内容传播（默认形式），也可实现基于 TTL 的缓存，还可以直接经过所有请求重定向到 API 服务器。 因此，从 configMap 被更新的那一刻算起，到新的主键被投射到 Pod 中去，这一 时间跨度可能与 kubelet 的同步周期加上高速缓存的传播延迟相等。 这里的传播延迟取决于所选的高速缓存类型 （分别对应 watch 操作的传播延迟、高速缓存的 TTL 时长或者 0）。

以环境变量方式使用的 configMap 数据不会被自动更新，更新这些数据需要重新启动 Pod。

参考文档：

k8s 官网

spring boot 官网