components

Nov 8, 2024

Changes in this version

type Builder

+ func (b Builder[ComponentConfigType]) WithEnvVarGen(envVarGen EnvVarGenerator[ComponentConfigType]) Builder[ComponentConfigType]

+ type EnvVarGenerator func(logger logr.Logger, config ComponentConfigType) ([]corev1.EnvVar, error)

type GenericParser

+ func (g *GenericParser[T]) GetEnvironmentVariables(logger logr.Logger, config interface{}) ([]corev1.EnvVar, error)

type MultiPortReceiver

+ func (m *MultiPortReceiver) GetEnvironmentVariables(logger logr.Logger, config interface{}) ([]corev1.EnvVar, error)

type Parser

+ GetEnvironmentVariables func(logger logr.Logger, config interface{}) ([]corev1.EnvVar, error)

Oct 9, 2024

Changes in this version

+ func AddressDefaulter(logger logr.Logger, defaultRecAddr string, port int32, ...) (map[string]interface{}, error)

type Builder

+ func (b Builder[ComponentConfigType]) WithDefaultRecAddress(defaultRecAddr string) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithDefaultsApplier(defaultsApplier Defaulter[ComponentConfigType]) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithLivenessGen(livenessGen ProbeGenerator[ComponentConfigType]) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithReadinessGen(readinessGen ProbeGenerator[ComponentConfigType]) Builder[ComponentConfigType]

+ type Defaulter func(logger logr.Logger, defaultAddr string, defaultPort int32, ...) (map[string]interface{}, error)

type GenericParser

+ func (g *GenericParser[T]) GetDefaultConfig(logger logr.Logger, config interface{}) (interface{}, error)

+ func (g *GenericParser[T]) GetLivenessProbe(logger logr.Logger, config interface{}) (*corev1.Probe, error)

+ func (g *GenericParser[T]) GetReadinessProbe(logger logr.Logger, config interface{}) (*corev1.Probe, error)

type MultiPortReceiver

+ func (m *MultiPortReceiver) GetDefaultConfig(logger logr.Logger, config interface{}) (interface{}, error)

+ func (m *MultiPortReceiver) GetLivenessProbe(logger logr.Logger, config interface{}) (*corev1.Probe, error)

+ func (m *MultiPortReceiver) GetReadinessProbe(logger logr.Logger, config interface{}) (*corev1.Probe, error)

type Parser

+ GetDefaultConfig func(logger logr.Logger, config interface{}) (interface{}, error)

+ GetLivenessProbe func(logger logr.Logger, config interface{}) (*corev1.Probe, error)

+ GetReadinessProbe func(logger logr.Logger, config interface{}) (*corev1.Probe, error)

+ type ProbeGenerator func(logger logr.Logger, config ComponentConfigType) (*corev1.Probe, error)

Sep 20, 2024

Changes in this version

+ type Builder []ParserOption[ComponentConfigType]

+ func NewBuilder[ComponentConfigType any]() Builder[ComponentConfigType]

+ func NewProtocolBuilder(name string, port int32) Builder[*MultiProtocolEndpointConfig]

+ func NewSilentSinglePortParserBuilder(name string, port int32) Builder[*SingleEndpointConfig]

+ func NewSinglePortParserBuilder(name string, port int32) Builder[*SingleEndpointConfig]

+ func (b Builder[ComponentConfigType]) Build() (*GenericParser[ComponentConfigType], error)

+ func (b Builder[ComponentConfigType]) MustBuild() *GenericParser[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithAppProtocol(appProtocol *string) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithName(name string) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithNodePort(nodePort int32) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithPort(port int32) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithPortParser(portParser PortParser[ComponentConfigType]) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithProtocol(protocol corev1.Protocol) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithRbacGen(rbacGen RBACRuleGenerator[ComponentConfigType]) Builder[ComponentConfigType]

+ func (b Builder[ComponentConfigType]) WithTargetPort(targetPort int32) Builder[ComponentConfigType]

type GenericParser

+ func (g *GenericParser[T]) GetRBACRules(logger logr.Logger, config interface{}) ([]rbacv1.PolicyRule, error)

+ type MultiPortBuilder []Builder[ComponentConfigType]

+ func NewMultiPortReceiverBuilder(name string) MultiPortBuilder[*MultiProtocolEndpointConfig]

+ func (mp MultiPortBuilder[ComponentConfigType]) AddPortMapping(builder Builder[ComponentConfigType]) MultiPortBuilder[ComponentConfigType]

+ func (mp MultiPortBuilder[ComponentConfigType]) Build() (*MultiPortReceiver, error)

+ func (mp MultiPortBuilder[ComponentConfigType]) MustBuild() *MultiPortReceiver

type MultiPortReceiver

+ func (m *MultiPortReceiver) GetRBACRules(logr.Logger, interface{}) ([]rbacv1.PolicyRule, error)

type Parser

+ GetRBACRules func(logger logr.Logger, config interface{}) ([]rbacv1.PolicyRule, error)

+ type ParserOption func(*Settings[ComponentConfigType])

+ type RBACRuleGenerator func(logger logr.Logger, config ComponentConfigType) ([]rbacv1.PolicyRule, error)

+ type Settings struct

+ func NewEmptySettings[ComponentConfigType any]() *Settings[ComponentConfigType]

+ func (o *Settings[ComponentConfigType]) Apply(opts ...ParserOption[ComponentConfigType])

+ func (o *Settings[ComponentConfigType]) GetServicePort() *corev1.ServicePort

Sep 5, 2024

Changes in this version

+ func ParseSingleEndpoint(logger logr.Logger, name string, o *Option, ...) ([]corev1.ServicePort, error)

+ func ParseSingleEndpointSilent(logger logr.Logger, name string, o *Option, ...) ([]corev1.ServicePort, error)

+ type GenericParser struct

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

+ 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 Option struct

+ func NewOption(name string, port int32) *Option

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

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

+ type Parser interface

+ ParserName func() string

+ ParserType func() string

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

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

Jul 18, 2024

Changes in this version

+ func GetPortsForConfig(logger logr.Logger, config map[string]interface{}, retriever ParserRetriever) ([]corev1.ServicePort, error)

+ type NopParser struct

+ func NewNopParser(name string, port int32, opts ...PortBuilderOption) *NopParser

+ func (n *NopParser) ParserName() string

+ func (n *NopParser) ParserType() string

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

+ type ParserRetriever func(string) ComponentPortParser

type SingleEndpointParser

+ func NewSilentSinglePortParser(name string, port int32, opts ...PortBuilderOption) *SingleEndpointParser

Jun 6, 2024

Changes in this version

+ var GrpcProtocol = "grpc"

+ var HttpProtocol = "http"

+ var PortNotFoundErr = errors.New("port should not be empty")

+ var UnsetPort int32 = 0

+ func ComponentType(name string) string

+ func ConstructServicePort(current *corev1.ServicePort, port int32) corev1.ServicePort

+ func PortFromEndpoint(endpoint string) (int32, error)

+ type ComponentPortParser interface

+ ParserName func() string

+ ParserType func() string

+ Ports func(logger logr.Logger, config interface{}) ([]corev1.ServicePort, error)

+ type MultiPortOption func(parser *MultiPortReceiver)

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

+ type MultiPortReceiver struct

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

+ func (m *MultiPortReceiver) ParserName() string

+ func (m *MultiPortReceiver) ParserType() string

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

+ type MultiProtocolEndpointConfig struct

+ Protocols map[string]*SingleEndpointConfig

+ type PortBuilderOption func(*corev1.ServicePort)

+ func WithAppProtocol(proto *string) PortBuilderOption

+ func WithProtocol(proto corev1.Protocol) PortBuilderOption

+ func WithTargetPort(targetPort int32) PortBuilderOption

+ type PortRetriever interface

+ GetPortNum func() (int32, error)

+ GetPortNumOrDefault func(logr.Logger, int32) int32

+ type SingleEndpointConfig struct

+ Endpoint string

+ ListenAddress string

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

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

+ type SingleEndpointParser struct

+ func NewSinglePortParser(name string, port int32, opts ...PortBuilderOption) *SingleEndpointParser

+ func (s *SingleEndpointParser) ParserName() string

+ func (s *SingleEndpointParser) ParserType() string

+ func (s *SingleEndpointParser) Ports(logger logr.Logger, config interface{}) ([]corev1.ServicePort, error)