• Syntax: Scripted Pipelines Versus Declarative Pipelines
• Choosing Between Scripted and Declarative Syntax
• Systems: Masters, Nodes, Agents, and Executors
• Master
• Node
• Agent
• Executor
• Creating Nodes
• Structure: Working with the Jenkins DSL
• Support: Developing a Pipeline Script
• Starting a Pipeline Project
• The Editor
• Syntax checking
• Working with the Snippet Generator
• Running a Pipeline
• Build
• Viewing logs

• pipeline 语法的两种风格
• pipeline 运行的环境
• pipeline 基本结构
• Jenkins 为创建执行 pipeline 提供的工具

Syntax: Scripted Pipelines Versus Declarative Pipelines

// Scripted Pipeline
node('worker_node1') {
    stage('Source') { // Get code
        // get code from our Git repository
        git 'git@diyvb2:/home/git/repositories/workshop.git'
    }
    stage('Compile') { // Compile and do unit testing
       // run Gradle to execute compile and unit testing
       sh "gradle clean compileJava test"
    }
}

// Declarative Pipeline
pipeline {
    agent {label 'worker_node1'}
    stages {
        stage('Source') { // Get code
            steps {
                // get code from our Git repository
                git 'git@diyvb2:/home/git/repositories/workshop.git'
            }
        }
        stage('Compile') { // Compile and do unit testing
            steps {
                // run Gradle to execute compile and unit testing
                sh "gradle clean compileJava test"
            }
        }
    }
}

Choosing Between Scripted and Declarative Syntax

Systems: Masters, Nodes, Agents, and Executors

Master

1. 安全问题，在 master 运行的任务可以访问所有的配置数据信息
2. 运行负载过高的任务会导致 Jenkins 变慢

Node

Agent

Executor

Creating Nodes

Structure: Working with the Jenkins DSL

pipeline {
    agent any

    stages {
        stage('Hello') {
            steps {
                echo 'Hello World'
            }
        }
    }
}

• pipeline是 Declarative Pipeline 的顶层指令，表示开始定义一个流水线。
• agent any指定了流水线的运行环境，这里的any表示可以在任何可用的节点上执行流水线。
• stages定义了流水线中的阶段，每个阶段包含一个或多个步骤。
• stage('Hello')定义了一个名为'Hello'的阶段，用于执行一个任务。
• steps定义了在该阶段中执行的步骤。
• echo 'Hello World'是一个步骤，用于在控制台输出字符串'Hello World'。

1. 结构化语法：Declarative Pipeline使用结构化语法来定义流水线的不同部分。包括pipeline块作为最外层的容器，并可以包含多个stage块。每个stage块代表流水线的一个阶段，可以包含一个或多个步骤。
2. 高可读性：Declarative Pipeline的语法设计旨在提高可读性，使得流水线的意图更加清晰。使用关键字和指令来描述各个阶段和步骤，并提供了清晰的结构和缩进来区分不同的部分。
3. 集成性：Declarative Pipeline天生集成了 Jenkins 生态系统中的许多功能和插件。支持各种步骤和指令，如构建、测试、部署、通知等，可以轻松地与其他Jenkins插件和工具进行集成。
4. 可扩展性：Declarative Pipeline 支持自定义的步骤和条件，可以通过编写自定义的 Groovy 函数或引用外部的共享库来扩展流水线的功能。

Support: Developing a Pipeline Script

Starting a Pipeline Project

The Editor

Syntax checking

Working with the Snippet Generator

1. 打开 Snippet Generator：在 Jenkins 界面中，导航到 Pipeline，并点击"Pipeline Syntax"链接。这将带您进入 Snippet Generator。

1. 选择步骤或指令：在 Snippet Generator 页面的"Sample Step"下拉菜单中，选择"git: Git"。这将加载 git 步骤的相关参数。

   

2. 配置参数：在 Repository URL 参数中，输入要克隆的 Git 存储库的 URL。以及在 Branch 和 Credentials 输入对应的字段。

   

   

3. 生成代码片段：点击 Generate Pipeline Script 按钮。Snippet Generator 将根据您的配置生成 git clone 步骤的代码片段
4. 在流水线中使用代码片段：将生成的代码复制并粘贴到 pipeline 的适当位置。确保将其放在正确的 stage 中。

     stage('Source') {
         steps {
             git credentialsId: 'jenkins-demo', url: 'https://github.com/brentlaster/gradle-greetings.git'
         }
     }

Running a Pipeline

pipeline {
    agent any

    stages {
        stage('Source') {
            steps {
                git credentialsId: 'jenkins-demo', url: 'https://github.com/brentlaster/gradle-greetings.git'
            }
        }
        stage('Build') {
            // TO-DO: Execute the gradle build associated with this project
            steps {
                sh 'echo gradle build will go here'
            }
        }
    }
}

Build

Viewing logs

1. Console Output：点击进入到 job，在侧边栏单击 Console Output 就可以看到所有的日志。

   

2. Stage view 快捷查看日志：鼠标停留在相应的 stage 上，就会显示 Logs 。点击就会显示相关 stage 的日志。

   

   

   1. Open Bule Ocean ：点击进入到 job，在侧边栏单击 Open Bule Ocean ，如下图所示：

      

   Replay

   Jenkins Replay 可以重新运行先前执行过的构建。通过 Replay 功能，可以在不改变源代码的情况下修改 pipeline，进行测试。

   1. 侧边栏点击 Replay

   

   1. 修改脚本：更改 build 步骤

      steps {
      	// sh 'echo gradle build will go here'
        sh 'echo replay build'
      }

   2. Run and check：点击 Run 则会执行#2，查看日志输出，正是我们修改的内容。但是查看配置信息，Script 还是修改前的内容。

      

      Summary

      本章介绍了 Jenkins 基础功能的使用以及相关的概念。从不同的维度，对比了两种语法的优缺点。之后明确了 Jenkins 环境系统相关的定义，让我们知道 pipeline 是在哪运行。然后，简单介绍 Jenkins DSL 的结构，并介绍了 Jenkins 为方便开发 Pipeline 提供的一些工具。

      这些信息为在工作中使用和探索其余内容提供坚实的基础。在接下来的章节，我们会在此基础上进行更深入的探讨。