Jenkins传递Azure Key Vault密钥给Helm时出现无值异常如何解决？

错误根因 #

你遇到的报错由以下3个问题共同导致：

• 环境变量命名不规范：Jenkins Pipeline的environment块中变量名仅支持字母、数字、下划线，禁止使用横杠-，你定义的DB-USERNAME、DB-PASSWORD属于非法命名，实际取值会出现异常。
• Helm --set参数格式错误：--set必须遵循--set 目标配置键=值的结构，你只传递了密钥值没有指定要覆盖的Helm配置键，Helm会把传入的密钥内容识别为没有对应值的键，直接抛出解析错误。
• Shell变量未正确解析：你用单引号包裹sh命令内容，Linux shell中单引号不会对内部变量做插值解析，$DB-USERNAME会被当成普通字符串传递，不会替换为实际的密钥值。

修复后的Pipeline代码 #

假设你的Helm Chart中数据库用户名对应的配置键为db.username，密码对应的配置键为db.password，修复后的代码如下：

pipeline {
  agent any
  environment {
    // 修正环境变量命名，替换横杠为下划线
    DB_USERNAME = credentials('db-username')
    DB_PASSWORD = credentials('db-password')
  }
  stages {
    stage('Foo') {
      steps {
        echo DB_USERNAME
        echo DB_USERNAME.substring(0, DB_USERNAME.size() -1) 
        // 修正sh命令引号、helm --set参数格式
        sh """
        helm upgrade --install $SERVICE $CHART_NAME \
          --set db.username=${DB_USERNAME} \
          --set db.password=${DB_PASSWORD}
        """
      }
    }
  }
}

可选优化（更安全的密钥传递方式） #

直接通过--set传递密钥会导致密钥明文出现在进程列表、Jenkins日志中，建议用临时values文件的方式传递：

steps {
  // 生成临时values文件写入密钥
  writeFile file: 'values-secret.yaml', text: """
  db:
    username: ${DB_USERNAME}
    password: ${DB_PASSWORD}
  """
  sh """
  helm upgrade --install $SERVICE $CHART_NAME -f values-secret.yaml
  rm -f values-secret.yaml
  """
}

如果密钥中包含=、&、空格等特殊字符，可以在--set时使用单引号包裹值，或者改用--set-string参数强制识别为字符串类型。

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