Awesome

This component provisions a Kubernetes Service that creates an ALB for a specific IngressGroup.

An IngressGroup is a feature of the alb-controller which allows multiple Kubernetes Ingresses to share the same Application Load Balancer.

Usage

Stack Level: Regional

Once the catalog file is created, the file can be imported as follows.

import:
  - catalog/eks/alb-controller-ingress-group

The default catalog values e.g. stacks/catalog/eks/alb-controller-ingress-group.yaml will create a Kubernetes Service in the default namespace with an IngressGroup named alb-controller-ingress-group.

components:
  terraform:
    eks/alb-controller-ingress-group:
      metadata:
        component: eks/alb-controller-ingress-group
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        # change the name of the Ingress Group
        name: alb-controller-ingress-group

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.0.0
<a name="requirement_aws"></a> aws	>= 4.0
<a name="requirement_kubernetes"></a> kubernetes	>= 2.7.1, != 2.21.0

Providers

Name	Version
<a name="provider_aws"></a> aws	>= 4.0
<a name="provider_kubernetes"></a> kubernetes	>= 2.7.1, != 2.21.0

Modules

Name	Source	Version
<a name="module_dns_delegated"></a> dns_delegated	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_eks"></a> eks	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_global_accelerator"></a> global_accelerator	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_iam_roles"></a> iam_roles	../../account-map/modules/iam-roles	n/a
<a name="module_load_balancer_name"></a> load_balancer_name	cloudposse/label/null	0.25.0
<a name="module_this"></a> this	cloudposse/label/null	0.25.0
<a name="module_waf"></a> waf	cloudposse/stack-config/yaml//modules/remote-state	1.5.0

Resources

Name	Type
aws_globalaccelerator_endpoint_group.default	resource
kubernetes_ingress_v1.default	resource
kubernetes_namespace.default	resource
kubernetes_service.default	resource
aws_eks_cluster_auth.eks	data source
aws_lb.default	data source

Inputs

Name	Description	Type	Default	Required
<a name="input_additional_annotations"></a> additional_annotations	Additional annotations to add to the Kubernetes ingress	`map(any)`	`{}`	no
<a name="input_additional_tag_map"></a> additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
<a name="input_alb_access_logs_enabled"></a> alb_access_logs_enabled	Whether or not to enable access logs for the ALB	`bool`	`false`	no
<a name="input_alb_access_logs_s3_bucket_name"></a> alb_access_logs_s3_bucket_name	The name of the S3 bucket to store the access logs in	`string`	`null`	no
<a name="input_alb_access_logs_s3_bucket_prefix"></a> alb_access_logs_s3_bucket_prefix	The prefix to use when storing the access logs	`string`	`"echo-server"`	no
<a name="input_alb_group_name"></a> alb_group_name	The name of the alb group	`string`	`null`	no
<a name="input_attributes"></a> attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element.	`list(string)`	`[]`	no
<a name="input_context"></a> context	Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional_tag_map, which are merged.	`any`	<pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre>	no
<a name="input_create_namespace"></a> create_namespace	Create the namespace if it does not yet exist. Defaults to `false`.	`bool`	`false`	no
<a name="input_default_annotations"></a> default_annotations	Default annotations to add to the Kubernetes ingress	`map(any)`	<pre>{<br> "alb.ingress.kubernetes.io/listen-ports": "[{"HTTP": 80}, {"HTTPS": 443}]",<br> "alb.ingress.kubernetes.io/scheme": "internet-facing",<br> "alb.ingress.kubernetes.io/ssl-policy": "ELBSecurityPolicy-TLS13-1-2-2021-06",<br> "alb.ingress.kubernetes.io/target-type": "ip",<br> "kubernetes.io/ingress.class": "alb"<br>}</pre>	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_descriptor_formats"></a> descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br> format = string<br> labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
<a name="input_dns_delegated_component_name"></a> dns_delegated_component_name	The name of the `dns_delegated` component	`string`	`"dns-delegated"`	no
<a name="input_dns_delegated_environment_name"></a> dns_delegated_environment_name	Global environment name	`string`	`"gbl"`	no
<a name="input_eks_component_name"></a> eks_component_name	The name of the `eks` component	`string`	`"eks/cluster"`	no
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_fixed_response_config"></a> fixed_response_config	Configuration to overwrite the defaults such as `contentType`, `statusCode`, and `messageBody`	`map(any)`	`{}`	no
<a name="input_fixed_response_template"></a> fixed_response_template	Fixed response template to service as a default backend	`string`	`"resources/default-backend.html.tpl"`	no
<a name="input_fixed_response_vars"></a> fixed_response_vars	The templatefile vars to use for the fixed response template	`map(any)`	<pre>{<br> "email": "hello@cloudposse.com"<br>}</pre>	no
<a name="input_global_accelerator_component_name"></a> global_accelerator_component_name	The name of the `global_accelerator` component	`string`	`"global-accelerator"`	no
<a name="input_global_accelerator_enabled"></a> global_accelerator_enabled	Whether or not Global Accelerator Endpoint Group should be provisioned for the load balancer	`bool`	`false`	no
<a name="input_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to `0`.<br>Does not affect `id_full`.	`number`	`null`	no
<a name="input_kube_data_auth_enabled"></a> kube_data_auth_enabled	If `true`, use an `aws_eks_cluster_auth` data source to authenticate to the EKS cluster.<br>Disabled by `kubeconfig_file_enabled` or `kube_exec_auth_enabled`.	`bool`	`false`	no
<a name="input_kube_exec_auth_aws_profile"></a> kube_exec_auth_aws_profile	The AWS config profile for `aws eks get-token` to use	`string`	`""`	no
<a name="input_kube_exec_auth_aws_profile_enabled"></a> kube_exec_auth_aws_profile_enabled	If `true`, pass `kube_exec_auth_aws_profile` as the `profile` to `aws eks get-token`	`bool`	`false`	no
<a name="input_kube_exec_auth_enabled"></a> kube_exec_auth_enabled	If `true`, use the Kubernetes provider `exec` feature to execute `aws eks get-token` to authenticate to the EKS cluster.<br>Disabled by `kubeconfig_file_enabled`, overrides `kube_data_auth_enabled`.	`bool`	`true`	no
<a name="input_kube_exec_auth_role_arn"></a> kube_exec_auth_role_arn	The role ARN for `aws eks get-token` to use	`string`	`""`	no
<a name="input_kube_exec_auth_role_arn_enabled"></a> kube_exec_auth_role_arn_enabled	If `true`, pass `kube_exec_auth_role_arn` as the role ARN to `aws eks get-token`	`bool`	`true`	no
<a name="input_kubeconfig_context"></a> kubeconfig_context	Context to choose from the Kubernetes kube config file	`string`	`""`	no
<a name="input_kubeconfig_exec_auth_api_version"></a> kubeconfig_exec_auth_api_version	The Kubernetes API version of the credentials returned by the `exec` auth plugin	`string`	`"client.authentication.k8s.io/v1beta1"`	no
<a name="input_kubeconfig_file"></a> kubeconfig_file	The Kubernetes provider `config_path` setting to use when `kubeconfig_file_enabled` is `true`	`string`	`""`	no
<a name="input_kubeconfig_file_enabled"></a> kubeconfig_file_enabled	If `true`, configure the Kubernetes provider with `kubeconfig_file` and use that kubeconfig file for authenticating to the EKS cluster	`bool`	`false`	no
<a name="input_kubernetes_namespace"></a> kubernetes_namespace	The namespace to install the release into.	`string`	n/a	yes
<a name="input_kubernetes_service_enabled"></a> kubernetes_service_enabled	Whether or not to enable a default kubernetes service	`bool`	`false`	no
<a name="input_kubernetes_service_path"></a> kubernetes_service_path	The kubernetes default service's path if enabled	`string`	`"/*"`	no
<a name="input_kubernetes_service_port"></a> kubernetes_service_port	The kubernetes default service's port if enabled	`number`	`8080`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the `tags` output.<br>Set to `[]` to suppress all generated tags.<br>Notes:<br> The value of the `name` tag, if included, will be the `id`, not the `name`.<br> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br> "default"<br>]</pre>	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
<a name="input_regex_replace_chars"></a> regex_replace_chars	Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
<a name="input_region"></a> region	AWS Region	`string`	n/a	yes
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_tags"></a> tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
<a name="input_waf_component_name"></a> waf_component_name	The name of the `waf` component	`string`	`"waf"`	no
<a name="input_waf_enabled"></a> waf_enabled	Whether or not WAF ACL annotation should be provisioned for the load balancer	`bool`	`false`	no

Outputs

Name	Description
<a name="output_annotations"></a> annotations	The annotations of the Ingress
<a name="output_group_name"></a> group_name	The value of `alb.ingress.kubernetes.io/group.name` of the Ingress
<a name="output_host"></a> host	The name of the host used by the Ingress
<a name="output_ingress_class"></a> ingress_class	The value of the `kubernetes.io/ingress.class` annotation of the Kubernetes Ingress
<a name="output_load_balancer_name"></a> load_balancer_name	The name of the load balancer created by the Ingress
<a name="output_load_balancer_scheme"></a> load_balancer_scheme	The value of the `alb.ingress.kubernetes.io/scheme` annotation of the Kubernetes Ingress
<a name="output_message_body_length"></a> message_body_length	The length of the message body to ensure it's lower than the maximum limit

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

[!NOTE] This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
<details><summary>Learn More</summary>
It's 100% Open Source and licensed under the APACHE2.
</details>

Related Projects

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 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 Cloud Posse's other projects, we would love to hear from you! Hit us up in Slack, in the #cloudposse channel.

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

Review our Code of Conduct and Contributor Guidelines.
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!

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

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-alb-controller-ingress-group&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

About

This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-alb-controller-ingress-group&utm_content=">Cloud Posse, LLC</a>. <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-alb-controller-ingress-group&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>

We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

Your team can operate like a pro today.

Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.

<details> <summary>📚 See What's Included</summary>

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
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.

</details>

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

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.

</details>

Trademarks

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