controller

Documentation

Overview

Package controller configures controller options.

Index

• type ChangeLogOptions
• type ESSOptions
• type MetricOptions
• type Options
  • func DefaultOptions() Options
  • func (o Options) ForControllerRuntime() controller.Options

Types

type ChangeLogOptions

type ChangeLogOptions struct {
	ChangeLogger managed.ChangeLogger
}

ChangeLogOptions for recording changes to managed resources into the change logs.

type ESSOptions

type ESSOptions struct {
	TLSConfig     *tls.Config
	TLSSecretName *string
}

ESSOptions for External Secret Stores.

type MetricOptions

type MetricOptions struct {
	// PollStateMetricInterval at which each controller should record state
	PollStateMetricInterval time.Duration

	// MetricsRecorder to use for recording metrics.
	MRMetrics managed.MetricRecorder

	// MRStateMetrics to use for recording state metrics.
	MRStateMetrics *statemetrics.MRStateMetrics
}

MetricOptions for recording metrics.

type Options

type Options struct {
	// The Logger controllers should use.
	Logger logging.Logger

	// The GlobalRateLimiter used by this controller manager. The rate of
	// reconciles across all controllers will be subject to this limit.
	GlobalRateLimiter workqueue.RateLimiter

	// PollInterval at which each controller should speculatively poll to
	// determine whether it has work to do.
	PollInterval time.Duration

	// MaxConcurrentReconciles for each controller.
	MaxConcurrentReconciles int

	// Features that should be enabled.
	Features *feature.Flags

	// ESSOptions for External Secret Stores.
	ESSOptions *ESSOptions

	// MetricOptions for recording metrics.
	MetricOptions *MetricOptions

	// ChangeLogOptions for recording change logs.
	ChangeLogOptions *ChangeLogOptions
}

Options frequently used by most Crossplane controllers.

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns a functional set of options with conservative defaults.

func (Options) ForControllerRuntime

func (o Options) ForControllerRuntime() controller.Options

ForControllerRuntime extracts options for controller-runtime.