### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

### 場景
- 雖然能配置提交程式碼到Git時觸發Jenkins任務，但有時並不需要每次提交程式碼都觸發，而是僅在有需要時才執行。
- 除了在Jenkins頁面上手動執行任務，還可以向Jenkins網站發起HTTP請求，觸發指定任務的執行，本文就來實戰透過Http請求同時觸發多個Jenkins任務執行。
### 概述
- 對於pipeline型別的Jenkins任務，一般是透過外掛 **Generic Webhook Trigger** 來支援遠端觸發的，在使用過程中以下三點需要注意：
- 遠端觸發Jenkin任務，請求的URL怎麼寫；
- Http請求的引數，如何作為pipeline指令碼的引數；
- 假設有Jenkins任務A，某時刻有10個觸發該任務的請求同時到達，Jenkins如何處理？（後面會重點討論此問題）

- 針對上述問題，我們來做一次實戰：
- 向Jenkins服務發起http請求；
- 請求引數是一個Github程式碼倉庫的地址和分支名；
- Jenkins收到這個請求後，執行一個pipeline任務；
- 該任務是下載指定的Github倉庫的程式碼，流程如下圖所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329233522904.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
### 環境資訊
1. 作業系統：CentOS 7.7
2. Jenkins：2.190.3
3. Generic Webhook Trigger外掛：1.66

- 關於Jenkins的部署，請參考文章[《Helm部署和體驗jenkins》](https://blog.csdn.net/boling_cavalry/article/details/103670976)
### 實戰
- 先來安裝外掛，如下圖，進入外掛管理頁面：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329234136679.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 安裝外掛的操作步驟如下圖所示，請按照紅框數字的順序操作：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329234203459.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 稍等片刻，外掛線上安裝成功，如下圖，接下來建立個pipeline任務試試：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329234224951.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 新建名為 **remote-test** 的pipeline任務：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329234506306.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 進入設定頁面，如下圖紅框所示，出現了 **Generic Webhook Trigger** 選項：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329234605592.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 勾選 **Generic Webhook Trigger** 之後頁面會發生變化，如下圖，在紅框位置，先設定token的值為 **token-remote-test** ，這樣http請求中的token引數的值如果等於 **token-remote-test** ，就會觸發當前任務：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329234719748.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 接下來設定請求引數，如下圖紅框所示，先輸入固定的 **ref** 引數（外掛用到的，必須輸入），然後再把 **repositoryURL** 和 **branch** 也設定好，即Github程式碼倉庫地址和分支名，這樣http請求中 **repositoryURL** 和 **branch** 引數就能傳遞到後面的pipeline指令碼中去了；
- 接下來可以寫pipeline指令碼了：
```shell
pipeline {
    agent any
    triggers {
        GenericTrigger(
            genericVariables: [
              [key: 'ref', value: '$.ref'],
              [key: 'repositoryURL', value: '$.repositoryURL'],
              [key: 'branch', value: '$.branch']
            ],
            token: 'token-remote-test' ,
            causeString: '$ref' ,
            printContributedVariables: true,
            printPostContent: true
        )
    }

stages {
        stage('show-param') {
            steps {
                echo 'token引數：$token'
                echo '程式碼倉庫：$repositoryURL'
                echo '程式碼分支：$branch'
            }
        }

stage('down-sourcecode') {
            steps {
                echo '開始下載原始碼'
                checkout([$class: 'GitSCM',
                    branches: [[name: '*/$branch']],
                    doGenerateSubmoduleConfigurations: false,
                    extensions: [],
                    submoduleCfg: [],
                    userRemoteConfigs: [[url: '$repositoryURL']]])
            }
        }            
    }
}
```
- 上述指令碼有以下幾個關鍵點：

a. triggers 、GenericTrigger、genericVariables這幾個引數是固定的，按上述示例去寫即可；

b. printContributedVariables和printPostContent為true，會在執行任務時列印出請求引數的內容來；

c. 這裡一共有兩個stage，在執行 **show-param** 的時候，會將http請求引數全部列印出來；

d.  **checkout** 是pipeline提供的API，用於下載Github倉庫的程式碼，其branches引數的值用上了http的請求引數branch，userRemoteConfigs.url引數的值用上了http的請求引數repositoryURL

- 將上述pipeline指令碼寫在下圖紅框位置，然後點選底部的 **Save** 按鈕儲存：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329235233442.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 任務配置完成，接下來用Postman向Jenkins發起請求，驗證透過Http請求觸發Jenkins任務；
### 驗證
- 我這邊jenkins網站的地址是： **http://192.168.133.149:32049**  ，因此觸發任務的請求地址是： **http://192.168.133.149:32049/generic-webhook-trigger/invoke?token=token-remote-test ** ，注意token引數的值和任務設定中的token值必須一致；
- 在Postman上的配置如下圖所示，請按照數字順序配置，repositoryURL引數的值為 **https://github.com/zq2599/jenkinsdemo.git** ，這是我放在Github上的一個java工程，可以正常下載：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329235359588.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 配置完成後點選 **Send** 按鈕傳送請求，正常情況下收到的返回碼是200，如下圖紅框，如果非200（例如404），請檢查引數和Jenkins任務的引數設定(例如token不一致)：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329235427618.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 回到Jenkins頁面檢視日誌，如下圖紅框，請求引數都被列印出來了：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329235446887.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 繼續往下，可見Github原始碼成功下載：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329235501821.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)
- 至此，透過Http觸發Jenkins的pipeline實戰就完成了，我們可以透過程式、指令碼等各種手段，按照不同的需求來觸發Jenkins任務，並傳給任務不同的引數。
### 併發問題
- 遠端觸發Jenkins任務雖然靈活方便，但是在處理併發請求時會有問題：10個請求同時到達， **只有一個會執行** ，這個問題的詳情和解決辦法在下一篇文章《遠端觸發Jenkins的Pipeline任務的併發問題處理》詳細討論；
### 原始碼下載
- 我的Github地址如下所示：

| 名稱      |   連結 |   備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |

- 裡面有多個工程，請使用 **jenkinsremotedemo** ，如下圖紅框所示，這是個Java工程，裡面的 **remote-test** 檔案就是本文用到的pipeline指令碼，另外這個工程的Java程式碼(App.java)可以向Jenkins同時發起多個遠端觸發請求：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20200329235906520.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70)

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)

遠端觸發Jenkins的Pipeline任務

相關文章