Skip to content

Commit babd43f

Browse files
haoucjayanthvn
andauthored
adding a note to minimum ip target (#2739)
Co-authored-by: Jayanth Varavani <[email protected]>
1 parent 00359d1 commit babd43f

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,8 @@ in the *Amazon EC2 User Guide for Linux Instances*.
282282
For example, an `m4.4xlarge` launches with 1 network interface and 30 IP addresses\. If 5 pods are placed on the node and 5 free IP
283283
addresses are removed from the IP address warm pool, then `ipamd` attempts to allocate more interfaces until `WARM_ENI_TARGET` free
284284
interfaces are available on the node.
285-
If `WARM_IP_TARGET` is set, then this environment variable is ignored and the `WARM_IP_TARGET` behavior is used instead.
285+
286+
**NOTE!** If `WARM_IP_TARGET` is set, then this environment variable is ignored and the `WARM_IP_TARGET` behavior is used instead.
286287

287288
#### `WARM_IP_TARGET`
288289

@@ -333,6 +334,10 @@ elasticity, but uses roughly half as many IPs as using WARM_IP_TARGET alone (32
333334
This also improves the reliability of the EKS cluster by reducing the number of calls necessary to allocate or deallocate
334335
private IPs, which may be throttled, especially at scaling-related times.
335336

337+
**NOTE!**
338+
1. If `MINIMUM_IP_TARGET` is set, `WARM_ENI_TARGET` will be ignored. Please utilize `WARM_IP_TARGET` instead.
339+
2. If `MINIMUM_IP_TARGET` is set and `WARM_IP_TARGET` is not set, `WARM_IP_TARGET` is assumed to be 0, which leads to the number of IPs attached to the node will be the value of `MINIMUM_IP_TARGET`. This configuration will prevent future ENIs/IPs from being allocated. It is strongly recommended that `WARM_IP_TARGET` should be set greater than 0 when `MINIMUM_IP_TARGET` is set.
340+
336341
#### `MAX_ENI`
337342

338343
Type: Integer

0 commit comments

Comments
 (0)