Use label pattern (#3)

* terraform fmt * Add TravisCI * Use `label` pattern * Update `README` * Update `README` * Disambiguate Policy names * Fix policy names * Fix policy names * Fix policy names * Add group membership and assign users to the groups * Update `README`
cloudposse · Mar 29, 2018 · 10498ed · 10498ed
1 parent f339af7
commit 10498ed
Show file tree

Hide file tree

Showing 8 changed files with 325 additions and 120 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,5 @@
 
 # Local values for vars
 terraform.tfvars
+.idea
+*.iml
diff --git a/.travis.yml b/.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
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2017 Cloud Posse, LLC
+   Copyright 2017-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.

diff --git a/Makefile b/Makefile
@@ -0,0 +1,6 @@
+SHELL := /bin/bash
+
+-include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness)
+
+lint:
+	$(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate
diff --git a/README.md b/README.md
@@ -1,74 +1,138 @@
-# terraform-aws-iam-assumed-roles
+# terraform-aws-iam-assumed-roles [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-iam-assumed-roles.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-iam-assumed-roles)
 
-Provides two IAM roles and two IAM groups for assuming these roles provided MFA is present.
+Terraform module to provision two IAM roles and two IAM groups for assuming the roles provided MFA is present,
+and add IAM users to the groups.
 
-- role and group named as **ops** has Administratror (full) access to AWS resources
-- role and group named as **readonly** has ReadOnly access to AWS resources
+- Role and group with Administrator (full) access to AWS resources
+- Role and group with Readonly access to AWS resources
 
-To give some user Administrator's access just add user to group **ops**
+To give a user administrator's access, add the user to the admin group.
 
-### Module usage
+To give a user readonly access, add the user to the readonly group.
+
+
+## Usage
 
 ```hcl
 module "assumed_roles" {
-  source       = "git::https://github.com/cloudposse/terraform-aws-iam-assumed-roles.git?ref=master"
+  source              = "git::https://github.com/cloudposse/terraform-aws-iam-assumed-roles.git?ref=master"
+  namespace           = "cp"
+  stage               = "prod"
+  admin_name          = "admin"
+  readonly_name       = "readonly"
+  admin_user_names    = ["User1","User2"] # Add these IAM users to the admin group
+  readonly_user_names = ["User3","User4"] # Add these IAM users to the readonly group
 }
 ```
 
-### Example usage
+## Variables
 
-```hcl
-resource "aws_iam_user" "Alice" {
-  name = "Alice"
-}
+|  Name                  |  Default       |  Description                                                                    | Required |
+|:-----------------------|:---------------|:--------------------------------------------------------------------------------|:--------:|
+| `namespace`            | ``             | Namespace (_e.g._ `cp` or `cloudposse`)                                         | Yes      |
+| `stage`                | ``             | Stage (_e.g._ `prod`, `dev`, `staging`)                                         | Yes      |
+| `admin_name`           | `admin`        | Name for the admin group and role                                               | Yes      |
+| `readonly_name`        | `readonly`     | Name for the readonly group and role                                            | Yes      |
+| `admin_user_names`     | `[]`           | Optional list of IAM user names to add to the admin group                       | No       |
+| `readonly_user_names`  | `[]`           | Optional list of IAM user names to add to the readonly group                    | No       |
+| `attributes`           | `[]`           | Additional attributes (_e.g._ `policy` or `role`)                               | No       |
+| `tags`                 | `{}`           | Additional tags (_e.g._ `map("BusinessUnit","XYZ")`                             | No       |
+| `delimiter`            | `-`            | Delimiter to be used between `namespace`, `stage`, `name`, and `attributes`     | No       |
 
-resource "aws_iam_user" "Diana" {
-  name = "Diana"
-}
 
-module "assumed_roles" {
-  source              = "github.com/cloudposse/terraform-aws-iam-assumed-roles.git?ref=master"
-  admin_group_name    = "Admins"
-  readonly_group_name = "Watchers"
-}
+## Outputs
 
-# Alice will be in 'ops' group with 'AdministratorAcsess'
-#
-resource "aws_iam_group_membership" "admin" {
-  name = "ops-group-membership"
-  users = ["${aws_iam_user.Alice.name}"]
-  group = "${module.assumed_roles.group_admin_name}"
-}
+| Name                     | Description          |
+|:-------------------------|:---------------------|
+| `group_admin_id`         | Admin group ID       |
+| `group_admin_arn`        | Admin group ARN      |
+| `group_admin_name`       | Admin group name     |
+| `group_readonly_id`      | Readonly group ID    |
+| `group_readonly_arn`     | Readonly group ARN   |
+| `group_readonly_name`    | Readonly group name  |
+| `role_admin_arn`         | Admin role ARN       |
+| `role_admin_name`        | Admin role name      |
+| `role_readonly_arn`      | Readonly role ARN    |
+| `role_readonly_name`     | Readonly role name   |
 
-# Diana will be in 'readonly' group with 'ReadOnlyAccess'
-#
-resource "aws_iam_group_membership" "readonly" {
-  name = "ro-group-membership"
-  users = ["${aws_iam_user.Diana.name}"]
-  group = "${module.assumed_roles.group_readonly_name}"
-}
 
-```
+## Help
+
+**Got a question?**
+
+File a GitHub [issue](https://github.com/cloudposse/terraform-aws-iam-assumed-roles/issues), send us an [email](mailto:hello@cloudposse.com) or reach out to us on [Gitter](https://gitter.im/cloudposse/).
+
+
+## Contributing
+
+### Bug Reports & Feature Requests
+
+Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-iam-assumed-roles/issues) to report any bugs or file feature requests.
+
+### Developing
+
+If you are interested in being a contributor and want to get involved in developing `terraform-aws-iam-assumed-roles`, 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.
+
+ 1. **Fork** the repo on GitHub
+ 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
+
+**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)
+
+See [LICENSE](LICENSE) for full details.
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "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
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+
+## About
+
+`terraform-aws-iam-assumed-roles` is maintained and funded by [Cloud Posse, LLC][website].
+
+![Cloud Posse](https://cloudposse.com/logo-300x69.png)
+
+
+Like it? Please let us know at <hello@cloudposse.com>
 
-### Argument Reference
+We love [Open Source Software](https://github.com/cloudposse/)!
 
-- `admin_role_name` - (Optional, default "ops") Name for IAM role with Administrator access
-- `admin_group_name` - (Optional, default "ops") Name for group assuming ops role
-- `readonly_role_name` - (Optional, default "readonly") Name for IAM role with ReadOnly access
-- `readonly_group_name` - (Optional, default "readonly") Name for group assuming readonly IAM role
+See [our other projects][community]
+or [hire us][hire] to help build your next cloud platform.
 
-### Attributes Reference
+  [website]: https://cloudposse.com/
+  [community]: https://github.com/cloudposse/
+  [hire]: https://cloudposse.com/contact/
 
-- `group_admin_id` - the Administrator group's ID.
-- `group_admin_arn` - the Amazon Resource Name (ARN) specifying the Administrator group.
-- `group_admin_name` - the Administrator group's name.
 
-- `group_readonly_id` - the ReadOnly group's ID.
-- `group_readonly_arn` - the Amazon Resource Name (ARN) specifying the ReadOnly group.
-- `group_readonly_name` - the ReadOnly group's name.
+### Contributors
 
-- `role_admin_arn` - the Amazon Resource Name (ARN) specifying the Administrator role.
-- `role_admin_name` - the Administrator role's name.
+| [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] |
+|-------------------------------------------------------|------------------------------------------------------------------|
 
-- `role_readonly_arn` - the Amazon Resource Name (ARN) specifying the ReadOnly role.
-- `role_readonly_name` - the ReadOnly role's name.
+  [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/
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,3 +7,5 @@ @@
     # Local values for vars
     terraform.tfvars
+    .idea
+    *.iml