Documentation
¶
Overview ¶
Package reconciler defines implementations of the Reconciler interface defined at github.com/knative/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:
- Construct the Reconciler,
- Construct a controller.Impl with that Reconciler,
- Wire the assorted informers this Reconciler watches to call appropriate enqueue methods on the controller.
Copyright 2018 The Knative Authors ¶
Licensed under the Apache License, Version 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 ¶
- func EmitEvent(c record.EventRecorder, beforeCondition *apis.Condition, ...)
- func MustNewStatsReporter(reconciler string, logger *zap.SugaredLogger) controller.StatsReporter
- type Base
- type Options
- type StatusKey
- type TimeoutSet
- func (t *TimeoutSet) CheckTimeouts()
- func (t *TimeoutSet) Release(runObj StatusKey)
- func (t *TimeoutSet) SetPipelineRunCallbackFunc(f func(interface{}))
- func (t *TimeoutSet) SetTaskRunCallbackFunc(f func(interface{}))
- func (t *TimeoutSet) WaitPipelineRun(pr *v1alpha1.PipelineRun, startTime *metav1.Time)
- func (t *TimeoutSet) WaitTaskRun(tr *v1alpha1.TaskRun, startTime *metav1.Time)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EmitEvent ¶
func EmitEvent(c record.EventRecorder, beforeCondition *apis.Condition, afterCondition *apis.Condition, object runtime.Object)
EmitEvent emits success or failed event for object if afterCondition is different from beforeCondition
func MustNewStatsReporter ¶
func MustNewStatsReporter(reconciler string, logger *zap.SugaredLogger) controller.StatsReporter
MustNewStatsReporter creates a new instance of StatsReporter. Panics if creation fails.
Types ¶
type Base ¶
type Base struct {
// KubeClientSet allows us to talk to the k8s for core APIs
KubeClientSet kubernetes.Interface
SharedClientSet sharedclientset.Interface
// PipelineClientSet allows us to configure pipeline objects
PipelineClientSet clientset.Interface
// CachingClientSet allows us to instantiate Image objects
CachingClientSet cachingclientset.Interface
// ConfigMapWatcher allows us to watch for ConfigMap changes.
ConfigMapWatcher configmap.Watcher
// Recorder is an event recorder for recording Event resources to the
// Kubernetes API.
Recorder record.EventRecorder
// Sugared logger is easier to use but is not as performant as the
// raw logger. In performance critical paths, call logger.Desugar()
// and use the returned raw logger instead. In addition to the
// performance benefits, raw logger also preserves type-safety at
// the expense of slightly greater verbosity.
Logger *zap.SugaredLogger
}
Base implements the core controller logic, given a Reconciler.
type Options ¶
type Options struct {
KubeClientSet kubernetes.Interface
PipelineClientSet clientset.Interface
CachingClientSet cachingclientset.Interface
ConfigMapWatcher configmap.Watcher
Logger *zap.SugaredLogger
Recorder record.EventRecorder
ResyncPeriod time.Duration
}
Options defines the common reconciler options. We define this to reduce the boilerplate argument list when creating our controllers.
func (Options) GetTrackerLease ¶
GetTrackerLease returns a multiple of the resync period to use as the duration for tracker leases. This attempts to ensure that resyncs happen to refresh leases frequently enough that we don't miss updates to tracked objects.
type StatusKey ¶ added in v0.2.0
type StatusKey interface {
GetRunKey() string
}
StatusKey interface to be implemented by Taskrun Pipelinerun types
type TimeoutSet ¶ added in v0.2.0
type TimeoutSet struct {
// contains filtered or unexported fields
}
TimeoutSet contains required k8s interfaces to handle build timeouts
func NewTimeoutHandler ¶ added in v0.2.0
func NewTimeoutHandler( kubeclientset kubernetes.Interface, pipelineclientset clientset.Interface, stopCh <-chan struct{}, logger *zap.SugaredLogger, ) *TimeoutSet
NewTimeoutHandler returns TimeoutSet filled structure
func (*TimeoutSet) CheckTimeouts ¶ added in v0.2.0
func (t *TimeoutSet) CheckTimeouts()
CheckTimeouts function iterates through all namespaces and calls corresponding taskrun/pipelinerun timeout functions
func (*TimeoutSet) Release ¶ added in v0.2.0
func (t *TimeoutSet) Release(runObj StatusKey)
Release function deletes key from timeout map
func (*TimeoutSet) SetPipelineRunCallbackFunc ¶ added in v0.2.0
func (t *TimeoutSet) SetPipelineRunCallbackFunc(f func(interface{}))
SetPipelineRunCallbackFunc sets the callback function when timeout occurs for pipelinerun objects
func (*TimeoutSet) SetTaskRunCallbackFunc ¶ added in v0.2.0
func (t *TimeoutSet) SetTaskRunCallbackFunc(f func(interface{}))
SetTaskRunCallbackFunc sets the callback function when timeout occurs for taskrun objects
func (*TimeoutSet) WaitPipelineRun ¶ added in v0.2.0
func (t *TimeoutSet) WaitPipelineRun(pr *v1alpha1.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 ¶ added in v0.2.0
func (t *TimeoutSet) WaitTaskRun(tr *v1alpha1.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
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
v1alpha1
|
|
|
taskrun/resources
Package resources provides methods to convert a Build CRD to a k8s Pod resource.
|
Package resources provides methods to convert a Build CRD to a k8s Pod resource. |