Skip to content

Commit fddc353

Browse files
committed
Updated documentation with new variables.
1 parent 3de7f50 commit fddc353

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,17 +96,25 @@ MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-a
9696
| Name | Description | Type | Default | Required |
9797
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----: | :------: | :------: |
9898
| cluster_name | Name of the EKS cluster. Also used as a prefix in names of related resources. | string | - | yes |
99-
| 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 |
99+
| 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 |
100100
| cluster_version | Kubernetes version to use for the EKS cluster. | string | `1.10` | no |
101101
| 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 |
102102
| configure_kubectl_session | Configure the current session's kubectl to use the instantiated EKS cluster. | string | `true` | no |
103103
| subnets | A list of subnets to place the EKS cluster and workers within. | list | - | yes |
104104
| tags | A map of tags to add to all resources. | string | `<map>` | no |
105105
| vpc_id | VPC where the cluster and workers will be deployed. | string | - | yes |
106106
| worker_groups | A list of maps defining worker group configurations. See workers_group_defaults for valid keys. | list | `<list>` | no |
107-
| 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 |
107+
| 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 |
108108
| 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 |
109109
| workers_group_defaults | Default values for target groups as defined by the list of maps. | map | `<map>` | no |
110+
| kubeconfig_context_name | Name of the kubeconfig context. | map | `aws` | no |
111+
| kubeconfig_user_name | Name of the kubeconfig user. | map | `aws` | no |
112+
| kubeconfig_aws_authenticator_command | Command to use to to fetch AWS EKS credentials | map | `heptio-authenticator-aws` | no |
113+
| kubeconfig_aws_authenticator_additional_args | Any additional arguments to pass to the authenticator such as the role to assume `["-r", "MyEksRole"]` | map | `<list>` | no |
114+
| kubeconfig_aws_authenticator_env_variables | Environment variables that should be used when executing the authenticator i.e. `{ AWS_PROFILE = "eks"}` | map | `<map>` | no |
115+
116+
117+
110118

111119
## Outputs
112120

0 commit comments

Comments
 (0)