Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 106 additions & 1 deletion docs/reference/services/app-orchestration/amazon-eks-workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,11 @@ module "eks_workers" {
# if asg_iam_role_already_exists is true.
asg_custom_iam_role_name = null

# Default value for asg_ami_type field of autoscaling_group_configurations.
# See the AWS documentation for valid values. Docs:
# https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType
asg_default_ami_type = "AL2_x86_64"

# Default value for enable_detailed_monitoring field of
# autoscaling_group_configurations.
asg_default_enable_detailed_monitoring = true
Expand Down Expand Up @@ -238,6 +243,11 @@ module "eks_workers" {
# asg_instance_type will use this value.
asg_default_instance_type = "t3.medium"

# Default value for the asg_instance_user_data_base64 field of
# autoscaling_group_configurations. Any map entry that does not specify
# asg_instance_user_data_base64 will use this value.
asg_default_instance_user_data_base64 = null

# Default value for the max_pods_allowed field of
# autoscaling_group_configurations. Any map entry that does not specify
# max_pods_allowed will use this value.
Expand Down Expand Up @@ -479,6 +489,10 @@ module "eks_workers" {
# Must be one of: 'missing', 'ignore', 'breaching' or 'notBreaching'.
high_worker_memory_utilization_treat_missing_data = "missing"

# Whether or not to create an AWS Security Group for the Managed Node Groups.
# By default this is created.
managed_node_group_create_security_group = true

# Custom name for the IAM role for the Managed Node Groups. When null, a
# default name based on worker_name_prefix will be used. One of
# managed_node_group_custom_iam_role_name and managed_node_group_iam_role_arn
Expand All @@ -497,6 +511,11 @@ module "eks_workers" {
# is true.
managed_node_group_iam_role_arn = null

# Default value for ami_type field of managed_node_group_configurations. See
# the AWS documentation for valid values. Docs:
# https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType
node_group_default_ami_type = "AL2_x86_64"

# Default value for capacity_type field of managed_node_group_configurations.
node_group_default_capacity_type = "ON_DEMAND"

Expand Down Expand Up @@ -565,6 +584,11 @@ module "eks_workers" {
# only used if the taint field is omitted from the configuration.
node_group_default_taints = []

# Default value for the user_data_base64 field of
# managed_node_group_configurations. Any map entry that does not specify
# user_data_base64 will use this value.
node_group_default_user_data_base64 = null

# The instance type to configure in the launch template. This value will be
# used when the instance_types field is set to null (NOT omitted, in which
# case var.node_group_default_instance_types will be used).
Expand Down Expand Up @@ -749,6 +773,11 @@ inputs = {
# if asg_iam_role_already_exists is true.
asg_custom_iam_role_name = null

# Default value for asg_ami_type field of autoscaling_group_configurations.
# See the AWS documentation for valid values. Docs:
# https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType
asg_default_ami_type = "AL2_x86_64"

# Default value for enable_detailed_monitoring field of
# autoscaling_group_configurations.
asg_default_enable_detailed_monitoring = true
Expand Down Expand Up @@ -796,6 +825,11 @@ inputs = {
# asg_instance_type will use this value.
asg_default_instance_type = "t3.medium"

# Default value for the asg_instance_user_data_base64 field of
# autoscaling_group_configurations. Any map entry that does not specify
# asg_instance_user_data_base64 will use this value.
asg_default_instance_user_data_base64 = null

# Default value for the max_pods_allowed field of
# autoscaling_group_configurations. Any map entry that does not specify
# max_pods_allowed will use this value.
Expand Down Expand Up @@ -1037,6 +1071,10 @@ inputs = {
# Must be one of: 'missing', 'ignore', 'breaching' or 'notBreaching'.
high_worker_memory_utilization_treat_missing_data = "missing"

# Whether or not to create an AWS Security Group for the Managed Node Groups.
# By default this is created.
managed_node_group_create_security_group = true

# Custom name for the IAM role for the Managed Node Groups. When null, a
# default name based on worker_name_prefix will be used. One of
# managed_node_group_custom_iam_role_name and managed_node_group_iam_role_arn
Expand All @@ -1055,6 +1093,11 @@ inputs = {
# is true.
managed_node_group_iam_role_arn = null

# Default value for ami_type field of managed_node_group_configurations. See
# the AWS documentation for valid values. Docs:
# https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType
node_group_default_ami_type = "AL2_x86_64"

# Default value for capacity_type field of managed_node_group_configurations.
node_group_default_capacity_type = "ON_DEMAND"

Expand Down Expand Up @@ -1123,6 +1166,11 @@ inputs = {
# only used if the taint field is omitted from the configuration.
node_group_default_taints = []

# Default value for the user_data_base64 field of
# managed_node_group_configurations. Any map entry that does not specify
# user_data_base64 will use this value.
node_group_default_user_data_base64 = null

# The instance type to configure in the launch template. This value will be
# used when the instance_types field is set to null (NOT omitted, in which
# case var.node_group_default_instance_types will be used).
Expand Down Expand Up @@ -1276,6 +1324,10 @@ Any types represent complex values of variable type. For details, please consult
will be used to deploy updates to the cluster.
- asg_instance_type string : (Defaults to value from var.asg_default_instance_type) The type of
instances to use for the ASG (e.g., t2.medium).
- asg_ami_type string : (Defaults to value from var.asg_default_ami_type) Type of Amazon
Machine Image (e.g. AL2_x86_64, AL2_x86_64_GPU) associated with the EKS
Node Group. See the AWS documentation for valid values.
https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.htmlAmazonEKS-Type-Nodegroup-amiType
- max_pods_allowed number : (Defaults to value from var.asg_default_max_pods_allowed) The
maximum number of Pods allowed to be scheduled on the node. When null,
the max will be automatically calculated based on the availability of
Expand All @@ -1290,6 +1342,8 @@ Any types represent complex values of variable type. For details, please consult
instances to use for the ASG (e.g., 125).
- asg_instance_root_volume_encryption bool : (Defaults to value from var.asg_default_instance_root_volume_encryption)
Whether or not to enable root volume encryption for instances of the ASG.
- asg_instance_user_data_base64 string : (Defaults to value from var.asg_default_instance_user_data_base64) The base64 user-data content of
instance to use for the ASG.
- tags list(object[Tag]) : (Defaults to value from var.asg_default_tags) Custom tags to apply to the
EC2 Instances in this ASG. Refer to structure definition below for the
object type of each entry in the list.
Expand Down Expand Up @@ -1461,6 +1515,12 @@ Any types represent complex values of variable type. For details, please consult
nodes. EKS will choose from this list of instance types when launching
new instances. When using launch templates, this setting will override
the configured instance type of the launch template.
- ami_type string : (Defaults to value from var.node_group_default_ami_type) Type of Amazon
Machine Image (e.g. AL2_x86_64, AL2_x86_64_GPU) associated with the EKS
Node Group. See the AWS documentation for valid values.
https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.htmlAmazonEKS-Type-Nodegroup-amiType
- user_data_base64 string : (Defaults to value from var.node_group_default_user_data_base64) The base64 user-data content of
instance to use for the Node Group.
- capacity_type string : (Defaults to value from var.node_group_default_capacity_type) Type of capacity
associated with the EKS Node Group. Valid values: ON_DEMAND, SPOT.
- launch_template LaunchTemplate : (Defaults to value from var.node_group_default_launch_template)
Expand Down Expand Up @@ -1599,6 +1659,15 @@ Custom name for the IAM role for the Self-managed workers. When null, a default
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="asg_default_ami_type" requirement="optional" type="string">
<HclListItemDescription>

Default value for asg_ami_type field of autoscaling_group_configurations. See the AWS documentation for valid values. Docs: https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="&quot;AL2_x86_64&quot;"/>
</HclListItem>

<HclListItem name="asg_default_enable_detailed_monitoring" requirement="optional" type="bool">
<HclListItemDescription>

Expand Down Expand Up @@ -1719,6 +1788,15 @@ Default value for the asg_instance_type field of autoscaling_group_configuration
<HclListItemDefaultValue defaultValue="&quot;t3.medium&quot;"/>
</HclListItem>

<HclListItem name="asg_default_instance_user_data_base64" requirement="optional" type="string">
<HclListItemDescription>

Default value for the asg_instance_user_data_base64 field of autoscaling_group_configurations. Any map entry that does not specify asg_instance_user_data_base64 will use this value.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="asg_default_max_pods_allowed" requirement="optional" type="number">
<HclListItemDescription>

Expand Down Expand Up @@ -2431,6 +2509,15 @@ Sets how this alarm should handle entering the INSUFFICIENT_DATA state. Based on
<HclListItemDefaultValue defaultValue="&quot;missing&quot;"/>
</HclListItem>

<HclListItem name="managed_node_group_create_security_group" requirement="optional" type="bool">
<HclListItemDescription>

Whether or not to create an AWS Security Group for the Managed Node Groups. By default this is created.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="true"/>
</HclListItem>

<HclListItem name="managed_node_group_custom_iam_role_name" requirement="optional" type="string">
<HclListItemDescription>

Expand Down Expand Up @@ -2458,6 +2545,15 @@ ARN of the IAM role to use if iam_role_already_exists = true. When null, uses ma
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="node_group_default_ami_type" requirement="optional" type="string">
<HclListItemDescription>

Default value for ami_type field of managed_node_group_configurations. See the AWS documentation for valid values. Docs: https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="&quot;AL2_x86_64&quot;"/>
</HclListItem>

<HclListItem name="node_group_default_capacity_type" requirement="optional" type="string">
<HclListItemDescription>

Expand Down Expand Up @@ -2627,6 +2723,15 @@ list(map(string))
<HclListItemDefaultValue defaultValue="[]"/>
</HclListItem>

<HclListItem name="node_group_default_user_data_base64" requirement="optional" type="string">
<HclListItemDescription>

Default value for the user_data_base64 field of managed_node_group_configurations. Any map entry that does not specify user_data_base64 will use this value.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="node_group_launch_template_instance_type" requirement="optional" type="string">
<HclListItemDescription>

Expand Down Expand Up @@ -2896,6 +3001,6 @@ The list of names of the ASGs that were deployed to act as EKS workers.
"https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/v0.130.5/modules/services/eks-workers/outputs.tf"
],
"sourcePlugin": "service-catalog-api",
"hash": "adc816a4b69b80d88a5e5a211e74f038"
"hash": "b65e57ca25020da830fd90e05519e030"
}
##DOCS-SOURCER-END -->