fix(ec2): `AmazonLinuxImage` construct generates incorrect SSM parameter name for AL2023 images #27698

tam0ri · 2023-10-26T17:09:23Z

AmazonLinuxImage construct generates SSM parameter name for Amazon Linux images. The naming convention for Amazon Linux 2023 images is a bit different from Amazon Linux 2. For example, virtualization type (e.g. HVM) or backend storage type (e.g. GP2) are not included in parameter's name for AL2023.

AL2:

aws-cdk/packages/aws-cdk-lib/aws-ec2/lib/machine-image/amazon-linux2.ts

Lines 77 to 84 in d0d7547

    
              *     "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs", 
        
              *     "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2", 
        
              *     "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-ebs", 
        
              *     "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-arm64-gp2", 
        
              *     "/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-arm64-ebs", 
        
              *     "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-arm64-gp2", 
        
              *     "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-gp2", 
        
              *     "/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-x86_64-ebs"

AL2023:

aws-cdk/packages/aws-cdk-lib/aws-ec2/lib/machine-image/amazon-linux-2023.ts

Lines 59 to 66 in d0d7547

    
              *     "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64", 
        
              *     "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-x86_64", 
        
              *     "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-arm64", 
        
              *     "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-6.1-x86_64", 
        
              *     "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-arm64", 
        
              *     "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64", 
        
              *     "/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64", 
        
              *     "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-arm64",

Currently, AmazonLinuxImage construct generates incorrect SSM parameter name for AL2023 images, which includes virtualization and storage type in the name. This causes validation error against non-existing parameter name. This PR solves the issue by avoiding to include virtualization and storage in parameter's name when AMAZON_LINUX_2023 is specified as generation.

Closes #27638

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

…r name for AL2023 images

Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>

vinayak-kukreja · 2023-11-08T23:02:04Z

Hey, thank you for your contribution. I made some updates to the integ test to get it working. Since I have added code, I have asked someone else to add a review too. But it looks good to me.

scanlonp · 2023-11-08T23:10:16Z

packages/aws-cdk-lib/aws-ec2/test/machine-image.test.ts

+test('throw error if storage param is set for Amazon Linux 2023', () => {
+  expect(() => {
+    new ec2.AmazonLinuxImage({
+      generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2023,
+      storage: ec2.AmazonLinuxStorage.GENERAL_PURPOSE,
+    }).getImage(stack);
+  }).toThrow(/Storage parameter does not exist in SSM parameter name for Amazon Linux 2023./);
+});
+
+test('throw error if virtualization param is set for Amazon Linux 2023', () => {
+  expect(() => {
+    new ec2.AmazonLinuxImage({
+      generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2023,
+      virtualization: ec2.AmazonLinuxVirt.HVM,
+    }).getImage(stack);
+  }).toThrow(/Virtualization parameter does not exist in SSM parameter name for Amazon Linux 2023./);


These tests are outside of the describe block. Is that intended? It looks like theres a mix of 2022 and 2023 tests in the latest describe block. Is that intended too?

@scanlonp Thank you for your comment!

These tests are outside of the describe block. Is that intended?

Yes, this is intentional. I added three tests.

'AmazonLinuxImage with AMAZON_LINUX_2023'

'throw error if storage param is set for Amazon Linux 2023'

'throw error if virtualization param is set for Amazon Linux 2023'

1 is located in latest describe block. This is because I want to verify whether AmazonLinuxImage construct generates SSM parameter path for the latest AL2023 image by this change. 2 and 3 are not located in the describe block. This is also intentional because these tests are similar with the following tests located outside of the describe block.

aws-cdk/packages/aws-cdk-lib/aws-ec2/test/machine-image.test.ts

Lines 257 to 275 in 820bb99

test('throw error if storage param is set for Amazon Linux 2022', () => {

expect(() => {

ec2.MachineImage.latestAmazonLinux({

cachedInContext: true,

generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2022,

storage: ec2.AmazonLinuxStorage.GENERAL_PURPOSE,

}).getImage(stack).imageId;

}).toThrow(/Storage parameter does not exist in smm parameter name for Amazon Linux 2022./);

});

test('throw error if virtualization param is set for Amazon Linux 2022', () => {

expect(() => {

ec2.MachineImage.latestAmazonLinux({

cachedInContext: true,

generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2022,

virtualization: ec2.AmazonLinuxVirt.HVM,

}).getImage(stack).imageId;

}).toThrow(/Virtualization parameter does not exist in smm parameter name for Amazon Linux 2022./);

});

If I should move 2 and 3 into directly below the above tests, please let me know.

It looks like theres a mix of 2022 and 2023 tests in the latest describe block. Is that intended too?

This is not my intention. Before I added these tests, tests for both 2022 and 2023 are located in the describe block as below.
https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-ec2/test/machine-image.test.ts#L300-L407

scanlonp

Thanks for your explanation. I think the formatting of the tests is fine if it was your intention. We can reorganize as necessary in the future, but it is likely ok, and certainly should not block this PR.

Pull request has been modified.

scanlonp

See above.

vinayak-kukreja · 2023-11-10T16:59:08Z

@Mergifyio update

mergify · 2023-11-10T16:59:15Z

update

✅ Branch has been successfully updated

mergify · 2023-11-10T17:28:51Z

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-11-10T17:58:19Z

AWS CodeBuild CI Report

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

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

mergify · 2023-11-10T17:58:41Z

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).

…ter name for AL2023 images (#27698) AmazonLinuxImage construct generates SSM parameter name for Amazon Linux images. The naming convention for Amazon Linux 2023 images is a bit different from Amazon Linux 2. For example, virtualization type (e.g. HVM) or backend storage type (e.g. GP2) are not included in parameter's name for AL2023. AL2: https://github.com/aws/aws-cdk/blob/d0d75478e1cf3bb9a06f33642b9a06fc68d0c99d/packages/aws-cdk-lib/aws-ec2/lib/machine-image/amazon-linux2.ts#L77-L84 AL2023: https://github.com/aws/aws-cdk/blob/d0d75478e1cf3bb9a06f33642b9a06fc68d0c99d/packages/aws-cdk-lib/aws-ec2/lib/machine-image/amazon-linux-2023.ts#L59-L66 Currently, AmazonLinuxImage construct generates incorrect SSM parameter name for AL2023 images, which includes virtualization and storage type in the name. This causes validation error against non-existing parameter name. This PR solves the issue by avoiding to include virtualization and storage in parameter's name when AMAZON_LINUX_2023 is specified as generation. Closes #27638 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

fix(ec2): AmazonLinuxImage construct generates incorrect SSM paramete…

805a007

…r name for AL2023 images

aws-cdk-automation requested a review from a team October 26, 2023 17:09

github-actions bot added bug This issue is a bug. p1 admired-contributor [Pilot] contributed between 13-24 PRs to the CDK labels Oct 26, 2023

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

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

Monthly PR metrics report - October 2023 #27786

Closed

vinayak-kukreja self-assigned this Nov 8, 2023

vinayak-kukreja added 2 commits November 8, 2023 12:40

Merge branch 'main' into fix/ec2-amazon-linux-image-for-al2023

73cc474

Merge branch 'main' into fix/ec2-amazon-linux-image-for-al2023

1bbe6a4

vinayak-kukreja changed the title ~~fix(ec2): AmazonLinuxImage construct generates incorrect SSM parameter name for AL2023 images~~ fix(ec2): AmazonLinuxImage construct generates incorrect SSM parameter name for AL2023 images Nov 8, 2023

update integ test

32b9794

Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>

vinayak-kukreja added the pr/do-not-merge This PR should not be merged at this time. label Nov 8, 2023

vinayak-kukreja previously approved these changes Nov 8, 2023

View reviewed changes

scanlonp reviewed Nov 8, 2023

View reviewed changes

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

scanlonp previously approved these changes Nov 10, 2023

View reviewed changes

Merge branch 'main' into fix/ec2-amazon-linux-image-for-al2023

67ec037

scanlonp approved these changes Nov 10, 2023

View reviewed changes

Merge branch 'main' into fix/ec2-amazon-linux-image-for-al2023

565d2b6

vinayak-kukreja approved these changes Nov 10, 2023

View reviewed changes

vinayak-kukreja removed the pr/do-not-merge This PR should not be merged at this time. label Nov 10, 2023

Merge branch 'main' into fix/ec2-amazon-linux-image-for-al2023

b2d932b

mergify bot merged commit f6c1e62 into aws:main Nov 10, 2023
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(ec2): `AmazonLinuxImage` construct generates incorrect SSM parameter name for AL2023 images #27698

fix(ec2): `AmazonLinuxImage` construct generates incorrect SSM parameter name for AL2023 images #27698

tam0ri commented Oct 26, 2023

vinayak-kukreja commented Nov 8, 2023

scanlonp Nov 8, 2023

scanlonp Nov 8, 2023

tam0ri Nov 9, 2023

scanlonp left a comment

scanlonp left a comment

vinayak-kukreja commented Nov 10, 2023

mergify bot commented Nov 10, 2023

mergify bot commented Nov 10, 2023

aws-cdk-automation commented Nov 10, 2023

mergify bot commented Nov 10, 2023

	* "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs",
	* "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2",
	* "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-ebs",
	* "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-arm64-gp2",
	* "/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-arm64-ebs",
	* "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-arm64-gp2",
	* "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-gp2",
	* "/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-x86_64-ebs"

	test('throw error if storage param is set for Amazon Linux 2022', () => {
	expect(() => {
	ec2.MachineImage.latestAmazonLinux({
	cachedInContext: true,
	generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2022,
	storage: ec2.AmazonLinuxStorage.GENERAL_PURPOSE,
	}).getImage(stack).imageId;
	}).toThrow(/Storage parameter does not exist in smm parameter name for Amazon Linux 2022./);
	});

	test('throw error if virtualization param is set for Amazon Linux 2022', () => {
	expect(() => {
	ec2.MachineImage.latestAmazonLinux({
	cachedInContext: true,
	generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2022,
	virtualization: ec2.AmazonLinuxVirt.HVM,
	}).getImage(stack).imageId;
	}).toThrow(/Virtualization parameter does not exist in smm parameter name for Amazon Linux 2022./);
	});

fix(ec2): AmazonLinuxImage construct generates incorrect SSM parameter name for AL2023 images #27698

fix(ec2): AmazonLinuxImage construct generates incorrect SSM parameter name for AL2023 images #27698

Conversation

tam0ri commented Oct 26, 2023

vinayak-kukreja commented Nov 8, 2023

scanlonp Nov 8, 2023

Choose a reason for hiding this comment

scanlonp Nov 8, 2023

Choose a reason for hiding this comment

tam0ri Nov 9, 2023

Choose a reason for hiding this comment

scanlonp left a comment

Choose a reason for hiding this comment

scanlonp left a comment

Choose a reason for hiding this comment

vinayak-kukreja commented Nov 10, 2023

mergify bot commented Nov 10, 2023

✅ Branch has been successfully updated

mergify bot commented Nov 10, 2023

aws-cdk-automation commented Nov 10, 2023

AWS CodeBuild CI Report

mergify bot commented Nov 10, 2023

fix(ec2): `AmazonLinuxImage` construct generates incorrect SSM parameter name for AL2023 images #27698

fix(ec2): `AmazonLinuxImage` construct generates incorrect SSM parameter name for AL2023 images #27698