docs: Update potentially misleading dind.md #1173
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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