Skip to content

Commit

Permalink
updated readme, changelog and license
Browse files Browse the repository at this point in the history
  • Loading branch information
ZOI\graham.geary committed Dec 1, 2019
1 parent 7b936a2 commit 1640c5f
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 35 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ENHANCEMENTS:

* Upgraded module to terraform 0.12.x ([#10](https://github.com/zoitech/terraform-aws-saml/issues/10))
* Reduced security group complexity ([#13](https://github.com/zoitech/terraform-aws-saml/issues/13))
* Specify the port ranges of the allowed load balancer traffic into the instance(s) with variables "lb_in_from_port" and "lb_in_to_port" ([#13](https://github.com/zoitech/terraform-aws-saml/issues/13))
* Enabled access logs ([#7](https://github.com/zoitech/terraform-aws-saml/issues/7))

## 0.0.2

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License (MIT)

Copyright (c) 2018 Zoi TechCon GmbH
Copyright (c) 2019 Zoi TechCon GmbH

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:

Expand Down
53 changes: 20 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,28 @@ module "alb" {
aws_region = "eu-central-1"
vpc_id = "vpc-1234567b"
prefix = "p-dept.123-"
lb_name = "my-load-balancer"
suffix = "-abc"
lb_name = "my-load-balancer"
create_internal_lb = true
lb_security_group_ids = ["sg-1524364d", "172625db"]
lb_subnet_ids = ["subnet-fd42536a", "subnet-98781bac"]
create_lb_http_listener = true
lb_http_listener_port = 80
create_lb_http_listener_rules = true
http_target_group_parameters = [
{
target_group = "application-1-http"
host_headers = ["application-1.com"]
port = 80
},
{
target_group = "application-2-http"
host_headers = ["application-2.com"]
port = 10002
},
]
create_lb_https_listener = true
lb_https_listener_port = 443
https_target_group_parameters = [
{
target_group = "application-1-https"
Expand All @@ -40,11 +54,8 @@ module "alb" {
port = 10002
},
]
create_lb_https_listener = true
lb_https_listener_port = 443
enable_lb_https_offloading = false
certificate_arn = "arn:aws:acm:eu-central-1:xxxxxxxxxxx:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
create_lb_https_listener_rules = true
```

### Health Checks
Expand Down Expand Up @@ -101,18 +112,18 @@ https_target_group_stickiness_enabled = true #default set to false
https_target_group_stickiness_cookie_duration = 8640 #default 8640 seconds (1 day)
```


#### Security Groups

Two security groups are created by default.
The following security groups are created (depending on whether a HTTP listener, HTTPS listener or both are in use).

An empty security group is created and attached to the load balancer, which can be used later as the security group source in other security groups to allow traffic into the instance:

* Group-ALB-${var.lb_name}

The second security group uses the previously mentioned security group as the source, and is attached the target instances to allow traffic in:
The HTTP and HTTPs security groups uses the previously mentioned security group as the source, and is attached to the target instances to allow traffic in:

* tf-rule-alb-${var.prefix}${var.lb_name}-in-${var.lb_in_from_port}-${var.lb_in_to_port}
* group_loadbalancer_in_http
* group_loadbalancer_in_https

### Load Balancer Optional Arguments

Expand All @@ -133,30 +144,6 @@ The following outputs are available:
* lb_dns_name (The DNS name of the load balancer)
* lb_zone_id (The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record))

Example usage:
```hcl
#The name of the LB
output "lb_name" {
value = "${module.alb.lb_name}"
}
#The ARN of the load balancer
output "lb_arn" {
value = "${module.alb.lb_arn}"
}
#The ARN suffix for use with CloudWatch Metrics
output "lb_arn_suffix" {
value = "${module.alb.lb_arn_suffix}"
}
#The DNS name of the load balancer
output "lb_dns_name" {
value = "${module.alb.lb_dns_name}"
}
#The canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record)
output "lb_zone_id" {
value = "${module.alb.lb_zone_id}"
}
```

## Referencing a Tagged Version

```hcl
Expand Down

0 comments on commit 1640c5f

Please sign in to comment.