components

type GenericParser ¶ added in v0.108.0

type GenericParser[T any] struct {
	// contains filtered or unexported fields
}

GenericParser serves as scaffolding for custom parsing logic by isolating functionality to idempotent functions.

func NewGenericParser[T any](name string, port int32, parser PortParser[T], opts ...PortBuilderOption) *GenericParser[T]

func NewSilentSinglePortParser(name string, port int32, opts ...PortBuilderOption) *GenericParser[*SingleEndpointConfig]

func NewSinglePortParser(name string, port int32, opts ...PortBuilderOption) *GenericParser[*SingleEndpointConfig]

func (g *GenericParser[T]) ParserName() string

func (g *GenericParser[T]) ParserType() string

func (g *GenericParser[T]) Ports(logger logr.Logger, name string, config interface{}) ([]corev1.ServicePort, error)

type MultiPortOption ¶

type MultiPortOption func(parser *MultiPortReceiver)

MultiPortOption allows the setting of options for a MultiPortReceiver.

func WithPortMapping(name string, port int32, opts ...PortBuilderOption) MultiPortOption

type MultiPortReceiver ¶

type MultiPortReceiver struct {
	// contains filtered or unexported fields
}

MultiPortReceiver is a special parser for components with endpoints for each protocol.

func NewMultiPortReceiver(name string, opts ...MultiPortOption) *MultiPortReceiver

func (m *MultiPortReceiver) ParserName() string

func (m *MultiPortReceiver) ParserType() string

func (m *MultiPortReceiver) Ports(logger logr.Logger, name string, config interface{}) ([]corev1.ServicePort, error)

type MultiProtocolEndpointConfig ¶

type MultiProtocolEndpointConfig struct {
	Protocols map[string]*SingleEndpointConfig `mapstructure:"protocols"`
}

MultiProtocolEndpointConfig represents the minimal struct for a given YAML configuration input containing a map to a struct with either endpoint or listen_address.

type Option ¶ added in v0.108.0

type Option struct {
	// contains filtered or unexported fields
}

func NewOption(name string, port int32) *Option

func (o *Option) Apply(opts ...PortBuilderOption)

func (o *Option) GetServicePort() *corev1.ServicePort

type Parser ¶ added in v0.108.0

type Parser interface {
	// Ports returns the service ports parsed based on the component's configuration where name is the component's name
	// of the form "name" or "type/name"
	Ports(logger logr.Logger, name string, config interface{}) ([]corev1.ServicePort, error)

	// ParserType returns the type of this parser
	ParserType() string

	// ParserName is an internal name for the parser
	ParserName() string
}

type ParserRetriever ¶ added in v0.104.0

type ParserRetriever func(string) Parser

type PortBuilderOption ¶

type PortBuilderOption func(*Option)

func WithAppProtocol(proto *string) PortBuilderOption

func WithProtocol(proto corev1.Protocol) PortBuilderOption

func WithTargetPort(targetPort int32) PortBuilderOption

type PortParser ¶ added in v0.108.0

type PortParser[T any] func(logger logr.Logger, name string, o *Option, config T) ([]corev1.ServicePort, error)

PortParser is a function that returns a list of servicePorts given a config of type T.

type PortRetriever ¶

type PortRetriever interface {
	GetPortNum() (int32, error)
	GetPortNumOrDefault(logr.Logger, int32) int32
}

type SingleEndpointConfig ¶

type SingleEndpointConfig struct {
	Endpoint      string `mapstructure:"endpoint,omitempty"`
	ListenAddress string `mapstructure:"listen_address,omitempty"`
}

SingleEndpointConfig represents the minimal struct for a given YAML configuration input containing either endpoint or listen_address.

func (g *SingleEndpointConfig) GetPortNum() (int32, error)

func (g *SingleEndpointConfig) GetPortNumOrDefault(logger logr.Logger, p int32) int32