Skip to main content

Component: eks/cluster

This component is responsible for provisioning an end-to-end EKS Cluster, including managed node groups and Fargate profiles.

danger

This component should only be deployed after logging into AWS via Federated login with SAML (e.g. GSuite) or assuming an IAM role (e.g. from a CI/CD system). It should not be deployed if you log into AWS via AWS SSO, the reason being that on initial deployment, the EKS cluster will be owned by the assumed role that provisioned it, and AWS SSO roles are ephemeral (replaced on every configuration change). If this were to be the AWS SSO Role, then we risk losing access to the EKS cluster once the ARN of the AWS SSO Role eventually changes.

Usage​

Stack Level: Regional

Here's an example snippet for how to use this component.

This example expects the Cloud Posse Reference Architecture Identity and Network designs deployed for mapping users to EKS service roles and granting access in a private network. In addition, this example has the GitHub OIDC integration added and makes use of Karpenter to dynamically scale cluster nodes.

For more on these requirements, see Identity Reference Architecture, Network Reference Architecture, the GitHub OIDC component, and the Karpenter component.

components:
  terraform:
    eks/cluster:
      vars:
        enabled: true
        name: eks
        cluster_kubernetes_version: "1.27"

        vpc_component_name: "vpc"
        eks_component_name: "eks/cluster"

        # Your choice of availability zones or availability zone ids
        # availability_zones: ["us-east-1a", "us-east-1b", "us-east-1c"]
        aws_ssm_agent_enabled: true
        allow_ingress_from_vpc_accounts:
          - tenant: core
            stage: auto
          - tenant: core
            stage: corp
          - tenant: core
            stage: network

        public_access_cidrs: []
        allowed_cidr_blocks: []
        allowed_security_groups: []

        enabled_cluster_log_types:
          # Caution: enabling `api` log events may lead to a substantial increase in Cloudwatch Logs expenses.
          - api
          - audit
          - authenticator
          - controllerManager
          - scheduler

        oidc_provider_enabled: true

        # Allows GitHub OIDC role
        github_actions_iam_role_enabled: true
        github_actions_iam_role_attributes: [ "eks" ]
        github_actions_allowed_repos:
          - acme/infra

        # We use karpenter to provision nodes
        # See below for using node_groups
        managed_node_groups_enabled: false
        node_groups: {}

        # EKS IAM Authentication settings
        # By default, you can authenticate to EKS cluster only by assuming the role that created the cluster.
        # After the Auth Config Map is applied, the other IAM roles in
        # `primary_iam_roles`, `delegated_iam_roles`, and `sso_iam_roles` will be able to authenticate.
        apply_config_map_aws_auth: true
        availability_zone_abbreviation_type: fixed
        cluster_private_subnets_only: true
        cluster_encryption_config_enabled: true
        cluster_endpoint_private_access: true
        cluster_endpoint_public_access: false
        cluster_log_retention_period: 90

        # List of `aws-teams-roles` (in the account where the EKS cluster is deployed) to map to Kubernetes RBAC groups
        aws_team_roles_rbac:
          - aws_team_role: admin
            groups:
              - system:masters
          - aws_team_role: poweruser
            groups:
              - idp:poweruser
              - system:authenticated
          - aws_team_role: observer
            groups:
              - idp:observer
              - system:authenticated
          - aws_team_role: planner
            groups:
              - idp:observer
              - system:authenticated
          - aws_team: terraform
            groups:
              - system:masters

        # Permission sets from AWS SSO allowing cluster access
        # See `aws-sso` component.
        aws_sso_permission_sets_rbac:
          - aws_sso_permission_set: PowerUserAccess
            groups:
            - idp:poweruser
            - system:authenticated

        # Fargate Profiles for Karpenter
        fargate_profiles:
          karpenter:
            kubernetes_namespace: karpenter
            kubernetes_labels: null
        karpenter_iam_role_enabled: true
        # If you are using Karpenter, disable the legacy instance profile created by the eks/karpenter component
        # and use the one created by this component instead by setting the legacy flags to false in both components.
        # This is recommended for all new clusters.
        legacy_do_not_create_karpenter_instance_profile: false
        # All Fargate Profiles will use the same IAM Role when `legacy_fargate_1_role_per_profile_enabled` is set to false.
        # Recommended for all new clusters, but will damage existing clusters provisioned with the legacy component.
        legacy_fargate_1_role_per_profile_enabled: false
        # While it is possible to deploy add-ons to Fargate Profiles, it is not recommended. Use a managed node group instead.
        deploy_addons_to_fargate: false

        # EKS addons
        # https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html
        # Configuring EKS addons: https://aws.amazon.com/blogs/containers/amazon-eks-add-ons-advanced-configuration/
        addons:
          # https://docs.aws.amazon.com/eks/latest/userguide/managing-vpc-cni.html
          vpc-cni:
            addon_version: v1.13.4-eksbuild.1  # set `addon_version` to `null` to use the latest version
          # https://docs.aws.amazon.com/eks/latest/userguide/managing-kube-proxy.html
          kube-proxy:
            addon_version: "v1.27.1-eksbuild.1"  # set `addon_version` to `null` to use the latest version
          # https://docs.aws.amazon.com/eks/latest/userguide/managing-coredns.html
          coredns:
            addon_version: "v1.10.1-eksbuild.1"  # set `addon_version` to `null` to use the latest version
          # https://aws.amazon.com/blogs/containers/amazon-ebs-csi-driver-is-now-generally-available-in-amazon-eks-add-ons
          # https://docs.aws.amazon.com/eks/latest/userguide/ebs-csi.html
          # https://github.com/kubernetes-sigs/aws-ebs-csi-driver
          aws-ebs-csi-driver:
            addon_version: "v1.20.0-eksbuild.1"  # set `addon_version` to `null` to use the latest version
            # If you are not using [volume snapshots](https://kubernetes.io/blog/2020/12/10/kubernetes-1.20-volume-snapshot-moves-to-ga/#how-to-use-volume-snapshots)
            # (and you probably are not), disable the EBS Snapshotter with:
            configuration_values: '{"sidecars":{"snapshotter":{"forceEnable":false}}}'
          # Only install the EFS driver if you are using EFS.
          # Create an EFS file system with the `efs` component.
          # Create an EFS StorageClass with the `eks/storage-class` component.
          # https://docs.aws.amazon.com/eks/latest/userguide/efs-csi.html
          aws-efs-csi-driver:
            addon_version: "v1.5.8-eksbuild.1"
            # Set a short timeout in case of conflict with an existing efs-controller deployment
            create_timeout: "7m"

Amazon EKS End-of-Life Dates​

When picking a Kubernetes version, be sure to review the end-of-life dates for Amazon EKS. Refer to the chart below:

cyclereleaselatestlatest releaseeol
1.272023-05-241.27-eks-32023-06-302024-07-01
1.262023-04-111.26-eks-42023-06-302024-06-01
1.252023-02-211.25-eks-52023-06-302024-05-01
1.242022-11-151.24-eks-82023-06-302024-01-01
1.232022-08-111.23-eks-102023-06-302023-10-11
1.222022-04-041.22-eks-142023-06-302023-06-04
1.212021-07-191.21-eks-182023-06-092023-02-15
1.202021-05-181.20-eks-142023-05-052022-11-01
1.192021-02-161.19-eks-112022-08-152022-08-01
1.182020-10-131.18-eks-132022-08-152022-08-15

*This Chart was updated as of 08/04/2023 and is generated with the eol tool. Check the latest updates by running eol amazon-eks locally or on the website directly.

Usage with Node Groups​

The eks/cluster component also supports managed Node Groups. In order to add a set of nodes to provision with the cluster, provide values for var.managed_node_groups_enabled and var.node_groups.

info

You can use managed Node Groups in conjunction with Karpenter. We recommend provisioning a managed node group with as many nodes as Availability Zones used by your cluster (typically 3), to ensure a minimum support for a high-availability set of daemons, and then using Karpenter to provision additional nodes as needed.

For example:

managed_node_groups_enabled: true
node_groups: # for most attributes, setting null here means use setting from node_group_defaults
  main:
    # availability_zones = null will create one autoscaling group
    # in every private subnet in the VPC
    availability_zones: null

    desired_group_size: 3 # number of instances to start with, must be >= number of AZs
    min_group_size: 3 # must be  >= number of AZs
    max_group_size: 6

    # Can only set one of ami_release_version or kubernetes_version
    # Leave both null to use latest AMI for Cluster Kubernetes version
    kubernetes_version: null # use cluster Kubernetes version
    ami_release_version: null # use latest AMI for Kubernetes version

    attributes: []
    create_before_destroy: true
    cluster_autoscaler_enabled: true
    instance_types:
      - t3.medium
    ami_type: AL2_x86_64 # use "AL2_x86_64" for standard instances, "AL2_x86_64_GPU" for GPU instances
    block_device_map:
      # EBS volume for local ephemeral storage
      # IGNORED if legacy `disk_encryption_enabled` or `disk_size` are set!
      # "/dev/xvda" most of the instances (without local NVMe) and most of the Linuxes, "/dev/xvdb" BottleRocket
      "/dev/xvda":
        ebs:
          volume_size: 100 # number of GB
          volume_type: gp3
    kubernetes_labels: {}
    kubernetes_taints: {}
    resources_to_tag:
      - instance
      - volume
    tags: null

Using Addons​

EKS clusters support “Addons” that can be automatically installed on a cluster. Install these addons with the var.addons input.

info

Run the following command to see all available addons, their type, and their publisher. You can also see the URL for addons that are available through the AWS Marketplace. Replace 1.27 with the version of your cluster. See Creating an addon for more details.

EKS_K8S_VERSION=1.27 # replace with your cluster version
aws eks describe-addon-versions --kubernetes-version $EKS_K8S_VERSION \
  --query 'addons[].{MarketplaceProductUrl: marketplaceInformation.productUrl, Name: addonName, Owner: owner Publisher: publisher, Type: type}' --output table
info

You can see which versions are available for each addon by executing the following commands. Replace 1.27 with the version of your cluster.

EKS_K8S_VERSION=1.27 # replace with your cluster version
echo "vpc-cni:" && aws eks describe-addon-versions --kubernetes-version $EKS_K8S_VERSION --addon-name vpc-cni \
  --query 'addons[].addonVersions[].{Version: addonVersion, Defaultversion: compatibilities[0].defaultVersion}' --output table

echo "kube-proxy:" && aws eks describe-addon-versions --kubernetes-version $EKS_K8S_VERSION --addon-name kube-proxy \
  --query 'addons[].addonVersions[].{Version: addonVersion, Defaultversion: compatibilities[0].defaultVersion}' --output table

echo "coredns:" && aws eks describe-addon-versions --kubernetes-version $EKS_K8S_VERSION --addon-name coredns \
  --query 'addons[].addonVersions[].{Version: addonVersion, Defaultversion: compatibilities[0].defaultVersion}' --output table

echo "aws-ebs-csi-driver:" && aws eks describe-addon-versions --kubernetes-version $EKS_K8S_VERSION --addon-name aws-ebs-csi-driver \
  --query 'addons[].addonVersions[].{Version: addonVersion, Defaultversion: compatibilities[0].defaultVersion}' --output table

echo "aws-efs-csi-driver:" && aws eks describe-addon-versions --kubernetes-version $EKS_K8S_VERSION --addon-name aws-efs-csi-driver \
  --query 'addons[].addonVersions[].{Version: addonVersion, Defaultversion: compatibilities[0].defaultVersion}' --output table

Some add-ons accept additional configuration. For example, the vpc-cni addon accepts a disableNetworking parameter. View the available configuration options (as JSON Schema) via the aws eks describe-addon-configuration command. For example:

aws eks describe-addon-configuration \
  --addon-name aws-ebs-csi-driver \
  --addon-version v1.20.0-eksbuild.1 | jq '.configurationSchema | fromjson'

You can then configure the add-on via the configuration_values input. For example:

aws-ebs-csi-driver:
  configuration_values: '{"node": {"loggingFormat": "json"}}'

Configure the addons like the following example:

# https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html
# https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on
# https://aws.amazon.com/blogs/containers/amazon-eks-add-ons-advanced-configuration/
addons:
  # https://docs.aws.amazon.com/eks/latest/userguide/cni-iam-role.html
  # https://docs.aws.amazon.com/eks/latest/userguide/managing-vpc-cni.html
  # https://docs.aws.amazon.com/eks/latest/userguide/cni-iam-role.html#cni-iam-role-create-role
  # https://aws.github.io/aws-eks-best-practices/networking/vpc-cni/#deploy-vpc-cni-managed-add-on
  vpc-cni:
    addon_version: "v1.12.2-eksbuild.1"  # set `addon_version` to `null` to use the latest version
  # https://docs.aws.amazon.com/eks/latest/userguide/managing-kube-proxy.html
  kube-proxy:
    addon_version: "v1.25.6-eksbuild.1"  # set `addon_version` to `null` to use the latest version
  # https://docs.aws.amazon.com/eks/latest/userguide/managing-coredns.html
  coredns:
    addon_version: "v1.9.3-eksbuild.2"  # set `addon_version` to `null` to use the latest version
    # Uncomment to override default replica count of 2
    # configuration_values: '{"replicaCount": 3}'
  # https://docs.aws.amazon.com/eks/latest/userguide/csi-iam-role.html
  # https://aws.amazon.com/blogs/containers/amazon-ebs-csi-driver-is-now-generally-available-in-amazon-eks-add-ons
  # https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html#csi-iam-role
  # https://github.com/kubernetes-sigs/aws-ebs-csi-driver
  aws-ebs-csi-driver:
    addon_version: "v1.19.0-eksbuild.2"  # set `addon_version` to `null` to use the latest version
    # If you are not using [volume snapshots](https://kubernetes.io/blog/2020/12/10/kubernetes-1.20-volume-snapshot-moves-to-ga/#how-to-use-volume-snapshots)
    # (and you probably are not), disable the EBS Snapshotter with:
    configuration_values: '{"sidecars":{"snapshotter":{"forceEnable":false}}}'

Some addons, such as CoreDNS, require at least one node to be fully provisioned first. See issue #170 for more details. Set var.addons_depends_on to true to require the Node Groups to be provisioned before addons.

addons_depends_on: true
addons:
  coredns:
    addon_version: "v1.8.7-eksbuild.1"
danger

Addons may not be suitable for all use-cases! For example, if you are using Karpenter to provision nodes, these nodes will never be available before the cluster component is deployed.

For more information on upgrading EKS Addons, see "How to Upgrade EKS Cluster Addons"

Adding and Configuring a new EKS Addon​

Add a new EKS addon to the addons map (addons variable):

addons:
  my-addon:
    addon_version: "..."

If the new addon requires an EKS IAM Role for Kubernetes Service Account, perform the following steps:

  • Add a file addons-custom.tf to the eks/cluster folder

  • In the file, add an IAM policy document with the permissions required for the addon, and use the eks-iam-role module to provision an IAM Role for Kubernetes Service Account for the addon:

      data "aws_iam_policy_document" "my_addon" {
        statement {
          sid       = "..."
          effect    = "Allow"
          resources = ["..."]

          actions = [
            "...",
            "..."
          ]
        }
      }

      module "my_addon_eks_iam_role" {
        source  = "cloudposse/eks-iam-role/aws"
        version = "2.1.0"

        eks_cluster_oidc_issuer_url = local.eks_cluster_oidc_issuer_url

        service_account_name      = "..."
        service_account_namespace = "..."

        aws_iam_policy_document = [one(data.aws_iam_policy_document.my_addon[*].json)]

        context = module.this.context
      }

    For reference on how to configure the IAM role and IAM permissions for EKS addons, see addons.tf.

  • Add a file additional-addon-support_override.tf to the eks/cluster folder

  • In the file, add the IAM Role for Kubernetes Service Account for the addon to the overridable_additional_addon_service_account_role_arn_map map:

      locals {
        overridable_additional_addon_service_account_role_arn_map = {
          my-addon = module.my_addon_eks_iam_role.service_account_role_arn
        }
      }

  • This map will override the default map in the additional-addon-support.tf file, and will be merged into the final map together with the default EKS addons vpc-cni and aws-ebs-csi-driver (which this component configures and creates IAM Roles for Kubernetes Service Accounts)

  • Follow the instructions in the additional-addon-support.tf file if the addon may need to be deployed to Fargate, or has dependencies that Terraform cannot detect automatically.

Requirements​

NameVersion
terraform>= 1.3.0
aws>= 4.9.0
random>= 3.0

Providers​

NameVersion
aws>= 4.9.0
random>= 3.0

Modules​

NameSourceVersion
aws_ebs_csi_driver_eks_iam_rolecloudposse/eks-iam-role/aws2.1.1
aws_ebs_csi_driver_fargate_profilecloudposse/eks-fargate-profile/aws1.3.0
aws_efs_csi_driver_eks_iam_rolecloudposse/eks-iam-role/aws2.1.1
coredns_fargate_profilecloudposse/eks-fargate-profile/aws1.3.0
ekscloudposse/stack-config/yaml//modules/remote-state1.5.0
eks_clustercloudposse/eks-cluster/aws2.9.0
fargate_pod_execution_rolecloudposse/eks-fargate-profile/aws1.3.0
fargate_profilecloudposse/eks-fargate-profile/aws1.3.0
iam_arns../../account-map/modules/roles-to-principalsn/a
iam_roles../../account-map/modules/iam-rolesn/a
karpenter_labelcloudposse/label/null0.25.0
region_node_group./modules/node_group_by_regionn/a
thiscloudposse/label/null0.25.0
utilscloudposse/utils/aws1.3.0
vpccloudposse/stack-config/yaml//modules/remote-state1.5.0
vpc_cni_eks_iam_rolecloudposse/eks-iam-role/aws2.1.1
vpc_ingresscloudposse/stack-config/yaml//modules/remote-state1.5.0

Resources​

NameType
aws_iam_instance_profile.defaultresource
aws_iam_policy.ipv6_eks_cni_policyresource
aws_iam_role.karpenterresource
aws_iam_role_policy_attachment.amazon_ec2_container_registry_readonlyresource
aws_iam_role_policy_attachment.amazon_eks_worker_node_policyresource
aws_iam_role_policy_attachment.amazon_ssm_managed_instance_coreresource
aws_iam_role_policy_attachment.aws_ebs_csi_driverresource
aws_iam_role_policy_attachment.aws_efs_csi_driverresource
aws_iam_role_policy_attachment.ipv6_eks_cni_policyresource
aws_iam_role_policy_attachment.vpc_cniresource
random_pet.camel_case_warningresource
aws_availability_zones.defaultdata source
aws_iam_policy_document.assume_roledata source
aws_iam_policy_document.ipv6_eks_cni_policydata source
aws_iam_policy_document.vpc_cni_ipv6data source
aws_iam_roles.sso_rolesdata source
aws_partition.currentdata source

Inputs​

NameDescriptionTypeDefaultRequired
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.		map(string){}no
addonsManages EKS addons resources
map(object({
    enabled       = optional(bool, true)
    addon_version = optional(string, null)
    # configuration_values is a JSON string, such as '{"computeType": "Fargate"}'.
    configuration_values = optional(string, null)
    # Set default resolve_conflicts to OVERWRITE because it is required on initial installation of
    # add-ons that have self-managed versions installed by default (e.g. vpc-cni, coredns), and
    # because any custom configuration that you would want to preserve should be managed by Terraform.
    resolve_conflicts        = optional(string, "OVERWRITE")
    service_account_role_arn = optional(string, null)
    create_timeout           = optional(string, null)
    update_timeout           = optional(string, null)
    delete_timeout           = optional(string, null)
  }))
{}no
addons_depends_onIf set true (recommended), all addons will depend on managed node groups provisioned by this component and therefore not be installed until nodes are provisioned.
See issue #170 for more details.		booltrueno
allow_ingress_from_vpc_accountsList of account contexts to pull VPC ingress CIDR and add to cluster security group.

e.g.

{
environment = "ue2",
stage = "auto",
tenant = "core"
}		any[]no
allowed_cidr_blocksList of CIDR blocks to be allowed to connect to the EKS clusterlist(string)[]no
allowed_security_groupsList of Security Group IDs to be allowed to connect to the EKS clusterlist(string)[]no
apply_config_map_aws_authWhether to execute kubectl apply to apply the ConfigMap to allow worker nodes to join the EKS clusterbooltrueno
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.		list(string)[]no
availability_zone_abbreviation_typeType of Availability Zone abbreviation (either fixed or short) to use in names. See https://github.com/cloudposse/terraform-aws-utils for details.string"fixed"no
availability_zone_idsList of Availability Zones IDs where subnets will be created. Overrides availability_zones.
Can be the full name, e.g. use1-az1, or just the part after the AZ ID region code, e.g. -az1,
to allow reusable values across regions. Consider contention for resources and spot pricing in each AZ when selecting.
Useful in some regions when using only some AZs and you want to use the same ones across multiple accounts.		list(string)[]no
availability_zonesAWS Availability Zones in which to deploy multi-AZ resources.
Ignored if availability_zone_ids is set.
Can be the full name, e.g. us-east-1a, or just the part after the region, e.g. a to allow reusable values across regions.
If not provided, resources will be provisioned in every zone with a private subnet in the VPC.		list(string)[]no
aws_auth_yaml_strip_quotesIf true, remove double quotes from the generated aws-auth ConfigMap YAML to reduce spurious diffs in plansbooltrueno
aws_ssm_agent_enabledSet true to attach the required IAM policy for AWS SSM agent to each EC2 instance's IAM Roleboolfalseno
aws_sso_permission_sets_rbac(Not Recommended): AWS SSO (IAM Identity Center) permission sets in the EKS deployment account to add to aws-auth ConfigMap.
Unfortunately, aws-auth ConfigMap does not support SSO permission sets, so we map the generated
IAM Role ARN corresponding to the permission set at the time Terraform runs. This is subject to change
when any changes are made to the AWS SSO configuration, invalidating the mapping, and requiring a
terraform apply in this project to update the aws-auth ConfigMap and restore access.
list(object({
    aws_sso_permission_set = string
    groups                 = list(string)
  }))
[]no
aws_team_roles_rbacList of aws-team-roles (in the target AWS account) to map to Kubernetes RBAC groups.
list(object({
    aws_team_role = string
    groups        = list(string)
  }))
[]no
cluster_encryption_config_enabledSet to true to enable Cluster Encryption Configurationbooltrueno
cluster_encryption_config_kms_key_deletion_window_in_daysCluster Encryption Config KMS Key Resource argument - key deletion windows in days post destructionnumber10no
cluster_encryption_config_kms_key_enable_key_rotationCluster Encryption Config KMS Key Resource argument - enable kms key rotationbooltrueno
cluster_encryption_config_kms_key_idKMS Key ID to use for cluster encryption configstring""no
cluster_encryption_config_kms_key_policyCluster Encryption Config KMS Key Resource argument - key policystringnullno
cluster_encryption_config_resourcesCluster Encryption Config Resources to encrypt, e.g. ["secrets"]list(string)
[
  "secrets"
]
no
cluster_endpoint_private_accessIndicates whether or not the Amazon EKS private API server endpoint is enabled. Default to AWS EKS resource and it is falseboolfalseno
cluster_endpoint_public_accessIndicates whether or not the Amazon EKS public API server endpoint is enabled. Default to AWS EKS resource and it is truebooltrueno
cluster_kubernetes_versionDesired Kubernetes master version. If you do not specify a value, the latest available version is usedstringnullno
cluster_log_retention_periodNumber of days to retain cluster logs. Requires enabled_cluster_log_types to be set. See https://docs.aws.amazon.com/en_us/eks/latest/userguide/control-plane-logs.html.number0no
cluster_private_subnets_onlyWhether or not to enable private subnets or both public and private subnetsboolfalseno
colorThe cluster stage represented by a color; e.g. blue, greenstring""no
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.		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
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.		stringnullno
deploy_addons_to_fargateSet to true (not recommended) to deploy addons to Fargate instead of initial node poolboolfalseno
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).		any{}no
eks_component_nameThe name of the eks componentstring"eks/cluster"no
enabledSet to false to prevent the module from creating any resourcesboolnullno
enabled_cluster_log_typesA list of the desired control plane logging to enable. For more information, see https://docs.aws.amazon.com/en_us/eks/latest/userguide/control-plane-logs.html. Possible values [api, audit, authenticator, controllerManager, scheduler]list(string)[]no
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
fargate_profile_iam_role_kubernetes_namespace_delimiterDelimiter for the Kubernetes namespace in the IAM Role name for Fargate Profilesstring"-"no
fargate_profile_iam_role_permissions_boundaryIf provided, all Fargate Profiles IAM roles will be created with this permissions boundary attachedstringnullno
fargate_profilesFargate Profiles config
map(object({
    kubernetes_namespace = string
    kubernetes_labels    = map(string)
  }))
{}no
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.		numbernullno
karpenter_iam_role_enabledFlag to enable/disable creation of IAM role for EC2 Instance Profile that is attached to the nodes launched by Karpenterboolfalseno
kube_exec_auth_role_arnThe role ARN for aws eks get-token to use. Defaults to the current caller's role.stringnullno
kubeconfig_fileName of kubeconfig file to use to configure Kubernetes providerstring""no
kubeconfig_file_enabledSet true to configure Kubernetes provider with a kubeconfig file specified by kubeconfig_file.
Mainly for when the standard configuration produces a Terraform error.		boolfalseno
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.		stringnullno
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.		list(string)nullno
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.		stringnullno
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.
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
legacy_do_not_create_karpenter_instance_profileWhen true (the default), suppresses creation of the IAM Instance Profile
for nodes launched by Karpenter, to preserve the legacy behavior of
the eks/karpenter component creating it.
Set to false to enable creation of the IAM Instance Profile, which
ensures that both the role and the instance profile have the same lifecycle,
and avoids AWS Provider issue #32671.
Use in conjunction with eks/karpenter component legacy_create_karpenter_instance_profile.		booltrueno
legacy_fargate_1_role_per_profile_enabledSet to false for new clusters to create a single Fargate Pod Execution role for the cluster.
Set to true for existing clusters to preserve the old behavior of creating
a Fargate Pod Execution role for each Fargate Profile.		booltrueno
managed_node_groups_enabledSet false to prevent the creation of EKS managed node groups.booltrueno
map_additional_aws_accountsAdditional AWS account numbers to add to aws-auth ConfigMaplist(string)[]no
map_additional_iam_rolesAdditional IAM roles to add to config-map-aws-auth ConfigMap
list(object({
    rolearn  = string
    username = string
    groups   = list(string)
  }))
[]no
map_additional_iam_usersAdditional IAM users to add to aws-auth ConfigMap
list(object({
    userarn  = string
    username = string
    groups   = list(string)
  }))
[]no
map_additional_worker_rolesAWS IAM Role ARNs of worker nodes to add to aws-auth ConfigMaplist(string)[]no
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.		stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
node_group_defaultsDefaults for node groups in the cluster
object({
    ami_release_version        = optional(string, null)
    ami_type                   = optional(string, null)
    attributes                 = optional(list(string), null)
    availability_zones         = optional(list(string)) # set to null to use var.availability_zones
    cluster_autoscaler_enabled = optional(bool, null)
    create_before_destroy      = optional(bool, null)
    desired_group_size         = optional(number, null)
    instance_types             = optional(list(string), null)
    kubernetes_labels          = optional(map(string), {})
    kubernetes_taints = optional(list(object({
      key    = string
      value  = string
      effect = string
    })), [])
    kubernetes_version = optional(string, null) # set to null to use cluster_kubernetes_version
    max_group_size     = optional(number, null)
    min_group_size     = optional(number, null)
    resources_to_tag   = optional(list(string), null)
    tags               = optional(map(string), null)

    # block_device_map copied from cloudposse/terraform-aws-eks-node-group
    # Keep in sync via copy and paste, but make optional
    # Most of the time you want "/dev/xvda". For BottleRocket, use "/dev/xvdb".
    block_device_map = optional(map(object({
      no_device    = optional(bool, null)
      virtual_name = optional(string, null)
      ebs = optional(object({
        delete_on_termination = optional(bool, true)
        encrypted             = optional(bool, true)
        iops                  = optional(number, null)
        kms_key_id            = optional(string, null)
        snapshot_id           = optional(string, null)
        throughput            = optional(number, null) # for gp3, MiB/s, up to 1000
        volume_size           = optional(number, 50)   # disk  size in GB
        volume_type           = optional(string, "gp3")

        # Catch common camel case typos. These have no effect, they just generate better errors.
        # It would be nice to actually use these, but volumeSize in particular is a number here
        # and in most places it is a string with a unit suffix (e.g. 20Gi)
        # Without these defined, they would be silently ignored and the default values would be used instead,
        # which is difficult to debug.
        deleteOnTermination = optional(any, null)
        kmsKeyId            = optional(any, null)
        snapshotId          = optional(any, null)
        volumeSize          = optional(any, null)
        volumeType          = optional(any, null)
      }))
    })), null)

    # DEPRECATED: disk_encryption_enabled is DEPRECATED, use block_device_map instead.
    disk_encryption_enabled = optional(bool, null)
    # DEPRECATED: disk_size is DEPRECATED, use block_device_map instead.
    disk_size = optional(number, null)
  })
{
  "block_device_map": {
    "/dev/xvda": {
      "ebs": {
        "encrypted": true,
        "volume_size": 20,
        "volume_type": "gp2"
      }
    }
  },
  "desired_group_size": 1,
  "instance_types": [
    "t3.medium"
  ],
  "kubernetes_version": null,
  "max_group_size": 100
}
no
node_groupsList of objects defining a node group for the cluster
map(object({
    # EKS AMI version to use, e.g. "1.16.13-20200821" (no "v").
    ami_release_version = optional(string, null)
    # Type of Amazon Machine Image (AMI) associated with the EKS Node Group
    ami_type = optional(string, null)
    # Additional attributes (e.g. 1) for the node group
    attributes = optional(list(string), null)
    # will create 1 auto scaling group in each specified availability zone
    # or all AZs with subnets if none are specified anywhere
    availability_zones = optional(list(string), null)
    # Whether to enable Node Group to scale its AutoScaling Group
    cluster_autoscaler_enabled = optional(bool, null)
    # True to create new node_groups before deleting old ones, avoiding a temporary outage
    create_before_destroy = optional(bool, null)
    # Desired number of worker nodes when initially provisioned
    desired_group_size = optional(number, null)
    # Set of instance types associated with the EKS Node Group. Terraform will only perform drift detection if a configuration value is provided.
    instance_types = optional(list(string), null)
    # Key-value mapping of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed
    kubernetes_labels = optional(map(string), null)
    # List of objects describing Kubernetes taints.
    kubernetes_taints = optional(list(object({
      key    = string
      value  = string
      effect = string
    })), null)
    # Desired Kubernetes master version. If you do not specify a value, the latest available version is used
    kubernetes_version = optional(string, null)
    # The maximum size of the AutoScaling Group
    max_group_size = optional(number, null)
    # The minimum size of the AutoScaling Group
    min_group_size = optional(number, null)
    # List of auto-launched resource types to tag
    resources_to_tag = optional(list(string), null)
    tags             = optional(map(string), null)

    # block_device_map copied from cloudposse/terraform-aws-eks-node-group
    # Keep in sync via copy and paste, but make optional.
    # Most of the time you want "/dev/xvda". For BottleRocket, use "/dev/xvdb".
    block_device_map = optional(map(object({
      no_device    = optional(bool, null)
      virtual_name = optional(string, null)
      ebs = optional(object({
        delete_on_termination = optional(bool, true)
        encrypted             = optional(bool, true)
        iops                  = optional(number, null)
        kms_key_id            = optional(string, null)
        snapshot_id           = optional(string, null)
        throughput            = optional(number, null) # for gp3, MiB/s, up to 1000
        volume_size           = optional(number, 20)   # Disk size in GB
        volume_type           = optional(string, "gp3")

        # Catch common camel case typos. These have no effect, they just generate better errors.
        # It would be nice to actually use these, but volumeSize in particular is a number here
        # and in most places it is a string with a unit suffix (e.g. 20Gi)
        # Without these defined, they would be silently ignored and the default values would be used instead,
        # which is difficult to debug.
        deleteOnTermination = optional(any, null)
        kmsKeyId            = optional(any, null)
        snapshotId          = optional(any, null)
        volumeSize          = optional(any, null)
        volumeType          = optional(any, null)
      }))
    })), null)

    # DEPRECATED:
    # Enable disk encryption for the created launch template (if we aren't provided with an existing launch template)
    # DEPRECATED: disk_encryption_enabled is DEPRECATED, use block_device_map instead.
    disk_encryption_enabled = optional(bool, null)
    # Disk size in GiB for worker nodes. Terraform will only perform drift detection if a configuration value is provided.
    # DEPRECATED: disk_size is DEPRECATED, use block_device_map instead.
    disk_size = optional(number, null)

  }))
{}no
oidc_provider_enabledCreate an IAM OIDC identity provider for the cluster, then you can create IAM roles to associate with a service account in the cluster, instead of using kiam or kube2iam. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.htmlbooltrueno
public_access_cidrsIndicates which CIDR blocks can access the Amazon EKS public API server endpoint when enabled. EKS defaults this to a list with 0.0.0.0/0.list(string)
[
  "0.0.0.0/0"
]
no
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.		stringnullno
regionAWS Regionstringn/ayes
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
subnet_type_tag_keyThe tag used to find the private subnets to find by availability zone. If null, will be looked up in vpc outputs.stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.		map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
vpc_component_nameThe name of the vpc componentstring"vpc"no

Outputs​

NameDescription
availability_zonesAvailability Zones in which the cluster is provisioned
eks_auth_worker_rolesList of worker IAM roles that were included in the auth-map ConfigMap.
eks_cluster_arnThe Amazon Resource Name (ARN) of the cluster
eks_cluster_certificate_authority_dataThe Kubernetes cluster certificate authority data
eks_cluster_endpointThe endpoint for the Kubernetes API server
eks_cluster_idThe name of the cluster
eks_cluster_identity_oidc_issuerThe OIDC Identity issuer for the cluster
eks_cluster_managed_security_group_idSecurity Group ID that was created by EKS for the cluster. EKS creates a Security Group and applies it to ENI that is attached to EKS Control Plane master nodes and to any managed workloads
eks_cluster_versionThe Kubernetes server version of the cluster
eks_managed_node_workers_role_arnsList of ARNs for workers in managed node groups
eks_node_group_arnsList of all the node group ARNs in the cluster
eks_node_group_countCount of the worker nodes
eks_node_group_idsEKS Cluster name and EKS Node Group name separated by a colon
eks_node_group_role_namesList of worker nodes IAM role names
eks_node_group_statusesStatus of the EKS Node Group
fargate_profile_role_arnsFargate Profile Role ARNs
fargate_profile_role_namesFargate Profile Role names
fargate_profilesFargate Profiles
karpenter_iam_role_arnKarpenter IAM Role ARN
karpenter_iam_role_nameKarpenter IAM Role name
vpc_cidrThe CIDR of the VPC where this cluster is deployed.

References​

CHANGELOG​

Components PR #852​

This is a bug fix and feature enhancement update. No action is necessary to upgrade.

Bug Fixes​

  • Timeouts for Add-Ons are now honored (they were being ignored)
  • If you supply a service account role ARN for an Add-On, it will be used, and no new role will be created. Previously it was used, but the component created a new role anyway.
  • The EKS EFS controller add-on cannot be deployed to Fargate, and enabling it along with deploy_addons_to_fargate will no longer attempt to deploy EFS to Fargate. Note that this means to use the EFS Add-On, you must create a managed node group. Track the status of this feature with this issue.
  • If you are using an old VPC component that does not supply az_private_subnets_map, this module will now use the older the private_subnet_ids output.

Add-Ons have enabled option​

The EKS Add-Ons now have an optional "enabled" flag (defaults to true) so that you can selectively disable them in a stack where the inherited configuration has them enabled.

Upgrading to v1.270.0​

Components PR #795

Removed identity roles from cluster RBAC (aws-auth ConfigMap)​

Previously, this module added identity roles configured by the aws_teams_rbac input to the aws-auth ConfigMap. This never worked, and so now aws_teams_rbac is ignored. When upgrading, you may see these roles being removed from the aws-auth: this is expected and harmless.

Better support for Manged Node Group Block Device Specifications​

Previously, this module only supported specifying the disk size and encryption state for the root volume of Managed Node Groups. Now, the full set of block device specifications is supported, including the ability to specify the device name. This is particularly important when using BottleRocket, which uses a very small root volume for storing the OS and configuration, and exposes a second volume (/dev/xvdb) for storing data.

Block Device Migration​

Almost all of the attributes of node_groups and node_group_defaults are now optional. This means you can remove from your configuration any attributes that previously you were setting to null.

The disk_size and disk_encryption_enabled attributes are deprecated. They only apply to /dev/xvda, and only provision a gp2 volume. In order to provide backwards compatibility, they are still supported, and, when specified, cause the new block_device_map attribute to be ignored.

The new block_device_map attribute is a map of objects. The keys are the names of block devices, and the values are objects with the attributes from the Terraform launch_template.block-devices resource.

Note that the new default, when none of block_device_map, disk_size, or disk_encryption_enabled are specified, is to provision a 20GB gp3 volume for /dev/xvda, with encryption enabled. This is a change from the previous default, which provisioned a gp2 volume instead.

Support for EFS add-on​

This module now supports the EFS CSI driver add-on, in very much the same way as it supports the EBS CSI driver add-on. The only difference is that the EFS CSI driver add-on requires that you first provision an EFS file system.

Migration from eks/efs-controller to EFS CSI Driver Add-On​

If you are currently using the eks/efs-controller module, you can migrate to the EFS CSI Driver Add-On by following these steps:

  1. Remove or scale to zero Pods any Deployments using the EFS file system.
  2. Remove (terraform destroy) the eks/efs-controller module from your cluster. This will also remove the efs-sc StorageClass.
  3. Use the eks/storage-class module to create a replacement EFS StorageClass efs-sc. This component is new and you may need to add it to your cluster.
  4. Deploy the EFS CSI Driver Add-On by adding aws-efs-csi-driver to the addons map (see README).
  5. Restore the Deployments you modified in step 1.

More options for specifying Availability Zones​

Previously, this module required you to specify the Availability Zones for the cluster in one of two ways:

  1. Explicitly, by providing the full AZ names via the availability_zones input
  2. Implicitly, via private subnets in the VPC

Option 2 is still usually the best way, but now you have additional options:

  • You can specify the Availability Zones via the availability_zones input without specifying the full AZ names. You can just specify the suffixes of the AZ names, and the module will find the full names for you, using the current region. This is useful for using the same configuration in multiple regions.
  • You can specify Availability Zone IDs via the availability_zone_ids input. This is useful to ensure that clusters in different accounts are nevertheless deployed to the same Availability Zones. As with the availability_zones input, you can specify the suffixes of the AZ IDs, and the module will find the full IDs for you, using the current region.

Support for Karpenter Instance Profile​

Previously, this module created an IAM Role for instances launched by Karpenter, but did not create the corresponding Instance Profile, which was instead created by the eks/karpenter component. This can cause problems if you delete and recreate the cluster, so for new clusters, this module can now create the Instance Profile as well.

Because this is disruptive to existing clusters, this is not enabled by default. To enable it, set the legacy_do_not_create_karpenter_instance_profile input to false, and also set the eks/karpenter input legacy_create_karpenter_instance_profile to false.

Upgrading to v1.250.0​

Components PR #723

Improved support for EKS Add-Ons​

This has improved support for EKS Add-Ons.

Configuration and Timeouts​

The addons input now accepts a configuration_values input to allow you to configure the add-ons, and various timeout inputs to allow you to fine-tune the timeouts for the add-ons.

Automatic IAM Role Creation​

If you enable aws-ebs-csi-driver or vpc-cni add-ons, the module will automatically create the required Service Account IAM Role and attach it to the add-on.

Add-Ons can be deployed to Fargate​

If you are using Karpenter and not provisioning any nodes with this module, the coredns and aws-ebs-csi-driver add-ons can be deployed to Fargate. (They must be able to run somewhere in the cluster or else the deployment will fail.)

To cause the add-ons to be deployed to Fargate, set the deploy_addons_to_fargate input to true.

Note about CoreDNS: If you want to deploy CoreDNS to Fargate, as of this writing you must set the configuration_values input for CoreDNS to '{"computeType": "Fargate"}'. If you want to deploy CoreDNS to EC2 instances, you must NOT include the computeType configuration value.

Availability Zones implied by Private Subnets​

You can now avoid specifying Availability Zones for the cluster anywhere. If all of the possible Availability Zones inputs are empty, the module will use the Availability Zones implied by the private subnets. That is, it will deploy the cluster to all of the Availability Zones in which the VPC has private subnets.

Optional support for 1 Fargate Pod Execution Role per Cluster​

Previously, this module created a separate Fargate Pod Execution Role for each Fargate Profile it created. This is unnecessary, excessive, and can cause problems due to name collisions, but is otherwise merely inefficient, so it is not important to fix this on existiong, working clusters. This update brings a feature that causes the module to create at most 1 Fargate Pod Execution Role per cluster.

This change is recommended for all NEW clusters, but only NEW clusters. Because it is a breaking change, it is not enabled by default. To enable it, set the legacy_fargate_1_role_per_profile_enabled variable to false.

WARNING: If you enable this feature on an existing cluster, and that cluster is using Karpenter, the update could destroy all of your existing Karpenter-provisioned nodes. Depending on your Karpenter version, this could leave you with stranded EC2 instances (still running, but not managed by Karpenter or visible to the cluster) and an interruption of service, and possibly other problems. If you are using Karpenter and want to enable this feature, the safest way is to destroy the existing cluster and create a new one with this feature enabled.