mirror of
https://github.com/ysoftdevs/terraform-aws-eks.git
synced 2026-03-17 23:13:46 +01:00
first commit
This commit is contained in:
brandoconnor
105
README.md
Normal file
105
README.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# terraform-aws-eks
|
||||
|
||||
A terraform module to create a managed Kubernetes cluster on AWS EKS. Available
|
||||
through the [Terraform registry](https://registry.terraform.io/modules/terraform-aws-modules/eks/aws).
|
||||
|
||||
| Branch | Build status |
|
||||
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| master | [](https://travis-ci.org/terraform-aws-modules/terraform-aws-eks) |
|
||||
|
||||
## Assumptions
|
||||
|
||||
* You want to create a set of resources around an EKS cluster: namely an autoscaling group of workers and a security group for them.
|
||||
* You've created a Virtual Private Cloud (VPC) and subnets where you intend to put this EKS.
|
||||
|
||||
It's recommended you use this module with [terraform-aws-vpc](https://registry.terraform.io/modules/terraform-aws-modules/vpc/aws),
|
||||
[terraform-aws-security-group](https://registry.terraform.io/modules/terraform-aws-modules/security-group/aws), and
|
||||
[terraform-aws-autoscaling](https://registry.terraform.io/modules/terraform-aws-modules/autoscaling/aws/).
|
||||
|
||||
## Usage example
|
||||
|
||||
A full example leveraging other community modules is contained in the [examples/eks_test_fixture directory](https://github.com/terraform-aws-modules/terraform-aws-eks/tree/master/examples/eks_test_fixture). Here's the gist of using it via the Terraform registry:
|
||||
|
||||
```hcl
|
||||
module "eks" {
|
||||
source = "terraform-aws-modules/eks/aws"
|
||||
version = "0.1.0"
|
||||
cluster_name = "test-eks-cluster"
|
||||
security_groups = ["sg-edcd9784", "sg-edcd9785"]
|
||||
subnets = ["subnet-abcde012", "subnet-bcde012a"]
|
||||
tags = "${map("Environment", "test")}"
|
||||
vpc_id = "vpc-abcde012"
|
||||
}
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
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:
|
||||
|
||||
```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.
|
||||
|
||||
## Doc generation
|
||||
|
||||
Documentation should be modified within `main.tf` and generated using [terraform-docs](https://github.com/segmentio/terraform-docs).
|
||||
Generate them like so:
|
||||
|
||||
```bash
|
||||
go get github.com/segmentio/terraform-docs
|
||||
terraform-docs md ./ | cat -s | ghead -n -1 > README.md
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Report issues/questions/feature requests on in the [issues](https://github.com/terraform-aws-modules/terraform-aws-eks/issues/new) section.
|
||||
|
||||
Full contributing [guidelines are covered here](https://github.com/terraform-aws-modules/terraform-aws-eks/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## IAM Permissions
|
||||
|
||||
Testing and using this repo requires a minimum set of IAM permissions. Test permissions
|
||||
are listed in the [eks_test_fixture README](https://github.com/terraform-aws-modules/terraform-aws-eks/tree/master/examples/eks_test_fixture/README.md).
|
||||
|
||||
## Change log
|
||||
|
||||
The [changelog](https://github.com/terraform-aws-modules/terraform-aws-eks/tree/master/CHANGELOG.md) captures all important release notes.
|
||||
|
||||
## Authors
|
||||
|
||||
Created and maintained by [Brandon O'Connor](https://github.com/brandoconnor) - brandon@atscale.run.
|
||||
Many thanks to [the contributors listed here](https://github.com/terraform-aws-modules/terraform-aws-eks/graphs/contributors)!
|
||||
|
||||
## License
|
||||
|
||||
MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-eks/tree/master/LICENSE) for full details.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Name | Description | Type | Default | Required |
|
||||
|------|-------------|:----:|:-----:|:-----:|
|
||||
| cluster_name | Name of the EKS cluster. | string | - | yes |
|
||||
| security_groups | The security groups to attach to the EKS cluster instances | list | - | yes |
|
||||
| subnets | A list of subnets to associate with the cluster's underlying instances. | list | - | yes |
|
||||
| tags | A map of tags to add to all resources | string | `<map>` | no |
|
||||
| vpc_id | VPC id where the cluster and other resources will be deployed. | string | - | yes |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Name | Description |
|
||||
|------|-------------|
|
||||
| cluster_arn | The Amazon Resource Name (ARN) of the cluster. |
|
||||
| cluster_certificate_authority | Nested attribute containing certificate-authority-data for your cluster |
|
||||
| cluster_data | The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster. |
|
||||
| cluster_endpoint | The endpoint for your Kubernetes API server. |
|
||||
| cluster_id | The name of the cluster. |
|
||||
| cluster_version | The Kubernetes server version for the cluster. |
|
||||
| cluster_vpc_config | description |
|
||||
| config_map_aws_auth | description |
|
||||
| kubeconfig | description |
|
||||
Reference in New Issue
Block a user