From 9d3b5caff4681f9d33a08ebf73ff55d42e3236cb Mon Sep 17 00:00:00 2001 From: brandoconnor Date: Mon, 11 Jun 2018 16:15:11 -0700 Subject: [PATCH] typo fixed --- README.md | 62 +++++++++++++++++++++++++++---------------------------- main.tf | 2 +- 2 files changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 9471e63..689f0b6 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@ Read the [AWS docs on EKS to get connected to the k8s dashboard](https://docs.aw ## Assumptions -* 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. +- 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 @@ -33,7 +33,7 @@ module "eks" { ## Dependencies -The `configure_kubectl_session` variable requires that both `[kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) +The `configure_kubectl_session` variable requires that both [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) (>=1.10) and [`heptio-authenticator-aws`](https://github.com/heptio/authenticator#4-set-up-kubectl-to-use-heptio-authenticator-for-aws-tokens) are installed and on your shell's PATH. @@ -41,15 +41,15 @@ are installed and on your shell's PATH. This module has been packaged with [awspec](https://github.com/k1LoW/awspec) tests through [kitchen](https://kitchen.ci/) and [kitchen-terraform](https://newcontext-oss.github.io/kitchen-terraform/). To run them: -1. Install [rvm](https://rvm.io/rvm/install) and the ruby version specified in the [Gemfile](https://github.com/terraform-aws-modules/terraform-aws-eks/tree/master/Gemfile). -2. Install bundler and the gems from our Gemfile: +1. Install [rvm](https://rvm.io/rvm/install) and the ruby version specified in the [Gemfile](https://github.com/terraform-aws-modules/terraform-aws-eks/tree/master/Gemfile). +2. Install bundler and the gems from our Gemfile: ```bash gem install bundler && bundle install ``` -3. Ensure your AWS environment is configured (i.e. credentials and region) for test. -4. Test using `bundle exec kitchen test` from the root of the repo. +3. Ensure your AWS environment is configured (i.e. credentials and region) for test. +4. Test using `bundle exec kitchen test` from the root of the repo. 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 @@ -92,30 +92,30 @@ MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-a ## Inputs -| Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster_name | Name of the EKS cluster. Also used as a prefix in names of related resources. | string | - | yes | -| cluster_security_group_id | If provided, the EKS cluster will be attached to this security group. If not given, a security group will be created with necessary ingres/egress to work with the workers and provide API access to your current IP/32. | string | `` | no | -| cluster_version | Kubernetes version to use for the EKS cluster. | string | `1.10` | no | -| config_output_path | Determines where config files are placed if using configure_kubectl_session and you want config files to land outside the current working directory. | string | `./` | no | -| configure_kubectl_session | Configure the current session's kubectl to use the instantiated EKS cluster. | string | `true` | no | -| subnets | A list of subnets to place the EKS cluster and workers within. | list | - | yes | -| tags | A map of tags to add to all resources. | string | `` | no | -| vpc_id | VPC where the cluster and workers will be deployed. | string | - | yes | -| worker_groups | A list of maps defining worker group configurations. See workers_group_defaults for valid keys. | list | `` | no | -| worker_security_group_id | If provided, all workers will be attached to this security group. If not given, a security group will be created with necessary ingres/egress to work with the EKS cluster. | string | `` | no | -| workers_group_defaults | Default values for target groups as defined by the list of maps. | map | `` | no | +| Name | Description | Type | Default | Required | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----: | :------: | :------: | +| cluster_name | Name of the EKS cluster. Also used as a prefix in names of related resources. | string | - | yes | +| cluster_security_group_id | If provided, the EKS cluster will be attached to this security group. If not given, a security group will be created with necessary ingres/egress to work with the workers and provide API access to your current IP/32. | string | `` | no | +| cluster_version | Kubernetes version to use for the EKS cluster. | string | `1.10` | no | +| config_output_path | Determines where config files are placed if using configure_kubectl_session and you want config files to land outside the current working directory. | string | `./` | no | +| configure_kubectl_session | Configure the current session's kubectl to use the instantiated EKS cluster. | string | `true` | no | +| subnets | A list of subnets to place the EKS cluster and workers within. | list | - | yes | +| tags | A map of tags to add to all resources. | string | `` | no | +| vpc_id | VPC where the cluster and workers will be deployed. | string | - | yes | +| worker_groups | A list of maps defining worker group configurations. See workers_group_defaults for valid keys. | list | `` | no | +| worker_security_group_id | If provided, all workers will be attached to this security group. If not given, a security group will be created with necessary ingres/egress to work with the EKS cluster. | string | `` | no | +| workers_group_defaults | Default values for target groups as defined by the list of maps. | map | `` | no | ## Outputs -| Name | Description | -|------|-------------| +| Name | Description | +| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cluster_certificate_authority_data | Nested attribute containing certificate-authority-data for your cluster. This is the base64 encoded certificate data required to communicate with your cluster. | -| cluster_endpoint | The endpoint for your EKS Kubernetes API. | -| cluster_id | The name/id of the EKS cluster. | -| cluster_security_group_id | Security group ID attached to the EKS cluster. | -| cluster_version | The Kubernetes server version for the EKS cluster. | -| config_map_aws_auth | A kubernetes configuration to authenticate to this EKS cluster. | -| kubeconfig | kubectl config file contents for this EKS cluster. | -| worker_security_group_id | Security group ID attached to the EKS workers. | -| workers_asg_arns | IDs of the autoscaling groups containing workers. | +| cluster_endpoint | The endpoint for your EKS Kubernetes API. | +| cluster_id | The name/id of the EKS cluster. | +| cluster_security_group_id | Security group ID attached to the EKS cluster. | +| cluster_version | The Kubernetes server version for the EKS cluster. | +| config_map_aws_auth | A kubernetes configuration to authenticate to this EKS cluster. | +| kubeconfig | kubectl config file contents for this EKS cluster. | +| worker_security_group_id | Security group ID attached to the EKS workers. | +| workers_asg_arns | IDs of the autoscaling groups containing workers. | diff --git a/main.tf b/main.tf index 8999fae..4a50fc2 100644 --- a/main.tf +++ b/main.tf @@ -34,7 +34,7 @@ * ## Dependencies -* The `configure_kubectl_session` variable requires that both `[kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) +* The `configure_kubectl_session` variable requires that both [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) (>=1.10) and [`heptio-authenticator-aws`](https://github.com/heptio/authenticator#4-set-up-kubectl-to-use-heptio-authenticator-for-aws-tokens) are installed and on your shell's PATH.