你好 spring-cloud-kubernetes

語言: CN / TW / HK

歡迎訪問我的 GitHub

這裡分類和彙總了欣宸的全部原創(含配套原始碼): https://github.com/zq2599/blog_demos

關於 spring-cloud-kubernetes

  • spring-cloud-kubernetes 是 springcloud 官方推出的開源專案,用於將 Spring Cloud 和 Spring Boot 應用執行在 kubernetes 環境,並且提供了通用的介面來呼叫 kubernetes 服務,GitHub 上官方地址是:https://github.com/spring-cloud/spring-cloud-kubernetes

  • 該專案的提交者之一,就是 SpringCloud 的作者之一 Spencer Gibb:

通過官方 demo 來了解 spring-cloud-kubernetes

實戰 spring-cloud-kubernetes

  • 今天實戰的內容是開發一個簡單的 java 應用,然後將其部署在 kubernetes 環境(minikube 1.1.1),該應用通過 spring-cloud-kubernetes 呼叫當前 kubernetes 的服務;

環境資訊

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

  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

  • 上面的 linux、minikube、java、maven,請確保已準備好,linux 環境下 minikube 的安裝和啟動請參考《Linux 安裝 minikube 指南 》。

  • 準備工作已經 OK,開始編碼吧。

原始碼下載

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

  • 這個 git 專案中有多個資料夾,本章原始碼在 springcloudk8sdiscovery 這個資料夾下,如下圖紅框所示:

開發應用

  1. 基於 maven 建立一個 springboot 應用,名為 springcloudk8sdiscovery

  2. 該應用完整的 pom.xml 內容如下:

<?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.1.RELEASE</version>        <relativePath/> <!-- lookup parent from repository -->    </parent>    <groupId>com.bolingcavalry</groupId>    <artifactId>springcloudk8sdiscovery</artifactId>    <version>0.0.1-SNAPSHOT</version>    <name>springcloudk8sdiscovery</name>    <description>Demo project for Spring Boot</description>
<properties> <java.version>1.8</java.version> <spring-boot.version>2.1.1.RELEASE</spring-boot.version> <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> </properties>
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <type>pom</type> <scope>import</scope> <version>${spring-boot.version}</version> </dependency> </dependencies> </dependencyManagement>
<dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-kubernetes-core</artifactId> <version>1.0.1.RELEASE</version> </dependency>
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-kubernetes-discovery</artifactId> <version>1.0.1.RELEASE</version> </dependency>
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-commons</artifactId> <version>2.1.1.RELEASE</version> </dependency>
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <version>2.1.1.RELEASE</version> </dependency>
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>2.1.1.RELEASE</version> </dependency>
<!-- We need that(actuator) so that it can be used in readiness probes. Readiness checks are needed by arquillian, so that it knows when to run the actual test. --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> <version>2.1.1.RELEASE</version> </dependency>
<dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.28</version> </dependency> </dependencies>

<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> <profile> <id>release</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>helm</goal> </goals> </execution> </executions> </plugin> </plugins> </build> </profile>
<profile> <id>integration</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> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-failsafe-plugin</artifactId> <version>${maven-failsafe-plugin.version}</version> <executions> <execution> <id>run-integration-tests</id> <phase>integration-test</phase> <goals> <goal>integration-test</goal> <goal>verify</goal> </goals> </execution> </executions> <configuration> <skipTests>false</skipTests> <skipITs>false</skipITs> </configuration> </plugin> </plugins> </build> </profile> </profiles></project>

複製程式碼

  • 上述 pom.xml 檔案有幾處需要關注:a. 直接依賴了 spring-cloud-kubernetes 的以下兩個庫,後面才能使用 spring-cloud-kubernetes 的服務:

<code data-type="codeline">org.springframework.cloud:spring-cloud-kubernetes-core:1.0.1.RELEASE</code><code data-type="codeline">org.springframework.cloud:spring-cloud-kubernetes-discovery:1.0.1.RELEASE</code>

複製程式碼

b. 使用外掛 fabric8-maven-plugin 來構建映象並部署到 minikube 環境:

<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>

複製程式碼

c. 為 fabric8-maven-plugin 外掛準備了三個 profile,本次實戰主要用到 kubernetes 這個:

<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>                <!--部署到kubernetes後,會建立一個型別為NodePort的service-->                 <type>NodePort</type>               </fmp-service>             </config>           </enricher>         </configuration>       </plugin>     </plugins>   </build> </profile>

複製程式碼

  • 以上就是 pom.xml 的內容了,主要是新增 spring-cloud-kubernetes 的依賴,以及使用 fabric8 來構建和部署;

  1. 在 application.properties 檔案中設定應用名稱:

spring.application.name=springcloudk8sdiscovery

複製程式碼

  1. 建立應用啟動類 Springcloudk8sdiscoveryApplication,可見這是個很普通的 springboot 啟動類:

package com.bolingcavalry.springcloudk8sdiscovery;
import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

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

複製程式碼

  1. 建立 controller 類,對外提供 http 服務,部署完成後通過這些 http 服務來驗證功能:

@RestControllerpublic class DiscoveryController {
@Autowired private DiscoveryClient discoveryClient;
/** * 探針檢查響應類 * @return */ @RequestMapping("/health") public String health() { return "health"; }
/** * 返回遠端呼叫的結果 * @return */ @RequestMapping("/getservicedetail") public String getservicedetail( @RequestParam(value = "servicename", defaultValue = "") String servicename) { return "Service [" + servicename + "]'s instance list : " + JSON.toJSONString(discoveryClient.getInstances(servicename)); }
/** * 返回發現的所有服務 * @return */ @RequestMapping("/services") public String services() { return this.discoveryClient.getServices().toString() + ", " + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()); }}

複製程式碼

  • 上述程式碼有幾點需要注意:a. health 方法用於響應 kubernetes 的探針檢查;b. getservicedetail 方法接收名為 servicename 的引數,然後去服務列表中檢查對應的服務物件並返回;c. services 方法返回的是所有服務的名稱;

  • 以上就是所有程式碼了,功能是通過 autowire 得到 DiscoveryClient 例項,再呼叫該例項的 API 取得服務資訊。

  • 接下來我們將應用構建並部署到 minikube 環境;

編譯構建

  1. 請確保當前電腦上 java、maven、minikube 都是正常的;

  2. 在 pom.xml 檔案所在目錄執行以下命令,即可編譯構建部署一次性完成:

mvn clean package fabric8:deploy -Pkubernetes

複製程式碼

  • 構建成功後,控制檯輸出資訊如下:

...[INFO] [INFO] <<< fabric8-maven-plugin:3.5.37:deploy (default-cli) < install @ springcloudk8sdiscovery <<<[INFO] [INFO] [INFO] --- fabric8-maven-plugin:3.5.37:deploy (default-cli) @ springcloudk8sdiscovery ---[INFO] F8: Using Kubernetes at https://192.168.121.133:8443/ in namespace default with manifest /usr/local/work/demo/springcloudk8sdiscovery/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-springcloudk8sdiscovery.json[INFO] Using namespace: default[INFO] Updating Deployment from kubernetes.yml[INFO] Updated Deployment: target/fabric8/applyJson/default/deployment-springcloudk8sdiscovery.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:  11.207 s[INFO] Finished at: 2019-06-09T18:50:09+08:00[INFO] ------------------------------------------------------------------------

複製程式碼

  1. 用 kubectl 命令檢視部署和服務,都處於正常狀態:

[[email protected] springcloudk8sdiscovery]# kubectl get deploymentsNAME                      READY   UP-TO-DATE   AVAILABLE   AGEspringcloudk8sdiscovery   1/1     1            1           75m[[email protected] springcloudk8sdiscovery]# kubectl get svcNAME                      TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)          AGEkubernetes                ClusterIP   10.96.0.1       <none>        443/TCP          33hspringcloudk8sdiscovery   NodePort    10.102.167.79   <none>        8080:31583/TCP   75m

複製程式碼

  1. 執行命令 minikube service springcloudk8sdiscovery --url ,得到的是可以從外部訪問的服務地址:http://192.168.121.133:31583 ,其中 192.168.121.133 是宿主機 IP 地址;

  2. 在瀏覽器上訪問地址 http://192.168.121.133:31583/services ,如下圖,返回的"所有服務"其實是 kubernetes 中的所有 service:

  3. 為了驗證當前 namespace 下的所有服務都能被發現,我們再建立個服務實施,執行以下命令,會建立名為 my-tomcat 的部署和服務:

kubectl run my-tomcat --image=tomcat:7.0.94-jre7-alpine --replicas=2 --port=8080 \&& kubectl expose deployment my-tomcat --port=8080 --target-port=8080 --external-ip=192.168.50.7 --type=LoadBalancer

複製程式碼

  • 由於下載映象需要一定時間,所以需要稍作等待;

  1. 再去訪問地址 http://192.168.121.133:31583/services ,如下圖,my-tomcat 赫然在列:

  2. 訪問地址 http://192.168.121.133:31583/getservicedetail?servicename=my-tomcat ,會得到名為 my-tomcat 的服務資訊,該資訊格式化後的內容如下所示:

[    {        "host": "172.17.0.4",        "instanceId": "91201db9-8aa6-11e9-a5b5-000c29fd2001",        "metadata": {            "run": "my-tomcat"        },        "port": 8080,        "scheme": "http://",        "secure": false,        "serviceId": "my-tomcat",        "uri": "http://172.17.0.4:8080"    },    {        "host": "172.17.0.5",        "instanceId": "91223cda-8aa6-11e9-a5b5-000c29fd2001",        "metadata": {            "$ref": "$[0].metadata"        },        "port": 8080,        "scheme": "http://",        "secure": false,        "serviceId": "my-tomcat",        "uri": "http://172.17.0.5:8080"    }]

複製程式碼

  • 可見 spring-cloud-kubernetes 的 DiscoveryClient 服務將 kubernetes 中的"service"資源與 SpringCloud 中的服務對應起來了,有了這個 DiscoveryClient,我們在 kubernetes 環境就不需要 eureka 來做註冊發現了,而是直接使用 kubernetes 的服務機制,此時不得不感慨 SpringCloud 的對 DiscoveryClient 的設計是如此的精妙。

  • 至此,spring-cloud-kubernetes 的初體驗就結束了,通過簡單的編碼我們的程式在 kubernetes 環境可以取得 service 資源的資訊,隨著學習的深入,我們會用到更多的 spring-cloud-kubernetes 能力,感謝 spring-cloud-kubernetes 的設計者,讓我們的 SpringCloud 應用暢遊在在 kubernetes 世界。

疑惑待解

  • 您可能會有些疑惑:上面的程式碼都是和 SpringCloud 相關的,和 spring-cloud-kubernetes 沒什麼關係呀,為什麼程式執行起來後就能取得 kubernetes 環境中的服務資訊呢?

  • 此問題如果不弄清楚,後面的學習很難展開,因為我們都不知道自己的程式碼與 kubernetes 環境有什麼關係,和 kubernetes 有沒有互動?

  • 以上問題,在下一篇《spring-cloud-kubernetes 背後的三個關鍵知識點》會有詳細的分析。

歡迎關注 InfoQ:程式設計師欣宸

學習路上,你不孤單,欣宸原創一路相伴...