Skip to content

Commit

Permalink
chore: Update README with intention
Browse files Browse the repository at this point in the history
  • Loading branch information
js-timbirkett committed Mar 6, 2020
1 parent 6338f6d commit 05b7d54
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 64 deletions.
4 changes: 2 additions & 2 deletions .chglog/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ style: github
template: CHANGELOG.tpl.md
info:
title: CHANGELOG
repository_url: https://github.com/JSainsburyPLC/terraform-aws-eks
repository_url: https://github.com/devopsmakers/terraform-aws-eks
options:
commit_groups:
title_maps:
Expand All @@ -26,4 +26,4 @@ options:
- Subject
notes:
keywords:
- BREAKING CHANGE
- BREAKING CHANGE
2 changes: 0 additions & 2 deletions .whistle.yaml

This file was deleted.

5 changes: 0 additions & 5 deletions OWNER.md

This file was deleted.

24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
![terraform-aws-eks](./media/logo.png)
# terraform-aws-eks

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)

# terraform-aws-eks
This is a complete rework of the upstream community EKS module: https://github.com/terraform-aws-modules/terraform-aws-eks

> :warning: **Only `Terraform >= 0.12` will be supported. Based on `v9.0.0` of the upstream module.**
<!-- Add a sensible description of this repository -->

## Links
The interface to the module is the same but it attempts to be more flexible
by allowing users to create and use components separately by splitting out
sub-modules for:
- EKS Control Plane
- EKS Worker Nodes
- EKS Managed Node Groups

- [Owner](./OWNER.md)
- [Contributing](./CONTRIBUTING.md)
- [Requirements](./REQUIREMENTS.md)
The submodules are designed to be used as individual modules to help the user
perform actions in between creating the control plane and creating workers and nodes
(Custom CNI Configuration).

By breaking out separate sub modules we create a clearer separation of concerns and
reduce tight coupling of control plane and worker nodes whilst maintaining the same
interface for seamless migration to this module. The interface has become an example
implementation of the sub-modules.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Providers
Expand Down
48 changes: 0 additions & 48 deletions REQUIREMENTS.md

This file was deleted.

Binary file removed media/logo.png
Binary file not shown.

0 comments on commit 05b7d54

Please sign in to comment.