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 module to create a full-blown cluster
IAM Role to allow the cluster to access other AWS services
Security Group which is used by EKS workers to connect to the cluster and kubelets and pods to receive communication from the cluster control plane (see terraform-aws-eks-workers)
The module creates and automatically applies (via kubectl apply) an authentication ConfigMap to allow the wrokers nodes to join the cluster and to add additional users/roles/accounts

Works with Terraform Cloud

To run on Terraform Cloud, set the following variables:

    install_aws_cli                                = true
    install_kubectl                                = true
    external_packages_install_path                 = "~/.terraform/bin"
    kubeconfig_path                                = "~/.kube/config"
    configmap_auth_file                            = "/home/terraform/.terraform/configmap-auth.yaml"

    # Optional
    aws_eks_update_kubeconfig_additional_arguments = "--verbose"
    aws_cli_assume_role_arn                        = "arn:aws:iam::xxxxxxxxxxx:role/OrganizationAccountAccessRole"
    aws_cli_assume_role_session_name               = "eks_cluster_example_session"

Terraform Cloud executes terraform plan/apply on workers running Ubuntu. For the module to provision the authentication ConfigMap (to allow the EKS worker nodes to join the EKS cluster and to add additional users/roles/accounts), AWS CLI and kubectl need to be installed on Terraform Cloud workers.

To install the required external packages, set the variables install_aws_cli and install_kubectl to true and specify external_packages_install_path, kubeconfig_path and configmap_auth_file.

See auth.tf and Installing Software in the Run Environment for more details.

In a multi-account architecture, we might have a separate identity account where we provision all IAM users, and other accounts (e.g. prod, staging, dev, audit, testing) where all other AWS resources are provisioned. The IAM Users from the identity account can assume IAM roles to access the other accounts.

In this case, we provide Terraform Cloud with access keys (AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY) for an IAM User from the identity account and allow it to assume an IAM Role into the AWS account where the module gets provisioned.

To support this, the module can assume an IAM role before executing the command aws eks update-kubeconfig when applying the auth ConfigMap.

Set variable aws_cli_assume_role_arn to the Amazon Resource Name (ARN) of the role to assume and variable aws_cli_assume_role_session_name to the identifier for the assumed role session.

See auth.tf and assume-role for more details.

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

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-root-modules/eks - Cloud Posse's service catalog of "root module" invocations for provisioning reference architectures
terraform-root-modules/eks-backing-services-peering - example of VPC peering between the EKS VPC and backing services VPC

  provider "aws" {
    region = var.region
  }

  module "label" {
    source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master"
    namespace  = var.namespace
    name       = var.name
    stage      = var.stage
    delimiter  = var.delimiter
    attributes = compact(concat(var.attributes, list("cluster")))
    tags       = var.tags
  }

  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/${module.label.id}", "shared"))

    # Unfortunately, most_recent (https://github.com/cloudposse/terraform-aws-eks-workers/blob/34a43c25624a6efb3ba5d2770a601d7cb3c0d391/main.tf#L141)
    # variable does not work as expected, if you are not going to use custom AMI you should
    # enforce usage of 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 used, but
    # EKS control plane will use the version specified by kubernetes_version variable.
    eks_worker_ami_name_filter = "amazon-eks-node-${var.kubernetes_version}*"
  }

  module "vpc" {
    source     = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=master"
    namespace  = var.namespace
    stage      = var.stage
    name       = var.name
    attributes = var.attributes
    cidr_block = "172.16.0.0/16"
    tags       = local.tags
  }

  module "subnets" {
    source               = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=master"
    availability_zones   = var.availability_zones
    namespace            = var.namespace
    stage                = var.stage
    name                 = var.name
    attributes           = var.attributes
    vpc_id               = module.vpc.vpc_id
    igw_id               = module.vpc.igw_id
    cidr_block           = module.vpc.vpc_cidr_block
    nat_gateway_enabled  = false
    nat_instance_enabled = false
    tags                 = local.tags
  }

  module "eks_workers" {
    source                             = "git::https://github.com/cloudposse/terraform-aws-eks-workers.git?ref=master"
    namespace                          = var.namespace
    stage                              = var.stage
    name                               = var.name
    attributes                         = var.attributes
    tags                               = var.tags
    instance_type                      = var.instance_type
    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.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
  }

  module "eks_cluster" {
    source     = "git::https://github.com/cloudposse/terraform-aws-eks-cluster.git?ref=master"
    namespace  = var.namespace
    stage      = var.stage
    name       = var.name
    attributes = var.attributes
    tags       = var.tags
    vpc_id     = module.vpc.vpc_id
    subnet_ids = module.subnets.public_subnet_ids

    kubernetes_version = var.kubernetes_version
    kubeconfig_path    = var.kubeconfig_path

    oidc_provider_enabled = false

    workers_security_group_ids   = [module.eks_workers.security_group_id]
    workers_role_arns            = [module.eks_workers.workers_role_arn]
  }

Module usage with two worker groups:

  module "eks_workers" {
    source                             = "git::https://github.com/cloudposse/terraform-aws-eks-workers.git?ref=master"
    namespace                          = var.namespace
    stage                              = var.stage
    name                               = "small"
    attributes                         = var.attributes
    tags                               = var.tags
    instance_type                      = "t3.small"
    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.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
  }

  module "eks_workers_2" {
    source                             = "git::https://github.com/cloudposse/terraform-aws-eks-workers.git?ref=master"
    namespace                          = var.namespace
    stage                              = var.stage
    name                               = "medium"
    attributes                         = var.attributes
    tags                               = var.tags
    instance_type                      = "t3.medium"
    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.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
  }

  module "eks_cluster" {
    source     = "git::https://github.com/cloudposse/terraform-aws-eks-cluster.git?ref=master"
    namespace  = var.namespace
    stage      = var.stage
    name       = var.name
    attributes = var.attributes
    tags       = var.tags
    vpc_id     = module.vpc.vpc_id
    subnet_ids = module.subnets.public_subnet_ids

    kubernetes_version = var.kubernetes_version
    kubeconfig_path    = var.kubeconfig_path

    oidc_provider_enabled = false

    workers_role_arns          = [module.eks_workers.workers_role_arn, module.eks_workers_2.workers_role_arn]
    workers_security_group_ids = [module.eks_workers.security_group_id, module.eks_workers_2.security_group_id]
  }

Module usage on Terraform Cloud:

  provider "aws" {
    region = "us-east-2"

    assume_role {
      role_arn = "arn:aws:iam::xxxxxxxxxxx:role/OrganizationAccountAccessRole"
    }
  }

  module "eks_cluster" {
    source                 = "git::https://github.com/cloudposse/terraform-aws-eks-cluster.git?ref=master"
    namespace              = var.namespace
    stage                  = var.stage
    name                   = var.name
    attributes             = var.attributes
    tags                   = var.tags
    region                 = "us-east-2"
    vpc_id                 = module.vpc.vpc_id
    subnet_ids             = module.subnets.public_subnet_ids

    local_exec_interpreter = "/bin/bash"
    kubernetes_version     = "1.14"

    workers_role_arns          = [module.eks_workers.workers_role_arn]
    workers_security_group_ids = [module.eks_workers.security_group_id]

    # Terraform Cloud configurations
    kubeconfig_path                                = "~/.kube/config"
    configmap_auth_file                            = "/home/terraform/.terraform/configmap-auth.yaml"
    install_aws_cli                                = true
    install_kubectl                                = true
    external_packages_install_path                 = "~/.terraform/bin"
    aws_eks_update_kubeconfig_additional_arguments = "--verbose"
    aws_cli_assume_role_arn                        = "arn:aws:iam::xxxxxxxxxxx:role/OrganizationAccountAccessRole"
    aws_cli_assume_role_session_name               = "eks_cluster_example_session"
  }

Makefile Targets

Available targets:

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

Inputs

Name	Description	Type	Default	Required
allowed_cidr_blocks	List of CIDR blocks to be allowed to connect to the EKS cluster	list(string)	`<list>`	no
allowed_security_groups	List of Security Group IDs to be allowed to connect to the EKS cluster	list(string)	`<list>`	no
apply_config_map_aws_auth	Whether to execute `kubectl apply` to apply the ConfigMap to allow worker nodes to join the EKS cluster	bool	`true`	no
associate_public_ip_address	Associate a public IP address with an instance in a VPC	bool	`true`	no
attributes	Additional attributes (e.g. `1`)	list(string)	`<list>`	no
aws_cli_assume_role_arn	IAM Role ARN for AWS CLI to assume before calling `aws eks` to update `kubeconfig`	string	``	no
aws_cli_assume_role_session_name	An identifier for the assumed role session when assuming the IAM Role for AWS CLI before calling `aws eks` to update `kubeconfig`	string	``	no
aws_eks_update_kubeconfig_additional_arguments	Additional arguments for `aws eks update-kubeconfig` command, e.g. `--role-arn xxxxxxxxx`. For more info, see https://docs.aws.amazon.com/cli/latest/reference/eks/update-kubeconfig.html	string	``	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
configmap_auth_file	Path to `configmap_auth_file`	string	``	no
configmap_auth_template_file	Path to `config_auth_template_file`	string	``	no
delimiter	Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes`	string	`-`	no
enabled	Set to false to prevent the module from creating any resources	bool	`true`	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)	`<list>`	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	Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT'	string	``	no
external_packages_install_path	Path to install external packages, e.g. AWS CLI and `kubectl`. Used when the module is provisioned on workstations where the external packages are not installed by default, e.g. Terraform Cloud workers	string	``	no
install_aws_cli	Set to `true` to install AWS CLI if the module is provisioned on workstations where AWS CLI is not installed by default, e.g. Terraform Cloud workers	bool	`false`	no
install_kubectl	Set to `true` to install `kubectl` if the module is provisioned on workstations where `kubectl` is not installed by default, e.g. Terraform Cloud workers	bool	`false`	no
jq_version	Version of `jq` to download to extract temporaly credentials after running `aws sts assume-role` if AWS CLI needs to assume role to access the cluster (if variable `aws_cli_assume_role_arn` is set)	string	`1.6`	no
kubeconfig_path	The path to `kubeconfig` file	string	`~/.kube/config`	no
kubectl_version	`kubectl` version to install. If not specified, the latest version will be used	string	``	no
kubernetes_version	Desired Kubernetes master version. If you do not specify a value, the latest available version is used	string	`1.14`	no
local_exec_interpreter	shell to use for local exec	string	`/bin/bash`	no
map_additional_aws_accounts	Additional AWS account numbers to add to `config-map-aws-auth` ConfigMap	list(string)	`<list>`	no
map_additional_iam_roles	Additional IAM roles to add to `config-map-aws-auth` ConfigMap	object	`<list>`	no
map_additional_iam_users	Additional IAM users to add to `config-map-aws-auth` ConfigMap	object	`<list>`	no
name	Solution name, e.g. 'app' or 'jenkins'	string	``	no
namespace	Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'	string	``	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 https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html	bool	`false`	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)	`<list>`	no
region	AWS Region	string	-	yes
stage	Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'	string	``	no
subnet_ids	A list of subnet IDs to launch the cluster in	list(string)	-	yes
tags	Additional tags (e.g. `map('BusinessUnit','XYZ')`	map(string)	`<map>`	no
vpc_id	VPC ID for the EKS cluster	string	-	yes
workers_role_arns	List of Role ARNs of the worker nodes	list(string)	-	yes
workers_security_group_ids	Security Group IDs of the worker nodes	list(string)	-	yes

Outputs

Name	Description
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_version	The Kubernetes server version of the cluster
security_group_arn	ARN of the EKS cluster Security Group
security_group_id	ID of the EKS cluster Security Group
security_group_name	Name of the EKS cluster Security Group

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.

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	Oscar

jasimmk / terraform-aws-eks-cluster

terraform-aws-eks-cluster

Introduction

Works with Terraform Cloud

Usage

Makefile Targets

Inputs

Outputs

Share the Love

Related Projects

Help

DevOps Accelerator for Startups

Slack Community

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors

About

Languages