Version: Latest

Module: `eks-workers`

Terraform module to provision AWS resources to run EC2 worker nodes for Elastic Kubernetes Service.

Instantiate it multiple times to create many EKS worker node pools with specific settings such as GPUs, EC2 instance types, or autoscale parameters.

Introduction

The module provisions the following resources:

IAM Role and Instance Profile to allow Kubernetes nodes to access other AWS services
Security Group with rules for EKS workers to allow networking traffic
AutoScaling Group with Launch Template to configure and launch worker instances
AutoScaling Policies and CloudWatch Metric Alarms to monitor CPU utilization on the EC2 instances and scale the number of instance in the AutoScaling Group up or down. If you don't want to use the provided functionality, or want to provide your own policies, disable it by setting the variable autoscaling_policies_enabled to "false".

Usage

For a complete example, see examples/complete

  provider "aws" {
    region = var.region
  }

  locals {
    # 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 = merge(var.tags, map("kubernetes.io/cluster/${var.cluster_name}", "shared"))
  }

  module "vpc" {
    source  = "cloudposse/vpc/aws"
    version = "2.1.1"

    namespace = var.namespace
    stage     = var.stage
    name      = var.name

    ipv4_primary_cidr_block = "172.16.0.0/16"
    tags                    = local.tags
  }

  module "subnets" {
    source  = "cloudposse/dynamic-subnets/aws"
    version = "2.4.1"

    namespace = var.namespace
    stage     = var.stage
    name      = var.name

    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  = false
    nat_instance_enabled = false
    tags                 = local.tags
  }

  module "eks_workers" {
    source = "cloudposse/eks-workers/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
    namespace                          = var.namespace
    stage                              = var.stage
    name                               = var.name
    instance_type                      = var.instance_type
    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                       = var.cluster_name
    cluster_endpoint                   = var.cluster_endpoint
    cluster_certificate_authority_data = var.cluster_certificate_authority_data
    cluster_security_group_id          = var.cluster_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
  }

Variables

Required Variables

cluster_certificate_authority_data (string) required: The base64 encoded certificate data required to communicate with the cluster
cluster_endpoint (string) required: EKS cluster endpoint
cluster_name (string) required: The name of the EKS cluster
cluster_security_group_id (string) required: Security Group ID of the EKS cluster
instance_type (string) required: Instance type to launch
max_size (number) required: The maximum size of the autoscale group
min_size (number) required: The minimum size of the autoscale group
subnet_ids (list(string)) required: A list of subnet IDs to launch resources in
vpc_id (string) required: VPC ID for the EKS cluster

Optional Variables

additional_security_group_ids (list(string)) optional

Additional list of security groups that will be attached to the autoscaling group

Default value: [ ]

after_cluster_joining_userdata (string) optional

Additional commands to execute on each worker node after joining the EKS cluster (after executing the bootstrap.sh script). For mot info, see https://kubedex.com/90-days-of-aws-eks-in-production

Default value: ""

allowed_cidr_blocks (list(string)) optional

List of CIDR blocks to be allowed to connect to the worker nodes

Default value: [ ]

allowed_security_groups (list(string)) optional

List of Security Group IDs to be allowed to connect to the worker nodes

Default value: [ ]

associate_public_ip_address (bool) optional

Associate a public IP address with an instance in a VPC

Default value: false

autoscaling_group_tags (map(string)) optional

Additional tags only for the autoscaling group, e.g. "k8s.io/cluster-autoscaler/node-template/taint/dedicated" = "ci-cd:NoSchedule".

Default value: { }

autoscaling_policies_enabled (bool) optional

Whether to create aws_autoscaling_policy and aws_cloudwatch_metric_alarm resources to control Auto Scaling

Default value: true

aws_iam_instance_profile_name (string) optional

The name of the existing instance profile that will be used in autoscaling group for EKS workers. If empty will create a new instance profile.

Default value: ""

before_cluster_joining_userdata (string) optional

Additional commands to execute on each worker node before joining the EKS cluster (before executing the bootstrap.sh script). For mot info, see https://kubedex.com/90-days-of-aws-eks-in-production

Default value: ""

block_device_mappings optional

Specify volumes to attach to the instance besides the volumes specified by the AMI

Type:

list(object({
device_name  = string
no_device    = bool
virtual_name = string
ebs = object({
  delete_on_termination = bool
  encrypted             = bool
  iops                  = number
  kms_key_id            = string
  snapshot_id           = string
  volume_size           = number
  volume_type           = string
})
}))

Default value: [ ]

bootstrap_extra_args (string) optional

Extra arguments to the bootstrap.sh script to enable --enable-docker-bridge or --use-max-pods

Default value: ""

cluster_security_group_ingress_enabled (bool) optional

Whether to enable the EKS cluster Security Group as ingress to workers Security Group

Default value: true

cpu_utilization_high_evaluation_periods (number) optional

The number of periods over which data is compared to the specified threshold

Default value: 2

cpu_utilization_high_period_seconds (number) optional

The period in seconds over which the specified statistic is applied

Default value: 300

cpu_utilization_high_statistic (string) optional

The statistic to apply to the alarm's associated metric. Either of the following is supported: SampleCount, Average, Sum, Minimum, Maximum

Default value: "Average"

cpu_utilization_high_threshold_percent (number) optional

The value against which the specified statistic is compared

Default value: 90

cpu_utilization_low_evaluation_periods (number) optional

The number of periods over which data is compared to the specified threshold

Default value: 2

cpu_utilization_low_period_seconds (number) optional

The period in seconds over which the specified statistic is applied

Default value: 300

cpu_utilization_low_statistic (string) optional

The statistic to apply to the alarm's associated metric. Either of the following is supported: SampleCount, Average, Sum, Minimum, Maximum

Default value: "Average"

cpu_utilization_low_threshold_percent (number) optional

The value against which the specified statistic is compared

Default value: 10

credit_specification optional

Customize the credit specification of the instances

Type:

object({
cpu_credits = string
})

Default value: null

default_cooldown (number) optional

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start

Default value: 300

disable_api_termination (bool) optional

If true, enables EC2 Instance Termination Protection

Default value: false

ebs_optimized (bool) optional

If true, the launched EC2 instance will be EBS-optimized

Default value: false

eks_worker_ami_name_filter (string) optional

AMI name filter to lookup the most recent EKS AMI if image_id is not provided

Default value: "amazon-eks-node-*"

eks_worker_ami_name_regex (string) optional

A regex string to apply to the AMI list returned by AWS

Default value: "^amazon-eks-node-[0-9,.]+-v[0-9]{8}$"

elastic_gpu_specifications optional

Specifications of Elastic GPU to attach to the instances

Type:

object({
type = string
})

Default value: null

enable_monitoring (bool) optional

Enable/disable detailed monitoring

Default value: true

enabled_metrics (list(string)) optional

A list of metrics to collect. The allowed values are GroupMinSize, GroupMaxSize, GroupDesiredCapacity, GroupInServiceInstances, GroupPendingInstances, GroupStandbyInstances, GroupTerminatingInstances, GroupTotalInstances

Default value:

[
  "GroupMinSize",
  "GroupMaxSize",
  "GroupDesiredCapacity",
  "GroupInServiceInstances",
  "GroupPendingInstances",
  "GroupStandbyInstances",
  "GroupTerminatingInstances",
  "GroupTotalInstances"
]

force_delete (bool) optional

Allows deleting the autoscaling group without waiting for all instances in the pool to terminate. You can force an autoscaling group to delete even if it's in the process of scaling a resource. Normally, Terraform drains all the instances before deleting the group. This bypasses that behavior and potentially leaves resources dangling

Default value: false

health_check_grace_period (number) optional

Time (in seconds) after instance comes into service before checking health

Default value: 300

health_check_type (string) optional

Controls how health checking is done. Valid values are EC2 or ELB

Default value: "EC2"

image_id (string) optional

EC2 image ID to launch. If not provided, the module will lookup the most recent EKS AMI. See https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html for more details on EKS-optimized images

Default value: ""

instance_initiated_shutdown_behavior (string) optional

Shutdown behavior for the instances. Can be stop or terminate

Default value: "terminate"

instance_market_options optional

The market (purchasing) option for the instances

Type:

object({
market_type = string
spot_options = object({
  block_duration_minutes         = number
  instance_interruption_behavior = string
  max_price                      = number
  spot_instance_type             = string
  valid_until                    = string
})
})

Default value: null

key_name (string) optional

SSH key name that should be used for the instance

Default value: ""

kubelet_extra_args (string) optional

Extra arguments to pass to kubelet, like "--register-with-taints=dedicated=ci-cd:NoSchedule --node-labels=purpose=ci-worker"

Default value: ""

load_balancers (list(string)) optional

A list of elastic load balancer names to add to the autoscaling group. Only valid for classic load balancers. For ALBs, use target_group_arns instead

Default value: [ ]

max_instance_lifetime (number) optional

The maximum amount of time, in seconds, that an instance can be in service, values must be either equal to 0 or between 604800 and 31536000 seconds

Default value: null

metadata_http_endpoint_enabled (bool) optional

Set false to disable the Instance Metadata Service.

Default value: true

metadata_http_put_response_hop_limit (number) optional

The desired HTTP PUT response hop limit (between 1 and 64) for Instance Metadata Service requests.
The default is 2 to support containerized workloads.

Default value: 2

metadata_http_tokens_required (bool) optional

Set true to require IMDS session tokens, disabling Instance Metadata Service Version 1.

Default value: true

metrics_granularity (string) optional

The granularity to associate with the metrics to collect. The only valid value is 1Minute

Default value: "1Minute"

min_elb_capacity (number) optional

Setting this causes Terraform to wait for this number of instances to show up healthy in the ELB only on creation. Updates will not wait on ELB instance number changes

Default value: 0

mixed_instances_policy optional

policy to used mixed group of on demand/spot of differing types. Launch template is automatically generated. https://www.terraform.io/docs/providers/aws/r/autoscaling_group.html#mixed_instances_policy-1

Type:

object({
instances_distribution = object({
  on_demand_allocation_strategy            = string
  on_demand_base_capacity                  = number
  on_demand_percentage_above_base_capacity = number
  spot_allocation_strategy                 = string
  spot_instance_pools                      = number
  spot_max_price                           = string
})
override = list(object({
  instance_type     = string
  weighted_capacity = number
}))
})

Default value: null

placement optional

The placement specifications of the instances

Type:

object({
affinity          = string
availability_zone = string
group_name        = string
host_id           = string
tenancy           = string
})

Default value: null

placement_group (string) optional

The name of the placement group into which you'll launch your instances, if any

Default value: ""

protect_from_scale_in (bool) optional

Allows setting instance protection. The autoscaling group will not select instances with this setting for terminination during scale in events

Default value: false

scale_down_adjustment_type (string) optional

Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity and PercentChangeInCapacity

Default value: "ChangeInCapacity"

scale_down_cooldown_seconds (number) optional

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start

Default value: 300

scale_down_policy_type (string) optional

The scalling policy type, either SimpleScaling, StepScaling or TargetTrackingScaling

Default value: "SimpleScaling"

scale_down_scaling_adjustment (number) optional

The number of instances by which to scale. scale_down_scaling_adjustment determines the interpretation of this number (e.g. as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity

Default value: -1

scale_up_adjustment_type (string) optional

Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity and PercentChangeInCapacity

Default value: "ChangeInCapacity"

scale_up_cooldown_seconds (number) optional

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start

Default value: 300

scale_up_policy_type (string) optional

The scalling policy type, either SimpleScaling, StepScaling or TargetTrackingScaling

Default value: "SimpleScaling"

scale_up_scaling_adjustment (number) optional

The number of instances by which to scale. scale_up_adjustment_type determines the interpretation of this number (e.g. as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity

Default value: 1

service_linked_role_arn (string) optional

The ARN of the service-linked role that the ASG will use to call other AWS services

Default value: ""

suspended_processes (list(string)) optional

A list of processes to suspend for the AutoScaling Group. The allowed values are Launch, Terminate, HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions, AddToLoadBalancer. Note that if you suspend either the Launch or Terminate process types, it can prevent your autoscaling group from functioning properly.

Default value: [ ]

target_group_arns (list(string)) optional

A list of aws_alb_target_group ARNs, for use with Application Load Balancing

Default value: [ ]

termination_policies (list(string)) optional

A list of policies to decide how the instances in the auto scale group should be terminated. The allowed values are OldestInstance, NewestInstance, OldestLaunchConfiguration, ClosestToNextInstanceHour, Default

Default value:

[
  "Default"
]

use_custom_image_id (bool) optional

If set to true, will use variable image_id for the EKS workers inside autoscaling group

Default value: false

use_existing_aws_iam_instance_profile (bool) optional

If set to true, will use variable aws_iam_instance_profile_name to run EKS workers using an existing AWS instance profile that was created outside of this module, workaround for error like count cannot be computed

Default value: false

use_existing_security_group (bool) optional

If set to true, will use variable workers_security_group_id to run EKS workers using an existing security group that was created outside of this module, workaround for errors like count cannot be computed

Default value: false

wait_for_capacity_timeout (string) optional

A maximum duration that Terraform should wait for ASG instances to be healthy before timing out. Setting this to '0' causes Terraform to skip all Capacity Waiting behavior

Default value: "10m"

wait_for_elb_capacity (number) optional

Setting this will cause Terraform to wait for exactly this number of healthy instances in all attached load balancers on both create and update operations. Takes precedence over min_elb_capacity behavior

Default value: 0

workers_role_policy_arns (list(string)) optional

List of policy ARNs that will be attached to the workers default role on creation

Default value: [ ]

workers_role_policy_arns_count (number) optional

Count of policy ARNs that will be attached to the workers default role on creation. Needed to prevent Terraform error count can't be computed

Default value: 0

workers_security_group_id (string) optional

The name of the existing security group that will be used in autoscaling group for EKS workers. If empty, a new security group will be created

Default value: ""

Context Variables

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

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

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

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

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

Default value: null

environment (string) optional

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

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

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

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

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

Default value: null

tags (map(string)) optional

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

Required: No

Default value: { }

tenant (string) optional

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

Default value: null

Outputs

autoscaling_group_arn: ARN of the AutoScaling Group
autoscaling_group_default_cooldown: Time between a scaling activity and the succeeding scaling activity
autoscaling_group_desired_capacity: The number of Amazon EC2 instances that should be running in the group
autoscaling_group_health_check_grace_period: Time after instance comes into service before checking health
autoscaling_group_health_check_type: EC2 or ELB. Controls how health checking is done
autoscaling_group_id: The AutoScaling Group ID
autoscaling_group_max_size: The maximum size of the AutoScaling Group
autoscaling_group_min_size: The minimum size of the AutoScaling Group
autoscaling_group_name: The AutoScaling Group name
autoscaling_group_tags: A list of tag settings associated with the AutoScaling Group
launch_template_arn: ARN of the launch template
launch_template_id: The ID of the launch template
security_group_arn: ARN of the worker nodes Security Group
security_group_id: ID of the worker nodes Security Group
security_group_name: Name of the worker nodes Security Group
workers_role_arn: ARN of the worker nodes IAM role
workers_role_name: Name of the worker nodes IAM role

Dependencies

Requirements

terraform, version: >= 1.0
aws, version: >= 5.16.0

Providers

aws, version: >= 5.16.0

Modules

Name	Version	Source	Description
`autoscale_group`	0.40.0	`cloudposse/ec2-autoscale-group/aws`	n/a
`label`	0.25.0	`cloudposse/label/null`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_iam_instance_profile.default (resource)
aws_iam_role.default (resource)
aws_iam_role_policy_attachment.amazon_ec2_container_registry_read_only (resource)
aws_iam_role_policy_attachment.amazon_eks_cni_policy (resource)
aws_iam_role_policy_attachment.amazon_eks_worker_node_policy (resource)
aws_iam_role_policy_attachment.existing_policies_attach_to_eks_workers_role (resource)
aws_security_group.default (resource)
aws_security_group_rule.egress (resource)
aws_security_group_rule.ingress_cidr_blocks (resource)
aws_security_group_rule.ingress_cluster (resource)
aws_security_group_rule.ingress_security_groups (resource)
aws_security_group_rule.ingress_self (resource)

Data Sources

The following data sources are used by this module:

aws_ami.eks_worker (data source)
aws_iam_instance_profile.default (data source)
aws_iam_policy_document.assume_role (data source)
aws_partition.current (data source)

Introduction​

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Introduction

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources