The Terraform plugin for Jenkins adds an installer for Terraform and provides a job build wrapper for creating (and destroying) infrastructure.
The installer generates a list of Terraform binaries for installation from bintray.com, see Terraform Crawler.
Terraform binaries can be installed via Manage Jenkins > Global Tool Configuration. Select a label, version and platform to install.
This plugin works as a build wrapper and can be invoked by selecting Terraform under the Build Environment section of your job configuration.
A workspace directory terraform-plugin will be created, this is where temporary files are created and automatically deleted after runs.
This directory also contains the generated tfstate file terraform-plugin.tfstate.
This generated tfstate file is not deleted and is always passed to Terraform using -state=workspace/terraform-plugin/terraform-plugin.tfstate as an extra safety measure so as to not use any other tfstate file you might have in a workspace.
The first step is to decide how you would like to pass your configurations to Terraform, there are 2 options:
This option allows you to copy what would be in a resource file (.tf) into a textarea. This text will then be written to a temporary file (workspace/terraform-plugin/terraform-TEMP.tf) and parsed by Terraform.
This option provides a directory path (relative to your workspace) to enter where your configuration files (.tf) exist. If no path is given, it defaults to the workspace path.
Terraform will run the get command by default, use this option to run Terraform get with the -update flag.
If you are using resource files that reference external variables, set these variables here.
These variables will be written to a temporary file (workspace/terraform-plugin/variables-TEMP.tfvars) and will be passed to Terraform using the --var-file= option.
If you want to destroy the architecture you have created once the build is complete, click the advanced button and check Destroy On Build Completion.
This will call Terraform with the destroy --force option which will look at the generated terraform-plugin.tfstate file (workspace/terraform-plugin/terraform-plugin.tfstate) and destroy everything under Terraform supervision.
This plugin uses gradle wrapper, so the only dependency is a working JDK (7/8).
- To build the .hpi plugin (build/libs/jenkins-terraform.hpi)
./gradlew jpi
- To build and install in a local jenkins server running at http://localhost:8080/
./gradlew server
- To prepare a release (and set next release version)
./gradlew release
- To publish a release to update center (for Maintainer(s))
./gradlew publish