From c05331afde41b623c98007a99c9bd936912b49f0 Mon Sep 17 00:00:00 2001 From: badra001 Date: Thu, 23 Dec 2021 14:04:39 -0500 Subject: [PATCH] add .terraform-docs.yml --- .terraform-docs.yml | 45 +++++++++++++++++++++++++++++++++++++++++++++ CHANGELOG.md | 8 ++++++++ README.md | 32 ++++++++++++++++++++++++++++++++ common/version.tf | 2 +- 4 files changed, 86 insertions(+), 1 deletion(-) create mode 100644 .terraform-docs.yml diff --git a/.terraform-docs.yml b/.terraform-docs.yml new file mode 100644 index 0000000..418f24a --- /dev/null +++ b/.terraform-docs.yml @@ -0,0 +1,45 @@ +formatter: markdown table + +header-from: main.tf +footer-from: "" + +sections: +## hide: [] + show: + - data-sources + - header + - footer + - inputs + - modules + - outputs + - providers + - requirements + - resources + +output: + file: README.md + mode: replace +# mode: inject +# template: |- +# +# {{ .Content }} +# + +## output-values: +## enabled: false +## from: "" +## +## sort: +## enabled: true +## by: name +## +## settings: +## anchor: true +## color: true +## default: true +## description: false +## escape: true +## indent: 2 +## required: true +## sensitive: true +## type: true diff --git a/CHANGELOG.md b/CHANGELOG.md index 48c832e..6f92f4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Versions +## Version 1.x + * v1.0.0 -- 2021-10-14 - patch-aws-auth module creation +## Version 2.x + +* v2.0.0 -- 20211223 + - add providers for tf 0.13+ + + diff --git a/README.md b/README.md index e69de29..6bd377d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,32 @@ +# aws-eks + +This contains a list of submodules used for building an EKS cluster. There are also some examples which can be used +as a starting point for building a cluster. + +* Submodules + * [patch-aws-auth](#patch-aws-auth): update `aws-auth ConfigMap` + +* Submodules Planned + * dns-zone + * efs + * cluster-iam-policies + * cluster-iam-roles + * irsa-role + * cluster-role + * common-services, most likely split into a module for each of the common services + +* Examples + * established-cluster-examples + * full-cluster + +# Submodules +## [patch-aws-auth](patch-aws-auth/) + +This submodule allows for an easy patching of the `aws-auth ConfigMap`, which is used to map IAM users and roles to specific +Kubernetes groups, roles, and cluster roles. + +# Examples + +## established-cluster-examples +## full-cluster + diff --git a/common/version.tf b/common/version.tf index fa2705b..6b49608 100644 --- a/common/version.tf +++ b/common/version.tf @@ -1,3 +1,3 @@ locals { - _module_version = "1.0.0" + _module_version = "2.0.0" }