k8sgc

Documentation

Overview

Package k8sgc implements a basic for of garbage collection on the Kubernetes API.

This job is normally performed by the controller-manager. The component is not available in a test setting, with only the basic API server deployed. This is where k8sgc comes in to fill the gap, so deletion of objects can be tested as expected.

Index

• type GC
  • func New(ctx context.Context, cl client.Client) (GC, error)

Types

type GC

type GC interface {
	// Run the garbage collector until all orphaned resources are collected.
	// Returns true if any resources where collected.
	Run(ctx context.Context) (bool, error)
}

GC offers a basic form of garbage collection for Kubernetes resources

func New

func New(ctx context.Context, cl client.Client) (GC, error)

New creates a new GC using the passed kubernetes client. The GC will watch all resources for which the client has a Scheme.