Skip to content

Commit 8619685

Browse files
anmolnagpalanmolnagpal
committed
pushed README.md
1 parent 91d138f commit 8619685

File tree

1 file changed

+153
-0
lines changed

1 file changed

+153
-0
lines changed

‎README.md‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
<!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
2+
3+
<p align="center"> <img src="https://user-images.githubusercontent.com/50652676/62349836-882fef80-b51e-11e9-99e3-7b974309c7e3.png" width="100" height="100"></p>
4+
5+
6+
<h1 align="center">
7+
Terraform AWS Security Group
8+
</h1>
9+
10+
<p align="center" style="font-size: 1.2rem;">
11+
This terraform module creates set of Security Group and Security Group Rules resources in various combinations.
12+
</p>
13+
14+
<p align="center">
15+
16+
<a href="https://www.terraform.io">
17+
<img src="https://img.shields.io/badge/terraform-v0.13-green" alt="Terraform">
18+
</a>
19+
<a href="LICENSE.md">
20+
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
21+
</a>
22+
23+
24+
</p>
25+
<p align="center">
26+
27+
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-aws-security-group'>
28+
<img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
29+
</a>
30+
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AWS+Security+Group&url=https://github.com/clouddrove/terraform-aws-security-group'>
31+
<img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
32+
</a>
33+
<a href='https://twitter.com/intent/tweet/?text=Terraform+AWS+Security+Group&url=https://github.com/clouddrove/terraform-aws-security-group'>
34+
<img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" />
35+
</a>
36+
37+
</p>
38+
<hr>
39+
40+
41+
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.
42+
43+
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.
44+
45+
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.
46+
47+
48+
49+
50+
## Prerequisites
51+
52+
This module has a few dependencies:
53+
54+
- [Terraform 0.13](https://learn.hashicorp.com/terraform/getting-started/install.html)
55+
- [Go](https://golang.org/doc/install)
56+
- [github.com/stretchr/testify/assert](https://github.com/stretchr/testify)
57+
- [github.com/gruntwork-io/terratest/modules/terraform](https://github.com/gruntwork-io/terratest)
58+
59+
60+
61+
62+
63+
64+
65+
## Examples
66+
67+
68+
**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-security-group/releases).
69+
70+
71+
### Simple Example
72+
Here is an example of how you can use this module in your inventory structure:
73+
```hcl
74+
# use this
75+
module "security_group" {
76+
source = "clouddrove/security-group/aws"
77+
version = "0.13.0"
78+
name = "security-group"
79+
application = "clouddrove"
80+
environment = "test"
81+
protocol = "tcp"
82+
label_order = ["environment", "application", "name"]
83+
vpc_id = "vpc-xxxxxxxxx"
84+
allowed_ip = ["172.16.0.0/16", "10.0.0.0/16"]
85+
allowed_ipv6 = ["2405:201:5e00:3684:cd17:9397:5734:a167/128"]
86+
allowed_ports = [22, 27017]
87+
}
88+
```
89+
90+
91+
92+
93+
94+
95+
## Inputs
96+
97+
| Name | Description | Type | Default | Required |
98+
|------|-------------|------|---------|:--------:|
99+
| allowed\_ip | List of allowed ip. | `list` | `[]` | no |
100+
| allowed\_ipv6 | List of allowed ipv6. | `list` | `[]` | no |
101+
| allowed\_ports | List of allowed ingress ports. | `list` | `[]` | no |
102+
| application | Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no |
103+
| description | The security group description. | `string` | `"Instance default security group (only egress access is allowed)."` | no |
104+
| enable\_security\_group | Enable default Security Group with only Egress traffic allowed. | `bool` | `true` | no |
105+
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
106+
| label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no |
107+
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"[email protected]"` | no |
108+
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
109+
| prefix\_list | List of prefix list IDs (for allowing access to VPC endpoints)Only valid with egress | `list` | `[]` | no |
110+
| protocol | The protocol. If not icmp, tcp, udp, or all use the. | `string` | `"tcp"` | no |
111+
| security\_groups | List of Security Group IDs allowed to connect to the instance. | `list(string)` | `[]` | no |
112+
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(string)` | `{}` | no |
113+
| vpc\_id | The ID of the VPC that the instance security group belongs to. | `string` | `""` | no |
114+
115+
## Outputs
116+
117+
| Name | Description |
118+
|------|-------------|
119+
| security\_group\_ids | IDs on the AWS Security Groups associated with the instance. |
120+
| tags | A mapping of public tags to assign to the resource. |
121+
122+
123+
124+
125+
## Testing
126+
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.
127+
128+
You need to run the following command in the testing folder:
129+
```hcl
130+
go test -run Test
131+
```
132+
133+
134+
135+
## Feedback
136+
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-security-group/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).
137+
138+
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-security-group)!
139+
140+
## About us
141+
142+
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.
143+
144+
<p align="center">We are <b> The Cloud Experts!</b></p>
145+
<hr />
146+
<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>
147+
148+
[website]: https://clouddrove.com
149+
[github]: https://github.com/clouddrove
150+
[linkedin]: https://cpco.io/linkedin
151+
[twitter]: https://twitter.com/clouddrove/
152+
[email]: https://clouddrove.com/contact-us.html
153+
[terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=

0 commit comments

Comments
 (0)