kot

README

Kubernetes Operator Toolkit

A toolkit for building kubernetes operators, based on controller runtime libs.

Documentation

Index

• Variables
• func CopyAnnotations(src, dest Object)
• func CopyLabels(src, dest Object)
• func GetAnnotation(obj Object, name string) string
• func HasAnnotation(obj Object, name string) bool
• func SimpleIf(fn func(Context) bool) reconcile.ReconcileIfFunc
• func SimpleReconcileList(fn func(Context, ObjectList)) reconcile.ReconcileListFunc
• func SimpleReconcileOne(fn func(Context, Object)) reconcile.ReconcileOneFunc
• type Action
• type ActionFn
  • func SimpleAction(fn func(Context)) ActionFn
• type AnnotationChangedPredicate
• type ClientKey
• type Config
• type Container
• type Context
• type Controller
• type Custom
• type Finalizer
• type Finalizers
• type GenerationChangedPredicate
• type Indexer
• type LabelChangedPredicate
• type List
• type MatchingFields
• type Object
• type ObjectList
• type One
• type ReconcileRequest
• type Reconciler
• type Reconcilers
• type ResourceVersionChangedPredicate
• type ResourceWatcher
• type Result
• type SimpleFinalizer
  • func (f *SimpleFinalizer) Enabled(ctx action.Context) (bool, error)
  • func (f *SimpleFinalizer) Finalize(ctx action.Context) (bool, action.Result, error)
• type StatusResolvers
• type Watchers

Variables

var (
	Watch     = reconcile.MustCreateWatcher
	Reconcile = reconcile.MustCreateReconciler

	ListChildrenOption = indexing.ListChildrenOption

	Setup = setup.Run

	GVKForObject = apiutil.GVKForObject

	NewPredicateFuncs = runtimepredicate.NewPredicateFuncs
	AndPredicate      = runtimepredicate.And
	OrPredicate       = runtimepredicate.Or

	InNamespace = kotclient.InNamespace

	ClientDep = wkdeps.Client
)

Functions

func CopyAnnotations

func CopyAnnotations(src, dest Object)

func CopyLabels

func CopyLabels(src, dest Object)

func GetAnnotation

func GetAnnotation(obj Object, name string) string

func HasAnnotation

func HasAnnotation(obj Object, name string) bool

func SimpleIf

func SimpleIf(fn func(Context) bool) reconcile.ReconcileIfFunc

func SimpleReconcileList

func SimpleReconcileList(fn func(Context, ObjectList)) reconcile.ReconcileListFunc

func SimpleReconcileOne

func SimpleReconcileOne(fn func(Context, Object)) reconcile.ReconcileOneFunc

Types

type Action

type Action = action.Action

type ActionFn

type ActionFn = action.ActionFn

func SimpleAction

func SimpleAction(fn func(Context)) ActionFn

type AnnotationChangedPredicate

type AnnotationChangedPredicate = runtimepredicate.AnnotationChangedPredicate

type ClientKey

type ClientKey = kotclient.Key

type Config

type Config = setup.Config

type Container

type Container = deps.Container

type Context

type Context = action.Context

type Controller

type Controller = controller.Controller

type Custom

type Custom = reconcile.CustomReconcilerConfig

type Finalizer

type Finalizer = reconcile.Finalizer

type Finalizers

type Finalizers = []reconcile.Finalizer

type GenerationChangedPredicate

type GenerationChangedPredicate = runtimepredicate.GenerationChangedPredicate

type Indexer

type Indexer = indexing.Indexer

type LabelChangedPredicate

type LabelChangedPredicate = runtimepredicate.LabelChangedPredicate

type List

type List = reconcile.ListReconcilerConfig

type MatchingFields

type MatchingFields = kotclient.MatchingFields

type Object

type Object = runtimeclient.Object

type ObjectList

type ObjectList = runtimeclient.ObjectList

type One

type One = reconcile.OneReconcilerConfig

type ReconcileRequest

type ReconcileRequest = runtimereconcile.Request

type Reconciler

type Reconciler = reconcile.Reconciler

type Reconcilers

type Reconcilers = []reconcile.Reconciler

type ResourceVersionChangedPredicate

type ResourceVersionChangedPredicate = runtimepredicate.ResourceVersionChangedPredicate

type ResourceWatcher

type ResourceWatcher = reconcile.ResourceWatcherConfig

type Result

type Result = action.Result

type SimpleFinalizer

type SimpleFinalizer struct {
	EnabledFn  func(ctx action.Context) (bool, error)
	FinalizeFn func(ctx action.Context) (bool, action.Result, error)
}

func (*SimpleFinalizer) Enabled

func (f *SimpleFinalizer) Enabled(ctx action.Context) (bool, error)

func (*SimpleFinalizer) Finalize

func (f *SimpleFinalizer) Finalize(ctx action.Context) (bool, action.Result, error)

type StatusResolvers

type StatusResolvers = []reconcile.StatusResolver

type Watchers

type Watchers = []reconcile.Watcher