You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -243,16 +243,16 @@ We are grateful to the community for contributing bugfixes and improvements! Ple
243
243
| <aname="input_cluster_additional_security_group_ids"></a> [cluster\_additional\_security\_group\_ids](#input\_cluster\_additional\_security\_group\_ids)| List of additional, externally created security group IDs to attach to the cluster control plane |`list(string)`|`[]`| no |
244
244
| <aname="input_cluster_addons"></a> [cluster\_addons](#input\_cluster\_addons)| Map of cluster addon configurations to enable for the cluster. Addon name can be the map keys or set with `name`|`any`|`{}`| no |
245
245
| <aname="input_cluster_addons_timeouts"></a> [cluster\_addons\_timeouts](#input\_cluster\_addons\_timeouts)| Create, update, and delete timeout configurations for the cluster addons |`map(string)`|`{}`| no |
246
-
| <aname="input_cluster_enabled_log_types"></a> [cluster\_enabled\_log\_types](#input\_cluster\_enabled\_log\_types)| A list of the desired control plane logs to enable. For more information, see Amazon EKS Control Plane Logging documentation (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html)|`list(string)`| <pre>[<br> "audit",<br> "api",<br> "authenticator"<br>]</pre> | no |
247
-
| <aname="input_cluster_encryption_config"></a> [cluster\_encryption\_config](#input\_cluster\_encryption\_config)| Configuration block with encryption configuration for the cluster. To disable secret encryption, set this value to `{}`|`any`| <pre>{<br> "resources": [<br> "secrets"<br> ]<br>}</pre> | no |
246
+
| <aname="input_cluster_enabled_log_types"></a> [cluster\_enabled\_log\_types](#input\_cluster\_enabled\_log\_types)| A list of the desired control plane logs to enable. For more information, see Amazon EKS Control Plane Logging documentation (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html)|`list(string)`| <pre>[<br/> "audit",<br/> "api",<br/> "authenticator"<br/>]</pre> | no |
247
+
| <aname="input_cluster_encryption_config"></a> [cluster\_encryption\_config](#input\_cluster\_encryption\_config)| Configuration block with encryption configuration for the cluster. To disable secret encryption, set this value to `{}`|`any`| <pre>{<br/> "resources": [<br/> "secrets"<br/> ]<br/>}</pre> | no |
248
248
| <aname="input_cluster_encryption_policy_description"></a> [cluster\_encryption\_policy\_description](#input\_cluster\_encryption\_policy\_description)| Description of the cluster encryption policy created |`string`|`"Cluster encryption policy to allow cluster role to utilize CMK provided"`| no |
249
249
| <aname="input_cluster_encryption_policy_name"></a> [cluster\_encryption\_policy\_name](#input\_cluster\_encryption\_policy\_name)| Name to use on cluster encryption policy created |`string`|`null`| no |
250
250
| <aname="input_cluster_encryption_policy_path"></a> [cluster\_encryption\_policy\_path](#input\_cluster\_encryption\_policy\_path)| Cluster encryption policy path |`string`|`null`| no |
251
251
| <aname="input_cluster_encryption_policy_tags"></a> [cluster\_encryption\_policy\_tags](#input\_cluster\_encryption\_policy\_tags)| A map of additional tags to add to the cluster encryption policy created |`map(string)`|`{}`| no |
252
252
| <aname="input_cluster_encryption_policy_use_name_prefix"></a> [cluster\_encryption\_policy\_use\_name\_prefix](#input\_cluster\_encryption\_policy\_use\_name\_prefix)| Determines whether cluster encryption policy name (`cluster_encryption_policy_name`) is used as a prefix |`bool`|`true`| no |
253
253
| <aname="input_cluster_endpoint_private_access"></a> [cluster\_endpoint\_private\_access](#input\_cluster\_endpoint\_private\_access)| Indicates whether or not the Amazon EKS private API server endpoint is enabled |`bool`|`true`| no |
254
254
| <aname="input_cluster_endpoint_public_access"></a> [cluster\_endpoint\_public\_access](#input\_cluster\_endpoint\_public\_access)| Indicates whether or not the Amazon EKS public API server endpoint is enabled |`bool`|`false`| no |
255
-
| <aname="input_cluster_endpoint_public_access_cidrs"></a> [cluster\_endpoint\_public\_access\_cidrs](#input\_cluster\_endpoint\_public\_access\_cidrs)| List of CIDR blocks which can access the Amazon EKS public API server endpoint |`list(string)`| <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
255
+
| <aname="input_cluster_endpoint_public_access_cidrs"></a> [cluster\_endpoint\_public\_access\_cidrs](#input\_cluster\_endpoint\_public\_access\_cidrs)| List of CIDR blocks which can access the Amazon EKS public API server endpoint |`list(string)`| <pre>[<br/> "0.0.0.0/0"<br/>]</pre> | no |
256
256
| <aname="input_cluster_identity_providers"></a> [cluster\_identity\_providers](#input\_cluster\_identity\_providers)| Map of cluster identity provider configurations to enable for the cluster. Note - this is different/separate from IRSA |`any`|`{}`| no |
257
257
| <aname="input_cluster_ip_family"></a> [cluster\_ip\_family](#input\_cluster\_ip\_family)| The IP family used to assign Kubernetes pod and service addresses. Valid values are `ipv4` (default) and `ipv6`. You can only specify an IP family when you create a cluster, changing this value will force a new cluster to be created |`string`|`"ipv4"`| no |
258
258
| <aname="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name)| Name of the EKS cluster |`string`|`""`| no |
Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
85
85
86
-
<!--BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK-->
86
+
<!--BEGIN_TF_DOCS-->
87
87
## Requirements
88
88
89
89
| Name | Version |
@@ -176,4 +176,4 @@ No inputs.
176
176
| <aname="output_oidc_provider_arn"></a> [oidc\_provider\_arn](#output\_oidc\_provider\_arn)| The ARN of the OIDC Provider if `enable_irsa = true`|
177
177
| <aname="output_self_managed_node_groups"></a> [self\_managed\_node\_groups](#output\_self\_managed\_node\_groups)| Map of attribute maps for all self managed node groups created |
178
178
| <aname="output_self_managed_node_groups_autoscaling_group_names"></a> [self\_managed\_node\_groups\_autoscaling\_group\_names](#output\_self\_managed\_node\_groups\_autoscaling\_group\_names)| List of the autoscaling group names created by self-managed node groups |
Copy file name to clipboardExpand all lines: modules/_user_data/README.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Configuration in this directory renders the appropriate user data for the given
4
4
5
5
See [`examples/user_data/`](https://github.com/terraform-aws-modules/terraform-aws-eks/tree/master/examples/user_data) for various examples using this module.
6
6
7
-
<!--BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK-->
7
+
<!--BEGIN_TF_DOCS-->
8
8
## Requirements
9
9
10
10
| Name | Version |
@@ -39,8 +39,8 @@ No modules.
39
39
| <aname="input_additional_cluster_dns_ips"></a> [additional\_cluster\_dns\_ips](#input\_additional\_cluster\_dns\_ips)| Additional DNS IP addresses to use for the cluster. Only used when `ami_type` = `BOTTLEROCKET_*`|`list(string)`|`[]`| no |
40
40
| <aname="input_ami_type"></a> [ami\_type](#input\_ami\_type)| Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the [AWS documentation](https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType) for valid values |`string`|`null`| no |
41
41
| <aname="input_bootstrap_extra_args"></a> [bootstrap\_extra\_args](#input\_bootstrap\_extra\_args)| Additional arguments passed to the bootstrap script. When `ami_type` = `BOTTLEROCKET_*`; these are additional [settings](https://github.com/bottlerocket-os/bottlerocket#settings) that are provided to the Bottlerocket user data |`string`|`""`| no |
42
-
| <aname="input_cloudinit_post_nodeadm"></a> [cloudinit\_post\_nodeadm](#input\_cloudinit\_post\_nodeadm)| Array of cloud-init document parts that are created after the nodeadm document part | <pre>list(object({<br> content = string<br> content_type = optional(string)<br> filename = optional(string)<br> merge_type = optional(string)<br> }))</pre> |`[]`| no |
43
-
| <aname="input_cloudinit_pre_nodeadm"></a> [cloudinit\_pre\_nodeadm](#input\_cloudinit\_pre\_nodeadm)| Array of cloud-init document parts that are created before the nodeadm document part | <pre>list(object({<br> content = string<br> content_type = optional(string)<br> filename = optional(string)<br> merge_type = optional(string)<br> }))</pre> |`[]`| no |
42
+
| <aname="input_cloudinit_post_nodeadm"></a> [cloudinit\_post\_nodeadm](#input\_cloudinit\_post\_nodeadm)| Array of cloud-init document parts that are created after the nodeadm document part | <pre>list(object({<br/> content = string<br/> content_type = optional(string)<br/> filename = optional(string)<br/> merge_type = optional(string)<br/> }))</pre> |`[]`| no |
43
+
| <aname="input_cloudinit_pre_nodeadm"></a> [cloudinit\_pre\_nodeadm](#input\_cloudinit\_pre\_nodeadm)| Array of cloud-init document parts that are created before the nodeadm document part | <pre>list(object({<br/> content = string<br/> content_type = optional(string)<br/> filename = optional(string)<br/> merge_type = optional(string)<br/> }))</pre> |`[]`| no |
44
44
| <aname="input_cluster_auth_base64"></a> [cluster\_auth\_base64](#input\_cluster\_auth\_base64)| Base64 encoded CA of associated EKS cluster |`string`|`""`| no |
45
45
| <aname="input_cluster_endpoint"></a> [cluster\_endpoint](#input\_cluster\_endpoint)| Endpoint of associated EKS cluster |`string`|`""`| no |
46
46
| <aname="input_cluster_ip_family"></a> [cluster\_ip\_family](#input\_cluster\_ip\_family)| The IP family used to assign Kubernetes pod and service addresses. Valid values are `ipv4` (default) and `ipv6`|`string`|`"ipv4"`| no |
@@ -61,4 +61,4 @@ No modules.
61
61
|------|-------------|
62
62
| <aname="output_platform"></a> [platform](#output\_platform)|[DEPRECATED - Will be removed in `v21.0`] Identifies the OS platform as `bottlerocket`, `linux` (AL2), `al2023, or `windows |
63
63
| <aname="output_user_data"></a> [user\_data](#output\_user\_data)| Base64 encoded user data rendered for the provided inputs |
| <aname="input_bootstrap_extra_args"></a> [bootstrap\_extra\_args](#input\_bootstrap\_extra\_args)| Additional arguments passed to the bootstrap script. When `ami_type` = `BOTTLEROCKET_*`; these are additional [settings](https://github.com/bottlerocket-os/bottlerocket#settings) that are provided to the Bottlerocket user data |`string`|`""`| no |
111
111
| <aname="input_capacity_reservation_specification"></a> [capacity\_reservation\_specification](#input\_capacity\_reservation\_specification)| Targeting for EC2 capacity reservations |`any`|`{}`| no |
112
112
| <aname="input_capacity_type"></a> [capacity\_type](#input\_capacity\_type)| Type of capacity associated with the EKS Node Group. Valid values: `ON_DEMAND`, `SPOT`|`string`|`"ON_DEMAND"`| no |
113
-
| <aname="input_cloudinit_post_nodeadm"></a> [cloudinit\_post\_nodeadm](#input\_cloudinit\_post\_nodeadm)| Array of cloud-init document parts that are created after the nodeadm document part | <pre>list(object({<br> content = string<br> content_type = optional(string)<br> filename = optional(string)<br> merge_type = optional(string)<br> }))</pre> |`[]`| no |
114
-
| <aname="input_cloudinit_pre_nodeadm"></a> [cloudinit\_pre\_nodeadm](#input\_cloudinit\_pre\_nodeadm)| Array of cloud-init document parts that are created before the nodeadm document part | <pre>list(object({<br> content = string<br> content_type = optional(string)<br> filename = optional(string)<br> merge_type = optional(string)<br> }))</pre> |`[]`| no |
113
+
| <aname="input_cloudinit_post_nodeadm"></a> [cloudinit\_post\_nodeadm](#input\_cloudinit\_post\_nodeadm)| Array of cloud-init document parts that are created after the nodeadm document part | <pre>list(object({<br/> content = string<br/> content_type = optional(string)<br/> filename = optional(string)<br/> merge_type = optional(string)<br/> }))</pre> |`[]`| no |
114
+
| <aname="input_cloudinit_pre_nodeadm"></a> [cloudinit\_pre\_nodeadm](#input\_cloudinit\_pre\_nodeadm)| Array of cloud-init document parts that are created before the nodeadm document part | <pre>list(object({<br/> content = string<br/> content_type = optional(string)<br/> filename = optional(string)<br/> merge_type = optional(string)<br/> }))</pre> |`[]`| no |
115
115
| <aname="input_cluster_auth_base64"></a> [cluster\_auth\_base64](#input\_cluster\_auth\_base64)| Base64 encoded CA of associated EKS cluster |`string`|`""`| no |
116
116
| <aname="input_cluster_endpoint"></a> [cluster\_endpoint](#input\_cluster\_endpoint)| Endpoint of associated EKS cluster |`string`|`""`| no |
117
117
| <aname="input_cluster_ip_family"></a> [cluster\_ip\_family](#input\_cluster\_ip\_family)| The IP family used to assign Kubernetes pod and service addresses. Valid values are `ipv4` (default) and `ipv6`|`string`|`"ipv4"`| no |
| <aname="input_license_specifications"></a> [license\_specifications](#input\_license\_specifications)| A map of license specifications to associate with |`any`|`{}`| no |
165
165
| <aname="input_maintenance_options"></a> [maintenance\_options](#input\_maintenance\_options)| The maintenance options for the instance |`any`|`{}`| no |
166
166
| <aname="input_max_size"></a> [max\_size](#input\_max\_size)| Maximum number of instances/nodes |`number`|`3`| no |
167
-
| <aname="input_metadata_options"></a> [metadata\_options](#input\_metadata\_options)| Customize the metadata options for the instance |`map(string)`| <pre>{<br> "http_endpoint": "enabled",<br> "http_put_response_hop_limit": 2,<br> "http_tokens": "required"<br>}</pre> | no |
167
+
| <aname="input_metadata_options"></a> [metadata\_options](#input\_metadata\_options)| Customize the metadata options for the instance |`map(string)`| <pre>{<br/> "http_endpoint": "enabled",<br/> "http_put_response_hop_limit": 2,<br/> "http_tokens": "required"<br/>}</pre> | no |
168
168
| <aname="input_min_size"></a> [min\_size](#input\_min\_size)| Minimum number of instances/nodes |`number`|`0`| no |
169
169
| <aname="input_name"></a> [name](#input\_name)| Name of the EKS managed node group |`string`|`""`| no |
170
170
| <aname="input_network_interfaces"></a> [network\_interfaces](#input\_network\_interfaces)| Customize network interfaces to be attached at instance boot time |`list(any)`|`[]`| no |
| <aname="input_remote_access"></a> [remote\_access](#input\_remote\_access)| Configuration block with remote access settings. Only valid when `use_custom_launch_template` = `false`|`any`|`{}`| no |
180
180
| <aname="input_schedules"></a> [schedules](#input\_schedules)| Map of autoscaling group schedule to create |`map(any)`|`{}`| no |
181
181
| <aname="input_subnet_ids"></a> [subnet\_ids](#input\_subnet\_ids)| Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag: `kubernetes.io/cluster/CLUSTER_NAME`|`list(string)`|`null`| no |
182
-
| <aname="input_tag_specifications"></a> [tag\_specifications](#input\_tag\_specifications)| The tags to apply to the resources during launch |`list(string)`| <pre>[<br> "instance",<br> "volume",<br> "network-interface"<br>]</pre> | no |
182
+
| <aname="input_tag_specifications"></a> [tag\_specifications](#input\_tag\_specifications)| The tags to apply to the resources during launch |`list(string)`| <pre>[<br/> "instance",<br/> "volume",<br/> "network-interface"<br/>]</pre> | no |
183
183
| <aname="input_tags"></a> [tags](#input\_tags)| A map of tags to add to all resources |`map(string)`|`{}`| no |
184
184
| <aname="input_taints"></a> [taints](#input\_taints)| The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group |`any`|`{}`| no |
185
185
| <aname="input_timeouts"></a> [timeouts](#input\_timeouts)| Create, update, and delete timeout configurations for the node group |`map(string)`|`{}`| no |
186
-
| <aname="input_update_config"></a> [update\_config](#input\_update\_config)| Configuration block of settings for max unavailable resources during node group updates |`map(string)`| <pre>{<br> "max_unavailable_percentage": 33<br>}</pre> | no |
186
+
| <aname="input_update_config"></a> [update\_config](#input\_update\_config)| Configuration block of settings for max unavailable resources during node group updates |`map(string)`| <pre>{<br/> "max_unavailable_percentage": 33<br/>}</pre> | no |
187
187
| <aname="input_update_launch_template_default_version"></a> [update\_launch\_template\_default\_version](#input\_update\_launch\_template\_default\_version)| Whether to update the launch templates default version on each update. Conflicts with `launch_template_default_version`|`bool`|`true`| no |
188
188
| <aname="input_use_custom_launch_template"></a> [use\_custom\_launch\_template](#input\_use\_custom\_launch\_template)| Determines whether to use a custom launch template or not. If set to `false`, EKS will use its own default launch template |`bool`|`true`| no |
189
189
| <aname="input_use_latest_ami_release_version"></a> [use\_latest\_ami\_release\_version](#input\_use\_latest\_ami\_release\_version)| Determines whether to use the latest AMI release version for the given `ami_type` (except for `CUSTOM`). Note: `ami_type` and `cluster_version` must be supplied in order to enable this feature |`bool`|`false`| no |
| <aname="output_node_group_status"></a> [node\_group\_status](#output\_node\_group\_status)| Status of the EKS Node Group |
212
212
| <aname="output_node_group_taints"></a> [node\_group\_taints](#output\_node\_group\_taints)| List of objects containing information about taints applied to the node group |
213
213
| <aname="output_platform"></a> [platform](#output\_platform)|[DEPRECATED - Will be removed in `v21.0`] Identifies the OS platform as `bottlerocket`, `linux` (AL2), `al2023`, or `windows`|
0 commit comments