From 73119f65a4e3e48f1eec7cad186f8e0154ab57b8 Mon Sep 17 00:00:00 2001 From: marcincuber Date: Wed, 11 Dec 2019 10:17:07 +0000 Subject: [PATCH] add documentation --- LICENSE | 11 ++++++ README.md | 55 ++++++++++++++++++++++++++ examples/{complete-alb => alb}/main.tf | 0 3 files changed, 66 insertions(+) create mode 100644 LICENSE create mode 100644 README.md rename examples/{complete-alb => alb}/main.tf (100%) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d955a86 --- /dev/null +++ b/LICENSE @@ -0,0 +1,11 @@ +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..99fcbc3 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# AWS Application and Network Load Balancer (ALB & NLB) Terraform module + +Terraform module which creates Application and/or Network Load Balancer resources in AWS. + +These types of resources are supported: + +* [Load Balancer](https://www.terraform.io/docs/providers/aws/r/lb.html) + +## Terraform versions + +Terraform 0.12. Pin module version to `~> v1.0`. Submit pull-requests to `master` branch. + +## Usage + +### Application Load Balancer (HTTP and HTTPS listeners) + +```hcl +module "alb" { + source = "umotif-public/alb/aws" + version = "~> 1.0.0" + + name_prefix = "complete-alb" + + load_balancer_type = "application" + + internal = false + vpc_id = "vpc-abasdasd132" + subnets = ["subnet-abasdasd132123", "subnet-abasdasd132123132"] + + access_logs = { + bucket = "alb-logs" + } + + tags = { + Project = "Test" + } +} +``` + + +## Assumptions + +Module is to be used with Terraform > 0.12. + +## Examples + +* [Application Load Balancer ALB](https://github.com/umotif-public/terraform-aws-alb/tree/master/examples/alb) + +## Authors + +Module managed by [Marcin Cuber](https://github.com/marcincuber) [linkedin](https://www.linkedin.com/in/marcincuber/). + +## License + +See LICENSE for full details. \ No newline at end of file diff --git a/examples/complete-alb/main.tf b/examples/alb/main.tf similarity index 100% rename from examples/complete-alb/main.tf rename to examples/alb/main.tf