Cleanup (#2)

Author: osterman

.travis.yml

@@ -0,0 +1,16 @@
+addons:
+  apt:
+    packages:
+      - git
+      - make
+      - curl
+
+install:
+  - make init
+
+script:
+  - make terraform/install
+  - make terraform/get-plugins
+  - make terraform/get-modules
+  - make terraform/lint
+  - make terraform/validate

LICENSE

@@ -178,15 +178,15 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
+      boilerplate notice, with the fields enclosed by brackets "{}"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2018 Cloud Posse, LLC
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -113,12 +113,44 @@ resource "aws_iam_policy" "ps_manage" {
 
 
 
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| account_id | The account id of the parameter store you want to allow access to. If none supplied, it uses the current account id of the provider. | string | `` | no |
+| kms_key | The arn of the KMS key that you want to allow access to. If empty it uses a wildcard resource (`*`). | string | `` | no |
+| parameter_root_name | The prefix or root parameter that you want to allow access to. | string | `` | no |
+| region | The region of the parameter store value that you want to allow access to. If none supplied, it uses the current region of the provider. | string | `` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| manage_kms_store_policy | A JSON policy document that allows decryption access to a KMS key. |
+| manage_parameter_store_policy | A JSON policy document that allows full access to the parameter store. |
+| put_xray_trace_policy | A JSON policy document that allows putting data into x-ray for tracing parameter store requests. |
+| read_parameter_store_policy | A JSON policy document that only allows read access to the parameter store. |
+| write_parameter_store_policy | A JSON policy document that only allows write access to the parameter store. |
+
+## Makefile Targets
+```
+Available targets:
+
+  help                                This help screen
+  help/all                            Display help for all targets
+  lint                                Lint terraform code
+
+```
+
+
 
 ## Related Projects
 
 Check out these related projects.
 
-- [terraform-aws-ssm-parameter-store](https://github.com/cloudposse/terraform-aws-ssm-parameter-store) - AWS SSM Parameter Store module
+- [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
+- [terraform-aws-kms-key](https://github.com/cloudposse/terraform-aws-kms-key) - Terraform module to provision a KMS key with alias
 
 
 ## Help
@@ -223,13 +255,13 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi
 
 ### Contributors
 
-|  [![Erik Osterman][osterman_avatar]](osterman_homepage)<br/>[Erik Osterman][osterman_homepage] | [![Jamie Nelson][Jamie-BitFlight_avatar]](Jamie-BitFlight_homepage)<br/>[Jamie Nelson][Jamie-BitFlight_homepage] | [![Sarkis Varozian][sarkis_avatar]](sarkis_homepage)<br/>[Sarkis Varozian][sarkis_homepage] |
+|  [![Jamie Nelson][Jamie-BitFlight_avatar]](Jamie-BitFlight_homepage)<br/>[Jamie Nelson][Jamie-BitFlight_homepage] | [![Erik Osterman][osterman_avatar]](osterman_homepage)<br/>[Erik Osterman][osterman_homepage] | [![Sarkis Varozian][sarkis_avatar]](sarkis_homepage)<br/>[Sarkis Varozian][sarkis_homepage] |
 |---|---|---|
 
-  [osterman_homepage]: https://github.com/osterman
-  [osterman_avatar]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
   [Jamie-BitFlight_homepage]: https://github.com/Jamie-BitFlight
   [Jamie-BitFlight_avatar]: https://avatars0.githubusercontent.com/u/25075504?s=144&u=ac7e53bda3706cb9d51907808574b6d342703b3e&v=4
+  [osterman_homepage]: https://github.com/osterman
+  [osterman_avatar]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144
   [sarkis_homepage]: https://github.com/sarkis
   [sarkis_avatar]: https://avatars3.githubusercontent.com/u/42673?s=144&v=4
 

README.yaml

@@ -7,9 +7,6 @@
 # Name of this project
 name: terraform-aws-ssm-parameter-store-policy-documents
 
-# Logo for this project
-#logo: docs/logo.png
-
 # License of this project
 license: "APACHE2"
 
@@ -30,17 +27,21 @@ badges:
 
 related:
   - name: "terraform-aws-ssm-parameter-store"
-    description: "AWS SSM Parameter Store module"
+    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"
+  - name: "terraform-aws-kms-key"
+    description: "Terraform module to provision a KMS key with alias"
+    url: "https://github.com/cloudposse/terraform-aws-kms-key"
 
 # Short description of this project
 description: |-
   This module generates JSON documents for restricted permission sets for AWS SSM Parameter Store access.
   Helpful when combined with [terraform-aws-ssm-parameter-store](https://github.com/cloudposse/terraform-aws-ssm-parameter-store)
-# How to use this project
 
+# How to use this project
 examples: |-
   Create a policy that allows access to write all parameters
   ```hcl
@@ -127,30 +128,22 @@ examples: |-
   }
   ```
 
-# Example usage
-#examples: |-
-#  Example goes here...
-
-# How to get started quickly
-#quickstart: |-
-#  Here's how to get started...
-
 # Other files to include in this README from the project folder
-# include:
-#   - "docs/variables.md"
-#   - "docs/outputs.md"
+include:
+  - "docs/terraform.md"
+  - "docs/targets.md"
 
 # Contributors to this project
 contributors:
-  - name: "Erik Osterman"
-    homepage: "https://github.com/osterman"
-    avatar: "http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144"
-    github: "osterman"
   - name: "Jamie Nelson"
     homepage: "https://github.com/Jamie-BitFlight"
     avatar: "https://avatars0.githubusercontent.com/u/25075504?s=144&u=ac7e53bda3706cb9d51907808574b6d342703b3e&v=4"
     github: "Jamie-BitFlight"
+  - name: "Erik Osterman"
+    homepage: "https://github.com/osterman"
+    avatar: "http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144"
+    github: "osterman"
   - name: "Sarkis Varozian"
     homepage: "https://github.com/sarkis"
     avatar: "https://avatars3.githubusercontent.com/u/42673?s=144&v=4"
-    github: "sarkis"
+    github: "sarkis"

docs/terraform.md

@@ -4,17 +4,17 @@
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
 | account_id | The account id of the parameter store you want to allow access to. If none supplied, it uses the current account id of the provider. | string | `` | no |
-| kms_key | The arn of the KMS key that you want to allow access to. If empty it uses a wildcard resource. `*` | string | `` | no |
-| parameter_root_name | The prefix or root parameter that you want to allow access to | string | `` | no |
+| kms_key | The arn of the KMS key that you want to allow access to. If empty it uses a wildcard resource (`*`). | string | `` | no |
+| parameter_root_name | The prefix or root parameter that you want to allow access to. | string | `` | no |
 | region | The region of the parameter store value that you want to allow access to. If none supplied, it uses the current region of the provider. | string | `` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| manage_kms_store_policy | A JSON policy document that allows decryption access to a KMS key |
-| manage_parameter_store_policy | A JSON policy document that allows full access to the parameter store |
-| put_xray_trace_policy | A JSON policy document that allows putting data into x-ray for tracing parameter store requests |
-| read_parameter_store_policy | A JSON policy document that only allows read access to the parameter store |
-| write_parameter_store_policy | A JSON policy document that only allows write access to the parameter store |
+| manage_kms_store_policy | A JSON policy document that allows decryption access to a KMS key. |
+| manage_parameter_store_policy | A JSON policy document that allows full access to the parameter store. |
+| put_xray_trace_policy | A JSON policy document that allows putting data into x-ray for tracing parameter store requests. |
+| read_parameter_store_policy | A JSON policy document that only allows read access to the parameter store. |
+| write_parameter_store_policy | A JSON policy document that only allows write access to the parameter store. |
 

outputs.tf

@@ -1,24 +1,24 @@
 output "read_parameter_store_policy" {
-  description = "A JSON policy document that only allows read access to the parameter store"
-  value = "${data.aws_iam_policy_document.read_parameter_store.json}"
+  description = "A JSON policy document that only allows read access to the parameter store."
+  value       = "${data.aws_iam_policy_document.read_parameter_store.json}"
 }
 
 output "write_parameter_store_policy" {
-  description = "A JSON policy document that only allows write access to the parameter store "
-  value = "${data.aws_iam_policy_document.write_parameter_store.json}"
+  description = "A JSON policy document that only allows write access to the parameter store."
+  value       = "${data.aws_iam_policy_document.write_parameter_store.json}"
 }
 
 output "manage_kms_store_policy" {
-  description = "A JSON policy document that allows decryption access to a KMS key"
-  value = "${data.aws_iam_policy_document.manage_kms_store.json}"
+  description = "A JSON policy document that allows decryption access to a KMS key."
+  value       = "${data.aws_iam_policy_document.manage_kms_store.json}"
 }
 
 output "manage_parameter_store_policy" {
-  description = "A JSON policy document that allows full access to the parameter store"
-  value = "${data.aws_iam_policy_document.manage_parameter_store.json}"
+  description = "A JSON policy document that allows full access to the parameter store."
+  value       = "${data.aws_iam_policy_document.manage_parameter_store.json}"
 }
 
 output "put_xray_trace_policy" {
-  description = "A JSON policy document that allows putting data into x-ray for tracing parameter store requests"
-  value = "${data.aws_iam_policy_document.put_xray_trace.json}"
+  description = "A JSON policy document that allows putting data into x-ray for tracing parameter store requests."
+  value       = "${data.aws_iam_policy_document.put_xray_trace.json}"
 }

variables.tf

@@ -1,10 +1,10 @@
 variable "parameter_root_name" {
-  description = "The prefix or root parameter that you want to allow access to"
+  description = "The prefix or root parameter that you want to allow access to."
   default     = ""
 }
 
 variable "kms_key" {
-  description = "The arn of the KMS key that you want to allow access to. If empty it uses a wildcard resource. `*` "
+  description = "The arn of the KMS key that you want to allow access to. If empty it uses a wildcard resource (`*`)."
   default     = ""
 }
 
@@ -14,6 +14,6 @@ variable "region" {
 }
 
 variable "account_id" {
-  description = "The account id of the parameter store you want to allow access to. If none supplied, it uses the current account id of the provider. "
+  description = "The account id of the parameter store you want to allow access to. If none supplied, it uses the current account id of the provider."
   default     = ""
 }