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.604.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7aa0bf68eff5406a03a1571585dcabba7a4427f0bfd67ac14789f018486ab60b |
|
MD5 | 59ec16cb30faffa56cad916101186bd6 |
|
BLAKE2b-256 | b3fb5b2fd06be1d23f4e8690dfc4b5494e06c62c0281bc18448d8ac90a10883e |
Hashes for cdk_docker_image_deployment-0.0.604-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e77d489f9a39c91d3c4bd95beea04e7d1f829e2c8dad81747f27777095436239 |
|
MD5 | 160b45cca3f619279e4a83de10ddfb40 |
|
BLAKE2b-256 | 0fef7a5a3718e54b3eb281626acd2d9bcacaa8d46f0e13b1ca36ab1b225c8a62 |