掌握SpringBoot-2.3的容器探針:實戰篇

程式設計師欣宸發表於2020-09-18

歡迎訪問我的GitHub

https://github.com/zq2599/blog_demos

  • 內容:原創文章分類彙總,及配套原始碼,涉及Java、Docker、K8S、DevOPS等
    經過多篇知識積累終於來到實戰章節,親愛的讀者們,請將裝備就位,一起動手體驗SpringBoot官方帶給我們的最新技術;

關於《SpringBoot-2.3容器化技術》系列

  • 《SpringBoot-2.3容器化技術》系列,旨在和大家一起學習實踐2.3版本帶來的最新容器化技術,讓我們們的Java應用更加適應容器化環境,在雲端計算時代依舊緊跟主流,保持競爭力;
  • 全系列文章分為主題和輔助兩部分,主題部分如下:
  1. 《體驗SpringBoot(2.3)應用製作Docker映象(官方方案)》
  2. 《詳解SpringBoot(2.3)應用製作Docker映象(官方方案)》
  3. 《掌握SpringBoot-2.3的容器探針:基礎篇》
  4. 《掌握SpringBoot-2.3的容器探針:深入篇》
  5. 《掌握SpringBoot-2.3的容器探針:實戰篇》
  • 輔助部分是一些參考資料和備忘總結,如下:
  1. 《SpringBoot-2.3映象方案為什麼要做多個layer》
  2. 《設定非root賬號不用sudo直接執行docker命令》
  3. 《開發階段,將SpringBoot應用快速部署到K8S》

SpringBoot-2.3容器探針知識點小結

經過前面的知識積累,我們知道了SpringBoot-2.3新增的探針規範以及適用場景,這裡做個簡短的回顧:

  1. kubernetes要求業務容器提供一個名為livenessProbe的地址,kubernetes會定時訪問該地址,如果該地址的返回碼不在200到400之間,kubernetes認為該容器不健康,會殺死該容器重建新的容器,這個地址就是存活探針
  2. kubernetes要求業務容器提供一個名為readinessProbe的地址,kubernetes會定時訪問該地址,如果該地址的返回碼不在200到400之間,kubernetes認為該容器無法對外提供服務,不會把請求排程到該容器,這個地址就是就緒探針
  3. SpringBoot的2.3.0.RELEASE釋出了兩個新的actuator地址,/actuator/health/liveness/actuator/health/readiness,前者用作存活探針,後者用作就緒探針,這兩個地址的返回值來自兩個新增的actuator:Liveness StateReadiness State
  4. SpringBoot應用根據特殊環境變數是否存在來判定自己是否執行在容器環境,如果是,/actuator/health/liveness/actuator/health/readiness這兩個地址就有返回碼,具體的值是和應用的狀態有對應關係的,例如應用啟動過程中,/actuator/health/readiness返回503,啟動成功後返回200
  5. 業務應用可以通過Spring系統事件機制來讀取Liveness StateReadiness State,也可以訂閱這兩個actuator的變更事件;
  6. 業務應用可以通過Spring系統事件機制來修改Liveness StateReadiness State,此時/actuator/health/liveness和/actuator/health/readiness的返回值都會發生變更,從而影響kubernetes對此容器的行為(參照第一點和第二點),例如livenessProbe返回碼變成503,導致kubernetes認為容器不健康,從而殺死容器;

小結完畢,接下來開始實打實的編碼和操作實戰,驗證上述理論;

實戰環境資訊

本次實戰有兩個環境:開發和執行環境,其中開發環境資訊如下:

  1. 作業系統:Ubuntu 20.04 LTS 桌面版
  2. CPU :2.30GHz × 4,記憶體:32G,硬碟:1T NVMe
  3. JDK:1.8.0_231
  4. MAVEN:3.6.3
  5. SpringBoot:2.3.0.RELEASE
  6. Docker:19.03.10
  7. 開發工具:IDEA 2020.1.1 (Ultimate Edition)

執行環境資訊如下:

  1. 作業系統:CentOS Linux release 7.8.2003
  2. Kubernetes:1.15

事實證明,用Ubuntu桌面版作為開發環境是可行的,體驗十分順暢,IDEA、SubLime、SSH、Chrome、微信都能正常使用,下圖是我的Ubuntu開發環境:

在這裡插入圖片描述

實戰內容簡介

本次實戰包括以下內容:

  1. 開發SpringBoot應用,部署在kubernetes;
  2. 檢查應用狀態和kubernetes的pod狀態的關聯變化;
  3. 修改Readiness State,看kubernetes是否還會把請求排程到pod;
  4. 修改Liveness State,看kubernetes會不是殺死pod;

原始碼下載

  1. 本次實戰用到了一個普通的SpringBoot工程,原始碼可在GitHub下載到,地址和連結資訊如下表所示(https://github.com/zq2599/blog_demos):
名稱 連結 備註
專案主頁 https://github.com/zq2599/blog_demos 該專案在GitHub上的主頁
git倉庫地址(https) https://github.com/zq2599/blog_demos.git 該專案原始碼的倉庫地址,https協議
git倉庫地址(ssh) git@github.com:zq2599/blog_demos.git 該專案原始碼的倉庫地址,ssh協議
  1. 這個git專案中有多個資料夾,本章的應用在probedemo資料夾下,如下圖紅框所示:

在這裡插入圖片描述

開發SpringBoot應用

  1. 請在IDEA上安裝lombok外掛:

在這裡插入圖片描述

  1. 在IDEA上新建名為probedemo的SpringBoot工程,版本選擇2.3.0

在這裡插入圖片描述

  1. 該工程的pom.xml內容如下,注意要有spring-boot-starter-actuatorlombok依賴,另外外掛spring-boot-maven-plugin也要增加layers節點:
<?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 https://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.3.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.bolingcavalry</groupId>
    <artifactId>probedemo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>probedemo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.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>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.3.0.RELEASE</version>
                <!--該配置會在jar中增加layer描述檔案,以及提取layer的工具-->
                <configuration>
                    <layers>
                        <enabled>true</enabled>
                    </layers>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>
  1. 應用啟動類ProbedemoApplication是個最普通的啟動類:
package com.bolingcavalry.probedemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ProbedemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(ProbedemoApplication.class, args);
    }
}
  1. 增加一個監聽類,可以監聽存活和就緒狀態的變化:
package com.bolingcavalry.probedemo.listener;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.availability.AvailabilityChangeEvent;
import org.springframework.boot.availability.AvailabilityState;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

/**
 * description: 監聽系統事件的類 <br>
 * date: 2020/6/4 下午12:57 <br>
 * author: willzhao <br>
 * email: zq2599@gmail.com <br>
 * version: 1.0 <br>
 */
@Component
@Slf4j
public class AvailabilityListener {

    /**
     * 監聽系統訊息,
     * AvailabilityChangeEvent型別的訊息都從會觸發此方法被回撥
     * @param event
     */
    @EventListener
    public void onStateChange(AvailabilityChangeEvent<? extends AvailabilityState> event) {
        log.info(event.getState().getClass().getSimpleName() + " : " + event.getState());
    }
}
  1. 增加名為StateReader的Controller的Controller,用於獲取存活和就緒狀態:
package com.bolingcavalry.probedemo.controller;

import org.springframework.boot.availability.ApplicationAvailability;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
import java.util.Date;

@RestController
@RequestMapping("/statereader")
public class StateReader {

    @Resource
    ApplicationAvailability applicationAvailability;

    @RequestMapping(value="/get")
    public String state() {
        return "livenessState : " + applicationAvailability.getLivenessState()
               + "<br>readinessState : " + applicationAvailability.getReadinessState()
               + "<br>" + new Date();
    }
}
  1. 增加名為StateWritter的Controller,用於設定存活和就緒狀態:
package com.bolingcavalry.probedemo.controller;

import org.springframework.boot.availability.AvailabilityChangeEvent;
import org.springframework.boot.availability.LivenessState;
import org.springframework.boot.availability.ReadinessState;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.Date;

/**
 * description: 修改狀態的controller <br>
 * date: 2020/6/4 下午1:21 <br>
 * author: willzhao <br>
 * email: zq2599@gmail.com <br>
 * version: 1.0 <br>
 */
@RestController
@RequestMapping("/staterwriter")
public class StateWritter {

    @Resource
    ApplicationEventPublisher applicationEventPublisher;

    /**
     * 將存活狀態改為BROKEN(會導致kubernetes殺死pod)
     * @return
     */
    @RequestMapping(value="/broken")
    public String broken(){
        AvailabilityChangeEvent.publish(applicationEventPublisher, StateWritter.this, LivenessState.BROKEN);
        return "success broken, " + new Date();
    }

    /**
     * 將存活狀態改為CORRECT
     * @return
     */
    @RequestMapping(value="/correct")
    public String correct(){
        AvailabilityChangeEvent.publish(applicationEventPublisher, StateWritter.this, LivenessState.CORRECT);
        return "success correct, " + new Date();
    }

    /**
     * 將就緒狀態改為REFUSING_TRAFFIC(導致kubernetes不再把外部請求轉發到此pod)
     * @return
     */
    @RequestMapping(value="/refuse")
    public String refuse(){
        AvailabilityChangeEvent.publish(applicationEventPublisher, StateWritter.this, ReadinessState.REFUSING_TRAFFIC);
        return "success refuse, " + new Date();
    }

    /**
     * 將就緒狀態改為ACCEPTING_TRAFFIC(導致kubernetes會把外部請求轉發到此pod)
     * @return
     */
    @RequestMapping(value="/accept")
    public String accept(){
        AvailabilityChangeEvent.publish(applicationEventPublisher, StateWritter.this, ReadinessState.ACCEPTING_TRAFFIC);
        return "success accept, " + new Date();
    }

}
  1. 增加名為Hello的controller,此介面能返回當前pod的IP地址,在後面測試時會用到:
package com.bolingcavalry.probedemo.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.net.Inet4Address;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.util.ArrayList;
import java.util.Date;
import java.util.Enumeration;
import java.util.List;

/**
 * description: hello demo <br>
 * date: 2020/6/4 下午4:38 <br>
 * author: willzhao <br>
 * email: zq2599@gmail.com <br>
 * version: 1.0 <br>
 */
@RestController
public class Hello {

    /**
     * 返回的是當前伺服器IP地址,在k8s環境就是pod地址
     * @return
     * @throws SocketException
     */
    @RequestMapping(value="/hello")
    public String hello() throws SocketException {
        List<Inet4Address> addresses = getLocalIp4AddressFromNetworkInterface();
        if(null==addresses || addresses.isEmpty()) {
            return  "empty ip address, " + new Date();
        }

        return addresses.get(0).toString() + ", " + new Date();
    }

    public static List<Inet4Address> getLocalIp4AddressFromNetworkInterface() throws SocketException {
        List<Inet4Address> addresses = new ArrayList<>(1);
        Enumeration e = NetworkInterface.getNetworkInterfaces();
        if (e == null) {
            return addresses;
        }
        while (e.hasMoreElements()) {
            NetworkInterface n = (NetworkInterface) e.nextElement();
            if (!isValidInterface(n)) {
                continue;
            }
            Enumeration ee = n.getInetAddresses();
            while (ee.hasMoreElements()) {
                InetAddress i = (InetAddress) ee.nextElement();
                if (isValidAddress(i)) {
                    addresses.add((Inet4Address) i);
                }
            }
        }
        return addresses;
    }

    /**
     * 過濾迴環網路卡、點對點網路卡、非活動網路卡、虛擬網路卡並要求網路卡名字是eth或ens開頭
     * @param ni 網路卡
     * @return 如果滿足要求則true,否則false
     */
    private static boolean isValidInterface(NetworkInterface ni) throws SocketException {
        return !ni.isLoopback() && !ni.isPointToPoint() && ni.isUp() && !ni.isVirtual()
                && (ni.getName().startsWith("eth") || ni.getName().startsWith("ens"));
    }

    /**
     * 判斷是否是IPv4,並且內網地址並過濾迴環地址.
     */
    private static boolean isValidAddress(InetAddress address) {
        return address instanceof Inet4Address && address.isSiteLocalAddress() && !address.isLoopbackAddress();
    }
}

以上就是該SpringBoot工程的所有程式碼了,請確保可以編譯執行;

製作Docker映象

  1. 在pom.xml所在目錄建立檔案Dockerfile,內容如下:
# 指定基礎映象,這是分階段構建的前期階段
FROM openjdk:8u212-jdk-stretch as builder
# 執行工作目錄
WORKDIR application
# 配置引數
ARG JAR_FILE=target/*.jar
# 將編譯構建得到的jar檔案複製到映象空間中
COPY ${JAR_FILE} application.jar
# 通過工具spring-boot-jarmode-layertools從application.jar中提取拆分後的構建結果
RUN java -Djarmode=layertools -jar application.jar extract

# 正式構建映象
FROM openjdk:8u212-jdk-stretch
WORKDIR application
# 前一階段從jar中提取除了多個檔案,這裡分別執行COPY命令複製到映象空間中,每次COPY都是一個layer
COPY --from=builder application/dependencies/ ./
COPY --from=builder application/spring-boot-loader/ ./
COPY --from=builder application/snapshot-dependencies/ ./
COPY --from=builder application/application/ ./
ENTRYPOINT ["java", "org.springframework.boot.loader.JarLauncher"]
  1. 先編譯構建工程,執行以下命令:
mvn clean package -U -DskipTests 
  1. 編譯成功後,通過Dockerfile檔案建立映象:
sudo docker build -t bolingcavalry/probedemo:0.0.1 .
  1. 映象建立成功:

在這裡插入圖片描述
SpringBoot的映象準備完畢,接下來要讓kubernetes環境用上這個映象;

將映象載入到kubernetes環境

此時的映象儲存在開發環境的電腦上,可以有以下三種方式載入到kubernetes環境:

  1. push到私有倉庫,kubernetes上使用時也從私有倉庫獲取;
  2. push到hub.docker.com,kubernetes上使用時也從hub.docker.com獲取,目前我已經將此映象push到hub.docker.com,您在kubernetes直接使用即可,就像nginx、tomcat這些官方映象一樣下載;
  3. 在開發環境執行docker save bolingcavalry/probedemo:0.0.1 > probedemo.tar,可將此映象另存為本地檔案,再scp到kubernetes伺服器,再在kubernetes伺服器執行docker load < /root/temp/202006/04/probedemo.tar就能載入到kubernetes伺服器的本地docker快取中;

以上三種方法的優缺點整理如下:

  1. 首推第一種,但是需要您搭建私有倉庫;
  2. 由於springboot-2.3官方對映象構建作了優化,第二種方法也就執行第一次的時候上傳和下載很耗時,之後修改java程式碼重新構建時,不論上傳還是下載都很快(只上傳下載某個layer);
  3. 在開發階段,使用第三種方法最為便捷,但如果kubernetes環境有多臺機器,就不合適了,因為映象是存在指定機器的本地快取的;

我的kubernetes環境只有一臺電腦,因此用的是方法三,參考命令如下(建議安裝sshpass,就不用每次輸入帳號密碼了):

# 將映象儲存為tar檔案
sudo docker save bolingcavalry/probedemo:0.0.1 > probedemo.tar

# scp到kubernetes伺服器
sshpass -p 888888 scp ./probedemo.tar root@192.168.50.135:/root/temp/202006/04/ 
  
# 遠端執行ssh命令,載入docker映象
sshpass -p 888888 ssh root@192.168.50.135 "docker load < /root/temp/202006/04/probedemo.tar"

kubernetes部署deployment和service

  1. 在kubernetes建立名為probedemo.yaml的檔案,內容如下,注意pod副本數是2,另外請關注livenessProbe和readinessProbe的引數配置:
apiVersion: v1
kind: Service
metadata:
  name: probedemo
spec:
  type: NodePort
  ports:
    - port: 8080
      nodePort: 30080
  selector:
    name: probedemo
---
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: probedemo
spec:
  replicas: 2
  template:
    metadata:
      labels:
        name: probedemo
    spec:
      containers:
        - name: probedemo
          image: bolingcavalry/probedemo:0.0.1
          tty: true
          livenessProbe:
            httpGet:
              path: /actuator/health/liveness
              port: 8080
            initialDelaySeconds: 5
            failureThreshold: 10
            timeoutSeconds: 10
            periodSeconds: 5
          readinessProbe:
            httpGet:
              path: /actuator/health/readiness
              port: 8080
            initialDelaySeconds: 5
            timeoutSeconds: 10
            periodSeconds: 5
          ports:
            - containerPort: 8080
          resources:
            requests:
              memory: "512Mi"
              cpu: "100m"
            limits:
              memory: "1Gi"
              cpu: "500m"
  1. 執行命令kubectl apply -f probedemo..yaml,即可建立deployment和service:

在這裡插入圖片描述

  1. 這裡要重點關注的是livenessProbeinitialDelaySecondsfailureThreshold引數,initialDelaySeconds等於5,表示pod建立5秒後檢查存活探針,如果10秒內應用沒有完成啟動,存活探針不返回200,就會重試10次(failureThreshold等於10),如果重試10次後存活探針依舊無法返回200,該pod就會被kubernetes殺死重建,要是每次啟動都耗時這麼長,pod就會不停的被殺死重建;
  2. 執行命令kubectl apply -f probedemo.yaml,建立deployment和service,如下圖,可見在第十秒的時候pod建立成功,但是此時還未就緒:

在這裡插入圖片描述

  1. 繼續檢視狀態,建立一分鐘後兩個pod終於就緒:

在這裡插入圖片描述

  1. kubectl describe命令檢視pod狀態,事件通知顯示存活和就緒探針都有失敗情況,不過因為有重試,因此後來狀態會變為成功:

在這裡插入圖片描述

至此,從編碼到部署都完成了,接下來驗證SpringBoot-2.3.0.RELEASE的探針技術;

驗證SpringBoot-2.3.0.RELEASE的探針技術

  1. 監聽類AvailabilityListener的作用是監聽狀態變化,看看pod日誌,看AvailabilityListener的程式碼是否有效,如下圖紅框,在應用啟動階段AvailabilityListener被成功回撥,列印了存活和就緒狀態:

在這裡插入圖片描述

  1. kubernetes所在機器的IP地址是192.168.50.135,因此SpringBoot服務的訪問地址是http://192.168.50.135:30080/xxx

  2. 訪問地址http://192.168.50.135:30080/actuator/health/liveness,返回碼如下圖紅框,可見存活探針已開啟:

在這裡插入圖片描述

  1. 就緒探針也正常:

在這裡插入圖片描述

  1. 開啟兩個瀏覽器,都訪問:http://192.168.50.135:30080/hello,多次Ctrl+F5強刷,如下圖,很快就能得到不同結果,證明響應來自不同的Pod:

在這裡插入圖片描述

  1. 訪問:http://192.168.50.135:30080/statereader/get,可以得到存活和就緒的狀態,可見StateReader的程式碼已經生效,可以通過ApplicationAvailability介面取得狀態:

在這裡插入圖片描述

  1. 修改就緒狀態,訪問:http://192.168.50.135:30080/statewriter/refuse,如下圖紅框,可見收到請求的pod,其就緒狀態已經出現了異常,證明StateWritter.java中修改就緒狀態後,可以讓kubernetes感知到這個pod的異常

在這裡插入圖片描述

  1. 用瀏覽器反覆強刷hello介面,返回的Pod地址也只有一個,證明只有一個Pod在響應請求:

在這裡插入圖片描述

  1. 嘗試恢復服務,注意請求要在伺服器後臺傳送,而且IP地址要用剛才被設定為refuse的pod地址
curl http://10.233.90.195:8080/statewriter/accept
  1. 如下圖,狀態已經恢復:

在這裡插入圖片描述

  1. 最後再來試試將存活狀態從CORRECT改成BROKEN,瀏覽器訪問:http://192.168.50.135:30080/statewriter/broken
  2. 如下圖紅框,重啟次數變成1,表示pod被殺死了一次,並且由於重啟導致當前還未就緒,證明在SpringBoot中修改了存活探針的狀態,是會觸發kubernetes殺死pod的

在這裡插入圖片描述

  1. 等待pod重啟、就緒探針正常後,一切恢復如初:

在這裡插入圖片描述

  1. 強刷瀏覽器,如下圖紅框,兩個Pod都能正常響應:

在這裡插入圖片描述

官方忠告

  • 至此,《掌握SpringBoot-2.3的容器探針》系列就全部完成了,從理論到實踐,我們們一起學習了SpringBoot官方帶給我們的容器化技術,最後以一段官方忠告來結尾,大家一起將此忠告牢記在心:

在這裡插入圖片描述

  • 我對以上內容的理解:選擇外部系統的服務作為探針的時候要謹慎(外部系統可能是資料庫,也可能是其他web服務),如果外部系統出現問題,會導致kubernetes殺死pod(存活探針問題),或者導致kubernetes不再排程請求到pod(就緒探針問題);(再請感謝大家容忍我的英語水平)

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

在這裡插入圖片描述

https://github.com/zq2599/blog_demos

相關文章