From ff8140cab1d73b4ffa860a07ec7e3957c8707950 Mon Sep 17 00:00:00 2001 From: Marc Haase Date: Fri, 12 Mar 2021 19:59:44 -0800 Subject: [PATCH] update READMEs with lint --- README.md | 37 ++++++++++++++++++++++++++++++++++- modules/fargate/README.md | 15 +++++++++++++- modules/node_groups/README.md | 12 +++++++++++- 3 files changed, 61 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a5134732996..d5b62e9aaf7 100644 --- a/README.md +++ b/README.md @@ -163,6 +163,41 @@ MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-a | random | >= 2.1 | | template | >= 2.1 | +## Modules + +| Name | Source | Version | +|------|--------|---------| +| fargate | ./modules/fargate | | +| node_groups | ./modules/node_groups | | + +## Resources + +| Name | +|------| +| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | +| [aws_autoscaling_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/autoscaling_group) | +| [aws_caller_identity](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | +| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | +| [aws_eks_cluster](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eks_cluster) | +| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_instance_profile) | +| [aws_iam_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | +| [aws_iam_openid_connect_provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_openid_connect_provider) | +| [aws_iam_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | +| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | +| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_role) | +| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | +| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | +| [aws_launch_configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_configuration) | +| [aws_launch_template](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template) | +| [aws_partition](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/partition) | +| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | +| [aws_security_group_rule](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | +| [kubernetes_config_map](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) | +| [local_file](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | +| [null_resource](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | +| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | +| [template_file](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) | + ## Inputs | Name | Description | Type | Default | Required | @@ -177,6 +212,7 @@ MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-a | cluster\_encryption\_config | Configuration block with encryption configuration for the cluster. See examples/secrets\_encryption/main.tf for example format | 
list(object({
    provider_key_arn = string
    resources        = list(string)
  }))
| `[]` | no | | cluster\_endpoint\_private\_access | Indicates whether or not the Amazon EKS private API server endpoint is enabled. | `bool` | `false` | no | | cluster\_endpoint\_private\_access\_cidrs | List of CIDR blocks which can access the Amazon EKS private API server endpoint. | `list(string)` | `null` | no | +| cluster\_endpoint\_private\_access\_sg | List of security group IDs which can access the Amazon EKS private API server endpoint. | `list(string)` | `null` | no | | cluster\_endpoint\_public\_access | Indicates whether or not the Amazon EKS public API server endpoint is enabled. | `bool` | `true` | no | | cluster\_endpoint\_public\_access\_cidrs | List of CIDR blocks which can access the Amazon EKS public API server endpoint. | `list(string)` | 
[
  "0.0.0.0/0"
]
| no | | cluster\_iam\_role\_name | IAM role name for the cluster. Only applicable if manage\_cluster\_iam\_resources is set to false. Set this to reuse an existing IAM role. | `string` | `""` | no | @@ -268,5 +304,4 @@ MIT Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-a | workers\_launch\_template\_ids | IDs of the worker launch templates. | | workers\_launch\_template\_latest\_versions | Latest versions of the worker launch templates. | | workers\_user\_data | User data of worker groups | - diff --git a/modules/fargate/README.md b/modules/fargate/README.md index 8b4c72f25e5..7615eeb6f5e 100644 --- a/modules/fargate/README.md +++ b/modules/fargate/README.md @@ -27,6 +27,20 @@ No requirements. |------|---------| | aws | n/a | +## Modules + +No Modules. + +## Resources + +| Name | +|------| +| [aws_eks_fargate_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eks_fargate_profile) | +| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | +| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_role) | +| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | +| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | + ## Inputs | Name | Description | Type | Default | Required | @@ -52,5 +66,4 @@ No requirements. | fargate\_profile\_ids | EKS Cluster name and EKS Fargate Profile names separated by a colon (:). | | iam\_role\_arn | IAM role ARN for EKS Fargate pods | | iam\_role\_name | IAM role name for EKS Fargate pods | - diff --git a/modules/node_groups/README.md b/modules/node_groups/README.md index e7a1967dc6a..b2c8e051191 100644 --- a/modules/node_groups/README.md +++ b/modules/node_groups/README.md @@ -48,6 +48,17 @@ No requirements. | aws | n/a | | random | n/a | +## Modules + +No Modules. + +## Resources + +| Name | +|------| +| [aws_eks_node_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eks_node_group) | +| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | + ## Inputs | Name | Description | Type | Default | Required | @@ -67,5 +78,4 @@ No requirements. |------|-------------| | aws\_auth\_roles | Roles for use in aws-auth ConfigMap | | node\_groups | Outputs from EKS node groups. Map of maps, keyed by `var.node_groups` keys. See `aws_eks_node_group` Terraform documentation for values | -