feat(cloud9): support imageid when creating cloud9 environment #21194

sean-beath · 2022-07-18T07:23:51Z

Allows users to include the imageId parameter to specify which EC2 AMI to be used when creating the environment.

closes: #20908.

Shout out to @jumic for beginning the fix.

Unable to run yarn integ due to breaking change.

BREAKING CHANGE: The imageId parameter is now required and deployments will fail without it

All Submissions:

Have you followed the guidelines in our Contributing guide?

Adding new Unconventional Dependencies:

This PR adds new unconventional dependencies following the process described here

New Features

Have you added the new feature to an integration test?
- Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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

BREAKING CHANGE: imageId is now a required parameter for Cloud9 environments. Any stack without this parameter will fail.

…ws-cdk into feat/cloud9_imageId

gitpod-io · 2022-07-18T07:23:59Z

TheRealAmazonKendra

Thank you for your contribution! This is great work. I just have a few comments below. Additionally, please update the other integration tests to expect AL2 instead of AL1. That's why the build is currently failing.

TheRealAmazonKendra · 2022-07-18T23:52:56Z

packages/@aws-cdk/aws-cloud9/README.md

@@ -42,13 +42,14 @@ EC2 Environments are defined with `Ec2Environment`. To create an EC2 environment
 ```ts
 // create a cloud9 ec2 environment in a new VPC
 const vpc = new ec2.Vpc(this, 'VPC', { maxAzs: 3});
-new cloud9.Ec2Environment(this, 'Cloud9Env', { vpc });
+new cloud9.Ec2Environment(this, 'Cloud9Env', { vpc }, imageId: cloud9.ImageId.AMAZON_LINUX_2,);


If imageId is a prop, it would need to be inside the curly brackets, not outside.

TheRealAmazonKendra · 2022-07-18T23:55:08Z

packages/@aws-cdk/aws-cloud9/lib/environment.ts

+  /**
+   * Create using Amazon Linux 1
+   */
+  AMAZON_LINUX_1 = 'amazonlinux-1-x86_64',


This is in maintenance support, which means that new instances shouldn't be created. Let's not include it in the options.

I've removed AMAZON_LINUX_1

TheRealAmazonKendra · 2022-07-18T23:59:21Z

packages/@aws-cdk/aws-cloud9/lib/environment.ts

@@ -29,7 +29,7 @@ export interface IEc2Environment extends cdk.IResource {
 */
 export enum ConnectionType {
  /**
-   * Conect through SSH
+   * Connect through SSH


Thanks for catching this!

TheRealAmazonKendra · 2022-07-19T00:02:34Z

packages/@aws-cdk/aws-cloud9/lib/environment.ts

+  /**
+   * The image ID used for creating an Amazon EC2 environment.
+   *
+   * Valid values are: AMAZON_LINUX, AMAZON_LINUX_2, and UBUNTU_18_04


Let's remove AL1

updated image-id integ test to use integTest package

Pull request has been modified.

sean-beath · 2022-07-19T01:34:26Z

Thanks for your review @TheRealAmazonKendra
I've updated the existing snapshots to expect AL2 and they are now passing yarn integ.
The new integ test is failing but I don't know how to make it work! If you can provide some guidance on what I'm missing, I'll make the change.

TheRealAmazonKendra · 2022-07-19T04:48:18Z

Ah, luckily this is a simple issue, though it doesn't look like we have it documented very well. You just need to add "@aws-cdk/integ-tests": "0.0.0", as a devDependency in package.json.

… to be run

sean-beath · 2022-07-19T05:40:35Z

Thanks @TheRealAmazonKendra - I have added in that line and was able to successfully run the yarn integ on my end. Looks like the CodeBuild step is still failing though!

TheRealAmazonKendra · 2022-07-19T05:54:06Z

@Mergifyio update

mergify · 2022-07-19T05:54:22Z

update

✅ Branch has been successfully updated

TheRealAmazonKendra · 2022-07-19T05:55:52Z

Thanks @TheRealAmazonKendra - I have added in that line and was able to successfully run the yarn integ on my end. Looks like the CodeBuild step is still failing though!

Ugh, this again. This is a bug we had that got fixed this morning. The update I just did should fix it. It will rebase it main with the fix present.

TheRealAmazonKendra

Just one more tiny change, please. Besides this, as long as the build passes, this is good to go!

TheRealAmazonKendra · 2022-07-19T05:57:27Z

packages/@aws-cdk/aws-cloud9/lib/environment.ts

+  /**
+   * The image ID used for creating an Amazon EC2 environment.
+   *
+   * Valid values are: AMAZON_LINUX_2, and UBUNTU_18_04


Let's remove this line (just 114). They're already defined in the enum and this will just provide additional overhead to update in the future.

Thanks - have pushed the change

Pull request has been modified.

TheRealAmazonKendra · 2022-07-19T06:46:59Z

I made a small change to the README because I'm kind of guessing about what caused the failure this time. Seeing if that works.

aws-cdk-automation · 2022-07-19T07:25:48Z

AWS CodeBuild CI Report

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

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

TheRealAmazonKendra

Success! Thank you for all your hard work on this!

mergify · 2022-07-19T07:27:35Z

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

@jumic

…1194) Allows users to include the imageId parameter to specify which EC2 AMI to be used when creating the environment. closes: aws#20908. Shout out to @jumic for beginning the fix. Unable to run yarn integ due to breaking change. BREAKING CHANGE: The imageId parameter is now required and deployments will fail without it ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [x] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

sean-beath added 4 commits July 18, 2022 06:50

feat(cloud9)\!: support imageId when creating Cloud9 environment

c159086

BREAKING CHANGE: imageId is now a required parameter for Cloud9 environments. Any stack without this parameter will fail.

feat(cloud9): support imageId when creating Cloud9 environment

016becd

BREAKING CHANGE: imageId is now a required parameter for Cloud9 environments. Any stack without this parameter will fail.

Merge branch 'feat/cloud9_imageId' of https://github.com/sean-beath/a…

926d4ef

…ws-cdk into feat/cloud9_imageId

feat(cloud9): added integration test for imageId

5059e05

aws-cdk-automation requested a review from a team July 18, 2022 07:24

github-actions bot added the p2 label Jul 18, 2022

TheRealAmazonKendra changed the title ~~feat(aws-cloud9): support imageid when creating cloud9 environment~~ feat(cloud9): support imageid when creating cloud9 environment Jul 19, 2022

TheRealAmazonKendra previously requested changes Jul 19, 2022

View reviewed changes

sean-beath added 3 commits July 19, 2022 00:25

updated readme parameter error

2b9f7c5

removed Amazon Linux 1 option from ImageId

41a5788

updated existing integ test snapshots to expect amazon-linux-2 image id

f45bed2

updated image-id integ test to use integTest package

added integ-tests line to devdependencies to allow for new integ test…

c0e1701

… to be run

Merge branch 'main' into feat/cloud9_imageId

c96d2a1

TheRealAmazonKendra previously requested changes Jul 19, 2022

View reviewed changes

Update README.md

1c146bd

removed comment on valid imageid

c80c735

TheRealAmazonKendra approved these changes Jul 19, 2022

View reviewed changes

mergify bot merged commit dcf3eb3 into aws:main Jul 19, 2022

TheRealAmazonKendra mentioned this pull request Jul 19, 2022

feat(cloud9): support imageId in Cloud9 environment #21086

Closed

4 tasks

sean-beath deleted the feat/cloud9_imageId branch August 24, 2022 02:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cloud9): support imageid when creating cloud9 environment #21194

feat(cloud9): support imageid when creating cloud9 environment #21194

sean-beath commented Jul 18, 2022 •

edited

Loading

gitpod-io bot commented Jul 18, 2022

TheRealAmazonKendra left a comment

TheRealAmazonKendra Jul 18, 2022

sean-beath Jul 19, 2022

TheRealAmazonKendra Jul 18, 2022

sean-beath Jul 19, 2022

TheRealAmazonKendra Jul 18, 2022

TheRealAmazonKendra Jul 19, 2022

sean-beath Jul 19, 2022

sean-beath commented Jul 19, 2022

TheRealAmazonKendra commented Jul 19, 2022

sean-beath commented Jul 19, 2022

TheRealAmazonKendra commented Jul 19, 2022

mergify bot commented Jul 19, 2022

TheRealAmazonKendra commented Jul 19, 2022

TheRealAmazonKendra left a comment

TheRealAmazonKendra Jul 19, 2022 •

edited

Loading

sean-beath Jul 19, 2022

TheRealAmazonKendra commented Jul 19, 2022

aws-cdk-automation commented Jul 19, 2022

TheRealAmazonKendra left a comment

mergify bot commented Jul 19, 2022

feat(cloud9): support imageid when creating cloud9 environment #21194

feat(cloud9): support imageid when creating cloud9 environment #21194

Conversation

sean-beath commented Jul 18, 2022 • edited Loading

All Submissions:

Adding new Unconventional Dependencies:

New Features

gitpod-io bot commented Jul 18, 2022

TheRealAmazonKendra 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sean-beath commented Jul 19, 2022

TheRealAmazonKendra commented Jul 19, 2022

sean-beath commented Jul 19, 2022

TheRealAmazonKendra commented Jul 19, 2022

mergify bot commented Jul 19, 2022

✅ Branch has been successfully updated

TheRealAmazonKendra commented Jul 19, 2022

TheRealAmazonKendra left a comment

Choose a reason for hiding this comment

TheRealAmazonKendra Jul 19, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheRealAmazonKendra commented Jul 19, 2022

aws-cdk-automation commented Jul 19, 2022

AWS CodeBuild CI Report

TheRealAmazonKendra left a comment

Choose a reason for hiding this comment

mergify bot commented Jul 19, 2022

sean-beath commented Jul 18, 2022 •

edited

Loading

TheRealAmazonKendra Jul 19, 2022 •

edited

Loading