Jenkins流水线如何根据用户选择切换Docker代理或自定义代理

核心问题分析 #

你的原Jenkinsfile存在两个关键问题：

• 提前绑定Docker代理：Initialise build environment阶段强制使用docker { label 'docker-agent' }，无论用户选择什么节点参数，都会先尝试寻找带docker-agent标签的节点，找不到就报错。
• 变量作用域问题：agentLabel是在stage内部的script块定义的局部变量，后续stage的agent { label agentLabel }无法正确读取这个变量（因为pipeline的agent块是在初始化阶段解析，而非运行时）。

临时方案的重复代码、无差别拉取镜像问题，可通过动态代理选择+共享函数封装彻底解决。

优化后的Jenkinsfile配置 #

#!/usr/bin/env groovy
@Library('customLib')
import groovy.transform.Field

// 封装共享构建逻辑，消除代码重复
def runBuildStages() {
    stage('Import and Build project') {
        steps {
            script {
                // 替换为你的实际构建逻辑
                echo "Running build on node: ${env.NODE_NAME}"
                // ... 原有构建步骤
            }
        }
    }
    stage('Archive Artifacts') {
        steps {
            script {
                // 替换为你的实际归档逻辑
                archiveArtifacts artifacts: '**/*.zip', fingerprint: true
                // ... 原有归档步骤
            }
        }
    }
    // 其他需要复用的阶段都可添加在此
}

pipeline {
    agent none 
    parameters{
        choice(name: 'NODE', choices: ['PC1', 'PC2', 'dockerNode', 'auto'], description: 'Select which node to run on? Select auto for auto assignment.')
    }

    stages {
        stage('Determine Agent') {
            steps {
                script {
                    // 全局计算代理配置
                    if (params.NODE in ['PC1', 'PC2']) {
                        env.AGENT_LABEL = "${params.NODE} && custom_string"
                        env.USE_DOCKER = 'false'
                    } else if (params.NODE == 'dockerNode' || params.NODE == 'auto') {
                        // 替换为你环境中能运行Docker的节点标签（比如'docker'）
                        env.DOCKER_AGENT_LABEL = 'docker' 
                        env.USE_DOCKER = 'true'
                        env.DOCKER_IMAGE = 'docker-image'
                        env.DOCKER_REGISTRY_URL = 'url'
                        env.DOCKER_REGISTRY_CREDS = 'dockerRegistry'
                    }
                }
            }
        }

        stage('Run Build on PC Node') {
            when {
                expression { env.USE_DOCKER == 'false' }
            }
            agent { label env.AGENT_LABEL }
            post { cleanup { cleanWs() } }
            stages {
                runBuildStages()
            }
        }

        stage('Run Build on Docker Node') {
            when {
                expression { env.USE_DOCKER == 'true' }
            }
            agent {
                docker {
                    image env.DOCKER_IMAGE
                    label env.DOCKER_AGENT_LABEL
                    registryUrl env.DOCKER_REGISTRY_URL
                    registryCredentialsId env.DOCKER_REGISTRY_CREDS
                    args '--entrypoint=\'\''
                    alwaysPull true
                }
            }
            post { cleanup { cleanWs() } }
            stages {
                runBuildStages()
            }
        }
    }
}

关键优化点说明 #

1. 动态代理选择

   • 先在Determine Agent阶段全局计算代理配置，避免提前绑定agent导致的标签找不到问题。
   • 通过when块控制阶段执行，只有选中对应代理类型时才触发，不会无差别拉取Docker镜像。

2. 消除代码重复

   • 将构建、归档等重复逻辑封装成runBuildStages()函数，两个代理阶段直接调用该函数，后续修改只需维护一处代码。

3. 修复标签问题

   • 原配置中docker-agent标签需替换为你实际环境中存在的、能运行Docker的节点标签（比如docker），确保Jenkins能找到可启动Docker容器的节点。

4. 变量作用域优化

   • 使用env全局变量存储代理配置，确保后续阶段能正确读取参数。

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