feat(aws-ecs): add ScheduledEc2Task L3 construct #2336

piradeepk · 2019-04-19T17:57:30Z

Defined a new construct to enable creating a ec2 task to be run at a scheduled interval

Pull Request Checklist

Testing
- Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
- CLI change?: coordinate update of integration tests with team
- cdk-init template change?: coordinated update of integration tests with team
Docs
- jsdocs: All public APIs documented
- README: README and/or documentation topic updated
Title and Description
- Change type: title prefixed with fix, feat will appear in changelog
- Title: use lower-case and doesn't end with a period
- Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
- Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
Sensitive Modules (requires 2 PR approvers)
- IAM Policy Document (in @aws-cdk/aws-iam)
- EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
- Grant APIs (only if not based on official documentation with a reference)

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

SoManyHs · 2019-04-22T18:04:49Z

packages/@aws-cdk/aws-ecs/lib/scheduled-ecs-task.ts

+  /**
+   * The schedule expression used to configure the event rule.
+   */
+  readonly scheduleExpression?: string;


What is the expected syntax for schedule Expression? In the README the example says 'rate(1 minute)', which seems not the most intuitive syntax.

The schedulingExpressions are values that are provided by cloudwatch events: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html

I'll update the comment to reflect this though.

packages/@aws-cdk/aws-ecs/lib/scheduled-ecs-task.ts

packages/@aws-cdk/aws-ecs/test/integ.scheduled-ecs-task.ts

SoManyHs · 2019-04-22T18:08:56Z

packages/@aws-cdk/aws-ecs/test/test.scheduled-ecs-task.ts

+import { ScheduledEc2Task } from '../lib';
+
+export = {
+  "Can create a scheduled Ec2 Task without a service"(test: Test) {


The phrasing of this unit test is a bit confusing. Is this just saying that we expect this construct to be a wrapper for an ECS task rather than a service? Also are there other API on the construct we should be unit testing?

Is this just saying that we expect this construct to be a wrapper for an ECS task rather than a service? - Yes
Also are there other API on the construct we should be unit testing? - Fair point, adding more unit tests.

packages/@aws-cdk/aws-ecs/lib/scheduled-ecs-task.ts

SoManyHs · 2019-04-22T18:33:06Z

packages/@aws-cdk/aws-ecs/lib/scheduled-ecs-task.ts

+    taskDefinition.addContainer('ScheduledTaskContainer', {
+      image: props.image,
+      memoryLimitMiB: props.memoryLimitMiB !== undefined ? props.memoryLimitMiB : 256,
+      logging: props.enableLogging ? this.createAWSLogDriver(this.node.id) : undefined,


enableLogging might be undefined -- you need to set the default to be true somewhere.

packages/@aws-cdk/aws-ecs/test/integ.scheduled-ecs-task.ts

SoManyHs · 2019-04-22T18:49:25Z

To be clear, this is not possible in Fargate, correct?

piradeepk · 2019-04-22T18:55:02Z

To be clear, this is not possible in Fargate, correct?

Correct, to use Fargate, I would need to add a network configuration as networkmode is awsvpc. This is not currently supported by Cloudformation.

SoManyHs · 2019-04-22T19:48:17Z

To be clear, this is not possible in Fargate, correct?

Correct, to use Fargate, I would need to add a network configuration as networkmode is awsvpc. This is not currently supported by Cloudformation.

What exactly isn't supported by CFN? We currently allow for awsvpc network mode for both Fargate Services and regular EC2 Task Definitions.

jogold · 2019-04-22T20:09:56Z

@SoManyHs

What exactly isn't supported by CFN?

The NetworkConfiguration property is currently missing in CloudFormation and needed for Fargate (allows to specify security group and subnets). See the differences between Amazon CloudWatch Events Rule EcsParameters (CloudFormation) and EcsParameters (CloudWatch PutTargets).

A Fargate scheduled task would need a Custom Resource. It would be a great addition to the CDK (need this in my projects) and I'm willing to PR for this but I'd prefer a more generic solution using what I proposed in #1850.

piradeepk · 2019-04-22T21:03:28Z

To be clear, this is not possible in Fargate, correct?

Correct, to use Fargate, I would need to add a network configuration as networkmode is awsvpc. This is not currently supported by Cloudformation.

What exactly isn't supported by CFN? We currently allow for awsvpc network mode for both Fargate Services and regular EC2 Task Definitions.

CloudFormation currently only supports clusters, services and taskdefinitions: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-reference-ecs.html.

TaskDefinitions contain a network mode, and for EC2, we can use none, bridge or the many others, but in order to use awsvpc, you need to create a NetworkConfiguration, which is not supported in the TaskDefinition, but is supported in the Service.

For this construct, we're creating a scheduled task (that is standalone task, not backed with a service), and for Fargate to support this feature, we'd need to have a CloudFormation create the concept of a standalone Task (not Task Definition) that can take a NetworkConfiguration property.

It works for ECS because we're using bridge as the NetworkMode, which does not require a NetworkConfiguration to be present.

SoManyHs · 2019-04-22T21:23:19Z

@pkandasamy91 Ah, right -- I was more referring to the CFN support on CWE mentioned by @jogold (thanks for the comment). Appreciate the clarification.

packages/@aws-cdk/aws-ecs/lib/index.ts

packages/@aws-cdk/aws-ecs/lib/scheduled-ecs-task.ts

packages/@aws-cdk/aws-ecs/test/test.scheduled-ecs-task.ts

packages/@aws-cdk/aws-ecs/test/integ.scheduled-ecs-task.ts

SoManyHs

Generally looks good -- could you combine #2363 with this PR?

design/aws-ecs-scheduled-ecs-task-construct.md

packages/@aws-cdk/aws-ecs/test/integ.scheduled-ecs-task.ts

packages/@aws-cdk/aws-ecs/test/test.scheduled-ecs-task.ts

SoManyHs

Style nit about spaces, otherwise LGTM!

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

packages/@aws-cdk/aws-ecs/test/ec2/integ.event-task.lit.expected.json

piradeepk · 2019-04-26T21:38:10Z

Squashed all commits

piradeepk · 2019-05-13T21:50:31Z

Unit tests have been updated to handle merged changes.

rix0rrr · 2019-05-23T08:45:58Z

I notice you made these changes on the master branch in your repo. That might cause you some trouble when trying to resync with upstream master later on. Don't forget to git reset --hard :).

piradeepk requested review from SoManyHs and a team as code owners April 19, 2019 17:57

piradeepk changed the title **feat** defined a new construct to enable creating a ec2 task to be run at a scheduled interval feat: defined a new construct to enable creating a ec2 task to be run at a scheduled interval Apr 22, 2019

SoManyHs suggested changes Apr 22, 2019

View reviewed changes

SoManyHs reviewed Apr 22, 2019

View reviewed changes

SoManyHs changed the title ~~feat: defined a new construct to enable creating a ec2 task to be run at a scheduled interval~~ feat(aws-ecs): add ScheduledEc2Task L3 construct Apr 22, 2019

SoManyHs mentioned this pull request Apr 23, 2019

design(aws-ecs): Design doc for creating a scheduled ecs task construct #2363

Closed

4 tasks

piradeepk requested review from RomainMuller and skinny85 as code owners April 25, 2019 19:55

piradeepk force-pushed the master branch from b8336c9 to a6d3574 Compare April 25, 2019 21:19

SoManyHs reviewed Apr 25, 2019

View reviewed changes

SoManyHs reviewed Apr 26, 2019

View reviewed changes

design/aws-ecs-scheduled-ecs-task-construct.md Outdated Show resolved Hide resolved

packages/@aws-cdk/aws-ecs/test/integ.scheduled-ecs-task.ts Outdated Show resolved Hide resolved

packages/@aws-cdk/aws-ecs/test/test.scheduled-ecs-task.ts Outdated Show resolved Hide resolved

SoManyHs reviewed Apr 26, 2019

View reviewed changes

packages/@aws-cdk/aws-ecs/README.md Outdated Show resolved Hide resolved

packages/@aws-cdk/aws-ecs/test/ec2/integ.event-task.lit.expected.json Outdated Show resolved Hide resolved

SoManyHs approved these changes Apr 26, 2019

View reviewed changes

piradeepk force-pushed the master branch from 73b1aed to 8bfc469 Compare April 26, 2019 21:36

piradeepk mentioned this pull request Apr 29, 2019

L3 Construct for creating a scheduled task on AWS ECS #2352

Closed

jogold mentioned this pull request May 9, 2019

feat(cloudformation): aws custom resource #1850

Merged

4 tasks

piradeepk closed this May 13, 2019

piradeepk force-pushed the master branch from 8bfc469 to b9eeaa0 Compare May 13, 2019 18:07

piradeepk reopened this May 13, 2019

SoManyHs mentioned this pull request May 17, 2019

L3 Construct for creating scheduled task on AWS Fargate #2353

Closed

rix0rrr added 4 commits May 23, 2019 10:37

Update package.json

d6ddf6e

Update README.md

bcd15ad

Update README.md

3efd6fc

Update README.md

93d26ed

rix0rrr approved these changes May 23, 2019

View reviewed changes

rix0rrr merged commit b9cbb6a into aws:master May 23, 2019

This was referenced Jan 20, 2020

[Snyk] Upgrade @aws-cdk/aws-route53 from 0.22.0 to 0.39.0 MechanicalRock/tech-radar#20

Closed

[Snyk] Upgrade @aws-cdk/aws-s3 from 0.22.0 to 0.39.0 MechanicalRock/tech-radar#21

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(aws-ecs): add ScheduledEc2Task L3 construct #2336

feat(aws-ecs): add ScheduledEc2Task L3 construct #2336

piradeepk commented Apr 19, 2019 •

edited by SoManyHs

SoManyHs Apr 22, 2019

piradeepk Apr 22, 2019 •

edited

SoManyHs Apr 22, 2019

piradeepk Apr 22, 2019

SoManyHs Apr 22, 2019

SoManyHs commented Apr 22, 2019

piradeepk commented Apr 22, 2019

SoManyHs commented Apr 22, 2019

jogold commented Apr 22, 2019 •

edited

piradeepk commented Apr 22, 2019 •

edited

SoManyHs commented Apr 22, 2019

SoManyHs left a comment

SoManyHs left a comment

piradeepk commented Apr 26, 2019

piradeepk commented May 13, 2019

rix0rrr commented May 23, 2019

feat(aws-ecs): add ScheduledEc2Task L3 construct #2336

feat(aws-ecs): add ScheduledEc2Task L3 construct #2336

Conversation

piradeepk commented Apr 19, 2019 • edited by SoManyHs

Pull Request Checklist

SoManyHs Apr 22, 2019

Choose a reason for hiding this comment

piradeepk Apr 22, 2019 • edited

Choose a reason for hiding this comment

SoManyHs Apr 22, 2019

Choose a reason for hiding this comment

piradeepk Apr 22, 2019

Choose a reason for hiding this comment

SoManyHs Apr 22, 2019

Choose a reason for hiding this comment

SoManyHs commented Apr 22, 2019

piradeepk commented Apr 22, 2019

SoManyHs commented Apr 22, 2019

jogold commented Apr 22, 2019 • edited

piradeepk commented Apr 22, 2019 • edited

SoManyHs commented Apr 22, 2019

SoManyHs left a comment

Choose a reason for hiding this comment

SoManyHs left a comment

Choose a reason for hiding this comment

piradeepk commented Apr 26, 2019

piradeepk commented May 13, 2019

rix0rrr commented May 23, 2019

piradeepk commented Apr 19, 2019 •

edited by SoManyHs

piradeepk Apr 22, 2019 •

edited

jogold commented Apr 22, 2019 •

edited

piradeepk commented Apr 22, 2019 •

edited