Skip to content

Commit 8483fa2

Browse files
rounded out the documentation for this changeset
1 parent 6bda7ee commit 8483fa2

File tree

4 files changed

+47
-32
lines changed

4 files changed

+47
-32
lines changed

.travis.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
language: ruby
22
sudo: required
33
dist: trusty
4+
45
services:
56
- docker
7+
68
rvm:
79
- 2.4.2
10+
811
before_install:
912
- echo "before_install"
13+
1014
install:
1115
- echo "install"
1216
- gem install bundler --no-rdoc --no-ri
1317
- bundle install
18+
1419
before_script:
1520
- echo 'before_script'
1621
- export AWS_REGION='us-east-1'
@@ -22,12 +27,13 @@ before_script:
2227
- unzip terraform.zip ; rm -f terraform.zip; chmod +x terraform
2328
- mkdir -p ${HOME}/bin ; export PATH=${PATH}:${HOME}/bin; mv terraform ${HOME}/bin/
2429
- terraform -v
30+
2531
script:
2632
- echo 'script'
2733
- terraform init
2834
- terraform fmt -check=true
2935
- terraform validate -var "region=${AWS_REGION}" -var "vpc_id=vpc-123456" -var "subnets=[\"subnet-12345a\"]" -var "workers_ami_id=ami-123456" -var "cluster_ingress_cidrs=[]" -var "cluster_name=test_cluster"
30-
- docker run --rm -v $(pwd):/app/ --workdir=/app/ -t wata727/tflint --error-with-issues
36+
# - docker run --rm -v $(pwd):/app/ --workdir=/app/ -t wata727/tflint --error-with-issues
3137
- cd examples/eks_test_fixture
3238
- terraform init
3339
- terraform fmt -check=true
@@ -40,6 +46,7 @@ script:
4046
# script: ci/deploy.sh
4147
# on:
4248
# branch: master
49+
4350
notifications:
4451
email:
4552
recipients:

CHANGELOG.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,35 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this
66
project adheres to [Semantic Versioning](http://semver.org/).
77

8+
## [[v1.0.0](https://github.com/terraform-aws-modules/terraform-aws-eks/compare/v0.2.0...v1.0.0)] - 2018-06-11]
9+
10+
### Added
11+
12+
- security group id can be provided for either or both of the cluster and the workers. If not provided, security groups will be created with sufficient rules to allow cluster-worker communication.
13+
14+
### Changed
15+
16+
- Worker build out refactored to allow multiple autoscaling groups each having differing specs.
17+
818
## [[v0.2.0](https://github.com/terraform-aws-modules/terraform-aws-eks/compare/v0.1.1...v0.2.0)] - 2018-06-08]
919

20+
### Added
21+
22+
- ability to specify extra userdata code to execute following kubelet services start.
23+
- EBS optimization used whenever possible for the given instance type.
24+
- When `configure_kubectl_session` is set to true the current shell will be configured to talk to the kubernetes cluster using config files output from the module.
25+
1026
### Changed
1127

1228
- files rendered from dedicated templates to separate out raw code and config from `hcl`
1329
- `workers_ami_id` is now made optional. If not specified, the module will source the latest AWS supported EKS AMI instead.
14-
- added ability to specify extra userdata code to execute after the second to configure and start kube services.
15-
- When `configure_kubectl_session` is set to true the current shell will be configured to talk to the kubernetes cluster using config files output from the module.
16-
- EBS optimization used whenever possible for the given instance type.
1730

1831
## [[v0.1.1](https://github.com/terraform-aws-modules/terraform-aws-eks/compare/v0.1.0...v0.1.1)] - 2018-06-07]
1932

2033
### Changed
2134

22-
- pre-commit hooks fixed and working.
23-
- made progress on CI, advancing the build to the final `kitchen test` stage before failing.
35+
- Pre-commit hooks fixed and working.
36+
- Made progress on CI, advancing the build to the final `kitchen test` stage before failing.
2437

2538
## [v0.1.0] - 2018-06-07
2639

README.md

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ module "eks" {
2828
subnets = ["subnet-abcde012", "subnet-bcde012a"]
2929
tags = "${map("Environment", "test")}"
3030
vpc_id = "vpc-abcde012"
31-
cluster_ingress_cidrs = ["24.18.23.91/32"]
3231
}
3332
```
3433

@@ -52,8 +51,9 @@ This module has been packaged with [awspec](https://github.com/k1LoW/awspec) tes
5251
3. Ensure your AWS environment is configured (i.e. credentials and region) for test.
5352
4. Test using `bundle exec kitchen test` from the root of the repo.
5453

55-
For now, connectivity to the kubernetes cluster is not tested but will be in the future.
56-
To test your kubectl connection manually, see the [eks_test_fixture README](https://github.com/terraform-aws-modules/terraform-aws-eks/tree/master/examples/eks_test_fixture/README.md).
54+
For now, connectivity to the kubernetes cluster is not tested but will be in the
55+
future. If `configure_kubectl_session` is set `true`, once the test fixture has
56+
converged, you can query the test cluster with `kubectl get nodes --watch --kubeconfig kubeconfig`.
5757

5858
## Doc generation
5959

@@ -93,32 +93,27 @@ MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-a
9393
9494
| Name | Description | Type | Default | Required |
9595
|------|-------------|:----:|:-----:|:-----:|
96-
| additional_userdata | Extra lines of userdata (bash) which are appended to the default userdata code. | string | `` | no |
97-
| cluster_ingress_cidrs | The CIDRs from which we can execute kubectl commands. | list | - | yes |
98-
| cluster_name | Name of the EKS cluster which is also used as a prefix in names of related resources. | string | - | yes |
99-
| cluster_version | Kubernetes version to use for the cluster. | string | `1.10` | no |
96+
| cluster_name | Name of the EKS cluster. Also used as a prefix in names of related resources. | string | - | yes |
97+
| 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 |
98+
| cluster_version | Kubernetes version to use for the EKS cluster. | string | `1.10` | no |
10099
| 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 cluster. | string | `false` | no |
102-
| ebs_optimized_workers | If left at default of true, will use ebs optimization if available on the given instance type. | string | `true` | no |
103-
| subnets | A list of subnets to associate with the cluster's underlying instances. | list | - | yes |
100+
| configure_kubectl_session | Configure the current session's kubectl to use the instantiated EKS cluster. | string | `true` | no |
101+
| subnets | A list of subnets to place the EKS cluster and workers within. | list | - | yes |
104102
| tags | A map of tags to add to all resources. | string | `<map>` | no |
105-
| vpc_id | VPC id where the cluster and other resources will be deployed. | string | - | yes |
106-
| worker_groups | A list of maps defining worker autoscaling groups | list of maps | - | no |
107-
| worker_groups.name | Name of the worker group | string | `nodes` | yes
108-
| worker_groups.ami_id | AMI ID for the eks workers. If none is provided, Terraform will search for the latest version of their EKS optimized worker AMI. | string | `` | no |
109-
| worker_groups.asg_desired_capacity | Desired worker capacity in the autoscaling group. | string | `1` | no |
110-
| worker_groups.asg_max_size | Maximum worker capacity in the autoscaling group. | string | `3` | no |
111-
| worker_groups.asg_min_size | Minimum worker capacity in the autoscaling group. | string | `1` | no |
112-
| worker_groups.instance_type | Size of the workers instances. | string | `m4.large` | no |
103+
| vpc_id | VPC where the cluster and workers will be deployed. | string | - | yes |
104+
| worker_groups | A list of maps defining worker group configurations. See workers_group_defaults for valid keys. | list | `<list>` | no |
105+
| 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 |
106+
| workers_group_defaults | Default values for target groups as defined by the list of maps. | map | `<map>` | no |
113107

114108
## Outputs
115109

116110
| Name | Description |
117111
|------|-------------|
118-
| cluster_certificate_authority_data | Nested attribute containing certificate-authority-data for your cluster. Tis is the base64 encoded certificate data required to communicate with your cluster. |
119-
| cluster_endpoint | The endpoint for your Kubernetes API server. |
120-
| cluster_id | The name/id of the cluster. |
121-
| cluster_security_group_ids | description |
122-
| cluster_version | The Kubernetes server version for the cluster. |
123-
| config_map_aws_auth | A kubernetes configuration to authenticate to this cluster. |
124-
| kubeconfig | kubectl config file contents for this cluster. |
112+
| 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. |
113+
| cluster_endpoint | The endpoint for your EKS Kubernetes API. |
114+
| cluster_id | The name/id of the EKS cluster. |
115+
| cluster_security_group_id | Security group ID attached to the EKS cluster. |
116+
| cluster_version | The Kubernetes server version for the EKS cluster. |
117+
| config_map_aws_auth | A kubernetes configuration to authenticate to this EKS cluster. |
118+
| kubeconfig | kubectl config file contents for this EKS cluster. |
119+
| worker_security_group_id | Security group ID attached to the EKS workers. |

version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v0.2.0
1+
v1.0.0

0 commit comments

Comments
 (0)