Skip to content

Commit

Permalink
add .terraform-docs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
badra001 committed Dec 23, 2021
1 parent 31a03f7 commit c05331a
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 1 deletion.
45 changes: 45 additions & 0 deletions .terraform-docs.yml
Original file line number Diff line number Diff line change
@@ -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: |-
# <!-- BEGIN_TF_DOCS -->
# {{ .Content }}
# <!-- END_TF_DOCS -->

## 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
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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+


32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

2 changes: 1 addition & 1 deletion common/version.tf
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
locals {
_module_version = "1.0.0"
_module_version = "2.0.0"
}

0 comments on commit c05331a

Please sign in to comment.