Springboot整合Spring Cloud Kubernetes讀取ConfigMap支持自動(dòng)刷新配置的教程

1 前言

歡迎訪問南瓜慢說(shuō) www.pkslow.com獲取更多精彩文章！

Docker & Kubernetes相關(guān)文章：容器技術(shù)

之前介紹了Spring Cloud Config的用法，但對(duì)于Kubernetes應(yīng)用，可能會(huì)需要讀取ConfigMap的配置，我們看看Springboot是如何方便地讀取ConfigMap和Secret。

2 整合Spring Cloud Kubenetes

Spring Cloud Kubernetes提供了Spring Cloud應(yīng)用與Kubernetes服務(wù)關(guān)聯(lián)，我們也可以自己寫Java程序來(lái)獲取Kubernetes的特性，但Spring又為我們做了。

2.1 項(xiàng)目代碼

引入依賴：

<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即可，很簡(jiǎn)單。

Springboot啟動(dòng)類：

@SpringBootApplication
public class ConfigMapMain {
  public static void main(String[] args) {
    SpringApplication.run(ConfigMapMain.class, args);
  }
}

準(zhǔn)備一個(gè)EndPoint來(lái)展示所讀到的配置信息：

@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;
  }
}

默認(rèn)是為空的，password是從Secret讀取，其它從ConfigMap讀取。

應(yīng)用的配置文件如下：

server:
 port: 8080
spring:
 application:
  name: spring-cloud-kubernetes-configmap
 cloud:
  kubernetes:
   config:
    name: spring-cloud-kubernetes-configmap

這里的spring.cloud.kubernetes.config.name是重點(diǎn)，后續(xù)要通過(guò)它來(lái)找ConfigMap。

加密密碼：

$ echo -n "pkslow-pass" | base64 
cGtzbG93LXBhc3M=

創(chuàng)建Kubernetes Secret：

kind: Secret
apiVersion: v1
metadata:
 name: spring-cloud-kubernetes-secret
 namespace: default
data:
 pkslow.password: cGtzbG93LXBhc3M=
type: Opaque

ConfigMap的內(nèi)容如下：

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的值映射到環(huán)境變量：

env:
	- name: PKSLOW_PASSWORD
		valueFrom:
			secretKeyRef:
				name: spring-cloud-kubernetes-secret
				key: pkslow.password

2.2 啟動(dòng)與測(cè)試

應(yīng)用會(huì)在啟動(dòng)時(shí)就去Kubernetes找相應(yīng)的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的內(nèi)容都獲取到了：

3 自動(dòng)刷新配置

3.1 原理介紹與代碼變更

我們需要在Web運(yùn)行過(guò)程中修改配置并使配置生效，有多種模式。修改配置文件如下：

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：只對(duì)特定的配置生效，有注解@ConfigurationProperties 或 @RefreshScope。
• restart_context：整個(gè)Spring Context會(huì)優(yōu)雅重啟，里面的所有配置都會(huì)重新加載。

需要打開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：會(huì)通過(guò)k8s API監(jiān)控ConfigMap的變更，讀取配置并生效。
• Polling：定期查看是否有變化，有變化則觸發(fā)，默認(rèn)為15秒。

3.2 測(cè)試

我們修改一下ConfigMap的配置，并更新到K8s。

$ kubectl apply -f src/main/k8s/config.yaml 
configmap/spring-cloud-kubernetes-configmap configured

查看發(fā)現(xiàn)age和email都修改了：

我們查看一下Pod的日志如下：

Springboot先是檢測(cè)到了ConfigMap有了變更，然后觸發(fā)Context重啟。

4 總結(jié)

Spring Cloud Kubernetes為我們提供了不少Spring Cloud整合Kubernetes的特性，可以引入使用。

到此這篇關(guān)于Springboot整合Spring Cloud Kubernetes讀取ConfigMap支持自動(dòng)刷新配置的文章就介紹到這了,更多相關(guān)Springboot整合Spring Cloud Kubernetes內(nèi)容請(qǐng)搜索億速云以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持億速云！