terraform-aws-eks
A terraform module to create a managed Kubernetes cluster on AWS EKS. Available through the Terraform registry. Inspired by and adapted from this doc and its source code.
| Branch | Build status |
|---|---|
| master |
Assumptions
- You want to create a set of resources around an EKS cluster: namely an autoscaling group of workers and a security group for them.
- You've created a Virtual Private Cloud (VPC) and subnets where you intend to put this EKS.
Usage example
A full example leveraging other community modules is contained in the examples/eks_test_fixture directory. Here's the gist of using it via the Terraform registry:
module "eks" {
source = "terraform-aws-modules/eks/aws"
version = "0.1.0"
cluster_name = "test-eks-cluster"
subnets = ["subnet-abcde012", "subnet-bcde012a"]
tags = "${map("Environment", "test")}"
vpc_id = "vpc-abcde012"
workers_ami_id = "ami-123456"
cluster_ingress_cidrs = ["24.18.23.91/32"]
}
Testing
This module has been packaged with awspec tests through kitchen and kitchen-terraform. To run them:
-
Install bundler and the gems from our Gemfile:
gem install bundler && bundle install -
Ensure your AWS environment is configured (i.e. credentials and region) for test.
-
Test using
bundle exec kitchen testfrom the root of the repo.
Doc generation
Documentation should be modified within main.tf and generated using terraform-docs.
Generate them like so:
go get github.com/segmentio/terraform-docs
terraform-docs md ./ | cat -s | ghead -n -1 > README.md
Contributing
Report issues/questions/feature requests on in the issues section.
Full contributing guidelines are covered here.
IAM Permissions
Testing and using this repo requires a minimum set of IAM permissions. Test permissions are listed in the eks_test_fixture README.
Change log
The changelog captures all important release notes.
Authors
Created and maintained by Brandon O'Connor - brandon@atscale.run. Many thanks to the contributors listed here!
License
MIT Licensed. See LICENSE for full details.
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| cluster_ingress_cidrs | The CIDRs from which we can execute kubectl commands. | list | - | yes |
| cluster_name | Name of the EKS cluster. | string | - | yes |
| cluster_version | Kubernetes version to use for the cluster. | string | 1.10 |
no |
| subnets | A list of subnets to associate with the cluster's underlying instances. | list | - | yes |
| tags | A map of tags to add to all resources | string | <map> |
no |
| vpc_id | VPC id where the cluster and other resources will be deployed. | string | - | yes |
| workers_ami_id | AMI ID for the eks workers. | string | - | yes |
| workers_asg_desired_capacity | description | string | 1 |
no |
| workers_asg_max_size | description | string | 3 |
no |
| workers_asg_min_size | description | string | 1 |
no |
| workers_instance_type | Size of the workers instances. | string | m4.large |
no |
Outputs
| Name | Description |
|---|---|
| cluster_certificate_authority_data | Nested attribute containing certificate-authority-data for your cluster. Tis is the base64 encoded certificate data required to communicate with your cluster. |
| cluster_endpoint | The endpoint for your Kubernetes API server. |
| cluster_id | The name/id of the cluster. |
| cluster_security_group_ids | description |
| cluster_version | The Kubernetes server version for the cluster. |
| config_map_aws_auth | |
| kubeconfig | kubectl config file contents for this cluster. |