Jenkins CLI 命令詳解

2022-01-12 23:09:08 字數 3714 閱讀 1714

筆者在前文《通過 cli 管理 jenkins server》中介紹了如何通過 ssh 或客戶端命令列的方式管理 jenkins server,限於篇幅,前文主要的目的是介紹連線 jenkins server 的方式。本文主要介紹 jenkins server 提供的常用命令。

本文主要演示以 ssh 的方式執行常見的 jenkins cli 命令,關於通過 ssh 連線 jenkins server 的內容,請參考前文。說明:本文的演示環境為 ubuntu 16.04。

create-node 命令需要指定乙個 xml 檔案作為引數,這個 xml 檔案中儲存著新建 node 的配置資訊。方便起見我們可以先使用 get-node 命令獲得乙個現有 node 的配置檔案,然後修改其中的配置,並最終用來建立新的 node。比如我們當前有乙個名為 testagent 的 node:

用下面的命令獲得其配置資訊:

接下來複製乙份 testagent.xml 檔案,建立 myagent.xml 檔案,並修改 myagent.xml 檔案中的相關配置。比如把 agent 名稱改為 myagent,host 修改為新 agent 的 ip 位址,credentialsid 改為具有適當許可權的新 id。最後用新的 myagent.xml 檔案建立 node:

這樣新的 node 就建立好了。當然,我們也可以使用 delete-node 命令刪除乙個 node。

jenkins 預設提供的操作 plugin 的 cli 只有  list-plugins 和 install-plugin。list-plugins 用來羅列所有已安裝的 plugins:

如果為 list-plugins 指定引數(外掛程式的名稱),則只顯示該外掛程式的資訊,該外掛程式不存在就報錯:

install-plugin 命令用來安裝外掛程式:

install-plugin source ... [-deploy] [-name val] [-restart]

根據指定的 source 選項,分別可以從 url、本地檔案和 update center 安裝外掛程式。預設從 update center 安裝外掛程式,只用指定外掛程式的短名稱(id)就可以了:

$ ssh -l jack -p 8090

192.168.21.145

install-plugin greenballs -deploy

-deploy 表示立即部署外掛程式而不必等到下次重啟 jenkins。

如果指定的外掛程式已經存在並且需要公升級到新的版本,同樣執行 install-plugin 命令就可以了:

-restart 選項表示安裝完成後重啟 jenkins。

等 jenkins 重啟完成後,發現外掛程式已經被更新到了最新的版本:

注意:update center 安裝外掛程式時,會自動安裝當前外掛程式所依賴的外掛程式

通過本地的檔案安裝外掛程式

$ ssh -l jack -p 8090

192.168.21.145

install-plugin = -deploy < greenballs.hpi -name greenballs

注意,此時需要通過 -name 選項指定外掛程式的名稱。

jenkins cli 提供了豐富的命令來操作 job:

list-jobs:預設列出所有的 job

get-job:獲得指定 job 的配置檔案

copy-job:以現存的 job 為模板建立乙個新的 job

create-job:建立乙個新的 job,以標準輸入中的內容作為配置資訊

update-job:以配置檔案中的內容更新 job

delete-job:刪除 job

enable-job:enable job

disable-job:disable job

雖然 job 操作涉及的命令比較多,但是都相對的簡單,這裡不再一一演示。

build 命令用來觸發乙個 job 任務,我們可以通過 help 命令來檢視一下 build 命令的幫助文件:

由上面的文件可知,可以通過 -f 和 -v 選項同步的執行 job 並獲得控制台輸出:

jenkins cli 預設支援的命令很多,這裡只是簡單介紹了其中的幾個,主要目的是幫助理解 jenkins cli 命令的基本用法。更多命令的詳細用法請參考官方文件。

參考:

jenkins cli

Jenkins CLI 命令詳解

筆者在前文 通過 cli 管理 jenkins server 中介紹了如何通過 ssh 或客戶端命令列的方式管理 jenkins server,限於篇幅,前文主要的目的是介紹連線 jenkins server 的方式。本文主要介紹 jenkins server 提供的常用命令。本文主要演示以 ssh...

快速學習 Jenkins CLI憑據

通過jcli可以在 jenkins 上建立憑據 credentials 下面介紹使用方法。jenkins 中的憑據有多種型別,下面的命令會建立乙個使用者名稱和密碼型別的憑據 jcli credential create credential username your username creden...

快速學習 Jenkins CLI使用者

jcli可以完成使用者的建立 刪除以及生成令牌 token 的操作,jcli user create password flags 在建立使用者的時候,可以指定乙個密碼或者隨機生成。jenkins 的 web api 必須是通過令牌 token 來訪問,jcli支援給當前使用者或者 指定使用者生成令...