簡單幾步把Spring Boot 項目部署到 K8S，步驟來了！
前言
在Kubernetes中部署spring boot應用整體上來說是一件比較繁瑣的事情，而Spring Boot Operator則能帶給你更清爽簡單的體驗。
Spring Boot Operator基于Kubernetes的custom resource definitions (CRDs)擴展API進行的開發。
打包Docker鏡像
在講部署之前我們需要先將我們的SpringBoot應用打包成標準的DockerImage。
java項目打包鏡像用maven/gradle插件比較多，我的另一篇文章構建SpringBoot的Docker鏡像，這里在介紹一個新的google開源的插件Jib，該插件使用起來比較方便。
注意：jib打包的鏡像會導致java應用的pid=1，在使用SpringBootOperator進行發布時候，Operator會設置kubernetes的ShareProcessNamespace參數為true（v1.10+版本都可使用）來解決該問題。
下面就來演示一下我們通過https://start.spring.io生成一個標準的SpringBoot項目operator-demo,然后使用jib插件進行鏡像打包
- mvn com.google.cloud.tools:jib-maven-plugin:build \
- -Djib.to.auth.username=${{ secrets.MY_USERNAME }} \
- -Djib.to.auth.password=${{ secrets.MY_PASSWORD }} \
- -Djib.container.jvmFlags=--add-opens,java.base/sun.nio.ch=ALL-UNNAMED \
- -Djib.from.image=freemanliu/oprenjre:11.0.5 \
- -Dimage=registry.cn-shanghai.aliyuncs.com/qingmuio/operator-demo/operator-demo:v1.0.0
執行上面的命令之后我們將得到一個標準的docker鏡像，該鏡像會被推送到遠程倉庫。
Operator快速體驗
完成了鏡像的構建之后,我們緊接著來安裝我們的Operator到kubernetes集群，當然了首先你需要一套集群，可以參考我之前一篇文章部署高可用kubernetes，雖然版本比較老,但是新版本其實也差不多的一個思路。
https://qingmu.io/2019/05/17/Deploy-a-highly-available-cluster-with-kubeadm/
快速安裝
此處快速安裝只是為了快速體驗demo
- kubectl apply -f https://raw.githubusercontent.com/goudai/spring-boot-operator/master/manifests/deployment.yaml
apply成功之后控制臺輸出
- namespace/spring-boot-operator-system created
- customresourcedefinition.apiextensions.k8s.io/springbootapplications.springboot.qingmu.io created
- role.rbac.authorization.k8s.io/spring-boot-operator-leader-election-role created
- clusterrole.rbac.authorization.k8s.io/spring-boot-operator-manager-role created
- clusterrole.rbac.authorization.k8s.io/spring-boot-operator-proxy-role created
- clusterrole.rbac.authorization.k8s.io/spring-boot-operator-metrics-reader created
- rolebinding.rbac.authorization.k8s.io/spring-boot-operator-leader-election-rolebinding created
- clusterrolebinding.rbac.authorization.k8s.io/spring-boot-operator-manager-rolebinding created
- clusterrolebinding.rbac.authorization.k8s.io/spring-boot-operator-proxy-rolebinding created
- service/spring-boot-operator-controller-manager-metrics-service created
- deployment.apps/spring-boot-operator-controller-manager created
稍等片刻查看是否已經安裝成功
- kubectl get po -n spring-boot-operator-system
成功如下輸出
- NAME READY STATUS RESTARTS AGE
- spring-boot-operator-controller-manager-7f498596bb-wcwtn 2/2 Running 0 2m15s
部署OperatorDemo應用
完成了Operator的部署之后，我們來部署我們第一個應用，這里我們就發布上面我們編寫的springboot應用opreator-demo。
首先我們需要先編寫一個Spring Boot Application 的CRD部署yaml，如下
- # Demo.yaml
- apiVersion: springboot.qingmu.io/v1alpha1
- kind: SpringBootApplication
- metadata:
- name: operator-demo
- spec:
- springBoot:
- version: v1.0.0
- # image: registry.cn-shanghai.aliyuncs.com/qingmuio/operator-demo/operator-demo:v1.0.0
細心的同學可能發現了，為啥連Image都沒有？這怎么發布，就name，version，就能完成發布？是的沒錯！就能完成發布，后面我講詳細講到他是如何完成的。
接著我們apply一下
- kubectl apply -f Demo.yaml
看到console輸出
- springbootapplication.springboot.qingmu.io/operator-demo created
驗證
表示創建成功了，接著我們來看下我們部署的第一個應用，這里我們直接用上面的yaml中的name過濾即可。
查看pod
- ~# kubectl get po | grep operator-demo
- operator-demo-7574f4789c-mg58m 1/1 Running 0 76s
- operator-demo-7574f4789c-ssr8v 1/1 Running 0 76s
- operator-demo-7574f4789c-sznww 1/1 Running 0 76s
查看下我們的pid不等于1的設置是否生效,根據下面的結果可以看到通過設置ShareProcessNamespace該參數我們可以在Kubernetes層面來解決這個pid=1的問題。
- kubectl exec -it operator-demo-7574f4789c-mg58m bash
- bash-5.0# ps -ef
- UID PID PPID C STIME TTY TIME CMD
- root 1 0 0 02:06 ? 00:00:00 /pause
- root 6 0 26 02:06 ? 00:00:09 java --add-opens java.base/sun.nio.ch=ALL-UNNAMED -cp /app/resources:/app/classes:/app/libs/* io.qingmu.operator.operatordemo.Oper...
- root 38 0 0 02:07 pts/0 00:00:00 bash
- root 44 38 0 02:07 pts/0 00:00:00 ps -ef
查看svc
- ~# kubectl get svc | grep operator-demo
- operator-demo ClusterIP 10.101.128.6 <none> 8080/TCP 2m52s
我們來訪問一下試試。
- root@server1:~# curl -i http://10.101.128.6:8080
- HTTP/1.1 200
- Content-Type: text/plain;charset=UTF-8
- Content-Length: 9
- Date: Wed, 08 Apr 2020 08:45:46 GMT
- hello !!!
我們來試著縮減他的副本數到1個
編輯我們的Demo.yaml，加入一個新的屬性replicas
- # Demo.yaml
- apiVersion: springboot.qingmu.io/v1alpha1
- kind: SpringBootApplication
- metadata:
- name: operator-demo
- spec:
- springBoot:
- version: v1.0.0
- replicas: 1
應用一下
- root@server1:~# kubectl apply -f Demo.yaml
- springbootapplication.springboot.qingmu.io/operator-demo configured
再次查看pod，你會發現我們的pod已經縮放為一個副本了
- ~# kubectl get po | grep operator-demo
- operator-demo-7574f4789c-sznww 1/1 Running 0 8m29s
清理operator-demo
要刪除該pod 我們只需要執行delete即可
- ~# kubectl delete -f Demo.yaml
- springbootapplication.springboot.qingmu.io "operator-demo" deleted
再次查看pod，已經沒了
- kubectl get po | grep operator-demo
部署自己的應用
部署自己私有倉庫的應用需要需要先創建secret(如果已經創建跳過即可)
創建docker-registry的secret
- kubectl create \
- secret docker-registry aliyun-registry-secret \
- --docker-server=registry-vpc.cn-hangzhou.aliyuncs.com \
- --docker-username=*** \
- --docker-password=*** \
- --docker-email=***
自己應用的crd Yaml
- apiVersion: springboot.qingmu.io/v1alpha1
- kind: SpringBootApplication
- metadata:
- name: 你的應用的名稱
- spec:
- springBoot:
- version: v1.0.0
- replicas: 1
- image: 你的image地址
- imagePullSecrets:
- - 上面創建的secret
一個完整的Spring Boot Application Yaml
下面是一個完整的yaml屬性結構，大部分屬性我們都可以用默認配置的即可。推薦：一百期Java面試題匯總
不設置屬性，默認使用Operator中設置的通用值詳見后面的自定義安裝Operator。
- apiVersion: springboot.qingmu.io/v1alpha1
- kind: SpringBootApplication
- metadata:
- name: operator-demo
- namespace: default
- spec:
- springBoot:
- # image 可以不設置，如果不設置默認使用 IMAGE_REPOSITORY+/+mate.name+:+spec.springBoot.version
- # registry.cn-shanghai.aliyuncs.com/qingmuio + / + operator-demo + : + v1.0.0
- image: registry.cn-shanghai.aliyuncs.com/qingmuio/operator-demo:v1.0.0
- clusterIp: ""
- version: v1.0.0
- replicas: 1
- resource:
- cpu:
- request: 50m
- limit: ""
- memory:
- request: 1Gi
- limit: 1Gi
- path:
- liveness: /actuator/health
- readiness: /actuator/health
- hostLog: /var/applog
- shutdown: /spring/shutdown
- imagePullSecrets:
- - aliyun-docker-registry-secret
- env:
- - name: EUREKA_SERVERS
- value: http://eureka1:8761/eureka/,http://eureka2:8761/eureka/,http://eureka3:8761/eureka/
- nodeAffinity:
- key: "failure-domain.beta.kubernetes.io/zone"
- operator: "In"
- values:
- - "cn-i"
- - "cn-h"
- - "cn-g"
優雅停機的路徑
由于優雅停機默認是關閉的并且并不支持Get請求所以我們需要開啟和搭個橋
首先在application.yml中啟用
- management:
- endpoints:
- web:
- exposure:
- include: "*"
- endpoint:
- shutdown:
- enabled: true
然后橋接一個Get方法
- @RestController
- public class ShutdownController {
- @Autowired
- private ShutdownEndpoint shutdownEndpoint;
- @GetMapping("/spring/shutdown")
- public Map<String, String> shutdown(HttpServletRequest request) {
- return shutdownEndpoint.shutdown();
- }
- }
node親和的使用
舉一個列子 我們有一個springboot應用 user-service 希望他能分布到3個可用區的6個節點上:
首先我們把機器劃分多個可用區
- cn-i區(node-i1,node-i02)
- cn-h區(node-g1,node-g02)
- cn-g區(node-h1,node-h02)
現在我們有三個可以區 每個區有2臺workload，一共6臺。然后我們需要給這些機器分別打上label。
將全部的i區機器標注為cn-i
- kubectl label node node-i1 failure-domain.beta.kubernetes.io/zone=cn-i
- kubectl label node node-i2 failure-domain.beta.kubernetes.io/zone=cn-i
同理將h區的標注為h，g區同理
- kubectl label node node-h1 failure-domain.beta.kubernetes.io/zone=cn-i
- kubectl label node node-ih2 failure-domain.beta.kubernetes.io/zone=cn-i
現在準備工作我們就緒了，現在我們來設置讓它達到我們的調度效果，像如下編寫即可。
- spec:
- springBoot:
- nodeAffinity: #可以不設置 節點親和 這里演示的是盡量將pod分散到 i h g 三個可用區，默認設置了pod反親和
- key: "failure-domain.beta.kubernetes.io/zone"
- operator: "In"
- values:
- - "cn-i"
- - "cn-h"
- - "cn-g"
Operator 自定義安裝
上面我們快速的安裝了好了，接著我們來講解下如何自定義安裝，以及有哪些自定義的參數，可以個性化的參數我們用環境變量的方式注入。
下面來修改Deployment完成自己個性化的配置部署，從我提供的部署yaml中拉倒最后，找到name是spring-boot-operator-controller-manager的Deployment，我們將修改它。
- apiVersion: apps/v1
- kind: Deployment
- metadata:
- labels:
- control-plane: controller-manager
- name: spring-boot-operator-controller-manager
- namespace: spring-boot-operator-system
- .....
- #注意：一下配置針對通用全局的spring boot默認配置，對crd的spring boot生效，這里不配置也可以在部署的yaml中指定
- # 私有倉庫的地址，比如我的最終打包的鏡像地址是 registry.cn-shanghai.aliyuncs.com/qingmuio/operator-demo/operator-demo:v1.0.0
- # 那么配置的值是 registry.cn-shanghai.aliyuncs.com/qingmuio/operator-demo
- # 配置這個值之后，我們我們如果在發布的yaml中不寫image，那么使用的image就是 IMAGE_REPOSITORY+"/"+mate.name+spec.springBoot.version
- - name: IMAGE_REPOSITORY
- value: registry.cn-shanghai.aliyuncs.com/qingmuio
- # 請求CPU限制
- - name: REQUEST_CPU
- value: 50m
- # 限制最大能用最大CPU java應用可以不用限制，限制不合理會導致啟動異常緩慢
- - name: LIMIT_CPU
- value: ""
- # 請求內存大小
- - name: REQUEST_MEMORY
- value: 500Mi
- # 限制最大內存大小 一般和request一樣大即可
- - name: LIMIT_MEMORY
- value: 500Mi
- # 就緒檢查Path，spring boot actuator 默認Path
- - name: READINESS_PATH
- value: /actuator/health
- # 就緒存活Path，spring boot actuator 默認Path
- - name: LIVENESS_PATH
- value: /actuator/health
- # 就緒存活Path，優雅停機Path
- - name: SHUTDOWN_PATH
- value: /spring/shutdown
- # 復制級 即副本數
- - name: REPLICAS
- value: "3"
- # 將日志外掛到主機磁盤Path，默認兩者相同
- - name: HOST_LOG_PATH
- value: /var/applog
- # 用于pull 鏡像的secrets
- - name: IMAGE_PULL_SECRETS
- value: ""
- # 用于pull 鏡像的secrets
- - name: SPRING_BOOT_DEFAULT_PORT
- value: "8080"
- # node親和，比如我可以設置pod盡量分散在不同可用區cn-i,cn-g,cn-h區
- - name: NODE_AFFINITY_KEY
- value: ""
- - name: NODE_AFFINITY_OPERATOR
- value: ""
- - name: NODE_AFFINITY_VALUES
- value: ""
- # 全局的環境變量，會追加到每個spring boot的每個pod中，格式 k=v;k1=v2,
- # 如 EUREKA_SERVERS=http://eureka1:8761/eureka/,http://eureka2:8761/eureka/,http://eureka3:8761/eureka/;k=v
- - name: SPRING_BOOT_ENV
- value: ""
- image: registry.cn-shanghai.aliyuncs.com/qingmuio/spring-boot-operator-controller:latest
- .....
自定義安裝之后部署
yaml可以簡化為如下。
- apiVersion: springboot.qingmu.io/v1alpha1
- kind: SpringBootApplication
- metadata:
- name: 你的應用的名稱
- spec:
- springBoot:
- version: v1.0.0
附錄
環境變量表格
Github倉庫
SpringBootOperator: https://github.com/goudai/spring-boot-operator
