pruning

Documentation

Index

• type KeepGrid
  • func MustNewKeepGrid(regex, gridspec string) *KeepGrid
  • func NewKeepGrid(in *config.PruneGrid) (p *KeepGrid, err error)
  • func (p *KeepGrid) KeepRule(snaps []Snapshot) (destroyList []Snapshot)
• type KeepLastN
  • func MustKeepLastN(n int, regex string) *KeepLastN
  • func NewKeepLastN(n int, regex string) (*KeepLastN, error)
  • func (k KeepLastN) KeepRule(snaps []Snapshot) (destroyList []Snapshot)
• type KeepNotReplicated
  • func NewKeepNotReplicated() *KeepNotReplicated
  • func (*KeepNotReplicated) KeepRule(snaps []Snapshot) (destroyList []Snapshot)
• type KeepRegex
  • func MustKeepRegex(expr string, negate bool) *KeepRegex
  • func NewKeepRegex(expr string, negate bool) (*KeepRegex, error)
  • func (k *KeepRegex) KeepRule(snaps []Snapshot) []Snapshot
• type KeepRule
  • func RuleFromConfig(in config.PruningEnum) (KeepRule, error)
  • func RulesFromConfig(in []config.PruningEnum) (rules []KeepRule, err error)
• type Snapshot
  • func PruneSnapshots(snaps []Snapshot, keepRules []KeepRule) []Snapshot

Types

type KeepGrid

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

KeepGrid fits snapshots that match a given regex into a retentiongrid.Grid, uses the most recent snapshot among those that match the regex as 'now', and deletes all snapshots that do not fit the grid specification.

func MustNewKeepGrid

func MustNewKeepGrid(regex, gridspec string) *KeepGrid

func NewKeepGrid

func NewKeepGrid(in *config.PruneGrid) (p *KeepGrid, err error)

func (*KeepGrid) KeepRule

func (p *KeepGrid) KeepRule(snaps []Snapshot) (destroyList []Snapshot)

Prune filters snapshots with the retention grid.

type KeepLastN

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

func MustKeepLastN

func MustKeepLastN(n int, regex string) *KeepLastN

func NewKeepLastN

func NewKeepLastN(n int, regex string) (*KeepLastN, error)

func (KeepLastN) KeepRule

func (k KeepLastN) KeepRule(snaps []Snapshot) (destroyList []Snapshot)

type KeepNotReplicated

type KeepNotReplicated struct{}

func NewKeepNotReplicated

func NewKeepNotReplicated() *KeepNotReplicated

func (*KeepNotReplicated) KeepRule

func (*KeepNotReplicated) KeepRule(snaps []Snapshot) (destroyList []Snapshot)

type KeepRegex

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

func MustKeepRegex

func MustKeepRegex(expr string, negate bool) *KeepRegex

func NewKeepRegex

func NewKeepRegex(expr string, negate bool) (*KeepRegex, error)

func (*KeepRegex) KeepRule

func (k *KeepRegex) KeepRule(snaps []Snapshot) []Snapshot

type KeepRule

type KeepRule interface {
	KeepRule(snaps []Snapshot) (destroyList []Snapshot)
}

func RuleFromConfig

func RuleFromConfig(in config.PruningEnum) (KeepRule, error)

func RulesFromConfig

func RulesFromConfig(in []config.PruningEnum) (rules []KeepRule, err error)

type Snapshot

type Snapshot interface {
	Name() string
	Replicated() bool
	Date() time.Time
}

func PruneSnapshots

func PruneSnapshots(snaps []Snapshot, keepRules []KeepRule) []Snapshot

The returned snapshot list is guaranteed to only contains elements of input parameter snaps