-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Nikita Dugar
committed
Sep 30, 2019
0 parents
commit bac359e
Showing
13 changed files
with
498 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# ignored files | ||
*.tfstate | ||
*.tfstate.backup | ||
.terraform | ||
.idea | ||
*.iml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
repos: | ||
- repo: git://github.com/antonbabenko/pre-commit-terraform | ||
rev: v1.12.0 | ||
hooks: | ||
- id: terraform_fmt | ||
|
||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v2.0.0 | ||
hooks: | ||
- id: check-merge-conflict | ||
- id: trailing-whitespace | ||
- id: check-yaml | ||
- id: check-added-large-files |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
export GENIE_PATH ?= $(shell 'pwd')/../../../genie | ||
|
||
include $(GENIE_PATH)/Makefile |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,160 @@ | ||
<!-- 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 Iam User | ||
</h1> | ||
|
||
<p align="center" style="font-size: 1.2rem;"> | ||
Terraform module to create Iam user resource on AWS. | ||
</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-iam-user'> | ||
<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+Iam+User&url=https://github.com/clouddrove/terraform-aws-iam-user'> | ||
<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+Iam+User&url=https://github.com/clouddrove/terraform-aws-iam-user'> | ||
<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-iam-user/releases). | ||
|
||
|
||
### Simple example | ||
Here is an example of how you can use this module in your inventory structure: | ||
```hcl | ||
module "iam-user" { | ||
source = "git::https://github.com/clouddrove/terraform-aws-iam-user.git?ref=tags/0.12.0" | ||
name = "iam-user" | ||
application = "clouddrove" | ||
environment = "test" | ||
label_order = ["environment", "name", "application"] | ||
policy_enabled = true | ||
policy = data.aws_iam_policy_document.default.json | ||
} | ||
data "aws_iam_policy_document" "default" { | ||
statement { | ||
actions = [ | ||
"ec2:Describe*" | ||
] | ||
effect = "Allow" | ||
resources = ["*"] | ||
} | ||
} | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
|
||
## Inputs | ||
|
||
| Name | Description | Type | Default | Required | | ||
|------|-------------|:----:|:-----:|:-----:| | ||
| application | Application (e.g. `cd` or `clouddrove`). | string | `` | no | | ||
| attributes | Additional attributes (e.g. `1`). | list | `<list>` | no | | ||
| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | string | `-` | no | | ||
| enabled | Whether to create Iam user. | bool | `true` | no | | ||
| environment | Environment (e.g. `prod`, `dev`, `staging`). | string | `` | no | | ||
| force_destroy | When destroying this user, destroy even if it has non-Terraform-managed IAM access keys, login profile or MFA devices. Without force_destroy a user with non-Terraform-managed access keys and login profile will fail to be destroyed. | bool | `false` | no | | ||
| label_order | Label order, e.g. `name`,`application`. | list | `<list>` | no | | ||
| name | Name (e.g. `app` or `cluster`). | string | `` | no | | ||
| path | The path to the role. | string | `/` | no | | ||
| permissions_boundary | The ARN of the policy that is used to set the permissions boundary for the role. | string | `` | no | | ||
| pgp_key | Either a base-64 encoded PGP public key, or a keybase username in the form keybase:some_person_that_exists. | string | `` | no | | ||
| policy | The policy document. | string | `` | no | | ||
| policy_enabled | Whether to Attach Iam policy with user. | bool | `false` | no | | ||
| status | The access key status to apply. Defaults to Active. Valid values are Active and Inactive. | string | `Active` | no | | ||
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | map | `<map>` | no | | ||
|
||
## Outputs | ||
|
||
| Name | Description | | ||
|------|-------------| | ||
| arn | The ARN assigned by AWS for this user. | | ||
| key_id | The access key ID. | | ||
| secret | The secret access key. Note that this will be written to the state file. Please supply a pgp_key instead, which will prevent the secret from being stored in plain text. | | ||
| 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-iam-user/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-iam-user)! | ||
|
||
## 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= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
# | ||
# This is the canonical configuration for the `README.md` | ||
# Run `make readme` to rebuild the `README.md` | ||
# | ||
|
||
# Name of this project | ||
name : Terraform AWS Iam User | ||
|
||
# License of this project | ||
license: "MIT" | ||
|
||
# Canonical GitHub repo | ||
github_repo: clouddrove/terraform-aws-iam-user | ||
|
||
# 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: |- | ||
Terraform module to create Iam user resource on AWS. | ||
# extra content | ||
# please not remove these two If you need add more | ||
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 "iam-user" { | ||
source = "git::https://github.com/clouddrove/terraform-aws-iam-user.git?ref=tags/0.12.0" | ||
name = "iam-user" | ||
application = "clouddrove" | ||
environment = "test" | ||
label_order = ["environment", "name", "application"] | ||
policy_enabled = true | ||
policy = data.aws_iam_policy_document.default.json | ||
} | ||
data "aws_iam_policy_document" "default" { | ||
statement { | ||
actions = [ | ||
"ec2:Describe*" | ||
] | ||
effect = "Allow" | ||
resources = ["*"] | ||
} | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
provider "aws" { | ||
region = "eu-west-1" | ||
} | ||
|
||
module "iam-user" { | ||
source = "git::https://github.com/clouddrove/terraform-aws-iam-user.git?ref=tags/0.12.0" | ||
|
||
name = "iam-user" | ||
application = "clouddrove" | ||
environment = "test" | ||
label_order = ["environment", "name", "application"] | ||
|
||
policy_enabled = true | ||
policy = data.aws_iam_policy_document.default.json | ||
} | ||
|
||
data "aws_iam_policy_document" "default" { | ||
statement { | ||
actions = [ | ||
"ec2:Describe*" | ||
] | ||
effect = "Allow" | ||
resources = ["*"] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
output "arn" { | ||
value = module.iam-user.*.arn | ||
description = "The ARN assigned by AWS for this user." | ||
} | ||
|
||
output "key_id" { | ||
value = module.iam-user.*.key_id | ||
description = "The ARN assigned by AWS for this user." | ||
} | ||
|
||
output "secret" { | ||
value = module.iam-user.*.secret | ||
description = "The ARN assigned by AWS for this user." | ||
} | ||
|
||
output "tags" { | ||
value = module.iam-user.tags | ||
description = "A mapping of tags to assign to the resource." | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
// Managed By : CloudDrove | ||
// Description : This Terratest is used to test the Terraform Route53 module. | ||
// Copyright @ CloudDrove. All Right Reserved. | ||
package test | ||
|
||
import ( | ||
"testing" | ||
"strings" | ||
"github.com/stretchr/testify/assert" | ||
"github.com/gruntwork-io/terratest/modules/terraform" | ||
) | ||
|
||
func Test(t *testing.T) { | ||
t.Parallel() | ||
|
||
terraformOptions := &terraform.Options{ | ||
// Source path of Terraform directory. | ||
TerraformDir: "../_example", | ||
Upgrade: true, | ||
} | ||
|
||
// This will run `terraform init` and `terraform apply` and fail the test if there are any errors | ||
terraform.InitAndApply(t, terraformOptions) | ||
|
||
// To clean up any resources that have been created, run 'terraform destroy' towards the end of the test | ||
defer terraform.Destroy(t, terraformOptions) | ||
|
||
// To get the value of an output variable, run 'terraform output' | ||
Tags := terraform.OutputMap(t, terraformOptions, "tags") | ||
Arn := strings.Join(terraform.OutputList(t, terraformOptions, "arn"),"") | ||
|
||
// Check that we get back the outputs that we expect | ||
assert.Equal(t, "test-iam-user-clouddrove", Tags["Name"]) | ||
assert.Contains(t, Arn, "arn:aws:iam") | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
## Managed By : CloudDrove | ||
## Copyright @ CloudDrove. All Right Reserved. | ||
|
||
#Module : label | ||
#Description : This terraform module is designed to generate consistent label names and tags | ||
# for resources. You can use terraform-labels to implement a strict naming | ||
# convention. | ||
module "labels" { | ||
source = "git::https://github.com/clouddrove/terraform-labels.git?ref=tags/0.12.0" | ||
|
||
name = var.name | ||
application = var.application | ||
environment = var.environment | ||
label_order = var.label_order | ||
} | ||
|
||
# Module : Iam user | ||
# Description : Terraform module to create IAm user resource on AWS. | ||
resource "aws_iam_user" "default" { | ||
count = var.enabled ? 1 : 0 | ||
name = module.labels.id | ||
force_destroy = var.force_destroy | ||
path = var.path | ||
permissions_boundary = var.permissions_boundary | ||
tags = module.labels.tags | ||
} | ||
|
||
resource "aws_iam_access_key" "default" { | ||
count = var.enabled ? 1 : 0 | ||
user = aws_iam_user.default.*.name[0] | ||
pgp_key = var.pgp_key | ||
status = var.status | ||
} | ||
|
||
resource "aws_iam_user_policy" "default" { | ||
count = var.enabled && var.policy_enabled ? 1 : 0 | ||
name = format("%s-policy", module.labels.id) | ||
user = aws_iam_user.default.*.name[0] | ||
|
||
policy = var.policy | ||
} |
Oops, something went wrong.