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.363.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d7119a386626e3e67f67da98684e284e34ca883b779ab14def8cbca0b250cfa |
|
MD5 | 3f806d9b91c46d6eab77bd9e05436e3b |
|
BLAKE2b-256 | d6730cdeb53b86f84bc5c585b92c3609014ce0b28cce93843c7c44c11cd8fedf |
Hashes for cdk_docker_image_deployment-0.0.363-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e854a1d97bcacf364ca3f3c782325207d9c15e625d0b58ec70ef90cc12c71cf |
|
MD5 | 016d02c543dcfde81a2b4bdeccbd743f |
|
BLAKE2b-256 | 81417b873ad93ba3ce09a1ad27209ad651f42292bb315fb85c9904e61da5ebd2 |