Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(ecr-assets): mention CDK_DOCKER environment variable in README #32586

Merged
merged 8 commits into from
Dec 28, 2024
7 changes: 6 additions & 1 deletion packages/aws-cdk-lib/aws-ecr-assets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ asset hash.
Additionally, you can supply `buildSecrets`. Your system must have Buildkit
enabled, see https://docs.docker.com/build/buildkit/.

Also, similarly to `@aws-cdk/aws-s3-assets`, you can set the CDK_DOCKER environment
variable in order to provide a custom Docker executable command or path. This may sometimes
be needed when building in environments where the standard docker cannot be executed
(see https://github.com/aws/aws-cdk/issues/8460 for details).

SSH agent sockets or keys may be passed to docker build via `buildSsh`.

```ts
Expand Down Expand Up @@ -209,5 +214,5 @@ 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), you must either copy the image to a new repository, or
grant pull permissions on the resource policy of the repository. Since the repository is managed by the CDK bootstrap stack,
the following permissions must be granted there, or granted manually on the repository: "ecr:GetDownloadUrlForLayer",
the following permissions must be granted there, or granted manually on the repository: "ecr:GetDownloadUrlForLayer",
"ecr:BatchGetImage" and "ecr:BatchCheckLayerAvailability".
Loading