一键部署 SpringCloud 微服务，这套流程值得学习一波儿！

水深无声 2024-04-21 19:10 8阅读 0赞

#### 文章目录 ####

*   *  前言
     *  1、开发者将代码PUSH到Git
     *  2、通过Jenkins部署，自动到Git上PULL代码
     *   *   *  2.1、 配置SSH-KEY
             *   *  2.1.1、生成/添加SSH公钥
                 *  2.1.2、将公钥配置到git平台
                 *  2.1.3、测试
             *  2.2、配置Jenkins的pipeline 自动clone代码
             *   *  2.2.1、Jenkins创建任务
                 *  2.2.2、测试拉代码流程\*
     *  3、通过maven构建代码
     *   *   *  3.1、maven插件安装
             *  3.2、maven构建项目
             *  3.3、测试拉代码流程+构建项目过程
     *  4、将maven构建后的jar打包成docker镜像 并 push docker镜像到docker registry
     *  5、通过k8s发起 发布/更新 服务 操作
     *   *   *  5.1、配置构建K8S资源的描述文件
             *  5.2、完善jenkins步骤
             *  5.3、测试

### 前言 ###

一键部署 springcloud 微服务，需要用到 Jenkins K8S Docker等工具。

本文使用jenkins部署，流程如下图

![图片][647730c5da7c18de9a7856f3a61fd2aa.png]

1.  开发者将代码push到git
2.  运维人员通过jenkins部署，自动到git上pull代码
3.  通过maven构建代码
4.  将maven构建后的jar打包成docker镜像 并 push docker镜像到docker registry
5.  通过k8s发起 发布/更新 服务 操作

其中 2~5步骤都会在jenkins中进行操作

### 1、开发者将代码PUSH到Git ###

这一步本文不做详细描述

### 2、通过Jenkins部署，自动到Git上PULL代码 ###

这里需要用到Jenkins 的 pipeline插件

##### 2.1、 配置SSH-KEY #####

因为jenkins需要`pull` git上的代码，正常来说，代码都是私有的，`git clone`操作的时候会需要密码，就不能完成自动化操作了。这里使用`SSH-KEY` 的方式，让`git clone`操作无需密码就能完成克隆

###### 2.1.1、生成/添加SSH公钥 ######

在jenkins所在环境里执行

ssh-keygen -t ed25519 -C "xxxxx@xxxxx.com"

> 注意：这里的 `xxxxx@xxxxx.com` 只是生成的 sshkey 的名称，并不约束或要求具体命名为某个邮箱，现网的大部分教程均讲解的使用邮箱生成，其一开始的初衷仅仅是为了便于辨识所以使用了邮箱

按照提示完成三次回车，即可生成 `ssh key`。通过查看 `~/.ssh/id_ed25519.pub` 文件内容，获取到你的 `public key`

![图片][fc2701a744de4b838d5e34d4ba382673.png]

得到公钥 public key 内容

cat ~/.ssh/id_ed25519.pub

复制备用

###### 2.1.2、将公钥配置到git平台 ######

git平台可以是github，gitee，也可以是自己搭建的gitlab等

我这里使用gitee

通过仓库主页 「`管理`」->「`部署公钥管理`」->「`添加部署公钥`」 ，添加生成的 public key 添加到仓库中。

![图片][681f7276860809239c3e383ceb051dce.png]

添加成功后，到jenkins所在环境运行

ssh -T git@gitee.com

![图片][851a59994b5fbc80c9c6fa2d89fe8c15.png]

首次使用需要确认并添加主机到本机SSH可信列表。若返回 `Hi XXX! You’ve successfully authenticated, but Gitee.com does not provide shell access.` 内容，则证明添加成功

###### 2.1.3、测试 ######

复制你项目的SSH链接

![图片][ca31799a0661a710454ecd21adeaf81a.png]

在jenkins所在环境

执行`git clone git@gitee.com:xxxx.git`

![图片][6a633b70f037606d8c3846e295af51fd.png]

##### 2.2、配置Jenkins的pipeline 自动clone代码 #####

###### 2.2.1、Jenkins创建任务 ######

新建任务

![图片][016e9564d1fac747b0b03614b050afcd.png]

选择流水线 确定

![图片][f854c9088afd1073edd277f6a884b2ed.png]

这里勾选参数化构建，选择字符参数，用于输入构建代码的版本

![图片][c98a4907db23ec532171b5aafa0b0280.png]

默认值填master，根据自身项目实际填写

![图片][d8340b401b7ec69d0d6485c025787cff.png]

拉到最下面的流水线，写pipeline脚本，如果不知道怎么写，可以点击流水线语法进行参考

![图片][88c7d27d9c8381834814399f3dd4e509.png]

这是我的脚本， `REPOSITORY` 填写项目的ssh地址，`REPOSITORY_VERSION`是刚刚配置的构建参数

pipeline {
        
        agent any
        
        environment {
        
            REPOSITORY="git@gitee.com:xxxxxx/cloud-demo.git"
        }
        
        stages {
        
            stage('拉代码') {
        
                steps {
        
                    echo "start fetch code from git:${REPOSITORY}"
                    deleteDir()
                    git branch: "${REPOSITORY_VERSION}", url: "${REPOSITORY}"
                }
            }
        }
    }

保存

###### 2.2.2、测试拉代码流程\* ######

返回Jenkins 首页，选择刚刚创建的项目

![图片][6761b56152a4492523e04edf1ea658e1.png]

点击右边的运行按钮

![图片][c8926cfad903dd4be76322ee231cf5a7.png]

输入代码分支版本

点击开始构建

![图片][cafd7c6f3aa6db273c6000eb751c2da6.png]

看到这里就是已经构建成功了

![图片][1a2c9923a75c9dab2a27ade401c8444d.png]

根据日志提示的目录，可以看到目录下已经有代码了

### 3、通过maven构建代码 ###

##### 3.1、maven插件安装 #####

因为这里使用到了maven，jenkins需要先安装maven工具

##### 3.2、maven构建项目 #####

补充pipeline脚本

pipeline {
        
        agent any
        
        environment {
        
            REPOSITORY="git@gitee.com:xxxxxx/cloud-demo.git"
            MODULE="cloud-demo-m-test-dubbo-service"
        }
        
        stages {
        
            stage('拉代码') {
        
                steps {
        
                    echo "start fetch code from git:${REPOSITORY}"
                    deleteDir()
                    git branch: "${REPOSITORY_VERSION}", url: "${REPOSITORY}"
                }
            }
            
            stage('编译代码') {
        
                steps {
        
                    echo "start compile"
                    sh "cd cloud-demo-project && mvn -U clean install"
                    echo "compile project ................................"
                    sh "cd cloud-demo-dependencies && mvn -U clean install"
                    echo "compile dependencies ................................"
                    sh "cd cloud-demo-common && mvn -U clean install"
                    echo "compile common ................................"
                    sh "cd cloud-demo-m-test && mvn -U -am clean install"
                    echo "compile m-test ................................"
                    sh "cd cloud-demo-m-test/cloud-demo-m-test-common && mvn -U -am clean install"
                    echo "compile m-test-dubbo-api ................................"
                    sh "cd cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-api && mvn -U -am clean install"
                    echo "compile m-test-dubbo-service ................................"
                    sh "cd cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service && mvn -U -am clean package"
                }
            }
        }
    }

这里补充了`stage('编译代码') {}`部分，用于maven编译。具体编译脚本需要根据自己项目实际，这个是我项目的编译必须步骤。

##### 3.3、测试拉代码流程+构建项目过程 #####

重复2.2.2步骤，查看运行结果

![图片][66633a1db9a0b86277671962fb85a9df.png]

构建成功

### 4、将maven构建后的jar打包成docker镜像 并 push docker镜像到docker registry ###

在jenkins环境下，创建目录用于存放脚本文件

mkdir /usr/local/project/.env/cloud-demo-m-test-dubbo-service/ -p

这个目录下存放4个文件

*  build.sh
 *  Dockerfile
 *  application.properties
 *  bootstrap.properties

`application.properties` 和 `bootstrap.properties` 是springcloud的配置文件，内容根据自己项目情况

**buils.sh 文件内容**

#!/usr/bin/env bash
    
    REPOSITORY_VERSION=$1
    GIT_REVISION=`git log -1 --pretty=format:"%h"`
    TIME=`date "+%Y.%m.%d.%H.%M"`
    IMAGE_NAME=192.168.31.100:5000/cloud-demo/cloud-demo-m-test-dubbo-service
    IMAGE_TAG=${REPOSITORY_VERSION}-${GIT_REVISION}-${TIME}
    
    docker build -t ${IMAGE_NAME}:${IMAGE_TAG} .
    
    docker push ${IMAGE_NAME}:${IMAGE_TAG}
    
    echo "${IMAGE_NAME}:${IMAGE_TAG}" > IMAGE
    ## 内容说明
    REPOSITORY_VERSION 是需要传入的参数，传项目git分支名，用于打标签使用
    GIT_REVISION 是获取当前git的提交版本 如 c9c8525，线上问题可以根据这个版本查找具体代码问题
    TIME 年.月.日.时.分  记录打包时间，也用于打标签使用
    IMAGE_NAME 镜像名，这里前缀包含了192.168.31.100:5000 是因为我打包之后会push到192.168.31.100:5000，其他服务器可以到这里来pull镜像
    docker build -t ${IMAGE_NAME}:${IMAGE_TAG} . 构建镜像
    docker push ${IMAGE_NAME}:${IMAGE_TAG}  推送镜像
    echo "${IMAGE_NAME}:${IMAGE_TAG}" > IMAGE  把镜像名:镜像标签 输出到IMAGE文件里，方便后续步骤获取

**Dockerfile 文件内容**

FROM openjdk:8u342-jdk
    MAINTAINER yanger yanger@qq.com
    
    COPY target/cloud-demo-m-test-dubbo-service-1.0-SNAPSHOT.jar /cloud-demo-m-test-dubbo-service.jar
    COPY application.properties /application.properties
    COPY bootstrap.properties /bootstrap.properties
    ENTRYPOINT ["java", "-jar", "/cloud-demo-m-test-dubbo-service.jar"]
    ## 内容说明
    FROM openjdk:8u342-jdk 使用openjdk:8u342-jdk 作为基础镜像
    COPY 文件到镜像
    ENTRYPOINT ["java", "-jar", "/cloud-demo-m-test-dubbo-service.jar"] 启动时运行 java -jar /cloud-demo-m-test-dubbo-service.jar

这里用到了`docker registry`如果还没有registry 请先启动，可以用docker的方式启动

docker run -d -p 5000:5000 --name registry registry

`build.sh`文件需要可执行权限

chmod 755 build.sh

补充pipeline脚本

pipeline {
        
        agent any
        
        environment {
        
            REPOSITORY="git@gitee.com:xxxxxx/cloud-demo.git"
            SCRIPT_PATH="/usr/local/project/.env/cloud-demo-m-test-dubbo-service/"
        }
        
        stages {
        
            stage('拉代码') {
        
                steps {
        
                    echo "start fetch code from git:${REPOSITORY}"
                    deleteDir()
                    git branch: "${REPOSITORY_VERSION}", url: "${REPOSITORY}"
                }
            }
            
            stage('编译代码') {
        
                steps {
        
                    echo "start compile"
                    sh "cd cloud-demo-project && /usr/local/maven/bin/mvn -U clean install"
                    echo "compile project ................................"
                    sh "cd cloud-demo-dependencies && /usr/local/maven/bin/mvn -U clean install"
                    echo "compile dependencies ................................"
                    sh "cd cloud-demo-common && /usr/local/maven/bin/mvn -U clean install"
                    echo "compile common ................................"
                    sh "cd cloud-demo-m-test && /usr/local/maven/bin/mvn -U -am clean install"
                    echo "compile m-test ................................"
                    sh "cd cloud-demo-m-test/cloud-demo-m-test-common && /usr/local/maven/bin/mvn -U -am clean install"
                    echo "compile m-test-dubbo-api ................................"
                    sh "cd cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-api && /usr/local/maven/bin/mvn -U -am clean install"
                    echo "compile m-test-dubbo-service ................................"
                    sh "cd cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service && /usr/local/maven/bin/mvn -U -am clean package"
                }
            }
    
            stage('构建镜像') {
        
                steps {
        
                    echo "start build image"
                    sh "cp ${SCRIPT_PATH}/build.sh cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/"
                    sh "cp ${SCRIPT_PATH}/Dockerfile cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/"
                    sh "cp ${SCRIPT_PATH}/application.properties cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/"
                    sh "cp ${SCRIPT_PATH}/bootstrap.properties cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/"
                    sh "cd cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/ && ./build.sh ${REPOSITORY_VERSION}"
                }
            }
    
        }
    }

补充了`stage(‘构建镜像’){}` 内容和`environment` 部分加了个参数 `SCRIPT_PATH`

`SCRIPT_PATH`参数是上面创建的文件夹路径

`stage(‘构建镜像’){}`这一步是复制相应文件到项目目录下，并且执行build.sh脚本

**测试**

![图片][95794087837f54585b2fa65c1632b8e1.png]

可以看到镜像已经打包好，并且已经push到registry了

*  浏览器访问`http://192.168.31.100:5000/v2/cloud-demo/cloud-demo-m-test-dubbo-service/tags/list`可以看到registry有`cloud-demo/cloud-demo-m-test-dubbo-service:master-7012e1d-2023.05.01.10.16`这个镜像

### 5、通过k8s发起 发布/更新 服务 操作 ###

##### 5.1、配置构建K8S资源的描述文件 #####

*  在 `/usr/local/project/.env/cloud-demo-m-test-dubbo-service/` 目录新增文件 `cloud-demo-m-test-dubbo-service.yaml`

**文件内容**

apiVersion: apps/v1
    kind: Deployment
    metadata:
      creationTimestamp: null
      labels:
        app: cloud-demo-m-test-dubbo-service
      name: cloud-demo-m-test-dubbo-service
    spec:
      replicas: 1
      selector:
        matchLabels:
          app: cloud-demo-m-test-dubbo-service
      strategy: {
        }
      template:
        metadata:
          creationTimestamp: null
          labels:
            app: cloud-demo-m-test-dubbo-service
        spec:
          containers:
          - image: IMAGE_AND_TAG
            name: cloud-demo-m-test-dubbo-service
            resources: {
        }
            volumeMounts: 
            - name: log-path
              mountPath: /logs
          volumes: 
          - name: log-path
            hostPath: 
              path: /root/k8s/cloud-demo-m-test-dubbo-service/logs
    status: {
        }
    
    ---
    
    apiVersion: v1
    kind: Service
    metadata:
      creationTimestamp: null
      labels:
        app: cloud-demo-m-test-dubbo-service
      name: cloud-demo-m-test-dubbo-service
    spec:
      ports:
      - port: 20881
        protocol: TCP
        targetPort: 20881
      selector:
        app: cloud-demo-m-test-dubbo-service
      type: NodePort
    status:
      loadBalancer: {
        }

这个文件是构建K8S资源的描述文件，创建`deployment` 和`service`，暴露端口20881，挂载/logs目录到主机

其中 `IMAGE_AND_TAG` 是需要替换为相应 `容器名:容器标签` 的

##### 5.2、完善jenkins步骤 #####

pipeline {
        
        agent any
        
        environment {
        
            REPOSITORY="git@gitee.com:xxxxxx/cloud-demo.git"
            SCRIPT_PATH="/usr/local/project/.env/cloud-demo-m-test-dubbo-service"
            IMAGE=""
        }
        
        stages {
        
            stage('拉代码') {
        
                steps {
        
                    echo "start fetch code from git:${REPOSITORY}"
                    deleteDir()
                    git branch: "${REPOSITORY_VERSION}", url: "${REPOSITORY}"
                }
            }
            
            stage('编译代码') {
        
                steps {
        
                    echo "start compile"
                    sh "cd cloud-demo-project && /usr/local/maven/bin/mvn -U clean install"
                    echo "compile project ................................"
                    sh "cd cloud-demo-dependencies && /usr/local/maven/bin/mvn -U clean install"
                    echo "compile dependencies ................................"
                    sh "cd cloud-demo-common && /usr/local/maven/bin/mvn -U clean install"
                    echo "compile common ................................"
                    sh "cd cloud-demo-m-test && /usr/local/maven/bin/mvn -U -am clean install"
                    echo "compile m-test ................................"
                    sh "cd cloud-demo-m-test/cloud-demo-m-test-common && /usr/local/maven/bin/mvn -U -am clean install"
                    echo "compile m-test-dubbo-api ................................"
                    sh "cd cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-api && /usr/local/maven/bin/mvn -U -am clean install"
                    echo "compile m-test-dubbo-service ................................"
                    sh "cd cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service && /usr/local/maven/bin/mvn -U -am clean package"
                }
            }
    
            stage('构建镜像') {
        
                steps {
        
                    echo "start build image"
                    sh "cp ${SCRIPT_PATH}/build.sh cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/"
                    sh "cp ${SCRIPT_PATH}/Dockerfile cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/"
                    sh "cp ${SCRIPT_PATH}/application.properties cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/"
                    sh "cp ${SCRIPT_PATH}/bootstrap.properties cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/"
                    sh "cd cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/ && ./build.sh ${REPOSITORY_VERSION}"
                }
            }
    
            stage('发布') {
        
                steps {
        
                    echo "start deploy"
                    script {
        
                        IMAGE = readFile "cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/IMAGE"
                        IMAGE = IMAGE.trim()
                        if (IMAGE == "") {
        
                            throw new Exception("获取镜像名文件失败，请重试")
                        }
                    }
                    echo "IMAGE: -- ${IMAGE}"
                    sh "cp ${SCRIPT_PATH}/cloud-demo-m-test-dubbo-service.yaml cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/"
                    sh "sed -i \"s#IMAGE_AND_TAG#${IMAGE}#g\" cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/cloud-demo-m-test-dubbo-service.yaml"
                    sh "kubectl apply -f cloud-demo-m-test/dubbo/cloud-demo-m-test-dubbo-service/cloud-demo-m-test-dubbo-service.yaml"
                }
            }
        }
    }

**添加了 `stage('发布') {}` 部分**

*  通过读取IMAGE文件，获取`镜像名:镜像标签`
 *  如果获取不到`镜像名:镜像标签`，抛出异常
 *  将`cloud-demo-m-test-dubbo-service.yaml`文件复制到工作目录
 *  用镜像名:镜像标签 替换掉 `IMAGE_AND_TAG`
 *  使用kubectl命令发布/更新服务

##### 5.3、测试 #####

在jenkins上构建项目

![图片][24259f0c11e6704bda1f0ada1ef65db8.png]

在K8S master服务器上，执行

kubectl get all

![图片][73bd0ce479d8d773a7f21fc08b6958fa.png]

搞定！

[647730c5da7c18de9a7856f3a61fd2aa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/5d9d831f45784350b7701993df0ff048.png
[fc2701a744de4b838d5e34d4ba382673.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/5daf6c04e99c4c80b02351fdac531adb.png
[681f7276860809239c3e383ceb051dce.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/11bdd5f9bf0046d7a18607a57506fb76.png
[851a59994b5fbc80c9c6fa2d89fe8c15.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/c891126defa94b0ba961c5562ca312e4.png
[ca31799a0661a710454ecd21adeaf81a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/2743b48fa0884266be5f8d386cfc2023.png
[6a633b70f037606d8c3846e295af51fd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/19628eb5e28e433e86caffaa09ba5759.png
[016e9564d1fac747b0b03614b050afcd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/32724e3b24984ba1ac3d4152b4e683d7.png
[f854c9088afd1073edd277f6a884b2ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/9d523c8fd990427ebde5552544c8d082.png
[c98a4907db23ec532171b5aafa0b0280.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/8eb3e95cc4714126a507ab6307dd4d1d.png
[d8340b401b7ec69d0d6485c025787cff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/2763ec589f704c1f958a1e870b37be42.png
[88c7d27d9c8381834814399f3dd4e509.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/b89cab54cf5943a3b1ec3fc4857eb95d.png
[6761b56152a4492523e04edf1ea658e1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/4d558bb4255942bdb4a4069e35ccf9da.png
[c8926cfad903dd4be76322ee231cf5a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/a3b08f15dbd343cd9f59ec6834c7a237.png
[cafd7c6f3aa6db273c6000eb751c2da6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/3fbdd8ec90694a0e97ffd00f67df876b.png
[1a2c9923a75c9dab2a27ade401c8444d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/df87fd4db423492a9a8ba5074b26dc3f.png
[66633a1db9a0b86277671962fb85a9df.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/8240b2af4af442198d2186a107354bcf.png
[95794087837f54585b2fa65c1632b8e1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/9be871e51da24cf3adfa730848ac2b38.png
[24259f0c11e6704bda1f0ada1ef65db8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/d166eb52f2a341a88eb6e5f73ab61a65.png
[73bd0ce479d8d773a7f21fc08b6958fa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/64ffc980c0ff418aa5bac4eb56293ee8.png