JenkinsFile pipeline 语法使用心得

最新推荐文章于 2024-05-27 07:00:00 发布
最新推荐文章于 2024-05-27 07:00:00 发布
阅读量892 收藏 6
点赞数
分类专栏： CICD Linux 基础 Linux 运维 文章标签： jenkins linux docker
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u011607971/article/details/115205792
版权

JenkinsFile pipeline 语法使用心得

本次使用心得针对想让特定的 job 在指定的 jenkins slave 节点上运行。并能通过 pipeline 的方式规定任务流程。在使用过程中遇到很多问题，以及语法的一些尝试，最终完美解决各个阶段的连通性 克隆代码–>编译代码–>处理编译后文件–>项目压缩–>项目部署工具处理–>部署工具转存等，原本计划要写很多，因为在书写过程中语法报错很多次，但是在书写完成后，其实只要注意的部分是语法的格式、调用方式、执行顺序、变量的调取方式等，有想法就持续更新此文档吧，呜呜呜呜呜！

  • 最终效果展示

  • 最终代码展示
pipeline {
    agent {
       label 'jenkins-slave'
    }
    parameters {
        // 指定 tag 或者分支名称
        gitParameter(name: 'BRANCH_TAG',type: 'PT_BRANCH_TAG',defaultValue: 'master')
        // 定义基础镜像
        string(name: 'BASE_IMAGE', defaultValue: '192.168.1.64/magic/magicjupyter:v0.3', description: '输入使用的基础镜像名称?')
    }

    environment {
        // 定义编译过程中配置文件转存目录
        CONFIG_PATH="/data/conf_tmp"
        // 定义项目打包后存放路径
        PACKAGE_PATH="/data/package_save"
        // 通过 sh 的输出定义为变量
        // PROJECTNAME=sh(returnStdout: true, script: 'basename ${WORKSPACE}_${BRANCH_TAG}')
        // 项目名称，在打包时进行调用
        PROJECT_NAME="magicjupyter"
        // 远程目录
        REMOTE_PATH="/package_download/tools"
        // 远端主机，使用 jenkins 插件进行传送配置麻烦，简单使用 scp 传送(前提做好 SSH 免密登陆即可)
        REMOTE_HOST="192.168.1.74"

    }

    stages {
        stage('克隆代码'){
           steps {
                checkout([$class: 'GitSCM', 
                          branches: [[name: "${params.BRANCH_TAG}"]], 
                          doGenerateSubmoduleConfigurations: false, 
                          extensions: [], 
                          gitTool: 'Default', 
                          submoduleCfg: [], 
                          userRemoteConfigs: [[credentialsId: 'jenkins-slave-git-key', url: 'ssh://git@192.168.1.12:2223/lab/magicjupyter.git']]
                        ])
            }
        }

        stage('编译准备') {
            parallel {
                stage('临时目录创建') {
                    steps {
                        sh '[[ ! -d "${CONFIG_PATH}" ]] && mkdir -p ${CONFIG_PATH}'
                    }
                }

                stage('同步目录') {
                    steps {
                        sh 'rsync -rv --exclude=.git --exclude=.gitignore ${WORKSPACE}/ ${WORKSPACE}_${BRANCH_TAG} >> /dev/null 2>&1'
                    }
                }

                stage('处理项目结构') {
                    steps {
                        sh '[[ ! -d ${PACKAGE_PATH} ]] && mkdir -p ${PACKAGE_PATH}'
                    }
                }
            }
        }
        stage('代码编译') {
            stages {
                stage('转存配置文件') {
                    steps {
                        sh '''
                            cp ${WORKSPACE}_${BRANCH_TAG}/api/settings.py ${CONFIG_PATH}
                            cp ${WORKSPACE}_${BRANCH_TAG}/utils/constants.py ${CONFIG_PATH}
                        '''
                    }
                }
                stage('运行编译') {
                    steps {
                        dir("${env.WORKSPACE}_${BRANCH_TAG}") {
                            sh '/usr/local/python3/bin/python3 setup.py build_ext --inplace'
                        }
                    }
                }
                stage('删除编译后pyc文件') {
                    steps {
                        dir("${env.WORKSPACE}_${BRANCH_TAG}") {
                            sh """
                                /bin/bash clean.sh
                            """
                        }
                    }
                }

                stage('还原配置文件') {
                    steps {
                        dir("${env.WORKSPACE}_${BRANCH_TAG}") {
                            
                            sh '''

                                [[ -f "./api/settings.pyc" ]] && rm -f ./api/settings.pyc

                                [[ -f "./utils/constants.pyc" ]] && rm -f ./utils/constants.pyc

                                cp ${CONFIG_PATH}/settings.py ./api/settings.py

                                cp ${CONFIG_PATH}/constants.py ./utils/constants.py
                                
                            '''
                        }
                    }
                }
            }
        }

        stage('编译后处理') {
            stages {
                stage('重命名') {
                    
                    steps {
                        sh 'mv ${WORKSPACE}_${BRANCH_TAG} ${PACKAGE_PATH}/${PROJECT_NAME}'
                    }
                    
                }

                stage('压缩项目文件') {
                    steps {
                        dir("${env.PACKAGE_PATH}") {
                            sh '''
                                tar czvf ${PROJECT_NAME}-${BRANCH_TAG}.tar.gz \\
                                --exclude=${PROJECT_NAME}/logs \\
                                --exclude=${PROJECT_NAME}/static \\
                                --exclude=${PROJECT_NAME}/build \\
                                --exclude=${PROJECT_NAME}/Dockerfile \\
                                --exclude=${PROJECT_NAME}/Jenkinsfile \\
                                --exclude=${PROJECT_NAME}/README.md \\
                                --exclude=${PROJECT_NAME}/requirements.txt \\
                                --exclude=${PROJECT_NAME}/clean.sh \\
                                ${PROJECT_NAME} >> /dev/null 2>&1
                            '''
                        }
                    }
                }

                stage('构建镜像') {
                    stages {
                        stage('编译镜像准备') {
                            steps {
                                dir("${env.PACKAGE_PATH}") {
                                    sh 'mv ${PROJECT_NAME}-${BRANCH_TAG}.tar.gz ${PROJECT_NAME}/build/'
                                }
                            }
                            
                        }
                        stage('编译镜像') {
                            // 只要注意包含关系 dir 切换目录；stage{stages {....}} 或者 stages { stage { steps {.....}}
                            steps {
                                script {
                                    dir("${env.PACKAGE_PATH}/${env.PROJECT_NAME}") {
                                        docker.withRegistry('http://192.168.1.64/', 'harbor') { 
                                            def customImage = docker.build("192.168.1.64/magic/${env.PROJECT_NAME}:${env.BRANCH_TAG}", "--build-arg TARNAME=${PROJECT_NAME}-${BRANCH_TAG}.tar.gz --build-arg DOCKER_BASE_IMAGE=${params.BASE_IMAGE} ./build")
                                            customImage.push()
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
        stage('部署工具') {
            stages {

                stage ('压缩镜像') {
                    input {
                        message "是否进行打包?"
                        ok "Yes"
                    }
                    steps {
                        dir("${env.PACKAGE_PATH}/${env.PROJECT_NAME}/deploy/code_pack") {
                            sh '''
                                docker save 192.168.1.64/magic/${PROJECT_NAME}:${BRANCH_TAG} | gzip > ${PROJECT_NAME}:${BRANCH_TAG}.tar.gz
                            '''
                        }
                    }
                }
                stage ('打包部署工具') {

                    steps {
                        dir("${env.PACKAGE_PATH}/${env.PROJECT_NAME}") {
                            sh '''
                                tar czvf ${PROJECT_NAME}_${BUILD_NUMBER}.tar.gz deploy
                            '''
                        }
                    }
                }

                stage ('传送文件') {
                    steps {
                        dir("${env.PACKAGE_PATH}/${env.PROJECT_NAME}") {
                            sh '''
                                scp ${PROJECT_NAME}_${BUILD_NUMBER}.tar.gz root@${REMOTE_HOST}:${REMOTE_PATH}/
                            '''
                        }
                    }
                }
            }
        }
   }
   post {
       // pipeline 执行左后删除临时目录
       always {
           dir("${env.WORKSPACE}@tmp") {
               deleteDir()
           }
           dir("${env.WORKSPACE}_${BRANCH_TAG}@tmp") {
               deleteDir()
           }
           dir("${env.WORKSPACE}_${BRANCH_TAG}") {
               deleteDir()
           }
           dir("${env.CONFIG_PATH}") {
               deleteDir()
           }
           dir("${env.PACKAGE_PATH}") {
               deleteDir()
           }
       }
   }
}

  • 使用到的语法简介

    • pipeline: 块是 声明式流水线.
    • agent: 具体参数使用可以查阅官网说明：Jenkinsfile 文档
      • 官方说明: 部分指定了整个流水线或特定的部分, 将会在Jenkins环境中执行的位置，这取决于 agent 区域的位置。该部分必须在 pipeline 块的顶层被定义, 但是 stage 级别的使用是可选的。
      • 本人理解: 就是可以使用 pipeline 整个生态中，也可以指定在具体的 stage 块中使用。
    • parameters: 定义构建过程参数
    • environment: 设置环境变量，也可以动态设置变量
    • stages: 包含一系列一个或多个 stage 指令, stages 部分是流水线描述的大部分"work" 的位置。本文中进行了尝试如下使用同样OK，stages { stage { stages { } } }
    • steps: 在给定的 stage 指令中执行的定义了一系列的一个或多个steps。
    • dir: 指定在什么目录下工作
    • sh: 执行 shell 命令
    • docker: 直接编译 docker 镜像与提交镜像
    • input: 运行中的交互功能
    • post: 在所有 pipeline 既定任务完成后，执行的操作；
Y-Loong
关注
专栏目录
云原生DevOps篇：pipeline脚本通过Jenkinsfile的方式使用
江晓龙的博客
10-15 1063
由于我们可以把Jenkinsfile放在gitlab上，因此拉代码的时候可以使用checkout scm，意思就是拉取Jenkinsfile所在的gitlab项目。为了便于版本控制，有的公司也会将pipeline写成Jenkinsfile，保存在项目代码目录中，拉代码的时候就可以拉到Jenkinsfile。Jenkinsfile就是一个文件名，里面存的内容还是pipeline脚本，只不过必须写成Jenkinsfile，就像Dockerfile一样。
Jenkins-pipeline语法
ljsykf的博客
12-07 3996
Pipeline是将一个命令/程序/进程的输出发送到另一个命令/程序/进程，进行进一步处理 Pipeline的代码定义了整个构建过程声明式的pipeline语法格式 所有的声明都必须包含在pipeline{}中 块只能有节段，指令，步骤或者赋值语句组成 节段：agent，stages，post，steps 指令：environment，options，parameters，triggers，stage，input，tool，when 创建一个简单的pipeline项目 新建一个item，选择“Pipelin
Jenkins Pipeline—使用 Jenkinsfile 文件
k4nz
04-27 278
原文地址：Jenkins Pipeline—使用 Jenkinsfile 文件（永久地址，保存网址不迷路 ????） 本笔记内容是对 Jenkins/Pipeline/Using a Jenkinsfile 手册的学习整理。 Table of Contents Creating a Jenkinsfile Build Test Deploy Working with your Jenkinsfile String interpolation Using environment variab
玩转Jenkins Pipeline
热门推荐
大宝鱼的博客
07-17 13万+
Jenkins Pipeline的总体介绍 1.Jenkins Pipeline 的核心概念 Pipeline，简而言之，就是一套运行于Jenkins上的工作流框架，将原本独立运行于单个或者多个节点的任务连接起来，实现单个任务难以完成的复杂流程编排与可视化。 Pipeline是Jenkins2.X的最核心的特性，帮助Jenkins实现从CI到CD与DevOps的转变 Pipeline是一组...
Jenkins 流水线（Pipeline）详解
最新发布
若不知道要驶向哪个码头，那么任何风都不会是顺风。
05-27 6030
大家好，Jenkins 流水线（Pipeline）是一种可编排的持续集成和交付（CI/CD）方法，它以代码的方式定义整个软件开发过程中的构建、测试和部署流程。接下来就跟大家分享一下Jenkins 流水线（Pipeline）。
Jenkins的Pipeline
六月的雨
04-22 1169
Jenkins的Pipeline
jenkins pipeline语法详解
alittleyatou的博客
07-06 1021
详细说明了jenkins pipeline的语法结构和常用命令
Jenkins-Pipeline语法篇- Pipeline指令
alanpo_的博客
07-16 4229
Jenkins Pipeline 语法分类 Jenkins Pipeline 支持两种语法，一种 Declarative Pipeline(声明式)，一种 ScriptedPipeline(脚本式)。 声明式的 Pipeline 限制用户使用严格的预选定义的结构，是一种声明式的编程模型，对比脚本式的 Pipeline 学习起来更加简单； 脚本式的 Pipeline 限制比较少，结构和语法的限制由 Groovy 本身决定，是一种命令式的编程模型。 所以使用声明式的方式编写 jenkinsfil
持续交付(三)Jenkinsfile语法使用介绍
Mikasa的博客
08-03 1511
本章主要讲述：Jenkinsfile语法基本介绍 上篇blog已经讲过Pipeline的操作我们都是用解释性代码Jenkinsfile来描述 且Jenkinsfile的语法形式有两种 # V2.5之后引入，结构化方式 - 1、Declarative pipeline # 基于groovy的语法 - 2、Scripts pipeline ``` 那本章咱们就详细讲述一下这两种语法的使用...
VScode本地进行Jenkinsfile语法验证
DevOps持续集成的博客
11-11 1213
background（背景）Pipeline As Code is a core feature of Jenkins2.0. Not only learn the pipeline syntax, we also had to do a local basic syntax check on each Jenkinsfile commit to git repo.Pipeline As Code...
Jenkins（6）流水线（pipeline）、Jenkinsfile设置、多分支构建及简单总结
учёба
09-16 6308
流水线、Jenkinsfile、多分支构建
【Jenkins】pipeline流水线
weixin_44823875的博客
09-11 4203
pipeline就是一套运行于jenkins上的工作流程框架，将原本独立运行于单个或者多个节点的任务连接起来，实现单个任务难以完成的复杂流程编排与可视化；Pipeline 是Jenkins 2.X 的最核心的特性，帮助Jenkins 实现从CI 到 CD 与 DevOps的转变。Pipeline 是一组插件，让jenkins 可以实现持续交付管道的落地和实施。持续交付管道是将软件从版本控制阶段到交付给用户/客户的完整过程的自动化表现。
jenkins pipeline的parameters参数介绍
认知 行动 坚持
08-07 1万+
这个指令允许我们为一个声明式流水线指定项目参数。这些参数的输入值可以来自一个用户或者一个API调用。 下面列举了所有合法的参数类型，以及他们的描述和示例： booleanParam 这是基本的true/false参数。其子参数为name、defaultValue及description。 choice 此参数允许用户从一个选项列表中选择。其子参数为name、choices及description。这里的choices指的是你所输入的以换行符分隔的展示给用户的选项列表。列表中的第一个值会作为默认值。 fi
Jenkins使用pipeline流水线部署项目
万物皆可学
03-18 1987
通过Docker命令，还是直接用“sh：Shell Script”生成移动target目录下的jar包到docker目录中，镜像命名为当前任务名：版本（即pipeline-mytest：Gitlab拉取的标签版本）后面跟着的docker/目录指定Dockerfile文件在此目录下，根据它构建镜像。将脚本复制到Jenkinsfile文件相应流程中构建只花了1秒，并成功构建了去Jenkins服务器上查看镜像已经生成了个pipeline-mytest的镜像。
Jenkinsfile Pipeline 语法格式 Devops
运维那些事儿
01-14 5367
1、pipeline语法如下： node { #这里可以定义在node节点运行jenki服务 stage('拉取代码') { git credentialsId: 'b25e5382-9949-468d-a101-4b40cc479a38', url: 'http://139.159.232.80:3429/root/icp-web-inte...
jenkins-Pipeline 教程，看这一篇文章就够了
雨水的早晨的博客
10-13 2万+
jenkins-pipeline教程，如何创建pipleline任务，jenkinsfile语法
jenkins-pipeline语法详解 最新最全 （声明式Pipeline和脚本式）
zero_open的博客
04-16 9331
pipeline 是一套运行于jenkins上的工作流框架，将原本独立运行于单个或者多个节点的任务连接起来，实现单个任务难以完成的复杂流程编排与可视化。
jenkinsfile示例_Jenkinsfile用示例解释
weixin_26746861的博客
07-17 1697
jenkinsfile示例 代理商 (Agent) Let’s start with agent where certain phase will be executed. It can be the entire pipeline or certain stage. At top level agent, we set it to none so we need to set each stag...
Linux Jenkins 流水线方式pipeline script部署
weixin_57901667的博客
06-03 669
前端：
Jenkins2.0 Pipeline语法深度解析：Declarative vs Scripted
"pipeline使用之语法详解" Jenkins2.0引入的Pipeline功能是其核心特性之一，旨在实现持续交付的最佳实践。Pipeline as Code的概念将传统Jenkins 1.0项目中的配置信息，如源码管理（如SVN或Git）、参数设置等，转化...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值