Skip to main content

Component eks/alb-controller-ingress-group

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.


Stack Level: Regional

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

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

component: eks/alb-controller-ingress-group
workspace_enabled: true
enabled: true
# change the name of the Ingress Group
name: alb-controller-ingress-group


terraform>= 1.0.0
aws>= 4.0
kubernetes>= 2.7.1, != 2.21.0


aws>= 4.0
kubernetes>= 2.7.1, != 2.21.0




aws_eks_cluster_auth.eksdata source
aws_lb.defaultdata source


additional_annotationsAdditional annotations to add to the Kubernetes ingressmap(any){}no
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
alb_access_logs_enabledWhether or not to enable access logs for the ALBboolfalseno
alb_access_logs_s3_bucket_nameThe name of the S3 bucket to store the access logs instringnullno
alb_access_logs_s3_bucket_prefixThe prefix to use when storing the access logsstring"echo-server"no
alb_group_nameThe name of the alb groupstringnullno
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
contextSingle 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.
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
create_namespaceCreate the namespace if it does not yet exist. Defaults to false.boolfalseno
default_annotationsDefault annotations to add to the Kubernetes ingressmap(any)
"": "[{\"HTTP\": 80}, {\"HTTPS\": 443}]",
"": "internet-facing",
"": "ELBSecurityPolicy-TLS13-1-2-2021-06",
"": "ip",
"": "alb"
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
dns_delegated_component_nameThe name of the dns_delegated componentstring"dns-delegated"no
dns_delegated_environment_nameGlobal environment namestring"gbl"no
eks_component_nameThe name of the eks componentstring"eks/cluster"no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
fixed_response_configConfiguration to overwrite the defaults such as contentType, statusCode, and messageBodymap(any){}no
fixed_response_templateFixed response template to service as a default backendstring"resources/default-backend.html.tpl"no
fixed_response_varsThe templatefile vars to use for the fixed response templatemap(any)
"email": "[email protected]"
global_accelerator_component_nameThe name of the global_accelerator componentstring"global-accelerator"no
global_accelerator_enabledWhether or not Global Accelerator Endpoint Group should be provisioned for the load balancerboolfalseno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
kube_data_auth_enabledIf true, use an aws_eks_cluster_auth data source to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled or kube_exec_auth_enabled.
kube_exec_auth_aws_profileThe AWS config profile for aws eks get-token to usestring""no
kube_exec_auth_aws_profile_enabledIf true, pass kube_exec_auth_aws_profile as the profile to aws eks get-tokenboolfalseno
kube_exec_auth_enabledIf true, use the Kubernetes provider exec feature to execute aws eks get-token to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled, overrides kube_data_auth_enabled.
kube_exec_auth_role_arnThe role ARN for aws eks get-token to usestring""no
kube_exec_auth_role_arn_enabledIf true, pass kube_exec_auth_role_arn as the role ARN to aws eks get-tokenbooltrueno
kubeconfig_contextContext to choose from the Kubernetes kube config filestring""no
kubeconfig_exec_auth_api_versionThe Kubernetes API version of the credentials returned by the exec auth pluginstring""no
kubeconfig_fileThe Kubernetes provider config_path setting to use when kubeconfig_file_enabled is truestring""no
kubeconfig_file_enabledIf true, configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS clusterboolfalseno
kubernetes_namespaceThe namespace to install the release into.stringn/ayes
kubernetes_service_enabledWhether or not to enable a default kubernetes serviceboolfalseno
kubernetes_service_pathThe kubernetes default service's path if enabledstring"/*"no
kubernetes_service_portThe kubernetes default service's port if enablednumber8080no
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
regionAWS Regionstringn/ayes
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
waf_component_nameThe name of the waf componentstring"waf"no
waf_enabledWhether or not WAF ACL annotation should be provisioned for the load balancerboolfalseno


annotationsThe annotations of the Ingress
group_nameThe value of of the Ingress
hostThe name of the host used by the Ingress
ingress_classThe value of the annotation of the Kubernetes Ingress
load_balancer_nameThe name of the load balancer created by the Ingress
load_balancer_schemeThe value of the annotation of the Kubernetes Ingress
message_body_lengthThe length of the message body to ensure it's lower than the maximum limit