Skip to content

Commit 57ca6ad

Browse files
authored
Update Docker requirements page to be more container runtime agnostic (#7655)
1 parent 3b2676a commit 57ca6ad

File tree

1 file changed

+15
-18
lines changed
  • docs/supported_docker_environment

1 file changed

+15
-18
lines changed

docs/supported_docker_environment/index.md

+15-18
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,25 @@
1-
# General Docker requirements
1+
# General Container runtime requirements
22

33
## Overview
44

5-
Testcontainers requires a Docker-API compatible container runtime.
6-
During development, Testcontainers is actively tested against recent versions of Docker on Linux, as well as against Docker Desktop on Mac and Windows.
5+
To run Testcontainers-based tests,
6+
you need a Docker-API compatible container runtime,
7+
such as using [Testcontainers Cloud](https://www.testcontainers.cloud/) or installing Docker locally.
8+
During development, Testcontainers is actively tested against recent versions of Docker on Linux,
9+
as well as against Docker Desktop on Mac and Windows.
710
These Docker environments are automatically detected and used by Testcontainers without any additional configuration being necessary.
811

9-
It is possible to configure Testcontainers to work for other Docker setups, such as a remote Docker host or Docker alternatives.
10-
However, these are not actively tested in the main development workflow, so not all Testcontainers features might be available and additional manual configuration might be necessary.
11-
If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests,
12+
It is possible to configure Testcontainers to work with alternative container runtimes.
13+
Making use of the free [Testcontainers Desktop](https://testcontainers.com/desktop/) app will take care of most of the manual configuration.
14+
When using those alternatives without Testcontainers Desktop,
15+
sometimes some manual configuration might be necessary
16+
(see further down for specific runtimes, or [Customizing Docker host detection](/features/configuration/#customizing-docker-host-detection) for general configuration mechanisms).
17+
Alternative container runtimes are not actively tested in the main development workflow,
18+
so not all Testcontainers features might be available.
19+
If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests,
1220
please contact the Testcontainers team and other users from the Testcontainers community on [Slack](https://slack.testcontainers.org/).
1321

14-
| Host Operating System / Environment | Minimum recommended docker versions | Known issues / tips |
15-
|-------------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
16-
| Linux - general | Docker v17.09 | After docker installation, follow [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/). |
17-
| Linux - CircleCI (LXC driver) | Docker v17.09 | The `exec` feature is not compatible with CircleCI. See CircleCI configuration [example](./continuous_integration/circle_ci.md) |
18-
| Linux - within a Docker container | Docker v17.09 | See [Running inside Docker](continuous_integration/dind_patterns.md) for Docker-in-Docker and Docker wormhole patterns |
19-
| Mac OS X - Docker Toolbox | Docker Machine v0.8.0 | |
20-
| Mac OS X - Docker for Mac | v17.09 | Starting 4.13, run `sudo ln -s $HOME/.docker/run/docker.sock /var/run/docker.sock`<br>Support is best-efforts at present<br>`getTestHostIpAddress()` is [not currently supported](https://github.com/testcontainers/testcontainers-java/issues/166) due to limitations in Docker for Mac. |
21-
| Windows - Docker Toolbox | | *Support is limited at present and this is not currently tested on a regular basis*. |
22-
| Windows - Docker for Windows | | *Support is best-efforts at present.* Only Linux Containers (LCOW) are supported at the moment. See [Windows Support](windows.md) |
23-
| Windows - Windows Subsystem for Linux (WSL) | Docker v17.09 | *Support is best-efforts at present.* Only Linux Containers (LCOW) are supported at the moment. See [Windows Support](windows.md). |
24-
25-
## Using Colima?
22+
## Colima
2623

2724
In order to run testcontainers against [colima](https://github.com/abiosoft/colima) the env vars bellow should be set
2825

0 commit comments

Comments
 (0)