diff --git a/docs/features/using_colima.md b/docs/features/using_colima.md new file mode 100644 index 0000000000..bac39bdabf --- /dev/null +++ b/docs/features/using_colima.md @@ -0,0 +1,39 @@ +# Using Colima with Docker + +[Colima](https://github.com/abiosoft/colima) is a container runtime which +integrates with Docker's tooling and can be configured in various ways. + +As of Colima v0.4.0 it's recommended to set the active Docker context to use +Colima. After the context is set testcontainers-go will automatically be +configured to use Colima. + +```bash +$ docker context ls +NAME DESCRIPTION DOCKER ENDPOINT KUBERNETES ENDPOINT ORCHESTRATOR +colima colima unix:///Users/foobar/.colima/default/docker.sock +default * Current DOCKER_HOST based configuration unix:///Users/foobar/.colima/docker.sock + +$ docker context use colima +colima +Current context is now "colima" + +$ docker context ls +NAME DESCRIPTION DOCKER ENDPOINT KUBERNETES ENDPOINT ORCHESTRATOR +colima * colima unix:///Users/foobar/.colima/default/docker.sock +default Current DOCKER_HOST based configuration unix:///var/run/docker.sock +``` + +If you're using an older version of Colima or have other applications that are +unaware of Docker context the following workaround is available: + +1. Locate your Docker Socket, see: [Colima's FAQ - Docker Socket Location](https://github.com/abiosoft/colima/blob/main/docs/FAQ.md#docker-socket-location) + +2. Set the `DOCKER_HOST` environment variable to match the located Docker Socket + + * Example: `export DOCKER_HOST="unix://${HOME}/.colima/default/docker.sock"` + +3. As of testcontainers-go v0.14.0 set `TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE` + to `/var/run/docker.sock` as the default value refers to your `DOCKER_HOST` + environment variable. + + * Example: `export TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE="/var/run/docker.sock"` diff --git a/mkdocs.yml b/mkdocs.yml index 0d1a7574ad..dd4ab1c983 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,6 +37,7 @@ nav: - features/override_container_command.md - features/copy_file.md - features/using_podman.md + - features/using_colima.md - Wait Strategies: - Introduction: features/wait/introduction.md - Exec: features/wait/exec.md