operands

Documentation

Index

• type Operand
• type WatchType

Types

type Operand

type Operand interface {
	// WatchTypes returns a slice of namespaced resources, that the operator should watch.
	WatchTypes() []WatchType

	// WatchClusterTypes returns a slice of cluster resources, that the operator should watch.
	WatchClusterTypes() []WatchType

	// RequiredCrds returns names of CRDs, that need to be installed for the operand to work.
	RequiredCrds() []string

	// Reconcile creates and updates resources.
	Reconcile(*common.Request) ([]common.ReconcileResult, error)

	// Cleanup removes any created cluster resources.
	// They don't use owner references, so the garbage collector will not remove them.
	Cleanup(*common.Request) ([]common.CleanupResult, error)

	// Name returns the name of the operand
	Name() string
}

type WatchType

type WatchType struct {
	Object client.Object

	// Crd name that defines the object
	Crd string

	// WatchFullObject specifies if the operator should watch for any changes in the full object.
	// Otherwise, only these changes in spec, labels, and annotations.
	// If an object does not have spec field, the full object is watched by default.
	WatchFullObject bool
}