Skip to content

Commit f7ad48e

Browse files
authored
Clarify wording about using AGS tags. Fix broken docs link. (#721)
1 parent 5c39cc4 commit f7ad48e

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -285,21 +285,20 @@ $ aws autoscaling create-or-update-tags \
285285
--tags ResourceId=my-auto-scaling-group,ResourceType=auto-scaling-group,Key=aws-node-termination-handler/managed,Value=,PropagateAtLaunch=true
286286
```
287287

288-
To tag an EC2 instance:
288+
To tag an individual EC2 instance:
289289
```
290290
aws ec2 create-tags \
291291
--resources i-1234567890abcdef0 \
292292
--tags 'Key="aws-node-termination-handler/managed",Value='
293293
```
294294

295-
This functionality is helpful in accounts where there are ASGs that do not run kubernetes nodes or you do not want aws-node-termination-handler to manage their termination lifecycle.
296-
However, if your account is dedicated to ASGs for your kubernetes cluster, then you can turn off the ASG tag check by setting the flag `--check-tag-before-draining=false` or environment variable `CHECK_TAG_BEFORE_DRAINING=false`.
295+
Tagging your EC2 instances in this way is helpful if you only want aws-node-termination-handler to manage the lifecycle of instances in certain ASGs. For example, if your account also has other ASGs that do not contain Kubernetes nodes, this tagging mechanism will ensure that NTH does not manage the lifecycle of any instances in those non-Kubernetes ASGs.
297296

298-
You can also control what resources NTH manages by adding the resource ARNs to your Amazon EventBridge rules.
297+
However, if the only ASGs in your account are for your Kubernetes cluster, then you can turn off the tag check by setting the flag `--check-tag-before-draining=false` or environment variable `CHECK_TAG_BEFORE_DRAINING=false`.
299298

300-
Take a look at the docs on how to create rules that only manage certain ASGs [here](https://docs.aws.amazon.com/autoscaling/ec2/userguide/cloud-watch-events.html).
299+
You can also control what resources NTH manages by adding the resource ARNs to your Amazon EventBridge rules.
301300

302-
See all the different events docs [here](https://docs.aws.amazon.com/eventbridge/latest/userguide/event-types.html#auto-scaling-event-types).
301+
Take a look at the docs on how to [create rules that only manage certain ASGs](https://docs.aws.amazon.com/autoscaling/ec2/userguide/cloud-watch-events.html), and read about all the [supported ASG events](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-event-reference.html).
303302

304303
#### 4. Create Amazon EventBridge Rules
305304

0 commit comments

Comments
 (0)