config

Documentation

Overview

Package config contains the operator's runtime configuration.

Index

• func ApplyCLI(cfg *Config) error
• func ApplyConfigFile(file string, c *Config) error
• func ApplyEnvVars(cfg *Config)
• func CreateCLIParser(cfg Config) *pflag.FlagSet
• type Config
  • func New() Config
  • func (c *Config) Apply(configFile string) error
  • func (c Config) String() string
  • func (c Config) ToStringMap() map[string]string
• type Internal
• type TLSConfig
  • func (tlsOpt TLSConfig) ApplyTLSConfig(cfg *tls.Config) error
• type ZapConfig

Functions

func ApplyCLI

func ApplyCLI(cfg *Config) error

func ApplyConfigFile

func ApplyConfigFile(file string, c *Config) error

ApplyConfigFile applies the yaml file contents to the configuration.

func ApplyEnvVars

func ApplyEnvVars(cfg *Config)

func CreateCLIParser

func CreateCLIParser(cfg Config) *pflag.FlagSet

Types

type Config

type Config struct {
	// TargetAllocatorImage represents the flag to override the OpenTelemetry TargetAllocator container image.
	TargetAllocatorImage string `yaml:"targetallocator-image"`
	// OperatorOpAMPBridgeImage represents the flag to override the OpAMPBridge container image.
	OperatorOpAMPBridgeImage string `yaml:"operatoropampbridge-image"`
	// AutoInstrumentationPythonImage is the OpenTelemetry Python auto-instrumentation container image.
	AutoInstrumentationPythonImage string `yaml:"auto-instrumentation-python-image"`
	// CollectorImage represents the flag to override the OpenTelemetry Collector container image.
	CollectorImage string `yaml:"collector-image"`
	// CollectorConfigMapEntry represents the configuration file name for the collector. Immutable.
	CollectorConfigMapEntry string `yaml:"collector-configmap-entry"`
	// CreateRBACPermissions is true when the operator can create RBAC permissions for SAs running a collector instance. Immutable.
	CreateRBACPermissions autoRBAC.Availability `yaml:"create-rbac-permissions"`
	// EnableMultiInstrumentation is true when the operator supports multi instrumentation.
	EnableMultiInstrumentation bool `yaml:"enable-multi-instrumentation"`
	// EnableApacheHttpdAutoInstrumentation is true when the operator supports ApacheHttpd auto instrumentation.
	EnableApacheHttpdInstrumentation bool `yaml:"enable-apache-httpd-instrumentation"`
	// EnableDotNetAutoInstrumentation is true when the operator supports dotnet auto instrumentation.
	EnableDotNetAutoInstrumentation bool `yaml:"enable-dot-net-auto-instrumentation"`
	// EnableGoAutoInstrumentation is true when the operator supports Go auto instrumentation.
	EnableGoAutoInstrumentation bool `yaml:"enable-go-auto-instrumentation"`
	// EnableNginxAutoInstrumentation is true when the operator supports nginx auto instrumentation.
	EnableNginxAutoInstrumentation bool `yaml:"enable-nginx-auto-instrumentation"`
	// EnablePythonAutoInstrumentation is true when the operator supports dotnet auto instrumentation.
	EnablePythonAutoInstrumentation bool `yaml:"enable-python-auto-instrumentation"`
	// EnableNodeJSAutoInstrumentation is true when the operator supports dotnet auto instrumentation.
	EnableNodeJSAutoInstrumentation bool `yaml:"enable-node-js-auto-instrumentation"`
	// EnableJavaAutoInstrumentation is true when the operator supports java auto instrumentation.
	EnableJavaAutoInstrumentation bool `yaml:"enable-java-auto-instrumentation"`
	// AutoInstrumentationDotNetImage is the OpenTelemetry DotNet auto-instrumentation container image.
	AutoInstrumentationDotNetImage string `yaml:"auto-instrumentation-dot-net-image"`
	// AutoInstrumentationGoImage is the OpenTelemetry Go auto-instrumentation container image.
	AutoInstrumentationGoImage string `yaml:"auto-instrumentation-go-image"`
	// AutoInstrumentationApacheHttpdImage is the OpenTelemetry ApacheHttpd auto-instrumentation container image.
	AutoInstrumentationApacheHttpdImage string `yaml:"auto-instrumentation-apache-httpd-image"`
	// AutoInstrumentationNginxImage is the OpenTelemetry Nginx auto-instrumentation container image.
	AutoInstrumentationNginxImage string `yaml:"auto-instrumentation-nginx-image"`
	// TargetAllocatorConfigMapEntry represents the configuration file name for the TargetAllocator. Immutable.
	TargetAllocatorConfigMapEntry string `yaml:"target-allocator-configmap-entry"`
	// OperatorOpAMPBridgeImageConfigMapEntry represents the configuration file name for the OpAMPBridge. Immutable.
	OperatorOpAMPBridgeConfigMapEntry string `yaml:"operator-op-amp-bridge-configmap-entry"`
	// AutoInstrumentationNodeJSImage is the OpenTelemetry NodeJS auto-instrumentation container image.
	AutoInstrumentationNodeJSImage string `yaml:"auto-instrumentation-node-js-image"`
	// AutoInstrumentationJavaImage returns OpenTelemetry Java auto-instrumentation container image.
	AutoInstrumentationJavaImage string `yaml:"auto-instrumentation-java-image"`
	// OpenshiftCreateDashboard creates an OpenShift dashboard for monitoring the OpenTelemetryCollector instances
	OpenshiftCreateDashboard bool `yaml:"openshift-create-dashboard"`
	// OpenShiftRoutesAvailability represents the availability of the OpenShift Routes API.
	OpenShiftRoutesAvailability openshift.RoutesAvailability `yaml:"open-shift-routes-availability"`
	// PrometheusCRAvailability represents the availability of the Prometheus Operator CRDs.
	PrometheusCRAvailability prometheus.Availability `yaml:"prometheus-cr-availability"`
	// CertManagerAvailability represents the availability of the Cert-Manager.
	CertManagerAvailability certmanager.Availability `yaml:"cert-manager-availability"`
	// TargetAllocatorAvailability represents the availability of the TargetAllocator CRD.
	TargetAllocatorAvailability targetallocator.Availability `yaml:"target-allocator-availability"`
	// CollectorAvailability represents the availability of the OpenTelemetryCollector CRD.
	CollectorAvailability collector.Availability `yaml:"collector-availability"`
	// OpAmpBridgeAvailability represents the availability of the OpAmpBridge CRD.
	OpAmpBridgeAvailability opampbridge.Availability `yaml:"opampbridge-availability"`
	// IgnoreMissingCollectorCRDs is true if the operator can ignore missing OpenTelemetryCollector CRDs.
	IgnoreMissingCollectorCRDs bool `yaml:"ignore-missing-collector-crds"`
	// LabelsFilter Returns the filters converted to regex strings used to filter out unwanted labels from propagations.
	LabelsFilter []string `yaml:"labels-filter"`
	// AnnotationsFilter Returns the filters converted to regex strings used to filter out unwanted labels from propagations.
	AnnotationsFilter []string `yaml:"annotations-filter"`
	// MetricsAddr is the address the metric endpoint binds to.
	MetricsAddr string `yaml:"metrics-addr"`
	// ProbeAddr is the address the probe endpoint binds to.
	ProbeAddr string `yaml:"health-probe-addr"`
	// PprofAddr is the address to expose the pprof server. Default is empty string which disables the pprof server.
	PprofAddr string `yaml:"pprof-addr"`
	// EnableLeaderElection enables leader election for controller manager
	EnableLeaderElection bool `yaml:"enable-leader-election"`
	// EnableCRMetrics controls whether exposing the CR metrics is enabled
	EnableCRMetrics bool `yaml:"enable-cr-metrics"`
	// CreateServiceMonitorOperatorMetrics creates a ServiceMonitor for the operator metrics
	CreateServiceMonitorOperatorMetrics bool `yaml:"create-service-monitor-operator-metrics"`
	// WebhookPort is the port the webhook endpoint binds to.
	WebhookPort int `yaml:"webhook-port"`
	// FipsDisabledComponents are disabled collector components when operator runs on FIPS enabled platform
	FipsDisabledComponents string `yaml:"fips-disabled-components"`
	// TLS holds the TLS configuration of the controllers.
	TLS TLSConfig `yaml:"tls"`
	// ZapConfig holds the advanced Zap logging config
	Zap ZapConfig `yaml:"zap"`
	// EnableWebhooks enables the webhooks used by controllers.
	EnableWebhooks bool `yaml:"enable-webhooks"`
	// Internal contains configuration that is propagated and cannot be accessed from the operator configuration.
	Internal Internal `yaml:"-"`
}

Config holds the static configuration for this operator.

func New

func New() Config

New constructs a new configuration.

func (*Config) Apply

func (c *Config) Apply(configFile string) error

func (Config) String

func (c Config) String() string

func (Config) ToStringMap

func (c Config) ToStringMap() map[string]string

type Internal

type Internal struct {
	// NativeSidecarSupport is set to true if the corresponding featuregate is enabled and the minimum required k8s version is met.
	NativeSidecarSupport bool `yaml:"native-sidecar-support"`
}

Internal contains configuration that is propagated and cannot be accessed from the operator configuration.

type TLSConfig

type TLSConfig struct {
	MinVersion   string
	CipherSuites []string
}

func (TLSConfig) ApplyTLSConfig

func (tlsOpt TLSConfig) ApplyTLSConfig(cfg *tls.Config) error

ApplyTLSConfig get the option from command argument (tlsConfig), check the validity through k8s apiflag and set the config for webhook server. refer to https://pkg.go.dev/k8s.io/component-base/cli/flag

type ZapConfig

type ZapConfig struct {
	MessageKey  string `yaml:"message-key"`
	TimeKey     string `yaml:"time-key"`
	LevelKey    string `yaml:"level-key"`
	LevelFormat string `yaml:"level-format"`
}