alb-controller

This component creates a Helm release for alb-controller on an EKS cluster.

alb-controller is a Kubernetes addon that, in the context of AWS, provisions and manages ALBs and NLBs based on Service and Ingress annotations. This module also can (and is recommended to) provision a default IngressClass.

Special note about upgrading

When upgrading the chart version, check to see if the IAM policy for the service account needs to be updated. If it does, update the policy in the distributed-iam-policy.tf file. Probably the easiest way to check if it needs updating is to simply download the policy from https://raw.githubusercontent.com/kubernetes-sigs/aws-load-balancer-controller/main/docs/install/iam_policy.json and compare it to the policy in distributed-iam-policy.tf.

Usage

Stack Level: Regional

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

import:
  - catalog/eks/alb-controller
  ...

The default catalog values e.g. stacks/catalog/eks/alb-controller.yaml

components:
  terraform:
    eks/alb-controller:
      vars:
        chart: aws-load-balancer-controller
        chart_repository: https://aws.github.io/eks-charts
        # IMPORTANT: When updating the chart version, check to see if the IAM policy for the service account.
        # needs to be updated, and if it does, update the policy in the `distributed-iam-policy.tf` file.
        chart_version: "1.7.1"
        create_namespace: true
        kubernetes_namespace: alb-controller
        # this feature causes inconsistent final plans
        # see https://github.com/hashicorp/terraform-provider-helm/issues/711#issuecomment-836192991
        helm_manifest_experiment_enabled: false
        default_ingress_class_name: default
        default_ingress_group: common
        default_ingress_ip_address_type: ipv4
        default_ingress_scheme: internet-facing
        # You can use `chart_values` to set any other chart options. Treat `chart_values` as the root of the doc.
        #
        # # For example
        # ---
        # chart_values:
        #   enableShield: false
        chart_values: {}
        resources:
          limits:
            cpu: 200m
            memory: 256Mi
          requests:
            cpu: 100m
            memory: 128Mi

Variables

Required Variables

chart (string) required

Chart name to be installed. The chart name can be local path, a URL to a chart, or the name of the chart if repository is specified. It is also possible to use the <repository>/<chart> format here if you are running Terraform on a system that the repository has been added to with helm repo add but this is not recommended.

chart_repository (string) required

Repository URL where to locate the requested chart.

kubernetes_namespace (string) required

The namespace to install the release into.

region (string) required

AWS Region.

resources required

The cpu and memory of the deployment's limits and requests.

Type:

object({
limits = object({
  cpu    = string
  memory = string
})
requests = object({
  cpu    = string
  memory = string
})
})

Optional Variables

atomic (bool) optional

If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used.

Default value: true

chart_description (string) optional

Set release description attribute (visible in the history).

Default value: null

chart_values (any) optional

Additional values to yamlencode as helm_release values.

Default value: { }

chart_version (string) optional

Specify the exact chart version to install. If this is not specified, the latest version is installed.

Default value: null

cleanup_on_fail (bool) optional

Allow deletion of new resources created in this upgrade when upgrade fails.

Default value: true

create_namespace (bool) optional

Create the namespace if it does not yet exist. Defaults to false.

Default value: null

default_ingress_additional_tags (map(string)) optional

Additional tags to apply to the ingress load balancer.

Default value: { }

default_ingress_class_name (string) optional

Class name for default ingress

Default value: "default"

default_ingress_enabled (bool) optional

Set true to deploy a default IngressClass. There should only be one default per cluster.

Default value: true

default_ingress_group (string) optional

Group name for default ingress

Default value: "common"

default_ingress_ip_address_type (string) optional

IP address type for default ingress, one of ipv4 or dualstack.

Default value: "ipv4"

default_ingress_load_balancer_attributes (list(object({ key = string, value = string }))) optional

A list of load balancer attributes to apply to the default ingress load balancer.
See Load Balancer Attributes.

Default value: [ ]

default_ingress_scheme (string) optional

Scheme for default ingress, one of internet-facing or internal.

Default value: "internet-facing"

eks_component_name (string) optional

The name of the eks component

Default value: "eks/cluster"

helm_manifest_experiment_enabled (bool) optional

Enable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the plan

Default value: false

kube_data_auth_enabled (bool) optional

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.

Default value: false

kube_exec_auth_aws_profile (string) optional

The AWS config profile for aws eks get-token to use

Default value: ""

kube_exec_auth_aws_profile_enabled (bool) optional

If true, pass kube_exec_auth_aws_profile as the profile to aws eks get-token

Default value: false

kube_exec_auth_enabled (bool) optional

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.

Default value: true

kube_exec_auth_role_arn (string) optional

The role ARN for aws eks get-token to use

Default value: ""

kube_exec_auth_role_arn_enabled (bool) optional

If true, pass kube_exec_auth_role_arn as the role ARN to aws eks get-token

Default value: true

kubeconfig_context (string) optional

Context to choose from the Kubernetes config file.
If supplied, kubeconfig_context_format will be ignored.

Default value: ""

kubeconfig_context_format (string) optional

A format string to use for creating the kubectl context name when
kubeconfig_file_enabled is true and kubeconfig_context is not supplied.
Must include a single %s which will be replaced with the cluster name.

Default value: ""

kubeconfig_exec_auth_api_version (string) optional

The Kubernetes API version of the credentials returned by the exec auth plugin

Default value: "client.authentication.k8s.io/v1beta1"

kubeconfig_file (string) optional

The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true

Default value: ""

kubeconfig_file_enabled (bool) optional

If true, configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS cluster

Default value: false

rbac_enabled (bool) optional

Service Account for pods.

Default value: true

timeout (number) optional

Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 seconds

Default value: null

vpc_component_name (string) optional

The name of the vpc component

Default value: "vpc"

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

metadata: Block status of the deployed release

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.9.0
helm, version: >= 2.0
kubernetes, version: >= 2.14.0, != 2.21.0

Providers

aws, version: >= 4.9.0

Modules

Name	Version	Source	Description
`alb_controller`	0.10.0	`cloudposse/helm-release/aws`	n/a
`eks`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`iam_roles`	latest	`../../account-map/modules/iam-roles`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`vpc`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a

Resources

The following resources are used by this module:

Data Sources

The following data sources are used by this module:

aws_eks_cluster_auth.eks (data source)

References

alb-controller - Helm Chart
alb-controller - AWS Load Balancer Controller

Changelog

Release 1.466.0

PR #1070

Change default for default_ingress_ip_address_type from dualstack to ipv4. When dualstack is configured, the Ingress will fail if the VPC does not have an IPv6 CIDR block, which is still a common case. When ipv4 is configured, the Ingress will work with only an IPv4 CIDR block, and simply will not use IPv6 if it exists. This makes ipv4 the more conservative default.

Release 1.432.0

Better support for Kubeconfig authentication

Release 1.289.1

PR #821

Update IAM Policy and Change How it is Managed

The ALB controller needs a lot of permissions and has a complex IAM policy. For this reason, the project releases a complete JSON policy document that is updated as needed.

In this release:

We have updated the policy to the one distributed with version 2.6.0 of the ALB controller. This fixes an issue where the controller was not able to create the service-linked role for the Elastic Load Balancing service.
To ease maintenance, we have moved the policy document to a separate file, distributed-iam-policy.tf and made it easy to update or override.

Gov Cloud and China Regions

Actually, the project releases 3 policy documents, one for each of the three AWS partitions: aws, aws-cn, and aws-us-gov. For simplicity, this module only uses the aws partition policy. If you are in another partition, you can create a distributed-iam-policy_override.tf file in your directory and override the overridable_distributed_iam_policy local variable with the policy document for your partition.

Special note about upgrading​

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Changelog​

Release 1.466.0​

Release 1.432.0​

Release 1.289.1​

Update IAM Policy and Change How it is Managed​

Gov Cloud and China Regions​

Special note about upgrading

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References

Changelog

Release 1.466.0

Release 1.432.0

Release 1.289.1

Update IAM Policy and Change How it is Managed

Gov Cloud and China Regions