在Terraform中处理apply命令错误的退出码

42次阅读

问题描述

在使用Terraform作为Jenkins Pipeline的一部分时，遇到了一个问题：当运行terraform apply命令遇到错误时，它不会返回非零的退出码。在Jenkins上运行时，这不会停止流水线或将构建标记为失败。用户希望在Terraform遇到错误时，能够停止作业并阻止进一步执行。

此外，用户还考虑了通过在Jenkins中运行terraform apply | tee /dev/tty | ( ! grep "Error applying plan" )来绕过该问题，但他希望找到更为优雅的解决方案。

解决方案

根据Terraform的文档，terraform apply命令默认情况下并没有提供直接返回有用退出码的选项。但是，用户还是可以通过一些方法来实现他们的目标。

方案1：避免误导的退出码

用户在评论中提到，问题实际上并不存在。他们发现在他们的shell脚本的末尾使用了echo命令，这导致了非零状态码的返回。一旦移除了这个echo命令，terraform apply的退出码就会按预期工作了。因此，确保你的shell脚本中没有意外的非零退出码。

方案2：使用Terraform的Plan操作

尽管在terraform apply命令中直接获取有用的退出码可能有些困难，但你可以结合使用terraform plan来达到类似的效果。terraform plan命令具有-detailed-exitcode标志，该标志可以返回不同的退出码以指示不同的状态。例如，当计划有变更时，退出码为2，当计划有变更并且需要应用时，退出码为1，没有变更时退出码为0。因此，你可以将这个命令嵌入到你的流水线中，以实现在Terraform计划有变更时阻止进一步执行的目标。

以下是一个可能在Jenkins Pipeline中使用的示例：

stage('Terraform Plan') {
    steps {
        script {
            def planExitCode = sh(script: 'terraform plan -detailed-exitcode', returnStatus: true)
            if (planExitCode == 1 || planExitCode == 2) {
                error("Terraform plan indicates changes or changes needing approval.")
            }
        }
    }
}

stage('Terraform Apply') {
    steps {
        script {
            sh 'terraform apply'
        }
    }
}

这个示例首先运行terraform plan命令并检查其退出码。如果计划中有变更，或者有变更需要应用，它会引发一个错误，阻止进一步的执行。然后，在Terraform Apply阶段运行实际的terraform apply命令。

通过结合使用terraform plan和Jenkins的流水线功能，你可以更好地控制流程并在必要时阻止作业的进一步执行。