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.

Sign up for GitHub

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

Jump to bottom

Supported container runtimes tidy up #560

Merged
merged 1 commit into from
May 9, 2023
Merged

Supported container runtimes tidy up #560

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/supported-container-runtimes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Works out of the box.

## Podman

### Usage

MacOS:
```bash
{% raw %}
Expand All @@ -24,16 +26,16 @@ export DOCKER_HOST=unix://${XDG_RUNTIME_DIR}/podman/podman.sock

The resource reaper is a process which runs in the background and cleans up containers and images after they are no longer needed. It is not possible to run the resource reaper on MacOS with Podman due to permission limitations, it fails with "Operation not supported" errors.

Workarounds:

Disable the resource reaper:
One workaround is to disable the resource reaper:

```bash
export TESTCONTAINERS_RYUK_DISABLED=true
```

## Colima

### Usage

```bash
export DOCKER_HOST=unix://${HOME}/.colima/default/docker.sock
export TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock
Expand All @@ -45,7 +47,7 @@ export TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock

When exposing a container port, Docker may provide an IPv4 _and_ an IPv6 binding, where the port may be different. Node versions < 18 default to resolve a hostname to an IPv4 address, while Node 18+ would default to an IPv6 address. Because Colima does not support IPv6, resolving a hostname to an IPv6 address results in connection refused.

Workarounds:
There are 2 workarounds:

1. Disable IPv6 in your environment.
2. Run Node with flags such that it prefers IPv4:
Expand Down Expand Up @@ -75,6 +77,8 @@ const container = await new GenericContainer("redis")

## Rancher Desktop

### Usage

```bash
export DOCKER_HOST=unix://${HOME}/.rd/docker.sock
export TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock
Expand Down