controller

Documentation

Overview

Package controller provides helper methods for external controllers for Custom Task types.

Index

• func FilterCustomRunRef(apiVersion, kind string) func(interface{}) bool
• func FilterOwnerCustomRunRef(customRunLister listersbeta.CustomRunLister, apiVersion, kind string) func(interface{}) bool

Functions

func FilterCustomRunRef

func FilterCustomRunRef(apiVersion, kind string) func(interface{}) bool

FilterCustomRunRef returns a filter that can be passed to a CustomRun Informer, which filters out CustomRuns for apiVersion and kinds that a controller doesn't care about.

For example, a controller impl that wants to be notified of updates to CustomRuns which reference a Task with apiVersion "example.dev/v0" and kind "Example":

customruninformer.Get(ctx).Informer().AddEventHandler(cache.FilteringResourceEventHandler{
  FilterFunc: FilterCustomRunRef("example.dev/v0", "Example"),
  Handler:    controller.HandleAll(impl.Enqueue),
})

func FilterOwnerCustomRunRef

func FilterOwnerCustomRunRef(customRunLister listersbeta.CustomRunLister, apiVersion, kind string) func(interface{}) bool

FilterOwnerCustomRunRef returns a filter that can be passed to an Informer for any runtime object, which filters out objects that aren't controlled by a CustomRun that references a particular apiVersion and kind.

For example, a controller impl that wants to be notified of updates to TaskRuns that are controlled by a CustomRun which references a custom task with apiVersion "example.dev/v0" and kind "Example":

taskruninformer.Get(ctx).Informer().AddEventHandler(cache.FilteringResourceEventHandler{
  FilterFunc: FilterOwnerCustomRunRef("example.dev/v0", "Example"),
  Handler:    controller.HandleAll(impl.Enqueue),
})