CDK ECS CodeDeploy
This project contains CDK constructs to create CodeDeploy ECS deployments.
Installation
TypeScript
yarn add @cdklabs/cdk-ecs-codedeploy
Deployments
CodeDeploy for ECS can manage the deployment of new task definitions to ECS services. Only 1 deployment construct can be defined for a given EcsDeploymentGroup.
from cdk.ecs_codedeploy import TargetService
# deployment_group: codeDeploy.IEcsDeploymentGroup
# task_definition: ecs.ITaskDefinition
EcsDeployment(
deployment_group=deployment_group,
target_service=TargetService(
task_definition=task_definition,
container_name="mycontainer",
container_port=80
)
)
The deployment will use the AutoRollbackConfig for the EcsDeploymentGroup unless it is overridden in the deployment:
from cdk.ecs_codedeploy import TargetService
# deployment_group: codeDeploy.IEcsDeploymentGroup
# task_definition: ecs.ITaskDefinition
EcsDeployment(
deployment_group=deployment_group,
target_service=TargetService(
task_definition=task_definition,
container_name="mycontainer",
container_port=80
),
auto_rollback=codeDeploy.AutoRollbackConfig(
failed_deployment=True,
deployment_in_alarm=True,
stopped_deployment=False
)
)
By default, the deployment will timeout after 30 minutes. The timeout value can be overridden:
from cdk.ecs_codedeploy import TargetService
# deployment_group: codeDeploy.IEcsDeploymentGroup
# task_definition: ecs.ITaskDefinition
EcsDeployment(
deployment_group=deployment_group,
target_service=TargetService(
task_definition=task_definition,
container_name="mycontainer",
container_port=80
),
timeout=Duration.minutes(60)
)
API Canaries
CodeDeploy can leverage Cloudwatch Alarms to trigger automatic rollbacks. The ApiCanary construct simplifies the process for creating CloudWatch Synthetics Canaries to monitor APIs. The following code demonstrates a canary that monitors https://xkcd.com/908/info.0.json and checks the JSON response to assert that safe_title has the value of 'The Cloud'.
from cdk.ecs_codedeploy import ApiTestStep
canary = ApiCanary(stack, "Canary",
base_url="https://xkcd.com",
duration_alarm_threshold=Duration.seconds(5),
thread_count=5,
steps=[ApiTestStep(
name="info",
path="/908/info.0.json",
jmes_path="safe_title",
expected_value="The Cloud"
)
]
)
Application Load Balanced CodeDeployed Fargate Service
An L3 construct named ApplicationLoadBalancedCodeDeployedFargateService extends ApplicationLoadBalancedFargateService and adds support for deploying new versions of the service with AWS CodeDeploy. Additionally, an Amazon CloudWatch Synthetic canary is created via the ApiCanary construct and is monitored by the CodeDeploy deployment to trigger rollback if the canary begins to alarm.
from aws_cdk.aws_ecs_patterns import ApplicationLoadBalancedTaskImageOptions
from cdk.ecs_codedeploy import ApiTestStep
# cluster: ecs.ICluster
# image: ecs.ContainerImage
service = ApplicationLoadBalancedCodeDeployedFargateService(stack, "Service",
cluster=cluster,
task_image_options=ApplicationLoadBalancedTaskImageOptions(
image=image
),
api_test_steps=[ApiTestStep(
name="health",
path="/health",
jmes_path="status",
expected_value="ok"
)]
)
Local Development
yarn install
yarn build
yarn test
To run an integration test and update the snapshot, run:
yarn integ:ecs-deployment:deploy
To recreate snapshots for integration tests, run:
yarn integ:snapshot-all
Security
See CONTRIBUTING for more information.
License
This project is licensed under the Apache-2.0 License.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cdklabs_ecs_codedeploy-0.0.452.tar.gz.
File metadata
- Download URL: cdklabs_ecs_codedeploy-0.0.452.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
51589f486532eeb005fea2ad39666774edec1d41245af2e59ee827b58841aae1
|
|
| MD5 |
b01a383b9faab93dd1fafcc92dd878ed
|
|
| BLAKE2b-256 |
98e1df01e4e5fef4da10a80eb439d653a524e9d5d295171f1f46e298262d188a
|
Provenance
The following attestation bundles were made for cdklabs_ecs_codedeploy-0.0.452.tar.gz:
Publisher:
release.yml on cdklabs/cdk-ecs-codedeploy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdklabs_ecs_codedeploy-0.0.452.tar.gz -
Subject digest:
51589f486532eeb005fea2ad39666774edec1d41245af2e59ee827b58841aae1 - Sigstore transparency entry: 2411332753
- Sigstore integration time:
-
Permalink:
cdklabs/cdk-ecs-codedeploy@3ecb1313fa697a4bfd3fd733a9d98363b5cc9d5d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cdklabs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3ecb1313fa697a4bfd3fd733a9d98363b5cc9d5d -
Trigger Event:
push
-
Statement type:
File details
Details for the file cdklabs_ecs_codedeploy-0.0.452-py3-none-any.whl.
File metadata
- Download URL: cdklabs_ecs_codedeploy-0.0.452-py3-none-any.whl
- Upload date:
- Size: 1.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
318b190200d80b41fe6bc85492c971c48f21c62d93e99aa75e7f2c2d594da160
|
|
| MD5 |
a22f6e660f2d23a11a68c5fccd08cfdd
|
|
| BLAKE2b-256 |
aa141379ad421e02176a35e8e68ce373d7f52c6a89eaa6f6cf78c724584d6191
|
Provenance
The following attestation bundles were made for cdklabs_ecs_codedeploy-0.0.452-py3-none-any.whl:
Publisher:
release.yml on cdklabs/cdk-ecs-codedeploy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdklabs_ecs_codedeploy-0.0.452-py3-none-any.whl -
Subject digest:
318b190200d80b41fe6bc85492c971c48f21c62d93e99aa75e7f2c2d594da160 - Sigstore transparency entry: 2411332680
- Sigstore integration time:
-
Permalink:
cdklabs/cdk-ecs-codedeploy@3ecb1313fa697a4bfd3fd733a9d98363b5cc9d5d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cdklabs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@3ecb1313fa697a4bfd3fd733a9d98363b5cc9d5d -
Trigger Event:
push
-
Statement type:
