Jenkins pipeline使用 - 云原生基站

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

1 准备#

[!info] 提前安装好插件参考 [[Jenkins安装]]主要是 Config File Provider

1.1 dockerfile模板#

1
# global-dockerfile-file
2
FROM ccr.ccs.tencentyun.com/ccops/all:jdk-17
3
EXPOSE 18100
4
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
5
ENV TZ=Asia/Shanghai\
6
    # jvm配置,按需选择
7
    JAVA_OPTS="-Xmx4096m -Xms4096m  -Xmn1536m -Xss256k -XX:+UseConcMarkSweepGC -XX:  +UseCompressedClassPointers -XX:+PrintGCDetails -XX:+PrintGC -XX:+PrintGCTimeStamps -Xloggc:/var/  app/logs/gc.log -verbose:gc -Djava.awt.headless=true" \
8
    # skywalking agent,如果不需要刻意删除
9
    JAVA_TOOL_OPTIONS="-javaagent:/skywalking/agent/skywalking-agent.jar" \
10
    SW_AGENT_NAMESPACE="#PROJECT" \
11
    SW_AGENT_NAME="#PROJECT::#APP_NAME" \
12
    SW_AGENT_COLLECTOR_BACKEND_SERVICES="#SW_OAP"
13
# jar路径不统一,配合pipeline jarPath map使用
14
ADD #jarPath  /#APP_NAME.jar
15
ENTRYPOINT java ${JAVA_OPTS} -jar /#APP_NAME.jar --spring.profiles.active=prod

1.2 deployment模板#

1
# global-kubernetes-deployment
2
apiVersion: apps/v1
3
kind: Deployment
4
metadata:
5
  name: #APP_NAME
6
spec:
7
  replicas: #APP_REPLICAS
8
  selector:
9
    matchLabels:
10
      app: #APP_NAME
11
      service: #APP_NAME
12
  strategy:
13
    type: Recreate
14
  template:
15
    metadata:
16
      labels:
17
        app: #APP_NAME
18
        service: #APP_NAME
19
    spec:
20
      volumes:
21
        - name: skywalking-agent
22
          emptyDir: { }
23
      containers:
24
      - image: #APP_IMAGE_NAME
25
        name: #APP_NAME
26
        # 探针相关,按需修改
27
        startupProbe:
28
          tcpSocket:
29
            port: 8080
30
          failureThreshold: 30
31
          periodSeconds: 10
32
        readinessProbe:
33
          tcpSocket:
34
            port: 8080
35
          initialDelaySeconds: 30
36
          periodSeconds: 10
37
        livenessProbe:
38
          tcpSocket:
39
            port: 8080
40
          initialDelaySeconds: 15
41
          periodSeconds: 20
42
        ports:
43
        - containerPort: 8080
44
          name: server
45
    # 下面这部分是集成skywalking-agent,按需开启
46
        volumeMounts:
47
          - name: skywalking-agent
48
            mountPath: /skywalking
49
      initContainers:
50
      - name: agent-container
51
        image: ccr.ccs.tencentyun.com/ccops/all:skywalking-java-agent-9.4.0
52
        volumeMounts:
53
          - name: skywalking-agent
54
            mountPath: /agent
55
        command: [ "/bin/sh" ]
56
        args: [ "-c", "cp -R /skywalking/agent /agent/" ]
57
---
58
apiVersion: v1
59
kind: Service
60
metadata:
61
  name: #APP_NAME
62
  labels:
63
    app: #APP_NAME
64
spec:
65
  type: ClusterIP
66
  ports:
67
  - name: server
68
    port: 8080
69
    targetPort: 8080
70
  selector:
71
    app: #APP_NAME

2 不集成通知与k8s#

1
pipeline {
2
  parameters {
3
      choice choices: ['app1', 'app2'], description: '选择发布程序', name: 'APP_NAME'
4
  }
5
  options { buildDiscarder(logRotator(numToKeepStr: '10', artifactNumToKeepStr: '5')) }
6
  environment {
7
    PROJECT = '项目名'
8
    BRANCH_NAME = '环境名（分支名）'
9
    HARBOR_NAMESPACE = 'docker仓库凭据名称'
10
    GIT_ID = 'git凭据名称'
11
    GIT_URL = "https://git.xxx.com/${APP_NAME}.git（git的url）"
12
    REGISTRY = '镜像仓库地址'
13
    KUBECONFIG_ID = 'kubeconfig id'
14
    KUBERNETES_APP_REPLICAS = 'deployment副本数'
15
    KUBERNETES_DEPLOYMENT_ID = 'global-kubernetes-deployment' # deployment模板名称
16
    DOCKER_DOCKERFILE_ID = 'global-dockerfile-file' # dockerfile模板
17
    SW_OAP = 'skywalking OPA地址'
18
  }
19
  agent any
20
  tools {
21
    maven 'maven'
22
    jdk 'jdk17'
23
  }
24
  stages {
25
    stage('拉取代码') {
26
      steps {
27
        git(credentialsId: "${GIT_ID}", url: "$GIT_URL", branch: "${BRANCH_NAME}", changelog: true, poll: false)
28
      }
29
  }
30
    stage('编译打包') {
31
      steps {
32
        sh 'mvn clean package install -Dmaven.test.skip=true -DarchetypeCatalog=local'
33
      }
34
    }
35
    stage('镜像制作') {
36
      steps {
37
        // 设置 Docker 镜像名称
38
        def dockerImageName = "${REGISTRY}/${APP_NAME}:1.${BUILD_NUMBER}"
39
        // 使用 configFileProvider 插件提供 Dockerfile 文件
40
        configFileProvider([configFile(fileId: "${DOCKER_DOCKERFILE_ID}", targetLocation: "dockerfile")]){
41
          // 替换dockerfile文件中的变量
42
          def docker = readFile encoding: "UTF-8", file: "dockerfile"
43
          def dockerfile = docker.replaceAll("#APP_NAME","${APP_NAME}")
44
                                 .replaceAll("#PROJECT","${PROJECT}")
45
                                 .replaceAll("#SW_OAP","${SW_OAP}")
46
                                 .replaceAll("#jarPath","${jarPath}")
47
          // 生成新的 dockerfile 部署文件
48
          writeFile encoding: 'UTF-8', file: './Dockerfile', text: "${dockerfile}"
49
        }
50
        // 提供 Docker 环境，使用 Docker 工具来进行 Docker 镜像构建与推送
51
        docker.withRegistry("http://${REGISTRY}", "${HARBOR_NAMESPACE}") {
52
            def customImage = docker.build("${dockerImageName}")
53
            customImage.push()
54
        }
55
      }
56
    }
57
    stage('更新版本') {
58
      steps {
59
        // 使用 Kubectl Cli 插件的方法，提供 Kubeconfig
60
        withKubeConfig([credentialsId: "${KUBECONFIG_ID}"]) {
61
        // 读取 Kubernetes 部署文件
62
        configFileProvider([configFile(fileId: "${KUBERNETES_DEPLOYMENT_ID}", targetLocation: "deployment.yaml")]){
63
          script {
64
            // 替换deployment文件中的变量
65
            def deploy = readFile encoding: "UTF-8", file: "deployment.yaml"
66
            def deployfile = deploy.replaceAll("#APP_NAME","${APP_NAME}")
67
                           .replaceAll("#APP_REPLICAS","${KUBERNETES_APP_REPLICAS}")
68
                           .replaceAll("#APP_IMAGE_NAME","${dockerImageName}")
69
            // 生成新的 Kubernetes 部署文件
70
            writeFile encoding: 'UTF-8', file: './deploy.yaml', text: "${deployfile}"
71
            // sh "cat deploy.yaml"
72
            // 执行 Kuberctl 命令进行部署操作
73
            sh "kubectl apply -n ${PROJECT} -f deploy.yaml"
74
            }
75
          }
76
        }
77
      }
78
    }
79
  }
80
}

3 集成k8s#

没写的直接复用不集成k8s的配置就可以

1
pipeline {
2
......
3
  agent {
4
    kubernetes {
5
      inheritFrom 'mypod'
6
    }
7
  }
8
  stages {
9
    stage('拉取代码') {
10
      steps { # 不指定container默认使用jnlp
11
        git(credentialsId: "${GIT_ID}", url: "$GIT_URL", branch: "${BRANCH_NAME}", changelog: true, poll: false)
12
      }
13
  }
14
    stage('镜像制作') {
15
      steps {
16
        container('docker') {
17
            // 创建 Dockerfile 文件，但只能在方法块内使用
18
          configFileProvider([configFile(fileId: "${DOCKER_DOCKERFILE_ID}", targetLocation: "dockerfile")]){
19
            script {
20
              // 设置 Docker 镜像名称
21
              def dockerImageName = "${REGISTRY}/${PROJECT}/${APP_NAME}:1.${BUILD_NUMBER}"
22
              // 替换dockerfile文件中的变量
23
              def docker = readFile encoding: "UTF-8", file: "dockerfile"
24
              def dockerfile = docker.replaceAll("#APP_NAME","${APP_NAME}")
25
                                     .replaceAll("#PROJECT","${PROJECT}")
26
                                     .replaceAll("#SW_OAP","${SW_OAP}")
27
              // 生成新的 dockerfile 部署文件
28
              writeFile encoding: 'UTF-8', file: './Dockerfile', text: "${dockerfile}"
29
              // sh "cat ./Dockerfile"
30
              // 提供 Docker 环境，使用 Docker 工具来进行 Docker 镜像构建与推送
31
              docker.withRegistry("http://${REGISTRY}", "${HARBOR_NAMESPACE}") {
32
                  def customImage = docker.build("${dockerImageName}")
33
                  customImage.push()
34
              }
35
            }
36
          }
37
        }
38
      }
39
    }
40
......
41
  }
42
}

4 集成飞书#

需要安装此插件

1
pipeline {
2
......
3
  environment {
4
    ROBOT_ID = '告警机器人id'
5
  }
6
  agent {
7
    kubernetes {
8
      inheritFrom 'mypod'
9
    }
10
  }
11
  stages {
12
    stage('拉取代码') {
13
      steps {
14
        git(credentialsId: "${GIT_ID}", url: "$GIT_URL", branch: "${BRANCH_NAME}", changelog: true, poll: false)
15
      }
16
      post {
17
        failure {
18
          echo "❌ 代码拉取失败"
19
          // 发送失败通知
20
          sendNotification("拉取代码", "❌失败")
21
        }
22
      }
23
  }
24
  }
25
  post {
26
    success {
27
      lark (
28
        robot: "${ROBOT_ID}",
29
        type: "CARD",
30
        title: "📢 ${PROJECT} ${APP_NAME} 构建成功通知  ",
31
        text: [
32
            "📋 **任务名称**：[${JOB_NAME}](${JOB_URL})",
33
            "🔢 **任务编号**：[${BUILD_DISPLAY_NAME}](${BUILD_URL})",
34
            "🌟 **构建状态**: <font color='green'>成功</font>",
35
            "🕐 **构建用时**: ${currentBuild.duration / 1000} 秒",
36
            "📜 **更新内容**: $changeString",
37
            "<at id=all></at>"
38
        ],
39
        buttons: [
40
           [
41
              title: "更改记录",
42
              url: "${BUILD_URL}changes"
43
           ],
44
           [
45
              title: "控制台",
46
              type: "danger",
47
              url: "${BUILD_URL}console"
48
          ]
49
        ]
50
      )
51
    }
52
  }
53
}
54
# 告警失败函数
55
def sendNotification(String stageName, String status) {
56
  lark(
57
    robot: "${ROBOT_ID}",
58
    type: "CARD",
59
    title: "❌ ${PROJECT} ${APP_NAME} ${stageName}失败通知",
60
    text: [
61
      "📌 **阶段**: ${stageName}",
62
      "🔢 **状态**: <font color='red'>${status}</font>",
63
      "<at id=all></at>"
64
    ]
65
  )
66
}
67
......
68
# 此部分为了获取commit信息,如果不需要可以不加,但需要删除更新内容
69
@NonCPS
70
def getChangeString() {
71
    MAX_MSG_LEN = 100
72
    def changeString = ""
73

74
    echo "Gathering SCM changes"
75
    def changeLogSets = currentBuild.changeSets
76
    for (int i = 0; i < changeLogSets.size(); i++) {
77
        def entries = changeLogSets[i].items
78
        for (int j = 0; j < entries.length; j++) {
79
            def entry = entries[j]
80
            truncated_msg = entry.msg.take(MAX_MSG_LEN)
81
            changeString += " - ${truncated_msg} [${entry.author}]\n"
82
        }
83
    }
84
    if (!changeString) {
85
        changeString = " - No new changes"
86
    }
87
    return changeString
88
}

5 完整配置#

1
pipeline {
2
  parameters {
3
      choice choices: ['app1', 'app2'], description: '选择发布程序', name: 'APP_NAME'
4
  }
5
  options { buildDiscarder(logRotator(numToKeepStr: '10', artifactNumToKeepStr: '5')) }
6
  environment {
7
    PROJECT = '项目名'
8
    BRANCH_NAME = '环境名（分支名）'
9
    HARBOR_NAMESPACE = 'docker仓库凭据名称'
10
    GIT_ID = 'git凭据名称'
11
    GIT_URL = "https://git.xxx.com/${APP_NAME}.git（git的url）"
12
    REGISTRY = '镜像仓库地址'
13
    KUBECONFIG_ID = 'kubeconfig id'
14
    KUBERNETES_APP_REPLICAS = 'deployment副本数'
15
    KUBERNETES_DEPLOYMENT_ID = 'global-kubernetes-deployment' # deployment模板名称
16
    DOCKER_DOCKERFILE_ID = 'global-dockerfile-file' # dockerfile模板
17
    SW_OAP = 'skywalking OPA地址'
18
  }
19

20
  agent {
21
    kubernetes {
22
      inheritFrom 'mypod'
23
    }
24
  }
25
  stages {
26
    stage('拉取代码') {
27
      steps {
28
        git(credentialsId: "${GIT_ID}", url: "$GIT_URL", branch: "${BRANCH_NAME}", changelog: true, poll: false)
29
      }
30
      post {
31
        failure {
32
          echo "❌ 代码拉取失败"
33
          sendNotification("拉取代码", "❌失败")
34
        }
35
      }
36
    }
37
    stage('编译打包') {
38
      steps {
39
        sh 'mvn clean package install -Dmaven.test.skip=true -DarchetypeCatalog=local'
40
      }
41
      post {
42
        failure {
43
          echo "❌ 打包失败"
44
          sendNotification("maven打包", "❌失败")
45
        }
46
      }
47
    }
48
    stage('镜像制作') {
49
      steps {
50
        container('docker') {
51
            // 创建 Dockerfile 文件，但只能在方法块内使用
52
          configFileProvider([configFile(fileId: "${DOCKER_DOCKERFILE_ID}", targetLocation: "dockerfile")]){
53
            script {
54
              // 设置 Docker 镜像名称
55
              def dockerImageName = "${REGISTRY}/${PROJECT}/${APP_NAME}:1.${BUILD_NUMBER}"
56
              // 替换dockerfile文件中的变量
57
              def dockerfile = readFile encoding: "UTF-8", file: "dockerfile"
58
              def dockerfile = dockerfile.replaceAll("#APP_NAME","${APP_NAME}")
59
                                     .replaceAll("#PROJECT","${PROJECT}")
60
                                     .replaceAll("#SW_OAP","${SW_OAP}")
61
              // 生成新的 dockerfile 部署文件
62
              writeFile encoding: 'UTF-8', file: './Dockerfile', text: "${dockerfile}"
63
              // sh "cat ./Dockerfile"
64
              // 提供 Docker 环境，使用 Docker 工具来进行 Docker 镜像构建与推送
65
              docker.withRegistry("http://${REGISTRY}", "${HARBOR_NAMESPACE}") {
66
                  def customImage = docker.build("${dockerImageName}")
67
                  customImage.push()
68
              }
69
            }
70
          }
71
        }
72
      }
73
      post {
74
        failure {
75
          echo "❌ 镜像制作"
76
          sendNotification("镜像制作", "❌失败")
77
        }
78
      }
79
    }
80
    stage('更新版本') {
81
      steps {
82
        // 使用 Kubectl Cli 插件的方法，提供 Kubeconfig
83
        withKubeConfig([credentialsId: "${KUBECONFIG_ID}"]) {
84
        // 读取 Kubernetes 部署文件
85
        configFileProvider([configFile(fileId: "${KUBERNETES_DEPLOYMENT_ID}", targetLocation: "deployment.yaml")]){
86
          script {
87
            // 替换deployment文件中的变量
88
            def deploy = readFile encoding: "UTF-8", file: "deployment.yaml"
89
            def deployfile = deploy.replaceAll("#APP_NAME","${APP_NAME}")
90
                           .replaceAll("#APP_REPLICAS","${KUBERNETES_APP_REPLICAS}")
91
                           .replaceAll("#APP_IMAGE_NAME","${dockerImageName}")
92
            // 生成新的 Kubernetes 部署文件
93
            writeFile encoding: 'UTF-8', file: './deploy.yaml', text: "${deployfile}"
94
            // sh "cat deploy.yaml"
95
            // 执行 Kuberctl 命令进行部署操作
96
            sh "kubectl apply -n ${PROJECT} -f deploy.yaml"
97
            }
98
          }
99
        }
100
      }
101
      post {
102
        failure {
103
          echo "❌ 更新版本失败"
104
          sendNotification("更新版本", "❌失败")
105
        }
106
      }
107
    }
108
  }
109
  post {
110
    success {
111
      lark (
112
        robot: "${ROBOT_ID}",
113
        type: "CARD",
114
        title: "📢 ${PROJECT} ${APP_NAME} 构建成功通知  ",
115
        text: [
116
            "📋 **任务名称**：[${JOB_NAME}](${JOB_URL})",
117
            "🔢 **任务编号**：[${BUILD_DISPLAY_NAME}](${BUILD_URL})",
118
            "🌟 **构建状态**: <font color='green'>成功</font>",
119
            "🕐 **构建用时**: ${currentBuild.duration / 1000} 秒",
120
            "📜 **更新内容**: $changeString",
121
            "<at id=all></at>"
122
        ],
123
        buttons: [
124
           [
125
              title: "更改记录",
126
              url: "${BUILD_URL}changes"
127
           ],
128
           [
129
              title: "控制台",
130
              type: "danger",
131
              url: "${BUILD_URL}console"
132
          ]
133
        ]
134
      )
135
    }
136
  }
137
}
138

139
def sendNotification(String stageName, String status) {
140
  lark(
141
    robot: "${ROBOT_ID}",
142
    type: "CARD",
143
    title: "❌ ${PROJECT} ${APP_NAME} ${stageName}失败通知",
144
    text: [
145
      "📌 **阶段**: ${stageName}",
146
      "🔢 **状态**: <font color='red'>${status}</font>",
147
      "<at id=all></at>"
148
    ]
149
  )
150
}
151

152
@NonCPS
153
def getChangeString() {
154
    MAX_MSG_LEN = 100
155
    def changeString = ""
156

157
    echo "Gathering SCM changes"
158
    def changeLogSets = currentBuild.changeSets
159
    for (int i = 0; i < changeLogSets.size(); i++) {
160
        def entries = changeLogSets[i].items
161
        for (int j = 0; j < entries.length; j++) {
162
            def entry = entries[j]
163
            truncated_msg = entry.msg.take(MAX_MSG_LEN)
164
            changeString += " - ${truncated_msg} [${entry.author}]\n"
165
        }
166
    }
167
    if (!changeString) {
168
        changeString = " - No new changes"
169
    }
170
    return changeString
171
}

1 准备#

1.1 dockerfile模板#

1.2 deployment模板#

2 不集成通知与k8s#

3 集成k8s#

4 集成飞书#

5 完整配置#

文章分享

评论区

音乐

文章目录