Skip to content

Commit 7d52be6

Browse files
authored
Update README.md with more details on lifecycle state in IMDS mode (#1117)
1 parent e981e08 commit 7d52be6

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,17 @@ Both modes (IMDS and Queue Processor) monitor for events affecting your EC2 inst
4848
- Webhook feature to send shutdown or restart notification messages
4949
- Unit & integration tests
5050

51-
### Instance Metadata Service Processor
51+
### Instance Metadata Service (IMDS) Processor
5252
Must be deployed as a Kubernetes **DaemonSet**.
5353

5454
- Monitors EC2 Instance Metadata for:
5555
- [Spot Instance Termination Notifications](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-instance-termination-notices.html)
5656
- [Scheduled Events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html)
5757
- [Instance Rebalance Recommendations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/rebalance-recommendations.html)
58+
- [Autoscaling Group Target Lifecycle State changes](https://docs.aws.amazon.com/autoscaling/ec2/userguide/retrieving-target-lifecycle-state-through-imds.html)
59+
60+
#### IMDS Processor with ASG Target Lifecycle State change
61+
Please note that IMDS does **not** support lifecycle *hooks*, but it does support lifecycle *state* change. When using IMDS mode with the ASG target lifecycle state, ASG will update instance metadata to be **Terminated** before it terminates the node. NTH will monitor the path latest/meta-data/autoscaling/target-lifecycle-state for changes and will cordon and drain when the target state is set to **Terminated**.
5862

5963
### Queue Processor
6064
Must be deployed as a Kubernetes **Deployment**. Also requires some **additional infrastructure setup** (including SQS queue, EventBridge rules).
@@ -84,7 +88,8 @@ When using the EC2 Console or EC2 API to terminate the instance, a state-change
8488
| Scheduled Events |||
8589
| Instance Rebalance Recommendation |||
8690
| ASG Termination Lifecycle Hooks |||
87-
| AZ Rebalance Recommendation |||
91+
| ASG Termination Lifecycle State Change |||
92+
| AZ Rebalance Recommendation |||
8893
| Instance State Change Events |||
8994

9095
### Kubernetes Compatibility

0 commit comments

Comments
 (0)