Skip to content

Commit 145bddc

Browse files
committed
update README.md
1 parent 8181c90 commit 145bddc

File tree

1 file changed

+20
-29
lines changed

1 file changed

+20
-29
lines changed

README.md

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
Terraform AWS ALB
88
</h1>
99

10-
<p align="center" style="font-size: 1.2rem;">
10+
<p align="center" style="font-size: 1.2rem;">
1111
This terraform module is used to create ALB on AWS.
1212
</p>
1313

1414
<p align="center">
1515

1616
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/Terraform-v0.13-green" alt="Terraform">
17+
<img src="https://img.shields.io/badge/Terraform-v0.14-green" alt="Terraform">
1818
</a>
1919
<a href="LICENSE.md">
2020
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
@@ -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)
@@ -73,11 +73,8 @@ Here are examples of how you can use this module in your inventory structure:
7373
```hcl
7474
module "alb" {
7575
source = "clouddrove/alb/aws"
76-
version = "0.13.0"
76+
version = "0.14.0"
7777
name = "alb"
78-
application = "clouddrove"
79-
environment = "test"
80-
label_order = ["environment", "application", "name"]
8178
internal = false
8279
load_balancer_type = "application"
8380
instance_count = module.ec2.instance_count
@@ -118,11 +115,8 @@ Here are examples of how you can use this module in your inventory structure:
118115
```hcl
119116
module "alb" {
120117
source = "clouddrove/alb/aws"
121-
version = "0.13.0"
118+
version = "0.14.0"
122119
name = "nlb"
123-
application = "clouddrove"
124-
environment = "test"
125-
label_order = ["environment", "application", "name"]
126120
internal = false
127121
load_balancer_type = "application"
128122
instance_count = module.ec2.instance_count
@@ -165,12 +159,9 @@ Here are examples of how you can use this module in your inventory structure:
165159
### CLB Example
166160
```hcl
167161
module "clb" {
168-
source = "clouddrove/alb/aws"
169-
version = "0.13.0"
170-
name = "clb"
171-
application = "clouddrove"
172-
environment = "test"
173-
label_order = ["environment", "application", "name"]
162+
source = "clouddrove/alb/aws"
163+
version = "0.14.0"
164+
name = "clb"
174165
175166
load_balancer_type = "classic"
176167
internal = false
@@ -214,8 +205,7 @@ Here are examples of how you can use this module in your inventory structure:
214205
|------|-------------|------|---------|:--------:|
215206
| access\_logs | Access logs Enable or Disable. | `bool` | `false` | no |
216207
| allocation\_id | The allocation ID of the Elastic IP address. | `string` | `""` | no |
217-
| application | Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no |
218-
| attributes | Additional attributes (e.g. `1`). | `list` | `[]` | no |
208+
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
219209
| availability\_zones | The AZ's to serve traffic in. | `list(map(string))` | `[]` | no |
220210
| clb\_enable | If true, create clb. | `bool` | `false` | no |
221211
| connection\_draining | TBoolean to enable connection draining. Default: false. | `bool` | `false` | no |
@@ -227,7 +217,7 @@ Here are examples of how you can use this module in your inventory structure:
227217
| enable\_cross\_zone\_load\_balancing | Indicates whether cross zone load balancing should be enabled in application load balancers. | `bool` | `false` | no |
228218
| enable\_deletion\_protection | If true, deletion of the load balancer will be disabled via the AWS API. This will prevent Terraform from deleting the load balancer. Defaults to false. | `bool` | `false` | no |
229219
| enable\_http2 | Indicates whether HTTP/2 is enabled in application load balancers. | `bool` | `true` | no |
230-
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
220+
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `"test"` | no |
231221
| health\_check\_healthy\_threshold | The number of successful health checks before an instance is put into service. | `number` | `10` | no |
232222
| health\_check\_interval | The time between health check attempts in seconds. | `number` | `30` | no |
233223
| health\_check\_target | The target to use for health checks. | `string` | `"TCP:80"` | no |
@@ -244,7 +234,7 @@ Here are examples of how you can use this module in your inventory structure:
244234
| instance\_count | The count of instances. | `number` | `0` | no |
245235
| internal | If true, the LB will be internal. | `string` | `""` | no |
246236
| ip\_address\_type | The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 and dualstack. | `string` | `"ipv4"` | no |
247-
| label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no |
237+
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | <pre>[<br> "name",<br> "environment"<br>]</pre> | no |
248238
| listener\_certificate\_arn | The ARN of the SSL server certificate. Exactly one certificate is required if the protocol is HTTPS. | `string` | `""` | no |
249239
| listener\_protocol | The protocol for connections from clients to the load balancer. Valid values are TCP, HTTP and HTTPS. Defaults to HTTP. | `string` | `"HTTPS"` | no |
250240
| listener\_ssl\_policy | The security policy if using HTTPS externally on the load balancer. [See](https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-security-policy-table.html). | `string` | `"ELBSecurityPolicy-2016-08"` | no |
@@ -255,17 +245,18 @@ Here are examples of how you can use this module in your inventory structure:
255245
| load\_balancer\_type | The type of load balancer to create. Possible values are application or network. The default value is application. | `string` | `""` | no |
256246
| load\_balancer\_update\_timeout | Timeout value when updating the ALB. | `string` | `"10m"` | no |
257247
| log\_bucket\_name | S3 bucket (externally created) for storing load balancer access logs. Required if logging\_enabled is true. | `string` | `""` | no |
258-
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"anmol@clouddrove.com"` | no |
248+
| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"hello@clouddrove.com"` | no |
259249
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
260-
| security\_groups | A list of security group IDs to assign to the LB. Only valid for Load Balancers of type application. | `list` | `[]` | no |
250+
| repository | Terraform current module repo | `string` | `"https://registry.terraform.io/modules/clouddrove/terraform-aws-alb/aws/0.14.0"` | no |
251+
| security\_groups | A list of security group IDs to assign to the LB. Only valid for Load Balancers of type application. | `list(any)` | `[]` | no |
261252
| status\_code | The HTTP redirect code. The redirect is either permanent (HTTP\_301) or temporary (HTTP\_302). | `string` | `"HTTP_301"` | no |
262253
| subnet\_id | The id of the subnet of which to attach to the load balancer. You can specify only one subnet per Availability Zone. | `string` | `""` | no |
263254
| subnet\_mapping | A list of subnet mapping blocks describing subnets to attach to network load balancer | `list(map(string))` | `[]` | no |
264-
| subnets | A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type network. Changing this value will for load balancers of type network will force a recreation of the resource. | `list` | `[]` | no |
265-
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map` | `{}` | no |
255+
| subnets | A list of subnet IDs to attach to the LB. Subnets cannot be updated for Load Balancers of type network. Changing this value will for load balancers of type network will force a recreation of the resource. | `list(any)` | `[]` | no |
256+
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
266257
| target\_group\_port | The port on which targets receive traffic, unless overridden when registering a specific target. | `string` | `80` | no |
267258
| target\_groups | A list of maps containing key/value pairs that define the target groups to be created. Order of these maps is important and the index of these are to be referenced in listener definitions. Required key/values: name, backend\_protocol, backend\_port. Optional key/values are in the target\_groups\_defaults variable. | `any` | `[]` | no |
268-
| target\_id | The ID of the target. This is the Instance ID for an instance, or the container ID for an ECS container. If the target type is ip, specify an IP address. | `list` | n/a | yes |
259+
| target\_id | The ID of the target. This is the Instance ID for an instance, or the container ID for an ECS container. If the target type is ip, specify an IP address. | `list(any)` | n/a | yes |
269260
| target\_type | The type of target that you must specify when registering targets with this target group. | `string` | `""` | no |
270261
| vpc\_id | The identifier of the VPC in which to create the target group. | `string` | `""` | no |
271262

@@ -291,7 +282,7 @@ Here are examples of how you can use this module in your inventory structure:
291282

292283

293284
## Testing
294-
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.
285+
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.
295286

296287
You need to run the following command in the testing folder:
297288
```hcl
@@ -300,7 +291,7 @@ You need to run the following command in the testing folder:
300291

301292

302293

303-
## Feedback
294+
## Feedback
304295
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-alb/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
305296

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

0 commit comments

Comments
 (0)