Commit 3266504
authored
docs(ecs): document Podman as a Docker/Finch alternative (#35933)
docs(aws-ecs): Document Podman as a Docker/Finch alternative
- Add Podman configuration examples in aws-ecr-assets README
- Document DOCKER_HOST requirement for both Finch and Podman
- Update CONTRIBUTING.md with Podman setup instructions
- Provide community-tested alternative guidance for Docker licensing concerns
Fixes #35833
### Issue # (if applicable)
Closes #35833.
### Reason for this change
Users are facing Docker licensing issues and seeking alternatives like Podman for CDK container builds. The current documentation only mentions Finch as a Docker alternative but lacks:
1. Podman configuration examples despite it being a popular, lightweight Docker alternative
2. Critical DOCKER_HOST environment variable requirements for both Finch and Podman
3. Clear guidance on community-tested alternatives for users with Docker licensing concerns
This creates a documentation gap that prevents users from successfully using Podman with CDK, even though it works with proper configuration.
### Description of changes
**1. Enhanced aws-ecr-assets README.md:**
- Added new "Docker Alternatives" section with structured examples
- Documented exact Podman configuration: `CDK_DOCKER=podman` and `DOCKER_HOST=$(podman machine inspect...)`
- Added missing DOCKER_HOST configuration for Finch
- Included clear support level distinctions (AWS-supported vs community-tested)
- Added explanatory note about DOCKER_HOST requirement for container daemon communication
**2. Updated CONTRIBUTING.md:**
- Extended Docker replacement documentation to include Podman
- Added DOCKER_HOST requirement explanation for both Finch and Podman
- Provided specific configuration example for Podman setup
**3. Design decisions:**
- Used the exact configuration validated by the issue reporter (@TrevorBurnham)
- Maintained clear distinction between official AWS support (Finch) and community-tested alternatives (Podman)
- Structured documentation to be copy-paste friendly for users
- Positioned content logically after existing CDK_DOCKER explanation
**4. Alternatives considered:**
- Could have only documented Podman without DOCKER_HOST - rejected because it's critical for functionality
- Could have provided minimal examples - rejected in favor of complete, working configurations
- Could have avoided mentioning support levels - rejected because transparency is important
### Describe any new or updated permissions being added
No new or updated IAM permissions are being added. This is purely documentation enhancement.
### Description of how you validated changes
**Documentation validation:**
- [x] Verified configuration examples match the working setup from issue #35833
- [x] Confirmed both CONTRIBUTING.md and aws-ecr-assets README.md are updated consistently
- [x] Ensured documentation follows existing patterns and formatting
- [x] Cross-referenced with existing Finch documentation for consistency
- [x] Validated markdown formatting and code block syntax
**Content validation:**
- [x] Examples use the exact environment variables validated by the community
- [x] Support level messaging aligns with AWS policy (official support for Finch, community-tested for Podman)
- [x] Documentation addresses all points raised in the original issue
### 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*1 parent 13b6480 commit 3266504
File tree
2 files changed
+25
-0
lines changed- packages/aws-cdk-lib/aws-ecr-assets
2 files changed
+25
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
222 | 222 | | |
223 | 223 | | |
224 | 224 | | |
| 225 | + | |
| 226 | + | |
225 | 227 | | |
226 | 228 | | |
227 | 229 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
62 | 85 | | |
63 | 86 | | |
64 | 87 | | |
| |||
0 commit comments