You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-39Lines changed: 39 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,10 @@ Read the [AWS docs on EKS to get connected to the k8s dashboard](https://docs.aw
12
12
13
13
## Assumptions
14
14
15
-
- You want to create an EKS cluster and an autoscaling group of workers for the cluster.
16
-
- You want these resources to exist within security groups that allow communication and coordination. These can be user provided or created within the module.
17
-
- You've created a Virtual Private Cloud (VPC) and subnets where you intend to put the EKS resources.
18
-
- If using the default variable value (`true`) for `configure_kubectl_session`, it's required 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.
15
+
* You want to create an EKS cluster and an autoscaling group of workers for the cluster.
16
+
* You want these resources to exist within security groups that allow communication and coordination. These can be user provided or created within the module.
17
+
* You've created a Virtual Private Cloud (VPC) and subnets where you intend to put the EKS resources.
18
+
* If using the default variable value (`true`) for `configure_kubectl_session`, it's required 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.
19
19
20
20
## Usage example
21
21
@@ -41,15 +41,15 @@ come up with the spare time (hah!), release may happen more often on occasion.
41
41
42
42
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:
43
43
44
-
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).
45
-
2.Install bundler and the gems from our Gemfile:
44
+
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).
45
+
2. Install bundler and the gems from our Gemfile:
46
46
47
47
```bash
48
48
gem install bundler && bundle install
49
49
```
50
50
51
-
3. Ensure your AWS environment is configured (i.e. credentials and region) for test.
52
-
4. Test using `bundle exec kitchen test` from the root of the repo.
51
+
3. Ensure your AWS environment is configured (i.e. credentials and region) for test.
52
+
4. Test using `bundle exec kitchen test` from the root of the repo.
53
53
54
54
For now, connectivity to the kubernetes cluster is not tested but will be in the
55
55
future. If `configure_kubectl_session` is set`true`, once the test fixture has
@@ -92,38 +92,38 @@ MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-a
92
92
93
93
## Inputs
94
94
95
-
| Name | Description | Type | Default | Required |
| cluster_name | Name of the EKS cluster. Also used as a prefix in names of related resources. | string | - | yes |
98
-
| 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_version | Kubernetes version to use for the EKS cluster. | string | `1.10` | no |
100
-
| 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 |
101
-
| configure_kubectl_session | Configure the current session's kubectl to use the instantiated EKS cluster. | string |`true`| no |
102
-
|kubeconfig_context_name | Name of the kubeconfig context. | map |`aws`| no |
103
-
|kubeconfig_user_name | Name of the kubeconfig user. | map |`aws`| no |
104
-
|kubeconfig_aws_authenticator_command | Command to use to to fetch AWS EKS credentials | map |`heptio-authenticator-aws`| no |
105
-
|kubeconfig_aws_authenticator_additional_args|Any additional arguments to pass to the authenticator such as the role to assume `["-r", "MyEksRole"]`| map |`<list>`| no |
106
-
|kubeconfig_aws_authenticator_env_variables | Environment variables that should be used when executing the authenticator i.e. `{ AWS_PROFILE = "eks"}`| map |`<map>`| no |
107
-
| subnets | A list of subnets to place the EKS cluster and workers within. |list | - |yes|
108
-
| tags | A map of tags to add to all resources. | string |`<map>`| no |
109
-
| vpc_id | VPC where the cluster and workers will be deployed. | string | - |yes|
110
-
| worker_groups | A list of maps defining worker group configurations. See workers_group_defaults for valid keys. |list |`<list>`| no |
111
-
| 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 |
112
-
| 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 |
113
-
| workers_group_defaults | Default values for target groups as defined by the list of maps. |map |`<map>`| no |
114
-
| workstation_cidr | Override the default ingress rule that allows communication with the EKS cluster API. If not given, will use current IP/32. | string | - | no |
95
+
| Name | Description | Type | Default | Required |
96
+
|------|-------------|:----:|:-----:|:-----:|
97
+
| cluster_name | Name of the EKS cluster. Also used as a prefix in names of related resources. | string | - | yes |
98
+
| 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_version | Kubernetes version to use for the EKS cluster. | string | `1.10` | no |
100
+
| 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 |
101
+
| configure_kubectl_session | Configure the current session's kubectl to use the instantiated EKS cluster. | string |`true`| no|
102
+
|kubeconfig_aws_authenticator_additional_args | Any additional arguments to pass to the authenticator such as the role to assume ["-r", "MyEksRole"] | string |`<list>`| no|
103
+
|kubeconfig_aws_authenticator_command | Command to use to to fetch AWS EKS credentials | string |`heptio-authenticator-aws`| no|
104
+
|kubeconfig_aws_authenticator_env_variables | Environment variables that should be used when executing the authenticator i.e. { AWS_PROFILE = "eks"} | string |`<map>`| no |
105
+
|kubeconfig_context_name|Name of the kubeconfig context. | string |`aws`|no|
106
+
|kubeconfig_user_name | Name of the kubeconfig user. | string |`aws`| no|
107
+
| subnets | A list of subnets to place the EKS cluster and workers within. |list | - |yes |
108
+
| tags | A map of tags to add to all resources. | string |`<map>`| no|
109
+
| vpc_id | VPC where the cluster and workers will be deployed. | string |- |yes |
110
+
| worker_groups | A list of maps defining worker group configurations. See workers_group_defaults for valid keys. |list |`<list>`|no|
111
+
| 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|
112
+
| 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|
113
+
| workers_group_defaults | Default values for target groups as defined by the list of maps. |map |`<map>`| no|
114
+
| workstation_cidr | Override the default ingress rule that allows communication with the EKS cluster API. If not given, will use current IP/32. | string |``| no|
| 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. |
121
-
| cluster_endpoint | The endpoint for your EKS Kubernetes API.|
122
-
| cluster_id | The name/id of the EKS cluster.|
123
-
| cluster_security_group_id | Security group ID attached to the EKS cluster.|
124
-
| cluster_version | The Kubernetes server version for the EKS cluster.|
125
-
| config_map_aws_auth | A kubernetes configuration to authenticate to this EKS cluster.|
126
-
| kubeconfig | kubectl config file contents for this EKS cluster.|
127
-
| worker_iam_role_name | IAM role name attached to EKS workers|
128
-
| worker_security_group_id | Security group ID attached to the EKS workers.|
129
-
| workers_asg_arns | IDs of the autoscaling groups containing workers.|
121
+
| cluster_endpoint | The endpoint for your EKS Kubernetes API. |
122
+
| cluster_id | The name/id of the EKS cluster. |
123
+
| cluster_security_group_id | Security group ID attached to the EKS cluster. |
124
+
| cluster_version | The Kubernetes server version for the EKS cluster. |
125
+
| config_map_aws_auth | A kubernetes configuration to authenticate to this EKS cluster. |
126
+
| kubeconfig | kubectl config file contents for this EKS cluster. |
127
+
| worker_iam_role_name | IAM role name attached to EKS workers |
128
+
| worker_security_group_id | Security group ID attached to the EKS workers. |
129
+
| workers_asg_arns | IDs of the autoscaling groups containing workers. |
0 commit comments