redpanda

func NewAdminAPIClient ¶

func NewAdminAPIClient(baseURL string) *AdminAPIClient

NewAdminAPIClient creates a new AdminAPIClient.

func Run ¶ added in v0.32.0

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)

Run creates an instance of the Redpanda container type

// runRedpandaContainer {
ctx := context.Background()

redpandaContainer, err := redpanda.Run(ctx,
	"docker.redpanda.com/redpandadata/redpanda:v23.3.3",
	redpanda.WithEnableSASL(),
	redpanda.WithEnableKafkaAuthorization(),
	redpanda.WithEnableWasmTransform(),
	redpanda.WithBootstrapConfig("data_transforms_per_core_memory_reservation", 33554432),
	redpanda.WithBootstrapConfig("data_transforms_per_function_memory_limit", 16777216),
	redpanda.WithNewServiceAccount("superuser-1", "test"),
	redpanda.WithNewServiceAccount("superuser-2", "test"),
	redpanda.WithNewServiceAccount("no-superuser", "test"),
	redpanda.WithSuperusers("superuser-1", "superuser-2"),
	redpanda.WithEnableSchemaRegistryHTTPBasicAuth(),
)
defer func() {
	if err := testcontainers.TerminateContainer(redpandaContainer); err != nil {
		log.Printf("failed to terminate container: %s", err)
	}
}()
if err != nil {
	log.Printf("failed to start container: %s", err)
	return
}
// }

state, err := redpandaContainer.State(ctx)
if err != nil {
	log.Printf("failed to get container state: %s", err)
	return
}

fmt.Println(state.Running)

Output:

true

func WithAdminAPIAuthentication ¶ added in v0.36.0

func WithAdminAPIAuthentication() Option

WithAdminAPIAuthentication enables Admin API Authentication. It sets `admin_api_require_auth` configuration to true and configures a bootstrap user account. See https://docs.redpanda.com/current/deploy/deployment-option/self-hosted/manual/production/production-deployment/#bootstrap-a-user-account

func WithAutoCreateTopics ¶ added in v0.22.0

func WithAutoCreateTopics() Option

WithAutoCreateTopics enables topic auto creation.

func WithBootstrapConfig ¶ added in v0.33.0

func WithBootstrapConfig(cfg string, val any) Option

WithBootstrapConfig adds an arbitrary config kvp 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.

func WithEnableKafkaAuthorization ¶

func WithEnableKafkaAuthorization() Option

WithEnableKafkaAuthorization enables authorization for connections on the Kafka API.

func WithEnableSASL ¶

func WithEnableSASL() Option

WithEnableSASL enables SASL scram sha 256 authentication. By default, no authentication (plaintext) is used. When setting an authentication method, make sure to add users as well as authorize them using the WithSuperusers() option.

func WithEnableSchemaRegistryHTTPBasicAuth ¶

func WithEnableSchemaRegistryHTTPBasicAuth() Option

WithEnableSchemaRegistryHTTPBasicAuth enables HTTP basic authentication for Schema Registry.

func WithEnableWasmTransform ¶ added in v0.28.0

func WithEnableWasmTransform() Option

WithEnableWasmTransform enables wasm transform. Should not be used with RP versions before 23.3

func WithHTTPProxyAuthMethod ¶ added in v0.39.0

func WithHTTPProxyAuthMethod(method HTTPProxyAuthMethod) Option

WithHTTPProxyAuthMethod sets the authentication method for HTTP Proxy. If an invalid method is provided, it defaults to "none".

func WithListener ¶ added in v0.28.0

func WithListener(lis string) Option

WithListener adds a custom listener to the Redpanda containers. Listener will be aliases to all networks, so they can be accessed from within docker networks. At least one network must be attached to the container, if not an error will be thrown when starting the container.

func WithNewServiceAccount ¶

func WithNewServiceAccount(username, password string) Option

WithNewServiceAccount includes a new user with username (key) and password (value) that shall be created, so that you can use these to authenticate against Redpanda (either for the Kafka API or Schema Registry HTTP access).

func WithSuperusers ¶

func WithSuperusers(superusers ...string) Option

WithSuperusers defines the superusers added to the redpanda config. By default, there are no superusers.

func WithTLS ¶ added in v0.24.0

func WithTLS(cert, key []byte) Option