CDK Docker Image Deployment
This module allows you to copy docker image assets to a repository you control. This can be necessary if you want to build a Docker image in one CDK app and consume it in a different app or outside the CDK, or if you want to apply a lifecycle policy to all images of a part of your application.
Getting Started
Below is a basic example for how to use the DockerImageDeployment API:
import * as ecr from 'aws-cdk-lib/aws-ecr';
import * as imagedeploy from 'cdk-docker-image-deployment';
const repo = ecr.Repository.fromRepositoryName(this, 'MyRepository', 'myrepository');
new imagedeploy.DockerImageDeployment(this, 'ExampleImageDeploymentWithTag', {
source: imagedeploy.Source.directory('path/to/directory'),
destination: imagedeploy.Destination.ecr(repo, {
tag: 'myspecialtag',
}),
});
Currently Supported Sources
Source.directory(): Supply a path to a local docker image as source.
Don't see a source listed? See if there is an open issue or PR already. If not, please open an issue asking for it or better yet, submit a contribution!
Currently Supported Destinations
Destination.ecr(repo, options): Send your docker image to an ECR repository in your stack's account.
Don't see a destination listed? See if there is an open issue or PR already. If not, please open an issue asking for it or better yet, submit a contribution!
Under the Hood
- When this stack is deployed (either via cdk deploy or via CI/CD), the contents of the local Docker image will be archived and uploaded to an intermediary assets ECR Repository using the cdk-assets mechanism.
- The
DockerImageDeploymentconstruct synthesizes a CodeBuild Project which uses docker to pull the image from the intermediary repository, tag the image if a tag is provided, and push the image to the destination repository. - The deployment will wait until the CodeBuild Project completes successfully before finishing.
The architecture of this construct can be seen here:
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 cdk_docker_image_deployment-0.0.1000.tar.gz.
File metadata
- Download URL: cdk_docker_image_deployment-0.0.1000.tar.gz
- Upload date:
- Size: 13.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 |
71c570d2a7785a7c1f2b128e475d2045a8d47f502345ad631f6f15cba4b2f01f
|
|
| MD5 |
b5f96ad6e817ae5c93bf98a27bcfb99e
|
|
| BLAKE2b-256 |
409e371bf5a5c73f583468a31ed706eb4ec01f7fc737281c88af8159307f0d0a
|
Provenance
The following attestation bundles were made for cdk_docker_image_deployment-0.0.1000.tar.gz:
Publisher:
release.yml on cdklabs/cdk-docker-image-deployment
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdk_docker_image_deployment-0.0.1000.tar.gz -
Subject digest:
71c570d2a7785a7c1f2b128e475d2045a8d47f502345ad631f6f15cba4b2f01f - Sigstore transparency entry: 2341822151
- Sigstore integration time:
-
Permalink:
cdklabs/cdk-docker-image-deployment@32fa9ab2620757a2e13bbd660f2430afd13832e2 -
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@32fa9ab2620757a2e13bbd660f2430afd13832e2 -
Trigger Event:
push
-
Statement type:
File details
Details for the file cdk_docker_image_deployment-0.0.1000-py3-none-any.whl.
File metadata
- Download URL: cdk_docker_image_deployment-0.0.1000-py3-none-any.whl
- Upload date:
- Size: 13.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 |
04fd2f7773b9ca749cae2c5deb91ef6456e8a3ea8be641d8bb3b641ec414544a
|
|
| MD5 |
41be2e01191d6df5306158d86499bd7f
|
|
| BLAKE2b-256 |
6e420cf4af4d3da84f2d54def46e9c467a6b78c61f35f1f62fdef69145bf6c57
|
Provenance
The following attestation bundles were made for cdk_docker_image_deployment-0.0.1000-py3-none-any.whl:
Publisher:
release.yml on cdklabs/cdk-docker-image-deployment
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdk_docker_image_deployment-0.0.1000-py3-none-any.whl -
Subject digest:
04fd2f7773b9ca749cae2c5deb91ef6456e8a3ea8be641d8bb3b641ec414544a - Sigstore transparency entry: 2341822114
- Sigstore integration time:
-
Permalink:
cdklabs/cdk-docker-image-deployment@32fa9ab2620757a2e13bbd660f2430afd13832e2 -
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@32fa9ab2620757a2e13bbd660f2430afd13832e2 -
Trigger Event:
push
-
Statement type:
