diff --git a/.gitignore b/.gitignore index 6a2a4e5..bf42b9f 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,6 @@ .terraform/ .idea *.iml + +.build-harness +build-harness \ No newline at end of file diff --git a/Makefile b/Makefile index d002c7d..655f630 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,10 @@ SHELL := /bin/bash +# List of targets the `readme` target should call before generating the readme +export README_DEPS ?= docs/targets.md docs/terraform.md + -include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness) +## Lint terraform code lint: - $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate + $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate \ No newline at end of file diff --git a/README.md b/README.md index e268b5a..8e6dd24 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# terraform-aws-kms-key [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-kms-key.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-kms-key) + + +[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com) + +# terraform-aws-kms-key [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-kms-key.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-kms-key) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-kms-key.svg)](https://github.com/cloudposse/terraform-aws-kms-key/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com) + Terraform module to provision a [KMS](https://aws.amazon.com/kms/) key with alias. @@ -8,6 +13,22 @@ Can be used with [chamber](https://github.com/segmentio/chamber) for managing se * https://aws.amazon.com/blogs/mt/the-right-way-to-store-secrets-using-parameter-store +--- + +This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps. + + +It's 100% Open Source and licensed under the [APACHE2](LICENSE). + + + + + + + + + + ## Usage ```hcl @@ -24,44 +45,84 @@ module "kms_key" { ``` -## Variables -| Name | Default | Description | Required | -|:---------------------------|:----------------------------------|:---------------------------------------------------------|:---------:| -| `namespace` | `` | Namespace (e.g. `cp` or `cloudposse`) | Yes | -| `stage` | `` | Stage (e.g. `prod`, `dev`, `staging`) | Yes | -| `name` | `` | Application or solution name (e.g. `app`) | Yes | -| `attributes` | `[]` | Additional attributes (_e.g._ `policy` or `role`) | No | -| `tags` | `{}` | Additional tags (_e.g._ `map("Cluster","xyz")` | No | -| `delimiter` | `-` | Delimiter to be used between `namespace`, `stage`, `name`, and `attributes` | No | -| `alias` | `` | The display name of the alias. The name must start with the word `alias` followed by a forward slash | No | -| `deletion_window_in_days` | `10` | Duration in days after which the key is deleted after destruction of the resource | No | -| `enable_key_rotation` | `true` | Specifies whether key rotation is enabled | No | -| `description` | `Parameter Store KMS master key` | The description of the key as viewed in AWS console | No | -__NOTE:__ To use the KMS key with [chamber](https://github.com/segmentio/chamber), the `alias` must be set to `alias/parameter_store_key`. -__NOTE:__ If `alias` is not specified, `format("alias/%v", module.label.id)` will be used instead. +## Makefile Targets +``` +Available targets: + + help This help screen + help/all Display help for all targets + lint Lint terraform code + +``` +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| alias | The display name of the alias. The name must start with the word `alias` followed by a forward slash | string | `` | no | +| attributes | Additional attributes (e.g. `1`) | list | `` | no | +| deletion_window_in_days | Duration in days after which the key is deleted after destruction of the resource | string | `10` | no | +| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | string | `-` | no | +| description | The description of the key as viewed in AWS console | string | `Parameter Store KMS master key` | no | +| enable_key_rotation | Specifies whether key rotation is enabled | string | `true` | no | +| name | Application or solution name (e.g. `app`) | string | - | yes | +| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes | +| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes | +| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map | `` | no | ## Outputs -| Name | Description | -|:------------------|:------------------| -| `key_arn` | Key ARN | -| `key_id` | Key ID | -| `alias_arn` | Alias ARN | -| `alias_name` | Alias name | +| Name | Description | +|------|-------------| +| alias_arn | Alias ARN | +| alias_name | Alias name | +| key_arn | Key ARN | +| key_id | Key ID | + + + + +## Related Projects + +Check out these related projects. + +- [terraform-aws-iam-chamber-user](https://github.com/cloudposse/terraform-aws-iam-chamber-user) - Terraform module to provision a basic IAM chamber user with access to SSM parameters and KMS key to decrypt secrets, suitable for CI/CD systems (e.g. TravisCI, CircleCI, CodeFresh) or systems which are external to AWS that cannot leverage AWS IAM Instance Profiles +- [terraform-aws-ssm-parameter-store](https://github.com/cloudposse/terraform-aws-ssm-parameter-store) - Terraform module to populate AWS Systems Manager (SSM) Parameter Store with values from Terraform. Works great with Chamber. +- [terraform-aws-ssm-iam-role](https://github.com/cloudposse/terraform-aws-ssm-iam-role) - Terraform module to provision an IAM role with configurable permissions to access SSM Parameter Store + ## Help **Got a question?** -File a GitHub [issue](https://github.com/cloudposse/terraform-aws-kms-key/issues), send us an [email](mailto:hello@cloudposse.com) or reach out to us on [Gitter](https://gitter.im/cloudposse/). +File a GitHub [issue](https://github.com/cloudposse/terraform-aws-kms-key/issues), send us an [email][email] or join our [Slack Community][slack]. + +## Commerical Support + +Work directly with our team of DevOps experts via email, slack, and video conferencing. + +We provide *commercial support* for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a fulltime engineer. + +[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)](mailto:hello@cloudposse.com) + +- **Questions.** We'll use a Shared Slack channel between your team and ours. +- **Troubleshooting.** We'll help you triage why things aren't working. +- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback. +- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects. +- **Build New Terraform Modules.** We'll develop original modules to provision infrastructure. +- **Cloud Architecture.** We'll assist with your cloud strategy and design. +- **Implementation.** We'll provide hands on support to implement our reference architectures. +## Community Forum + +Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build *sweet* infrastructure. + ## Contributing ### Bug Reports & Feature Requests @@ -70,7 +131,7 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-kms-k ### Developing -If you are interested in being a contributor and want to get involved in developing `terraform-aws-kms-key`, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com). +If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:hello@cloudposse.com). In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. @@ -78,14 +139,20 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. 2. **Clone** the project to your own machine 3. **Commit** changes to your own branch 4. **Push** your work back up to your fork - 5. Submit a **Pull request** so that we can review your changes + 5. Submit a **Pull Request** so that we can review your changes + +**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! + + +## Copyright + +Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com) -**NOTE:** Be sure to merge the latest from "upstream" before making a pull request! -## License +## License -[APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) See [LICENSE](LICENSE) for full details. @@ -97,7 +164,7 @@ See [LICENSE](LICENSE) for full details. "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an @@ -107,31 +174,46 @@ See [LICENSE](LICENSE) for full details. under the License. -## About -`terraform-aws-kms-key` is maintained and funded by [Cloud Posse, LLC][website]. -![Cloud Posse](https://cloudposse.com/logo-300x69.png) -Like it? Please let us know at -We love [Open Source Software](https://github.com/cloudposse/)! -See [our other projects][community] -or [hire us][hire] to help build your next cloud platform. +## Trademarks + +All other trademarks referenced herein are the property of their respective owners. + +## About + +This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at + +[![Cloud Posse](https://cloudposse.com/logo-300x69.svg)](https://cloudposse.com) + +We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)! + +We offer paid support on all of our projects. + +Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation. + + [docs]: https://docs.cloudposse.com/ [website]: https://cloudposse.com/ - [community]: https://github.com/cloudposse/ + [github]: https://github.com/cloudposse/ + [jobs]: https://cloudposse.com/jobs/ [hire]: https://cloudposse.com/contact/ + [slack]: https://slack.cloudposse.com/ + [linkedin]: https://www.linkedin.com/company/cloudposse + [twitter]: https://twitter.com/cloudposse/ + [email]: mailto:hello@cloudposse.com ### Contributors -| [![Erik Osterman][erik_img]][erik_web]
[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]
[Andriy Knysh][andriy_web] | -|-------------------------------------------------------|------------------------------------------------------------------| +| [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]
[Andriy Knysh][aknysh_homepage] | +|---| + + [aknysh_homepage]: https://github.com/aknysh + [aknysh_avatar]: https://github.com/aknysh.png?size=150 + - [erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144 - [erik_web]: https://github.com/osterman/ - [andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144 - [andriy_web]: https://github.com/aknysh/ diff --git a/README.yaml b/README.yaml new file mode 100644 index 0000000..bfc0dfd --- /dev/null +++ b/README.yaml @@ -0,0 +1,73 @@ +--- +# +# This is the canonical configuration for the `README.md` +# Run `make readme` to rebuild the `README.md` +# + +# Name of this project +name: terraform-aws-kms-key + +# Logo for this project +#logo: docs/logo.png + +# License of this project +license: "APACHE2" + +# Canonical GitHub repo +github_repo: cloudposse/terraform-aws-kms-key + +# Badges to display +badges: + - name: "Build Status" + image: "https://travis-ci.org/cloudposse/terraform-aws-kms-key.svg?branch=master" + url: "https://travis-ci.org/cloudposse/terraform-aws-kms-key" + - name: "Latest Release" + image: "https://img.shields.io/github/release/cloudposse/terraform-aws-kms-key.svg" + url: "https://github.com/cloudposse/terraform-aws-kms-key/releases/latest" + - name: "Slack Community" + image: "https://slack.cloudposse.com/badge.svg" + url: "https://slack.cloudposse.com" + +related: + - name: "terraform-aws-iam-chamber-user" + description: "Terraform module to provision a basic IAM chamber user with access to SSM parameters and KMS key to decrypt secrets, suitable for CI/CD systems (e.g. TravisCI, CircleCI, CodeFresh) or systems which are external to AWS that cannot leverage AWS IAM Instance Profiles" + url: "https://github.com/cloudposse/terraform-aws-iam-chamber-user" + - name: "terraform-aws-ssm-parameter-store" + description: "Terraform module to populate AWS Systems Manager (SSM) Parameter Store with values from Terraform. Works great with Chamber." + url: "https://github.com/cloudposse/terraform-aws-ssm-parameter-store" + - name: "terraform-aws-ssm-iam-role" + description: "Terraform module to provision an IAM role with configurable permissions to access SSM Parameter Store" + url: "https://github.com/cloudposse/terraform-aws-ssm-iam-role" + +# Short description of this project +description: |- + Terraform module to provision a [KMS](https://aws.amazon.com/kms/) key with alias. + + Can be used with [chamber](https://github.com/segmentio/chamber) for managing secrets by storing them in Amazon EC2 Systems Manager Parameter Store. + + * https://aws.amazon.com/systems-manager/features + * https://aws.amazon.com/blogs/mt/the-right-way-to-store-secrets-using-parameter-store + +# How to use this project +usage: |- + ```hcl + module "kms_key" { + source = "git::https://github.com/cloudposse/terraform-aws-kms-key.git?ref=master" + namespace = "cp" + stage = "prod" + name = "app" + description = "KMS key for chamber" + deletion_window_in_days = 10 + enable_key_rotation = "true" + alias = "alias/parameter_store_key" + } + ``` + +include: + - "docs/targets.md" + - "docs/terraform.md" + +# Contributors to this project +contributors: + - name: "Andriy Knysh" + github: "aknysh" \ No newline at end of file diff --git a/docs/targets.md b/docs/targets.md new file mode 100644 index 0000000..09c39cd --- /dev/null +++ b/docs/targets.md @@ -0,0 +1,9 @@ +## Makefile Targets +``` +Available targets: + + help This help screen + help/all Display help for all targets + lint Lint terraform code + +``` diff --git a/docs/terraform.md b/docs/terraform.md new file mode 100644 index 0000000..eb8a42f --- /dev/null +++ b/docs/terraform.md @@ -0,0 +1,25 @@ + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| alias | The display name of the alias. The name must start with the word `alias` followed by a forward slash | string | `` | no | +| attributes | Additional attributes (e.g. `1`) | list | `` | no | +| deletion_window_in_days | Duration in days after which the key is deleted after destruction of the resource | string | `10` | no | +| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes` | string | `-` | no | +| description | The description of the key as viewed in AWS console | string | `Parameter Store KMS master key` | no | +| enable_key_rotation | Specifies whether key rotation is enabled | string | `true` | no | +| name | Application or solution name (e.g. `app`) | string | - | yes | +| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes | +| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes | +| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`) | map | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| alias_arn | Alias ARN | +| alias_name | Alias name | +| key_arn | Key ARN | +| key_id | Key ID | + diff --git a/output.tf b/output.tf index f4501f9..be4918d 100644 --- a/output.tf +++ b/output.tf @@ -1,15 +1,19 @@ output "key_arn" { - value = "${aws_kms_key.default.arn}" + value = "${aws_kms_key.default.arn}" + description = "Key ARN" } output "key_id" { - value = "${aws_kms_key.default.key_id}" + value = "${aws_kms_key.default.key_id}" + description = "Key ID" } output "alias_arn" { - value = "${aws_kms_alias.default.arn}" + value = "${aws_kms_alias.default.arn}" + description = "Alias ARN" } output "alias_name" { - value = "${aws_kms_alias.default.name}" + value = "${aws_kms_alias.default.name}" + description = "Alias name" }