Skip to content

Commit 1925f40

Browse files
committed
update README.md
1 parent 87cf93c commit 1925f40

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Terraform AWS EC2
88
</h1>
99

10-
<p align="center" style="font-size: 1.2rem;">
10+
<p align="center" style="font-size: 1.2rem;">
1111
Terraform module to create an EC2 resource on AWS with ElasticC IP Addresses and Elastic Block Store.
1212
</p>
1313

@@ -38,7 +38,7 @@
3838
<hr>
3939

4040

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.
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.
4242

4343
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.
4444

@@ -49,7 +49,7 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c
4949

5050
## Prerequisites
5151

52-
This module has a few dependencies:
52+
This module has a few dependencies:
5353

5454
- [Terraform 0.13](https://learn.hashicorp.com/terraform/getting-started/install.html)
5555
- [Go](https://golang.org/doc/install)
@@ -145,10 +145,8 @@ Here is examples of how you can use this module in your inventory structure:
145145
| availability\_zone | Availability Zone the instance is launched in. If not set, will be launched in the first AZ of the region. | `list(any)` | `[]` | no |
146146
| cpu\_core\_count | Sets the number of CPU cores for an instance. | `string` | `null` | no |
147147
| cpu\_credits | The credit option for CPU usage. Can be `standard` or `unlimited`. T3 instances are launched as unlimited by default. T2 instances are launched as standard by default. | `string` | `"standard"` | no |
148-
| delete\_on\_termination | Whether the volume should be destroyed on instance termination. Defaults to true. | `bool` | `true` | no |
149148
| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no |
150149
| disable\_api\_termination | If true, enables EC2 Instance Termination Protection. | `bool` | `false` | no |
151-
| disk\_size | Size of the root volume in gigabytes. | `number` | `8` | no |
152150
| dns\_enabled | Flag to control the dns\_enable. | `bool` | `false` | no |
153151
| dns\_zone\_id | The Zone ID of Route53. | `string` | `""` | no |
154152
| ebs\_block\_device | Additional EBS block devices to attach to the instance. | `list(any)` | `[]` | no |
@@ -175,9 +173,9 @@ Here is examples of how you can use this module in your inventory structure:
175173
| kms\_key\_id | The ARN for the KMS encryption key. When specifying kms\_key\_id, encrypted needs to be set to true. | `string` | `""` | no |
176174
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
177175
| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"[email protected]"` | no |
178-
| metadata\_http\_endpoint\_enabled | Whether the metadata service is available | `bool` | `true` | no |
176+
| metadata\_http\_endpoint\_enabled | Whether the metadata service is available. Valid values include enabled or disabled. Defaults to enabled. | `string` | `"enabled"` | no |
179177
| metadata\_http\_put\_response\_hop\_limit | The desired HTTP PUT response hop limit (between 1 and 64) for instance metadata requests. | `number` | `2` | no |
180-
| metadata\_http\_tokens\_required | Whether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2. | `bool` | `true` | no |
178+
| metadata\_http\_tokens\_required | Whether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2 (IMDSv2). Valid values include optional or required. Defaults to optional. | `string` | `"optional"` | no |
181179
| monitoring | If true, the launched EC2 instance will have detailed monitoring enabled. (Available since v0.6.0). | `bool` | `true` | no |
182180
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
183181
| network\_interface | Customize network interfaces to be attached at instance boot time | `list(map(string))` | `[]` | no |
@@ -208,13 +206,14 @@ Here is examples of how you can use this module in your inventory structure:
208206
| private\_ip | Private IP of instance. |
209207
| public\_ip | Public IP of instance (or EIP). |
210208
| subnet\_id | The EC2 subnet ID. |
209+
| tags | The instance ID. |
211210
| vpc\_security\_group\_ids | The associated security groups in non-default VPC. |
212211

213212

214213

215214

216215
## Testing
217-
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.
216+
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.
218217

219218
You need to run the following command in the testing folder:
220219
```hcl
@@ -223,7 +222,7 @@ You need to run the following command in the testing folder:
223222

224223

225224

226-
## Feedback
225+
## Feedback
227226
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-ec2/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).
228227

229228
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-ec2)!

0 commit comments

Comments
 (0)