v1

Documentation

Index

• func RegisterPlanGeneratingHandler(ctx context.Context, controller PlanController, apply apply.Apply, ...)
• func RegisterPlanStatusHandler(ctx context.Context, controller PlanController, condition condition.Cond, ...)
• type Interface
  • func New(controllerFactory controller.SharedControllerFactory) Interface
• type PlanCache
• type PlanClient
• type PlanController
• type PlanGeneratingHandler
• type PlanStatusHandler

Functions

func RegisterPlanGeneratingHandler

func RegisterPlanGeneratingHandler(ctx context.Context, controller PlanController, apply apply.Apply,
	condition condition.Cond, name string, handler PlanGeneratingHandler, opts *generic.GeneratingHandlerOptions)

RegisterPlanGeneratingHandler configures a PlanController to execute a PlanGeneratingHandler for every events observed, passing the returned objects to the provided apply.Apply. If a non-empty condition is provided, it will be updated in the status conditions for every handler execution

func RegisterPlanStatusHandler

func RegisterPlanStatusHandler(ctx context.Context, controller PlanController, condition condition.Cond, name string, handler PlanStatusHandler)

RegisterPlanStatusHandler configures a PlanController to execute a PlanStatusHandler for every events observed. If a non-empty condition is provided, it will be updated in the status conditions for every handler execution

Types

type Interface

type Interface interface {
	Plan() PlanController
}

func New

func New(controllerFactory controller.SharedControllerFactory) Interface

type PlanCache

type PlanCache interface {
	generic.CacheInterface[*v1.Plan]
}

PlanCache interface for retrieving Plan resources in memory.

type PlanClient

type PlanClient interface {
	generic.ClientInterface[*v1.Plan, *v1.PlanList]
}

PlanClient interface for managing Plan resources in Kubernetes.

type PlanController

type PlanController interface {
	generic.ControllerInterface[*v1.Plan, *v1.PlanList]
}

PlanController interface for managing Plan resources.

type PlanGeneratingHandler

type PlanGeneratingHandler func(obj *v1.Plan, status v1.PlanStatus) ([]runtime.Object, v1.PlanStatus, error)

PlanGeneratingHandler is the top-level handler that is executed for every Plan event. It extends PlanStatusHandler by a returning a slice of child objects to be passed to apply.Apply

type PlanStatusHandler

type PlanStatusHandler func(obj *v1.Plan, status v1.PlanStatus) (v1.PlanStatus, error)

PlanStatusHandler is executed for every added or modified Plan. Should return the new status to be updated