如何灰度发布 java

转载

浪人小风光 2024-12-17 15:21:44

文章标签 如何灰度发布 java jenkins ci docker Java工程师 文章分类 Java 后端开发

本文介绍通过 Jenkins 构建流水线的方式实现全链路灰度功能。

在发布过程中，为了整体稳定性，我们总是希望能够用小部分特定流量来验证下新发布应用是否正常。即使新版本有问题，也能及时发现，控制影响面，保障了整体的稳定性。

1.整体架构

我们以如下 Demo 为例：

如何灰度发布 java_docker

为了保证稳定，我们约定如下上线流程：

如何灰度发布 java_ci_02

其中，在灰度验证中，有几种不同的策略：

直接使用线上小部分流量来测试（按照百分比放量）
从线上按照特定规则选择流量（比如特定的 header、特定的 cookie 等）
在客户端或浏览器上标识出流量是否灰度（比如通过 header 传递）

2.部署应用&创建泳道

按照参考文档部署应用后，我们首先要区分线上流量和灰度流量。创建泳道组，将整个链路涉及到的应用全选：

如何灰度发布 java_Java工程师_03

然后创建泳道组，将符合规则的应用划入 gray 泳道：

如何灰度发布 java_ci_04

注：没有匹配的流量，会走到基线环境，也就是没有打标的应用节点上。

配置完成后，访问网关，如果不符合灰度规则，走基线环境：

如何灰度发布 java_jenkins_05

如何符合灰度规则，走灰度环境：

如何灰度发布 java_docker_06

3.配置 Jenkins 流水线

本文实践需要将源码打包后执行镜像推送，请确保 Jenkins 有权限推送到镜像仓库中。具体操作，请参见使用 kaniko 构建和推送容器镜像。

在 Jenkins 命名空间下使用生成的 config.json 文件创建名为 jenkins-docker-cfg 的 Secret。

kubectl create secret generic jenkins-docker-cfg -n jenkins --from-file=/root/.docker/config.json

（1）在 Jenkins 中创建全链路灰度发布流水线

基于 Jenkins 实现自动化发布的流水线，通过该流水线可以使应用发布具备可灰度、可观测、可回滚的安全生产三板斧能力。

在 Jenkins 控制台左侧导航栏单击新建任务。
输入任务名称，选择流水线，然后单击确定。
在顶部菜单栏单击流水线页签，在流水线区域配置相关参数选择，输入脚本路径，然后单击保存。

如何灰度发布 java_Java工程师_07

定义：选择 Pipeline script from SCM。

SCM：选择 Git。

Repository URL：输入 Git 仓库的 URL。

脚本路径：输入 Jenkinsfile。

您可以参考以下的文件填写好指定的参数，当然您也可以根据需求编写 Jenkinsfile ，并上传至 Git 的指定路径下（流水线中指定的脚本路径）。

#!groovy
pipeline {
    // 定义本次构建使用哪个标签的构建环境，本示例中为 “slave-pipeline”
    agent{
        node{
          label 'slave-pipeline'
        }
    }
    //常量参数，初始确定后一般不需更改
    environment{
        IMAGE = sh(returnStdout: true,script: 'echo registry.$image_region.aliyuncs.com/$image_namespace/$image_reponame:$image_tag').trim()
        BRANCH =  sh(returnStdout: true,script: 'echo $branch').trim()
    }
    options {
        //保持构建的最大个数
        buildDiscarder(logRotator(numToKeepStr: '10'))
    }
    parameters {
        string(name: 'image_region', defaultValue: 'cn-shanghai')
        string(name: 'image_namespace', defaultValue: 'yizhan')
        string(name: 'image_reponame', defaultValue: 'spring-cloud-a')
        string(name: 'image_tag', defaultValue: 'gray')
        string(name: 'branch', defaultValue: 'master')
        string(name: 'number_of_pods', defaultValue: '2')
    }
    //pipeline的各个阶段场景
    stages {
        stage('代码打包') {
            steps{
                container("maven") {
                    echo "镜像构建......"
                    sh "cd A && mvn clean package"
                }
            }
        }
        stage('镜像构建及发布'){
          steps{
              container("kaniko") {
                  sh "kaniko -f `pwd`/A/Dockerfile -c `pwd`/A --destination=${IMAGE} --skip-tls-verify"
              }
          }
        }
        stage('灰度部署') {
            steps{
                container('kubectl') {
                    echo "灰度部署......"
                    sh "cd A && sed -i -E \"s/${env.image_reponame}:.+/${env.image_reponame}:${env.image_tag}/\" A-gray-deployment.yaml"
                    sh "cd A && sed -i -E \"s/replicas:.+/replicas: ${env.number_of_pods}/\" A-gray-deployment.yaml"
                    sh "kubectl apply -f A/A-gray-deployment.yaml -n default"
                }
            }
        }
        stage('结束灰度') {
            input {
                message "请确认是否全量发布"
                ok "确认"
                parameters {
                    string(name: 'continue', defaultValue: 'true', description: 'true为全量发布，其他为回滚')
                }
            }
            steps{
                script {
                    env.continue = sh (script: 'echo ${continue}', returnStdout: true).trim()
                    if (env.continue.equals('true')) {
                        container('kubectl') {
                            echo "全量发布......"
                            sh "cd A && sed -i -E \"s/${env.image_reponame}:.+/${env.image_reponame}:${env.image_tag}/\" A-deployment.yaml"
                            sh "cd A && sed -i -E \"s/replicas:.+/replicas: ${env.number_of_pods}/\" A-deployment.yaml"
                            sh "kubectl apply -f A/A-deployment.yaml -n default"
                        }
                    } else {
                        echo '回滚'
                    }
                    container('kubectl') {
                        sh "kubectl delete -f A/A-gray-deployment.yaml -n default"
                    }
                }
            }
        }
    }
}

（2）构建 Jenkins 流水线