serviceoption

Documentation

Index

• Variables
• type AddressFamily
• type AddressFamilyPreference
• type Option
  • func WithAddressFamilyPreference(pref AddressFamilyPreference) Option
  • func WithMaxSendBufferSize(size int) Option
  • func WithoutTLSInfo() Option
• type Options

Variables

var (
	AddressPreferIPv4 = AddressFamilyPreference{AddressFamilyIPv4, AddressFamilyIPv6}
	AddressPreferIPv6 = AddressFamilyPreference{AddressFamilyIPv6, AddressFamilyIPv4}
)

var Default = Options{
	MaxSendBufferSize:       65_536,
	AddressFamilyPreference: AddressPreferIPv4,
}

Default serves only as reference point for default values.

Types

type AddressFamily

type AddressFamily uint

const (
	AddressFamilyIPv4 AddressFamily = 4
	AddressFamilyIPv6 AddressFamily = 6
)

type AddressFamilyPreference

type AddressFamilyPreference []AddressFamily

type Option

type Option func(o *Options)

Option customizes the peer service's configuration.

func WithAddressFamilyPreference

func WithAddressFamilyPreference(pref AddressFamilyPreference) Option

WithAddressFamilyPreference configures the order in which IP addresses will be considered when sending notifications for nodes that have both IPv4 and IPv6 available.

func WithMaxSendBufferSize

func WithMaxSendBufferSize(size int) Option

WithMaxSendBufferSize sets the maximum size of the send buffer. When the send buffer is full, for example due to errors in the transport, the server disconnects the corresponding client. The maximum buffer size should be large enough to accommodate the burst of peer change notifications than happens on an initial call where all nodes in the cluster are notified as being added.

func WithoutTLSInfo

func WithoutTLSInfo() Option

WithoutTLSInfo configures the service to send peer change notifications without TLS information. This implies that TLS is disabled for the Hubble gRPC service.

type Options

type Options struct {
	MaxSendBufferSize       int
	WithoutTLSInfo          bool
	AddressFamilyPreference AddressFamilyPreference
}

Options stores all the configuration values for the peer service.