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.

Sign up for GitHub

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

Jump to bottom

aws-ecr-assets: there's no description about CDK_DOCKER environment variable #32585

Closed
ymotongpoo opened this issue Dec 19, 2024 · 3 comments · Fixed by #32586
Closed

aws-ecr-assets: there's no description about CDK_DOCKER environment variable #32585

ymotongpoo opened this issue Dec 19, 2024 · 3 comments · Fixed by #32586
Labels
@aws-cdk/aws-ecr-assets Related to AWS CDK Docker Image Assets documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@ymotongpoo
Copy link
Contributor

Describe the issue

Though there are cases where the local machine doesn't have docker command but has podman, nerdctl or finch, the document of aws-ecr-assets doesn't mention that it supports Docker CLI compatible commands with CDK_DOCKER. This information is not available either from the document[1] or from the error message[2].

[1] https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr_assets-readme.html

[2]

ContainerAassetsStack: fail: Unable to execute 'docker' in order to build a container asset. Please install 'docker' and try again.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr_assets-readme.html#images-from-dockerfile
@ymotongpoo ymotongpoo added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Dec 19, 2024
@github-actions github-actions bot added the @aws-cdk/aws-ecr-assets Related to AWS CDK Docker Image Assets label Dec 19, 2024
@ymotongpoo ymotongpoo mentioned this issue Dec 19, 2024
Merged
1 task
@khushail khushail added investigating This issue is being investigated and/or work is in progress to resolve the issue. p2 and removed needs-triage This issue or PR still needs to be triaged. labels Dec 19, 2024
@khushail khushail self-assigned this Dec 19, 2024
@khushail
Copy link
Contributor

Thanks @ymotongpoo for reporting this issue and submitting a PR for the same. Its always helpful to have clear documentation and your PR adds-on on that enhancement about CDK_DOCKER. Appreciate your efforts!

@khushail khushail removed their assignment Dec 19, 2024
@khushail khushail added effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Dec 19, 2024
@mergify mergify bot closed this as completed in #32586 Dec 28, 2024
@mergify mergify bot closed this as completed in 7f6f94c Dec 28, 2024
@github-actions GitHub Actions
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

1 similar comment
@github-actions GitHub Actions
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 28, 2024
iankhou pushed a commit that referenced this issue Jan 13, 2025
@ymotongpoo
docs(ecr-assets): mention CDK_DOCKER environment variable in README (#…
c975ebf 
…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*
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
@aws-cdk/aws-ecr-assets Related to AWS CDK Docker Image Assets documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(ecr-assets): mention CDK_DOCKER environment variable in README ymotongpoo/aws-cdk
2 participants
@ymotongpoo @khushail