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.129.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce56b74267202c22bc09b20f2375f29b576286e00c44b6026ad48d7167bb9219 |
|
MD5 | 03936f5007f46de64611b63ea4079174 |
|
BLAKE2b-256 | 2edf678f85156ae29b5f9170feeed1edda92aaf4d301fc2b89f8adb27dc91b6a |
Hashes for cdk_docker_image_deployment-0.0.129-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1dad8e429e98aa4d5eadbd629fa01b1bb49e544c5ccf45bc4abbfa5f487dd38 |
|
MD5 | 0b158bcc2ef1d7145797d51e98535e0c |
|
BLAKE2b-256 | 5f416a9dce84befe47fd4bfc3493b1f43dc048d1ed6ae7222fc3921685a0240c |