diff --git a/README.md b/README.md index 0363e22f..783f09bf 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,15 @@ A terraform module to create a managed Kubernetes cluster on AWS EKS. Available through the [Terraform registry](https://registry.terraform.io/modules/terraform-aws-modules/eks/aws). Inspired by and adapted from [this doc](https://www.terraform.io/docs/providers/aws/guides/eks-getting-started.html) and its [source code](https://github.com/terraform-providers/terraform-provider-aws/tree/master/examples/eks-getting-started). -Instructions on [this post](https://aws.amazon.com/blogs/aws/amazon-eks-now-generally-available/) -can help guide you through connecting to the cluster via `kubectl`. | Branch | Build status | | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | master | [![build Status](https://travis-ci.org/terraform-aws-modules/terraform-aws-eks.svg?branch=master)](https://travis-ci.org/terraform-aws-modules/terraform-aws-eks) | ## 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. +* You want to create an EKS cluster and an autoscaling group of workers for the cluster. +* You want these resources to exist within security groups that allow communication and coordination. These can be user provided or created within the module. +* You've created a Virtual Private Cloud (VPC) and subnets where you intend to put the EKS resources. ## Usage example @@ -53,7 +51,8 @@ This module has been packaged with [awspec](https://github.com/k1LoW/awspec) tes For now, connectivity to the kubernetes cluster is not tested but will be in the future. If `configure_kubectl_session` is set `true`, once the test fixture has -converged, you can query the test cluster with `kubectl get nodes --watch --kubeconfig kubeconfig`. +converged, you can query the test cluster from that terminal session with +`kubectl get nodes --watch --kubeconfig kubeconfig`. ## Doc generation diff --git a/local.tf b/local.tf index ce706e76..6c3249d8 100644 --- a/local.tf +++ b/local.tf @@ -1,5 +1,4 @@ locals { - # More information: https://amazon-eks.s3-us-west-2.amazonaws.com/1.10.3/2018-06-05/amazon-eks-nodegroup.yaml asg_tags = ["${null_resource.tags_as_list_of_maps.*.triggers}"] cluster_security_group_id = "${var.cluster_security_group_id == "" ? aws_security_group.cluster.id : var.cluster_security_group_id}" worker_security_group_id = "${var.worker_security_group_id == "" ? aws_security_group.workers.id : var.worker_security_group_id}" diff --git a/main.tf b/main.tf index a51c3362..fd33776f 100644 --- a/main.tf +++ b/main.tf @@ -5,17 +5,15 @@ * through the [Terraform registry](https://registry.terraform.io/modules/terraform-aws-modules/eks/aws). * Inspired by and adapted from [this doc](https://www.terraform.io/docs/providers/aws/guides/eks-getting-started.html) * and its [source code](https://github.com/terraform-providers/terraform-provider-aws/tree/master/examples/eks-getting-started). -* Instructions on [this post](https://aws.amazon.com/blogs/aws/amazon-eks-now-generally-available/) -* can help guide you through connecting to the cluster via `kubectl`. * | Branch | Build status | * | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | * | master | [![build Status](https://travis-ci.org/terraform-aws-modules/terraform-aws-eks.svg?branch=master)](https://travis-ci.org/terraform-aws-modules/terraform-aws-eks) | * ## 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. +** You want to create an EKS cluster and an autoscaling group of workers for the cluster. +** You want these resources to exist within security groups that allow communication and coordination. These can be user provided or created within the module. +** You've created a Virtual Private Cloud (VPC) and subnets where you intend to put the EKS resources. * ## Usage example @@ -54,7 +52,8 @@ are installed and on your shell's PATH. * For now, connectivity to the kubernetes cluster is not tested but will be in the * future. If `configure_kubectl_session` is set `true`, once the test fixture has -* converged, you can query the test cluster with `kubectl get nodes --watch --kubeconfig kubeconfig`. +* converged, you can query the test cluster from that terminal session with +* `kubectl get nodes --watch --kubeconfig kubeconfig`. * ## Doc generation