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.

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
terraform	>= 1.0.0
aws	>= 4.0
kubernetes	>= 2.7.1, != 2.21.0

Providers

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

Modules

Name	Source	Version
dns_delegated	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
eks	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
global_accelerator	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
iam_roles	../../account-map/modules/iam-roles	n/a
load_balancer_name	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0
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
additional_annotations	Additional annotations to add to the Kubernetes ingress	map(any)	{}	no
additional_tag_map	Additional 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.	map(string)	{}	no
alb_access_logs_enabled	Whether or not to enable access logs for the ALB	bool	false	no
alb_access_logs_s3_bucket_name	The name of the S3 bucket to store the access logs in	string	null	no
alb_access_logs_s3_bucket_prefix	The prefix to use when storing the access logs	string	"echo-server"	no
alb_group_name	The name of the alb group	string	null	no
attributes	ID 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.	list(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.	any	{ "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": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
create_namespace	Create the namespace if it does not yet exist. Defaults to false.	bool	false	no
default_annotations	Default annotations to add to the Kubernetes ingress	map(any)	{ "alb.ingress.kubernetes.io/listen-ports": "[{\"HTTP\": 80}, {\"HTTPS\": 443}]", "alb.ingress.kubernetes.io/scheme": "internet-facing", "alb.ingress.kubernetes.io/ssl-policy": "ELBSecurityPolicy-TLS13-1-2-2021-06", "alb.ingress.kubernetes.io/target-type": "ip", "kubernetes.io/ingress.class": "alb" }	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	Describe 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).	any	{}	no
dns_delegated_component_name	The name of the dns_delegated component	string	"dns-delegated"	no
dns_delegated_environment_name	Global environment name	string	"gbl"	no
eks_component_name	The name of the eks component	string	"eks/cluster"	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
fixed_response_config	Configuration to overwrite the defaults such as contentType, statusCode, and messageBody	map(any)	{}	no
fixed_response_template	Fixed response template to service as a default backend	string	"resources/default-backend.html.tpl"	no
fixed_response_vars	The templatefile vars to use for the fixed response template	map(any)	{ "email": "[email protected]" }	no
global_accelerator_component_name	The name of the global_accelerator component	string	"global-accelerator"	no
global_accelerator_enabled	Whether or not Global Accelerator Endpoint Group should be provisioned for the load balancer	bool	false	no
id_length_limit	Limit 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.	number	null	no
kube_data_auth_enabled	If 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.	bool	false	no
kube_exec_auth_aws_profile	The AWS config profile for aws eks get-token to use	string	""	no
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
kube_exec_auth_enabled	If 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.	bool	true	no
kube_exec_auth_role_arn	The role ARN for aws eks get-token to use	string	""	no
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
kubeconfig_context	Context to choose from the Kubernetes kube config file	string	""	no
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
kubeconfig_file	The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true	string	""	no
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
kubernetes_namespace	The namespace to install the release into.	string	n/a	yes
kubernetes_service_enabled	Whether or not to enable a default kubernetes service	bool	false	no
kubernetes_service_path	The kubernetes default service's path if enabled	string	"/*"	no
kubernetes_service_port	The kubernetes default service's port if enabled	number	8080	no
label_key_case	Controls 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.	string	null	no
label_order	The 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.	list(string)	null	no
label_value_case	Controls 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.	string	null	no
labels_as_tags	Set 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. Notes: 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.	set(string)	[ "default" ]	no
name	ID 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.	string	null	no
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
regex_replace_chars	Terraform 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.	string	null	no
region	AWS Region	string	n/a	yes
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
waf_component_name	The name of the waf component	string	"waf"	no
waf_enabled	Whether or not WAF ACL annotation should be provisioned for the load balancer	bool	false	no

Outputs

Name	Description
annotations	The annotations of the Ingress
group_name	The value of alb.ingress.kubernetes.io/group.name of the Ingress
host	The name of the host used by the Ingress
ingress_class	The value of the kubernetes.io/ingress.class annotation of the Kubernetes Ingress
load_balancer_name	The name of the load balancer created by the Ingress
load_balancer_scheme	The value of the alb.ingress.kubernetes.io/scheme annotation of the Kubernetes Ingress
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