v1

Documentation

Index

• func FromPlanHandlerToHandler(sync PlanHandler) generic.Handler
• func RegisterPlanGeneratingHandler(ctx context.Context, controller PlanController, apply apply.Apply, ...)
• func RegisterPlanStatusHandler(ctx context.Context, controller PlanController, condition condition.Cond, ...)
• func UpdatePlanDeepCopyOnChange(client PlanClient, obj *v1.Plan, handler func(obj *v1.Plan) (*v1.Plan, error)) (*v1.Plan, error)
• type Interface
  • func New(controllerFactory controller.SharedControllerFactory) Interface
• type PlanCache
• type PlanClient
• type PlanController
  • func NewPlanController(gvk schema.GroupVersionKind, resource string, namespaced bool, ...) PlanController
• type PlanGeneratingHandler
• type PlanHandler
• type PlanIndexer
• type PlanStatusHandler

Functions

func FromPlanHandlerToHandler

func FromPlanHandlerToHandler(sync PlanHandler) generic.Handler

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

func UpdatePlanDeepCopyOnChange

func UpdatePlanDeepCopyOnChange(client PlanClient, obj *v1.Plan, handler func(obj *v1.Plan) (*v1.Plan, error)) (*v1.Plan, error)

Types

type Interface

type Interface interface {
	Plan() PlanController
}

func New

func New(controllerFactory controller.SharedControllerFactory) Interface

type PlanCache

type PlanCache interface {
	Get(namespace, name string) (*v1.Plan, error)
	List(namespace string, selector labels.Selector) ([]*v1.Plan, error)

	AddIndexer(indexName string, indexer PlanIndexer)
	GetByIndex(indexName, key string) ([]*v1.Plan, error)
}

type PlanClient

type PlanClient interface {
	Create(*v1.Plan) (*v1.Plan, error)
	Update(*v1.Plan) (*v1.Plan, error)
	UpdateStatus(*v1.Plan) (*v1.Plan, error)
	Delete(namespace, name string, options *metav1.DeleteOptions) error
	Get(namespace, name string, options metav1.GetOptions) (*v1.Plan, error)
	List(namespace string, opts metav1.ListOptions) (*v1.PlanList, error)
	Watch(namespace string, opts metav1.ListOptions) (watch.Interface, error)
	Patch(namespace, name string, pt types.PatchType, data []byte, subresources ...string) (result *v1.Plan, err error)
}

type PlanController

type PlanController interface {
	generic.ControllerMeta
	PlanClient

	OnChange(ctx context.Context, name string, sync PlanHandler)
	OnRemove(ctx context.Context, name string, sync PlanHandler)
	Enqueue(namespace, name string)
	EnqueueAfter(namespace, name string, duration time.Duration)

	Cache() PlanCache
}

func NewPlanController

func NewPlanController(gvk schema.GroupVersionKind, resource string, namespaced bool, controller controller.SharedControllerFactory) PlanController

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 PlanHandler

type PlanHandler func(string, *v1.Plan) (*v1.Plan, error)

type PlanIndexer

type PlanIndexer func(obj *v1.Plan) ([]string, error)

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