Pin to release. Update README (#3)

cloudposse-archives · Apr 22, 2018 · c18e452 · c18e452
1 parent 1d4ab38
commit c18e452
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 41 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,4 @@
 # Module directory
 .terraform/
 .idea
-*.iml
+*.iml
diff --git a/README.md b/README.md
@@ -1,51 +1,53 @@
 # terraform-aws-iam-chamber-user [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-iam-chamber-user.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-iam-chamber-user)
 
-Terraform Module to provision a basic IAM [chamber](https://github.com/segmentio/chamber) user with access to SSM parameters and KMS key to decrypt secrets, suitable for CI/CD Systems
+Terraform module to provision a basic IAM [chamber](https://github.com/segmentio/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](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).
 
 We do not recommend creating IAM users this way for any other purpose.
 
-## Usage
 
-### Simple usage
+## Usage
 
 ```hcl
-module "circleci" {
-  source     = "git::https://github.com/cloudposse/terraform-aws-iam-chamber-user.git?ref=master"
+module "chamber_user" {
+  source      = "git::https://github.com/cloudposse/terraform-aws-iam-chamber-user.git?ref=master"
   namespace   = "cp"
-  stage       = "staging"
+  stage       = "prod"
   name        = "chamber"
   kms_key_arn = "arn:aws:kms:us-west-2:253234095951:key/abfd558e-3275-4ece-84e5-b35abc46c243"
 }
 ```
 
+
 ## Variables
 
 | Name            | Default | Description                                                                                 | Required |
 |:----------------|:-------:|:--------------------------------------------------------------------------------------------|:--------:|
 | `namespace`     |   ``    | Namespace (e.g. `cp` or `cloudposse`)                                                       |   Yes    |
 | `stage`         |   ``    | Stage (e.g. `prod`, `dev`, `staging`)                                                       |   Yes    |
-| `name`          |   ``    | Name  (e.g. `bastion` or `db`)                                                              |   Yes    |
-| `attributes`    |  `[]`   | Additional attributes (e.g. `policy` or `role`)                                             |    No    |
+| `name`          |   ``    | Name  (e.g. `app`)                                                                          |   Yes    |
+| `kms_key_arn`   |   ``    | KMS key ARN used to decrypt secrets in Parameter Store                                      |   Yes    |
+| `attributes`    |  `[]`   | Additional attributes (e.g. `1`)                                                            |    No    |
 | `tags`          |  `{}`   | Additional tags  (e.g. `map("BusinessUnit","XYZ")`                                          |    No    |
-| `delimiter`     |   `-`   | Delimiter to be used between `name`, `namespace`, `stage`, `arguments`, etc.                |    No    |
-| `force_destroy` | `false` | Destroy even if it has non-Terraform-managed IAM access keys, login profile or MFA devices. |    No    |
+| `delimiter`     |   `-`   | Delimiter to be used between `namespace`, `stage`, `name` and `attributes`                  |    No    |
+| `force_destroy` | `false` | Destroy even if it has non-Terraform-managed IAM access keys, login profiles or MFA devices |    No    |
 | `path`          |   `/`   | Path in which to create the user                                                            |    No    |
 | `enabled`       | `true`  | Set to `false` to prevent the module from creating any resources                            |    No    |
-| `kms_key_arn`   |   ``    | KMS key_arn used if Secure Strings are stored in Parameter Store to decrypt secrets.        |    Yes    |
-| `ssm_actions`   |  `["ssm:DescribeParameters","ssm:GetParameters"]`   | Actions to allow in policy                       |    No    |
-| `ssm_resources` |  `["*"]`   | Resources to apply actions specified in policy i.e. `["arn:aws:ssm:region:account-id:parameter/ci-*"]`  |    No    |
+| `ssm_actions`   | `["ssm:DescribeParameters","ssm:GetParameters"]`   | Actions to allow in the policy                   |    No    |
+| `ssm_resources` | `["*"]` | Resources to apply the actions specified in the policy                                      |    No    |
+
 
 ## Outputs
 
 | Name                | Description                                                                 |
 |:--------------------|:----------------------------------------------------------------------------|
 | `user_name`         | Normalized IAM user name                                                    |
-| `user_arn`          | The ARN assigned by AWS for this user                                       |
-| `user_unique_id`    | The unique ID assigned by AWS                                               |
+| `user_arn`          | The ARN assigned by AWS for the user                                        |
+| `user_unique_id`    | The user unique ID assigned by AWS                                          |
 | `access_key_id`     | The access key ID                                                           |
 | `secret_access_key` | The secret access key. This will be written to the state file in plain-text |
 
+
 ## Help
 
 **Got a question?**
@@ -72,6 +74,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 
 **NOTE:** Be sure to merge the latest from "upstream" before making a pull request!
 
+
 ## License
 
 [APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com)
@@ -95,6 +98,7 @@ See [LICENSE](LICENSE) for full details.
     specific language governing permissions and limitations
     under the License.
 
+
 ## About
 
 `terraform-aws-iam-chamber-user` is maintained and funded by [Cloud Posse, LLC][website].
@@ -112,7 +116,8 @@ or [hire us][hire] to help build your next cloud platform.
   [community]: https://github.com/cloudposse/
   [hire]: https://cloudposse.com/contact/
 
-### Contributors
+
+## Contributors
 
 | [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |  [![Sarkis Varozian][sarkis_img]][sarkis_web]<br/>[Sarkis Varozian][sarkis_web] |
 |------------------------------|------------------------------|------------------------------|

diff --git a/main.tf b/main.tf
@@ -1,14 +1,3 @@
-module "label" {
-  source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.3.1"
-  namespace  = "${var.namespace}"
-  stage      = "${var.stage}"
-  name       = "${var.name}"
-  attributes = "${var.attributes}"
-  delimiter  = "${var.delimiter}"
-  tags       = "${var.tags}"
-  enabled    = "${var.enabled}"
-}
-
 data "aws_iam_policy_document" "default" {
   statement {
     actions = "${var.ssm_actions}"
@@ -28,14 +17,14 @@ data "aws_iam_policy_document" "default" {
 }
 
 module "chamber_user" {
-  source        = "git::https://github.com/cloudposse/terraform-aws-iam-system-user.git?ref=master"
+  source        = "git::https://github.com/cloudposse/terraform-aws-iam-system-user.git?ref=tags/0.2.2"
+  namespace     = "${var.namespace}"
+  stage         = "${var.stage}"
   name          = "${var.name}"
-  enabled       = "${var.enabled}"
   attributes    = "${var.attributes}"
   tags          = "${var.tags}"
+  enabled       = "${var.enabled}"
   force_destroy = "${var.force_destroy}"
   path          = "${var.path}"
-  namespace     = "${var.namespace}"
-  stage         = "${var.stage}"
   policy        = "${data.aws_iam_policy_document.default.json}"
 }
diff --git a/outputs.tf b/outputs.tf
@@ -1,19 +1,24 @@
 output "user_name" {
-  value = "${module.chamber_user.user_name}"
+  value       = "${module.chamber_user.user_name}"
+  description = "Normalized IAM user name"
 }
 
 output "user_arn" {
-  value = "${module.chamber_user.user_arn}"
+  value       = "${module.chamber_user.user_arn}"
+  description = "The ARN assigned by AWS for the user"
 }
 
 output "user_unique_id" {
-  value = "${module.chamber_user.user_unique_id}"
+  value       = "${module.chamber_user.user_unique_id}"
+  description = "The user unique ID assigned by AWS"
 }
 
 output "access_key_id" {
-  value = "${module.chamber_user.access_key_id}"
+  value       = "${module.chamber_user.access_key_id}"
+  description = "The access key ID"
 }
 
 output "secret_access_key" {
-  value = "${module.chamber_user.secret_access_key}"
+  value       = "${module.chamber_user.secret_access_key}"
+  description = "The secret access key. This will be written to the state file in plain-text"
 }
diff --git a/variables.tf b/variables.tf
@@ -32,24 +32,24 @@ variable "tags" {
 }
 
 variable "kms_key_arn" {
-  description = "ARN of the KMS Key which will decrypt Secret Strings"
+  description = "ARN of the KMS key which will decrypt secret strings"
 }
 
 variable "ssm_actions" {
   type        = "list"
   default     = ["ssm:DescribeParameters", "ssm:GetParameters"]
-  description = "Actions to allow for in default policy"
+  description = "Actions to allow in the policy"
 }
 
 variable "ssm_resources" {
   type        = "list"
   default     = ["*"]
-  description = "Resources to apply default policy actions"
+  description = "Resources to apply the actions specified in the policy"
 }
 
 variable "force_destroy" {
   default     = "false"
-  description = "Destroy even if it has non-Terraform-managed IAM access keys, login profile or MFA devices."
+  description = "Destroy even if it has non-Terraform-managed IAM access keys, login profiles or MFA devices"
 }
 
 variable "path" {
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,4 +5,4 @@ @@
     # Module directory
     .terraform/
     .idea
-    *.iml
+    *.iml