kafka

Documentation

Overview

* This is local copy of testcontainers/testcontainers/go/modules/kafka/kafka.go with modified startup script for * the purpose of fully working demonstration. See https://github.com/testcontainers/testcontainers-go/issues/2630

Index

• func WithClusterID(clusterID string) testcontainers.CustomizeRequestOption
• type KafkaContainer
  • func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*KafkaContainer, error)
  • func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*KafkaContainer, error)
  • func (kc *KafkaContainer) Brokers(ctx context.Context) ([]string, error)
• type Option
  • func WithListener(listener string) Option

Functions

func WithClusterID

func WithClusterID(clusterID string) testcontainers.CustomizeRequestOption

Types

type KafkaContainer

type KafkaContainer struct {
	testcontainers.Container
	ClusterID string
	Listeners []string
}

KafkaContainer represents the Kafka container type used in the module

func Run

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

Run creates an instance of the Kafka container type

func RunContainer

func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*KafkaContainer, error)

Deprecated: use Run instead RunContainer creates an instance of the Kafka container type

func (*KafkaContainer) Brokers

func (kc *KafkaContainer) Brokers(ctx context.Context) ([]string, error)

Brokers retrieves the broker connection strings from Kafka with only one entry, defined by the exposed public port.

type Option

type Option func(*KafkaContainer) error

Option represents an option to pass to the KafkaContainer.

func WithListener

func WithListener(listener string) Option

WithListener allows declaring addition listener