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.
Project description
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 = new 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
DockerImageDeployment
construct 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.
Project details
Release history Release notifications | RSS feed
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
Hashes for cdk-docker-image-deployment-0.0.343.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3bac7cb8eb122ff5a79c0b331d09ac7ef08eff0337308421d4dbbd6fefbae4b |
|
MD5 | 12e99c05ec9bd8eecdf1f4e7fd8eecbe |
|
BLAKE2b-256 | 1c0913bcab06178fa628ef7f708f206f905bcc99e25d58e73eb88e6d6e133ebb |
Hashes for cdk_docker_image_deployment-0.0.343-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37290e8b963387d1fb904bcc9bb709f420976a9e08892bd7fe0e7b7ba2e5317f |
|
MD5 | 8df8737806c516486c4f4e425ac597a2 |
|
BLAKE2b-256 | b539256392cd9091ea74ba66fbc2f187da87a25e6e29d193d1257b76d27a1f27 |