cleaner

Documentation

Index

• type GetJobsHistoryLimiter
• type ObjectCleaner
  • func NewObjectCleaner(clt client.Client, Limits GetJobsHistoryLimiter) *ObjectCleaner
  • func (c *ObjectCleaner) CleanOldObjects(ctx context.Context, jobObjects k8upv1.JobObjectList) (int, error)

Types

type GetJobsHistoryLimiter

type GetJobsHistoryLimiter interface {
	GetSuccessfulJobsHistoryLimit() *int
	GetFailedJobsHistoryLimit() *int
}

GetJobsHistoryLimiter provides the limits on how many jobs to clean.

type ObjectCleaner

type ObjectCleaner struct {
	Client client.Client
	Limits GetJobsHistoryLimiter
}

ObjectCleaner cleans old, finished job objects.

func NewObjectCleaner

func NewObjectCleaner(clt client.Client, Limits GetJobsHistoryLimiter) *ObjectCleaner

NewObjectCleaner creates a new ObjectCleaner instance.

func (*ObjectCleaner) CleanOldObjects

func (c *ObjectCleaner) CleanOldObjects(ctx context.Context, jobObjects k8upv1.JobObjectList) (int, error)

CleanOldObjects iterates over the given list and deletes them with the oldest object first until the amount returned from GetJobsHistoryLimiter remain. The function aborts early on errors. Returns the amount of deleted objects and possible errors.