config

Documentation

Index

• Constants
• type Options
  • func NewDefaultOptions() *Options
  • func (o *Options) AddFlags(cmd *cobra.Command)
  • func (o *Options) Validate() error

Constants

const (
	// DefaultResyncInterval is the default interval for the controller to
	// resync PersistentVolumeClaims.
	DefaultResyncInterval = 30 * time.Second

	// DefaultDeleteAfter is the default time after which
	// PersistentVolumeClaims are deleted where their managing StatefulSet was
	// deleted.
	DefaultDeleteAfter = 24 * time.Hour

	// DefaultLabelSelector is the default label selector that is used to
	// identify StatefulSets whose PersistentVolumeClaims should be managed by
	// kube-volume-cleaner.
	DefaultLabelSelector = "kube-volume-cleaner.io/on-delete=cleanup-pvcs"

	// DefaultControllerID is the default ID of the controller used to annotate
	// PersistentVolumeClaims with in order to allow multiple controllers to
	// coexist without interfering.
	DefaultControllerID = "kube-volume-cleaner"
)

Types

type Options

type Options struct {
	ControllerID   string
	Namespace      string
	LabelSelector  string
	NoDelete       bool
	DeleteAfter    time.Duration
	ResyncInterval time.Duration
}

Options holds the options that can be configured via cli flags.

func NewDefaultOptions

func NewDefaultOptions() *Options

NewDefaultOptions creates a new *Options value with defaults set.

func (*Options) AddFlags

func (o *Options) AddFlags(cmd *cobra.Command)

AddFlags adds cli flags for configurable options to the command.

func (*Options) Validate

func (o *Options) Validate() error

Validate validates options.