Make documentation less confusing

Author: dpiddock

modules/node_groups/README.md

@@ -10,6 +10,27 @@ The role ARN specified in `var.default_iam_role_arn` will be used by default. In
 
 `iam_role_arn` must be specified in either `var.node_groups_defaults` or `var.node_groups` if the default parent IAM role is not being created for whatever reason, for example if `manage_worker_iam_resources` is set to false in the parent.
 
+## `node_groups` and `node_groups_defaults` keys
+`node_groups_defaults` is a map that can take the below keys. Values will be used if not specified in individual node groups.
+
+`node_groups` is a map of maps. Key of first level will be used as unique value for `for_each` resources and in the `aws_eks_node_group` name. Inner map can take the below values.
+
+| Name | Description | Type | If unset |
+|------|-------------|:----:|:-----:|
+| additional\_tags | Additional tags to apply to node group | map(string) | Only `var.tags` applied |
+| ami\_release\_version | AMI version of workers | string | Provider default behavior |
+| ami\_type | AMI Type. See Terraform or AWS docs | string | Provider default behavior |
+| desired\_capacity | Desired number of workers | number | `var.workers_group_defaults[asg_desired_capacity]` |
+| disk\_size | Workers' disk size | number | Provider default behavior |
+| iam\_role\_arn | IAM role ARN for workers | string | `var.default_iam_role_arn` |
+| instance\_type | Workers' instance type | string | `var.workers_group_defaults[instance_type]` |
+| k8s\_labels | Kubernetes labels | map(string) | No labels applied |
+| key\_name | Key name for workers. Set to empty string to disable remote access | string | `var.workers_group_defaults[key_name]` |
+| max\_capacity | Max number of workers | number | `var.workers_group_defaults[asg_max_size]` |
+| min\_capacity | Min number of workers | number | `var.workers_group_defaults[asg_min_size]` |
+| source\_security\_group\_ids | Source security groups for remote access to workers | list(string) | If key\_name is specified: THE REMOTE ACCESS WILL BE OPENED TO THE WORLD |
+| subnets | Subnets to contain workers | list(string) | `var.workers_group_defaults[subnets]` |
+
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
@@ -20,7 +41,7 @@ The role ARN specified in `var.default_iam_role_arn` will be used by default. In
 | create\_eks | Controls if EKS resources should be created (it affects almost all resources) | bool | `"true"` | no |
 | default\_iam\_role\_arn | ARN of the default IAM worker role to use if one is not specified in the node_groups | string | n/a | yes |
 | node\_groups | Map of maps of `eks_node_groups` to create. See `node_groups_defaults` for valid keys and types. | any | `{}` | no |
-| node\_groups\_defaults | map of maps of node groups to create. See default for valid keys and type. See source for extra comments | any | `{ "additional_tags": [ { "key": "" } ], "ami_release_version": "", "ami_type": "", "desired_capacity": 0, "disk_size": 0, "iam_role_arn": "", "instance_type": "", "k8s_labels": [ { "key": "" } ], "key_name": "", "max_capacity": 0, "min_capacity": 0, "source_security_group_ids": [ "" ], "subnets": [ "" ] }` | no |
+| node\_groups\_defaults | map of maps of node groups to create. See default for valid keys and type. See source for extra comments | any | n/a | yes |
 | tags | A map of tags to add to all resources | map(string) | n/a | yes |
 | workers\_group\_defaults | Workers group defaults from parent | any | n/a | yes |
 

modules/node_groups/variables.tf

@@ -32,23 +32,6 @@ variable "tags" {
 variable "node_groups_defaults" {
   description = "map of maps of node groups to create. See default for valid keys and type. See source for extra comments"
   type        = any
-
-  # This will be always be overriden by the value from the top level module
-  default = {
-    iam_role_arn              = ""           # IAM Role ARN for workers. If unset: uses `var.default_iam_role_arn`
-    subnets                   = [""]         # Subnets to contain workers. If unset: uses `var.workers_group_defaults[subnets]`
-    desired_capacity          = 0            # Desired number of workers. If unset: uses `var.workers_group_defaults[asg_desired_capacity]`
-    max_capacity              = 0            # Max number of workers. If unset: uses `var.workers_group_defaults[asg_max_size]`
-    min_capacity              = 0            # Min number of workers. If unset: uses `var.workers_group_defaults[asg_min_size]`
-    ami_type                  = ""           # AMI type. See Terraform docs. If unset: falls back to provider default behavior
-    disk_size                 = 0            # Workers' disk size. If unset: falls back to provider default behavior
-    instance_type             = ""           # Workers' instance type. If unset: uses `var.workers_group_defaults[instance_type]`
-    k8s_labels                = { key = "" } # Map of Kubernetes labels. If unset: no extra labels set
-    ami_release_version       = ""           # AMI version of workers. If unset: falls back to provider default behavior
-    key_name                  = ""           # Key name for workers. Set to empty string to disable remote access. If unset: uses `var.workers_group_defaults[key_name]`
-    source_security_group_ids = [""]         # List of source security groups for remote access to workers. If unset and key_name is specified: THE REMOTE ACCESS PORT WILL BE OPENED TO THE WORLD
-    additional_tags           = { key = "" } # Additional tags to apply to node_group. If unset: only `var.tags` applied
-  }
 }
 
 variable "node_groups" {