terraform 0.12.0

clouddrove · Aug 20, 2019 · 00b07d9 · 00b07d9
1 parent d783c5c
commit 00b07d9
Show file tree

Hide file tree

Showing 13 changed files with 613 additions and 62 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,6 @@
-# Compiled files
+# ignored files
 *.tfstate
 *.tfstate.backup
-
-# Module directory
 .terraform
 .idea
 *.iml
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Cloud Drove
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,3 @@
+export GENIE_PATH ?= $(shell 'pwd')/../../../genie
+
+include $(GENIE_PATH)/Makefile
diff --git a/README.md b/README.md
@@ -1,2 +1,224 @@
-# terraform-aws-kms
->
+<!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
+
+<p align="center"> <img src="https://user-images.githubusercontent.com/50652676/62349836-882fef80-b51e-11e9-99e3-7b974309c7e3.png" width="100" height="100"></p>
+
+
+<h1 align="center">
+    Terraform AWS KMS
+</h1>
+
+<p align="center" style="font-size: 1.2rem;">
+    This terraform module creates a KMS Customer Master Key (CMK) and its alias.
+     </p>
+
+<p align="center">
+
+<a href="https://www.terraform.io">
+  <img src="https://img.shields.io/badge/Terraform-v0.12-green" alt="Terraform">
+</a>
+<a href="LICENSE.md">
+  <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
+</a>
+
+
+</p>
+<p align="center">
+
+<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-aws-kms'>
+  <img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
+</a>
+<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AWS+KMS&url=https://github.com/clouddrove/terraform-aws-kms'>
+  <img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
+</a>
+<a href='https://twitter.com/intent/tweet/?text=Terraform+AWS+KMS&url=https://github.com/clouddrove/terraform-aws-kms'>
+  <img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" />
+</a>
+
+</p>
+<hr>
+
+
+We eat, drink, sleep and most importantly love **DevOps**. We are working towards stratergies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
+
+This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.
+
+We have [*fifty plus terraform modules*][terraform_modules]. A few of them are comepleted and are available for open source usage while a few others are in progress.
+
+
+
+
+## Prerequisites
+
+This module has a few dependencies:
+
+- [Terraform 0.12](https://learn.hashicorp.com/terraform/getting-started/install.html)
+- [Go](https://golang.org/doc/install)
+- [github.com/stretchr/testify/assert](https://github.com/stretchr/testify)
+- [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest)
+
+
+
+
+
+
+## Examples
+
+**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-aws-kms/releases).
+
+
+### Simple Example
+Here is an example of how you can use this module in your inventory structure:
+```hcl
+  module "kms_key" {
+    source                  = "git::https://github.com/clouddrove/terraform-aws-kms.git"
+    name                    = "kms"
+    application             = "clouddrove"
+    environment             = "test"
+    label_order             = ["environment", "name", "application"]
+    description             = "KMS key for cloudtrail"
+    deletion_window_in_days = 7
+    enable_key_rotation     = true
+    alias                   = "alias/cloudtrail"
+    policy                  = data.aws_iam_policy_document.default.json
+  }
+
+  data "aws_iam_policy_document" "default" {
+    version = "2012-10-17"
+    statement {
+      sid    = "Enable IAM User Permissions"
+      effect = "Allow"
+      principals {
+        type        = "AWS"
+        identifiers = ["*"]
+      }
+      actions   = ["kms:*"]
+      resources = ["*"]
+    }
+    statement {
+      sid    = "Allow CloudTrail to encrypt logs"
+      effect = "Allow"
+      principals {
+        type        = "Service"
+        identifiers = ["cloudtrail.amazonaws.com"]
+      }
+      actions   = ["kms:GenerateDataKey*"]
+      resources = ["*"]
+      condition {
+        test     = "StringLike"
+        variable = "kms:EncryptionContext:aws:cloudtrail:arn"
+        values = ["arn:aws:cloudtrail:*:XXXXXXXXXXXX:trail/*"]
+      }
+    }
+
+    statement {
+      sid    = "Allow CloudTrail to describe key"
+      effect = "Allow"
+      principals {
+        type        = "Service"
+        identifiers = ["cloudtrail.amazonaws.com"]
+      }
+      actions   = ["kms:DescribeKey"]
+      resources = ["*"]
+    }
+
+    statement {
+      sid    = "Allow principals in the account to decrypt log files"
+      effect = "Allow"
+      principals {
+        type        = "AWS"
+        identifiers = ["*"]
+      }
+      actions   = [
+                    "kms:Decrypt",
+                    "kms:ReEncryptFrom"
+      ]
+      resources = ["*"]
+      condition {
+        test = "StringEquals"
+        variable = "kms:CallerAccount"
+        values = [
+          "XXXXXXXXXXXX"]
+      }
+      condition {
+          test     = "StringLike"
+          variable = "kms:EncryptionContext:aws:cloudtrail:arn"
+          values = ["arn:aws:cloudtrail:*:XXXXXXXXXXXX:trail/*"]
+      }
+    }
+
+    statement {
+      sid    = "Allow alias creation during setup"
+      effect = "Allow"
+      principals {
+        type        = "AWS"
+        identifiers = ["*"]
+      }
+      actions   = ["kms:CreateAlias"]
+      resources = ["*"]
+    }
+  }
+
+```
+
+
+
+## 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 |
+| application | Application (e.g. `cd` or `clouddrove`). | string | `` | no |
+| attributes | Additional attributes (e.g. `1`). | list(string) | `<list>` | no |
+| deletion_window_in_days | Duration in days after which the key is deleted after destruction of the resource. | number | `10` | 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. | bool | `true` | no |
+| environment | Environment (e.g. `prod`, `dev`, `staging`). | string | `` | no |
+| is_enabled | Specifies whether the key is enabled. | bool | `true` | no |
+| key_usage | Specifies the intended use of the key. Defaults to ENCRYPT_DECRYPT, and only symmetric encryption and decryption are supported. | string | `ENCRYPT_DECRYPT` | no |
+| label_order | label order, e.g. `name`,`application`. | list | `<list>` | no |
+| name | Name  (e.g. `app` or `cluster`). | string | `` | no |
+| policy | A valid policy JSON document. For more information about building AWS IAM policy documents with Terraform. | string | `` | no |
+| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | map(string) | `<map>` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| alias_arn | Alias ARN. |
+| alias_name | Alias name. |
+| key_arn | Key ARN. |
+| key_id | Key ID. |
+| tags | A mapping of tags to assign to the resource. |
+
+
+
+## Testing
+
+In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
+
+You need to run the following command in the testing folder:
+```hcl
+  go test -run Test
+```
+
+
+
+## Feedback
+If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-kms/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
+
+If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-kms)!
+
+## About us
+
+At [CloudDrove][website], we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering.
+
+<p align="center">We are <b> The Cloud Experts!</b></p>
+<hr />
+<p align="center">We ❤️  <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://github.com/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p>
+
+  [website]: https://clouddrove.com
+  [github]: https://github.com/clouddrove
+  [linkedin]: https://cpco.io/linkedin
+  [twitter]: https://twitter.com/clouddrove/
+  [email]: https://clouddrove.com/contact-us.html
+  [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=
diff --git a/README.yaml b/README.yaml
@@ -0,0 +1,127 @@
+---
+#
+# 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
+
+# License of this project
+license: "MIT"
+
+# Canonical GitHub repo
+github_repo: clouddrove/terraform-aws-kms
+
+# Badges to display
+badges:
+  - name: "Terraform"
+    image: "https://img.shields.io/badge/Terraform-v0.12-green"
+    url: "https://www.terraform.io"
+  - name: "Licence"
+    image: "https://img.shields.io/badge/License-MIT-blue.svg"
+    url: "LICENSE.md"
+
+#  description of this project
+description: |-
+  This terraform module creates a KMS Customer Master Key (CMK) and its alias.
+
+# extra content
+include:
+  - "terraform.md"
+
+# How to use this project
+usage : |-
+  ### Simple Example
+  Here is an example of how you can use this module in your inventory structure:
+  ```hcl
+    module "kms_key" {
+      source                  = "git::https://github.com/clouddrove/terraform-aws-kms.git"
+      name                    = "kms"
+      application             = "clouddrove"
+      environment             = "test"
+      label_order             = ["environment", "name", "application"]
+      description             = "KMS key for cloudtrail"
+      deletion_window_in_days = 7
+      enable_key_rotation     = true
+      alias                   = "alias/cloudtrail"
+      policy                  = data.aws_iam_policy_document.default.json
+    }
+
+    data "aws_iam_policy_document" "default" {
+      version = "2012-10-17"
+      statement {
+        sid    = "Enable IAM User Permissions"
+        effect = "Allow"
+        principals {
+          type        = "AWS"
+          identifiers = ["*"]
+        }
+        actions   = ["kms:*"]
+        resources = ["*"]
+      }
+      statement {
+        sid    = "Allow CloudTrail to encrypt logs"
+        effect = "Allow"
+        principals {
+          type        = "Service"
+          identifiers = ["cloudtrail.amazonaws.com"]
+        }
+        actions   = ["kms:GenerateDataKey*"]
+        resources = ["*"]
+        condition {
+          test     = "StringLike"
+          variable = "kms:EncryptionContext:aws:cloudtrail:arn"
+          values = ["arn:aws:cloudtrail:*:XXXXXXXXXXXX:trail/*"]
+        }
+      }
+
+      statement {
+        sid    = "Allow CloudTrail to describe key"
+        effect = "Allow"
+        principals {
+          type        = "Service"
+          identifiers = ["cloudtrail.amazonaws.com"]
+        }
+        actions   = ["kms:DescribeKey"]
+        resources = ["*"]
+      }
+
+      statement {
+        sid    = "Allow principals in the account to decrypt log files"
+        effect = "Allow"
+        principals {
+          type        = "AWS"
+          identifiers = ["*"]
+        }
+        actions   = [
+                      "kms:Decrypt",
+                      "kms:ReEncryptFrom"
+        ]
+        resources = ["*"]
+        condition {
+          test = "StringEquals"
+          variable = "kms:CallerAccount"
+          values = [
+            "XXXXXXXXXXXX"]
+        }
+        condition {
+            test     = "StringLike"
+            variable = "kms:EncryptionContext:aws:cloudtrail:arn"
+            values = ["arn:aws:cloudtrail:*:XXXXXXXXXXXX:trail/*"]
+        }
+      }
+
+      statement {
+        sid    = "Allow alias creation during setup"
+        effect = "Allow"
+        principals {
+          type        = "AWS"
+          identifiers = ["*"]
+        }
+        actions   = ["kms:CreateAlias"]
+        resources = ["*"]
+      }
+    }
+
+  ```