# AWS CDK Docker Image Assets
<!--BEGIN STABILITY BANNER-->---
---
<!--END STABILITY BANNER-->
This module allows bundling Docker images as assets.
## Images from Dockerfile
Images are built from a local Docker context directory (with a `Dockerfile`),
uploaded to Amazon Elastic Container Registry (ECR) by the CDK toolkit
and/or your app's CI/CD pipeline, and can be naturally referenced in your CDK app.
```python
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 Amazon ECR repository and wire the name of the repository as CloudFormation
parameters to your stack.
By default, all files in the given directory will be copied into the docker
*build context*. If there is a large directory that you know you definitely
don't need in the build context you can improve the performance by adding the
names of files and directories to ignore to a file called `.dockerignore`, or
pass them via the `exclude` property. If both are available, the patterns
found in `exclude` are appended to the patterns found in `.dockerignore`.
The `ignoreMode` property controls how the set of ignore patterns is
interpreted. The recommended setting for Docker image assets is
`IgnoreMode.DOCKER`. If the context flag
`@aws-cdk/aws-ecr-assets:dockerIgnoreSupport` is set to `true` in your
`cdk.json` (this is by default for new projects, but must be set manually for
old projects) then `IgnoreMode.DOCKER` is the default and you don't need to
configure it on the asset itself.
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. It is recommended to skip hashing of `buildArgs` for
values that can change between different machines to maintain a consistent
asset hash.
```python
from aws_cdk.aws_ecr_assets import DockerImageAsset
asset = DockerImageAsset(self, "MyBuildImage",
directory=path.join(__dirname, "my-image"),
build_args={
"HTTP_PROXY": "http://10.20.30.2:1234"
},
invalidation=DockerImageAssetInvalidationOptions(
build_args=False
)
)
```
You can optionally pass a target to the `docker build` command by specifying
the `target` property:
```python
from aws_cdk.aws_ecr_assets import DockerImageAsset
asset = DockerImageAsset(self, "MyBuildImage",
directory=path.join(__dirname, "my-image"),
target="a-target"
)
```
You can optionally pass networking mode to the `docker build` command by specifying
the `networkMode` property:
```python
from aws_cdk.aws_ecr_assets import DockerImageAsset, NetworkMode
asset = DockerImageAsset(self, "MyBuildImage",
directory=path.join(__dirname, "my-image"),
network_mode=NetworkMode.HOST
)
```
You can optionally pass an alternate platform to the `docker build` command by specifying
the `platform` property:
```python
from aws_cdk.aws_ecr_assets import DockerImageAsset, Platform
asset = DockerImageAsset(self, "MyBuildImage",
directory=path.join(__dirname, "my-image"),
platform=Platform.LINUX_ARM64
)
```
## Images from Tarball
Images are loaded from a local tarball, uploaded to ECR by the CDK toolkit and/or your app's CI-CD pipeline, and can be
naturally referenced in your CDK app.
```python
from aws_cdk.aws_ecr_assets import TarballImageAsset
asset = TarballImageAsset(self, "MyBuildImage",
tarball_file="local-image.tar"
)
```
This will instruct the toolkit to add the tarball as a file asset. During deployment it will load the container image
from `local-image.tar`, push it to an Amazon ECR repository and wire the name of the repository as CloudFormation parameters
to your stack.
## Publishing images to ECR repositories
`DockerImageAsset` is designed for seamless build & consumption of image assets by CDK code deployed to multiple environments
through the CDK CLI or through CI/CD workflows. To that end, the ECR repository behind this construct is controlled by the AWS CDK.
The mechanics of where these images are published and how are intentionally kept as an implementation detail, and the construct
does not support customizations such as specifying the ECR repository name or tags.
If you are looking for a way to *publish* image assets to an ECR repository in your control, you should consider using
[cdklabs/cdk-ecr-deployment](https://github.com/cdklabs/cdk-ecr-deployment), which is able to replicate an image asset from the CDK-controlled ECR repository to a repository of
your choice.
Here an example from the [cdklabs/cdk-ecr-deployment](https://github.com/cdklabs/cdk-ecr-deployment) project:
```text
// This example available in TypeScript only
import { DockerImageAsset } from '@aws-cdk/aws-ecr-assets';
import * as ecrdeploy from 'cdk-ecr-deployment';
const image = new DockerImageAsset(this, 'CDKDockerImage', {
directory: path.join(__dirname, 'docker'),
});
new ecrdeploy.ECRDeployment(this, 'DeployDockerImage', {
src: new ecrdeploy.DockerImageName(image.imageUri),
dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/test:nginx`),
});
```
⚠️ Please note that this is a 3rd-party construct library and is not officially supported by AWS.
You are welcome to +1 [this GitHub issue](https://github.com/aws/aws-cdk/issues/12597) if you would like to see
native support for this use-case in the AWS CDK.
## 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".
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-cdk",
"name": "aws-cdk.aws-ecr-assets",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/e8/c8/2367bf970ff8c8284574786441df852d6bca54d1a4d02880baf09b1b8c70/aws-cdk.aws-ecr-assets-1.203.0.tar.gz",
"platform": null,
"description": "# AWS CDK Docker Image Assets\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n---\n<!--END STABILITY BANNER-->\n\nThis module allows bundling Docker images as assets.\n\n## Images from Dockerfile\n\nImages are built from a local Docker context directory (with a `Dockerfile`),\nuploaded to Amazon Elastic Container Registry (ECR) by the CDK toolkit\nand/or your app's CI/CD pipeline, and can be naturally referenced in your CDK app.\n\n```python\nfrom aws_cdk.aws_ecr_assets import DockerImageAsset\n\n\nasset = DockerImageAsset(self, \"MyBuildImage\",\n directory=path.join(__dirname, \"my-image\")\n)\n```\n\nThe directory `my-image` must include a `Dockerfile`.\n\nThis will instruct the toolkit to build a Docker image from `my-image`, push it\nto an Amazon ECR repository and wire the name of the repository as CloudFormation\nparameters to your stack.\n\nBy default, all files in the given directory will be copied into the docker\n*build context*. If there is a large directory that you know you definitely\ndon't need in the build context you can improve the performance by adding the\nnames of files and directories to ignore to a file called `.dockerignore`, or\npass them via the `exclude` property. If both are available, the patterns\nfound in `exclude` are appended to the patterns found in `.dockerignore`.\n\nThe `ignoreMode` property controls how the set of ignore patterns is\ninterpreted. The recommended setting for Docker image assets is\n`IgnoreMode.DOCKER`. If the context flag\n`@aws-cdk/aws-ecr-assets:dockerIgnoreSupport` is set to `true` in your\n`cdk.json` (this is by default for new projects, but must be set manually for\nold projects) then `IgnoreMode.DOCKER` is the default and you don't need to\nconfigure it on the asset itself.\n\nUse `asset.imageUri` to reference the image. It includes both the ECR image URL\nand tag.\n\nYou can optionally pass build args to the `docker build` command by specifying\nthe `buildArgs` property. It is recommended to skip hashing of `buildArgs` for\nvalues that can change between different machines to maintain a consistent\nasset hash.\n\n```python\nfrom aws_cdk.aws_ecr_assets import DockerImageAsset\n\n\nasset = DockerImageAsset(self, \"MyBuildImage\",\n directory=path.join(__dirname, \"my-image\"),\n build_args={\n \"HTTP_PROXY\": \"http://10.20.30.2:1234\"\n },\n invalidation=DockerImageAssetInvalidationOptions(\n build_args=False\n )\n)\n```\n\nYou can optionally pass a target to the `docker build` command by specifying\nthe `target` property:\n\n```python\nfrom aws_cdk.aws_ecr_assets import DockerImageAsset\n\n\nasset = DockerImageAsset(self, \"MyBuildImage\",\n directory=path.join(__dirname, \"my-image\"),\n target=\"a-target\"\n)\n```\n\nYou can optionally pass networking mode to the `docker build` command by specifying\nthe `networkMode` property:\n\n```python\nfrom aws_cdk.aws_ecr_assets import DockerImageAsset, NetworkMode\n\n\nasset = DockerImageAsset(self, \"MyBuildImage\",\n directory=path.join(__dirname, \"my-image\"),\n network_mode=NetworkMode.HOST\n)\n```\n\nYou can optionally pass an alternate platform to the `docker build` command by specifying\nthe `platform` property:\n\n```python\nfrom aws_cdk.aws_ecr_assets import DockerImageAsset, Platform\n\n\nasset = DockerImageAsset(self, \"MyBuildImage\",\n directory=path.join(__dirname, \"my-image\"),\n platform=Platform.LINUX_ARM64\n)\n```\n\n## Images from Tarball\n\nImages are loaded from a local tarball, uploaded to ECR by the CDK toolkit and/or your app's CI-CD pipeline, and can be\nnaturally referenced in your CDK app.\n\n```python\nfrom aws_cdk.aws_ecr_assets import TarballImageAsset\n\n\nasset = TarballImageAsset(self, \"MyBuildImage\",\n tarball_file=\"local-image.tar\"\n)\n```\n\nThis will instruct the toolkit to add the tarball as a file asset. During deployment it will load the container image\nfrom `local-image.tar`, push it to an Amazon ECR repository and wire the name of the repository as CloudFormation parameters\nto your stack.\n\n## Publishing images to ECR repositories\n\n`DockerImageAsset` is designed for seamless build & consumption of image assets by CDK code deployed to multiple environments\nthrough the CDK CLI or through CI/CD workflows. To that end, the ECR repository behind this construct is controlled by the AWS CDK.\nThe mechanics of where these images are published and how are intentionally kept as an implementation detail, and the construct\ndoes not support customizations such as specifying the ECR repository name or tags.\n\nIf you are looking for a way to *publish* image assets to an ECR repository in your control, you should consider using\n[cdklabs/cdk-ecr-deployment](https://github.com/cdklabs/cdk-ecr-deployment), which is able to replicate an image asset from the CDK-controlled ECR repository to a repository of\nyour choice.\n\nHere an example from the [cdklabs/cdk-ecr-deployment](https://github.com/cdklabs/cdk-ecr-deployment) project:\n\n```text\n// This example available in TypeScript only\n\nimport { DockerImageAsset } from '@aws-cdk/aws-ecr-assets';\nimport * as ecrdeploy from 'cdk-ecr-deployment';\n\nconst image = new DockerImageAsset(this, 'CDKDockerImage', {\n directory: path.join(__dirname, 'docker'),\n});\n\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage', {\n src: new ecrdeploy.DockerImageName(image.imageUri),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/test:nginx`),\n});\n```\n\n\u26a0\ufe0f Please note that this is a 3rd-party construct library and is not officially supported by AWS.\nYou are welcome to +1 [this GitHub issue](https://github.com/aws/aws-cdk/issues/12597) if you would like to see\nnative support for this use-case in the AWS CDK.\n\n## Pull Permissions\n\nDepending on the consumer of your image asset, you will need to make sure\nthe principal has permissions to pull the image.\n\nIn most cases, you should use the `asset.repository.grantPull(principal)`\nmethod. This will modify the IAM policy of the principal to allow it to\npull images from this repository.\n\nIf the pulling principal is not in the same account or is an AWS service that\ndoesn't assume a role in your account (e.g. AWS CodeBuild), pull permissions\nmust be granted on the **resource policy** (and not on the principal's policy).\nTo do that, you can use `asset.repository.addToResourcePolicy(statement)` to\ngrant the desired principal the following permissions: \"ecr:GetDownloadUrlForLayer\",\n\"ecr:BatchGetImage\" and \"ecr:BatchCheckLayerAvailability\".\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Docker image assets deployed to ECR",
"version": "1.203.0",
"project_urls": {
"Homepage": "https://github.com/aws/aws-cdk",
"Source": "https://github.com/aws/aws-cdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69a12a2cfbc7053777666b183a403ed5d6428bc3b6b3cdf76eafcfc9a2f7a197",
"md5": "29df7ce11c5d78957d37617b5edafb79",
"sha256": "ebcee8a9159382c373b07ad28c66f7304d07747f0418983c7079d251b3f221bf"
},
"downloads": -1,
"filename": "aws_cdk.aws_ecr_assets-1.203.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29df7ce11c5d78957d37617b5edafb79",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 56005,
"upload_time": "2023-05-31T22:54:32",
"upload_time_iso_8601": "2023-05-31T22:54:32.975338Z",
"url": "https://files.pythonhosted.org/packages/69/a1/2a2cfbc7053777666b183a403ed5d6428bc3b6b3cdf76eafcfc9a2f7a197/aws_cdk.aws_ecr_assets-1.203.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e8c82367bf970ff8c8284574786441df852d6bca54d1a4d02880baf09b1b8c70",
"md5": "1dde2007baa159db41c1d60220e16034",
"sha256": "4c6bab4f0679bf7fa6c3e7964e848719544ddb9beb5071a7749199486dcdec27"
},
"downloads": -1,
"filename": "aws-cdk.aws-ecr-assets-1.203.0.tar.gz",
"has_sig": false,
"md5_digest": "1dde2007baa159db41c1d60220e16034",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 57506,
"upload_time": "2023-05-31T23:02:05",
"upload_time_iso_8601": "2023-05-31T23:02:05.838333Z",
"url": "https://files.pythonhosted.org/packages/e8/c8/2367bf970ff8c8284574786441df852d6bca54d1a4d02880baf09b1b8c70/aws-cdk.aws-ecr-assets-1.203.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-31 23:02:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-cdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-cdk.aws-ecr-assets"
}
JSON
