events

Documentation

Overview

Package events defines the interface and different implementations for events

Tekton uses events to notify about changes in Condition of resources, like a TaskRun is starting, a PipelineRun failed to run or could not be validated.

Copyright 2019 The Tekton 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

• Constants
• func Emit(ctx context.Context, beforeCondition *apis.Condition, ...)
• func EmitError(c record.EventRecorder, err error, object runtime.Object)
• func EmitErrorEvent(c record.EventRecorder, err error, object runtime.Object)
• func EmitEvent(ctx context.Context, beforeCondition *apis.Condition, ...)

Constants

const (
	// EventReasonSucceded is the reason set for events about successful completion of TaskRuns / PipelineRuns
	EventReasonSucceded = "Succeeded"
	// EventReasonFailed is the reason set for events about unsuccessful completion of TaskRuns / PipelineRuns
	EventReasonFailed = "Failed"
	// EventReasonStarted is the reason set for events about the start of TaskRuns / PipelineRuns
	EventReasonStarted = "Started"
	// EventReasonError is the reason set for events related to TaskRuns / PipelineRuns reconcile errors
	EventReasonError = "Error"
)

Functions

func Emit

func Emit(ctx context.Context, beforeCondition *apis.Condition, afterCondition *apis.Condition, object runtime.Object)

Emit emits events for object Two types of events are supported, k8s and cloud events.

k8s events are always sent if afterCondition is different from beforeCondition Cloud events are always sent if enabled, i.e. if a sink is available

func EmitError

func EmitError(c record.EventRecorder, err error, object runtime.Object)

EmitError emits a failure associated to an error

func EmitErrorEvent

func EmitErrorEvent(c record.EventRecorder, err error, object runtime.Object)

EmitErrorEvent emits a failure associated to an error Deprecated: use EmitError instead

func EmitEvent

func EmitEvent(ctx context.Context, beforeCondition *apis.Condition, afterCondition *apis.Condition, object runtime.Object)

EmitEvent emits an event for object if afterCondition is different from beforeCondition

Status "ConditionUnknown":

 beforeCondition == nil, emit EventReasonStarted
 beforeCondition != nil, emit afterCondition.Reason

Status "ConditionTrue": emit EventReasonSucceded
Status "ConditionFalse": emit EventReasonFailed

Deprecated: use Emit