如何在 Jenkisfile 中进行用户输入以进行 terraform 应用？

Question

我正在使用 Jenkinsfile 运行 Jenkins 管道作业。主要目的是运行 terraform <plan|apply>，根据 choice 参数选择plan 或apply，如下所示：

stages {
  stage('tf_run') {
    steps { 
      sh '''#!/usr/bin/env bash
        terragrunt ${Action} --terragrunt-source "/var/temp/tf_modules//${tfm}"
      '''
    }
  }
}

Action 是选择参数变量，这对 计划 来说都是好的，但对于 apply 来说却失败了em> 因为它要求确认是否继续，并且工作立即下降。我可以在这里做什么，以便用户输入yes/no（或从列表中选择），然后可以将其传递给terraform apply？

我被困在了中间，如果有人能把我引向正确的方向，我将不胜感激。感谢您提供的任何帮助。

-S

Answer 1

为了适应用例，Jenkins Pipeline 将分为三个步骤：

• 生成计划文件
• 查询用户输入以进行计划审批
• 如果获得批准，应用计划文件

假设：您声称plan 的管道是成功的，这对我来说意味着Action 和tfm 是环境变量（即env.Action），否则sh 步骤方法的String 参数是无效的。鉴于该假设：

（现在应要求修改答案以将 tfm 演示为管道参数，并且不再位于 env 对象中）

parameters {
  string(name: 'tfm', description: 'Terraform module to act upon.')
}

stages {
  stage('TF Plan') {
    steps {
      // execute plan and capture plan output 
      sh(
         label:  'Terraform Plan',
         script: "terragrunt plan -out=plan.tfplan -no-color --terragrunt-source '/var/temp/tf_modules//${params.tfm}'"
      )
    }
  }
  stage('TF Apply') {
    // only execute stage if apply is desired
    when { expression { return env.Action == 'apply' } }
    steps {
      // query for user approval of plan
      input(message: 'Click "proceed" to approve the above Terraform Plan')
      // apply the plan if approved
      sh(
         label:  'Terraform Apply',
         script: 'terraform apply -auto-approve -input=false -no-color plan.tfplan'
      )
    }
  }
}

您可能还想将 env.TF_IN_AUTOMATION = true 的等效项添加到 environment 指令中。这在管道中执行 Terraform 时会很有帮助。

如果您还将管道agent 修改为例如Terraform CLI 镜像作为容器运行，那么计划输出文件也需要在阶段之间保留。

Answer 2

您可以在 Jenkins 作业中使用 terraform apply -auto-approve。

See Docs

提示：当用户选择参数计划时，您可以在 Jenkins stage() 中添加条件，而不是自动添加 -auto-approve 选项，否则该命令将附加 -auto-approve 选项。

stage(plan&apply){
  if ${USER_INPUT} == "plan"{
    terraform plan
  }
  else{
   terraform apply -auto-approve
  }
}

注意：上面的 Jenkins 代码可能与正确的 Ans 不匹配，但可以作为示例。