periodic

Documentation

Index

• Constants
• Variables
• type Option
  • func WithClient(c client.Client) Option
  • func WithEventChannel(ch chan event.GenericEvent) Option
  • func WithEventRecorder(recorder record.EventRecorder) Option
  • func WithInterval(interval time.Duration) Option
  • func WithMetricsSource(src metricssource.Source) Option
• type Runner
  • func New(opts ...Option) (*Runner, error)
  • func (r *Runner) Start(ctx context.Context) error

Constants

const UnknownUtilizationValue = "unknown"

UnknownUtilizationValue is the value which will be used when the free space/inodes utilization is unknown.

Variables

var ErrNoClient = errors.New("no client provided")

ErrNoClient is an error which is returned when the periodic Runner was configured configured without a Kubernetes API client.

var ErrNoMetricsSource = errors.New("no metrics source provided")

ErrNoMetricsSource is returned when the Runner is configured without a metrics source.

var ErrStorageClassDoesNotSupportExpansion = errors.New("storage class does not support expansion")

ErrStorageClassDoesNotSupportExpansion is an error which is returned when an annotated PVC uses a storage class that does not support volume expansion.

var ErrStorageClassNotFound = errors.New("no storage class found")

ErrStorageClassNotFound is an error which is returned when the storage class for a PVC is not found.

var ErrVolumeModeIsNotFilesystem = errors.New("volume mode is not filesystem")

ErrVolumeModeIsNotFilesystem is an error which is returned if a target PVC for resizing is not using the Filesystem VolumeMode.

Types

type Option

type Option func(r *Runner)

Option is a function which configures the Runner.

func WithClient

func WithClient(c client.Client) Option

WithClient configures the Runner with the given client.

func WithEventChannel

func WithEventChannel(ch chan event.GenericEvent) Option

WithEventChannel configures the Runner to use the given channel for enqueuing.

func WithEventRecorder

func WithEventRecorder(recorder record.EventRecorder) Option

WithEventRecorder configures the Runner to use the given event recorder.

func WithInterval

func WithInterval(interval time.Duration) Option

WithInterval configures the Runner with the given interval.

func WithMetricsSource

func WithMetricsSource(src metricssource.Source) Option

WithMetricsSource configures the Runner to use the given source of metrics.

type Runner

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

Runner is a sigs.k8s.io/controller-runtime/pkg/manager.Runnable, which enqueues v1alpha1.PersistentVolumeClaimAutoscaler items for reconciling on regular basis.

func New

func New(opts ...Option) (*Runner, error)

New creates a new Runner with the given options.

func (*Runner) Start

func (r *Runner) Start(ctx context.Context) error

Start implements the sigs.k8s.io/controller-runtime/pkg/manager.Runnable interface.