Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-eks-node-group/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse/terraform-aws-eks-node-group/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-eks-node-group.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-eks-node-group/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-eks-node-group.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

Terraform module to provision an EKS Managed Node Group for Elastic Kubernetes Service.

Instantiate it multiple times to create EKS Managed Node Groups with specific settings such as GPUs, EC2 instance types, or autoscale parameters.

IMPORTANT: When SSH access is enabled without specifying a source security group, this module provisions EKS Node Group nodes that are globally accessible by SSH (22) port. Normally, AWS recommends that no security group allows unrestricted ingress access to port 22 .

[!TIP]

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>

Introduction

This module creates an EKS Managed Node Group for an EKS cluster. It assumes you have already created an EKS cluster, but you can create the cluster and the node group in the same Terraform configuration. See our full-featured root module (a.k.a. component) eks/cluster for an example of how to do that.

Launch Templates

This module always uses a launch template to create the node group. You can create your own launch template and pass in its ID, or else this module will create one for you.

The AWS default for EKS is that if the launch template is updated, the existing nodes will not be affected. Only new instances added to the node group would get the changes specified in the new launch template. In contrast, when the launch template changes, this module can immediately create a new node group from the new launch template to replace the old one.

See the inputs create_before_destroy and immediately_apply_lt_changes for details about how to control this behavior.

Operating system differences

Currently, EKS supports 4 Operating Systems: Amazon Linux 2, Amazon Linux 2023, Bottlerocket, and Windows Server. This module supports all 4 OSes, but support for detailed configuration of the nodes varies by OS. The 4 inputs:

  1. before_cluster_joining_userdata
  2. kubelet_additional_options
  3. bootstrap_additional_options
  4. after_cluster_joining_userdata

are fully supported for Amazon Linux 2 and Windows, and take advantage of the bootstrap.sh supplied on those AMIs. NONE of these inputs are supported on Bottlerocket. On AL2023, only the first 2 are supported.

Note that for all OSes, you can supply the complete userdata contents, which will be untouched by this module, via userdata_override_base64.

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

βœ… We build it together with your team.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-eks-node-group&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

<details><summary>πŸ“š <strong>Learn More</strong></summary> <br/>

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-eks-node-group&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-eks-node-group&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

</details>

Usage

Major Changes (breaking and otherwise)

With the v3.0.0 release of this module, support for Amazon Linux 2023 (AL2023) has been added, and some breaking changes have been made. Please see the release notes for details.

With the v2.0.0 (a.k.a. v0.25.0) release of this module, it has undergone major breaking changes and added new features. Please see the migration document for details.

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.

Sources of Information

Example Code

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 = "1.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 = "2.x.x"

  availability_zones   = var.availability_zones
  vpc_id               = module.vpc.vpc_id
  igw_id               = [module.vpc.igw_id]
  ipv4_cidr_block      = [module.vpc.vpc_cidr_block]
  nat_gateway_enabled  = true
  nat_instance_enabled = false

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

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

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

  kubernetes_version    = var.kubernetes_version
  oidc_provider_enabled = true

  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     = "3.x.x"

  instance_types        = [var.instance_type]
  subnet_ids            = module.subnets.public_subnet_ids
  min_size              = var.min_size
  max_size              = var.max_size
  cluster_name          = module.eks_cluster.eks_cluster_id
  create_before_destroy = true
  kubernetes_version    = var.kubernetes_version == null || var.kubernetes_version == "" ? [] : [var.kubernetes_version]

  # 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]
}

[!IMPORTANT] In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

<!-- markdownlint-disable -->

Makefile Targets

Available targets:

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

<!-- markdownlint-restore --> <!-- markdownlint-disable -->

Windows Managed Node groups

Windows managed node-groups have a few pre-requisites.

apiVersion: v1
kind: ConfigMap
metadata:
name: amazon-vpc-cni
namespace: kube-system
data:
enable-windows-ipam: "true"
kubernetes_taints = [{
  key    = "WINDOWS"
  value  = "true"
  effect = "NO_SCHEDULE"
}]
  nodeSelector:
    kubernetes.io/os: windows
    kubernetes.io/arch: amd64

https://docs.aws.amazon.com/eks/latest/userguide/windows-support.html

<!-- markdownlint-disable -->

Requirements

NameVersion
<a name="requirement_terraform"></a> terraform>= 1.3.0
<a name="requirement_aws"></a> aws>= 5.8
<a name="requirement_random"></a> random>= 2.0

Providers

NameVersion
<a name="provider_aws"></a> aws>= 5.8
<a name="provider_random"></a> random>= 2.0

Modules

NameSourceVersion
<a name="module_label"></a> labelcloudposse/label/null0.25.0
<a name="module_ssh_access"></a> ssh_accesscloudposse/security-group/aws2.2.0
<a name="module_this"></a> thiscloudposse/label/null0.25.0

Resources

NameType
aws_eks_node_group.cbdresource
aws_eks_node_group.defaultresource
aws_iam_policy.ipv6_eks_cni_policyresource
aws_iam_role.defaultresource
aws_iam_role_policy_attachment.amazon_ec2_container_registry_read_onlyresource
aws_iam_role_policy_attachment.amazon_eks_worker_node_policyresource
aws_iam_role_policy_attachment.existing_policies_for_eks_workers_roleresource
aws_iam_role_policy_attachment.ipv6_eks_cni_policyresource
aws_launch_template.defaultresource
random_pet.cbdresource
aws_ami.windows_amidata source
aws_eks_cluster.thisdata source
aws_iam_policy_document.assume_roledata source
aws_iam_policy_document.ipv6_eks_cni_policydata source
aws_launch_template.thisdata source
aws_partition.currentdata source
aws_ssm_parameter.ami_iddata source

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.map(string){}no
<a name="input_after_cluster_joining_userdata"></a> after_cluster_joining_userdataAdditional bash commands to execute on each worker node after joining the EKS cluster (after executing the bootstrap.sh script). For more info, see https://kubedex.com/90-days-of-aws-eks-in-productionlist(string)[]no
<a name="input_ami_image_id"></a> ami_image_idAMI to use, overriding other AMI specifications, but must match ami_type. Ignored if launch_template_id is supplied.list(string)[]no
<a name="input_ami_release_version"></a> ami_release_versionThe EKS AMI "release version" to use. Defaults to the latest recommended version.<br/>For Amazon Linux, it is the "Release version" from Amazon AMI Releases<br/>For Bottlerocket, it is the release tag from Bottlerocket Releases without the "v" prefix.<br/>For Windows, it is "AMI version" from AWS docs.<br/>Note that unlike AMI names, release versions never include the "v" prefix.<br/>Examples:<br/> AL2: 1.29.3-20240531<br/> Bottlerocket: 1.2.0 or 1.2.0-ccf1b754<br/> Windows: 1.29-2024.04.09list(string)[]no
<a name="input_ami_type"></a> ami_typeType of Amazon Machine Image (AMI) associated with the EKS Node Group.<br/>Defaults to AL2_x86_64. Valid values: AL2_x86_64, AL2_x86_64_GPU, AL2_ARM_64, CUSTOM, BOTTLEROCKET_ARM_64, BOTTLEROCKET_x86_64, BOTTLEROCKET_ARM_64_NVIDIA, BOTTLEROCKET_x86_64_NVIDIA, WINDOWS_CORE_2019_x86_64, WINDOWS_FULL_2019_x86_64, WINDOWS_CORE_2022_x86_64, WINDOWS_FULL_2022_x86_64, AL2023_x86_64_STANDARD, AL2023_ARM_64_STANDARD.string"AL2_x86_64"no
<a name="input_associate_cluster_security_group"></a> associate_cluster_security_groupWhen true, associate the default cluster security group to the nodes. If disabled the EKS managed security group will not<br/>be associated to the nodes and you will need to provide another security group that allows the nodes to communicate with<br/>the EKS control plane. Be aware that if no associated_security_group_ids or ssh_access_security_group_ids are provided,<br/>then the nodes will have no inbound or outbound rules.booltrueno
<a name="input_associated_security_group_ids"></a> associated_security_group_idsA list of IDs of Security Groups to associate the node group with, in addition to the EKS' created security group.<br/>These security groups will not be modified.list(string)[]no
<a name="input_attributes"></a> attributesID element. Additional attributes (e.g. workers or cluster) to add to id,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the delimiter<br/>and treated as a single ID element.list(string)[]no
<a name="input_before_cluster_joining_userdata"></a> before_cluster_joining_userdataAdditional bash commands to execute on each worker node before joining the EKS cluster (before executing the bootstrap.sh script). For more info, see https://kubedex.com/90-days-of-aws-eks-in-productionlist(string)[]no
<a name="input_block_device_map"></a> block_device_mapMap of block device name specification, see launch_template.block-devices.<pre>map(object({<br/> no_device = optional(bool, null)<br/> virtual_name = optional(string, null)<br/> ebs = optional(object({<br/> delete_on_termination = optional(bool, true)<br/> encrypted = optional(bool, true)<br/> iops = optional(number, null)<br/> kms_key_id = optional(string, null)<br/> snapshot_id = optional(string, null)<br/> throughput = optional(number, null)<br/> volume_size = optional(number, 20)<br/> volume_type = optional(string, "gp3")<br/> }))<br/> }))</pre><pre>{<br/> "/dev/xvda": {<br/> "ebs": {}<br/> }<br/>}</pre>no
<a name="input_block_device_mappings"></a> block_device_mappingsDEPRECATED: Use block_device_map instead.<br/>List of block device mappings for the launch template.<br/>Each list element is an object with a device_name key and<br/>any keys supported by the ebs block of launch_template.list(any)nullno
<a name="input_bootstrap_additional_options"></a> bootstrap_additional_optionsAdditional options to bootstrap.sh. DO NOT include --kubelet-additional-args, use kubelet_additional_options var instead. Not used with AL2023 AMI types.list(string)[]no
<a name="input_capacity_type"></a> capacity_typeType of capacity associated with the EKS Node Group. Valid values: "ON_DEMAND", "SPOT", or null.<br/>Terraform will only perform drift detection if a configuration value is provided.stringnullno
<a name="input_cluster_autoscaler_enabled"></a> cluster_autoscaler_enabledOBSOLETE. Used to add support for the Kubernetes Cluster Autoscaler, but additional support is no longer needed.boolnullno
<a name="input_cluster_name"></a> cluster_nameThe name of the EKS clusterstringn/ayes
<a name="input_context"></a> contextSingle object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as null to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.any<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>no
<a name="input_cpu_options"></a> cpu_optionsConfiguration for the cpu_options Configuration Block of the launch template.<br/>Leave list empty for defaults. Pass list with single object with attributes matching the cpu_options block to configure it.<br/>Note that this configures the launch template only. Some elements will be ignored by the Auto Scaling Group<br/>that actually launches instances. Consult AWS documentation for details.list(any)[]no
<a name="input_create_before_destroy"></a> create_before_destroyIf true (default), a new node group will be created before destroying the old one.<br/>If false, the old node group will be destroyed first, causing downtime.<br/>Changing this setting will always cause node group to be replaced.booltrueno
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>{<br/> format = string<br/> labels = list(string)<br/>}<br/>(Type is any so the map values can later be enhanced to provide additional options.)<br/>format is a Terraform format string to be passed to the format() function.<br/>labels is a list of labels, in order, to pass to format() function.<br/>Label values will be normalized before being passed to format() so they will be<br/>identical to how they appear in id.<br/>Default is {} (descriptors output will be empty).any{}no
<a name="input_desired_size"></a> desired_sizeInitial desired number of worker nodes (external changes ignored)numbern/ayes
<a name="input_detailed_monitoring_enabled"></a> detailed_monitoring_enabledThe launched EC2 instance will have detailed monitoring enabled. Defaults to falseboolfalseno
<a name="input_ebs_optimized"></a> ebs_optimizedSet false to disable EBS optimizationbooltrueno
<a name="input_ec2_ssh_key_name"></a> ec2_ssh_key_nameSSH key pair name to use to access the worker nodeslist(string)[]no
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_enclave_enabled"></a> enclave_enabledSet to true to enable Nitro Enclaves on the instance.boolfalseno
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_force_update_version"></a> force_update_versionWhen updating the Kubernetes version, force Pods to be removed even if PodDisruptionBudget or taint/toleration issues would otherwise prevent them from being removed (and cause the update to fail)boolfalseno
<a name="input_id_length_limit"></a> id_length_limitLimit id to this many characters (minimum 6).<br/>Set to 0 for unlimited length.<br/>Set to null for keep the existing setting, which defaults to 0.<br/>Does not affect id_full.numbernullno
<a name="input_immediately_apply_lt_changes"></a> immediately_apply_lt_changesWhen true, any change to the launch template will be applied immediately.<br/>When false, the changes will only affect new nodes when they are launched.<br/>When null (default) this input takes the value of create_before_destroy.<br/>NOTE: Setting this to false does not guarantee that other changes,<br/>such as ami_type, will not cause changes to be applied immediately.boolnullno
<a name="input_instance_types"></a> instance_typesInstance types to use for this node group (up to 20). Defaults to ["t3.medium"].<br/>Must be empty if the launch template configured by launch_template_id specifies an instance type.list(string)<pre>[<br/> "t3.medium"<br/>]</pre>no
<a name="input_kubelet_additional_options"></a> kubelet_additional_optionsAdditional flags to pass to kubelet.<br/>DO NOT include --node-labels or --node-taints,<br/>use kubernetes_labels and kubernetes_taints to specify those."list(string)[]no
<a name="input_kubernetes_labels"></a> kubernetes_labelsKey-value mapping of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument.<br/>Other Kubernetes labels applied to the EKS Node Group will not be managed.map(string){}no
<a name="input_kubernetes_taints"></a> kubernetes_taintsList of key, value, effect objects representing Kubernetes taints.<br/>effect must be one of NO_SCHEDULE, NO_EXECUTE, or PREFER_NO_SCHEDULE.<br/>key and effect are required, value may be null.<pre>list(object({<br/> key = string<br/> value = optional(string)<br/> effect = string<br/> }))</pre>[]no
<a name="input_kubernetes_version"></a> kubernetes_versionKubernetes version. Defaults to EKS Cluster Kubernetes version. Terraform will only perform drift detection if a configuration value is providedlist(string)[]no
<a name="input_label_key_case"></a> label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the tags input.<br/>Possible values: lower, title, upper.<br/>Default value: title.stringnullno
<a name="input_label_order"></a> label_orderThe order in which the labels (ID elements) appear in the id.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.list(string)nullno
<a name="input_label_value_case"></a> label_value_caseControls the letter case of ID elements (labels) as included in id,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the tags input.<br/>Possible values: lower, title, upper and none (no transformation).<br/>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br/>Default value: lower.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the tags output.<br/>Set to [] to suppress all generated tags.<br/>Notes:<br/> The value of the name tag, if included, will be the id, not the name.<br/> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.set(string)<pre>[<br/> "default"<br/>]</pre>no
<a name="input_launch_template_id"></a> launch_template_idThe ID (not name) of a custom launch template to use for the EKS node group. If provided, it must specify the AMI image ID.list(string)[]no
<a name="input_launch_template_version"></a> launch_template_versionThe version of the specified launch template to use. Defaults to latest version.list(string)[]no
<a name="input_max_size"></a> max_sizeMaximum number of worker nodesnumbern/ayes
<a name="input_metadata_http_endpoint_enabled"></a> metadata_http_endpoint_enabledSet false to disable the Instance Metadata Service.booltrueno
<a name="input_metadata_http_put_response_hop_limit"></a> metadata_http_put_response_hop_limitThe desired HTTP PUT response hop limit (between 1 and 64) for Instance Metadata Service requests.<br/>The default is 2 to allows containerized workloads assuming the instance profile, but it's not really recomended. You should use OIDC service accounts instead.number2no
<a name="input_metadata_http_tokens_required"></a> metadata_http_tokens_requiredSet true to require IMDS session tokens, disabling Instance Metadata Service Version 1.booltrueno
<a name="input_min_size"></a> min_sizeMinimum number of worker nodesnumbern/ayes
<a name="input_module_depends_on"></a> module_depends_onCan be any value desired. Module will wait for this value to be computed before creating node group.anynullno
<a name="input_name"></a> nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a tag.<br/>The "name" tag is set to the full id string. There is no tag with the value of the name input.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_node_group_terraform_timeouts"></a> node_group_terraform_timeoutsConfiguration for the Terraform timeouts Configuration Block of the node group resource.<br/>Leave list empty for defaults. Pass list with single object with attributes matching the timeouts block to configure it.<br/>Leave attribute values null to preserve individual defaults while setting others.<pre>list(object({<br/> create = optional(string)<br/> update = optional(string)<br/> delete = optional(string)<br/> }))</pre>[]no
<a name="input_node_role_arn"></a> node_role_arnIf provided, assign workers the given role, which this module will not modifylist(string)[]no
<a name="input_node_role_cni_policy_enabled"></a> node_role_cni_policy_enabledWhen true, the AmazonEKS_CNI_Policy will be attached to the node IAM role.<br/>This used to be required, but it is now recommended that this policy be<br/>attached only to the aws-node Kubernetes service account. However, that<br/>is difficult to do with Terraform, so this module defaults to the old pattern.booltrueno
<a name="input_node_role_permissions_boundary"></a> node_role_permissions_boundaryIf provided, all IAM roles will be created with this permissions boundary attached.stringnullno
<a name="input_node_role_policy_arns"></a> node_role_policy_arnsList of policy ARNs to attach to the worker role this module creates in addition to the default oneslist(string)[]no
<a name="input_placement"></a> placementConfiguration for the placement Configuration Block of the launch template.<br/>Leave list empty for defaults. Pass list with single object with attributes matching the placement block to configure it.<br/>Note that this configures the launch template only. Some elements will be ignored by the Auto Scaling Group<br/>that actually launches instances. Consult AWS documentation for details.list(any)[]no
<a name="input_random_pet_length"></a> random_pet_lengthIn order to support "create before destroy" behavior, this module uses the random_pet<br/>resource to generate a unique pet name for the node group, since the node group name<br/>must be unique, meaning the new node group must have a different name than the old one.<br/>This variable controls the length of the pet name, meaning the number of pet names<br/>concatenated together. This module defaults to 1, but there are only 452 names available,<br/>so users with large numbers of node groups may want to increase this value.number1no
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.stringnullno
<a name="input_replace_node_group_on_version_update"></a> replace_node_group_on_version_updateForce Node Group replacement when updating to a new Kubernetes version. If set to false (the default), the Node Groups will be updated in-placeboolfalseno
<a name="input_resources_to_tag"></a> resources_to_tagList of auto-launched resource types to tag. Valid types are "instance", "volume", "elastic-gpu", "spot-instances-request", "network-interface".list(string)<pre>[<br/> "instance",<br/> "volume",<br/> "network-interface"<br/>]</pre>no
<a name="input_ssh_access_security_group_ids"></a> ssh_access_security_group_idsSet of EC2 Security Group IDs to allow SSH access (port 22) to the worker nodes. If you specify ec2_ssh_key, but do not specify this configuration when you create an EKS Node Group, port 22 on the worker nodes is opened to the Internet (0.0.0.0/0)list(string)[]no
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_subnet_ids"></a> subnet_idsA list of subnet IDs to launch resources inlist(string)n/ayes
<a name="input_tags"></a> tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).<br/>Neither the tag keys nor the tag values will be modified by this module.map(string){}no
<a name="input_tenant"></a> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
<a name="input_update_config"></a> update_configConfiguration for the eks_node_group update_config Configuration Block.<br/>Specify exactly one of max_unavailable (node count) or max_unavailable_percentage (percentage of nodes).list(map(number))[]no
<a name="input_userdata_override_base64"></a> userdata_override_base64Many features of this module rely on the bootstrap.sh provided with Amazon Linux, and this module<br/>may generate "user data" that expects to find that script. If you want to use an AMI that is not<br/>compatible with the userdata generated by this module, then use userdata_override_base64 to provide<br/>your own (Base64 encoded) user data. Use "" to prevent any user data from being set.<br/><br/>Setting userdata_override_base64 disables kubernetes_taints, kubelet_additional_options,<br/>before_cluster_joining_userdata, after_cluster_joining_userdata, and bootstrap_additional_options.list(string)[]no

Outputs

NameDescription
<a name="output_WARNING_cluster_autoscaler_enabled"></a> WARNING_cluster_autoscaler_enabledWARNING
<a name="output_eks_node_group_ami_id"></a> eks_node_group_ami_idThe ID of the AMI used for the worker nodes, if specified
<a name="output_eks_node_group_arn"></a> eks_node_group_arnAmazon Resource Name (ARN) of the EKS Node Group
<a name="output_eks_node_group_cbd_pet_name"></a> eks_node_group_cbd_pet_nameThe pet name of this node group, if this module generated one
<a name="output_eks_node_group_id"></a> eks_node_group_idEKS Cluster name and EKS Node Group name separated by a colon
<a name="output_eks_node_group_launch_template_id"></a> eks_node_group_launch_template_idThe ID of the launch template used for this node group
<a name="output_eks_node_group_launch_template_name"></a> eks_node_group_launch_template_nameThe name of the launch template used for this node group
<a name="output_eks_node_group_remote_access_security_group_id"></a> eks_node_group_remote_access_security_group_idThe ID of the security group generated to allow SSH access to the nodes, if this module generated one
<a name="output_eks_node_group_resources"></a> eks_node_group_resourcesList of objects containing information about underlying resources of the EKS Node Group
<a name="output_eks_node_group_role_arn"></a> eks_node_group_role_arnARN of the worker nodes IAM role
<a name="output_eks_node_group_role_name"></a> eks_node_group_role_nameName of the worker nodes IAM role
<a name="output_eks_node_group_status"></a> eks_node_group_statusStatus of the EKS Node Group
<a name="output_eks_node_group_tags_all"></a> eks_node_group_tags_allA map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
<!-- markdownlint-restore -->

Related Projects

Check out these related projects.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse/terraform-aws-eks-node-group/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-eks-node-group&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

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

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. 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!

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

πŸ“° Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β€” and usually a 5-minute read.

πŸ“† Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-eks-node-group&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>

<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>

Complete license is available in the LICENSE file.

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

Trademarks

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


Copyright Β© 2017-2024 Cloud Posse, LLC

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-eks-node-group&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-eks-node-group?pixel&cs=github&cm=readme&an=terraform-aws-eks-node-group"/>