DinD (Docker in Docker)
DinD (Docker in Docker)
Since v0.36.0
Introduction
The Testcontainers module for DinD (Docker in Docker).
Adding this module to your project dependencies
Please run the following command to add the DinD module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/dindUsage example
Creating a DinD container
ctx := context.Background()
dindContainer, err := dind.Run(ctx, "docker:28.0.1-dind")
defer func() {
if err := testcontainers.TerminateContainer(dindContainer); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to start container: %s", err)
return
}Module Reference
Run function
- Since v0.36.0
The DinD module exposes one entrypoint function to create the DinD container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)context.Context, the Go context.string, the Docker image to use.testcontainers.ContainerCustomizer, a variadic argument for passing options.
Image
If you need to set a different DinD Docker image, you can set a valid Docker image as the second argument in the Run function. E.g. Run(context.Background(), "docker:28.0.1-dind").
Container Options
When starting the DinD container, you can pass options in a variadic way to configure it.
The following options are exposed by the testcontainers package.
Basic Options
WithExposedPortsSince v0.37.0WithEnvSince v0.29.0WithWaitStrategySince v0.20.0WithAdditionalWaitStrategySince v0.38.0WithWaitStrategyAndDeadlineSince v0.20.0WithAdditionalWaitStrategyAndDeadlineSince v0.38.0WithEntrypointSince v0.37.0WithEntrypointArgsSince v0.37.0WithCmdSince v0.37.0WithCmdArgsSince v0.37.0WithLabelsSince v0.37.0
Lifecycle Options
WithLifecycleHooksSince v0.38.0WithAdditionalLifecycleHooksSince v0.38.0WithStartupCommandSince v0.25.0WithAfterReadyCommandSince v0.28.0
Files & Mounts Options
WithFilesSince v0.37.0WithMountsSince v0.37.0WithTmpfsSince v0.37.0WithImageMountSince v0.37.0
Build Options
WithDockerfileSince v0.37.0
Logging Options
WithLogConsumersSince v0.28.0WithLogConsumerConfigSince v0.38.0WithLoggerSince v0.29.0
Image Options
WithAlwaysPullSince v0.38.0WithImageSubstitutorsSince v0.26.0WithImagePlatformSince v0.38.0
Networking Options
WithNetworkSince v0.27.0WithNetworkByNameSince v0.38.0WithBridgeNetworkSince v0.38.0WithNewNetworkSince v0.27.0
Advanced Options
WithHostPortAccessSince v0.31.0WithConfigModifierSince v0.20.0 · Chainable since mainWithHostConfigModifierSince v0.20.0 · Chainable since mainWithEndpointSettingsModifierSince v0.20.0 · Chainable since mainCustomizeRequestSince v0.20.0WithNameSince v0.38.0WithNoStartSince v0.38.0WithProviderSince v0.39.0
Experimental Options
WithReuseByNameSince v0.37.0
Container Methods
The DinD container exposes the following methods:
Host
- Since v0.36.0
The Host method returns the DinD URL, to be used for connecting to the Docker API using a Docker client. It'll be returned in the format of string.
HostGet a Docker client
host, err := dindContainer.Host(ctx)
if err != nil {
log.Printf("failed to get docker host: %s", err)
return
}cli, err := client.New(client.WithHost(host))
if err != nil {
log.Printf("failed to create docker client: %s", err)
return
}LoadImage
- Since v0.36.0
The LoadImage method loads an image into the docker in docker daemon.
This is useful for testing images generated locally without having to push them to a public docker registry.
The images must be already present in the node running the test. DockerProvider offers a method for pulling images, which can be used from the test code to ensure the image is present locally before loading them to the daemon.
评论
登录后参与评论
KnowForge