Jenkins集成GitLab的正确姿势，实现Git代码提交触发CI/CD

DevOps在路上

发布于 2024-04-22 10:59:18

4820

发布于 2024-04-22 10:59:18

文章被收录于专栏：DevOps实践之路DevOps实践之路

?jenkins和gitlab是目前DevOps工具链中最常见的，抛开gitlab-ci不谈，gitlab代码提交触发jenkins流水线是最经典的搭配。这里就介绍下如何配置实现jenkins和gitlab之间的集成。

安装GitLab Plguin

Gitlab Plugin- 这个插件允许GitLab在提交代码或打开/更新合并请求时触发Jenkins中的构建。它还可以将构建状态发送回GitLab。

配置Jenkins Server

首先创建GitLab凭证，将凭证填充到 Manage Jenkins->System->enable authentication for '/project' end-point。

?通过该配置，相当于创建了jenkins job 可以操作访问gitlab的凭证，在后面的jenkinsfile中就会使用声明并使用该凭证。

配置Jenkins Job

创建jenkins job, 源代码管理选 Git，Repository URL 填写你 gitlab 上源码 repo 的地址，Credentials 是拉取代码时需要用到的身份认证

构建触发器选择 “Build when a change is pushed to GitLab” （记住后面的GitLab webhook URL 后面要填在gitlab的webhooks中），按照下面勾选

同时点击“高级”，“Allowd branches” 勾选 “Filter branches by regex”

点 “Generate” 生成 token，这个 token 用于填写到 gitlab 的 webhook 里，gitlab 检测到代码提交，会通知 webhook 里填写的 Jenkins 生成的回调URL，并带上这个 token，防止其它人触发 jenkins 的持续集成

注: 复制出 URL 和 token，后面配置 gitlab 的 webhook 会用到

?该步骤的目的主要是为了将要通过gitlab触发的jenkins job的信息准备好，用于后面的配置gitlab-webhook, 让gitlab知道该触发哪个jenkins job.

新版jenkins可能遇到的坑

在“Generate” 生成 token时候，如果使用的是高版本的 jenkins ，会出现403错误 HTTP ERROR 403 No valid crumb was included in the request

这是因为 jenkins 的防止跨站点请求伪造（Prevent Cross Site Request Forgery exploits）阻拦了请求，本来低版本的 jenkins 可以在界面把这个关掉，貌似高版本去掉了，可以通过如下方式：

hudson.security.csrf.GlobalCrumbIssuerConfiguration.DISABLE_CSRF_PROTECTION = true

如果出现下图所示的情况，就表示命令成功了

image.png

上面的方法对于在容器里运行的jenkins而言，需要进入容器修改配置，永久生效

修改/usr/local/bin/jenkins.sh , 找到exec java那行,添加-Dhudson.security.csrf.GlobalCrumbIssuerConfiguration.DISABLE_CSRF_PROTECTION=true

# 最终效果
exec java -Duser.home="$JENKINS_HOME" -Dhudson.security.csrf.GlobalCrumbIssuerConfiguration.DISABLE_CSRF_PROTECTION=true "${java_opts_array[@]}" -jar ${JENKINS_WAR} "${jenkins_opts_array[@]}" "$@"

至此，jenkins 的持续集成配置好了，还需要配置 gitlab 的 webhook，用于代码提交通知 jenkins。

配置Gitlab Webhook

打开 gitlab 的 repo 的 Settings-Integrations,URL 和 Secret Token 填写 jenkins job中构建触发器部分生成的，点击 “Add webhook”，搞定！

在链接那里输入之前jenkins上提供的webhook url 以及“Secret token“，编辑完后保存

点击测试，如果返回200，那就成功了，去jenkins看看有没有自动构建的记录

配置Jenkins返回执行状态

上面步骤仅仅实现了gitlab代码提交触发jenkins job, 那么job执行完成后的状态，怎么在gitlab上看到呢？

pipeline {
    agent any

    options {
        gitLabConnection('gitlab-connection') 
      //Manage Jenkins->System->enable authentication for '/project' end-pointYour配置的GitLab Connection
    }

    stages {
        stage('build') {
            steps {
                updateGitlabCommitStatus name: 'build', state: 'running'
                hogehoge
            }
        }
    }

    post {
        success {
            updateGitlabCommitStatus name: 'build', state: 'success'
        }
        failure {
            updateGitlabCommitStatus name: 'build', state: 'failed'
        }
    }
}

参数说明：

gitLabConnection 是和GitLab链接的名称。GitLab名称的设定是在jenkins管理>系统设定>Gitlab当中设置详细的gitlab url和token
updateGitlabCommitStatus
- name: build 名称
- state: pending, running, canceled, success, failed