From 4df8b2e87a40f7cedf512504ed7ba2b8a88b0c3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20de=20la=20Pe=C3=B1a?= Date: Fri, 20 Sep 2024 12:22:41 +0200 Subject: [PATCH] docs: include versions for each option and method --- docs/modules/redpanda.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/modules/redpanda.md b/docs/modules/redpanda.md index 293d66a01e..028dbaf95f 100644 --- a/docs/modules/redpanda.md +++ b/docs/modules/redpanda.md @@ -61,6 +61,8 @@ If you need to enable TLS use `WithTLS` with a valid PEM encoded certificate and #### Additional Listener +- Since testcontainers-go :material-tag: v0.28.0 + There are scenarios where additional listeners are needed, for example if you want to consume/from another container in the same network @@ -81,25 +83,35 @@ Produce messages using the new registered listener #### Adding Service Accounts +- Since testcontainers-go :material-tag: v0.20.0 + It's possible to add service accounts to the Redpanda container using the `WithNewServiceAccount` option, setting the service account name and its password. E.g. `WithNewServiceAccount("service-account", "password")`. #### Adding Super Users +- Since testcontainers-go :material-tag: v0.20.0 + When a super user is needed, you can use the `WithSuperusers` option, passing a variadic list of super users. E.g. `WithSuperusers("superuser-1", "superuser-2")`. #### Enabling SASL +- Since testcontainers-go :material-tag: v0.20.0 + The `WithEnableSASL()` option enables SASL scram sha authentication. By default, no authentication (plaintext) is used. When setting an authentication method, make sure to add users as well and authorize them using the `WithSuperusers()` option. #### WithEnableKafkaAuthorization +- Since testcontainers-go :material-tag: v0.20.0 + The `WithEnableKafkaAuthorization` enables authorization for connections on the Kafka API. #### WithEnableWasmTransform +- Since testcontainers-go :material-tag: v0.28.0 + The `WithEnableWasmTransform` enables wasm transform. !!!warning @@ -107,19 +119,27 @@ The `WithEnableWasmTransform` enables wasm transform. #### WithEnableSchemaRegistryHTTPBasicAuth +- Since testcontainers-go :material-tag: v0.20.0 + The `WithEnableSchemaRegistryHTTPBasicAuth` enables HTTP basic authentication for the Schema Registry. #### WithAutoCreateTopics +- Since testcontainers-go :material-tag: v0.22.0 + The `WithAutoCreateTopics` option enables the auto-creation of topics. #### WithTLS +- Since testcontainers-go :material-tag: v0.24.0 + The `WithTLS` option enables TLS encryption. It requires a valid PEM encoded certificate and key, passed as byte slices. E.g. `WithTLS([]byte(cert), []byte(key))`. #### WithBootstrapConfig +- Since testcontainers-go :material-tag: v0.33.0 + `WithBootstrapConfig` adds an arbitrary config key-value pair to the Redpanda container. Per the name, this config will be interpolated into the generated bootstrap config file, which is particularly useful for configs requiring a restart when otherwise applied to a running Redpanda instance. E.g. `WithBootstrapConfig("config_key", config_value)`, where `config_value` is of type `any`. @@ -130,6 +150,8 @@ The Redpanda container exposes the following methods: #### KafkaSeedBroker +- Since testcontainers-go :material-tag: v0.20.0 + KafkaSeedBroker returns the seed broker that should be used for connecting to the Kafka API with your Kafka client. It'll be returned in the format: "host:port" - for example: "localhost:55687". @@ -140,6 +162,8 @@ to the Kafka API with your Kafka client. It'll be returned in the format: #### SchemaRegistryAddress +- Since testcontainers-go :material-tag: v0.20.0 + SchemaRegistryAddress returns the address to the schema registry API. This is an HTTP-based API and thus the returned format will be: http://host:port. @@ -150,6 +174,8 @@ is an HTTP-based API and thus the returned format will be: http://host:port. #### AdminAPIAddress +- Since testcontainers-go :material-tag: v0.20.0 + AdminAPIAddress returns the address to the Redpanda Admin API. This is an HTTP-based API and thus the returned format will be: http://host:port.