terraform-aws-alb-ingress

Terraform module to provision an HTTP style ALB ingress based on hostname and/or path.

ALB ingress can be provisioned without authentication, or using Cognito or OIDC authentication.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

For a complete example, see examples/complete.

For automated test of the complete example using bats and Terratest, see test.

  provider "aws" {
    region = var.region
  }

  module "vpc" {
    source     = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=tags/0.8.1"
    namespace  = var.namespace
    stage      = var.stage
    name       = var.name
    delimiter  = var.delimiter
    attributes = var.attributes
    cidr_block = var.vpc_cidr_block
    tags       = var.tags
  }

  module "subnets" {
    source               = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=tags/0.16.1"
    availability_zones   = var.availability_zones
    namespace            = var.namespace
    stage                = var.stage
    name                 = var.name
    attributes           = var.attributes
    delimiter            = var.delimiter
    vpc_id               = module.vpc.vpc_id
    igw_id               = module.vpc.igw_id
    cidr_block           = module.vpc.vpc_cidr_block
    nat_gateway_enabled  = false
    nat_instance_enabled = false
    tags                 = var.tags
  }

  module "alb" {
    source                                  = "git::https://github.com/cloudposse/terraform-aws-alb.git?ref=tags/0.7.0"
    namespace                               = var.namespace
    stage                                   = var.stage
    name                                    = var.name
    attributes                              = var.attributes
    delimiter                               = var.delimiter
    vpc_id                                  = module.vpc.vpc_id
    security_group_ids                      = [module.vpc.vpc_default_security_group_id]
    subnet_ids                              = module.subnets.public_subnet_ids
    internal                                = var.internal
    http_enabled                            = var.http_enabled
    access_logs_enabled                     = var.access_logs_enabled
    alb_access_logs_s3_bucket_force_destroy = var.alb_access_logs_s3_bucket_force_destroy
    cross_zone_load_balancing_enabled       = var.cross_zone_load_balancing_enabled
    http2_enabled                           = var.http2_enabled
    idle_timeout                            = var.idle_timeout
    ip_address_type                         = var.ip_address_type
    deletion_protection_enabled             = var.deletion_protection_enabled
    deregistration_delay                    = var.deregistration_delay
    health_check_path                       = var.health_check_path
    health_check_timeout                    = var.health_check_timeout
    health_check_healthy_threshold          = var.health_check_healthy_threshold
    health_check_unhealthy_threshold        = var.health_check_unhealthy_threshold
    health_check_interval                   = var.health_check_interval
    health_check_matcher                    = var.health_check_matcher
    target_group_port                       = var.target_group_port
    target_group_target_type                = var.target_group_target_type
    tags                                    = var.tags
  }

  module "alb_ingress" {
    source                              = "git::https://github.com/cloudposse/terraform-aws-alb-ingress.git?ref=master"
    namespace                           = var.namespace
    stage                               = var.stage
    name                                = var.name
    attributes                          = var.attributes
    delimiter                           = var.delimiter
    vpc_id                              = module.vpc.vpc_id
    authentication_type                 = var.authentication_type
    unauthenticated_priority            = var.unauthenticated_priority
    unauthenticated_paths               = var.unauthenticated_paths
    slow_start                          = var.slow_start
    stickiness_enabled                  = var.stickiness_enabled
    default_target_group_enabled        = false
    target_group_arn                    = module.alb.default_target_group_arn
    unauthenticated_listener_arns       = [module.alb.http_listener_arn]
    unauthenticated_listener_arns_count = 1
    tags                                = var.tags
  }

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 0.12.0
aws	>= 2.42
local	>= 1.3
null	>= 2.0
template	>= 2.0

Providers

Name	Version
aws	>= 2.42

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional tags for appending to tags_as_list_of_maps. Not added to `tags`.	`map(string)`	`{}`	no
attributes	Additional attributes (e.g. `1`)	`list(string)`	`[]`	no
authenticated_hosts	Authenticated hosts to match in Hosts header	`list(string)`	`[]`	no
authenticated_listener_arns	A list of authenticated ALB listener ARNs to attach ALB listener rules to	`list(string)`	`[]`	no
authenticated_listener_arns_count	The number of authenticated ARNs in `authenticated_listener_arns`. This is necessary to work around a limitation in Terraform where counts cannot be computed	`number`	`0`	no
authenticated_paths	Authenticated path pattern to match (a maximum of 1 can be defined)	`list(string)`	`[]`	no
authenticated_priority	The priority for the rules with authentication, between 1 and 50000 (1 being highest priority). Must be different from `unauthenticated_priority` since a listener can't have multiple rules with the same priority	`number`	`0`	no
authentication_cognito_scope	Cognito scope	`list(string)`	`[]`	no
authentication_cognito_user_pool_arn	Cognito User Pool ARN	`string`	`""`	no
authentication_cognito_user_pool_client_id	Cognito User Pool Client ID	`string`	`""`	no
authentication_cognito_user_pool_domain	Cognito User Pool Domain. The User Pool Domain should be set to the domain prefix (`xxx`) instead of full domain (https://xxx.auth.us-west-2.amazoncognito.com)	`string`	`""`	no
authentication_oidc_authorization_endpoint	OIDC Authorization Endpoint	`string`	`""`	no
authentication_oidc_client_id	OIDC Client ID	`string`	`""`	no
authentication_oidc_client_secret	OIDC Client Secret	`string`	`""`	no
authentication_oidc_issuer	OIDC Issuer	`string`	`""`	no
authentication_oidc_scope	OIDC scope	`list(string)`	`[]`	no
authentication_oidc_token_endpoint	OIDC Token Endpoint	`string`	`""`	no
authentication_oidc_user_info_endpoint	OIDC User Info Endpoint	`string`	`""`	no
authentication_type	Authentication type. Supported values are `COGNITO` and `OIDC`	`string`	`""`	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as `null` to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	object({ enabled = bool namespace = string environment = string stage = string name = string delimiter = string attributes = list(string) tags = map(string) additional_tag_map = map(string) regex_replace_chars = string label_order = list(string) id_length_limit = number })	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "enabled": true, "environment": null, "id_length_limit": null, "label_order": [], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {} }	no
default_target_group_enabled	Enable/disable creation of the default target group	`bool`	`true`	no
delimiter	Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes`. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
deregistration_delay	The amount of time to wait in seconds while deregistering target	`number`	`15`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
environment	Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
health_check_enabled	Indicates whether health checks are enabled. Defaults to `true`	`bool`	`true`	no
health_check_healthy_threshold	The number of consecutive health checks successes required before healthy	`number`	`2`	no
health_check_interval	The duration in seconds in between health checks	`number`	`15`	no
health_check_matcher	The HTTP response codes to indicate a healthy check	`string`	`"200-399"`	no
health_check_path	The destination for the health check request	`string`	`"/"`	no
health_check_port	The port to use to connect with the target. Valid values are either ports 1-65536, or `traffic-port`. Defaults to `traffic-port`	`string`	`"traffic-port"`	no
health_check_protocol	The protocol to use to connect with the target. Defaults to `HTTP`. Not applicable when `target_type` is `lambda`	`string`	`"HTTP"`	no
health_check_timeout	The amount of time to wait in seconds before failing a health check request	`number`	`10`	no
health_check_unhealthy_threshold	The number of consecutive health check failures required before unhealthy	`number`	`2`	no
id_length_limit	Limit `id` to this many characters. Set to `0` for unlimited length. Set to `null` for default, which is `0`. Does not affect `id_full`.	`number`	`null`	no
label_order	The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present.	`list(string)`	`null`	no
listener_http_header_conditions	A list of http header conditions to apply to the listener.	list(object({ name = string value = list(string) }))	`[]`	no
load_balancing_algorithm_type	Determines how the load balancer selects targets when routing requests. Only applicable for Application Load Balancer Target Groups. The value is round_robin or least_outstanding_requests. The default is round_robin.	`string`	`"round_robin"`	no
name	Solution name, e.g. 'app' or 'jenkins'	`string`	`null`	no
namespace	Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'	`string`	`null`	no
port	The port for the created ALB target group (if `target_group_arn` is not set)	`number`	`80`	no
protocol	The protocol for the created ALB target group (if `target_group_arn` is not set)	`string`	`"HTTP"`	no
regex_replace_chars	Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
slow_start	The amount of time for targets to warm up before the load balancer sends them a full share of requests. The range is 30-900 seconds or 0 to disable. The default value is `0` seconds	`number`	`0`	no
stage	Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
stickiness_cookie_duration	The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds)	`number`	`86400`	no
stickiness_enabled	Boolean to enable / disable `stickiness`. Default is `true`	`bool`	`true`	no
stickiness_type	The type of sticky sessions. The only current possible value is `lb_cookie`	`string`	`"lb_cookie"`	no
tags	Additional tags (e.g. `map('BusinessUnit','XYZ')`	`map(string)`	`{}`	no
target_group_arn	Existing ALB target group ARN. If provided, set `default_target_group_enabled` to `false` to disable creation of the default target group	`string`	`""`	no
target_type	The type (`instance`, `ip` or `lambda`) of targets that can be registered with the target group	`string`	`"ip"`	no
unauthenticated_hosts	Unauthenticated hosts to match in Hosts header	`list(string)`	`[]`	no
unauthenticated_listener_arns	A list of unauthenticated ALB listener ARNs to attach ALB listener rules to	`list(string)`	`[]`	no
unauthenticated_listener_arns_count	The number of unauthenticated ARNs in `unauthenticated_listener_arns`. This is necessary to work around a limitation in Terraform where counts cannot be computed	`number`	`0`	no
unauthenticated_paths	Unauthenticated path pattern to match (a maximum of 1 can be defined)	`list(string)`	`[]`	no
unauthenticated_priority	The priority for the rules without authentication, between 1 and 50000 (1 being highest priority). Must be different from `authenticated_priority` since a listener can't have multiple rules with the same priority	`number`	`0`	no
vpc_id	The VPC ID where generated ALB target group will be provisioned (if `target_group_arn` is not set)	`string`	n/a	yes

Outputs

Name	Description
target_group_arn	ALB Target Group ARN
target_group_arn_suffix	ALB Target Group ARN suffix
target_group_name	ALB Target Group name

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

terraform-aws-alb - Terraform module to create an ALB, default ALB listener(s), and a default ALB target and related security groups.

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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

  https://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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman	Igor Rodionov	Andriy Knysh	Sarkis Varozian

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

terraform-aws-alb-ingress

Usage

Makefile Targets

Requirements

Providers

Inputs

Outputs

Share the Love

Related Projects

Help

DevOps Accelerator for Startups

Slack Community

Discourse Forums

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors

Files

README.md

Latest commit

History

README.md

File metadata and controls

terraform-aws-alb-ingress

Usage

Makefile Targets

Requirements

Providers

Inputs

Outputs

Share the Love

Related Projects

Help

DevOps Accelerator for Startups

Slack Community

Discourse Forums

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors