config

Documentation

Overview

Package config contains the operator's runtime configuration.

Index

• type Config
  • func New(opts ...Option) Config
  • func (c *Config) AutoDetect() error
  • func (c *Config) AutoscalingVersion() autodetect.AutoscalingVersion
  • func (c *Config) LabelsFilter() []string
  • func (c *Config) OpenShiftRoutes() autodetect.OpenShiftRoutesAvailability
  • func (c *Config) RegisterOpenShiftRoutesChangeCallback(f func() error)
  • func (c *Config) StartAutoDetect() error
• type Option
  • func WithAutoDetect(a autodetect.AutoDetect) Option
  • func WithAutoDetectFrequency(t time.Duration) Option
  • func WithLabelFilters(labelFilters []string) Option
  • func WithLogger(logger logr.Logger) Option
  • func WithOnOpenShiftRoutesChangeCallback(f func() error) Option
  • func WithPlatform(ora autodetect.OpenShiftRoutesAvailability) Option
  • func WithVersion(v version.Version) Option

Types

type Config

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

Config holds the static configuration for this operator.

func New

func New(opts ...Option) Config

New constructs a new configuration based on the given options.

func (*Config) AutoDetect

func (c *Config) AutoDetect() error

AutoDetect attempts to automatically detect relevant information for this operator.

func (*Config) AutoscalingVersion

func (c *Config) AutoscalingVersion() autodetect.AutoscalingVersion

AutoscalingVersion represents the preferred version of autoscaling.

func (*Config) LabelsFilter

func (c *Config) LabelsFilter() []string

LabelsFilter Returns the filters converted to regex strings used to filter out unwanted labels from propagations.

func (*Config) OpenShiftRoutes

func (c *Config) OpenShiftRoutes() autodetect.OpenShiftRoutesAvailability

OpenShiftRoutes represents the availability of the OpenShift Routes API.

func (*Config) RegisterOpenShiftRoutesChangeCallback

func (c *Config) RegisterOpenShiftRoutesChangeCallback(f func() error)

RegisterOpenShiftRoutesChangeCallback registers the given function as a callback that is called when the OpenShift Routes detection detects a change.

func (*Config) StartAutoDetect

func (c *Config) StartAutoDetect() error

StartAutoDetect attempts to automatically detect relevant information for this operator. This will block until the first run is executed and will schedule periodic updates.

type Option

type Option func(c *options)

Option represents one specific configuration option.

func WithAutoDetect

func WithAutoDetect(a autodetect.AutoDetect) Option

func WithAutoDetectFrequency

func WithAutoDetectFrequency(t time.Duration) Option

func WithLabelFilters

func WithLabelFilters(labelFilters []string) Option

func WithLogger

func WithLogger(logger logr.Logger) Option

func WithOnOpenShiftRoutesChangeCallback

func WithOnOpenShiftRoutesChangeCallback(f func() error) Option

func WithPlatform

func WithPlatform(ora autodetect.OpenShiftRoutesAvailability) Option

func WithVersion

func WithVersion(v version.Version) Option