From 95d4e78f2fbb31f267bd8a5eb07e027aaee8c76d Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Tue, 15 Jan 2019 12:03:48 +0100 Subject: [PATCH] Fix variable description typo, regenerate README (#247) --- README.md | 42 +++++++++++++++++++++--------------------- variables.tf | 18 +++++++++++------- 2 files changed, 32 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 9cabcda..0683a50 100644 --- a/README.md +++ b/README.md @@ -110,40 +110,40 @@ MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-a | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| -| cluster\_create\_security\_group | Whether to create a security group for the cluster or attach the cluster to `cluster_security_group_id`. | string | `true` | no | -| cluster\_create\_timeout | Timeout value when creating the EKS cluster. | string | `15m` | no | -| cluster\_delete\_timeout | Timeout value when deleting the EKS cluster. | string | `15m` | no | -| 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.11` | no | -| config\_output\_path | Where to save the Kubectl config file (if `write_kubeconfig = true`). Should end in a forward slash `/` . | string | `./` | no | +| cluster\_create\_security\_group | Whether to create a security group for the cluster or attach the cluster to `cluster_security_group_id`. | string | `"true"` | no | +| cluster\_create\_timeout | Timeout value when creating the EKS cluster. | string | `"15m"` | no | +| cluster\_delete\_timeout | Timeout value when deleting the EKS cluster. | string | `"15m"` | no | +| cluster\_name | Name of the EKS cluster. Also used as a prefix in names of related resources. | string | n/a | 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.11"` | no | +| config\_output\_path | Where to save the Kubectl config file (if `write_kubeconfig = true`). Should end in a forward slash `/` . | string | `"./"` | no | | kubeconfig\_aws\_authenticator\_additional\_args | Any additional arguments to pass to the authenticator such as the role to assume. e.g. ["-r", "MyEksRole"]. | list | `[]` | no | -| kubeconfig\_aws\_authenticator\_command | Command to use to to fetch AWS EKS credentials. | string | `aws-iam-authenticator` | no | +| kubeconfig\_aws\_authenticator\_command | Command to use to fetch AWS EKS credentials. | string | `"aws-iam-authenticator"` | no | | kubeconfig\_aws\_authenticator\_command\_args | Default arguments passed to the authenticator command. Defaults to [token -i $cluster_name]. | list | `[]` | no | | kubeconfig\_aws\_authenticator\_env\_variables | Environment variables that should be used when executing the authenticator. e.g. { AWS_PROFILE = "eks"}. | map | `{}` | no | -| kubeconfig\_name | Override the default name used for items kubeconfig. | string | `` | no | +| kubeconfig\_name | Override the default name used for items kubeconfig. | string | `""` | no | | local\_exec\_interpreter | Command to run for local-exec resources. Must be a shell-style interpreter. If you are on Windows Git Bash is a good choice. | list | `[ "/bin/sh", "-c" ]` | no | -| manage\_aws\_auth | Whether to write and apply the aws-auth configmap file. | string | `true` | no | +| manage\_aws\_auth | Whether to write and apply the aws-auth configmap file. | string | `"true"` | no | | map\_accounts | Additional AWS account numbers to add to the aws-auth configmap. See examples/eks_test_fixture/variables.tf for example format. | list | `[]` | no | -| map\_accounts\_count | The count of accounts in the map_accounts list. | string | `0` | no | +| map\_accounts\_count | The count of accounts in the map_accounts list. | string | `"0"` | no | | map\_roles | Additional IAM roles to add to the aws-auth configmap. See examples/eks_test_fixture/variables.tf for example format. | list | `[]` | no | -| map\_roles\_count | The count of roles in the map_roles list. | string | `0` | no | +| map\_roles\_count | The count of roles in the map_roles list. | string | `"0"` | no | | map\_users | Additional IAM users to add to the aws-auth configmap. See examples/eks_test_fixture/variables.tf for example format. | list | `[]` | no | -| map\_users\_count | The count of roles in the map_users list. | string | `0` | no | -| subnets | A list of subnets to place the EKS cluster and workers within. | list | - | yes | +| map\_users\_count | The count of roles in the map_users list. | string | `"0"` | no | +| subnets | A list of subnets to place the EKS cluster and workers within. | list | n/a | yes | | tags | A map of tags to add to all resources. | map | `{}` | no | -| vpc\_id | VPC where the cluster and workers will be deployed. | string | - | yes | +| vpc\_id | VPC where the cluster and workers will be deployed. | string | n/a | yes | | worker\_additional\_security\_group\_ids | A list of additional security group ids to attach to worker instances | list | `[]` | no | -| worker\_create\_security\_group | Whether to create a security group for the workers or attach the workers to `worker_security_group_id`. | string | `true` | no | -| worker\_group\_count | The number of maps contained within the worker_groups list. | string | `1` | no | -| worker\_group\_launch\_template\_count | The number of maps contained within the worker_groups_launch_template list. | string | `0` | no | +| worker\_create\_security\_group | Whether to create a security group for the workers or attach the workers to `worker_security_group_id`. | string | `"true"` | no | +| worker\_group\_count | The number of maps contained within the worker_groups list. | string | `"1"` | no | +| worker\_group\_launch\_template\_count | The number of maps contained within the worker_groups_launch_template list. | string | `"0"` | no | | worker\_groups | A list of maps defining worker group configurations to be defined using AWS Launch Configurations. See workers_group_defaults for valid keys. | list | `[ { "name": "default" } ]` | no | | worker\_groups\_launch\_template | A list of maps defining worker group configurations to be defined using AWS Launch Templates. See workers_group_defaults for valid keys. | list | `[ { "name": "default" } ]` | 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 | -| worker\_sg\_ingress\_from\_port | Minimum port number from which pods will accept communication. Must be changed to a lower value if some pods in your cluster will expose a port lower than 1025 (e.g. 22, 80, or 443). | string | `1025` | 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 | +| worker\_sg\_ingress\_from\_port | Minimum port number from which pods will accept communication. Must be changed to a lower value if some pods in your cluster will expose a port lower than 1025 (e.g. 22, 80, or 443). | string | `"1025"` | no | | workers\_group\_defaults | Override default values for target groups. See workers_group_defaults_defaults in locals.tf for valid keys. | map | `{}` | no | | workers\_group\_launch\_template\_defaults | Override default values for target groups. See workers_group_defaults_defaults in locals.tf for valid keys. | map | `{}` | no | -| write\_kubeconfig | Whether to write a Kubectl config file containing the cluster configuration. Saved to `config_output_path`. | string | `true` | no | +| write\_kubeconfig | Whether to write a Kubectl config file containing the cluster configuration. Saved to `config_output_path`. | string | `"true"` | no | ## Outputs diff --git a/variables.tf b/variables.tf index 5efd66c..1937585 100644 --- a/variables.tf +++ b/variables.tf @@ -82,9 +82,11 @@ variable "worker_groups" { description = "A list of maps defining worker group configurations to be defined using AWS Launch Configurations. See workers_group_defaults for valid keys." type = "list" - default = [{ - "name" = "default" - }] + default = [ + { + "name" = "default" + }, + ] } variable "worker_group_count" { @@ -103,9 +105,11 @@ variable "worker_groups_launch_template" { description = "A list of maps defining worker group configurations to be defined using AWS Launch Templates. See workers_group_defaults for valid keys." type = "list" - default = [{ - "name" = "default" - }] + default = [ + { + "name" = "default" + }, + ] } variable "worker_group_launch_template_count" { @@ -137,7 +141,7 @@ variable "worker_sg_ingress_from_port" { } variable "kubeconfig_aws_authenticator_command" { - description = "Command to use to to fetch AWS EKS credentials." + description = "Command to use to fetch AWS EKS credentials." default = "aws-iam-authenticator" }