Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.95 KB

TerraformEnvironmentStageShellHookPlugin.md

File metadata and controls

42 lines (31 loc) · 1.95 KB
Raw

TerraformEnvironmentStageShellHookPlugin

This plugin allows inserting shell script hooks at various points in the TerraformEnvironmentStage execution. Please see the TerraformEnvironmentStage source code for a list of the supported hook points. At this time, they are:

  • TerraformEnvironmentStage.ALL
  • TerraformEnvironmentStage.INIT_COMMAND
  • TerraformEnvironmentStage.PLAN
  • TerraformEnvironmentStage.PLAN_COMMAND
  • TerraformEnvironmentStage.APPLY
  • TerraformEnvironmentStage.APPLY_COMMAND

Each hook point "wraps" various parts of the Stage, and supports a total of four hooks:

  • Before the wrapped code runs (WhenToRun.BEFORE)
  • The default, after the wrapped code runs successfully (WhenToRun.ON_SUCCESS)
  • After the wrapped code runs and fails (WhenToRun.ON_FAILURE)
  • After the wrapped code runs, regardless of success or failure (WhenToRun.AFTER)
// Jenkinsfile
@Library(['terraform-pipeline']) _

Jenkinsfile.init(this)

TerraformEnvironmentStageShellHookPlugin.withHook(TerraformEnvironmentStage.APPLY_COMMAND, './bin/after_successful_apply.sh')
                                        .withHook(TerraformEnvironmentStage.INIT_COMMAND, './bin/download_deps.sh', WhenToRun.BEFORE)
                                        .withHook(TerraformEnvironmentStage.ALL, './bin/cleanup.sh', WhenToRun.AFTER)
                                        .init()

def validate = new TerraformValidateStage()

def deployQA = new TerraformEnvironmentStage('qa')
def deployUat = new TerraformEnvironmentStage('uat')
def deployProd = new TerraformEnvironmentStage('prod')

validate.then(deployQA)
        .then(deployUat)
        .then(deployProd)
        .build()

Reminder: Please remember that plugin definition order matters. You most likely want this plugin to be defined in your Jenkinsfile before any plugins that affect the environment.