Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(codepipeline-actions): native Amazon EC2 deployment support #33604

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Tietew
Copy link
Contributor

@Tietew Tietew commented Feb 27, 2025

Issue # (if applicable)

Closes #33584.

Reason for this change

AWS CodePipeline introduces a new action to deploy to Amazon Elastic Compute Cloud (EC2).
https://aws.amazon.com/about-aws/whats-new/2025/02/aws-codepipeline-native-ec2-deployment-support/

Description of changes

Added Ec2DeployAction action class.
Usage:

new codepipeline_actions.Ec2DeployAction({
  actionName: 'EC2',
  input: buildOutput,
  // specify tag key and value, not ec2.IInstance
  instanceTagKey: 'Target',                 // REQUIRED
  instanceTagValue: 'DeployTarget',         // REQUIRED
  // deployment target and hooks
  targetDirectory: '/home/ec2-user/deploy', // REQUIRED
  preScript: 'hooks/pre-script',
  postScript: 'hooks/post-script',          // REQUIRED
  // the action will detach and attach instances from/to target groups
  targetGroups: [myTargetGroup],
  // the number or percentage of instances that can deploy in parallel
  maxBatch: codepipeline_actions.Ec2MaxInstances.target(2),
  maxError: codepipeline_actions.Ec2MaxInstances.target(1),
});

Describe any new or updated permissions being added

Ec2DeployAction adds permissions based on CodePipeline documentation:
https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-EC2Deploy.html#action-reference-EC2Deploy-permissions-action

Description of how you validated changes

Unit tests and an integ test.
The integ test also asserts pipeline execution.

Checklist


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

@github-actions github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 labels Feb 27, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team February 27, 2025 08:58
@github-actions github-actions bot added the star-contributor [Pilot] contributed between 25-49 PRs to the CDK label Feb 27, 2025
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

contains 3 files:

  • index.html - fetched on assertions
  • scripts/pre-deploy.sh - specified as preScript; just runs true
  • scripts/post-deploy.sh - specified as postScript; just runs true

Copy link

codecov bot commented Feb 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.21%. Comparing base (dd0d62f) to head (6773a05).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #33604   +/-   ##
=======================================
  Coverage   82.21%   82.21%           
=======================================
  Files         119      119           
  Lines        6876     6876           
  Branches     1162     1162           
=======================================
  Hits         5653     5653           
  Misses       1120     1120           
  Partials      103      103           
Flag Coverage Δ
suite.unit 82.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk ∅ <ø> (∅)
packages/aws-cdk-lib/core 82.21% <ø> (ø)

/**
* Max number of instances.
*
* Valid range: from 1 to number of your instances
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Validation based on AWS console:
image

/**
* Max percentage of instances.
*
* Valid range: from 1 to 99
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Validation based on AWS console:
image

TargetDirectory: this.props.targetDirectory,
MaxBatch: this.props.maxBatch?.value,
MaxError: this.props.maxError?.value,
TargetGroupNameList: this.props.targetGroups?.length ? this.props.targetGroups.map((tg) => tg.targetGroupName).join(',') : undefined,
Copy link
Contributor Author

@Tietew Tietew Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From AWS console, TargetGroupListName is a comma-separated string instead of a JSON array.

Result of GetPipeline: (pipeline created by console)
image

if (!Token.isUnresolved(percentage) && !(percentage >= 1 && percentage <= 99 && Number.isInteger(percentage))) {
throw new UnscopedValidationError(`percentage must be a positive integer between 1 and 99. got ${percentage}`);
}
return { value: `${Tokenization.stringifyNumber(percentage)}%` };
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From AWS console, percentage is represented as "NN%"
image

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 27, 2025
Comment on lines +148 to +155
if (
props.maxBatch && props.maxError &&
!Token.isUnresolved(props.maxBatch.value) && !Token.isUnresolved(props.maxError.value) &&
props.maxBatch.value.endsWith('%') === props.maxError.value.endsWith('%') &&
parseInt(props.maxBatch.value, 10) <= parseInt(props.maxError.value, 10)
) {
throw new UnscopedValidationError(`The maxError must be less than the maxBatch ${props.maxBatch.value}. got ${props.maxError.value}`);
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When maxBatch <= maxError, action execution will fail:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. star-contributor [Pilot] contributed between 25-49 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(codepipeline): native Amazon EC2 deployment support
2 participants