一. 背景

在生产环境中，一个app服务处于工作中的状态，此时如果需要临时替换某些配置信息，如数据库连接池大小，链接等，一般都需要在源码端修改配置信息，然后重新部署，可想而知，这样做会影响用户或者其他与其对接的app服务。有没有可以在不重启应用的情况下就可以修改配置信息呢？答案是肯定。
达到热更新的方案还是很多的，如果是java体系，spring-cloud已经为我们提供的一套方案，即spring-cloud-config，本文就不做介绍了。
spring-cloud-kubernetes是springcloud官方推出的开源项目，用于将Spring Cloud和Spring Boot应用运行在kubernetes环境，并且提供了通用的接口来调用kubernetes服务,最终是借用了kubernetes自己的服务发现功能，当configmap发生变动时可通知相关服务更新配置。

二. 实践

1.准备

1.1 应用源码

准备一个spring-boot应用，目录如下：
image.png

（1）添加maven依赖

通过maven创建名为springcloudk8sreloadconfigdemo的springboot工程，pom.xml内容如下，要注意的是新增了依赖spring-cloud-starter-kubernetes-config、spring-boot-actuator、spring-boot-actuator-autoconfigure，

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.2.7.RELEASE</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.ftlcloud</groupId>
  12.     <artifactId>demo</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>demo</name>
  15.     <description>Demo project for Spring Boot</description>
  18.     <properties>
  19.         <spring-boot.version>2.2.7.RELEASE</spring-boot.version>
  20.         <spring-cloud.version>Hoxton.SR4</spring-cloud.version>
  21.         <maven-checkstyle-plugin.failsOnError>false</maven-checkstyle-plugin.failsOnError>
  22.         <maven-checkstyle-plugin.failsOnViolation>false</maven-checkstyle-plugin.failsOnViolation>
  23.         <maven-checkstyle-plugin.includeTestSourceDirectory>false</maven-checkstyle-plugin.includeTestSourceDirectory>
  24.         <maven-compiler-plugin.version>3.5</maven-compiler-plugin.version>
  25.         <maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
  26.         <maven-failsafe-plugin.version>2.18.1</maven-failsafe-plugin.version>
  27.         <maven-surefire-plugin.version>2.21.0</maven-surefire-plugin.version>
  28.         <fabric8.maven.plugin.version>3.5.37</fabric8.maven.plugin.version>
  29.         <springcloud.kubernetes.version>1.0.1.RELEASE</springcloud.kubernetes.version>
  30.     </properties>
  32.     <dependencies>
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-starter-web</artifactId>
  36.         </dependency>
  38.         <dependency>
  39.             <groupId>org.springframework.boot</groupId>
  40.             <artifactId>spring-boot-starter-actuator</artifactId>
  41.         </dependency>
  43.         <dependency>
  44.             <groupId>org.springframework.boot</groupId>
  45.             <artifactId>spring-boot-actuator-autoconfigure</artifactId>
  46.         </dependency>
  48.         <dependency>
  49.             <groupId>org.springframework.cloud</groupId>
  50.             <artifactId>spring-cloud-starter-kubernetes-config</artifactId>
  51.             <version>${springcloud.kubernetes.version}</version>
  52.         </dependency>
  54.         <dependency>
  55.             <groupId>org.projectlombok</groupId>
  56.             <artifactId>lombok</artifactId>
  57.             <optional>true</optional>
  58.         </dependency>
  61.         <dependency>
  62.             <groupId>org.springframework.boot</groupId>
  63.             <artifactId>spring-boot-starter-test</artifactId>
  64.             <scope>test</scope>
  65.             <exclusions>
  66.                 <exclusion>
  67.                     <groupId>org.junit.vintage</groupId>
  68.                     <artifactId>junit-vintage-engine</artifactId>
  69.                 </exclusion>
  70.             </exclusions>
  71.         </dependency>
  72.     </dependencies>
  74.     <dependencyManagement>
  75.         <dependencies>
  76.             <dependency>
  77.                 <groupId>org.springframework.cloud</groupId>
  78.                 <artifactId>spring-cloud-dependencies</artifactId>
  79.                 <version>${spring-cloud.version}</version>
  80.                 <type>pom</type>
  81.                 <scope>import</scope>
  82.             </dependency>
  83.         </dependencies>
  84.     </dependencyManagement>
  86.     <build>
  87.         <plugins>
  88.             <plugin>
  89.                 <groupId>org.springframework.boot</groupId>
  90.                 <artifactId>spring-boot-maven-plugin</artifactId>
  91.                 <version>${spring-boot.version}</version>
  92.                 <executions>
  93.                     <execution>
  94.                         <goals>
  95.                             <goal>repackage</goal>
  96.                         </goals>
  97.                     </execution>
  98.                 </executions>
  99.             </plugin>
  101.             <plugin>
  102.                 <!--skip deploy -->
  103.                 <groupId>org.apache.maven.plugins</groupId>
  104.                 <artifactId>maven-deploy-plugin</artifactId>
  105.                 <version>${maven-deploy-plugin.version}</version>
  106.                 <configuration>
  107.                     <skip>true</skip>
  108.                 </configuration>
  109.             </plugin>
  110.             <plugin>
  111.                 <groupId>org.apache.maven.plugins</groupId>
  112.                 <artifactId>maven-surefire-plugin</artifactId>
  113.                 <version>${maven-surefire-plugin.version}</version>
  114.                 <configuration>
  115.                     <skipTests>true</skipTests>
  116.                     <!-- Workaround for https://issues.apache.org/jira/browse/SUREFIRE-1588 -->
  117.                     <useSystemClassLoader>false</useSystemClassLoader>
  118.                 </configuration>
  119.             </plugin>
  120.             <plugin>
  121.                 <groupId>io.fabric8</groupId>
  122.                 <artifactId>fabric8-maven-plugin</artifactId>
  123.                 <version>${fabric8.maven.plugin.version}</version>
  124.                 <executions>
  125.                     <execution>
  126.                         <id>fmp</id>
  127.                         <goals>
  128.                             <goal>resource</goal>
  129.                         </goals>
  130.                     </execution>
  131.                 </executions>
  132.             </plugin>
  133.         </plugins>
  134.     </build>
  136.     <profiles>
  137.         <profile>
  138.             <id>kubernetes</id>
  139.             <build>
  140.                 <plugins>
  141.                     <plugin>
  142.                         <groupId>io.fabric8</groupId>
  143.                         <artifactId>fabric8-maven-plugin</artifactId>
  144.                         <version>${fabric8.maven.plugin.version}</version>
  145.                         <executions>
  146.                             <execution>
  147.                                 <id>fmp</id>
  148.                                 <goals>
  149.                                     <goal>resource</goal>
  150.                                     <goal>build</goal>
  151.                                 </goals>
  152.                             </execution>
  153.                         </executions>
  154.                         <configuration>
  155.                             <enricher>
  156.                                 <config>
  157.                                     <fmp-service>
  158.                                         <type>NodePort</type>
  159.                                     </fmp-service>
  160.                                 </config>
  161.                             </enricher>
  162.                         </configuration>
  163.                     </plugin>
  164.                 </plugins>
  165.             </build>
  166.         </profile>
  167.     </profiles>
  168. </project>

（2）src\main\resources创建名为bootstrap.yml的文件

如下：

server:
  port: 8080

management:
  endpoint:
    restart:
      enabled: true
    health:
      enabled: true
    info:
      enabled: true

spring:
  application:
    name: ftl-cloud-app-demo
  profiles:
    active: staging
  cloud:
    kubernetes:
      reload:
        #自动更新配置的开关设置为打开
        enabled: true
        #更新配置信息的模式是主动拉取
        mode: polling
        #主动拉取的间隔时间是500毫秒
        period: 1000
      config:
        sources:
          - name: ${spring.application.name}
            namespace: import-staging

可见新增了配置项spring.cloud.kubernetes.reload和spring.cloud.kubernetes.config，前者用于开启自动更新配置，执行更新模式为500毫秒拉取一次，后者指定配置来源于kubernetes的哪个namespace下的哪个configmap。

（3）java源码

需要应用加载的信息如下

## kafka topic相关配置
kafka:
  topic:
    group-id: receiver-group
    topic-name:
      - topic1
      - topic2
      - topic3

KafkaTopicProperties.java ：

@RefreshScope
@Data
@Component
@ConfigurationProperties("kafka.topic")
public class KafkaTopicProperties {

    private String groupId;
    private String[] topicName;

    public String getGroupId() {
        return groupId;
    }

    public void setGroupId(String groupId) {
        this.groupId = groupId;
    }

    public String[] getTopicName() {
        return topicName;
    }

    public void setTopicName(String[] topicName) {
        this.topicName = topicName;
    }
}

TestController.java


@RestController
public class TestController {

    @Autowired
    private KafkaTopicProperties properties;

    @GetMapping("/get")
    @ResponseBody
    public Object test(){
        return  properties.getTopicName();
    }

}

DemoApplication.java


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

1.2 configmap创建

即application.yml内容，本文以kafka主题简单配置为例，如下：

## kafka topic相关配置
kafka:
  topic:
    group-id: receiver-group
    topic-name:
      - topic1
      - topic2
      - topic3

（1）通过rancher创建configmap

如果k8s通过rancher管理的话，可以通过rancher创建此configmap.
首先，点击资源-配置映射如下：
image.png
添加一个配置映射，名称就取我们的demo名称ftl-cloud-app-demo,注意选择命名空间。
image.png
点击保存即可创建成功一个名称为ftl-cloud-app-demo的configmap

（2）通过kubectl创建configmap

1）在kubernetes环境新建名为ftl-cloud-app-demo.yml的文件，内容如下：

apiVersion: v1
data:
  application.yml: |-
    ## kafka topic相关配置
    kafka:
      topic:
        group-id: receiver-group
        topic-name:
          - topic1
          - topic2
          - topic3
kind: ConfigMap
metadata:
  name: ftl-cloud-app-demo
  namespace: import-staging

保存后执行：

kubectl apply -f ftl-cloud-app-demo.yml

即可生成名称为ftl-cloud-app-demo的configmap。

2.授权

2.1 角色的创建

在命令行执行：

kubectl create role role-configmap-reader --verb=get,list,watch --resource=pods,configmaps --dry-run -o yaml > role-configmap-reader.yml

执行后，会生成role-configmap-reader.yml的文件，编辑使之如下：

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  namespace: import-staging
  name: role-configmap-reader
rules:
  - apiGroups: [""]
    resources: ["pods","configmaps"]
    verbs: ["get", "watch", "list"]

保存，执行

kubectl apply -f role-configmap-reader.yml

即可创建一个拥有”get”, “watch”, “list” -> “pods”,”configmaps”权限的角色

2.2 创建ServiceAccount

在命令行执行：

kubectl create serviceaccount qianxunke  -o yaml > user-qianxunke.yml

在当前目录下会生成user-qianxunke.yml的文件，我们需要编辑它，改变默认命名空间（default),如下：
image.png
修改好命名空间后，保存执行

kubectl apply -f user-qianxunke.yml

2.3 绑定Role和ServiceAccount

kubectl create rolebinding rolebinding-pods-configmap-reade- --role=pods-reader --user=qianxunke --dry-run -o yaml > rolebinding-pods-configmap-reader.yaml

执行成功会在当前目录生成rolebinding-pods-configmap-reader.yaml，编辑其，使之如下：

apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: rolebinding-pods-configmap-reader
  namespace: default
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: role-configmap-reader
subjects:
  - kind: ServiceAccount
    name: qianxunke
    namespace: import-staging

保存，执行：

kubectl apply -f rolebinding-pods-configmap-reader.yaml

3.验证

3.1项目部署

这个根据自己的环境，基本步骤就是：编译镜像，推送镜像到镜像仓库，在k8s中创建模版，执行。
这里我们创建一个无状态的deployment来部署：
内容如下：

apiVersion: apps/v1 # for versions before 1.9.0 use apps/v1beta2
kind: Deployment
metadata:
  name: ftl-cloud-app-demo
spec:
  selector:
    matchLabels:
      app: ftl-cloud-app-demo
  replicas: 2 # tells deployment to run 2 pods matching the template
  template:
    metadata:
      labels:
        app: ftl-cloud-app-demo
    spec:
      containers:
      - name: ftl-cloud-app-demo
        image: 填写镜像地址
        ports:
        - containerPort: 8080
      serviceAccount: qianxunke
      serviceAccountName: qianxunke

注意：serviceAccount，serviceAccountName的值为上文授权的用户名
保存以上内容在ftl-cloud-app-demo-deployment.yml，然后执行

kubectl apply -f ./ftl-cloud-app-demo-deployment.yml

不出意外，程序运行正常。
如果结合rancher部署应用，只需修改已有的deployment，在相应位置添加serviceAccount,serviceAccountName即可。

3.2 验证

在postman输入：
http://自己的域名或IP/get
输入如下：
image.png
修改configmap

kubectl edit configmap ftl-cloud-app-demo

image.png再在postman点击send，即可马得到如下结果：
image.png

4.补充说明

之前的bootstrap.yml中和同步配置相关的参数，如下图红框所示：
image.png
polling是定时拉取的模式，间隔时间太大会影响实时性，太小又导致请求过于密集，所以spring-cloud-kubernetes框架还给出了另一种模式：事件通知，对应的值是event;
设置事件通知模式的步骤：先将mode的值从polling改为event，再将period参数注释掉（该参数只在mode等于polling时有效），修改后如下：
image.png