Jenkins 保姆级教程

  一、什么是流水线

jenkins 有 2 种流水线分为声明式流水线脚本化流水线,脚本化流水线是 jenkins 旧版本使用的流水线脚本,新版本 Jenkins 推荐使用声明式流水线。文档只介绍声明流水线。

声明式流水线

在声明式流水线语法中,流水线过程定义在Pipeline{}中,Pipeline 块定义了整个流水线中完成的所有工作,比如

参数说明:
  • agent any:在任何可用的代理上执行流水线或它的任何阶段,也就是执行流水线过程的位置,也可以指定到具体的节点

  • stage:定义流水线的执行过程(相当于一个阶段),比如下文所示的 Build、Test、Deploy, 但是这个名字是根据实际情况进行定义的,并非固定的名字

  • steps:执行某阶段具体的步骤。

//Jenkinsfile (Declarative Pipeline)
pipeline {agent anystages {stage('Build') {steps {echo 'Build'}}stage('Test') {steps {echo 'Test'}}stage('Deploy') {steps {echo 'Deploy'}}}
}
脚本化流水线

在脚本化流水线语法中,会有一个或多个 Node(节点)块在整个流水线中执行核心工作

参数说明:
  • node:在任何可用的代理上执行流水线或它的任何阶段,也可以指定到具体的节点

  • stage:和声明式的含义一致,定义流水线的阶段。Stage 块在脚本化流水线语法中是可选的,然而在脚本化流水线中实现 stage 块,可以清楚地在 Jenkins UI 界面中显示每个 stage 的任务子集。

//Jenkinsfile (Scripted Pipeline)
node {stage('Build') {echo 'Build'}stage('Test') {echo 'Test'}stage('Deploy') {echo 'Deploy'}
}

二、声明式流水线

声明式流水线必须包含在一个 Pipeline 块中,比如是一个 Pipeline 块的格式

pipeline {/* insert Declarative Pipeline here */
}

在声明式流水线中有效的基本语句和表达式遵循与 Groovy 的语法同样的规则,但有以下例外

  • 流水线顶层必须是一个 block,即 pipeline{}

  • 分隔符可以不需要分号,但是每条语句都必须在自己的行上

  • 块只能由 Sections、Directives、Steps 或 assignment statements 组成

  • 属性引用语句被当做是无参数的方法调用,比如 input 会被当做 input()。

Sections

声明式流水线中的 Sections 不是一个关键字或指令,而是包含一个或多个 Agent、Stages、 post、Directives 和 Steps 的代码区域块。

1.Agent

Agent 表示整个流水线或特定阶段中的步骤和命令执行的位置,该部分必须在 pipeline 块的顶层被定义,也可以在 stage 中再次定义,但是 stage 级别是可选的。

any

在任何可用的代理上执行流水线,配置语法

pipeline {agent any
}
none

表示该 Pipeline 脚本没有全局的 agent 配置。当顶层的 agent 配置为 none 时, 每个 stage 部分都需要包含它自己的 agent。配置语法

pipeline {agent nonestages {stage('Stage For Build'){agent any}}
}
label

以节点标签形式选择某个具体的节点执行 Pipeline 命令,例如:agent { label 'my-defined-label' }。节点需要提前配置标签。

pipeline {agent nonestages {stage('Stage For Build'){agent { label 'role-master' }steps {echo "role-master"}}}
}
node

和 label 配置类似,只不过是可以添加一些额外的配置,比如 customWorkspace(设置默认工作目录)

pipeline {agent nonestages {stage('Stage For Build'){agent {node {label 'role-master'customWorkspace "/tmp/zhangzhuo/data"}}steps {sh "echo role-master > 1.txt"}}}
}
dockerfile

使用从源码中包含的 Dockerfile 所构建的容器执行流水线或 stage。此时对应的 agent 写法如下

agent {dockerfile {filename 'Dockerfile.build'  //dockerfile文件名称dir 'build'                  //执行构建镜像的工作目录label 'role-master'          //执行的node节点,标签选择additionalBuildArgs '--build-arg version=1.0.2' //构建参数}
}
docker

相当于 dockerfile,可以直接使用 docker 字段指定外部镜像即可,可以省去构建的时间。比如使用 maven 镜像进行打包,同时可以指定 args

agent{docker{image '192.168.101.22/kubernetes/alpine:latest'   //镜像地址label 'role-master' //执行的节点,标签选择args '-v /tmp:/tmp'      //启动镜像的参数}
}
kubernetes

需要部署 kubernetes 相关的插件,官方文档:

https://github.com/jenkinsci/kubernetes-plugin/

Jenkins 也支持使用 Kubernetes 创建 Slave,也就是常说的动态 Slave。配置示例如下

  • cloud: Configure Clouds 的名称,指定到其中一个 k8s

  • slaveConnectTimeout: 连接超时时间

  • yaml: pod 定义文件,jnlp 容器的配置必须有配置无需改变,其余 containerd 根据自己情况指定

  • workspaceVolume:持久化 jenkins 的工作目录。

    • persistentVolumeClaimWorkspaceVolume:挂载已有 pvc。

workspaceVolume persistentVolumeClaimWorkspaceVolume(claimName: "jenkins-agent", mountPath: "/", readOnly: "false")
  • nfsWorkspaceVolume:挂载 nfs 服务器目录

workspaceVolume nfsWorkspaceVolume(serverAddress: "192.168.101.24", serverPath: "/nfs", readOnly: "false")
  • dynamicPVC:动态申请 pvc,任务执行结束后删除

workspaceVolume dynamicPVC(storageClassName: "nfs-client", requestsSize: "1Gi", accessModes: "ReadWriteMany")
  • emptyDirWorkspaceVolume:临时目录,任务执行结束后会随着 pod 删除被删除,主要功能多个任务 container 共享 jenkins 工作目录。

workspaceVolume emptyDirWorkspaceVolume()
  • hostPathWorkspaceVolume:挂载 node 节点本机目录,注意挂载本机目录注意权限问题,可以先创建设置 777 权限,否则默认 kubelet 创建的目录权限为 755 默认其他用户没有写权限,执行流水线会报错。

workspaceVolume hostPathWorkspaceVolume(hostPath: "/opt/workspace", readOnly: false)
示例
agent {kubernetes {cloud 'kubernetes'slaveConnectTimeout 1200workspaceVolume emptyDirWorkspaceVolume()yaml '''
kind: Pod
metadata:name: jenkins-agent
spec:containers:- args: [\'$(JENKINS_SECRET)\', \'$(JENKINS_NAME)\']image: '192.168.101.22/kubernetes/jnlp:alpine'name: jnlpimagePullPolicy: IfNotPresent- command:- "cat"image: "192.168.101.22/kubernetes/alpine:latest"imagePullPolicy: "IfNotPresent"name: "date"tty: truerestartPolicy: Never
'''}
}
2.agent 的配置示例

kubernetes 示例

pipeline {agent {kubernetes {cloud 'kubernetes'slaveConnectTimeout 1200workspaceVolume emptyDirWorkspaceVolume()yaml '''
kind: Pod
metadata:name: jenkins-agent
spec:containers:- args: [\'$(JENKINS_SECRET)\', \'$(JENKINS_NAME)\']image: '192.168.101.22/kubernetes/jnlp:alpine'name: jnlpimagePullPolicy: IfNotPresent- command:- "cat"image: "192.168.101.22/kubernetes/alpine:latest"imagePullPolicy: "IfNotPresent"name: "date"tty: true- command:- "cat"image: "192.168.101.22/kubernetes/kubectl:apline"imagePullPolicy: "IfNotPresent"name: "kubectl"tty: truerestartPolicy: Never
'''}}environment {MY_KUBECONFIG = credentials('kubernetes-cluster')}stages {stage('Data') {steps {container(name: 'date') {sh """date"""}}}stage('echo') {steps {container(name: 'date') {sh """echo 'k8s is pod'"""}}}stage('kubectl') {steps {container(name: 'kubectl') {sh """kubectl get pod -A  --kubeconfig $MY_KUBECONFIG"""}}}}
}

docker 的示例

pipeline {agent nonestages {stage('Example Build') {agent { docker 'maven:3-alpine' }steps {echo 'Hello, Maven'sh 'mvn --version'}}stage('Example Test') {agent { docker 'openjdk:8-jre' }steps {echo 'Hello, JDK'sh 'java -version'}}}
}
3.Post

Post 一般用于流水线结束后的进一步处理,比如错误通知等。Post 可以针对流水线不同的结果做出不同的处理,就像开发程序的错误处理,比如 Python 语言的 try catch。

Post 可以定义在 Pipeline 或 stage 中,目前支持以下条件

  • always:无论 Pipeline 或 stage 的完成状态如何,都允许运行该 post 中定义的指令;

  • changed:只有当前 Pipeline 或 stage 的完成状态与它之前的运行不同时,才允许在该 post 部分运行该步骤;

  • fixed:当本次 Pipeline 或 stage 成功,且上一次构建是失败或不稳定时,允许运行该 post 中定义的指令;

  • regression:当本次 Pipeline 或 stage 的状态为失败、不稳定或终止,且上一次构建的 状态为成功时,允许运行该 post 中定义的指令;

  • failure:只有当前 Pipeline 或 stage 的完成状态为失败(failure),才允许在 post 部分运行该步骤,通常这时在 Web 界面中显示为红色

  • success:当前状态为成功(success),执行 post 步骤,通常在 Web 界面中显示为蓝色 或绿色

  • unstable:当前状态为不稳定(unstable),执行 post 步骤,通常由于测试失败或代码 违规等造成,在 Web 界面中显示为黄色

  • aborted:当前状态为终止(aborted),执行该 post 步骤,通常由于流水线被手动终止触发,这时在 Web 界面中显示为灰色;

  • unsuccessful:当前状态不是 success 时,执行该 post 步骤;

  • cleanup:无论 pipeline 或 stage 的完成状态如何,都允许运行该 post 中定义的指令。和 always 的区别在于,cleanup 会在其它执行之后执行。

示例

一般情况下 post 部分放在流水线的底部,比如本实例,无论 stage 的完成状态如何,都会输出一条 I will always say Hello again!信息

//Jenkinsfile (Declarative Pipeline)
pipeline {agent anystages {stage('Example1') {steps {echo 'Hello World1'}}stage('Example2') {steps {echo 'Hello World2'}}}post {always {echo 'I will always say Hello again!'}}
}

也可以将 post 写在 stage,下面示例表示 Example1 执行失败执行 post。

//Jenkinsfile (Declarative Pipeline)
pipeline {agent anystages {stage('Example1') {steps {sh 'ip a'}post {failure {echo 'I will always say Hello again!'}}}}
}
4.sepes

Steps 部分在给定的 stage 指令中执行的一个或多个步骤,比如在 steps 定义执行一条 shell 命令

//Jenkinsfile (Declarative Pipeline)
pipeline {agent anystages {stage('Example') {steps {echo 'Hello World'}}}
}

或者是使用 sh 字段执行多条指令

//Jenkinsfile (Declarative Pipeline)
pipeline {agent anystages {stage('Example') {steps {sh """echo 'Hello World1'echo 'Hello World2'"""}}}
}
Directives

Directives 可用于一些执行 stage 时的条件判断或预处理一些数据,和 Sections 一致,Directives 不是一个关键字或指令,而是包含了 environment、options、parameters、triggers、stage、tools、 input、when 等配置。

1.Environment

Environment 主要用于在流水线中配置的一些环境变量,根据配置的位置决定环境变量的作用域。可以定义在 pipeline 中作为全局变量,也可以配置在 stage 中作为该 stage 的环境变量。该指令支持一个特殊的方法 credentials(),该方法可用于在 Jenkins 环境中通过标识符访问预定义的凭证。对于类型为 Secret Text 的凭证,credentials()可以将该 Secret 中的文本内容赋值给环境变量。对于类型为标准的账号密码型的凭证,指定的环境变量为 username 和 password,并且也会定义两个额外的环境变量,分别为MYVARNAME_USR和MYVARNAME_PSW。

基本变量使用

//示例
pipeline {agent anyenvironment {   //全局变量,会在所有stage中生效NAME= 'zhangzhuo'}stages {stage('env1') {environment { //定义在stage中的变量只会在当前stage生效,其他的stage不会生效HARBOR = 'https://192.168.10.15'}steps {sh "env"}}stage('env2') {steps {sh "env"}}}
}

使用变量引用 secret 的凭证

//这里使用k8s的kubeconfig文件示例
pipeline {agent anyenvironment {KUBECONFIG = credentials('kubernetes-cluster')}stages {stage('env') {steps {sh "env"  //默认情况下输出的变量内容会被加密}}}
}
使用变量引用类型为标准的账号密码型的凭证

这里使用 HARBOR 变量进行演示,默认情况下账号密码型的凭证会自动创建 3 个变量

  • HARBOR_USR:会把凭证中 username 值赋值给这个变量

  • HARBOR_PSW:会把凭证中 password 值赋值给这个变量

  • HARBOR:默认情况下赋值的值为usernamme:password

//这里使用k8s的kubeconfig文件示例
pipeline {agent anyenvironment {HARBOR = credentials('harbor-account')}stages {stage('env') {steps {sh "env"}}}
}
2.Options

Jenkins 流水线支持很多内置指令,比如 retry 可以对失败的步骤进行重复执行 n 次,可以根据不同的指令实现不同的效果。比较常用的指令如下:

  • buildDiscarder:保留多少个流水线的构建记录

  • disableConcurrentBuilds:禁止流水线并行执行,防止并行流水线同时访问共享资源导致流水线失败。

  • disableResume:如果控制器重启,禁止流水线自动恢复。

  • newContainerPerStage:agent 为 docker 或 dockerfile 时,每个阶段将在同一个节点的新容器中运行,而不是所有的阶段都在同一个容器中运行。

  • quietPeriod:流水线静默期,也就是触发流水线后等待一会在执行。

  • retry:流水线失败后重试次数。

  • timeout:设置流水线的超时时间,超过流水线时间,job 会自动终止。如果不加 unit 参数默认为 1 分。

  • timestamps:为控制台输出时间戳。

定义在 pipeline 中

pipeline {agent anyoptions {timeout(time: 1, unit: 'HOURS')  //超时时间1小时,如果不加unit参数默认为1分timestamps()                     //所有输出每行都会打印时间戳buildDiscarder(logRotator(numToKeepStr: '3')) //保留三个历史构建版本quietPeriod(10)  //注意手动触发的构建不生效retry(3)    //流水线失败后重试次数}stages {stage('env1') {steps {sh "env"sleep 2}}stage('env2') {steps {sh "env"}}}
}

定义在 stage 中

Option 除了写在 Pipeline 顶层,还可以写在 stage 中,但是写在 stage 中的 option 仅支持 retry、 timeout、timestamps,或者是和 stage 相关的声明式选项,比如 skipDefaultCheckout。处于 stage 级别的 options 写法如下

pipeline {agent anystages {stage('env1') {options {   //定义在这里这对这个stage生效timeout(time: 2, unit: 'SECONDS') //超时时间2秒timestamps()                     //所有输出每行都会打印时间戳retry(3)    //流水线失败后重试次数}steps {sh "env && sleep 2"}}stage('env2') {steps {sh "env"}}}
}
3.Parameters

Parameters 提供了一个用户在触发流水线时应该提供的参数列表,这些用户指定参数的值可以通过 params 对象提供给流水线的 step(步骤)。只能定义在 pipeline 顶层。

目前支持的参数类型如下
  • string:字符串类型的参数。

  • text:文本型参数,一般用于定义多行文本内容的变量。

  • booleanParam:布尔型参数。

  • choice:选择型参数,一般用于给定几个可选的值,然后选择其中一个进行赋值。

  • password:密码型变量,一般用于定义敏感型变量,在 Jenkins 控制台会输出为*。

插件 Parameters
  • imageTag:镜像 tag,需要安装 Image Tag Parameter 插件后使用

  • gitParameter:获取 git 仓库分支,需要 Git Parameter 插件后使用

示例
pipeline {agent anyparameters {string(name: 'DEPLOY_ENV', defaultValue:  'staging', description: '1')   //执行构建时需要手动配置字符串类型参数,之后赋值给变量text(name:  'DEPLOY_TEXT', defaultValue: 'One\nTwo\nThree\n', description: '2')  //执行构建时需要提供文本参数,之后赋值给变量booleanParam(name: 'DEBUG_BUILD',  defaultValue: true, description: '3')   //布尔型参数choice(name: 'CHOICES', choices: ['one', 'two', 'three'], description: '4')  //选择形式列表参数password(name: 'PASSWORD', defaultValue: 'SECRET', description: 'A  secret password')  //密码类型参数,会进行加密imageTag(name: 'DOCKER_IMAGE', description: '', image: 'kubernetes/kubectl', filter: '.*', defaultTag: '', registry: 'https://192.168.10.15', credentialId: 'harbor-account', tagOrder: 'NATURAL')   //获取镜像名称与taggitParameter(branch: '', branchFilter: 'origin/(.*)', defaultValue: '', description: 'Branch for build and deploy', name: 'BRANCH', quickFilterEnabled: false, selectedValue: 'NONE', sortMode: 'NONE',  tagFilter: '*', type: 'PT_BRANCH')}  //获取git仓库分支列表,必须有git引用stages {stage('env1') {steps {sh "env"}}stage('git') {steps {git branch: "$BRANCH", credentialsId: 'gitlab-key', url: 'git@192.168.10.14:root/env.git'   //使用gitParameter,必须有这个}}}
}
4.Triggers

在 Pipeline 中可以用 triggers 实现自动触发流水线执行任务,可以通过 Webhook、Cron、 pollSCM 和 upstream 等方式触发流水线。

Cron

定时构建假如某个流水线构建的时间比较长,或者某个流水线需要定期在某个时间段执行构建,可以 使用 cron 配置触发器,比如周一到周五每隔四个小时执行一次

注意:H 的意思不是 HOURS 的意思,而是 Hash 的缩写。主要为了解决多个流水线在同一时间同时运行带来的系统负载压力。

pipeline {agent anytriggers {cron('H */4 * * 1-5')   //周一到周五每隔四个小时执行一次cron('H/12 * * * *')   //每隔12分钟执行一次cron('H * * * *')   //每隔1小时执行一次}stages {stage('Example') {steps {echo 'Hello World'}}}
}
Upstream

Upstream 可以根据上游 job 的执行结果决定是否触发该流水线。比如当 job1 或 job2 执行成功时触发该流水线

目前支持的状态有SUCCESSUNSTABLEFAILURENOT_BUILTABORTED等。

pipeline {agent anytriggers {upstream(upstreamProjects: 'env', threshold: hudson.model.Result.SUCCESS)  //当env构建成功时构建这个流水线}stages {stage('Example') {steps {echo 'Hello World'}}}
}
5.Input

Input 字段可以实现在流水线中进行交互式操作,比如选择要部署的环境、是否继续执行某个阶段等。

配置 Input 支持以下选项
  • message:必选,需要用户进行 input 的提示信息,比如:“是否发布到生产环境?”;

  • id:可选,input 的标识符,默认为 stage 的名称;

  • ok:可选,确认按钮的显示信息,比如:“确定”、“允许”;

  • submitter:可选,允许提交 input 操作的用户或组的名称,如果为空,任何登录用户均可提交 input;

  • parameters:提供一个参数列表供 input 使用。

假如需要配置一个提示消息为“还继续么”、确认按钮为“继续”、提供一个 PERSON 的变量的参数,并且只能由登录用户为 alice 和 bob 提交的 input 流水线

pipeline {agent anystages {stage('Example') {input {message "还继续么?"ok "继续"submitter "alice,bob"parameters {string(name: 'PERSON', defaultValue: 'Mr Jenkins', description: 'Who should I say hello to?')}}steps {echo "Hello, ${PERSON}, nice to meet you."}}}
}
6.when

When 指令允许流水线根据给定的条件决定是否应该执行该 stage,when 指令必须包含至少 一个条件。如果 when 包含多个条件,所有的子条件必须都返回 True,stage 才能执行。

When 也可以结合 not、allOf、anyOf 语法达到更灵活的条件匹配。

目前比较常用的内置条件如下
  • branch:当正在构建的分支与给定的分支匹配时,执行这个 stage。注意,branch 只适用于多分支流水线

  • changelog:匹配提交的 changeLog 决定是否构建,例如:when { changelog '.*^\\[DEPENDENCY\\] .+$' }

  • environment:当指定的环境变量和给定的变量匹配时,执行这个 stage,例如:when { environment name: 'DEPLOY_TO', value: 'production' }

  • equals:当期望值和实际值相同时,执行这个 stage,例如:when { equals expected: 2, actual: currentBuild.number }

  • expression:当指定的 Groovy 表达式评估为 True,执行这个 stage,例如:when { expression { return params.DEBUG_BUILD } }

  • tag:如果 TAG_NAME 的值和给定的条件匹配,执行这个 stage,例如:when { tag "release-" }

  • not:当嵌套条件出现错误时,执行这个 stage,必须包含一个条件,例如:when { not { branch 'master' } }

  • allOf:当所有的嵌套条件都正确时,执行这个 stage,必须包含至少一个条件,例如:when { allOf { branch 'master'; environment name: 'DEPLOY_TO', value: 'production' } }

  • anyOf:当至少有一个嵌套条件为 True 时,执行这个 stage,例如:when { anyOf { branch 'master'; branch 'staging' } }

示例:当分支为 main 时执行 Example Deploy 步骤

pipeline {agent anystages {stage('Example Build') {steps {echo 'Hello World'}}stage('Example Deploy') {when {branch 'main' //多分支流水线,分支为才会执行。}steps {echo 'Deploying'}}}
}

也可以同时配置多个条件,比如分支是 production,而且 DEPLOY_TO 变量的值为 main 时,才执行 Example Deploy

pipeline {agent anyenvironment {DEPLOY_TO = "main"}stages {stage('Example Deploy') {when {branch 'main'environment name: 'DEPLOY_TO', value: 'main'}steps {echo 'Deploying'}}}
}

也可以使用 anyOf 进行匹配其中一个条件即可,比如分支为 main 或 DEPLOY_TO 为 main 或 master 时执行 Deploy

pipeline {agent anystages {stage('Example Deploy') {when {anyOf {branch 'main'environment name: 'DEPLOY_TO', value: 'main'environment name: 'DEPLOY_TO', value: 'master'}}steps {echo 'Deploying'}}}
}

也可以使用 expression 进行正则匹配,比如当 BRANCH_NAME 为 main 或 master,并且 DEPLOY_TO 为 master 或 main 时才会执行 Example Deploy

pipeline {agent anystages {stage('Example Deploy') {when {expression { BRANCH_NAME ==~ /(main|master)/ }anyOf {environment name: 'DEPLOY_TO', value: 'main'environment name: 'DEPLOY_TO', value: 'master'}}steps {echo 'Deploying'}}}
}

默认情况下,如果定义了某个 stage 的 agent,在进入该 stage 的 agent 后,该 stage 的 when 条件才会被评估,但是可以通过一些选项更改此选项。比如在进入 stage 的 agent 前评估 when, 可以使用 beforeAgent,当 when 为 true 时才进行该 stage

目前支持的前置条件如下
  • beforeAgent:如果 beforeAgent 为 true,则会先评估 when 条件。在 when 条件为 true 时,才会进入该 stage

  • beforeInput:如果 beforeInput 为 true,则会先评估 when 条件。在 when 条件为 true 时,才会进入到 input 阶段;

  • beforeOptions:如果 beforeInput 为 true,则会先评估 when 条件。在 when 条件为 true 时,才会进入到 options 阶段;

  • beforeOptions 优先级大于beforeInput大于beforeAgent

示例

pipeline {agent nonestages {stage('Example Build') {steps {echo 'Hello World'}}stage('Example Deploy') {when {beforeAgent truebranch 'main'}steps {echo 'Deploying'}}}
}
Parallel

在声明式流水线中可以使用 Parallel 字段,即可很方便的实现并发构建,比如对分支 A、B、 C 进行并行处理

pipeline {agent anystages {stage('Non-Parallel Stage') {steps {echo 'This stage will be executed first.'}}stage('Parallel Stage') {failFast true         //表示其中只要有一个分支构建执行失败,就直接推出不等待其他分支构建parallel {stage('Branch A') {steps {echo "On Branch A"}}stage('Branch B') {steps {echo "On Branch B"}}stage('Branch C') {stages {stage('Nested 1') {steps {echo "In stage Nested 1 within Branch C"}}stage('Nested 2') {steps {echo "In stage Nested 2 within Branch C"}}}}}}}
}

三、jenkinsfile的使用

上面讲过流水线支持两种语法,即声明式和脚本式,这两种语法都支持构建持续交付流水线。并且都可以用来在 Web UI 或 Jenkinsfile 中定义流水线,不过通常将 Jenkinsfile 放置于代码仓库中(当然也可以放在单独的代码仓库中进行管理)。

创建一个 Jenkinsfile 并将其放置于代码仓库中,有以下好处

  • 方便对流水线上的代码进行复查/迭代

  • 对管道进行审计跟踪

  • 流水线真正的源代码能够被项目的多个成员查看和编辑

环境变量
1.静态变量

Jenkins 有许多内置变量可以直接在 Jenkinsfile 中使用,可以通过JENKINS_URL/pipeline/syntax/globals#env获取完整列表。目前比较常用的环境变量如下

  • BUILD_ID:当前构建的 ID,与 Jenkins 版本 1.597+中的 BUILD_NUMBER 完全相同

  • BUILD_NUMBER:当前构建的 ID,和 BUILD_ID 一致

  • BUILD_TAG:用来标识构建的版本号,格式为:jenkins-{BUILD_NUMBER}, 可以对产物进行命名,比如生产的 jar 包名字、镜像的 TAG 等;

  • BUILD_URL:本次构建的完整 URL,比如:http://buildserver/jenkins/job/MyJobName/17/%EF%BC%9B

  • JOB_NAME:本次构建的项目名称

  • NODE_NAME:当前构建节点的名称;

  • JENKINS_URL:Jenkins 完整的 URL,需要在 SystemConfiguration 设置;

  • WORKSPACE:执行构建的工作目录。

示例如果一个流水线名称为print_env,第 2 次构建,各个变量的值。

BUILD_ID:2
BUILD_NUMBER:2
BUILD_TAG:jenkins-print_env-2
BUILD_URL:http://192.168.101.10:8080/job/print_env/2/
JOB_NAME:print_env
NODE_NAME:built-in
JENKINS_URL:http://192.168.101.10:8080/
WORKSPACE:/bitnami/jenkins/home/workspace/print_env

上述变量会保存在一个 Map 中,可以使用 env.BUILD_ID 或 env.JENKINS_URL 引用某个内置变量

pipeline {agent anystages {stage('print env') {parallel {stage('BUILD_ID') {steps {echo "$env.BUILD_ID"}}stage('BUILD_NUMBER') {steps {echo "$env.BUILD_NUMBER"}}stage('BUILD_TAG') {steps {echo "$env.BUILD_TAG"}}}}}
}
2.动态变量

动态变量是根据某个指令的结果进行动态赋值,变量的值根据指令的执行结果而不同。如下所示

  • returnStdout:将命令的执行结果赋值给变量,比如下述的命令返回的是 clang,此时 CC 的值为“clang”。

  • returnStatus:将命令的执行状态赋值给变量,比如下述命令的执行状态为 1,此时 EXIT_STATUS 的值为 1。

//Jenkinsfile (Declarative Pipeline)
pipeline {agent anyenvironment {// 使用 returnStdoutCC = """${sh(returnStdout: true,script: 'echo -n "clang"'   //如果使用shell命令的echo赋值变量最好加-n取消换行)}"""// 使用 returnStatusEXIT_STATUS = """${sh(returnStatus: true,script: 'exit 1')}"""}stages {stage('Example') {environment {DEBUG_FLAGS = '-g'}steps {sh 'printenv'}}}
}
凭证管理

Jenkins 的声明式流水线语法有一个 credentials()函数,它支持 secret text(加密文本)、username 和 password(用户名和密码)以及 secret file(加密文件)等。接下来看一下一些常用的凭证处理方法。

1.加密文本

本实例演示将两个 Secret 文本凭证分配给单独的环境变量来访问 Amazon Web 服务,需要 提前创建这两个文件的 credentials(实践的章节会有演示),Jenkinsfile 文件的内容如下

//Jenkinsfile (Declarative Pipeline)
pipeline {agent anyenvironment {AWS_ACCESS_KEY_ID = credentials('txt1')AWS_SECRET_ACCESS_KEY = credentials('txt2')}stages {stage('Example stage 1') {steps {echo "$AWS_ACCESS_KEY_ID"}}stage('Example stage 2') {steps {echo "$AWS_SECRET_ACCESS_KEY"}}}
}
2.用户名密码

本示例用来演示 credentials 账号密码的使用,比如使用一个公用账户访问 Bitbucket、GitLab、 Harbor 等。假设已经配置完成了用户名密码形式的 credentials,凭证 ID 为 harbor-account

//Jenkinsfile (Declarative Pipeline)
pipeline {agent anyenvironment {BITBUCKET_COMMON_CREDS = credentials('harbor-account')}stages {stage('printenv') {steps {sh "env"}}
}

上述的配置会自动生成 3 个环境变量

  • BITBUCKET_COMMON_CREDS:包含一个以冒号分隔的用户名和密码,格式为 username:password

  • BITBUCKET_COMMON_CREDS_USR:仅包含用户名的附加变量

  • BITBUCKET_COMMON_CREDS_PSW:仅包含密码的附加变量。

3.加密文件

需要加密保存的文件,也可以使用 credential,比如链接到 Kubernetes 集群的 kubeconfig 文件等。

假如已经配置好了一个 kubeconfig 文件,此时可以在 Pipeline 中引用该文件

//Jenkinsfile (Declarative Pipeline)
pipeline {agent {kubernetes {cloud 'kubernetes'slaveConnectTimeout 1200workspaceVolume emptyDirWorkspaceVolume()yaml '''
kind: Pod
metadata:name: jenkins-agent
spec:containers:- args: [\'$(JENKINS_SECRET)\', \'$(JENKINS_NAME)\']image: '192.168.10.15/kubernetes/jnlp:alpine'name: jnlpimagePullPolicy: IfNotPresent- command:- "cat"image: "192.168.10.15/kubernetes/kubectl:apline"imagePullPolicy: "IfNotPresent"name: "kubectl"tty: truerestartPolicy: Never
'''}}environment {MY_KUBECONFIG = credentials('kubernetes-cluster')}stages {stage('kubectl') {steps {container(name: 'kubectl') {sh """kubectl get pod -A  --kubeconfig $MY_KUBECONFIG"""}}}}
}

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/168843.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

水淹七军(递归,又是递归)

北大2023级最强新生问我的,最后他的问题说是重写了一遍就解决了 乐死了,有的时候根本看不出源代码漏了哪里 我的思路是: 一个数组记录本次放水所经过的格子,经过的不再递归 一个数组记录地图上各地点的高度 一个数组记录地图…

uni-app - 去除隐藏页面右侧垂直滚动条

全局配置 "globalStyle": { //全局配置 "scrollIndicator":"none", // 不显示滚动条 "app-plus":{ "scrollIndicator":"none" // 在APP平台都不显示滚动条 } }局部配置 "path": "pages/ind…

vue3 for循环创建的多个e-form 添加校验

v-for 创建 ref <el-form :model"item" :rules"state.rules" :ref"el > getRiskSpreadRef(el, index)" ></el-form>// 定义ref list const riskSpreadRefList ref<HTMLElement[]>([]);// ref存到数组 const getRiskSpread…

物流公司打印用什么软件,佳易王物流运单打印管理系统软件下载

物流公司打印用什么软件&#xff0c;佳易王物流运单打印管理系统软件下载 软件特色&#xff1a; 1、功能实用&#xff0c;操作简单&#xff0c;不会电脑也会操作&#xff0c;软件免安装&#xff0c;已内置数据库。 2、物流开单打印&#xff0c;可以打印两联单或三联单&#x…

大数据-之LibrA数据库系统告警处理(ALM-37002 MPPDB实例连接数超限)

告警解释 CN实例中的客户端连接数量超过了其postgresql.conf配置文件配置的最大可用告警上限&#xff08;max_connections*connection_alarm_rate&#xff09;时&#xff0c;产生该告警。 告警属性 告警ID 告警级别 可自动清除 37002 严重 是 告警参数 参数名称 参数…

基于Vue+SpringBoot的数字化社区网格管理系统

项目编号&#xff1a; S 042 &#xff0c;文末获取源码。 \color{red}{项目编号&#xff1a;S042&#xff0c;文末获取源码。} 项目编号&#xff1a;S042&#xff0c;文末获取源码。 目录 一、摘要1.1 项目介绍1.2 源码 & 项目录屏 二、功能模块三、开发背景四、系统展示五…

c语言:模拟实现各种字符串函数

strlen函数&#xff1a; 功能&#xff1a;获取到\0之前的的字符个数。 代码模拟实现函数&#xff1a; //strlen //这里用了递归法&#xff0c; //如abc&#xff0c;1bc&#xff0c;然后11c&#xff0c;接着111&#xff0c;最后读取到\0&#xff0c;1110&#xff0c;得到结果3…

使用Linux JumpServer堡垒机本地部署与远程访问

&#x1f308;个人主页&#xff1a;聆风吟 &#x1f525;系列专栏&#xff1a;网络奇遇记、Cpolar杂谈 &#x1f516;少年有梦不应止于心动&#xff0c;更要付诸行动。 文章目录 &#x1f4cb;前言一. 安装Jump server二. 本地访问jump server三. 安装 cpolar内网穿透软件四. 配…

宝塔 Linux 面板安装一个高大上的论坛程序 —— Flarum

这个是很早搭建的版本,基于宝塔面板,比较复杂,如果想要简单的搭建方法,可以参看咕咕新写的这篇: 【好玩的 Docker 项目】10 分钟搭建一个高大上的论坛程序 购买腾讯云轻量应用服务器 待补充 登录服务器 待补充 BBR 加速脚本 BBR 加速脚本: BASH cd /usr/src &…

京东数据采集接口推荐(京东大数据分析工具)

随着京东电商平台的不断发展&#xff0c;平台中店铺数量也越来越多&#xff0c;对于电商卖家而言&#xff0c;在电商运营过程中如何做好数据分析也越来越重要。而电商运营数据往往多而杂&#xff0c;想要高效的完成电商数据分析&#xff0c;品牌需要借助一些电商数据分析软件。…

毅速:复杂零件制造首选3D打印

确金属3D打印技术在制造行业的应用日益广泛&#xff0c;为制造业带来了巨大的变革和机遇。这种增材制造技术相较于传统制造工艺具有许多优势&#xff0c;尤其在制造复杂形状零件方面表现出色。 传统制造工艺在制造复杂形状零件时往往面临诸多挑战&#xff0c;如加工难度大、周期…

高性能Mysql第三版学习(一)

学习目标&#xff1a; 高性能Mysql第3版 学习内容&#xff1a; MySQL架构与历史Mysql基座测试服务器性能Schema与数据类型优化创建高性能的索引查询性能优化Mysql高级特性Explain 学习时间&#xff1a; 周一至周五晚上 9点—晚上10点周六晚上9点-10点周日晚上9 点-10点 学习…

mybatis 字符串比较失效

在mybatis的mapper.xml中用以下语句判断条件&#xff1a; <if test"name0"> and name#{name} </if> 实现&#xff0c;当name传入字符串0时&#xff0c;判断name的值 但是在实际运行过程中&#xff0c;这个判断条件并没有生效。 原因&#xff1a;m…

FreeRTOS学习之路,以STM32F103C8T6为实验MCU(2-5:队列)

学习之路主要为FreeRTOS操作系统在STM32F103&#xff08;STM32F103C8T6&#xff09;上的运用&#xff0c;采用的是标准库编程的方式&#xff0c;使用的IDE为KEIL5。 注意&#xff01;&#xff01;&#xff01;本学习之路可以通过购买STM32最小系统板以及部分配件的方式进行学习…

Linux【安全 01】云服务器主机安全加固(修改SSHD端口、禁用登陆失败的IP地址、使用密钥登录)

云服务器主机安全加固 1.SSH登录尝试的系统日志信息2.安全加固方法2.1 修改SSHD端口2.2 禁用登陆失败的IP地址2.3 使用密钥登录 3.总结 1.SSH登录尝试的系统日志信息 Last failed login: Sat Oct 7 14:10:39 CST 2023 from xxx.xx.xx.xxx on ssh:notty There were 10 failed …

电源控制系统架构(PCSA)之系统控制处理器(SCP)协调

目录 5.3 系统控制处理器&#xff08;SCP&#xff09;的协调 5.3.1 SOC电源状态 5.3.2 Cluster电源状态 5.3 系统控制处理器&#xff08;SCP&#xff09;的协调 并非所有的电源状态请求都将被显式处理。除了HW自主选择电源模式外&#xff0c;SCP固件还可以在电源模式选择过…

初出茅庐的小李博客之C语言必备知识枚举体

C语言必备知识枚举体 枚举类型是ANSI C新标准所增加的。如果一个变量只有几种可能的值&#xff0c;可以定义为枚举类型。所谓“枚举是指将变量的值一一列举出来&#xff0c;变量的值只限于列举出来的值的范围内。 枚举的定义形式 enum 枚举类型名 {枚举元素列表 }枚举变量…

Python:diskcache实现基于文件的数据缓存

diskcache是一个基于Sqlite文件的数据缓存 文档 https://grantjenks.com/docs/diskcache/https://github.com/grantjenks/python-diskcachehttps://pypi.org/project/diskcache/ 示例 from diskcache import Cache# 指定文件夹 cache Cache(./cache)# 存 cache.set(name, …

ORA-14452: 试图创建, 变更或删除正在使用的临时表中的索引

在编写一个test存储过程中出现一个错误报告:ORA-14452: 试图创建, 变更或删除正在使用的临时表中的索引,代码如下 create or replace PROCEDURE TMP_TRANSCRIPT AS str_sql varchar2(500);v_flag number:0; --标识 begin--判断临时表是否存在SELECT COUNT(*) into v_flag FROM…

信息收集小练习

信息收集小练习 本文章无任何恶意攻击行为&#xff0c;演示内容都合规无攻击性 演示如何绕过cdn获取真实ip 使用多地ping该网站 发现有很多ip地址&#xff0c;证明有cdn 此处使用搜索引擎搜索&#xff0c;得到ip 演示nmap工具的常用参数 此处以testfire.net为例 使用多地p…