From 025e5067e7172a35dd44e20ea1c24a590e506c10 Mon Sep 17 00:00:00 2001 From: Jacob McCann Date: Fri, 23 Dec 2016 09:47:33 -0600 Subject: [PATCH] Update DOCS for plugin registry --- DOCS.md | 268 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 133 insertions(+), 135 deletions(-) diff --git a/DOCS.md b/DOCS.md index 8f7f435..53e7479 100644 --- a/DOCS.md +++ b/DOCS.md @@ -1,201 +1,162 @@ -Use the Terraform plugin to apply the infrastructure configuration contained within the repository. The following parameters are used to configure this plugin: - -* `plan` - if true, calculates a plan but does __NOT__ apply it. -* `remote` - contains the configuration for the Terraform remote state tracking. - * `backend` - the Terraform remote state backend to use. - * `config` - a map of configuration parameters for the remote state backend. Each value is passed as a `-backend-config==` option. -* `vars` - a map of variables to pass to the Terraform `plan` and `apply` commands. Each value is passed as a `-var - =` option. -* `secrets` - a map of variables to pass to the Terraform `plan` and `apply` commands. Each value is passed as a `-var - =` 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 -* `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: +--- +date: 2016-01-01T00:00:00+00:00 +title: Terraform +author: jmccann +tags: [ infrastructure, build tool ] +repo: jmccann/drone-terraform +logo: terraform.svg +image: jmccann/drone-terraform +--- + +The Terraform plugin applies the infrastructure configuration contained within the repository. The below pipeline configuration demonstrates simple usage: ```yaml pipeline: terraform: image: jmccann/drone-terraform:1 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 -You may want to run terraform against internal resources, like an internal -OpenStack deployment. Usually 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. +```diff +pipeline: + terraform: + image: jmccann/drone-terraform:1 + 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: terraform: image: jmccann/drone-terraform:1 plan: false - remote: - backend: swift - config: - path: drone/terraform - vars: - app_name: my-project - app_version: 1.0.0 - ca_cert: | - -----BEGIN CERTIFICATE----- - asdfsadf - asdfsadf - -----END CERTIFICATE------- ++ secrets: ++ my_secret: TERRAFORM_SECRET ``` -## Suppress Sensitive Output 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 -want command is actually being ran. +what command is actually being ran. -```yaml +```diff pipeline: terraform: image: jmccann/drone-terraform:1 plan: false - 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 ++ sensitive: true ``` -## Assume Role ARN -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. +Example configuration with state tracked via remote: -```yaml +```diff pipeline: terraform: image: jmccann/drone-terraform:1 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 - role_arn_to_assume: arn:aws:iam::account-of-role-to-assume:role/name-of-role ++ remote: ++ backend: S3 ++ config: ++ bucket: my-terraform-config-bucket ++ key: tf-states/my-project ++ region: us-east-1 ``` -## Root dir -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. +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. -```yaml +```diff pipeline: terraform: image: jmccann/drone-terraform:1 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 - root_dir: some/path/here ++ ca_cert: | ++ -----BEGIN CERTIFICATE----- ++ asdfsadf ++ asdfsadf ++ -----END CERTIFICATE------- ``` -## Targets -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. +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](https://github.com/hashicorp/terraform/issues/1275) in the Terraform issues. -Single target: +```diff +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 +``` -```yaml +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. + +```diff pipeline: terraform: image: jmccann/drone-terraform:1 plan: false - targets: aws_security_group.generic_sg - 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 ++ root_dir: some/path/here ``` -Multiple targets: +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. -```yaml +```diff pipeline: terraform: image: jmccann/drone-terraform:1 plan: false - targets: - - aws_security_group.generic_sg - - aws_security_group.app_sg - 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 ++ targets: ++ - aws_security_group.generic_sg ++ - aws_security_group.app_sg ``` -## Parallelism 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. -```yaml +```diff 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. + +```yaml +pipeline: + dev_terraform: + image: jmccann/drone-terraform:1 + 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 - parallelism: 2 -``` - -## Remote configuration - -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. ++ secrets: ++ AWS_ACCESS_KEY_ID: DEV_AWS_ACCESS_KEY_ID ++ AWS_SECRET_ACCESS_KEY: DEV_AWS_SECRET_ACCESS_KEY -```yaml -pipeline: - terraform: - image: jmccann/drone-terraform:0.5 + prod_terraform: + image: jmccann/drone-terraform:1 plan: false remote: backend: S3 @@ -203,10 +164,47 @@ pipeline: 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: - AWS_ACCESS_KEY_ID: FOO - AWS_SECRET_ACCESS_KEY: BAR ++ secrets: ++ AWS_ACCESS_KEY_ID: PROD_AWS_ACCESS_KEY_ID ++ AWS_SECRET_ACCESS_KEY: PROD_AWS_SECRET_ACCESS_KEY ``` + +# Parameter Reference + +plan +: if true, calculates a plan but does __NOT__ apply it. + +remote +: contains the configuration for the Terraform remote state tracking. + +remote.backend +: the Terraform remote state backend to use. + +remote.config +: a map of configuration parameters for the remote state backend. +Each value is passed as a `-backend-config==` option. + +vars +: a map of variables to pass to the Terraform `plan` and `apply` commands. +Each value is passed as a `-var =` option. + +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 =$` +* 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.