Jenkins Pipeline中如何为Agent设置跨阶段可见且不修改全局env的专属变量

可以实现。通过Jenkins的内部受限API，直接修改当前Agent节点的环境变量配置，就能让变量在该Agent的所有后续阶段生效，且不会修改全局env对象、不影响其他Agent节点。

实现方案 #

核心方法实现 #

以下是setAgentEnvironmentVariable的具体实现，通过修改Agent节点的持久化环境变量属性来达到需求：

def setAgentEnvironmentVariable(String name, String value) {
    import hudson.slaves.EnvironmentVariablesNodeProperty
    import jenkins.model.Jenkins
    
    // 获取当前运行的Agent节点实例
    def currentNode = Jenkins.get().getComputer(env.NODE_NAME)?.getNode()
    if (!currentNode) {
        throw new Exception("当前未在Agent节点上执行")
    }
    
    // 查找节点已有的环境变量配置属性
    EnvironmentVariablesNodeProperty envProp = currentNode.getProperties().get(EnvironmentVariablesNodeProperty.class)
    if (!envProp) {
        // 若不存在则创建新的环境变量属性
        envProp = new EnvironmentVariablesNodeProperty()
        currentNode.getProperties().add(envProp)
    }
    
    // 设置目标环境变量
    envProp.getEnvVars().put(name, value)
    // 保存节点配置，使修改生效
    currentNode.save()
}

配套清理方法（可选） #

由于上述修改是持久化到Agent节点配置的，若仅需当前Pipeline生效，需在Pipeline结束后清理变量：

def removeAgentEnvironmentVariable(String name) {
    import hudson.slaves.EnvironmentVariablesNodeProperty
    import jenkins.model.Jenkins
    
    def currentNode = Jenkins.get().getComputer(env.NODE_NAME)?.getNode()
    if (currentNode) {
        EnvironmentVariablesNodeProperty envProp = currentNode.getProperties().get(EnvironmentVariablesNodeProperty.class)
        if (envProp) {
            envProp.getEnvVars().remove(name)
            currentNode.save()
        }
    }
}

完整Pipeline示例 #

pipeline {
    agent none

    stages {
        stage('Stage1AgentA') {
            agent {
                label "AgentA"
            }
            steps {
               script {
                   setAgentEnvironmentVariable('MY_VAR', 'MyValue')
               }
               sh 'echo "MY_VAR: $MY_VAR"'      // 输出 "MyValue"
               echo "env.MY_VAR: ${env.MY_VAR}" // 输出 "MyValue"
            }
        }
        stage('Stage2AgentA') {
            agent {
                label "AgentA"
            }
            steps {
               sh 'echo "MY_VAR: $MY_VAR"'      // 输出 "MyValue"
               echo "env.MY_VAR: ${env.MY_VAR}" // 输出 "MyValue"
            }
        }
        stage('StageAgentB') {
            agent {
                label "AgentB"
            }
            steps {
               sh 'echo "MY_VAR: $MY_VAR"'      // 输出空字符串
               echo "env.MY_VAR: ${env.MY_VAR}" // 输出 "null"
            }
        }
        stage('CleanupAgentA') {
            agent { label "AgentA" }
            steps {
                script {
                    removeAgentEnvironmentVariable('MY_VAR')
                }
            }
        }
    }
}

def setAgentEnvironmentVariable(String name, String value) {
    import hudson.slaves.EnvironmentVariablesNodeProperty
    import jenkins.model.Jenkins
    
    def currentNode = Jenkins.get().getComputer(env.NODE_NAME)?.getNode()
    if (!currentNode) {
        throw new Exception("当前未在Agent节点上执行")
    }
    
    EnvironmentVariablesNodeProperty envProp = currentNode.getProperties().get(EnvironmentVariablesNodeProperty.class)
    if (!envProp) {
        envProp = new EnvironmentVariablesNodeProperty()
        currentNode.getProperties().add(envProp)
    }
    
    envProp.getEnvVars().put(name, value)
    currentNode.save()
}

def removeAgentEnvironmentVariable(String name) {
    import hudson.slaves.EnvironmentVariablesNodeProperty
    import jenkins.model.Jenkins
    
    def currentNode = Jenkins.get().getComputer(env.NODE_NAME)?.getNode()
    if (currentNode) {
        EnvironmentVariablesNodeProperty envProp = currentNode.getProperties().get(EnvironmentVariablesNodeProperty.class)
        if (envProp) {
            envProp.getEnvVars().remove(name)
            currentNode.save()
        }
    }
}

关键说明 #

1. 生效范围：设置的变量仅对当前Agent节点生效，其他Agent节点无法读取；同一Agent的所有后续阶段（包括当前Pipeline及后续构建）都会继承该变量。
2. 权限要求：运行Pipeline的用户需拥有Agent节点的配置权限，同时需在Jenkins的脚本安全中批准相关API（如hudson.slaves.EnvironmentVariablesNodeProperty、jenkins.model.Jenkins.getComputer等）。
3. 持久化特性：变量会被保存到Agent节点的配置中，若无需长期保留，必须执行清理方法删除变量。

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