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: Update potentially misleading dind.md #1173

Merged
merged 2 commits into from May 13, 2024

Conversation

valchetski
Copy link
Contributor

What does this PR do?

Update potentially misleading documentation. The updated text was taken from more accurate documentation for Java
https://java.testcontainers.org/supported_docker_environment/continuous_integration/dind_patterns/#docker-wormhole-pattern-sibling-docker-containers
Updated documentation has generic instruction for Docker Desktop and Docker Engine.

Why is it important?

In my case, I've used the example of the Docker Сompose file from current documentation, and it didn't work in our CI pipeline. Later I figured out we use Docker Engine, not Docker Desktop on the build server. Removed TESTCONTAINERS_HOST_OVERRIDE and all tests succeeded.

I think it'll be better to have generic documentation for Docker Engine and Docker Desktop and to emphasize that TESTCONTAINERS_HOST_OVERRIDE is needed only in the case of Docker Desktop (as documentation for Java does).

Related issues

  • N/A

Copy link

netlify bot commented May 10, 2024

Deploy Preview for testcontainers-dotnet ready!

Name Link
🔨 Latest commit 206903c
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-dotnet/deploys/6641f0dfef6c3200088c8e1f
😎 Deploy Preview https://deploy-preview-1173--testcontainers-dotnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@HofmeisterAn HofmeisterAn left a comment

Choose a reason for hiding this comment

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

Hi 👋, thanks for the PR. I am happy to merge it. I just have one question regarding Docker Desktop and the environment variable TESTCONTAINERS_HOST_OVERRIDE. WDYT?

docs/examples/dind.md Outdated Show resolved Hide resolved
docs/examples/dind.md Show resolved Hide resolved
docs/examples/dind.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@HofmeisterAn HofmeisterAn left a comment

Choose a reason for hiding this comment

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

Thanks ✔️.

@HofmeisterAn HofmeisterAn merged commit 1d6cbea into testcontainers:develop May 13, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants