drone-terraform/DOCS.md

date	title	author	tags	repo	logo	image
2016-01-01T00:00:00+00:00	Terraform	jmccann	[infrastructure build tool]	jmccann/drone-terraform	terraform.svg	jmccann/drone-terraform

The Terraform plugin applies the infrastructure configuration contained within the repository. The below pipeline configuration demonstrates simple usage:

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false

Example configuration passing vars to terraform commands:

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false
+   vars:
+     app_name: my-project
+     app_version: 1.0.0

Example configuration passing secrets to terraform via vars. The following example will call terraform apply -var my_secret=${TERRAFORM_SECRET}:

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false
+   terraform_secrets:
+     my_secret: TERRAFORM_SECRET
+   secrets: [ TERRAFORM_SECRET ]

You may be passing sensitive vars to your terraform commands. If you do not want the terraform commands to display in your drone logs then set sensitive to true. The output from the commands themselves will still display, it just won't show what command is actually being ran.

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false
+   sensitive: true

Example configuration with state tracked via remote. You will need a backend configuration specified in a .tf file. You can then pass additional options via the .drone.yml.

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false
+   init_options:
+     backend-config:
+       - "bucket=my-terraform-config-bucket"
+       - "key=tf-states/my-project"
+       - "region=us-east-1"

You may want to run terraform against internal resources, like an internal OpenStack deployment. Sometimes these resources are signed by an internal CA Certificate. You can inject your CA Certificate into the plugin by using ca_certs key as described above. Below is an example.

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false
+   ca_cert: |
+     -----BEGIN CERTIFICATE-----
+     asdfsadf
+     asdfsadf
+     -----END CERTIFICATE-------

You may want to assume another role before running the terraform commands. This is useful for cross account access, where a central account has privileges to assume roles in other accounts. Using the current credentials, this role will be assumed and exported to environment variables. See the discussion in the Terraform issues.

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false
+   role_arn_to_assume: arn:aws:iam::account-of-role-to-assume:role/name-of-role

You may want to change directories before applying the terraform commands. This parameter is useful if you have multiple environments in different folders and you want to use different drone configurations to apply different environments.

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false
+   root_dir: some/path/here

You may want to only target a specific list of resources within your terraform code. To achieve this you can specify the targets parameter. If left undefined all resources will be planned/applied against as the default behavior.

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false
+   targets:
+     - aws_security_group.generic_sg
+     - aws_security_group.app_sg

You may want to limit the number of concurrent operations as Terraform walks its graph. If you want to change Terraform's default parallelism (currently equal to 10) then set the parallelism parameter.

pipeline:
  terraform:
    image: jmccann/drone-terraform:1
    plan: false
+   parallelism: 2

If you need to set different ENV secrets for multiple terraform steps you can utilize secrets. The following example shows using different remotes secrets each step.

pipeline:
  dev_terraform:
    image: jmccann/drone-terraform:1
    plan: false
    init_options:
      backend_config:
        - "bucket=my-terraform-config-bucket"
        - "key=tf-states/my-project"
        - "region=us-east-1"
+   terraform_secrets:
+     AWS_ACCESS_KEY_ID: DEV_AWS_ACCESS_KEY_ID
+     AWS_SECRET_ACCESS_KEY: DEV_AWS_SECRET_ACCESS_KEY
+   secrets: [DEV_AWS_ACCESS_KEY_ID, DEV_AWS_SECRET_ACCESS_KEY]

  prod_terraform:
    image: jmccann/drone-terraform:1
    plan: false
    init_options:
      backend_config:
        - "bucket=my-terraform-config-bucket"
        - "key=tf-states/my-project"
        - "region=us-east-1"
+   terraform_secrets:
+     AWS_ACCESS_KEY_ID: PROD_AWS_ACCESS_KEY_ID
+     AWS_SECRET_ACCESS_KEY: PROD_AWS_SECRET_ACCESS_KEY
+   secrets: [PROD_AWS_ACCESS_KEY_ID, PROD_AWS_SECRET_ACCESS_KEY]

Parameter Reference

plan

if true, calculates a plan but does NOT apply it.

init_options

contains the configuration for the Terraform backend.

init_options.backend-config

This specifies additional configuration to merge for the backend. This can be specified multiple times. Flags specified later in the line override those specified earlier if they conflict.

init_options.lock

Lock the state file when locking is supported.

init_options.lock-timeout

Duration to retry a state lock.

vars

a map of variables to pass to the Terraform plan and apply commands. Each value is passed as a -var <key>=<value> option.

var_files

a list of variable files to pass to the Terraform plan and apply commands. Each value is passed as a -var-file <value> option.

terraform_secrets

a map of variables to pass to the Terraform plan and apply commands as well as setting envvars. The key is the var and ENV to set. The value is the ENV to read the value from.

• Each entry generate a terraform var as follows: -var <key>=$<value>
• Additionally each entry generate sets and envvar as follows: key=$value

ca_cert

ca cert to add to your environment to allow terraform to use internal/private resources

sensitive

(default: false) - Whether or not to suppress terraform commands to stdout.

role_arn_to_assume

A role to assume before running the terraform commands.

root_dir

The root directory where the terraform files live. When unset, the top level directory will be assumed.

parallelism

The number of concurrent operations as Terraform walks its graph.