-
Notifications
You must be signed in to change notification settings - Fork 11
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
1 parent
f2fd85b
commit f7fd1ce
Showing
2 changed files
with
139 additions
and
95 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 |
|---|---|---|
| @@ -1,34 +1,39 @@ | ||
| <!-- 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> | ||
|
|
||
|
|
||
| [][website] | ||
| <h1 align="center"> | ||
| Terraform AWS IAM Role | ||
| </h1> | ||
|
|
||
| <p align="center" style="font-size: 1.2rem;"> | ||
| Terraform module to create Iam role resource on AWS. | ||
| </p> | ||
| <p align="center" style="font-size: 1.2rem;"> | ||
| With our comprehensive DevOps toolkit - streamline operations, automate workflows, enhance collaboration and, most importantly, deploy with confidence. | ||
| </p> | ||
|
|
||
|
|
||
| <p align="center"> | ||
|
|
||
| <a href="https://www.terraform.io"> | ||
| <img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform"> | ||
| <a href="https://github.com/clouddrove/terraform-aws-iam-role/releases/latest"> | ||
| <img src="https://img.shields.io/github/release/clouddrove/terraform-aws-iam-role.svg" alt="Latest Release"> | ||
| </a> | ||
| <a href="https://github.com/clouddrove/terraform-aws-iam-role/actions/workflows/tfsec.yml"> | ||
| <img src="https://github.com/clouddrove/terraform-aws-iam-role/actions/workflows/tfsec.yml/badge.svg" alt="tfsec"> | ||
| </a> | ||
| <a href="LICENSE.md"> | ||
| <img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence"> | ||
| </a> | ||
| <a href="https://github.com/clouddrove/terraform-aws-iam-role/actions/workflows/tfsec.yml"> | ||
| <img src="https://github.com/clouddrove/terraform-aws-iam-role/actions/workflows/tfsec.yml/badge.svg" alt="tfsec"> | ||
| <a href="CHANGELOG.md"> | ||
| <img src="https://img.shields.io/badge/Changelog-blue" alt="Changelog"> | ||
| </a> | ||
|
|
||
|
|
||
| </p> | ||
| <p align="center"> | ||
|
|
||
| <a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-aws-iam-role'> | ||
| <img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" /> | ||
| </a> | ||
| <a href='https://www.instagram.com/cloud_drove?igsh=cHJqaDY3bGtnYmh3' title="Follow On Instagram"> | ||
| <img src="https://github.com/gauravghongde/social-icons/blob/master/SVG/Color/Instagram.svg" width="23" height="23" /> | ||
| </a> | ||
| <a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AWS+IAM+Role&url=https://github.com/clouddrove/terraform-aws-iam-role'> | ||
| <img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" /> | ||
| </a> | ||
|
|
@@ -40,137 +45,145 @@ | |
| <hr> | ||
|
|
||
|
|
||
| We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies 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. | ||
| We are a group of DevOps engineers & architects, joining hands in this ever evolving digital landscape. With our strong belief in Automation; just like microservices, always on the lookout to split the the infrastructure into smaller connected resources (database, cluster and more) which could be standardized, are manageable, scalable, secure & follow industry best practices. | ||
|
|
||
| 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. | ||
| This module includes Terraform open source, examples, and automation tests (for better understanding), which would help you create and improve your infrastructure with minimalistic coding. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Prerequisites | ||
|
|
||
| This module has a few dependencies: | ||
| - [Terraform 1.5.4](https://learn.hashicorp.com/terraform/getting-started/install.html) | ||
| ## Prerequisites and Providers | ||
|
|
||
| This table contains both Prerequisites and Providers: | ||
|
|
||
| | Description | Name | Version | | ||
| |:-------------:|:-------------------------------------------:|:---------:| | ||
| | **Prerequisite** | [Terraform](https://learn.hashicorp.com/terraform/getting-started/install.html) | >= 1.6.6 | | ||
| | **Provider** | [aws](https://aws.amazon.com/) | >= 5.31.0 | | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Examples | ||
|
|
||
| **IMPORTANT:** Since the master branch used in source varies based on new modifications, we recommend using the [release versions](https://github.com/clouddrove/terraform-aws-iam-role/releases). | ||
|
|
||
| 📌 For additional usage examples, check the complete list under [`examples/`](./examples) directory. | ||
|
|
||
|
|
||
|
|
||
| ## Inputs and Outputs | ||
|
|
||
| Refer to complete documentation: [here](docs/io.md) | ||
|
|
||
|
|
||
| <!-- | ||
| ## Module Dependencies | ||
| This module has dependencies on: | ||
| - [Labels Module](https://github.com/clouddrove/terraform-aws-labels): Provides resource tagging. | ||
| - [Security Groups Module](https://github.com/clouddrove/terraform-aws-security-group): Manage security groups | ||
| - [KMS Module](https://github.com/clouddrove/terraform-aws-kms): Manage resource encryption | ||
| **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-role/releases). | ||
| --> | ||
|
|
||
|
|
||
| ### Simple example | ||
| Here is an example of how you can use this module in your inventory structure: | ||
| ```hcl | ||
| module "iam-role" { | ||
| source = "clouddrove/iam-role/aws" | ||
| version = "1.3.0" | ||
| ## Module Dependencies | ||
|
|
||
| name = "iam-role" | ||
| application = "clouddrove" | ||
| environment = "test" | ||
| label_order = ["environment", "name"] | ||
| assume_role_policy = data.aws_iam_policy_document.default.json | ||
| managed_policy_arns = | ||
| policy_enabled = true | ||
| policy = data.aws_iam_policy_document.iam-policy.json | ||
| } | ||
| This module has dependencies on: | ||
| - [Labels Module](https://github.com/clouddrove/terraform-aws-labels): Provides resource tagging. | ||
|
|
||
| data "aws_iam_policy_document" "default" { | ||
| statement { | ||
| effect = "Allow" | ||
| actions = ["sts:AssumeRole"] | ||
| principals { | ||
| type = "Service" | ||
| identifiers = ["ec2.amazonaws.com"] | ||
| } | ||
| } | ||
| } | ||
|
|
||
| data "aws_iam_policy_document" "iam-policy" { | ||
| statement { | ||
| actions = [ | ||
| "ssm:UpdateInstanceInformation", | ||
| "ssmmessages:CreateControlChannel", | ||
| "ssmmessages:CreateDataChannel", | ||
| "ssmmessages:OpenControlChannel", | ||
| "ssmmessages:OpenDataChannel" ] | ||
| effect = "Allow" | ||
| resources = ["*"] | ||
| } | ||
| } | ||
| ``` | ||
| ## 📑 Changelog | ||
|
|
||
| Refer [here](CHANGELOG.md). | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## ✨ Contributors | ||
|
|
||
| Big thanks to our contributors for elevating our project with their dedication and expertise! But, we do not wish to stop there, would like to invite contributions from the community in improving these projects and making them more versatile for better reach. Remember, every bit of contribution is immensely valuable, as, together, we are moving in only 1 direction, i.e. forward. | ||
|
|
||
| <a href="https://github.com/clouddrove/terraform-aws-iam-role/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=clouddrove/terraform-aws-iam-role&max" /> | ||
| </a> | ||
| <br> | ||
| <br> | ||
|
|
||
| If you're considering contributing to our project, here are a few quick guidelines that we have been following (Got a suggestion? We are all ears!): | ||
|
|
||
| - **Fork the Repository:** Create a new branch for your feature or bug fix. | ||
| - **Coding Standards:** You know the drill. | ||
| - **Clear Commit Messages:** Write clear and concise commit messages to facilitate understanding. | ||
| - **Thorough Testing:** Test your changes thoroughly before submitting a pull request. | ||
| - **Documentation Updates:** Include relevant documentation updates if your changes impact it. | ||
|
|
||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | assume\_role\_policy | Whether to create Iam role. | `any` | n/a | yes | | ||
| | description | The description of the role. | `string` | `""` | no | | ||
| | enabled | Whether to create Iam role. | `bool` | `true` | no | | ||
| | environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no | | ||
| | force\_detach\_policies | The policy that grants an entity permission to assume the role. | `bool` | `false` | no | | ||
| | label\_order | Label order, e.g. `name`,`application`. | `list(any)` | <pre>[<br> "name",<br> "environment"<br>]</pre> | no | | ||
| | managed\_policy\_arns | Set of exclusive IAM managed policy ARNs to attach to the IAM role | `list(any)` | `[]` | no | | ||
| | managedby | ManagedBy, eg 'CloudDrove' | `string` | `"[email protected]"` | no | | ||
| | max\_session\_duration | The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. | `number` | `3600` | 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 | | ||
| | policy | The policy document. | `any` | `null` | no | | ||
| | policy\_arn | The ARN of the policy you want to apply. | `string` | `""` | no | | ||
| | policy\_enabled | Whether to Attach Iam policy with role. | `bool` | `false` | no | | ||
| | repository | https://github.com/clouddrove/terraform-aws-iam-role | `string` | `""` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | arn | The Amazon Resource Name (ARN) specifying the role. | | ||
| | name | Name of specifying the role. | | ||
| | policy | The policy document attached to the role. | | ||
| | role | The name of the role associated with the policy. | | ||
| | 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-role/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]). | ||
| Spot a bug or have thoughts to share with us? Let's squash it together! Log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-iam-role/issues), feel free to drop us an email at [[email protected]](mailto:[email protected]). | ||
|
|
||
| Show some love with a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-iam-role)! if our work has brightened your day! – your feedback fuels our journey! | ||
|
|
||
|
|
||
| ## :rocket: Our Accomplishment | ||
|
|
||
| We have [*100+ Terraform modules*][terraform_modules] 🙌. You could consider them finished, but, with enthusiasts like yourself, we are able to ever improve them, so we call our status - improvement in progress. | ||
|
|
||
| - [Terraform Module Registry:](https://registry.terraform.io/namespaces/clouddrove) Discover our Terraform modules here. | ||
|
|
||
| - [Terraform Modules for AWS/Azure Modules:](https://github.com/clouddrove/toc) Explore our comprehensive Table of Contents for easy navigation through our documentation for modules pertaining to AWS, Azure & GCP. | ||
|
|
||
| - [Terraform Modules for Digital Ocean:](https://github.com/terraform-do-modules/toc) Check out our specialized Terraform modules for Digital Ocean. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Join Our Slack Community | ||
|
|
||
| Join our vibrant open-source slack community and embark on an ever-evolving journey with CloudDrove; helping you in moving upwards in your career path. | ||
| Join our vibrant Open Source Slack Community and embark on a learning journey with CloudDrove. Grow with us in the world of DevOps and set your career on a path of consistency. | ||
|
|
||
| 🌐💬What you'll get after joining this Slack community: | ||
|
|
||
| - 🚀 Encouragement to upgrade your best version. | ||
| - 🌈 Learning companionship with our DevOps squad. | ||
| - 🌱 Relentless growth with daily updates on new advancements in technologies. | ||
|
|
||
| Join our tech elites [Join Now][slack] 🚀 | ||
|
|
||
|
|
||
| ## Explore Our Blogs | ||
|
|
||
| If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-iam-role)! | ||
| Click [here][blog] :books: :star2: | ||
|
|
||
| ## About us | ||
| ## Tap into our capabilities | ||
| We provide a platform for organizations to engage with experienced top-tier DevOps & Cloud services. Tap into our pool of certified engineers and architects to elevate your DevOps and Cloud Solutions. | ||
|
|
||
| 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. | ||
| At [CloudDrove][website], has extensive experience in designing, building & migrating environments, securing, consulting, monitoring, optimizing, automating, and maintaining complex and large modern systems. With remarkable client footprints in American & European corridors, our certified architects & engineers are ready to serve you as per your requirements & schedule. Write to us at [[email protected]](mailto:[email protected]). | ||
|
|
||
| <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> | ||
| <p align="center">We ❤️ <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://registry.terraform.io/namespaces/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p> | ||
|
|
||
| [website]: https://clouddrove.com | ||
| [blog]: https://blog.clouddrove.com | ||
| [slack]: https://www.launchpass.com/devops-talks | ||
| [github]: https://github.com/clouddrove | ||
| [linkedin]: https://cpco.io/linkedin | ||
| [twitter]: https://twitter.com/clouddrove/ | ||
|
|
||
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,31 @@ | ||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|------|---------|:--------:| | ||
| | assume\_role\_policy | Whether to create Iam role. | `string` | `null` | no | | ||
| | description | The description of the role. | `string` | `""` | no | | ||
| | enabled | Whether to create Iam role. | `bool` | `true` | no | | ||
| | environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no | | ||
| | force\_detach\_policies | The policy that grants an entity permission to assume the role. | `bool` | `false` | no | | ||
| | label\_order | Label order, e.g. `name`,`application`. | `list(any)` | <pre>[<br> "name",<br> "environment"<br>]</pre> | no | | ||
| | managed\_policy\_arns | Set of exclusive IAM managed policy ARNs to attach to the IAM role | `list(any)` | `[]` | no | | ||
| | managedby | ManagedBy, eg 'CloudDrove' | `string` | `"[email protected]"` | no | | ||
| | max\_session\_duration | The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. | `number` | `3600` | 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 | | ||
| | policy | The policy document. | `string` | `null` | no | | ||
| | policy\_arn | The ARN of the policy you want to apply. | `string` | `""` | no | | ||
| | policy\_enabled | Whether to Attach Iam policy with role. | `bool` | `false` | no | | ||
| | repository | https://github.com/clouddrove/terraform-aws-iam-role | `string` | `""` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | arn | The Amazon Resource Name (ARN) specifying the role. | | ||
| | name | Name of specifying the role. | | ||
| | policy | The policy document attached to the role. | | ||
| | role | The name of the role associated with the policy. | | ||
| | tags | A mapping of tags to assign to the resource. | | ||
|
|