kafkadocker

Documentation

Index

• Variables
• type Cluster
  • func (c *Cluster) BrokerAddresses() []string
  • func (c *Cluster) Start(ctx context.Context) error
  • func (c *Cluster) Stop(ctx context.Context) error

Variables

var (
	// ErrBrokerAlreadyStarted is returned when a broker is started more than once.
	ErrBrokerAlreadyStarted = errors.New("broker already started")
	// ErrBrokerWasNotStarted is returned when a broker is stopped before it is started.
	ErrBrokerWasNotStarted = errors.New("broker was not started")
	// ErrBrokerNotConnected is returned when a broker is not connected.
	ErrBrokerNotConnected = errors.New("broker not connected")
)

Types

type Cluster

type Cluster struct {
	Brokers     int      // For specifying the number of brokers to start.
	Topics      []string // For specifying the topics to create.
	HealthProbe bool     // For specifying whether to health-probe the brokers after creation.
	Kraft       bool     // For specifying whether to use the Kafka Raft protocol.
	// contains filtered or unexported fields
}

Cluster represents a Kafka cluster.

func (*Cluster) BrokerAddresses

func (c *Cluster) BrokerAddresses() []string

BrokerAddresses returns the addresses of the brokers in the cluster.

func (*Cluster) Start

func (c *Cluster) Start(ctx context.Context) error

Start creates the containers and the network for the cluster. nolint: gocognit, gocyclo

func (*Cluster) Stop

func (c *Cluster) Stop(ctx context.Context) error

Stop removes all the containers and the network concerning the cluster. nolint: gocognit, gocyclo