Docker image assets deployed to ECR
Project description
AWS CDK Docker Image Assets
---The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
This module allows bundling Docker images as assets.
Images are built from a local Docker context directory (with a Dockerfile
),
uploaded to ECR by the CDK toolkit and/or your app's CI-CD pipeline, and can be
naturally referenced in your CDK app.
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_cdk.aws_ecr_assets import DockerImageAsset
asset = DockerImageAsset(self, "MyBuildImage",
directory=path.join(__dirname, "my-image")
)
The directory my-image
must include a Dockerfile
.
This will instruct the toolkit to build a Docker image from my-image
, push it
to an AWS ECR repository and wire the name of the repository as CloudFormation
parameters to your stack.
Use asset.imageUri
to reference the image (it includes both the ECR image URL
and tag.
You can optionally pass build args to the docker build
command by specifying
the buildArgs
property:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
asset = DockerImageAsset(self, "MyBuildImage",
directory=path.join(__dirname, "my-image"),
build_args={
"HTTP_PROXY": "http://10.20.30.2:1234"
}
)
You can optionally pass a target to the docker build
command by specifying
the target
property:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
asset = DockerImageAsset(self, "MyBuildImage",
directory=path.join(__dirname, "my-image"),
target="a-target"
)
Pull Permissions
Depending on the consumer of your image asset, you will need to make sure the principal has permissions to pull the image.
In most cases, you should use the asset.repository.grantPull(principal)
method. This will modify the IAM policy of the principal to allow it to
pull images from this repository.
If the pulling principal is not in the same account or is an AWS service that
doesn't assume a role in your account (e.g. AWS CodeBuild), pull permissions
must be granted on the resource policy (and not on the principal's policy).
To do that, you can use asset.repository.addToResourcePolicy(statement)
to
grant the desired principal the following permissions: "ecr:GetDownloadUrlForLayer",
"ecr:BatchGetImage" and "ecr:BatchCheckLayerAvailability".
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 aws-cdk.aws-ecr-assets-1.60.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26a15823c10c4814586a78747d74f77e2a1396c2e7cc6a72b44fcb1824506c9a |
|
MD5 | 40e8785704a8cf44721b41d2605462b1 |
|
BLAKE2b-256 | 6e729ce9d465df07c33a1c98124fd83de914e45666e0e5a2b181875ca8fa6c17 |
Hashes for aws_cdk.aws_ecr_assets-1.60.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c330a7cee3ba6fa96b59d1efa86e32c55482be2d151311904dc275d920f13f71 |
|
MD5 | 3089ec5860d76c016c8a6437dc3465b4 |
|
BLAKE2b-256 | 58c2895e8df514c5df31a90f2bf24ac3e03a7e814960e7bb470ff3b3909c47ee |