11
0
0
使用python进行jenkins批量发布
文章摘要
|
使用python进行jenkins批量发布
背景
最近准备上线skywalking的agent,于是需要重启所有的服务,服务有点多,在界面点的话,比较麻烦
寻找方案
有三种可选方案:Shell 脚本 + curl(调用 REST API)、Python 脚本(使用 python-jenkins 库) 以及 Jenkins CLI。
方案选择
这里选择了python脚本,Python 的 python-jenkins 库处理多层文件夹和参数更加优雅,不需要手动拼接 /job/ 路径,也能直接处理中文
开始使用
前置条件
获取jenkins用户token
获取 API Token:登录 Jenkins -> 点击右上角用户名 -> Configure(设置) -> API Token -> Add new Token。(切勿使用账号登录密码,必须用 Token)
确认jenkins的job任务名称
确认任务名称:注意如果 Job 在文件夹(Folder)内,API 路径中的文件夹和 Job 之间需要用 /job/ 连接,例如:job/文件夹名/job/任务名。
安装python3和python-jenkins
root@cks-node01 /u/l/s/jenkins-auto# pip install python-jenkins
Collecting python-jenkins
Downloading python_jenkins-1.8.3-py3-none-any.whl (29 kB)
Requirement already satisfied: requests in /usr/lib/python3/dist-packages (from python-jenkins) (2.22.0)
Collecting multi-key-dict
Downloading multi_key_dict-2.0.3.tar.gz (8.4 kB)
Collecting pbr>=0.8.2
Downloading pbr-7.0.3-py2.py3-none-any.whl (131 kB)
|████████████████████████████████| 131 kB 901 kB/s
Requirement already satisfied: setuptools in /usr/lib/python3/dist-packages (from pbr>=0.8.2->python-jenkins) (45.2.0)
Building wheels for collected packages: multi-key-dict
Building wheel for multi-key-dict (setup.py) ... done
Created wheel for multi-key-dict: filename=multi_key_dict-2.0.3-py3-none-any.whl size=9300 sha256=4f94b966bd3d95619a27d094bc4bc21c2d03cee27bc95451573c372c89f8cdab
Stored in directory: /root/.cache/pip/wheels/38/ae/7b/f0308afed57df2bc61f2ccc08343243dff27c4a78377e718dd
Successfully built multi-key-dict
Installing collected packages: multi-key-dict, pbr, python-jenkins
Successfully installed multi-key-dict-2.0.3 pbr-7.0.3 python-jenkins-1.8.3
不带中文路径、有参构建
#!/bin/bash
# ================= 配置区 =================
JENKINS_URL="https://jenkins.abc.cn"
USER="你的用户名"
TOKEN="你的API_Token" # 必须使用 API Token
BASE_JOB_PATH="job/watch/job/app_java"
PARAMS="branch=dev"
# ==========================================
# 23个服务列表
JOBS=(
"devin-account-service" "devin-user-service" "devin-mall-service"
)
SUCCESS_COUNT=0
FAIL_COUNT=0
echo "⏳ 正在获取 CSRF Crumb..."
# -k 跳过 HTTPS 证书校验
CRUMB_JSON=$(curl -s -k -u "$USER:$TOKEN" "$JENKINS_URL/crumbIssuer/api/json")
CRUMB_FIELD=$(echo $CRUMB_JSON | jq -r '.crumbRequestField' 2>/dev/null)
CRUMB_VALUE=$(echo $CRUMB_JSON | jq -r '.crumb' 2>/dev/null)
if [ -z "$CRUMB_FIELD" ] || [ "$CRUMB_FIELD" == "null" ]; then
echo "⚠️ 未获取到 Crumb,将尝试无 Crumb 触发..."
CRUMB_HEADER=""
else
echo "✅ Crumb 获取成功"
CRUMB_HEADER="-H \"$CRUMB_FIELD:$CRUMB_VALUE\""
fi
echo "=================================================="
echo "🚀 开始批量触发 ${#JOBS[@]} 个任务 (参数: $PARAMS)"
echo "=================================================="
for JOB_NAME in "${JOBS[@]}"; do
FULL_URL="$JENKINS_URL/$BASE_JOB_PATH/job/$JOB_NAME/buildWithParameters?delay=0sec"
# 执行触发
HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" -k -X POST \
-u "$USER:$TOKEN" \
-H "$CRUMB_FIELD:$CRUMB_VALUE" \
--data "$PARAMS" \
"$FULL_URL")
if [ "$HTTP_CODE" == "201" ]; then
echo "✅ [成功] $JOB_NAME"
((SUCCESS_COUNT++))
else
echo "❌ [失败] $JOB_NAME (HTTP状态码: $HTTP_CODE)"
((FAIL_COUNT++))
fi
# 休眠 0.5 秒,避免瞬间并发请求导致 Jenkins Master 节点卡顿
sleep 0.5
done
echo "=================================================="
echo "🏁 执行完毕! 成功: $SUCCESS_COUNT | 失败: $FAIL_COUNT"
echo "=================================================="
带中文路径、无参构建
import jenkins
import os
import time
# ================= 配置区 =================
JENKINS_URL = 'https://jenkins.abc.cn'
USER = '你的用户名'
TOKEN = '你的API_Token'
# 直接使用中文路径 (python-jenkins 会自动处理 URL 编码)
BASE_JOB_PATH = 'java后端/测试'
# 如果任务需要参数,请取消注释并填入参数;如果不需要,保持为空字典 {}
PARAMS = {}
# PARAMS = {'branch': 'dev'}
# ==========================================
JOBS = ["user", "account", "gateway"]
# 跳过 HTTPS 证书校验
os.environ['PYTHONHTTPSVERIFY'] = '0'
def main():
try:
server = jenkins.Jenkins(JENKINS_URL, username=USER, password=TOKEN)
server.get_whoami()
print(f"✅ Jenkins 连接成功!准备触发 {len(JOBS)} 个任务...\n")
except Exception as e:
print(f"❌ 连接 Jenkins 失败: {e}")
return
success_count = 0
fail_count = 0
for job_name in JOBS:
full_job_name = f"{BASE_JOB_PATH}/{job_name}"
try:
# 如果 PARAMS 为空字典,库会自动调用 /build
# 如果 PARAMS 有值,库会自动调用 /buildWithParameters
server.build_job(full_job_name, parameters=PARAMS)
print(f"✅ [成功] {job_name}")
success_count += 1
except jenkins.NotFoundException:
print(f"❌ [失败] {job_name} (原因: 找不到该任务,请检查名称)")
fail_count += 1
except jenkins.JenkinsException as e:
print(f"❌ [失败] {job_name} (原因: {e})")
fail_count += 1
time.sleep(0.5)
print(f"\n🏁 批量触发完成! 成功: {success_count} | 失败: {fail_count}")
if __name__ == "__main__":
main()
结果展示
root@devin:/usr/local/src/jenkins-auto# python3 start-java.py
✅ Jenkins 连接成功!准备触发 3 个任务...
✅ [成功] user
✅ [成功] account
✅ [成功] gateway
🏁 批量触发完成! 成功: 3 | 失败: 0
文档信息
- 文章作者: 运维技术团队 - 辣个男人Devin
- 发布日期: 2026-06-30
- 适用系统: Ubuntu 24.04
- 参考链接: https://python-jenkins.readthedocs.io/en/latest/index.html
如果觉得本文对你有帮助,欢迎点赞、在看、转发,让更多运维的同学少走弯路!
使用python进行jenkins批量发布
/archives/shi-yong-pythonjin-xing-jenkinspi-liang-fa-bu