本文是《spring-cloud-kubernetes實戰系列》的第六篇，主要內容是在kubernetes上部署一個java web應用，該應用使用了spring-cloud-kubernetes框架，可以使用kubernetes的configmap；

系列文章列表

1. 《spring-cloud-kubernetes官方demo執行實戰》
2. 《你好spring-cloud-kubernetes》
3. 《spring-cloud-kubernetes背後的三個關鍵知識點》
4. 《spring-cloud-kubernetes的服務發現和輪詢實戰(含熔斷)》
5. 《spring-cloud-kubernetes與SpringCloud Gateway》
6. 《spring-cloud-kubernetes與k8s的configmap》
7. 《spring-cloud-kubernetes自動同步k8s的configmap更新》

關於SpringCloud Config

如果您開發過SpringCloud應用，相信您對SpringCloud Config不會陌生，在微服務環境中，業務應用可以從config server獲取所需的配置資訊，如下圖所示：

關於kubernetes的configmap

這是kubernetes提供的基本服務之一，建立一個configmap資源，對應著一份配置檔案，可以將該資源通過資料卷的形式對映到Pod上，這樣Pod就能用上這個配置檔案了，如下圖：

spring-cloud-kubernetes帶來的禮物

spring-cloud-starter-kubernetes-config是spring-cloud-starter-kubernetes框架下的一個庫，作用是將kubernetes的configmap與SpringCloud Config結合起來，通過spring-cloud-starter-kubernetes-config，我們的應用就像在通過SpringCloud Config取得配置資訊，只不過這裡的配置資訊來自kubernetes的configmap，而不是SpringCloud Config server，如下圖所示：

理論上的準備工作已經差不多了，接下來通過實戰來展示spring-cloud-starter-kubernetes-config的神奇之處；

原始碼下載

如果您不打算寫程式碼，也可以從GitHub上下載本次實戰的原始碼，地址和連結資訊如下表所示：

名稱	連結	備註
專案主頁	https://github.com/zq2599/blog_demos	該專案在GitHub上的主頁
git倉庫地址(https)	https://github.com/zq2599/blog_demos.git	該專案原始碼的倉庫地址，https協議
git倉庫地址(ssh)	[email protected]:zq2599/blog_demos.git	該專案原始碼的倉庫地址，ssh協議

這個git專案中有多個資料夾，本章的應用在springcloudk8sconfigdemo資料夾下，如下圖所示：

環境資訊

本次實戰的環境和版本資訊如下：

1. 作業系統：CentOS Linux release 7.6.1810
2. minikube：1.1.1
3. Java：1.8.0_191
4. Maven：3.6.0
5. fabric8-maven-plugin外掛：3.5.37
6. spring-cloud-kubernetes：1.0.1.RELEASE
7. springboot：2.1.6.RELEASE

準備完畢，可以開始實戰啦！

編碼

1. 通過maven建立名為springcloudk8sconfigdemo的springboot工程，pom.xml內容如下，要注意的是新增了依賴spring-cloud-starter-kubernetes-config，這是本次實戰的重點：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.bolingcavalry</groupId>
    <artifactId>springcloudk8sconfigdemo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springcloudk8sconfigdemo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-boot.version>2.1.6.RELEASE</spring-boot.version>
        <maven-checkstyle-plugin.failsOnError>false</maven-checkstyle-plugin.failsOnError>
        <maven-checkstyle-plugin.failsOnViolation>false</maven-checkstyle-plugin.failsOnViolation>
        <maven-checkstyle-plugin.includeTestSourceDirectory>false</maven-checkstyle-plugin.includeTestSourceDirectory>
        <maven-compiler-plugin.version>3.5</maven-compiler-plugin.version>
        <maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
        <maven-failsafe-plugin.version>2.18.1</maven-failsafe-plugin.version>
        <maven-surefire-plugin.version>2.21.0</maven-surefire-plugin.version>
        <fabric8.maven.plugin.version>3.5.37</fabric8.maven.plugin.version>
        <springcloud.kubernetes.version>1.0.1.RELEASE</springcloud.kubernetes.version>
        <spring-cloud.version>Greenwich.SR2</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-kubernetes-config</artifactId>
            <version>${springcloud.kubernetes.version}</version>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring-boot.version}</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

            <plugin>
                <!--skip deploy -->
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-deploy-plugin</artifactId>
                <version>${maven-deploy-plugin.version}</version>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>${maven-surefire-plugin.version}</version>
                <configuration>
                    <skipTests>true</skipTests>
                    <!-- Workaround for https://issues.apache.org/jira/browse/SUREFIRE-1588 -->
                    <useSystemClassLoader>false</useSystemClassLoader>
                </configuration>
            </plugin>
            <plugin>
                <groupId>io.fabric8</groupId>
                <artifactId>fabric8-maven-plugin</artifactId>
                <version>${fabric8.maven.plugin.version}</version>
                <executions>
                    <execution>
                        <id>fmp</id>
                        <goals>
                            <goal>resource</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

    <profiles>
        <profile>
            <id>kubernetes</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>io.fabric8</groupId>
                        <artifactId>fabric8-maven-plugin</artifactId>
                        <version>${fabric8.maven.plugin.version}</version>
                        <executions>
                            <execution>
                                <id>fmp</id>
                                <goals>
                                    <goal>resource</goal>
                                    <goal>build</goal>
                                </goals>
                            </execution>
                        </executions>
                        <configuration>
                            <enricher>
                                <config>
                                    <fmp-service>
                                        <type>NodePort</type>
                                    </fmp-service>
                                </config>
                            </enricher>
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>
</project>

1. 專案的src\main\resources路徑下不要建立application.yml檔案，只建立名為bootstrap.yml的檔案，內容如下：

spring:
  application:
    name: springcloudk8sconfigdemo
  cloud:
    kubernetes:
      config:
        sources:
          - name: ${spring.application.name}
            namespace: default

可見新增了配置項spring.cloud.kubernetes.config.source.name和spring.cloud.kubernetes.config.source.namespace，用於配置資訊來源於kubernetes的哪個namespace下的哪個configmap；

1. 增加一個配置類DummyConfig.java，註解ConfigurationProperties的prefix="greeting"表示該類用到的配置項都是名為"greeting"的配置項的子內容 ：

package com.bolingcavalry.springcloudk8sconfigdemo;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties(prefix = "greeting")
public class DummyConfig {

    private String message = "This is a dummy message";

    public String getMessage() {
        return this.message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

1. 啟動類Springcloudk8sconfigdemoApplication.java，簡單起見，將用於驗證配置項是否生效的web介面也寫在了這裡面，即hello方法 ：

package com.bolingcavalry.springcloudk8sconfigdemo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.text.SimpleDateFormat;
import java.util.Date;

@SpringBootApplication
@RestController
@EnableConfigurationProperties(DummyConfig.class)
public class Springcloudk8sconfigdemoApplication {

    @Autowired
    private DummyConfig dummyConfig;

    @GetMapping("/hello")
    public String hello() {
        return dummyConfig.getMessage()
                + " ["
                + new SimpleDateFormat().format(new Date())
                + "]";
    }

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

以上就是實戰工程的所有程式碼了，僅僅只是引入了spring-cloud-kubernetes-config的依賴，以及在啟動配置檔案中指定了configmap的資訊，即完成了獲取配置檔案的所有操作，至於程式碼中用到配置檔案的地方，和使用SpringCloud Config並無差別。

解決許可權問題

我這裡的是minikube，在部署了應用之後，預設的serviceaccount是沒有許可權訪問K8S的API Server資源的，執行以下命令可以提升許可權：

kubectl create clusterrolebinding permissive-binding \
  --clusterrole=cluster-admin \
  --user=admin \
  --user=kubelet \
  --group=system:serviceaccounts

注意：以上辦法只能用於開發和測試環境，不要用在生產環境，生產環境應參考Kubernetes的RBAC授權相關設定來處理，步驟如下：

1. 建立role：

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

1. 建立ServiceAccount：

apiVersion: v1
kind: ServiceAccount
metadata:
  name: config-reader
  namespace: default

1. 繫結Role和ServiceAccount：

apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: pod-reader
  namespace: default
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: pod-reader
subjects:
  - kind: ServiceAccount
    name: config-reader
    namespace: default

1. 在deployment中指定上面的ServiceAccount；

驗證

接下來我們在kubernetes環境建立configmap，再將springcloudk8sconfigdemo在kubernetes部署和啟動，通過springcloudk8sconfigdemo提供的http介面驗證應用是否已經從configmap中取得指定的配置；

1. 在kubernetes環境新建名為springcloudk8sconfigdemo.yml的檔案，內容如下：

kind: ConfigMap
apiVersion: v1
metadata:
  name: springcloudk8sconfigdemo
data:
  application.yml: |-
    greeting:
      message: Say Hello to the World
    farewell:
      message: Say Goodbye
    ---
    spring:
      profiles: development
    greeting:
      message: Say Hello to the Developers
    farewell:
      message: Say Goodbye to the Developers
    ---
    spring:
      profiles: production
    greeting:
      message: Say Hello to the Ops

1. 在springcloudk8sconfigdemo.yml檔案所在目錄執行以下命令，即可在kubernetes建立名為的configmap的資源：

kubectl apply -f springcloudk8sconfigdemo.yml

1. 在springcloudk8sconfigdemo專案的pom.xml檔案所在目錄，執行以下命令，即可編譯構建部署全部完成：

mvn clean install fabric8:deploy -Dfabric8.generator.from=fabric8/java-jboss-openjdk8-jdk -Pkubernetes

操作成功後的控制檯資訊如下：

[INFO] Installing /usr/local/work/k8s/springcloudk8sconfigdemo/target/classes/META-INF/fabric8/kubernetes.json to /root/.m2/repository/com/bolingcavalry/springcloudk8sconfigdemo/0.0.1-SNAPSHOT/springcloudk8sconfigdemo-0.0.1-SNAPSHOT-kubernetes.json
[INFO] 
[INFO] <<< fabric8-maven-plugin:3.5.37:deploy (default-cli) < install @ springcloudk8sconfigdemo <<<
[INFO] 
[INFO] 
[INFO] --- fabric8-maven-plugin:3.5.37:deploy (default-cli) @ springcloudk8sconfigdemo ---
[INFO] F8: Using Kubernetes at https://192.168.121.133:8443/ in namespace default with manifest /usr/local/work/k8s/springcloudk8sconfigdemo/target/classes/META-INF/fabric8/kubernetes.yml 
[INFO] Using namespace: default
[INFO] Updating a Service from kubernetes.yml
[INFO] Updated Service: target/fabric8/applyJson/default/service-springcloudk8sconfigdemo.json
[INFO] Using namespace: default
[INFO] Updating Deployment from kubernetes.yml
[INFO] Updated Deployment: target/fabric8/applyJson/default/deployment-springcloudk8sconfigdemo.json
[INFO] F8: HINT: Use the command `kubectl get pods -w` to watch your pods start up
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  13.538 s
[INFO] Finished at: 2019-07-14T17:06:25+08:00
[INFO] ------------------------------------------------------------------------

1. 如果您的環境也是minikube，可以執行以下命令檢視服務地址：

minikube service springcloudk8sconfigdemo --url

得到服務地址是：http://192.168.121.133:31646

1. 瀏覽器訪問地址：http://192.168.121.133:31646/hello ，得到響應如下圖，可見已經從configmap取得了配置檔案，並且載入成功：
   

   修改profile

   前面的實戰沒有指定springboot工程的profile，接下來指定profile為development，看能否載入到配置檔案中指定的配置，如下圖紅框所示：
   

2. 修改專案的src\main\resources路徑下的bootstrap.yml檔案，增加配置項spring.profiles.active，修改後的完整內容如下：

spring:
  application:
    name: springcloudk8sconfigdemo
  profiles:
    active: development
  cloud:
    kubernetes:
      config:
        sources:
          - name: ${spring.application.name}
            namespace: default

1. 在springcloudk8sconfigdemo專案的pom.xml檔案所在目錄，執行以下命令，即可編譯構建部署全部完成：

mvn clean install fabric8:deploy -Dfabric8.generator.from=fabric8/java-jboss-openjdk8-jdk -Pkubernetes

1. 如果您的環境也是minikube，可以執行以下命令檢視服務地址：

minikube service springcloudk8sconfigdemo --url

得到服務地址是：http://192.168.121.133:30659

1. 瀏覽器訪問地址：http://192.168.121.133:30659/hello ，得到響應如下圖，可見已經從configmap取得了指定profile的配置檔案，並且載入成功：
   
   至此，spring-cloud-kubernetes與k8s的configmap的實戰就完成了，我們可以發現藉助spring-cloud-kubernetes-config的神奇能力，曾經使用SpringCloud Config來配置的應用幾乎不用修改程式碼，僅僅調整了配置和依賴，就能順利遷移到kubernetes之上，直接使用原生的配置服務，並且SpringCloud Config Server也可以不用在kubernetes上部署了，再次感受到SpringCloud設計的前瞻性。

一點遺憾

雖然我們的應用已經成功從configmap取得配置資訊，但遺憾的是，configmap的配置資訊被修改後，這些修改是無法實時同步到我們的應用的，只能重啟應用來重現獲取配置，為了解決這個問題，請參考本系列的下一篇 《spring-cloud-kubernetes自動同步k8s的configmap更新》

歡迎關注我的公眾號：程式設計師欣宸

相關推薦