From 248f86d95f0b311ccfc240daa5b50d92c324f03a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20de=20la=20Pe=C3=B1a?= Date: Tue, 2 Jul 2024 18:30:49 +0200 Subject: [PATCH] docs: document ryuk timeouts for compose --- docs/features/configuration.md | 5 +++++ docs/features/docker_compose.md | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/docs/features/configuration.md b/docs/features/configuration.md index 0f29bbc36c..aa5a0d0a61 100644 --- a/docs/features/configuration.md +++ b/docs/features/configuration.md @@ -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. diff --git a/docs/features/docker_compose.md b/docs/features/docker_compose.md index 974d09c946..2dfa9f22ca 100644 --- a/docs/features/docker_compose.md +++ b/docs/features/docker_compose.md @@ -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