Skip to content

Commit 0cade1a

Browse files
committed
docs: document the temporary file
1 parent da5b366 commit 0cade1a

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

modules/clickhouse/options.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@ func renderZookeeperConfig(settings ZookeeperOptions) ([]byte, error) {
3434
return bootstrapConfig.Bytes(), nil
3535
}
3636

37-
// WithZookeeper pass a config to connect clickhouse with zookeeper and make clickhouse as cluster
37+
// WithZookeeper pass a config to connect clickhouse with zookeeper and make clickhouse as cluster.
38+
// It creates a temporary file in the host filesystem with the config and copies it to the container
39+
// at /etc/clickhouse-server/config.d/zookeeper_config.xml. This file is not cleaned up automatically,
40+
// and it's removed by the OS.
3841
func WithZookeeper(host, port string) testcontainers.CustomizeRequestOption {
3942
return func(req *testcontainers.GenericContainerRequest) error {
4043
f, err := os.CreateTemp("", "clickhouse-tc-config-")

0 commit comments

Comments
 (0)