Springboot整合Spring Cloud Kubernetes读取ConfigMap支持自动刷新配置的教程
1 前言
欢迎访问获取更多精彩文章!
docker & kubernetes相关文章:
之前介绍了spring cloud config
的用法,但对于kubernetes
应用,可能会需要读取configmap
的配置,我们看看springboot
是如何方便地读取configmap
和secret
。
2 整合spring cloud kubenetes
spring cloud kubernetes提供了spring cloud
应用与kubernetes
服务关联,我们也可以自己写java
程序来获取kubernetes
的特性,但spring
又为我们做了。
2.1 项目代码
引入依赖:
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-web</artifactid> </dependency> <dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-kubernetes-config</artifactid> </dependency>
只需要springboot web
和spring cloud kubernetes config
即可,很简单。
springboot
启动类:
@springbootapplication public class configmapmain { public static void main(string[] args) { springapplication.run(configmapmain.class, args); } }
准备一个endpoint
来展示所读到的配置信息:
@restcontroller public class pkslowcontroller { @value("${pkslow.age:0}") private integer age; @value("${pkslow.email:null}") private string email; @value("${pkslow.website:null}") private string website; @value("${pkslow.password:null}") private string password; @getmapping("/pkslow") public map<string, string> getconfig() { map<string, string> map = new hashmap<>(); map.put("age", age.tostring()); map.put("email", email); map.put("website", website); map.put("password", password); return map; } }
默认是为空的,password
是从secret
读取,其它从configmap
读取。
应用的配置文件如下:
server: port: 8080 spring: application: name: spring-cloud-kubernetes-configmap cloud: kubernetes: config: name: spring-cloud-kubernetes-configmap
这里的spring.cloud.kubernetes.config.name
是重点,后续要通过它来找configmap
。
加密密码:
$ echo -n "pkslow-pass" | base64 cgtzbg93lxbhc3m=
创建kubernetes secret
:
kind: secret apiversion: v1 metadata: name: spring-cloud-kubernetes-secret namespace: default data: pkslow.password: cgtzbg93lxbhc3m= type: opaque
configmap
的内容如下:
kind: configmap apiversion: v1 metadata: name: spring-cloud-kubernetes-configmap namespace: default labels: app: scdf-server data: application.yaml: |- pkslow: age: 19 email: admin@pkslow.com website: www.pkslow.com
要注意的是,这里的名字与前面配置的是一致的,都是spring-cloud-kubernetes-configmap
。
接着完成dockerfile
和k8s
部署文件就可以了。注意要将secret
的值映射到环境变量:
env: - name: pkslow_password valuefrom: secretkeyref: name: spring-cloud-kubernetes-secret key: pkslow.password
2.2 启动与测试
应用会在启动时就去kubernetes
找相应的configmap
和secret
:
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: spring boot :: (v2.2.5.release)
2020-08-25 00:13:17.374 info 7 --- [ main] b.c.propertysourcebootstrapconfiguration : located property source: compositepropertysource {name='composite-configmap', propertysources=[configmappropertysource {name='configmap.spring-cloud-kubernetes-configmap.default'}]}
访问spring-cloud-kubernetes-configmap.localhost/pkslow
,可以正确读取配置,configmap
和secret
的内容都获取到了:
3 自动刷新配置
3.1 原理介绍与代码变更
我们需要在web
运行过程中修改配置并使配置生效,有多种模式。修改配置文件如下:
server: port: 8080 spring: application: name: spring-cloud-kubernetes-configmap cloud: kubernetes: config: name: spring-cloud-kubernetes-configmap namespace: default secrets: name: spring-cloud-kubernetes-secret namespace: default enabled: true reload: enabled: true monitoring-config-maps: true monitoring-secrets: true strategy: restart_context mode: event management: endpoint: restart: enabled: true endpoints: web: exposure: include: restart
(1) spring.cloud.kubernetes.reload.enabled=true
需要打开刷新功能;
(2) 加载策略strategy
:
-
refresh
:只对特定的配置生效,有注解@configurationproperties
或@refreshscope
。 -
restart_context
:整个spring context
会优雅重启,里面的所有配置都会重新加载。
需要打开actuator endpoint
,所以要配置management.endpoint
。还要增加依赖:
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-actuator</artifactid> </dependency> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-actuator-autoconfigure</artifactid> </dependency>
shutdown
:重启容器。
(3)模式mode
- 事件
event
:会通过k8s api
监控configmap
的变更,读取配置并生效。 -
polling
:定期查看是否有变化,有变化则触发,默认为15秒。
3.2 测试
我们修改一下configmap
的配置,并更新到k8s
。
$ kubectl apply -f src/main/k8s/config.yaml configmap/spring-cloud-kubernetes-configmap configured
查看发现age
和email
都修改了:
我们查看一下pod
的日志如下:
springboot
先是检测到了configmap
有了变更,然后触发context
重启。
4 总结
spring cloud kubernetes
为我们提供了不少spring cloud
整合kubernetes
的特性,可以引入使用。
到此这篇关于springboot整合spring cloud kubernetes读取configmap支持自动刷新配置的文章就介绍到这了,更多相关springboot整合spring cloud kubernetes内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!