Skip to content

Commit

Permalink
docs: document ryuk timeouts for compose
Browse files Browse the repository at this point in the history
  • Loading branch information
mdelapenya committed Jul 2, 2024
1 parent bbcd7cd commit 248f86d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/features/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ but does not allow starting privileged containers, you can turn off the Ryuk con
!!!info
For more information about Ryuk, see [Garbage Collector](garbage_collector.md).

!!!warn
If using Ryuk and the Compose module, please increase the `ryuk.connection.timeout` to at least 5 minutes.
This is because the Compose module may take longer to start all the services. Besides, the `ryuk.reconnection.timeout`
should be increased to at least 30 seconds. For further information, please check [https://github.com/testcontainers/testcontainers-go/pull/2485](https://github.com/testcontainers/testcontainers-go/pull/2485).

## Docker host detection

_Testcontainers for Go_ will attempt to detect the Docker environment and configure everything to work automatically.
Expand Down
4 changes: 4 additions & 0 deletions docs/features/docker_compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ Because `compose` v2 is implemented in Go it's possible for _Testcontainers for
use [`github.com/docker/compose`](https://github.com/docker/compose) directly and skip any process execution/_docker-compose-in-a-container_ scenario.
The `ComposeStack` API exposes this variant of using `docker compose` in an easy way.

Before using the Compose module, there is some configuration that needs to be applied first.
It customizes the behaviour of the `Ryuk` container, which is used to clean up the resources created by the `docker compose` stack.
Please refer to [the Ryuk configuration](../configuration/#customizing-ryuk-the-resource-reaper) for more information.

### Usage

Use the convenience `NewDockerCompose(...)` constructor which creates a random identifier and takes a variable number
Expand Down

0 comments on commit 248f86d

Please sign in to comment.