reconciler

Documentation

Overview

Copyright 2020 The Knative Authors

Licensed under the Apache License, Veroute.on 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func AnnotationFilterFunc(key string, value string, allowUnset bool) func(interface{}) bool
• func ChainFilterFuncs(funcs ...func(interface{}) bool) func(interface{}) bool
• func LabelExistsFilterFunc(label string) func(obj interface{}) bool
• func LabelFilterFunc(label string, value string, allowUnset bool) func(interface{}) bool
• func NameFilterFunc(name string) func(interface{}) bool
• func NamespaceFilterFunc(namespace string) func(interface{}) bool
• func Not(f func(interface{}) bool) func(interface{}) bool
• func RetryUpdateConflicts(updater func(int) error) error
• type ConfigStore
• type Event
  • func NewEvent(eventtype, reason, messageFmt string, args ...interface{}) Event
• type ReconcilerEvent
  • func (e *ReconcilerEvent) Error() string
  • func (e *ReconcilerEvent) Is(target error) bool

Variables

var EventAs = errors.As

As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true.

The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.

An error matches target if the error's concrete value is assignable to the value pointed to by target, or if the error has a method As(interface{}) bool such that As(target) returns true. In the latter case, the As method is responsible for setting target.

As will panic if target is not a non-nil pointer to either a type that implements error, or to any interface type. As returns false if err is nil. (text from errors/wrap.go)

var EventIs = errors.Is

Is reports whether any error in err's chain matches target.

The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.

An error is considered to match a target if it is equal to that target or if it implements a method Is(error) bool such that Is(target) returns true. (text from errors/wrap.go)

Functions

func AnnotationFilterFunc

func AnnotationFilterFunc(key string, value string, allowUnset bool) func(interface{}) bool

AnnotationFilterFunc creates a FilterFunc only accepting objects with given annotation key and value

func ChainFilterFuncs

func ChainFilterFuncs(funcs ...func(interface{}) bool) func(interface{}) bool

ChainFilterFuncs creates a FilterFunc which performs an AND of the passed FilterFuncs.

func LabelExistsFilterFunc

func LabelExistsFilterFunc(label string) func(obj interface{}) bool

LabelExistsFilterFunc creates a FilterFunc only accepting objects which have a given label.

func LabelFilterFunc

func LabelFilterFunc(label string, value string, allowUnset bool) func(interface{}) bool

LabelFilterFunc creates a FilterFunc only accepting objects where a label is set to a specific value.

func NameFilterFunc

func NameFilterFunc(name string) func(interface{}) bool

NameFilterFunc creates a FilterFunc only accepting objects with the given name.

func NamespaceFilterFunc

func NamespaceFilterFunc(namespace string) func(interface{}) bool

NamespaceFilterFunc creates a FilterFunc only accepting objects in the given namespace.

func Not

func Not(f func(interface{}) bool) func(interface{}) bool

Not inverts the result of the predicate.

func RetryUpdateConflicts

func RetryUpdateConflicts(updater func(int) error) error

RetryUpdateConflicts retries the inner function if it returns conflict errors. This can be used to retry status updates without constantly reenqueuing keys.

Types

type ConfigStore

type ConfigStore interface {
	// ConfigStore is used to attach the frozen configuration to the context.
	ToContext(ctx context.Context) context.Context
}

ConfigStore is used to attach the frozen configuration to the context.

type Event

type Event error

Event leverages go's 1.13 error wrapping.

func NewEvent

func NewEvent(eventtype, reason, messageFmt string, args ...interface{}) Event

NewEvent returns an Event fully populated.

type ReconcilerEvent

type ReconcilerEvent struct {
	EventType string
	Reason    string
	Format    string
	Args      []interface{}
}

ReconcilerEvent wraps the fields required for recorders to create a kubernetes recorder Event.

func (*ReconcilerEvent) Error

func (e *ReconcilerEvent) Error() string

Error returns the string that is formed by using the format string with the provided args.

func (*ReconcilerEvent) Is

func (e *ReconcilerEvent) Is(target error) bool

Is returns if the target error is a ReconcilerEvent type checking that EventType and Reason match.