Use the Terraform plugin to apply the infrastructure configuration contained within the repository. The following parameters are used to configure this plugin:
---
date: 2016-01-01T00:00:00+00:00
* `plan` - if true, calculates a plan but does __NOT__ apply it.
title: Terraform
* `remote` - contains the configuration for the Terraform remote state tracking.
author: jmccann
* `backend` - the Terraform remote state backend to use.
tags: [ infrastructure, build tool ]
* `config` - a map of configuration parameters for the remote state backend. Each value is passed as a `-backend-config=<key>=<value>` option.
repo: jmccann/drone-terraform
* `vars` - a map of variables to pass to the Terraform `plan` and `apply` commands. Each value is passed as a `-var
logo: terraform.svg
<key>=<value>` option.
image: jmccann/drone-terraform
* `secrets` - a map of variables to pass to the Terraform `plan` and `apply` commands. Each value is passed as a `-var
---
<key>=<ENVVAR>` option. The `ENVVAR` is read as the key/pair value.
* `ca_cert` - ca cert to add to your environment to allow terraform to use internal/private resources
The Terraform plugin applies the infrastructure configuration contained within the repository. The below pipeline configuration demonstrates simple usage:
* `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.
The following is a sample Terraform configuration in your .drone.yml file:
```yaml
```yaml
pipeline:
pipeline:
terraform:
terraform:
image: jmccann/drone-terraform:1
image: jmccann/drone-terraform:1
plan: false
plan: false
remote:
backend: S3
config:
bucket: my-terraform-config-bucket
key: tf-states/my-project
region: us-east-1
vars:
app_name: my-project
app_version: 1.0.0
secrets:
my_secret: TERRAFORM_SECRET
```
```
# Advanced Configuration
Example configuration passing `vars` to terraform commands:
## CA Certs
```diff
You may want to run terraform against internal resources, like an internal
pipeline:
OpenStack deployment. Usually these resources are signed by an internal
terraform:
CA Certificate. You can inject your CA Certificate into the plugin by using
image: jmccann/drone-terraform:1
`ca_certs` key as described above. Below is an example.
plan: false
+ vars:
+ app_name: my-project
+ app_version: 1.0.0
```
```yaml
Example configuration passing secrets to terraform via `vars`. The following
example will call `terraform apply -var my_secret=${TERRAFORM_SECRET}`:
```diff
pipeline:
pipeline:
terraform:
terraform:
image: jmccann/drone-terraform:1
image: jmccann/drone-terraform:1
plan: false
plan: false
remote:
+ secrets:
backend: swift
+ my_secret: TERRAFORM_SECRET
config:
path: drone/terraform
vars:
app_name: my-project
app_version: 1.0.0
ca_cert: |
-----BEGIN CERTIFICATE-----
asdfsadf
asdfsadf
-----END CERTIFICATE-------
```
```
## Suppress Sensitive Output
You may be passing sensitive vars to your terraform commands. If you do not want
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 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
The output from the commands themselves will still display, it just won't show
want command is actually being ran.
what command is actually being ran.
```yaml
```diff
pipeline:
pipeline:
terraform:
terraform:
image: jmccann/drone-terraform:1
image: jmccann/drone-terraform:1
plan: false
plan: false
sensitive: true
+ sensitive: true
remote:
backend: S3
config:
bucket: my-terraform-config-bucket
key: tf-states/my-project
region: us-east-1
vars:
app_name: my-project
app_version: 1.0.0
```
```
## Assume Role ARN
Example configuration with state tracked via remote:
You may want to assume another role before running the terraform commands. This is useful for cross account access, where a central account ahs privileges to assume roles in other accounts. Using the current credentials, this role will be assumed and exported to environment variables. See [the discussion](https://github.com/hashicorp/terraform/issues/1275) in the Terraform issues.
You may want to run terraform against internal resources, like an internal
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.
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.
```yaml
```diff
pipeline:
pipeline:
terraform:
terraform:
image: jmccann/drone-terraform:1
image: jmccann/drone-terraform:1
plan: false
plan: false
remote:
+ ca_cert: |
backend: S3
+ -----BEGIN CERTIFICATE-----
config:
+ asdfsadf
bucket: my-terraform-config-bucket
+ asdfsadf
key: tf-states/my-project
+ -----END CERTIFICATE-------
region: us-east-1
vars:
app_name: my-project
app_version: 1.0.0
root_dir: some/path/here
```
```
## Targets
You may want to assume another role before running the terraform commands.
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.
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](https://github.com/hashicorp/terraform/issues/1275) in the Terraform issues.
If you are configuring an s3 remote state and require S3 environment secrets you add the secrets "FOO" and "BAR" to your drone environment and reference the secrets as follows. These will not be outputted to stdout.
Jacob McCann
8 years ago