terraform-aws-eks-cluster

Terraform module to provision an EKS cluster on AWS.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Introduction

The module provisions the following resources:

EKS cluster of master nodes that can be used together with the terraform-aws-eks-workers, terraform-aws-eks-node-group and terraform-aws-eks-fargate-profile modules to create a full-blown cluster
IAM Role to allow the cluster to access other AWS services
Optionally, the module creates and automatically applies an authentication ConfigMap (aws-auth) to allow the worker nodes to join the cluster and to add additional users/roles/accounts. (This option is enabled by default, but has some caveats noted below. Set apply_config_map_aws_auth to false to avoid these issues.)

NOTE: Release 2.0.0 (previously released as version 0.45.0) contains some changes that could result in your existing EKS cluster being replaced (destroyed and recreated). To prevent this, follow the instructions in the v1 to v2 migration path.

NOTE: Every Terraform module that provisions an EKS cluster has faced the challenge that access to the cluster is partly controlled by a resource inside the cluster, a ConfigMap called aws-auth. You need to be able to access the cluster through the Kubernetes API to modify the ConfigMap, because there is no AWS API for it. This presents a problem: how do you authenticate to an API endpoint that you have not yet created?

We use the Terraform Kubernetes provider to access the cluster, and it uses the same underlying library that kubectl uses, so configuration is very similar. However, every kind of configuration we have tried has failed at some point.

An authentication token can be retrieved using the aws_eks_cluster_auth data source. This works as long as the token does not expire while Terraform is running, and the token is refreshed during the "plan" phase before trying to refresh the state, and the token does not expire in the interval between "plan" and "apply". Unfortunately, failures of all these types have been seen. Nevertheless, this is the only method that is compatible with Terraform Cloud, so it is the default. It is the only method we fully support until AWS provides an API for managing aws-auth.
After creating the EKS cluster, you can generate a KUBECONFIG file that configures access to it. This works most of the time, but if the file was present and used as part of the configuration to create the cluster, and then the file gets deleted (as would happen in a CI system like Terraform Cloud), Terraform would not cause the file to be regenerated in time to use it to refresh Terraform's state and the "plan" phase will fail. So any KUBECONFIG file has to be managed separately.
An authentication token can be retrieved on demand by using the exec feature of the Kubernetes provider to call aws eks get-token. This requires that the aws CLI be installed and available to Terraform and that it has access to sufficient credentials to perform the authentication and is configured to use them. When those conditions are met, this is the most reliable method, and the one Cloud Posse prefers to use. However, since it has these requirements that are not always easily met, it is not the default method and it is not fully supported.

All of the above methods can face additional challenges when using terraform import to import resources into the Terraform state. The KUBECONFIG file method is the only sure way to import resources, due to Terraform limitations on providers. You will need to create the file, of course, but that is easily done with aws eks update-kubeconfig. Depending on the situation, you may also be able to import resources by setting -var apply_config_map_aws_auth=false during import.

At the moment, the exec option appears to be the most reliable method, so we recommend using it if possible, but because of the extra requirements it has, we use the data source as the default authentication method.

Additional Note: All of the above methods require network connectivity between the host running the terraform command and the EKS endpoint. If your EKS cluster does not have public access enabled, this means you need to take extra steps, such as using a VPN to provide access to the private endpoint, or running terraform on a host in the same VPC as the EKS cluster.

Failure during destroy: If the cluster is destroyed (via Terraform or otherwise) before the Terraform resource responsible for the aws-auth ConfigMap is destroyed, Terraform will get stuck trying to delete the ConfigMap, because it cannot contact the now destroyed cluster. This can show up as a connection refused error (usually to https://localhost/). The easiest ways to handle this is either to add -var apply_config_map_aws_auth=false to the destroy command or to remove the ConfigMap (...kubernetes_config_map.aws_auth[0]) from the Terraform state with terraform state rm.

NOTE: We give you the kubernetes_config_map_ignore_role_changes option and default it to true for the following reasons:

We provision the EKS cluster
Then we wait for the cluster to become available (see null_resource.wait_for_cluster in auth.tf
Then we provision the Kubernetes Auth ConfigMap to map and add additional roles/users/accounts to Kubernetes groups
That is all we do in this module, but after that, we expect you to use terraform-aws-eks-node-group to provision a managed Node Group
Then EKS updates the Auth ConfigMap and adds worker roles to it (for the worker nodes to join the cluster)
Since the ConfigMap is modified outside of Terraform state, Terraform wants to update it to to remove the worker roles EKS added
If you update the ConfigMap without including the worker nodes that EKS added, you will disconnect them from the cluster

However, it is possible to get the worker node roles from the terraform-aws-eks-node-group via Terraform "remote state" and include them with any other roles you want to add (example code to be published later), so we make ignoring the role changes optional. (This is what we do for Cloud Posse clients.) If you do not ignore changes then you will have no problem with making future intentional changes.

The downside of having kubernetes_config_map_ignore_role_changes set to true is that if you later want to make changes, such as adding other IAM roles to Kubernetes groups, you cannot do so via Terraform, because the role changes are ignored. Because of Terraform restrictions, you cannot simply change kubernetes_config_map_ignore_role_changes from true to false, apply changes, and set it back to true again. Terraform does not allow the "ignore" settings to be changed on a resource, so kubernetes_config_map_ignore_role_changes is implemented as 2 different resources, one with ignore settings and one without. If you want to switch from ignoring to not ignoring, or vice versa, you must manually move the aws_auth resource in the terraform state. Change the setting of kubernetes_config_map_ignore_role_changes, run terraform plan, and you will see that an aws_auth resource is planned to be destroyed and another one is planned to be created. Use terraform state mv to move the destroyed resource to the created resource "address", something like

terraform state mv 'module.eks_cluster.kubernetes_config_map.aws_auth_ignore_changes[0]' 'module.eks_cluster.kubernetes_config_map.aws_auth[0]'

Then run terraform plan again and you should see only your desired changes made "in place". After applying your changes, if you want to set kubernetes_config_map_ignore_role_changes back to true, you will again need to use terraform state mv to move the auth-map back to its old "address".

Security & Compliance

Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.

Benchmark	Description
	Infrastructure Security Compliance
	Center for Internet Security, KUBERNETES Compliance
	Center for Internet Security, AWS Compliance
	Center for Internet Security, AZURE Compliance
	Payment Card Industry Data Security Standards Compliance
	National Institute of Standards and Technology Compliance
	Information Security Management System, ISO/IEC 27001 Compliance
	Service Organization Control 2 Compliance
	Center for Internet Security, GCP Compliance
	Health Insurance Portability and Accountability Compliance

Usage

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

Other examples:

terraform-aws-components/eks/cluster - Cloud Posse's service catalog of "root module" invocations for provisioning reference architectures

  provider "aws" {
    region = var.region
  }

  module "label" {
    source = "cloudposse/label/null"
    # Cloud Posse recommends pinning every module to a specific version
    # version  = "x.x.x"

    namespace  = var.namespace
    name       = var.name
    stage      = var.stage
    delimiter  = var.delimiter
    attributes = ["cluster"]
    tags       = var.tags
  }

  locals {
    # Prior to Kubernetes 1.19, the usage of the specific kubernetes.io/cluster/* resource tags below are required
    # for EKS and Kubernetes to discover and manage networking resources
    # https://www.terraform.io/docs/providers/aws/guides/eks-getting-started.html#base-vpc-networking
    tags = { "kubernetes.io/cluster/${module.label.id}" = "shared" }
  }

  module "vpc" {
    source = "cloudposse/vpc/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
    cidr_block = "172.16.0.0/16"

    tags    = local.tags
    context = module.label.context
  }

  module "subnets" {
    source = "cloudposse/dynamic-subnets/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    availability_zones   = var.availability_zones
    vpc_id               = module.vpc.vpc_id
    igw_id               = module.vpc.igw_id
    cidr_block           = module.vpc.vpc_cidr_block
    nat_gateway_enabled  = true
    nat_instance_enabled = false

    tags    = local.tags
    context = module.label.context
  }

  module "eks_node_group" {
    source = "cloudposse/eks-node-group/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    instance_types                     = [var.instance_type]
    subnet_ids                         = module.subnets.public_subnet_ids
    health_check_type                  = var.health_check_type
    min_size                           = var.min_size
    max_size                           = var.max_size
    cluster_name                       = module.eks_cluster.eks_cluster_id

    # Enable the Kubernetes cluster auto-scaler to find the auto-scaling group
    cluster_autoscaler_enabled = var.autoscaling_policies_enabled

    context = module.label.context

    # Ensure the cluster is fully created before trying to add the node group
    module_depends_on = module.eks_cluster.kubernetes_config_map_id
  }

  module "eks_cluster" {
    source = "cloudposse/eks-cluster/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    vpc_id     = module.vpc.vpc_id
    subnet_ids = module.subnets.public_subnet_ids

    kubernetes_version    = var.kubernetes_version
    oidc_provider_enabled = true

    addons = [
      // https://docs.aws.amazon.com/eks/latest/userguide/managing-vpc-cni.html#vpc-cni-latest-available-version
      {
        addon_name                  = "vpc-cni"
        addon_version               = var.vpc_cni_version
        resolve_conflicts_on_create = "NONE"
        resolve_conflicts_on_update = "NONE"
        service_account_role_arn    = null
      },
      // https://docs.aws.amazon.com/eks/latest/userguide/managing-kube-proxy.html
      {
        addon_name                  = "kube-proxy"
        addon_version               = var.kube_proxy_version
        resolve_conflicts_on_create = "NONE"
        resolve_conflicts_on_update = "NONE"
        service_account_role_arn    = null
      },
      // https://docs.aws.amazon.com/eks/latest/userguide/managing-coredns.html
      {
        addon_name                  = "coredns"
        addon_version               = var.coredns_version
        resolve_conflicts_on_create = "NONE"
        resolve_conflicts_on_update = "NONE"
        service_account_role_arn    = null
      },
    ]
    addons_depends_on = [module.eks_node_group]

    context = module.label.context

    cluster_depends_on = [module.subnets]
  }

Module usage with two unmanaged worker groups:

  locals {
    # Unfortunately, the `aws_ami` data source attribute `most_recent` (https://github.com/cloudposse/terraform-aws-eks-workers/blob/34a43c25624a6efb3ba5d2770a601d7cb3c0d391/main.tf#L141)
    # does not work as you might expect. If you are not going to use a custom AMI you should
    # use the `eks_worker_ami_name_filter` variable to set the right kubernetes version for EKS workers,
    # otherwise the first version of Kubernetes supported by AWS (v1.11) for EKS workers will be selected, but
    # EKS control plane will ignore it to use one that matches the version specified by the `kubernetes_version` variable.
    eks_worker_ami_name_filter = "amazon-eks-node-${var.kubernetes_version}*"
  }

  module "eks_workers" {
    source = "cloudposse/eks-workers/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    attributes                         = ["small"]
    instance_type                      = "t3.small"
    eks_worker_ami_name_filter         = local.eks_worker_ami_name_filter
    vpc_id                             = module.vpc.vpc_id
    subnet_ids                         = module.subnets.public_subnet_ids
    health_check_type                  = var.health_check_type
    min_size                           = var.min_size
    max_size                           = var.max_size
    wait_for_capacity_timeout          = var.wait_for_capacity_timeout
    cluster_name                       = module.label.id
    cluster_endpoint                   = module.eks_cluster.eks_cluster_endpoint
    cluster_certificate_authority_data = module.eks_cluster.eks_cluster_certificate_authority_data
    cluster_security_group_id          = module.eks_cluster.eks_cluster_managed_security_group_id

    # Auto-scaling policies and CloudWatch metric alarms
    autoscaling_policies_enabled           = var.autoscaling_policies_enabled
    cpu_utilization_high_threshold_percent = var.cpu_utilization_high_threshold_percent
    cpu_utilization_low_threshold_percent  = var.cpu_utilization_low_threshold_percent

    context = module.label.context
  }

  module "eks_workers_2" {
    source = "cloudposse/eks-workers/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    attributes                         = ["medium"]
    instance_type                      = "t3.medium"
    eks_worker_ami_name_filter         = local.eks_worker_ami_name_filter
    vpc_id                             = module.vpc.vpc_id
    subnet_ids                         = module.subnets.public_subnet_ids
    health_check_type                  = var.health_check_type
    min_size                           = var.min_size
    max_size                           = var.max_size
    wait_for_capacity_timeout          = var.wait_for_capacity_timeout
    cluster_name                       = module.label.id
    cluster_endpoint                   = module.eks_cluster.eks_cluster_endpoint
    cluster_certificate_authority_data = module.eks_cluster.eks_cluster_certificate_authority_data
    cluster_security_group_id          = module.eks_cluster.eks_cluster_managed_security_group_id

    # Auto-scaling policies and CloudWatch metric alarms
    autoscaling_policies_enabled           = var.autoscaling_policies_enabled
    cpu_utilization_high_threshold_percent = var.cpu_utilization_high_threshold_percent
    cpu_utilization_low_threshold_percent  = var.cpu_utilization_low_threshold_percent

    context = module.label.context
  }

  module "eks_cluster" {
    source = "cloudposse/eks-cluster/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    vpc_id     = module.vpc.vpc_id
    subnet_ids = module.subnets.public_subnet_ids

    kubernetes_version    = var.kubernetes_version
    oidc_provider_enabled = false

    workers_role_arns          = [module.eks_workers.workers_role_arn, module.eks_workers_2.workers_role_arn]
    allowed_security_group_ids = [module.eks_workers.security_group_id, module.eks_workers_2.security_group_id]

    context = module.label.context
  }

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 5.0.0
kubernetes	>= 2.7.1
null	>= 2.0
tls	>= 3.1.0, != 4.0.0

Providers

Name	Version
aws	>= 5.0.0
kubernetes	>= 2.7.1
null	>= 2.0
tls	>= 3.1.0, != 4.0.0

Modules

Name	Source	Version
label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_cloudwatch_log_group.default	resource
aws_eks_addon.cluster	resource
aws_eks_cluster.default	resource
aws_iam_openid_connect_provider.default	resource
aws_iam_policy.cluster_elb_service_role	resource
aws_iam_role.default	resource
aws_iam_role_policy_attachment.amazon_eks_cluster_policy	resource
aws_iam_role_policy_attachment.amazon_eks_service_policy	resource
aws_iam_role_policy_attachment.cluster_elb_service_role	resource
aws_kms_alias.cluster	resource
aws_kms_key.cluster	resource
aws_security_group.default	resource
aws_security_group_rule.custom_ingress_rules	resource
aws_security_group_rule.egress	resource
aws_security_group_rule.ingress_cidr_blocks	resource
aws_security_group_rule.ingress_security_groups	resource
aws_security_group_rule.ingress_workers	resource
aws_security_group_rule.managed_ingress_cidr_blocks	resource
aws_security_group_rule.managed_ingress_security_groups	resource
kubernetes_config_map.aws_auth	resource
kubernetes_config_map.aws_auth_ignore_changes	resource
null_resource.wait_for_cluster	resource
aws_eks_cluster_auth.eks	data source
aws_iam_policy_document.assume_role	data source
aws_iam_policy_document.cluster_elb_service_role	data source
aws_partition.current	data source
tls_certificate.cluster	data source

Inputs

Name	Description	Type	Default	Required
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
addons	Manages `aws_eks_addon` resources	list(object({ addon_name = string addon_version = optional(string, null) configuration_values = optional(string, null) resolve_conflicts_on_create = optional(string, null) resolve_conflicts_on_update = optional(string, null) 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_on	If provided, all addons will depend on this object, and therefore not be installed until this object is finalized. This is useful if you want to ensure that addons are not applied before some other condition is met, e.g. node groups are created. See issue #170 for more details.	`any`	`null`	no
allowed_cidr_blocks	A list of IPv4 CIDRs to allow access to the cluster. The length of this list must be known at "plan" time.	`list(string)`	`[]`	no
allowed_security_group_ids	A list of IDs of Security Groups to allow access to the cluster.	`list(string)`	`[]`	no
allowed_security_groups	DEPRECATED: Use `allowed_security_group_ids` instead. Historical description: List of Security Group IDs to be allowed to connect to the EKS cluster. Historical default: `[]`	`list(string)`	`[]`	no
apply_config_map_aws_auth	Whether to apply the ConfigMap to allow worker nodes to join the EKS cluster and allow additional users, accounts and roles to acces the cluster	`bool`	`true`	no
associated_security_group_ids	A list of IDs of Security Groups to associate the cluster with. These security groups will not be modified.	`list(string)`	`[]`	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
aws_auth_yaml_strip_quotes	If true, remove double quotes from the generated aws-auth ConfigMap YAML to reduce spurious diffs in plans	`bool`	`true`	no
cloudwatch_log_group_kms_key_id	If provided, the KMS Key ID to use to encrypt AWS CloudWatch logs	`string`	`null`	no
cluster_attributes	Override label module default cluster attributes	`list(string)`	[ "cluster" ]	no
cluster_depends_on	If provided, the EKS will depend on this object, and therefore not be created until this object is finalized. This is useful if you want to ensure that the cluster is not created before some other condition is met, e.g. VPNs into the subnet are created.	`any`	`null`	no
cluster_encryption_config_enabled	Set to `true` to enable Cluster Encryption Configuration	`bool`	`true`	no
cluster_encryption_config_kms_key_deletion_window_in_days	Cluster Encryption Config KMS Key Resource argument - key deletion windows in days post destruction	`number`	`10`	no
cluster_encryption_config_kms_key_enable_key_rotation	Cluster Encryption Config KMS Key Resource argument - enable kms key rotation	`bool`	`true`	no
cluster_encryption_config_kms_key_id	KMS Key ID to use for cluster encryption config	`string`	`""`	no
cluster_encryption_config_kms_key_policy	Cluster Encryption Config KMS Key Resource argument - key policy	`string`	`null`	no
cluster_encryption_config_resources	Cluster Encryption Config Resources to encrypt, e.g. ['secrets']	`list(any)`	[ "secrets" ]	no
cluster_log_retention_period	Number 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.	`number`	`0`	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_eks_service_role	Set `false` to use existing `eks_cluster_service_role_arn` instead of creating one	`bool`	`true`	no
create_security_group	Set to `true` to create and configure an additional Security Group for the cluster. Only for backwards compatibility, if you are updating this module to the latest version on existing clusters, not recommended for new clusters. EKS creates a managed Security Group for the cluster automatically, places the control plane and managed nodes into the Security Group, and you can also allow unmanaged nodes to communicate with the cluster by using the `allowed_security_group_ids` variable. The additional Security Group is kept in the module for backwards compatibility and will be removed in future releases along with this variable. See https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html for more details.	`bool`	`false`	no
custom_ingress_rules	A List of Objects, which are custom security group rules that	list(object({ description = string from_port = number to_port = number protocol = string source_security_group_id = string }))	`[]`	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
dummy_kubeapi_server	URL of a dummy API server for the Kubernetes server to use when the real one is unknown. This is a workaround to ignore connection failures that break Terraform even though the results do not matter. You can disable it by setting it to `null`; however, as of Kubernetes provider v2.3.2, doing so _will_ cause Terraform to fail in several situations unless you provide a valid `kubeconfig` file via `kubeconfig_path` and set `kubeconfig_path_enabled` to `true`.	`string`	`"https://jsonplaceholder.typicode.com"`	no
eks_cluster_service_role_arn	The ARN of an IAM role for the EKS cluster to use that provides permissions for the Kubernetes control plane to perform needed AWS API operations. Required if `create_eks_service_role` is `false`, ignored otherwise.	`string`	`null`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
enabled_cluster_log_types	A 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
endpoint_private_access	Indicates whether or not the Amazon EKS private API server endpoint is enabled. Default to AWS EKS resource and it is false	`bool`	`false`	no
endpoint_public_access	Indicates whether or not the Amazon EKS public API server endpoint is enabled. Default to AWS EKS resource and it is true	`bool`	`true`	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	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_path_enabled` or `kube_exec_auth_enabled`.	`bool`	`true`	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_path_enabled`, overrides `kube_data_auth_enabled`.	`bool`	`false`	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`	`false`	no
kubeconfig_context	Context to choose from the Kubernetes kube config file	`string`	`""`	no
kubeconfig_path	The Kubernetes provider `config_path` setting to use when `kubeconfig_path_enabled` is `true`	`string`	`""`	no
kubeconfig_path_enabled	If `true`, configure the Kubernetes provider with `kubeconfig_path` and use it for authenticating to the EKS cluster	`bool`	`false`	no
kubernetes_config_map_ignore_role_changes	Set to `true` to ignore IAM role changes in the Kubernetes Auth ConfigMap	`bool`	`true`	no
kubernetes_network_ipv6_enabled	Set true to use IPv6 addresses for Kubernetes pods and services	`bool`	`false`	no
kubernetes_version	Desired Kubernetes master version. If you do not specify a value, the latest available version is used	`string`	`"1.21"`	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
local_exec_interpreter	shell to use for local_exec	`list(string)`	[ "/bin/sh", "-c" ]	no
managed_security_group_rules_enabled	Flag to enable/disable the ingress and egress rules for the EKS managed Security Group	`bool`	`true`	no
map_additional_aws_accounts	Additional AWS account numbers to add to `config-map-aws-auth` ConfigMap	`list(string)`	`[]`	no
map_additional_iam_roles	Additional IAM roles to add to `config-map-aws-auth` ConfigMap	list(object({ rolearn = string username = string groups = list(string) }))	`[]`	no
map_additional_iam_users	Additional IAM users to add to `config-map-aws-auth` ConfigMap	list(object({ userarn = string username = string groups = list(string) }))	`[]`	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
oidc_provider_enabled	Create 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 EKS User Guide.	`bool`	`false`	no
permissions_boundary	If provided, all IAM roles will be created with this permissions boundary attached	`string`	`null`	no
public_access_cidrs	Indicates 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_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	OBSOLETE (not needed): AWS Region	`string`	`null`	no
service_ipv4_cidr	The CIDR block to assign Kubernetes service IP addresses from. You can only specify a custom CIDR block when you create a cluster, changing this value will force a new cluster to be created.	`string`	`null`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
subnet_ids	A list of subnet IDs to launch the cluster in	`list(string)`	n/a	yes
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
vpc_id	VPC ID for the EKS cluster	`string`	n/a	yes
wait_for_cluster_command	`local-exec` command to execute to determine if the EKS cluster is healthy. Cluster endpoint URL is available as environment variable `ENDPOINT`	`string`	`"if test -n \"$ENDPOINT\"; then curl --silent --fail --retry 30 --retry-delay 10 --retry-connrefused --max-time 11 --insecure --output /dev/null $ENDPOINT/healthz; fi"`	no
workers_role_arns	List of Role ARNs of the worker nodes	`list(string)`	`[]`	no
workers_security_group_ids	DEPRECATED: Use `allowed_security_group_ids` instead. Historical description: Security Group IDs of the worker nodes. Historical default: `[]`	`list(string)`	`[]`	no

Outputs

Name	Description
cloudwatch_log_group_kms_key_id	KMS Key ID to encrypt AWS CloudWatch logs
cloudwatch_log_group_name	The name of the log group created in cloudwatch where cluster logs are forwarded to if enabled
cluster_encryption_config_enabled	If true, Cluster Encryption Configuration is enabled
cluster_encryption_config_provider_key_alias	Cluster Encryption Config KMS Key Alias ARN
cluster_encryption_config_provider_key_arn	Cluster Encryption Config KMS Key ARN
cluster_encryption_config_resources	Cluster Encryption Config Resources
eks_cluster_arn	The Amazon Resource Name (ARN) of the cluster
eks_cluster_certificate_authority_data	The Kubernetes cluster certificate authority data
eks_cluster_endpoint	The endpoint for the Kubernetes API server
eks_cluster_id	The name of the cluster
eks_cluster_identity_oidc_issuer	The OIDC Identity issuer for the cluster
eks_cluster_identity_oidc_issuer_arn	The OIDC Identity issuer ARN for the cluster that can be used to associate IAM roles with a service account
eks_cluster_managed_security_group_id	Security Group ID that was created by EKS for the cluster. EKS creates a Security Group and applies it to the ENI that are attached to EKS Control Plane master nodes and to any managed workloads.
eks_cluster_role_arn	ARN of the EKS cluster IAM role
eks_cluster_version	The Kubernetes server version of the cluster
kubernetes_config_map_id	ID of `aws-auth` Kubernetes ConfigMap
security_group_arn	(Deprecated) ARN of the optionally created additional Security Group for the EKS cluster
security_group_id	(Deprecated) ID of the optionally created additional Security Group for the EKS cluster
security_group_name	Name of the optionally created additional Security Group for the EKS cluster

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

terraform-aws-eks-workers - Terraform module to provision an AWS AutoScaling Group, IAM Role, and Security Group for EKS Workers
terraform-aws-ec2-autoscale-group - Terraform module to provision Auto Scaling Group and Launch Template on AWS
terraform-aws-ecs-container-definition - Terraform module to generate well-formed JSON documents (container definitions) that are passed to the aws_ecs_task_definition Terraform resource
terraform-aws-ecs-alb-service-task - Terraform module which implements an ECS service which exposes a web service via ALB
terraform-aws-ecs-web-app - Terraform module that implements a web app on ECS and supports autoscaling, CI/CD, monitoring, ALB integration, and much more
terraform-aws-ecs-codepipeline - Terraform module for CI/CD with AWS Code Pipeline and Code Build for ECS
terraform-aws-ecs-cloudwatch-autoscaling - Terraform module to autoscale ECS Service based on CloudWatch metrics
terraform-aws-ecs-cloudwatch-sns-alarms - Terraform module to create CloudWatch Alarms on ECS Service level metrics
terraform-aws-ec2-instance - Terraform module for providing a general purpose EC2 instance
terraform-aws-ec2-instance-group - Terraform module for provisioning multiple general purpose EC2 hosts for stateful applications

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
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.

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.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Contributing

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 our other projects, we would love to hear from you! Shoot us an email.

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

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!

Copyright

License

See LICENSE for full details.

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.

Trademarks

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

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman	Andriy Knysh	Igor Rodionov	Nuru	Oscar

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

terraform-aws-eks-cluster

Introduction

Security & Compliance

Usage

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Share the Love

Related Projects

Help

DevOps Accelerator for Startups

Slack Community

Discourse Forums

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors

Files

README.md

Latest commit

History

README.md

File metadata and controls

terraform-aws-eks-cluster

Introduction

Security & Compliance

Usage

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Share the Love

Related Projects

Help

DevOps Accelerator for Startups

Slack Community

Discourse Forums

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors