Skip to content

Commit

Permalink
docs(ecr-assets): mention CDK_DOCKER environment variable in README (#…
Browse files Browse the repository at this point in the history
…32586)

### Issue # (if applicable)

Closes #32585.

### Reason for this change

This change adds description that `CDK_DOCKER` environment variable is also effective in `aws-ecr-assets` module like `aws-s3-assets`.

### Description of changes

Just a documentation change. No code change.

### Describe any new or updated permissions being added

N/A

### Description of how you validated changes

I confirmed the environment variable is effective locally.

### Checklist
- [X] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
ymotongpoo authored Dec 28, 2024
1 parent 1c9103e commit 7f6f94c
Showing 1 changed file with 6 additions and 1 deletion.
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".

0 comments on commit 7f6f94c

Please sign in to comment.