• Jenkins pipeline 自动部署实践

    最近为公司做Jenkins部署改造，本文为我这几天的研究结果

    之前断断续续学过Jenkins，但从未成功过，原因在于他们都是简单的使用普通项目，我怎么就看不懂，各种配置之间没有逻辑让我有点晕

    此次机会，我重新翻阅了一遍《Jenkins2.x实践指南》，不得不说，带着问题的看书让我效率非常高，一个小时左右我就明白该怎么做了

    这次我使用的是pipeline方式实现，因为这种方式更具逻辑性，前后连贯，容易理解。不过我们得考虑到团队内其他成员的知识储备，所以pipeline文件内的我加满了必要的注释，帮助其他人员快速理解学习

    以下是我编写的pipeline脚本，基于其他项目的改造，各位根据需要进行自己开发，请不要直接使用（每个项目有每个项目的特性，需要结合自己的情况编写），明白我的意思即可。

    要想成功运行SSH，需要安装插件 

    插件名称： SSH Pipeline Steps
    使用说明: https://github.com/jenkinsci/ssh-steps-plugin#pipeline-steps

    1. // 代表整条流水线
    2. pipeline {
    3.     agent any
    4.  
    5.     parameters {
    6.         gitParameter(name: 'branch', defaultValue: 'origin/master', type: 'PT_BRANCH')
    7.         choice(name: '请选择操作', choices: [ "拉取代码-编译-打包-运行", "重启", "启动", "停止" ])
    8.     }
    9.  
    10.     // 设置环境变量
    11.     environment {
    12.         ACTION = "${params.请选择操作}"
    13.  
    14.         // ========== 远程服务器信息 ================
    15.         REMOTE_HOST = "${REMOTE_LOCAL_HOST_27}"
    16.         REMOTE_USER = "${REMOTE_LOCAL_USER_27}"
    17.         REMOTE_PASSWORD = "${REMOTE_LOCAL_PASSWORD_27}"
    18.         // 需要传输的文件路径
    19.         FILE_NAME = ""
    20.         SOURCE_FILE_PATH = ""
    21.         // 传输到目标服务器的位置
    22.         TARGET_PATH = ""
    23.         // jar包备份路径
    24.         BACKUP_PATH = ""
    25.         // 运行，启动位置
    26.         RUN_PATH = ""
    27.     }
    28.  
    29.     // pipeline选项
    30.     options {
    31.         // 保存最近历史构建记录数量
    32.         buildDiscarder(logRotator(numToKeepStr: '10'))
    33.         // 禁止pipeline同时执行
    34.         disableConcurrentBuilds()
    35.         // 失败时重试总次数
    36.         // retry(2)
    37.         // pipeline执行时间过长，超过timeout时间就停止掉pipeline
    38.         timeout(time: 3, unit: 'MINUTES')
    39.     }
    40.  
    41.     // 阶段容器
    42.     stages {
    43.         // 阶段：重新构建
    44.         stage('build and run') {
    45.             when {
    46.                 environment name: 'ACTION', value: '拉取代码-编译-打包-运行'
    47.             }
    48.             steps {
    49.                 script {
    50.                     echo "====================  开始重新构建项目   ========================"
    51.                     echo "======================  项目打包   ============================"
    52.                     sh "mvn clean package -DskipTests -Dmaven.compile.fork=true -U -B -pl motionplus-visual/motionplus-codegen -am -amd"
    53.  
    54.  
    55.                     echo "=================  将jar包发送到远程服务器  ====================="
    56.  
    57.                     def remote = [:]
    58.                     remote.name = "${REMOTE_HOST}"
    59.                     remote.host = "${REMOTE_HOST}"
    60.                     remote.user = "${REMOTE_USER}"
    61.                     remote.password = "${REMOTE_PASSWORD}"
    62.                     remote.allowAnyHosts = true
    63.  
    64.                     sshPut remote: remote, from: "${SOURCE_FILE_PATH}" , into: "${TARGET_PATH}"
    65.  
    66.                     echo "备份"
    67.                     sshCommand remote: remote, command: "cp ${RUN_PATH}${FILE_NAME}.jar ${BACKUP_PATH}${FILE_NAME}-" + '$(date +%Y-%m-%d-%H%M%S).jar'
    68.  
    69.                     echo "关闭"
    70.                     try {
    71.                         sshCommand remote: remote, command: "jps -l | grep ${FILE_NAME}.jar | cut -d' ' -f1 | xargs kill"
    72.                     } catch(err) {
    73.                         echo "关闭失败：${FILE_NAME}没有启动"
    74.                     }
    75.  
    76.                     echo "替换新包"
    77.                     sshCommand remote: remote, command: "cp ${TARGET_PATH}${FILE_NAME}.jar ${RUN_PATH}"
    78.  
    79.                     // 睡眠5秒，等待应用停止完毕再启动
    80.                     sleep(5)
    81.  
    82.                     echo "启动"
    83.                     sshCommand remote: remote, command: "java -javaagent:/usr/local/skywalking/agent/skywalking-agent.jar -Dskywalking.agent.service_name=${FILE_NAME} -Dskywalking.collector.backend_service=127.0.0.1:11800 -jar ${RUN_PATH}${FILE_NAME}.jar --spring.profiles.active=test >" + '/logs/${FILE_NAME}/log-$(date +%Y%m%d).txt 2>&1 &'
    84.  
    85.                 }
    86.             }
    87.         }
    88.  
    89.         // 阶段：启动
    90.         stage('start') {
    91.             when {
    92.                 environment name: 'ACTION', value: '启动'
    93.             }
    94.             steps {
    95.                 script {
    96.                     echo "======================  启动项目   =========================="
    97.                     def remote = [:]
    98.                     remote.name = "${REMOTE_HOST}"
    99.                     remote.host = "${REMOTE_HOST}"
    100.                     remote.user = "${REMOTE_USER}"
    101.                     remote.password = "${REMOTE_PASSWORD}"
    102.                     remote.allowAnyHosts = true
    103.  
    104.                     sshCommand remote: remote, command: "java -javaagent:/usr/local/skywalking/agent/skywalking-agent.jar -Dskywalking.agent.service_name=${FILE_NAME} -Dskywalking.collector.backend_service=127.0.0.1:11800 -jar ${RUN_PATH}${FILE_NAME}.jar --spring.profiles.active=test >" + '/logs/${FILE_NAME}/log-$(date +%Y%m%d).txt 2>&1 &'
    105.                 }
    106.             }
    107.         }
    108.  
    109.         // 阶段：停止
    110.         stage('stop') {
    111.             when {
    112.                 environment name: 'ACTION', value: '停止'
    113.             }
    114.             steps {
    115.                 script {
    116.                     echo "======================  停止项目   =========================="
    117.                     def remote = [:]
    118.                     remote.name = "${REMOTE_HOST}"
    119.                     remote.host = "${REMOTE_HOST}"
    120.                     remote.user = "${REMOTE_USER}"
    121.                     remote.password = "${REMOTE_PASSWORD}"
    122.                     remote.allowAnyHosts = true
    123.  
    124.                     try {
    125.                         sshCommand remote: remote, command: "jps -l | grep ${FILE_NAME}.jar | cut -d' ' -f1 | xargs kill"
    126.                     } catch(err) {
    127.                         echo "关闭失败：${FILE_NAME}没有启动"
    128.                     }
    129.                 }
    130.             }
    131.         }
    132.         // 阶段：重启
    133.         stage('restart') {
    134.             when {
    135.                 environment name: 'ACTION', value: '重启'
    136.             }
    137.             steps {
    138.                 script {
    139.                     echo "======================  重启项目   =========================="
    140.                     echo "关闭"
    141.  
    142.                     def remote = [:]
    143.                     remote.name = "${REMOTE_HOST}"
    144.                     remote.host = "${REMOTE_HOST}"
    145.                     remote.user = "${REMOTE_USER}"
    146.                     remote.password = "${REMOTE_PASSWORD}"
    147.                     remote.allowAnyHosts = true
    148.  
    149.                     try {
    150.                         sshCommand remote: remote, command: "jps -l | grep ${FILE_NAME}.jar | cut -d' ' -f1 | xargs kill"
    151.                     } catch(err) {
    152.                         echo "关闭失败：${FILE_NAME}没有启动"
    153.                     }
    154.  
    155.                     // 睡眠5秒，等待应用停止完毕再启动
    156.                     sleep(5)
    157.  
    158.                     sshCommand remote: remote, command: "java -javaagent:/usr/local/skywalking/agent/skywalking-agent.jar -Dskywalking.agent.service_name=${FILE_NAME} -Dskywalking.collector.backend_service=127.0.0.1:11800 -jar ${RUN_PATH}${FILE_NAME}.jar --spring.profiles.active=test >" + '/logs/${FILE_NAME}/log-$(date +%Y%m%d).txt 2>&1 &'
    159.                 }
    160.             }
    161.         }
    162.     }
    163.  
    164.     // 整个pipeline完成后
    165.     post {
    166.  
    167.         // 状态为失败执行
    168.         failure {
    169.             echo "======================  运行失败   =========================="
    170.         }
    171.  
    172.         // 状态为成功执行
    173.         success {
    174.             echo "======================  运行成功   =========================="
    175.             //    mail  subject: '关于xxx日的构建反馈-成功', body: '构建成功了', from: 'xxx@163.com',, to: 'to@163.com' // 可以邮件通知或者webhook
    176.             }
    177.         }
    178. }

    由于我不怎么会groovy，所以代码有大量冗余，如果各位能够告诉我怎么抽出来，不胜感激。

    另外我也将groovy书籍加入了我的书架，偶尔翻翻，由于是英文的，学起来还是有点吃力，不过当初也看在可以练习阅读能力倒也挺好

    没有花太多时间在这个上面，是因为这也不是我的主业，慢慢优化吧

    这是第二个的

    这个项目的特性就是用SSH做的，还是非MAVEN项目，所以使用了ANT打包，然后使用Tomcat运行

    1. // 代表整条流水线
    2. pipeline {
    3.     agent any
    4.  
    5.     parameters {
    6.         choice(name: 'branch', choices: ['master', 'dev', 'test'], description: '请选择构建分支')
    7.     }
    8.  
    9.     // 设置环境变量
    10.     environment {
    11.         // 安装Jenkins的操作系统类正在停止tomcat型：可选值 windows / linux
    12.         OS = "linux"
    13.         // 本机：ant自动生成打包配置文件位正在停止tomcat置(不带文件后缀)
    14.         ANT_GENERATE_BUILD_PATH = "/usr/lib/jenkins/generate-build"
    15.         // 本机：ant位置
    16.         ANT_HOME = "/usr/lib/jenkins/apache-ant-1.9.16"
    17.         // 本机：tomcat home目录路径
    18.         TOMCAT_HOME = "/usr/lib/jenkins/apache-tomcat-8.5.75"
    19.  
    20.         // 项目部署类型 local(本地) remote(远程服务器)
    21.         DEPLOY_TYPE = "remote"
    22.  
    23.         ///  ========== 如果部署到远程服务器 就填写下面的内容  ============
    24.         // windows / linux
    25.         REMOTE_OS = "linux"
    26.         REMOTE_HOST = ""
    27.         REMOTE_USER = ""
    28.         REMOTE_PASSWORD = ""
    29.         // windows 路径示例：/D:/developer/apache-tomcat-8.5.75 注意前面要加个/
    30.         REMOTE_TOMCAT_HOME = ""
    31.  
    32.         // 如果部署的是远程windows，就填写下面tomcat服务名称
    33.         REMOTE_WINDOWS_TOMCAT_SERVICE_NAME = "Tomcat"
    34.  
    35.     }
    36.  
    37.     // pipeline选项
    38.     options {
    39.         // 保存最近历史构建记录数量
    40.         buildDiscarder(logRotator(numToKeepStr: '10'))
    41.         // 禁止pipeline同时执行
    42.         disableConcurrentBuilds()
    43.         // 失败时重试总次数
    44.         // retry(2)
    45.         // pipeline执行时间过长，超过timeout时间就停止掉pipeline
    46.         timeout(time: 3, unit: 'MINUTES')
    47.     }
    48.  
    49.     // 阶段容器
    50.     stages {
    51.         // 流水线的阶段
    52.         // 1.拉取代码
    53.         stage("check out"){
    54.             // 步骤
    55.             steps {
    56.                 echo "==========================  拉取代码   ============================="
    57.                 git branch: 'master', credentialsId: '', url: ''
    58.                 echo "========================  拉取代码完毕  ============================="
    59.             }
    60.         }
    61.  
    62.         // 2.打包项目(本机windows环境打包) |||||||||||未测试
    63.         stage('build-windows') {
    64.             // 当条件满足了才执行当前 stage
    65.             when {
    66.                 // 环境变量的OS变量需要 等于 windows
    67.                 environment name: 'OS', value: 'windows'
    68.             }
    69.             steps {
    70.                 echo "======================  Windows下开始打包项目   ============================"
    71.                 echo "开始生成ant打包配置文件"
    72.                 // 生成配置文件
    73.                 // 第一个参数tomcat安装目录：将目录传入ant build.xml里，到时候将打包出来的包复制到tomcat/webapp下
    74.                 // 第一个参数项目名称：打包出来的文件名
    75.                 // 第三个参数源码路径：将生成的配置文件放到源码根目录下
    76.                 bat "${ANT_GENERATE_BUILD_PATH}.bat ${TOMCAT_HOME}  ${JOB_NAME}  ${WORKSPACE}"
    77.                 echo "开始执行ant打包命令."
    78.                 // 开始打包
    79.                 bat "${ANT_HOME}/bin/ant -buildfile ${WORKSPACE}/build.xml"
    80.                 echo "===========================  项目打包完毕   =============================="
    81.             }
    82.         }
    83.  
    84.         // 2.打包项目(本机linux环境打包)
    85.         stage('build-linux') {
    86.             when {
    87.                 environment name: 'OS', value: 'linux'
    88.             }
    89.             steps {
    90.                 echo "======================  Linux下开始打包项目   ============================="
    91.                 echo "开始生成ant打包配置文件"
    92.                 sh "JENKINS_NODE_COOKIE=dontKillMe sh ${ANT_GENERATE_BUILD_PATH}.sh ${TOMCAT_HOME}  ${JOB_NAME}  ${WORKSPACE}"
    93.                 echo "开始执行ant打包命令"
    94.                 sh "JENKINS_NODE_COOKIE=dontKillMe sh ${ANT_HOME}/bin/ant -buildfile ${WORKSPACE}/build.xml"
    95.                 echo "===========================  项目打包完毕   =============================="
    96.             }
    97.         }
    98.  
    99.         // 3.启动项目：远程windows上启动
    100.         stage('run-remote-windows') {
    101.             when {
    102.                 // 当部署类型是远程服务器 并且 远程服务器是windows才执行
    103.                 environment name: 'DEPLOY_TYPE', value: 'remote'
    104.                 environment name: 'REMOTE_OS', value: 'windows'
    105.             }
    106.             steps {
    107.                 script {
    108.                     echo "===============  部署到远程服务器[Windows]   ============================="
    109.  
    110.                     def remote = [:]
    111.                     remote.name = "remote-windows"
    112.                     remote.host = "${REMOTE_HOST}"
    113.                     remote.user = "${REMOTE_USER}"
    114.                     remote.password = "${REMOTE_PASSWORD}"
    115.                     remote.allowAnyHosts = true
    116.  
    117.                     try {
    118.                         sshCommand remote: remote, command: "net stop ${REMOTE_WINDOWS_TOMCAT_SERVICE_NAME}"
    119.                     } catch(err) {
    120.                         echo "停止失败：Tomcat没有启动"
    121.                     }
    122.  
    123.                     sshPut remote: remote, from: "${WORKSPACE}/target/war/${JOB_NAME}.war" , into: "${REMOTE_TOMCAT_HOME}/webapps/"
    124.                     echo "======================  打包文件上传成功   ============================="
    125.  
    126.                     sshCommand remote: remote, command: "net start ${REMOTE_WINDOWS_TOMCAT_SERVICE_NAME}"
    127.                     echo "======================  Tomcat启动成功   ============================="
    128.                 }
    129.             }
    130.         }
    131.  
    132.         // 3.启动项目：远程linux上启动
    133.         stage('run-remote-linux') {
    134.             when {
    135.                 // 当部署类型是远程服务器 并且 远程服务器是linux才执行
    136.                 environment name: 'DEPLOY_TYPE', value: 'remote'
    137.                 environment name: 'REMOTE_OS', value: 'linux'
    138.             }
    139.             steps {
    140.                 script {
    141.                     echo "===============  部署到远程服务器[Linux]   ============================="
    142.                     def remote = [:]
    143.                     remote.name = 'remote-linux'
    144.                     remote.host = "${REMOTE_HOST}"
    145.                     remote.user = "${REMOTE_USER}"
    146.                     remote.password = "${REMOTE_PASSWORD}"
    147.                     remote.allowAnyHosts = true
    148.  
    149.                     try {
    150.                         sshCommand remote: remote, command: "sh ${REMOTE_TOMCAT_HOME}/bin/shutdown.sh"
    151.                     } catch(err) {
    152.                         echo "停止失败：Tomcat没有启动"
    153.                     }
    154.                     sshPut remote: remote, from: "${WORKSPACE}/target/war/${JOB_NAME}.war", into: "${REMOTE_TOMCAT_HOME}/webapps/"
    155.  
    156.                     echo "======================  打包文件上传成功   ============================="
    157.  
    158.                     sshCommand remote: remote, command: "sh ${REMOTE_TOMCAT_HOME}/bin/startup.sh"
    159.                     echo "======================  Tomcat启动成功   ============================="
    160.                 }
    161.             }
    162.         }
    163.  
    164.         // 3.启动项目：本地windows上启动 |||||||||||未测试
    165.         stage('run-local-windows') {
    166.             when {
    167.                 // 环境变量的OS变量需要 等于 windows
    168.                 environment name: 'DEPLOY_TYPE', value: 'local'
    169.                 environment name: 'OS', value: 'windows'
    170.             }
    171.             steps {
    172.                 echo "============  将打包文件复制到Tomcat Webapps下   ==============="
    173.                 sh "cp ${WORKSPACE}/target/war/${JOB_NAME}.war ${TOMCAT_HOME}/webapps/"
    174.                 echo "=====================  开始启动项目   ========================="
    175.                 echo "开始运行项目"
    176.                 echo "正在停止tomcat"
    177.                 bat '${TOMCAT_HOME}/bin/shutdown.bat'
    178.                 echo "停止成功"
    179.                 echo "正在启动tomcat"
    180.                 bat '${TOMCAT_HOME}/bin/startup.bat'
    181.                 echo "启动成功"
    182.                 echo "======================  启动成功   =========================="
    183.             }
    184.         }
    185.  
    186.         // 3.启动项目：本地linux上启动
    187.         stage('run-local-linux') {
    188.             when {
    189.                 environment name: 'DEPLOY_TYPE', value: 'local'
    190.                 environment name: 'OS', value: 'linux'
    191.             }
    192.             steps {
    193.                 script {
    194.                     echo "============  将打包文件复制到Tomcat Webapps下   ==============="
    195.                     sh "cp ${WORKSPACE}/target/war/${JOB_NAME}.war ${TOMCAT_HOME}/webapps/"
    196.                     echo "=====================  开始启动项目   ========================="
    197.                     echo "开始运行项目"
    198.                     echo "正在停止tomcat"
    199.                     try {
    200.                         sh 'JENKINS_NODE_COOKIE=dontKillMe sh ${TOMCAT_HOME}/bin/shutdown.sh'
    201.                     } catch (err) {
    202.                         echo "停止失败：Tomcat没有启动"
    203.                     }
    204.  
    205.                     echo "正在启动tomcat"
    206.                     sh 'JENKINS_NODE_COOKIE=dontKillMe sh ${TOMCAT_HOME}/bin/startup.sh'
    207.                     echo "启动成功"
    208.                     echo "======================  启动成功   =========================="
    209.                 }
    210.             }
    211.         }
    212.     }
    213.  
    214.     // 整个pipeline完成后
    215.     post {
    216.  
    217.         // 状态为失败执行
    218.         failure {
    219.             echo "======================  部署失败   =========================="
    220.         }
    221.  
    222.         // 状态为成功执行
    223.         success {
    224.             echo "======================  部署成功   =========================="
    225.             //    mail  subject: '关于xxx日的构建反馈-成功', body: '构建成功了', from: 'xxx@163.com',, to: 'to@163.com' // 可以邮件通知或者webhook
    226.             }
    227.         }
    228. }
    229.  
    230.

    说几个注意点

    pipeline的${} 变量必须写在 双引号" " 字符串里面才能被解析

    pipeline里运行tomcat会启动不起来 需要前面加 JENKINS_NODE_COOKIE=dontKillMe 具体看上面代码

  • 相关阅读:
    双版本数据加载的系统设计
    第十九节——vue内置组件
    C++内存管理
    腾讯云服务器CVM和轻量应用服务器区别全方位对比
    图像处理之图像的几何变换
    关于JavaScript 异步方案 async/await
    MacOs 删除第三方软件
    架构：微服务网关(SIA-Gateway)简介
    天津工业大学计算机考研资料汇总
    dubbo之配置文件
  • 原文地址：https://blog.csdn.net/weixin_42195284/article/details/125605856