keepforcrs

Documentation

Index

• Constants
• func IsInvalidConfig(err error) bool
• type Config
• type Resource
  • func New(config Config) (*Resource, error)
  • func (r *Resource) EnsureCreated(ctx context.Context, obj interface{}) error
  • func (r *Resource) EnsureDeleted(ctx context.Context, obj interface{}) error
  • func (r *Resource) Name() string

Constants

const (
	Name = "keepforcrs"
)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	K8sClient k8sclient.Interface
	Logger    micrologger.Logger
	// NewObjFunc is to return an instance of a pointer for the CR type that
	// should be considered for keeping finalizers.
	//
	//     &infrastructurev1alpha3.G8sControlPlane{}
	//     &apiv1alpha3.MachineDeployment{}
	//
	NewObjFunc func() runtime.Object
	Provider   string
}

type Resource

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

Resource receives the runtime object of the underlying controller it is wired into and keeps finalizers for that very controller in case the configured runtime objects do still exist. This is to have a reliable deletion for the following CRs.

watch      |    delete
---------------------------------
Cluster    |    G8sControlPlane
Cluster    |    MachineDeployment

func New

func New(config Config) (*Resource, error)

func (*Resource) EnsureCreated

func (r *Resource) EnsureCreated(ctx context.Context, obj interface{}) error

func (*Resource) EnsureDeleted

func (r *Resource) EnsureDeleted(ctx context.Context, obj interface{}) error

func (*Resource) Name

func (r *Resource) Name() string