Skip to content

Normalize disabling ryuk container #4950

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

Closed
Koisell wants to merge 1 commit into from
Closed

Normalize disabling ryuk container #4950

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion core/src/main/java/org/testcontainers/DockerClientFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ public void close() {

final String ryukContainerId;

boolean useRyuk = !Boolean.parseBoolean(System.getenv("TESTCONTAINERS_RYUK_DISABLED"));
boolean useRyuk = TestcontainersConfiguration.getInstance().isRyukEnabled();
if (useRyuk) {
log.debug("Ryuk is enabled");
try {
Expand Down
7 changes: 7 additions & 0 deletions core/src/main/java/org/testcontainers/utility/TestcontainersConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,13 @@ public String getTinyImage() {
return getImage(ALPINE_IMAGE).asCanonicalNameString();
}

public boolean isRyukEnabled() {
// Environment variable TESTCONTAINERS_RYUK_DISABLED is legacy. Having this boolean expression ensure legacy
// systems will not break.
return !Boolean.parseBoolean(System.getenv("TESTCONTAINERS_RYUK_DISABLED")) &&
Boolean.parseBoolean(getEnvVarOrProperty("ryuk.container.enabled", "true"));
}

public boolean isRyukPrivileged() {
return Boolean
.parseBoolean(getEnvVarOrProperty("ryuk.container.privileged", "false"));
Expand Down
7 changes: 3 additions & 4 deletions docs/features/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,9 @@ Some companies disallow the usage of Docker Hub, but you can override `*.image`
> In some environments ryuk must be started in privileged mode to work properly (--privileged flag)

### Disabling Ryuk
Ryuk must be started as a privileged container.
If your environment already implements automatic cleanup of containers after the execution,
but does not allow starting privileged containers, you can turn off the Ryuk container by setting
`TESTCONTAINERS_RYUK_DISABLED` **environment variable** to `true`.
> **ryuk.container.enabled = true**
> If your environment already implements automatic cleanup of containers after the execution,
but does not allow starting privileged containers, you can turn off the Ryuk container by setting it to false.

!!!tip
Note that Testcontainers will continue doing the cleanup at JVM's shutdown, unless you `kill -9` your JVM process.
Expand Down