garbage

Documentation

Index

• type Interface
  • func New(opts Options) (Interface, error)
• type Options

Types

type Interface

type Interface interface {
	// Run runs the garbage collector. Collects every 30 seconds, or when the
	// collector is shutting down.
	Run(ctx context.Context) error

	// Push pushes a key to the garbage collector to be deleted.
	Push(key string)

	// Pop removes a key from the garbage collector.
	Pop(key string)
}

Interface is a garbage collector. It is used to queue-up deletion of ETCD keys so that they can be deleted in bulk and not interrupt triggering. Keys can be pulled from garbage collection queue. Runs every 30s.

func New

func New(opts Options) (Interface, error)

New creates a new garbage collector.

type Options

type Options struct {
	// Log is the logger for the collector to use.
	Log logr.Logger

	// Client is the ETCD client to use for deleting keys.
	Client client.Interface

	// CollectionInterval is the interval at which the garbage collector runs.
	// When nil, defaults to 180 seconds.
	CollectionInterval *time.Duration
}

Options is the configuration for the garbage collector.