Skip to content

Conversation

@sAchin-680
Copy link

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:

  • Verified configuration examples match the working setup from issue (aws-ecs): Document Podman as a Docker/Finch alternative #35833
  • Confirmed both CONTRIBUTING.md and aws-ecr-assets README.md are updated consistently
  • Ensured documentation follows existing patterns and formatting
  • Cross-referenced with existing Finch documentation for consistency
  • Validated markdown formatting and code block syntax

Content validation:

  • Examples use the exact environment variables validated by the community
  • Support level messaging aligns with AWS policy (official support for Finch, community-tested for Podman)
  • Documentation addresses all points raised in the original issue

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added effort/small Small work item – less than a day of effort p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Nov 3, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team November 3, 2025 15:24
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(This review is outdated)

@sAchin-680 sAchin-680 changed the title docs(aws-ecs): Document Podman as a Docker/Finch alternative Docs(aws-ecs): Document Podman as a Docker/Finch alternative Nov 12, 2025
@sAchin-680
Copy link
Author

Hi @pahud, @aws/aws-cdk-maintainers, and code owners

When you have a moment, could you please review this PR?

This update enhances the ECS documentation by adding Podman as a community-tested alternative to Docker/Finch, addressing configuration and setup gaps reported by users. It’s a documentation-only change aimed at improving developer experience when using CDK container builds without Docker licensing constraints.

Your feedback and review would be greatly appreciated.

@sAchin-680 sAchin-680 changed the title Docs(aws-ecs): Document Podman as a Docker/Finch alternative docs(ecs): document Podman as a Docker/Finch alternative Nov 12, 2025
- 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 aws#35833
@sAchin-680 sAchin-680 force-pushed the docs/podman-docker-alternative branch from 07662b9 to 111249c Compare November 12, 2025 12:52
@aws-cdk-automation aws-cdk-automation dismissed their stale review November 12, 2025 12:53

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Nov 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/small Small work item – less than a day of effort p2 pr/needs-maintainer-review This PR needs a review from a Core Team Member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(aws-ecs): Document Podman as a Docker/Finch alternative

3 participants