Valkey¶
Since v0.33.0
Introduction¶
The Testcontainers module for Valkey.
Adding this module to your project dependencies¶
Please run the following command to add the Valkey module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/valkey
Usage example¶
ctx := context.Background()
valkeyContainer, err := tcvalkey.Run(ctx,
"valkey/valkey:7.2.5",
tcvalkey.WithSnapshotting(10, 1),
tcvalkey.WithLogLevel(tcvalkey.LogLevelVerbose),
tcvalkey.WithConfigFile(filepath.Join("testdata", "valkey7.conf")),
)
defer func() {
if err := testcontainers.TerminateContainer(valkeyContainer); 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.33.0
Info
The RunContainer(ctx, opts...)
function is deprecated and will be removed in the next major release of Testcontainers for Go.
The Valkey module exposes one entrypoint function to create the Valkey container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*ValkeyContainer, error)
context.Context
, the Go context.string
, the Docker image to use.testcontainers.ContainerCustomizer
, a variadic argument for passing options.
Image¶
Use the second argument in the Run
function to set a valid Docker image.
In example: Run(context.Background(), "valkey/valkey:7.2.5")
.
Container Options¶
When starting the Valkey container, you can pass options in a variadic way to configure it.
Snapshotting¶
- Since v0.33.0
By default Valkey saves snapshots of the dataset on disk, in a binary file called dump.rdb. You can configure Valkey to have it save the dataset every N
seconds if there are at least M
changes in the dataset. E.g. WithSnapshotting(10, 1)
.
Log Level¶
- Since v0.33.0
You can easily set the valkey logging level. E.g. WithLogLevel(LogLevelDebug)
.
Valkey configuration¶
In the case you have a custom config file for Valkey, it's possible to copy that file into the container before it's started. E.g. WithConfigFile(filepath.Join("testdata", "valkey.conf"))
.
WithTLS¶
- Since v0.38.0
In the case you want to enable TLS for the Valkey container, you can use the WithTLS()
option. This options enables TLS on the 6379/tcp
port and uses a secure URL (e.g. rediss://host:port
).
Info
In case you want to use Non-mutual TLS (i.e. client authentication is not required), you can customize the CMD arguments by using the WithCmdArgs
option. E.g. WithCmdArgs("--tls-auth-clients", "no")
.
The module automatically generates three certificates, a CA certificate, a client certificate and a Valkey certificate. Please use the TLSConfig()
container method to get the TLS configuration and use it to configure the Valkey client. See more details in the TLSConfig section.
The following options are exposed by the testcontainers
package.
Basic Options¶
WithExposedPorts
Since v0.37.0WithEnv
Since v0.29.0WithWaitStrategy
Since v0.20.0WithAdditionalWaitStrategy
Since v0.38.0WithWaitStrategyAndDeadline
Since v0.20.0WithAdditionalWaitStrategyAndDeadline
Since v0.38.0WithEntrypoint
Since v0.37.0WithEntrypointArgs
Since v0.37.0WithCmd
Since v0.37.0WithCmdArgs
Since v0.37.0WithLabels
Since v0.37.0
Lifecycle Options¶
WithLifecycleHooks
Since v0.38.0WithAdditionalLifecycleHooks
Since v0.38.0WithStartupCommand
Since v0.25.0WithAfterReadyCommand
Since v0.28.0
Files & Mounts Options¶
WithFiles
Since v0.37.0WithMounts
Since v0.37.0WithTmpfs
Since v0.37.0WithImageMount
Since v0.37.0
Build Options¶
WithDockerfile
Since v0.37.0
Logging Options¶
WithLogConsumers
Since v0.28.0WithLogConsumerConfig
Since v0.38.0WithLogger
Since v0.29.0
Image Options¶
WithAlwaysPull
Since v0.38.0WithImageSubstitutors
Since v0.26.0WithImagePlatform
Since v0.38.0
Networking Options¶
WithNetwork
Since v0.27.0WithNetworkByName
Since v0.38.0WithBridgeNetwork
Since v0.38.0WithNewNetwork
Since v0.27.0
Advanced Options¶
WithHostPortAccess
Since v0.31.0WithConfigModifier
Since v0.20.0WithHostConfigModifier
Since v0.20.0WithEndpointSettingsModifier
Since v0.20.0CustomizeRequest
Since v0.20.0WithName
Since v0.38.0WithNoStart
Since v0.38.0WithProvider
Not available until the next release main
Experimental Options¶
WithReuseByName
Since v0.37.0
Container Methods¶
The Valkey container exposes the following methods:
ConnectionString¶
- Since v0.33.0
This method returns the connection string to connect to the Valkey container, using the default 6379
port.
uri, err := valkeyContainer.ConnectionString(ctx)
TLSConfig¶
- Since v0.38.0
This method returns the TLS configuration for the Valkey container, nil if TLS is not enabled.
options.TLSConfig = valkeyContainer.TLSConfig()
In the above example, the options are used to configure a Valkey client with TLS enabled.