如何配置Rundeck Webhook实现特定分支代码提交触发作业

1. 在Rundeck中创建专属Webhook #

• 登录Rundeck控制台，进入目标项目的「项目设置」→「Webhooks」页面
• 点击「创建Webhook」，填写关键信息：
  • 名称：设置辨识度高的名称（比如「Main分支提交触发部署」）
  • 关联作业：选择需要自动触发的Rundeck作业
  • 签名密钥：设置随机安全字符串（后续代码仓库配置需与该值一致，用于请求合法性验证）
• 保存后，复制生成的Webhook URL（格式类似http://your-rundeck-url/webhook/xxxx-xxxx）

2. 配置代码仓库的Webhook触发规则 #

以主流的GitHub、GitLab为例，其他托管平台逻辑通用：

GitHub配置 #

• 进入目标仓库的「Settings」→「Webhooks」→「Add webhook」
• 粘贴Rundeck生成的Webhook URL
• 「Content type」选择application/json
• 「Secret」填写Rundeck设置的签名密钥
• 「Which events would you like to trigger this webhook?」选择「Just the push event」
• 在「Branch filter」中输入特定分支名（支持精确匹配如main，或通配符如feature/*）
• 点击「Add webhook」完成配置

GitLab配置 #

• 进入目标仓库的「设置」→「集成」→「添加Webhook」
• 粘贴Rundeck的Webhook URL
• 「Secret token」填写Rundeck的签名密钥
• 「触发事件」勾选「推送事件」
• 在「分支」选项中选择「仅指定分支」，输入目标分支名
• 点击「添加Webhook」

3. 在Rundeck中添加分支过滤（双重验证） #

为避免仓库配置疏漏导致误触发，可在Rundeck侧再添加一层分支校验：

• 回到Rundeck的Webhook编辑页面，找到「Payload Filter」区域
• 添加一条过滤规则：
  • 选择「JSONPath」作为过滤类型
  • 输入路径：$.ref（对应代码仓库推送事件中分支的引用路径，例如GitHub中main分支的ref为refs/heads/main）
  • 设置匹配规则为「等于」，输入目标分支的完整ref值（比如refs/heads/main）
• 保存修改，仅符合分支条件的请求会触发作业

4. 验证配置 #

• 手动向目标分支提交代码（比如修改README文件）
• 进入Rundeck的「作业执行记录」，查看是否有自动触发的作业实例
• 若未触发，排查方向：
  • 检查代码仓库的Webhook日志（如GitHub的Webhook页面可查看请求状态与响应内容）
  • 查看Rundeck日志，确认是否存在签名验证失败、payload过滤不匹配的错误
  • 确保代码仓库服务器能访问到Rundeck的URL（内网环境需配置端口转发或内网穿透）

内容的提问来源于stack exchange，提问作者Rajesh V