reconciler

Documentation

Overview

Package reconciler defines implementations of the Reconciler interface defined at knative.dev/pkg/controller.Reconciler. These implement the basic workhorse functionality of controllers, while leaving the shared controller implementation to manage things like the workqueue.

Despite defining a Reconciler, each of the packages here are expected to expose a controller constructor like:

func NewController(...) *controller.Impl { ... }

These constructors will:

1. Construct the Reconciler,
2. Construct a controller.Impl with that Reconciler,
3. Wire the assorted informers this Reconciler watches to call appropriate enqueue methods on the controller.

Index

• type Backoff
• type StatusKey
• type TimeoutSet
  • func NewTimeoutHandler(stopCh <-chan struct{}, logger *zap.SugaredLogger) *TimeoutSet
  • func (t *TimeoutSet) CheckTimeouts(namespace string, kubeclientset kubernetes.Interface, ...)
  • func (t *TimeoutSet) GetBackoff(tr *v1beta1.TaskRun) (Backoff, bool)
  • func (t *TimeoutSet) Release(runObj StatusKey)
  • func (t *TimeoutSet) SetPipelineRunCallbackFunc(f func(interface{}))
  • func (t *TimeoutSet) SetTaskRunCallbackFunc(f func(interface{}))
  • func (t *TimeoutSet) SetTaskRunTimer(tr *v1beta1.TaskRun, d time.Duration)
  • func (t *TimeoutSet) WaitPipelineRun(pr *v1beta1.PipelineRun, startTime *metav1.Time)
  • func (t *TimeoutSet) WaitTaskRun(tr *v1beta1.TaskRun, startTime *metav1.Time)

Types

type Backoff

type Backoff struct {
	// NumAttempts reflects the number of times a given StatusKey has been delayed
	NumAttempts uint
	// NextAttempt is the point in time at which this backoff expires
	NextAttempt time.Time
}

Backoff contains state of exponential backoff for a given StatusKey

type StatusKey

type StatusKey interface {
	GetRunKey() string
}

StatusKey interface to be implemented by Taskrun Pipelinerun types

type TimeoutSet

type TimeoutSet struct {
	// contains filtered or unexported fields
}

TimeoutSet contains required k8s interfaces to handle build timeouts

func NewTimeoutHandler

func NewTimeoutHandler(
	stopCh <-chan struct{},
	logger *zap.SugaredLogger,
) *TimeoutSet

NewTimeoutHandler returns TimeoutSet filled structure

func (*TimeoutSet) CheckTimeouts

func (t *TimeoutSet) CheckTimeouts(namespace string, kubeclientset kubernetes.Interface, pipelineclientset clientset.Interface)

CheckTimeouts function iterates through a given namespace or all namespaces (if empty string) and calls corresponding taskrun/pipelinerun timeout functions

func (*TimeoutSet) GetBackoff

func (t *TimeoutSet) GetBackoff(tr *v1beta1.TaskRun) (Backoff, bool)

GetBackoff records the number of times it has seen a TaskRun and calculates an appropriate backoff deadline based on that count. Only one backoff per TaskRun may be active at any moment. Requests for a new backoff in the face of an existing one will be ignored and details of the existing backoff will be returned instead. Further, if a calculated backoff time is after the timeout of the TaskRun then the time of the timeout will be returned instead.

Returned values are a backoff struct containing a NumAttempts field with the number of attempts performed for this TaskRun and a NextAttempt field describing the time at which the next attempt should be performed. Additionally a boolean is returned indicating whether a backoff for the TaskRun is already in progress.

func (*TimeoutSet) Release

func (t *TimeoutSet) Release(runObj StatusKey)

Release deletes channels and data that are specific to a StatusKey object.

func (*TimeoutSet) SetPipelineRunCallbackFunc

func (t *TimeoutSet) SetPipelineRunCallbackFunc(f func(interface{}))

SetPipelineRunCallbackFunc sets the callback function when timeout occurs for pipelinerun objects

func (*TimeoutSet) SetTaskRunCallbackFunc

func (t *TimeoutSet) SetTaskRunCallbackFunc(f func(interface{}))

SetTaskRunCallbackFunc sets the callback function when timeout occurs for taskrun objects

func (*TimeoutSet) SetTaskRunTimer

func (t *TimeoutSet) SetTaskRunTimer(tr *v1beta1.TaskRun, d time.Duration)

SetTaskRunTimer creates a blocking function for taskrun to wait for 1. Stop signal, 2. TaskRun to complete or 3. a given Duration to elapse.

Since the timer's duration is a parameter rather than being tied to the lifetime of the TaskRun no resources are released after the timer fires. It is the caller's responsibility to Release() the TaskRun when work with it has completed.

func (*TimeoutSet) WaitPipelineRun

func (t *TimeoutSet) WaitPipelineRun(pr *v1beta1.PipelineRun, startTime *metav1.Time)

WaitPipelineRun function creates a blocking function for pipelinerun to wait for 1. Stop signal, 2. pipelinerun to complete or 3. pipelinerun to time out which is determined by checking if the tr's timeout has occurred since the startTime

func (*TimeoutSet) WaitTaskRun

func (t *TimeoutSet) WaitTaskRun(tr *v1beta1.TaskRun, startTime *metav1.Time)

WaitTaskRun function creates a blocking function for taskrun to wait for 1. Stop signal, 2. TaskRun to complete or 3. Taskrun to time out, which is determined by checking if the tr's timeout has occurred since the startTime