AWS cli documentation change
Summary
Added documentation for the new --warm-pool-config parameter for EKS create-nodegroup command, including configuration options for warm pool instances with states (Stopped, Running, Hibernated) and reuse behavior
Security assessment
This change documents a new feature for warm pool configuration in EKS node groups, which is a performance and cost optimization feature for scaling. There is no evidence of security vulnerability remediation or security incident response. The documentation focuses on operational efficiency, instance lifecycle management, and cost considerations rather than security controls or vulnerabilities.
Diff
diff --git a/cli/latest/reference/eks/create-nodegroup.md b/cli/latest/reference/eks/create-nodegroup.md index b984a3532..5e0bd9285 100644 --- a//cli/latest/reference/eks/create-nodegroup.md +++ b//cli/latest/reference/eks/create-nodegroup.md @@ -15 +15 @@ - * [AWS CLI 2.34.25 Command Reference](../../index.html) » + * [AWS CLI 2.34.28 Command Reference](../../index.html) » @@ -95,0 +96 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/eks-20 + [--warm-pool-config <value>] @@ -650,0 +652,56 @@ JSON Syntax: +`--warm-pool-config` (structure) + +> The warm pool configuration for the node group. Warm pools maintain pre-initialized EC2 instances that can quickly join your cluster during scale-out events, improving application scaling performance and reducing costs. +> +> enabled -> (boolean) +> +>> Specifies whether to attach warm pools on the managed node group. Set to `true` to enable the warm pool, or `false` to disable and remove it. If not specified during an update, the current value is preserved. +> +> minSize -> (integer) +> +>> The minimum number of instances to maintain in the warm pool. Default: `0` . Size your warm pool based on scaling patterns to balance cost and availability. Start with 10-20% of expected peak capacity. +>> +>> Constraints: +>> +>> * min: `0` +>> + +> +> maxGroupPreparedCapacity -> (integer) +> +>> The maximum total number of instances across the warm pool and Auto Scaling group combined. This value controls the total prepared capacity available for your node group. +> +> poolState -> (string) +> +>> The desired state for warm pool instances. Default: `Stopped` . Valid values are `Stopped` (most cost-effective with EBS storage costs only), `Running` (fastest transition time with full EC2 costs), and `Hibernated` (balance between cost and speed, only supported on specific instance types). Warm pool instances in the `Hibernated` state are not supported with Bottlerocket AMIs. +>> +>> Possible values: +>> +>> * `STOPPED` +>> * `RUNNING` +>> * `HIBERNATED` +>> + +> +> reuseOnScaleIn -> (boolean) +> +>> Indicates whether instances should return to the warm pool during scale-in events instead of being terminated. Default: `false` . Enable this to reduce costs by reusing instances. This feature is not supported for Bottlerocket AMIs. + +Shorthand Syntax: + + + enabled=boolean,minSize=integer,maxGroupPreparedCapacity=integer,poolState=string,reuseOnScaleIn=boolean + + +JSON Syntax: + + + { + "enabled": true|false, + "minSize": integer, + "maxGroupPreparedCapacity": integer, + "poolState": "STOPPED"|"RUNNING"|"HIBERNATED", + "reuseOnScaleIn": true|false + } + + @@ -1487,0 +1545,38 @@ nodegroup -> (structure) +> +> warmPoolConfig -> (structure) +> +>> The warm pool configuration attached to the node group. Amazon EKS manages warm pools throughout the node group lifecycle using the `AWSServiceRoleForAmazonEKSNodegroup` service-linked role to create, update, and delete warm pool resources. +>> +>> enabled -> (boolean) +>> +>>> Specifies whether to attach warm pools on the managed node group. Set to `true` to enable the warm pool, or `false` to disable and remove it. If not specified during an update, the current value is preserved. +>> +>> minSize -> (integer) +>> +>>> The minimum number of instances to maintain in the warm pool. Default: `0` . Size your warm pool based on scaling patterns to balance cost and availability. Start with 10-20% of expected peak capacity. +>>> +>>> Constraints: +>>> +>>> * min: `0` +>>> + +>> +>> maxGroupPreparedCapacity -> (integer) +>> +>>> The maximum total number of instances across the warm pool and Auto Scaling group combined. This value controls the total prepared capacity available for your node group. +>> +>> poolState -> (string) +>> +>>> The desired state for warm pool instances. Default: `Stopped` . Valid values are `Stopped` (most cost-effective with EBS storage costs only), `Running` (fastest transition time with full EC2 costs), and `Hibernated` (balance between cost and speed, only supported on specific instance types). Warm pool instances in the `Hibernated` state are not supported with Bottlerocket AMIs. +>>> +>>> Possible values: +>>> +>>> * `STOPPED` +>>> * `RUNNING` +>>> * `HIBERNATED` +>>> + +>> +>> reuseOnScaleIn -> (boolean) +>> +>>> Indicates whether instances should return to the warm pool during scale-in events instead of being terminated. Default: `false` . Enable this to reduce costs by reusing instances. This feature is not supported for Bottlerocket AMIs. @@ -1499 +1594 @@ nodegroup -> (structure) - * [AWS CLI 2.34.25 Command Reference](../../index.html) » + * [AWS CLI 2.34.28 Command Reference](../../index.html) »