terraform-aws-alb-ingress

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

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: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

Include this module in your existing terraform code:

module "alb_ingress" {
  source             = "git::https://github.com/cloudposse/terraform-aws-alb-ingress.git?ref=master"
  namespace          = "eg"
  name               = "app"
  stage              = "dev"

  vpc_id                              = "xxxxxxxx"
  unauthenticated_listener_arns       = ["xxxxxx", "yyyyyyy"]
  unauthenticated_listener_arns_count = "2"
  health_check_path                   = "/healthz"
  unauthenticated_paths               = ["/*"]
}

Makefile Targets

Available targets:

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

Inputs

Name	Description	Type	Default	Required
attributes	Additional attributes, e.g. `1`	list	`<list>`	no
authenticated_hosts	Authenticated hosts to match in Hosts header	list	`<list>`	no
authenticated_listener_arns	A list of authenticated ALB listener ARNs to attach ALB listener rules to	list	`<list>`	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	string	`0`	no
authenticated_paths	Authenticated path pattern to match (a maximum of 1 can be defined)	list	`<list>`	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	string	`300`	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_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
delimiter	Delimiter to be used between `namespace`, `name`, `stage` and `attributes`	string	`-`	no
deregistration_delay	The amount of time to wait in seconds while deregistering target	string	`15`	no
health_check_healthy_threshold	The number of consecutive health checks successes required before healthy	string	`2`	no
health_check_interval	The duration in seconds in between health checks	string	`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_timeout	The amount of time to wait in seconds before failing a health check request	string	`10`	no
health_check_unhealthy_threshold	The number of consecutive health check failures required before unhealthy	string	`2`	no
name	Solution name, e.g. `app`	string	-	yes
namespace	Namespace, which could be your organization name, e.g. `cp` or `cloudposse`	string	-	yes
port	The port for generated ALB target group (if `target_group_arn` not set)	string	`80`	no
protocol	The protocol for generated ALB target group (if `target_group_arn` not set)	string	`HTTP`	no
stage	Stage, e.g. `prod`, `staging`, `dev`, or `test`	string	-	yes
tags	Additional tags (e.g. `map(`BusinessUnit`,`XYZ`)	map	`<map>`	no
target_group_arn	ALB target group ARN. If this is an empty string, a new one will be generated	string	``	no
target_type	-	string	`ip`	no
unauthenticated_hosts	Unauthenticated hosts to match in Hosts header	list	`<list>`	no
unauthenticated_listener_arns	A list of unauthenticated ALB listener ARNs to attach ALB listener rules to	list	`<list>`	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	string	`0`	no
unauthenticated_paths	Unauthenticated path pattern to match (a maximum of 1 can be defined)	list	`<list>`	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	string	`100`	no
vpc_id	The VPC ID where generated ALB target group will be provisioned (if `target_group_arn` is not set)	string	-	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?

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

Commercial Support

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

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

Questions. We'll use a Shared Slack channel between your team and ours.
Troubleshooting. We'll help you triage why things aren't working.
Code Reviews. We'll review your Pull Requests and provide constructive feedback.
Bug Fixes. We'll rapidly work to fix any bugs in our projects.
Build New Terraform Modules. We'll develop original modules to provision infrastructure.
Cloud Architecture. We'll assist with your cloud strategy and design.
Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

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.

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

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

jamengual/terraform-aws-alb-ingress