Jenkins Pipeline将SSH凭证存为变量用于Git拉取失败如何解决

问题根因 #

你犯了两个核心错误导致鉴权失败：

• 语法错误：git步骤中你给credentialsId传的是带单引号的'SSH_KEY_PARAMETER'，这会被识别为固定字符串，而非你定义的环境变量，Jenkins中不存在名为SSH_KEY_PARAMETER的凭证，自然鉴权失败。
• 概念错误：credentials('SSH_KEY')的返回值是Jenkins解密后的SSH私钥内容，而非你传入的凭证ID字符串，你把私钥内容当成凭证ID传入credentialsId参数本身就不符合字段要求。

正确参数化多SSH密钥的实现方式 #

你完全不需要用credentials()方法处理凭证ID，直接把凭证ID存在变量中传入即可，两种常用实现方案：

方案1：使用流水线参数动态选择密钥 #

先给流水线新增一个类型为「凭证」的参数，参数名可设为SELECTED_SSH_KEY，凭证类型筛选为「SSH 用户名与私钥」，运行流水线时可手动选择对应环境的密钥，代码示例：

pipeline {
    agent any
    parameters {
        credentials(name: 'SELECTED_SSH_KEY', type: 'com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey', description: '选择对应环境的SSH密钥')
    }
    stages {
        stage('Checkout') {
            steps{
                script{
                    // 直接传参数变量，不要加引号
                    git credentialsId: params.SELECTED_SSH_KEY, url: 'git@github.com:SomeUser/PrivateRepo.git', branch: 'main'
                }
            }
        }
    }
}

方案2：代码内根据环境自动切换密钥 #

如果需要根据环境变量自动匹配密钥，直接在代码中做判断赋值即可：

pipeline {
    agent any
    environment {
        ENV_NAME = 'test' // 可替换为其他参数传入的环境标识
    }
    stages {
        stage('Checkout') {
            steps{
                script{
                    // 根据环境匹配对应凭证ID
                    def sshCredId = env.ENV_NAME == 'prod' ? 'PROD_GIT_SSH_KEY' : 'TEST_GIT_SSH_KEY'
                    git credentialsId: sshCredId, url: 'git@github.com:SomeUser/PrivateRepo.git', branch: 'main'
                }
            }
        }
    }
}

补充说明 #

credentials('凭证ID')方法的使用场景是你需要直接获取凭证的明文内容时（比如手动把私钥写入文件、调用第三方接口需要传密钥等），不需要拿到密钥内容的场景不要随便调用该方法。

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