如何无需WebUI配置GitLab实例级Jira集成

针对你的GitLab EE 16.10.0实例，以下是通过gitlab-rails控制台和REST API完成实例级Jira集成配置的具体步骤：

方法一：使用gitlab-rails控制台操作 #

1. 进入GitLab容器的Rails控制台

docker exec -it <你的GitLab容器ID/名称> gitlab-rails console

2. 初始化或获取Jira集成对象

jira_integration = InstanceIntegration.find_or_initialize_by(type: 'JiraIntegration')

3. 配置Jira核心参数（替换为你的实际信息）

jira_integration.attributes = {
  url: 'https://your-jira-domain.atlassian.net', # Jira实例的访问地址
  api_url: 'https://your-jira-domain.atlassian.net/rest/api/3', # Jira API地址，根据Jira版本调整（v2/v3）
  username: 'your-jira-login-email@example.com', # Jira登录邮箱/用户名
  password: 'your-jira-api-token', # Jira API令牌（推荐用此代替密码，在Atlassian账户中生成）
  enabled: true, # 启用集成
  commit_message_prefix: 'JIRA:', # 提交消息中关联Jira issue的前缀，可自定义
  project_key: '', # 留空则全局生效，填写项目Key可限制到特定Jira项目
  issues_enabled: true, # 启用Issue关联功能
  commits_enabled: true, # 启用提交同步到Jira
  merge_requests_enabled: true # 启用合并请求同步到Jira
}

4. 验证并保存配置

# 先验证参数合法性，返回true则继续
jira_integration.valid?

# 保存配置，失败会抛出异常便于排查
jira_integration.save!

方法二：使用GitLab REST API操作 #

需要先创建一个管理员权限的个人访问令牌，勾选api权限范围。

1. 首次配置Jira集成（POST请求）

curl --request POST "https://your-gitlab-domain/api/v4/integrations/jira" \
  --header "PRIVATE-TOKEN: <你的管理员个人访问令牌>" \
  --header "Content-Type: application/json" \
  --data '{
    "url": "https://your-jira-domain.atlassian.net",
    "api_url": "https://your-jira-domain.atlassian.net/rest/api/3",
    "username": "your-jira-login-email@example.com",
    "password": "your-jira-api-token",
    "enabled": true,
    "commit_message_prefix": "JIRA:",
    "project_key": "",
    "issues_enabled": true,
    "commits_enabled": true,
    "merge_requests_enabled": true
  }'

2. 更新现有配置（PUT请求）
   如果需要调整已有的集成设置，只需修改对应参数即可：

curl --request PUT "https://your-gitlab-domain/api/v4/integrations/jira" \
  --header "PRIVATE-TOKEN: <你的管理员个人访问令牌>" \
  --header "Content-Type: application/json" \
  --data '{
    "api_url": "https://your-jira-domain.atlassian.net/rest/api/2",
    "merge_requests_enabled": false
  }'

3. 验证配置状态
   发送GET请求查看当前集成配置：

curl --request GET "https://your-gitlab-domain/api/v4/integrations/jira" \
  --header "PRIVATE-TOKEN: <你的管理员个人访问令牌>"

注意事项 #

• Jira API令牌需在Atlassian账户的「个人设置>安全>API令牌」页面生成
• 确保GitLab实例网络能访问Jira的URL和API地址，无防火墙或代理限制
• 实例级集成会应用到所有项目，若个别项目需要自定义配置，可在项目级集成中覆盖全局设置

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