feat(autoscaling): instance maintenance policy for AutoScalingGroup #28092

go-to-k · 2023-11-21T11:17:11Z

This PR supports for configuring AutoScalingGroup's instance maintenance policy.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

…ingGroup

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

lpizzinidev

Thanks 👍
I added some suggestions for improvements, feel free to comment.

packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts

packages/aws-cdk-lib/aws-autoscaling/test/auto-scaling-group.test.ts

packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts

fix by the review add new validation to clear previously set values add new unit tests

go-to-k · 2023-11-22T05:25:21Z

@lpizzinidev

Thanks for your review. I fixed them!

add integ

go-to-k · 2023-11-25T12:40:28Z

@lpizzinidev

I changed the properties to flat and optional! Please check them.

lpizzinidev

Thanks 👍
Just some minor adjustments and it will be good to go for me.

packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts

This reverts commit 5eb173e.

go-to-k · 2023-11-27T11:23:42Z

@lpizzinidev

I changed. Please look at this comment.

packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts

lpizzinidev

Thanks 👍

kaizencc

Thanks @go-to-k. Some minor comments, but great start!

kaizencc · 2023-12-20T16:16:14Z

packages/aws-cdk-lib/aws-autoscaling/README.md

@@ -288,6 +288,38 @@ autoScalingGroup.scaleOnSchedule('AllowDownscalingAtNight', {
 });
 ```

+### Instance Maintenance Policy
+
+The instance maintenance policy allows you to configure an instance maintenance policy for


Suggested change

The instance maintenance policy allows you to configure an instance maintenance policy for

You can configure an instance maintenance policy for

kaizencc · 2023-12-20T16:17:36Z

packages/aws-cdk-lib/aws-autoscaling/README.md

+  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.MICRO),
+  machineImage: ec2.MachineImage.latestAmazonLinux2(),
+  maintenancePolicyMaxHealthPercentage: 200,
+  maintenancePolicyMinHealthPercentage: 100,


I'm not necessarily against this, but what was the reasoning against just minHealthPercentage and maxHealthPercentage? I think i prefer that unless it would be confusing if minimum health could point to other things besides maintenance policy.

Yes, I was not sure at first, but I think I will do that.

Changed to minHealthyPercentage and maxHealthyPercentage to match CloudFormation (with Health'y').

kaizencc · 2023-12-20T16:24:11Z

packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts

+   *
+   * @see https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html
+   *
+   * @default - No instance maintenance policy.


If possible, I think we should just set the default to -1. If I am reading the docs correctly, this is equivalent to undefined in CloudFormation. The only issue I see is if CloudFormation somehow fails if you set the value to -1 and there wasn't any previous value to clear. If that happens, then lets go down this path. If not, we can treat -1 and undefined equivalently in CDK.

When I tried to run CloudFormation with -1 from the beginning, I got the following error in CFn. In other words, it seems that -1 and undefined must be distinguished.

MinHealthyPercentage must be between 0 and 100 (inclusive).

kaizencc · 2023-12-20T16:26:19Z

packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts

+    if (maxHealthPercentage === -1 && minHealthPercentage === -1) {
+      return {
+        maxHealthyPercentage: maxHealthPercentage,
+        minHealthyPercentage: minHealthPercentage,
+      };
+    }
+    if (minHealthPercentage === -1 || maxHealthPercentage === -1) {
+      throw new Error(`Both maintenancePolicyMinHealthPercentage and maintenancePolicyMaxHealthPercentage must be -1 to clear the previously set value, got maintenancePolicyMinHealthPercentage: ${minHealthPercentage} and maintenancePolicyMaxHealthPercentage: ${maxHealthPercentage}`);
+    }


Suggested change

if (maxHealthPercentage === -1 && minHealthPercentage === -1) {

return {

maxHealthyPercentage: maxHealthPercentage,

minHealthyPercentage: minHealthPercentage,

};

}

if (minHealthPercentage === -1 || maxHealthPercentage === -1) {

throw new Error(`Both maintenancePolicyMinHealthPercentage and maintenancePolicyMaxHealthPercentage must be -1 to clear the previously set value, got maintenancePolicyMinHealthPercentage: ${minHealthPercentage} and maintenancePolicyMaxHealthPercentage: ${maxHealthPercentage}`);

}

if (minHealthPercentage === -1 || maxHealthPercentage === -1 && minHealthPercentage !== maxHealthPercentage) {

throw new Error(`Both maintenancePolicyMinHealthPercentage and maintenancePolicyMaxHealthPercentage must be -1 to clear the previously set value, got maintenancePolicyMinHealthPercentage: ${minHealthPercentage} and maintenancePolicyMaxHealthPercentage: ${maxHealthPercentage}`);

}

This would be equivalent and remove an additional if condition, but isn't a huge deal.

No, in the case for the code and both maxHealthPercentage and minHealthPercentage is -1, the next branch causes an error.

if (maxHealthPercentage < 100 || maxHealthPercentage > 200) { throw new Error(`maxHealthPercentage must be between 100 and 200, or -1 to clear the previously set value, got ${maxHealthPercentage}`); } if (minHealthPercentage < 0 || minHealthPercentage > 100) { throw new Error(`minHealthPercentage must be between 0 and 100, or -1 to clear the previously set value, got ${minHealthPercentage}`); }

So, if both are -1, we need to return them as soon as possible.

Or, the following code would work. I will go with this!

if ((minHealthPercentage === -1 || maxHealthPercentage === -1) && minHealthPercentage !== maxHealthPercentage) { throw new Error(`Both minHealthPercentage and maxHealthPercentage must be -1 to clear the previously set value, got minHealthPercentage: ${minHealthPercentage} and maxHealthPercentage: ${maxHealthPercentage}`); } if (maxHealthPercentage !== -1 && (maxHealthPercentage < 100 || maxHealthPercentage > 200)) { throw new Error(`maxHealthPercentage must be between 100 and 200, or -1 to clear the previously set value, got ${maxHealthPercentage}`); } if (minHealthPercentage !== -1 && (minHealthPercentage < 0 || minHealthPercentage > 100)) { throw new Error(`minHealthPercentage must be between 0 and 100, or -1 to clear the previously set value, got ${minHealthPercentage}`); }

kaizencc · 2023-12-20T16:27:21Z

packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts

+    }
+    if (maxHealthPercentage - minHealthPercentage > 100) {
+      throw new Error(`The difference between maintenancePolicyMinHealthPercentage and maintenancePolicyMaxHealthPercentage cannot be greater than 100, got ${maxHealthPercentage - minHealthPercentage}`);
+    }


We can store all errors we get in an array and throw them all at the same time, so the user will know all the issues present.

Hmmm, is that necessary?

I think the information given to the user would be more complex, and type inference would not work and branching would become more complicated.

(Because of the eslint error, in numerical comparisons, minHealthyPercentage !== undefined and maxHealthyPercentage !== undefined must be added to the numerical comparison.)

const errors: string[] = []; if (minHealthyPercentage === undefined && maxHealthyPercentage === undefined) return; if (minHealthyPercentage === undefined || maxHealthyPercentage === undefined) { errors.push(`Both or neither of minHealthyPercentage and maxHealthyPercentage must be specified, got minHealthyPercentage: ${minHealthyPercentage} and maxHealthyPercentage: ${maxHealthyPercentage}`); } if ((minHealthyPercentage === -1 || maxHealthyPercentage === -1) && minHealthyPercentage !== maxHealthyPercentage) { errors.push(`Both minHealthyPercentage and maxHealthyPercentage must be -1 to clear the previously set value, got minHealthyPercentage: ${minHealthyPercentage} and maxHealthyPercentage: ${maxHealthyPercentage}`); } if (minHealthyPercentage !== -1 && minHealthyPercentage !== undefined && (minHealthyPercentage < 0 || minHealthyPercentage > 100)) { errors.push(`minHealthyPercentage must be between 0 and 100, or -1 to clear the previously set value, got ${minHealthyPercentage}`); } if (maxHealthyPercentage !== -1 && maxHealthyPercentage !== undefined && (maxHealthyPercentage < 0 || maxHealthyPercentage > 100)) { errors.push(`maxHealthyPercentage must be between 100 and 200, or -1 to clear the previously set value, got ${maxHealthyPercentage}`); } if (maxHealthyPercentage !== undefined && minHealthyPercentage !== undefined && maxHealthyPercentage - minHealthyPercentage > 100) { errors.push(`The difference between minHealthyPercentage and maxHealthyPercentage cannot be greater than 100, got ${maxHealthyPercentage - minHealthyPercentage}`); } if (errors.length > 0) { throw new Error(errors.join('\n')); } return { minHealthyPercentage, maxHealthyPercentage, };

Pull request has been modified.

…HealthyPercentage and minHealthyPercentage

go-to-k · 2023-12-21T06:20:49Z

@kaizencc

Thanks for your review!

I fixed and commented back. I would especially appreciate it if you would read the following comment.

#28092 (comment)

kaizencc

I think the -1 thing is kind of dumb but I can't think of a reasonable way of doing it in cdk-land besides just passing on that user-experience to the user. Oh well. Everything else looks good -- my comments on the errors were just nits anyway. Thanks again.

mergify · 2023-12-22T22:18:26Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2023-12-22T22:22:14Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2023-12-22T23:56:29Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 225e5f1
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2023-12-22T23:56:50Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

…ws#28092) This PR supports for configuring AutoScalingGroup's instance maintenance policy. - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancemaintenancepolicy.html - https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html - https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-maintenance-policy-overview-and-considerations.html Closes aws#28042. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

feat(autoscaling): add InstanceMaintenancePolicy property to AutoScal…

1ccc29d

…ingGroup

github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 labels Nov 21, 2023

aws-cdk-automation requested a review from a team November 21, 2023 11:17

github-actions bot added the star-contributor [Pilot] contributed between 25-49 PRs to the CDK label Nov 21, 2023

aws-cdk-automation previously requested changes Nov 21, 2023

View reviewed changes

go-to-k added 3 commits November 21, 2023 21:05

add unit tests and change validations

efc8d38

change README

d18c78a

add an integ test

042b4b7

go-to-k added 2 commits November 21, 2023 21:47

fix to add semicolons

ef4db98

change integ snapshots

29a85ed

go-to-k marked this pull request as ready for review November 21, 2023 15:42

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 21, 2023

go-to-k added 2 commits November 22, 2023 00:49

change goc

8f8f6f1

change doc for instanceMaintenancePolicy

5814463

lpizzinidev suggested changes Nov 21, 2023

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 21, 2023

fix by the review

b4ef9f7

fix by the review add new validation to clear previously set values add new unit tests

go-to-k force-pushed the feat/autoscaling-instance-maintenance-policy branch from 8e4e844 to b4ef9f7 Compare November 22, 2023 05:10

go-to-k added 2 commits November 25, 2023 20:38

change the params to flat and nullable

23ef1b7

add integ

change parameter name

5eb173e

go-to-k force-pushed the feat/autoscaling-instance-maintenance-policy branch from 9f14ea4 to 5eb173e Compare November 25, 2023 11:39

change README

42b82e5

go-to-k changed the title ~~feat(autoscaling): add InstanceMaintenancePolicy property to AutoScalingGroup~~ feat(autoscaling): support instance maintenance policy to AutoScalingGroup Nov 25, 2023

go-to-k changed the title ~~feat(autoscaling): support instance maintenance policy to AutoScalingGroup~~ feat(autoscaling): support instance maintenance policy for AutoScalingGroup Nov 25, 2023

lpizzinidev suggested changes Nov 25, 2023

View reviewed changes

go-to-k added 2 commits November 27, 2023 20:04

Revert "change parameter name"

29da64a

This reverts commit 5eb173e.

change default

7abed93

lpizzinidev suggested changes Nov 27, 2023

View reviewed changes

packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts Outdated Show resolved Hide resolved

refactor method

31cdf68

lpizzinidev approved these changes Nov 27, 2023

View reviewed changes

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Nov 27, 2023

github-actions bot mentioned this pull request Dec 1, 2023

Monthly PR metrics report - November 2023 #28212

Closed

kaizencc previously requested changes Dec 20, 2023

View reviewed changes

kaizencc changed the title ~~feat(autoscaling): support instance maintenance policy for AutoScalingGroup~~ feat(autoscaling): instance maintenance policy for AutoScalingGroup Dec 20, 2023

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 20, 2023

change parameter names and README

2852f77

Merge branch 'main' into feat/autoscaling-instance-maintenance-policy

490b756

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 21, 2023

go-to-k added 2 commits December 21, 2023 14:42

improve renderInstanceMaintenancePolicy and change param names to max…

43d5c02

…HealthyPercentage and minHealthyPercentage

refactor to order of min and max

d3bf791

go-to-k requested a review from kaizencc December 21, 2023 06:19

kaizencc approved these changes Dec 22, 2023

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 22, 2023

Merge branch 'main' into feat/autoscaling-instance-maintenance-policy

225e5f1

mergify bot merged commit 5eb2c26 into aws:main Dec 22, 2023
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(autoscaling): instance maintenance policy for AutoScalingGroup #28092

feat(autoscaling): instance maintenance policy for AutoScalingGroup #28092

go-to-k commented Nov 21, 2023 •

edited

Loading

aws-cdk-automation left a comment

lpizzinidev left a comment

go-to-k commented Nov 22, 2023

go-to-k commented Nov 25, 2023

lpizzinidev left a comment

go-to-k commented Nov 27, 2023

lpizzinidev left a comment

kaizencc left a comment

kaizencc Dec 20, 2023

go-to-k Dec 21, 2023

kaizencc Dec 20, 2023

go-to-k Dec 21, 2023

go-to-k Dec 21, 2023 •

edited

Loading

kaizencc Dec 20, 2023

go-to-k Dec 21, 2023

kaizencc Dec 22, 2023

kaizencc Dec 20, 2023

go-to-k Dec 21, 2023

go-to-k Dec 21, 2023

go-to-k Dec 21, 2023

kaizencc Dec 20, 2023

go-to-k Dec 21, 2023 •

edited

Loading

go-to-k commented Dec 21, 2023 •

edited

Loading

kaizencc left a comment

mergify bot commented Dec 22, 2023

mergify bot commented Dec 22, 2023

aws-cdk-automation commented Dec 22, 2023

mergify bot commented Dec 22, 2023

	The instance maintenance policy allows you to configure an instance maintenance policy for
	You can configure an instance maintenance policy for

feat(autoscaling): instance maintenance policy for AutoScalingGroup #28092

feat(autoscaling): instance maintenance policy for AutoScalingGroup #28092

Conversation

go-to-k commented Nov 21, 2023 • edited Loading

aws-cdk-automation left a comment

Choose a reason for hiding this comment

lpizzinidev left a comment

Choose a reason for hiding this comment

go-to-k commented Nov 22, 2023

go-to-k commented Nov 25, 2023

lpizzinidev left a comment

Choose a reason for hiding this comment

go-to-k commented Nov 27, 2023

lpizzinidev left a comment

Choose a reason for hiding this comment

kaizencc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

go-to-k Dec 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

go-to-k Dec 21, 2023 • edited Loading

Choose a reason for hiding this comment

go-to-k commented Dec 21, 2023 • edited Loading

kaizencc left a comment

Choose a reason for hiding this comment

mergify bot commented Dec 22, 2023

mergify bot commented Dec 22, 2023

aws-cdk-automation commented Dec 22, 2023

AWS CodeBuild CI Report

mergify bot commented Dec 22, 2023

go-to-k commented Nov 21, 2023 •

edited

Loading

go-to-k Dec 21, 2023 •

edited

Loading

go-to-k Dec 21, 2023 •

edited

Loading

go-to-k commented Dec 21, 2023 •

edited

Loading