Jenkins安装 - 云原生基站

[!jenkins文章分为三部分]
第一部分为docker安装Jenkins与常用插件使用,此文章
第二部分为运行pipeline并通过k8s pod打包 [[Jenkins-pipeline使用]]
第三部分为,pipeline高阶使用,如map,共享库,参考 [[Jenkins-pipeline进阶使用]]

1 安装#

[!attention] 这里使用的lts镜像,官网查的版本不准,建议去这里查[Jenkins lts 更新记录](https://www.jenkins.io/changelog-stable/ 把2.492.3换成查到的最新版本,如果需要jdk8就改成lts-jdk8 -如果不需要集成k8s,取消注释,准备好二进制

1
services:
2
  jenkins:
3
    image: ccr.ccs.tencentyun.com/ccops/all:jenkins-2.492.3-lts-jdk17
4
    user: root
5
    container_name: jenkins
6
    restart: always
7
    environment:
8
      TZ: "Asia/Shanghai"
9
      JENKINS_UC: "https://mirrors.tuna.tsinghua.edu.cn/jenkins/"
10
      JENKINS_UC_DOWNLOAD: "https://mirrors.tuna.tsinghua.edu.cn/jenkins/"
11
      JAVA_OPTS: "-Dhudson.model.DownloadService.noSignatureCheck=true"
12
      # MAVEN_HOME: "/usr/local/maven"
13
      # PATH: "$JAVA_HOME/bin:$MAVEN_HOME/bin:$PATH"
14
    ports:
15
      - "8080:8080"
16
      - "50000:50000"
17
    volumes:
18
      - ./data:/var/jenkins_home
19
      - /etc/localtime:/etc/localtime
20
      # pipeline复用
21
      # - ./script:/var/jenkins_home/script
22
      # - bin/docker:/usr/bin/docker
23
      # - bin/kubectl:/usr/bin/docker
24
      # - bin/apache-maven-3.9.9:/usr/local/maven

1.1 准备国内源,防止插件安装不上#

2.492.1换成对应的版本,我这是2.492.3,但是没有,只能先用这个如果版本不对应插件可能安装不上

1
cat data/hudson.model.UpdateCenter.xml
2
<?xml version='1.1' encoding='UTF-8'?>
3
<sites>
4
  <site>
5
    <id>default</id>
6
    <url>https://mirrors.huaweicloud.com/jenkins/updates/dynamic-stable-2.492.1/update-center.json</url>
7
  </site>
8
</sites>

2 登陆#

查看密码

1
cat data/secrets/initialAdminPassword
2
4c0418dc42524016beb2aa7a67196693

登录后选择自己安装插件,先安装这几个

3 插件#

3.1 安装#

http://jenkins:8080/manage/pluginManager/available

名称	作用
Pipeline: Stage View	展示pipeline步骤
Git	通用clone代码插件
Git Parameter	能够与 Git 插件结合使用，动态获取 Git 项目中分支信息
Docker Pipeline	构建隐藏docker build,账号密码等命令
Rebuilder	重复上次构建
AnsiColor	扩展 echo -e指令，输出增加颜色。
Config File Provider	存储 k8s Deployment 模板等信息
Pipeline Utility Steps	操作文件的插件,与Config File Provider结合使用
Kubernetes	使用 Kubernetes 集群运行 Jenkins agent
Lark Notice Plugin	可选,钉钉,飞书告警插件,不支持在线安装,点击这里安装
Pipeline: Groovy Libraries	可选,共享 Pipeline 脚本
Job Configuration History	pipeline回滚功能
Extended Choice Parameter	支持多选,但现在有漏洞并且不维护,2025年4月17日
Active Choices	更高级的扩展选项,也支持多选,但配置复杂
Publish Over SSH	支持远程传输文件与执行命令
Material Theme与Blue Ocean	美化页面,但Blue Ocean支持功能比较少,比如不支持Active Choices插件
Kubernetes CLI	隐藏 kubeconfig
Generic Webhook Trigger	通过解析GitLab Webhook的JSON数据动态触发对应Job

3.2 插件使用#

3.2.1 Git#

pipeline 例子

1
git(credentialsId: "${GIT_ID}", url: "$GIT_URL", branch: "${BRANCH_NAME}", changelog: true, poll: false)

3.2.2 AnsiColor#

3.2.3 Config File Provider#

http://jenkins:8080/manage/configfiles/

3.2.4 Pipeline Utility Steps#

pipeline例子

1
onfigFileProvider([configFile(fileId: "${KUBERNETES_DEPLOYMENT_ID}", targetLocation: "deployment.yaml")]){
2
  script {
3
    // 替换deployment文件中的变量
4
    deploy = readFile encoding: "UTF-8", file: "deployment.yaml"
5
    deployfile = deploy.replaceAll("#APP_NAME","${APP_NAME}")
6
                   .replaceAll("#APP_REPLICAS","${KUBERNETES_APP_REPLICAS}")
7
                   .replaceAll("#APP_IMAGE_NAME","${dockerImageName}")
8
    // 生成新的 Kubernetes 部署文件
9
    writeFile encoding: 'UTF-8', file: './deploy.yaml', text: "${deployfile}"
10
    sh "cat deploy.yaml"
11
  }
12
}

3.2.5 Kubernetes#

3.2.5.1 添加kubeconfig#

3.2.5.2 添加集群#

选择刚才添加的凭据
image.png
测试

3.2.5.3 Pod模板#

这里建议自己制作镜像,把maven,kubelet什么的放进来,方便维护,用k8s与不用k8s好切换 jdk版本按需选择

1
cat Dockerfile
2
FROM jenkins/inbound-agent:latest-jdk17
3
ADD make/kubectl /usr/bin/kubectl
4
ADD make/apache-maven-3.9.9 /usr/local/maven
5
ENV MAVEN_HOME=/usr/local/maven
6
ENV PATH=$JAVA_HOME/bin:$MAVEN_HOME/bin:$PATH
7
ENV TZ=Asia/Shanghai
8
USER root
9
RUN cp /usr/share/zoneinfo/${TZ} /etc/localtime \
10
    && echo "${TZ}" > /etc/timezone
11
USER jenkins

maven配置

1
cat make/apache-maven-3.9.9/conf/settings.xml
2
<?xml version="1.0" encoding="UTF-8"?>
3
<settings xmlns="http://maven.apache.org/SETTINGS/1.2.0"
4
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.2.0 https://maven.apache.org/xsd/settings-1.2.0.xsd">
6
<localRepository>/data/repo</localRepository>
7
  <pluginGroups>
8

9
  </pluginGroups>
10
  <proxies>
11

12
  </proxies>
13
  <servers>
14

15
  </servers>
16
  <mirrors>
17
    <mirror>
18
      <id>alimaven</id>
19
      <name>aliyun maven</name>
20
      <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
21
      <mirrorOf>central</mirrorOf>
22
    </mirror>
23
  </mirrors>
24
  <profiles>
25
    <profile>
26
       <id>jdk-17</id>
27
       <activation>
28
           <activeByDefault>true</activeByDefault>
29
           <jdk>17</jdk>
30
       </activation>
31
       <properties>
32
          <maven.compiler.source>17</maven.compiler.source>
33
          <maven.compiler.target>17</maven.compiler.target>
34
          <maven.compiler.compilerVersion>17</maven.compiler.compilerVersion>
35
      </properties>
36
    </profile>
37
  </profiles>
38
</settings>

pod模板

为了演示这里单独加个docker in docker容器,也可以制作all镜像的时候安装docker

如果加容器了就需要pipeline里添加 container(‘docker’),要不然默认用jnlp容器执行

1
apiVersion: v1
2
kind: Pod
3
metadata:
4
  labels:
5
    app: jenkins-slave
6
spec:
7
  securityContext:
8
    runAsUser: 0
9
    privileged: true
10
  nodeSelector:
11
    node-role.kubernetes.io/jenkins-slave: "yes"
12
  containers:
13
  - name: jnlp
14
    tty: true
15
    workingDir: /home/jenkins/agent
16
    image: ccr.ccs.tencentyun.com/ccops/all:inbound-jdk17-all
17
    volumeMounts:
18
      - name: data
19
        mountPath: /data/repo
20
  - name: docker
21
    workingDir: /home/jenkins/agent
22
    image: ccr.ccs.tencentyun.com/ccops/all:docker-28.0.4-cli
23
    command: ["cat"]
24
    tty: true
25
    volumeMounts:
26
      - mountPath: /var/run/docker.sock
27
        name: dockersock
28
        readOnly: true
29
      - mountPath: /etc/docker/daemon.json
30
        name: dockerdaemon
31
        readOnly: true
32
  volumes:
33
    - name: data
34
      nfs:
35
        path: /data/nfs_data
36
        server: 192.1.1.1
37
    - name: dockersock
38
      hostPath:
39
        path: /var/run/docker.sock
40
    - name: dockerdaemon
41
      hostPath:
42
        path: /etc/docker/daemon.json

这里添加

3.2.6 Lark Notice Plugin#

参考,很简单

3.2.7 Extended Choice Parameter#

支持多选,但有漏洞并且不在维护

1
pipeline {
2
......
3
  parameters {
4
    extendedChoice name: 'APP_NAME', type: 'PT_CHECKBOX', description: '请勾选所要发布的项目模块', quoteValue: false, saveJSONParameterToFile: false, value: 'app1,app2', visibleItemCount: 7, multiSelectDelimiter: ',', defaultValue: 'app1'
5
  }
6
......

3.2.8 Active Choices#

1
properties([
2
  parameters([
3
    [
4
      $class: 'ChoiceParameter',
5
      choiceType: 'PT_CHECKBOX',  // 复选
6
      name: 'APP_NAME',
7
      description: '选择应用',
8
      script: [
9
        $class: 'GroovyScript', // Groovy脚本
10
        script: [
11
          classpath: [],
12
          sandbox: true,
13
          // 要返回的结果,写在一行
14
          script: "return ['app1', 'app2']"
15
        ]
16
      ]
17
    ]
18
  ])
19
])
20
pipeline {
21
......
22
}

3.2.9 Publish Over SSH#

3.2.9.1 添加远程主机#

3.2.9.2 Pipeline使用#

[!info]

{hostName} 可以写成host-213

xecCommand 要执行的命令

remoteDirectory 要创建的目录,在/data/app下

sourceFiles jenkins上文件路径

verbose 是否开启ssh执行日志,debug用

1
  sshPublisher(publishers: [sshPublisherDesc(configName: "${hostName}", transfers: [sshTransfer(cleanRemote: false, excludes: '', execCommand: """
2
    docker-compose -f /data/app/${appName}/docker-compose.yml up -d
3
  """, execTimeout: 120000, flatten: false, makeEmptyDirs: false, noDefaultExcludes: false, patternSeparator: '[, ]+', remoteDirectory: "${appName}/", remoteDirectorySDF: false, removePrefix: '', sourceFiles: 'docker-compose.yml')], usePromotionTimestamp: false, useWorkspaceInPromotion: false, verbose: false)])

3.2.10 Generic Webhook Trigger#

[!info] 我这里的方案是 gitlab push 触发单独 job, 然后通过 webhook 传的变量运行 job 任务
这里 job 任务名称要与 gitlab 仓库名称一样, 不一样需要加判断执行哪个 job

1
pipeline {
2
  agent any
3
  options {
4
    buildDiscarder(logRotator(numToKeepStr: '10', artifactNumToKeepStr: '5'))
5
    timeout(time:12, unit:'HOURS')
6
    skipDefaultCheckout()
7
  }
8
  triggers {
9
    GenericTrigger(
10
      genericVariables: [
11
        // 提取变量
12
        // git仓库名字,与job名称一致
13
        [key: 'REPO_NAME', value: '$.project.name'],
14
        // 分支名称,只有test分支触发
15
        [key: 'BRANCH', value: '$.ref'],
16
        // 提取提交信息,设置提交某些内容部署
17
        [key: 'COMMIT_MSG', value: '$.commits[0].message']
18
      ],
19
      // token, 随机生成
20
      token: '119f7f9e9447aa4ff3b12f9542776a6e1b',
21
      // 在构建日志中显示触发原因
22
      causeString: 'Triggered by $REPO_NAME (Branch: $BRANCH, Commit: $COMMIT_MSG)',
23
      // 触发器的过滤条件
24
      regexpFilterText: '$BRANCH $COMMIT_MSG',
25
      // 过滤文本,两个变量拼接内容为refs/heads/test cd*才部署
26
      regexpFilterExpression: '^refs/heads/test\\b' + ' cd.*',
27
      printContributedVariables: false,
28
      printPostContent: false
29
    )
30
  }
31
  stages {
32
    stage('Trigger Target Job') {
33
      steps {
34
        script {
35
          // 双重检查：分支+commit消息前缀
36
          if (env.BRANCH == 'refs/heads/test' && env.COMMIT_MSG?.trim()?.toLowerCase()?.startsWith('cd')) {
37
            // 触发同名任务（REPO_NAME变量值作为任务名）
38
            build job: env.REPO_NAME
39
          } else {
40
            // 构造跳过原因说明
41
            def skipReason = "Skipped: "
42
            if (env.BRANCH != 'refs/heads/test') {
43
              skipReason += "不是test分支. "
44
            }
45
            if (!env.COMMIT_MSG?.trim()?.toLowerCase()?.startsWith('cd')) {
46
              skipReason += "提交内容不是cd开头. "
47
            }
48
            echo skipReason
49
          }
50
        }
51
      }
52
    }
53
  }
54
}

gitlab 里 webhook 地址配置: http://${jenkins_url}$/generic-webhook-trigger/invoke/invoke?token=119f7f9e9447aa4ff3b12f9542776a6e1b

1 安装#

1.1 准备国内源,防止插件安装不上#

2 登陆#

3 插件#

3.1 安装#

3.2 插件使用#

3.2.1 Git#

3.2.2 AnsiColor#

3.2.3 Config File Provider#

3.2.4 Pipeline Utility Steps#

3.2.5 Kubernetes#

3.2.5.1 添加kubeconfig#

3.2.5.2 添加集群#

3.2.5.3 Pod模板#

3.2.6 Lark Notice Plugin#

3.2.7 Extended Choice Parameter#

3.2.8 Active Choices#

3.2.9 Publish Over SSH#

3.2.9.1 添加远程主机#

3.2.9.2 Pipeline使用#

3.2.10 Generic Webhook Trigger#

文章分享

评论区

音乐

文章目录