Triggers API

Packages:

triggers.tekton.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the triggers v1alpha1 API group

Resource Types:

ClusterTriggerBinding

ClusterTriggerBinding is a TriggerBinding with a cluster scope. ClusterTriggerBindings are used to represent TriggerBindings that should be publicly addressable from any namespace in the cluster.

Field Description
apiVersion
string
triggers.tekton.dev/v1alpha1
kind
string
ClusterTriggerBinding
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TriggerBindingSpec
(Optional)

Spec holds the desired state of the ClusterTriggerBinding from the client



params
[]Param

Params defines the parameter mapping from the given input event.

status
TriggerBindingStatus
(Optional)

EventListener

EventListener exposes a service to accept HTTP event payloads.

Field Description
apiVersion
string
triggers.tekton.dev/v1alpha1
kind
string
EventListener
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
EventListenerSpec
(Optional)

Spec holds the desired state of the EventListener from the client



serviceAccountName
string
triggers
[]EventListenerTrigger
namespaceSelector
NamespaceSelector
labelSelector
Kubernetes meta/v1.LabelSelector
resources
Resources
status
EventListenerStatus
(Optional)

Trigger

Trigger defines a mapping of an input event to parameters. This is used to extract information from events to be passed to TriggerTemplates within a Trigger.

Field Description
apiVersion
string
triggers.tekton.dev/v1alpha1
kind
string
Trigger
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TriggerSpec
(Optional)

Spec holds the desired state of the Trigger



bindings
[]TriggerSpecBinding
template
TriggerSpecTemplate
name
string
(Optional)
interceptors
[]TriggerInterceptor
serviceAccountName
string
(Optional)

ServiceAccountName optionally associates credentials with each trigger; Unlike EventListeners, this should be scoped to the same namespace as the Trigger itself

TriggerBinding

TriggerBinding defines a mapping of an input event to parameters. This is used to extract information from events to be passed to TriggerTemplates within a Trigger.

Field Description
apiVersion
string
triggers.tekton.dev/v1alpha1
kind
string
TriggerBinding
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TriggerBindingSpec
(Optional)

Spec holds the desired state of the TriggerBinding



params
[]Param

Params defines the parameter mapping from the given input event.

status
TriggerBindingStatus
(Optional)

BitbucketInterceptor

(Appears on:TriggerInterceptor)

BitbucketInterceptor provides a webhook to intercept and pre-process events

Field Description
secretRef
SecretRef
eventTypes
[]string

CELInterceptor

(Appears on:TriggerInterceptor)

CELInterceptor provides a webhook to intercept and pre-process events

Field Description
filter
string
overlays
[]CELOverlay

CELOverlay

(Appears on:CELInterceptor)

CELOverlay provides a way to modify the request body using DeprecatedCEL expressions

Field Description
key
string
expression
string

ClientConfig

(Appears on:ClusterInterceptorSpec)

ClientConfig describes how a client can communicate with the Interceptor

Field Description
url
knative.dev/pkg/apis.URL

URL is a fully formed URL pointing to the interceptor Mutually exclusive with Service

service
ServiceReference

Service is a reference to a Service object where the interceptor is running Mutually exclusive with URL

ClusterInterceptor

ClusterInterceptor describes a pluggable interceptor including configuration such as the fields it accepts and its deployment address. The type is based on the Validating/MutatingWebhookConfiguration types for configuring AdmissionWebhooks

Field Description
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ClusterInterceptorSpec


clientConfig
ClientConfig
status
ClusterInterceptorStatus
(Optional)

ClusterInterceptorSpec

(Appears on:ClusterInterceptor)

ClusterInterceptorSpec describes the Spec for an ClusterInterceptor

Field Description
clientConfig
ClientConfig

ClusterInterceptorStatus

(Appears on:ClusterInterceptor)

ClusterInterceptorStatus holds the status of the ClusterInterceptor

Field Description
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

AddressStatus
knative.dev/pkg/apis/duck/v1.AddressStatus

(Members of AddressStatus are embedded into this type.)

ClusterInterceptor is Addressable and exposes the URL where the Interceptor is running

CustomResource

(Appears on:Resources)

Field Description
RawExtension
k8s.io/apimachinery/pkg/runtime.RawExtension

(Members of RawExtension are embedded into this type.)

EventListenerConfig

(Appears on:EventListenerStatus)

EventListenerConfig stores configuration for resources generated by the EventListener

Field Description
generatedName
string

GeneratedResourceName is the name given to all resources reconciled by the EventListener

EventListenerSpec

(Appears on:EventListener)

EventListenerSpec defines the desired state of the EventListener, represented by a list of Triggers.

Field Description
serviceAccountName
string
triggers
[]EventListenerTrigger
namespaceSelector
NamespaceSelector
labelSelector
Kubernetes meta/v1.LabelSelector
resources
Resources

EventListenerStatus

(Appears on:EventListener)

EventListenerStatus holds the status of the EventListener

Field Description
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

AddressStatus
knative.dev/pkg/apis/duck/v1alpha1.AddressStatus

(Members of AddressStatus are embedded into this type.)

EventListener is Addressable. It currently exposes the service DNS address of the the EventListener sink

configuration
EventListenerConfig

Configuration stores configuration for the EventListener service

EventListenerTrigger

(Appears on:EventListenerSpec)

EventListenerTrigger represents a connection between TriggerBinding, Params, and TriggerTemplate; TriggerBinding provides extracted values for TriggerTemplate to then create resources from. TriggerRef can also be provided instead of TriggerBinding, Interceptors and TriggerTemplate

Field Description
bindings
[]TriggerSpecBinding
template
TriggerSpecTemplate
triggerRef
string
name
string
(Optional)
interceptors
[]TriggerInterceptor
serviceAccountName
string
(Optional)

ServiceAccountName optionally associates credentials with each trigger; more granular authorization for who is allowed to utilize the associated pipeline vs. defaulting to whatever permissions are associated with the entire EventListener and associated sink facilitates multi-tenant model based scenarios

GitHubInterceptor

(Appears on:TriggerInterceptor)

GitHubInterceptor provides a webhook to intercept and pre-process events

Field Description
secretRef
SecretRef
eventTypes
[]string

GitLabInterceptor

(Appears on:TriggerInterceptor)

GitLabInterceptor provides a webhook to intercept and pre-process events

Field Description
secretRef
SecretRef
eventTypes
[]string

InterceptorInterface

InterceptorKind (string alias)

(Appears on:InterceptorRef)

InterceptorKind defines the type of Interceptor used by the Trigger.

Value Description

"ClusterInterceptor"

ClusterTaskKind indicates that task type has a cluster scope.

InterceptorParams

(Appears on:TriggerInterceptor)

InterceptorParams defines a key-value pair that can be passed on an interceptor

Field Description
name
string
value
k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

InterceptorRef

(Appears on:TriggerInterceptor)

InterceptorRef provides a Reference to a ClusterInterceptor

Field Description
name
string

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

kind
InterceptorKind
(Optional)

InterceptorKind indicates the kind of the Interceptor, namespaced or cluster scoped. Currently only InterceptorKind is ClusterInterceptor, so the only valid value is the default one

apiVersion
string
(Optional)

API version of the referent

InterceptorRequest

Do not generate DeepCopy(). See #827

Field Description
body
string

Body is the incoming HTTP event body. We use a “string” representation of the JSON body in order to preserve the body exactly as it was sent (including spaces etc.). This is necessary for some interceptors e.g. GitHub for validating the body with a signature. While []byte can also store an exact representation of the body, json.Marshal will compact []byte to a base64 encoded string which means that we will lose the spaces any time we marshal this struct.

header
map[string][]string

Header are the headers for the incoming HTTP event

extensions
map[string]interface{}

Extensions are extra values that are added by previous interceptors in a chain

interceptor_params
map[string]interface{}

InterceptorParams are the user specified params for interceptor in the Trigger

context
TriggerContext

Context contains additional metadata about the event being processed

InterceptorResponse

Do not generate Deepcopy(). See #827

Field Description
extensions
map[string]interface{}

Extensions are additional fields that is added to the interceptor event.

continue
bool

Continue indicates if the EventListener should continue processing the Trigger or not

status
Status

Status is an Error status containing details on any interceptor processing errors

KubernetesResource

(Appears on:Resources)

Field Description
replicas
int32
serviceType
Kubernetes core/v1.ServiceType
spec
knative.dev/pkg/apis/duck/v1.WithPodSpec


template
knative.dev/pkg/apis/duck/v1.PodSpecable

NamespaceSelector

(Appears on:EventListenerSpec)

NamespaceSelector is a selector for selecting either all namespaces or a list of namespaces.

Field Description
matchNames
[]string

List of namespace names.

Param

(Appears on:TriggerBindingSpec)

Param defines a string value to be used for a ParamSpec with the same name.

Field Description
name
string
value
string

ParamSpec

(Appears on:TriggerTemplateSpec)

ParamSpec defines an arbitrary named input whose value can be supplied by a Param.

Field Description
name
string

Name declares the name by which a parameter is referenced.

description
string
(Optional)

Description is a user-facing description of the parameter that may be used to populate a UI.

default
string
(Optional)

Default is the value a parameter takes if no input value via a Param is supplied.

Resources

(Appears on:EventListenerSpec)

Field Description
kubernetesResource
KubernetesResource
customResource
CustomResource

SecretRef

(Appears on:BitbucketInterceptor, GitHubInterceptor, GitLabInterceptor)

SecretRef contains the information required to reference a single secret string This is needed because the other secretRef types are not cross-namespace and do not actually contain the “SecretName” field, which allows us to access a single secret value.

Field Description
secretKey
string
secretName
string

ServiceReference

(Appears on:ClientConfig)

ServiceReference is a reference to a Service object with an optional path

Field Description
name
string

Name is the name of the service

namespace
string

Namespace is the namespace of the service

path
string
(Optional)

Path is an optional URL path

port
int32

Port is a valid port number

Status

(Appears on:InterceptorResponse, StatusError)

Field Description
code
google.golang.org/grpc/codes.Code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message
string

A developer-facing error message, which should be in English.

StatusError

Field Description
s
Status

TriggerBindingInterface

TriggerBindingInterface is implemented by TriggerBinding and ClusterTriggerBinding

TriggerBindingKind (string alias)

(Appears on:TriggerSpecBinding)

Check that EventListener may be validated and defaulted. TriggerBindingKind defines the type of TriggerBinding used by the EventListener.

Value Description

"ClusterTriggerBinding"

ClusterTriggerBindingKind indicates that triggerbinding type has a cluster scope.

"TriggerBinding"

NamespacedTriggerBindingKind indicates that triggerbinding type has a namespace scope.

TriggerBindingSpec

(Appears on:ClusterTriggerBinding, TriggerBinding)

TriggerBindingSpec defines the desired state of the TriggerBinding.

Field Description
params
[]Param

Params defines the parameter mapping from the given input event.

TriggerBindingStatus

(Appears on:ClusterTriggerBinding, TriggerBinding)

TriggerBindingStatus defines the observed state of TriggerBinding.

TriggerContext

(Appears on:InterceptorRequest)

Field Description
event_url
string

EventURL is the URL of the incoming event

event_id
string

EventID is a unique ID assigned by Triggers to each event

trigger_id
string

TriggerID is of the form namespace/$ns/triggers/$name

TriggerInterceptor

(Appears on:EventListenerTrigger, TriggerSpec)

TriggerInterceptor provides a hook to intercept and pre-process events

Field Description
name
string

Optional name to identify the current interceptor configuration

ref
InterceptorRef

Ref refers to the Interceptor to use

params
[]InterceptorParams

Params are the params to send to the interceptor

webhook
WebhookInterceptor

WebhookInterceptor refers to an old style webhook interceptor service

github
GitHubInterceptor

Deprecated old fields below

gitlab
GitLabInterceptor
cel
CELInterceptor
bitbucket
BitbucketInterceptor

TriggerResourceTemplate

(Appears on:TriggerTemplateSpec)

TriggerResourceTemplate describes a resource to create

Field Description
RawExtension
k8s.io/apimachinery/pkg/runtime.RawExtension

(Members of RawExtension are embedded into this type.)

TriggerSpec

(Appears on:Trigger)

TriggerSpec represents a connection between TriggerSpecBinding, and TriggerSpecTemplate; TriggerSpecBinding provides extracted values for TriggerSpecTemplate to then create resources from.

Field Description
bindings
[]TriggerSpecBinding
template
TriggerSpecTemplate
name
string
(Optional)
interceptors
[]TriggerInterceptor
serviceAccountName
string
(Optional)

ServiceAccountName optionally associates credentials with each trigger; Unlike EventListeners, this should be scoped to the same namespace as the Trigger itself

TriggerSpecBinding

(Appears on:EventListenerTrigger, TriggerSpec)

Field Description
name
string

Name is the name of the binding param Mutually exclusive with Ref

value
string

Value is the value of the binding param. Can contain JSONPath Has to be pointer since “” is a valid value Required if Name is also specified.

ref
string

Ref is a reference to a TriggerBinding kind. Mutually exclusive with Name

kind
TriggerBindingKind

Kind can only be provided if Ref is also provided. Defaults to TriggerBinding

apiversion
string

APIVersion of the binding ref

TriggerSpecTemplate

(Appears on:EventListenerTrigger, TriggerSpec)

Field Description
ref
string
apiversion
string
spec
TriggerTemplateSpec


TriggerTemplate

TriggerTemplate takes parameters and uses them to create CRDs

Field Description
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TriggerTemplateSpec
(Optional)

Spec holds the desired state of the TriggerTemplate from the client



params
[]ParamSpec
resourcetemplates
[]TriggerResourceTemplate
status
TriggerTemplateStatus
(Optional)

TriggerTemplateSpec

(Appears on:TriggerSpecTemplate, TriggerTemplate)

TriggerTemplateSpec holds the desired state of TriggerTemplate

Field Description
params
[]ParamSpec
resourcetemplates
[]TriggerResourceTemplate

TriggerTemplateStatus

(Appears on:TriggerTemplate)

TriggerTemplateStatus describes the desired state of TriggerTemplate

WebhookInterceptor

(Appears on:TriggerInterceptor)

WebhookInterceptor provides a webhook to intercept and pre-process events

Field Description
objectRef
Kubernetes core/v1.ObjectReference
(Optional)

ObjectRef is a reference to an object that will resolve to a cluster DNS name to use as the EventInterceptor. Either objectRef or url can be specified

url
knative.dev/pkg/apis.URL
(Optional)
header
[]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.Param

Header is a group of key-value pairs that can be appended to the interceptor request headers. This allows the interceptor to make decisions specific to an EventListenerTrigger.


triggers.tekton.dev/v1beta1

package v1beta1 contains API Schema definitions for the triggers v1beta1 API group

Resource Types:

ClusterTriggerBinding

ClusterTriggerBinding is a TriggerBinding with a cluster scope. ClusterTriggerBindings are used to represent TriggerBindings that should be publicly addressable from any namespace in the cluster.

Field Description
apiVersion
string
triggers.tekton.dev/v1beta1
kind
string
ClusterTriggerBinding
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TriggerBindingSpec
(Optional)

Spec holds the desired state of the ClusterTriggerBinding from the client



params
[]Param

Params defines the parameter mapping from the given input event.

status
TriggerBindingStatus
(Optional)

EventListener

EventListener exposes a service to accept HTTP event payloads.

Field Description
apiVersion
string
triggers.tekton.dev/v1beta1
kind
string
EventListener
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
EventListenerSpec
(Optional)

Spec holds the desired state of the EventListener from the client



serviceAccountName
string
triggers
[]EventListenerTrigger
triggerGroups
[]EventListenerTriggerGroup

Trigger groups allow for centralized processing of an interceptor chain

namespaceSelector
NamespaceSelector
labelSelector
Kubernetes meta/v1.LabelSelector
resources
Resources
cloudEventURI
string
status
EventListenerStatus
(Optional)

Trigger

Trigger defines a mapping of an input event to parameters. This is used to extract information from events to be passed to TriggerTemplates within a Trigger.

Field Description
apiVersion
string
triggers.tekton.dev/v1beta1
kind
string
Trigger
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TriggerSpec
(Optional)

Spec holds the desired state of the Trigger



bindings
[]TriggerSpecBinding
template
TriggerSpecTemplate
name
string
(Optional)
interceptors
[]TriggerInterceptor
serviceAccountName
string
(Optional)

ServiceAccountName optionally associates credentials with each trigger; Unlike EventListeners, this should be scoped to the same namespace as the Trigger itself

TriggerBinding

TriggerBinding defines a mapping of an input event to parameters. This is used to extract information from events to be passed to TriggerTemplates within a Trigger.

Field Description
apiVersion
string
triggers.tekton.dev/v1beta1
kind
string
TriggerBinding
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TriggerBindingSpec
(Optional)

Spec holds the desired state of the TriggerBinding



params
[]Param

Params defines the parameter mapping from the given input event.

status
TriggerBindingStatus
(Optional)

BitbucketInterceptor

BitbucketInterceptor provides a webhook to intercept and pre-process events

Field Description
secretRef
SecretRef
eventTypes
[]string

CELInterceptor

CELInterceptor provides a webhook to intercept and pre-process events

Field Description
filter
string
overlays
[]CELOverlay

CELOverlay

(Appears on:CELInterceptor)

CELOverlay provides a way to modify the request body using CEL expressions

Field Description
key
string
expression
string

CustomResource

(Appears on:Resources)

Field Description
RawExtension
k8s.io/apimachinery/pkg/runtime.RawExtension

(Members of RawExtension are embedded into this type.)

EventListenerConfig

(Appears on:EventListenerStatus)

EventListenerConfig stores configuration for resources generated by the EventListener

Field Description
generatedName
string

GeneratedResourceName is the name given to all resources reconciled by the EventListener

EventListenerSpec

(Appears on:EventListener)

EventListenerSpec defines the desired state of the EventListener, represented by a list of Triggers.

Field Description
serviceAccountName
string
triggers
[]EventListenerTrigger
triggerGroups
[]EventListenerTriggerGroup

Trigger groups allow for centralized processing of an interceptor chain

namespaceSelector
NamespaceSelector
labelSelector
Kubernetes meta/v1.LabelSelector
resources
Resources
cloudEventURI
string

EventListenerStatus

(Appears on:EventListener)

EventListenerStatus holds the status of the EventListener

Field Description
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

AddressStatus
knative.dev/pkg/apis/duck/v1beta1.AddressStatus

(Members of AddressStatus are embedded into this type.)

EventListener is Addressable. It currently exposes the service DNS address of the the EventListener sink

configuration
EventListenerConfig

Configuration stores configuration for the EventListener service

EventListenerTrigger

(Appears on:EventListenerSpec)

EventListenerTrigger represents a connection between TriggerBinding, Params, and TriggerTemplate; TriggerBinding provides extracted values for TriggerTemplate to then create resources from. TriggerRef can also be provided instead of TriggerBinding, Interceptors and TriggerTemplate

Field Description
bindings
[]TriggerSpecBinding
template
TriggerSpecTemplate
triggerRef
string
name
string
(Optional)
interceptors
[]TriggerInterceptor
serviceAccountName
string
(Optional)

ServiceAccountName optionally associates credentials with each trigger; more granular authorization for who is allowed to utilize the associated pipeline vs. defaulting to whatever permissions are associated with the entire EventListener and associated sink facilitates multi-tenant model based scenarios

EventListenerTriggerGroup

(Appears on:EventListenerSpec)

EventListenerTriggerGroup defines a group of Triggers that share a common set of interceptors

Field Description
name
string
interceptors
[]TriggerInterceptor
triggerSelector
EventListenerTriggerSelector

EventListenerTriggerSelector

(Appears on:EventListenerTriggerGroup)

EventListenerTriggerSelector defines ways to select a group of triggers using their metadata

Field Description
namespaceSelector
NamespaceSelector
labelSelector
Kubernetes meta/v1.LabelSelector

GitHubInterceptor

GitHubInterceptor provides a webhook to intercept and pre-process events

Field Description
secretRef
SecretRef
eventTypes
[]string

GitLabInterceptor

GitLabInterceptor provides a webhook to intercept and pre-process events

Field Description
secretRef
SecretRef
eventTypes
[]string

InterceptorInterface

InterceptorKind (string alias)

(Appears on:InterceptorRef)

InterceptorKind defines the type of Interceptor used by the Trigger.

Value Description

"ClusterInterceptor"

ClusterTaskKind indicates that task type has a cluster scope.

InterceptorParams

(Appears on:TriggerInterceptor)

InterceptorParams defines a key-value pair that can be passed on an interceptor

Field Description
name
string
value
k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

InterceptorRef

(Appears on:TriggerInterceptor)

InterceptorRef provides a Reference to a ClusterInterceptor

Field Description
name
string

Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names

kind
InterceptorKind
(Optional)

InterceptorKind indicates the kind of the Interceptor, namespaced or cluster scoped. Currently only InterceptorKind is ClusterInterceptor, so the only valid value is the default one

apiVersion
string
(Optional)

API version of the referent

InterceptorRequest

Do not generate DeepCopy(). See #827

Field Description
body
string

Body is the incoming HTTP event body. We use a “string” representation of the JSON body in order to preserve the body exactly as it was sent (including spaces etc.). This is necessary for some interceptors e.g. GitHub for validating the body with a signature. While []byte can also store an exact representation of the body, json.Marshal will compact []byte to a base64 encoded string which means that we will lose the spaces any time we marshal this struct.

header
map[string][]string

Header are the headers for the incoming HTTP event

extensions
map[string]interface{}

Extensions are extra values that are added by previous interceptors in a chain

interceptor_params
map[string]interface{}

InterceptorParams are the user specified params for interceptor in the Trigger

context
TriggerContext

Context contains additional metadata about the event being processed

InterceptorResponse

Do not generate Deepcopy(). See #827

Field Description
extensions
map[string]interface{}

Extensions are additional fields that is added to the interceptor event.

continue
bool

Continue indicates if the EventListener should continue processing the Trigger or not

status
Status

Status is an Error status containing details on any interceptor processing errors

KubernetesResource

(Appears on:Resources)

Field Description
replicas
int32
serviceType
Kubernetes core/v1.ServiceType
servicePort
int32
spec
knative.dev/pkg/apis/duck/v1.WithPodSpec


template
knative.dev/pkg/apis/duck/v1.PodSpecable

NamespaceSelector

(Appears on:EventListenerSpec, EventListenerTriggerSelector)

NamespaceSelector is a selector for selecting either all namespaces or a list of namespaces.

Field Description
matchNames
[]string

List of namespace names.

Param

(Appears on:TriggerBindingSpec)

Param defines a string value to be used for a ParamSpec with the same name.

Field Description
name
string
value
string

ParamSpec

(Appears on:TriggerTemplateSpec)

ParamSpec defines an arbitrary named input whose value can be supplied by a Param.

Field Description
name
string

Name declares the name by which a parameter is referenced.

description
string
(Optional)

Description is a user-facing description of the parameter that may be used to populate a UI.

default
string
(Optional)

Default is the value a parameter takes if no input value via a Param is supplied.

PodTemplate

Field Description
tolerations
[]Kubernetes core/v1.Toleration
(Optional)

If specified, the pod’s tolerations.

nodeSelector
map[string]string
(Optional)

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

Resources

(Appears on:EventListenerSpec)

Field Description
kubernetesResource
KubernetesResource
customResource
CustomResource

SecretRef

(Appears on:BitbucketInterceptor, GitHubInterceptor, GitLabInterceptor)

SecretRef contains the information required to reference a single secret string This is needed because the other secretRef types are not cross-namespace and do not actually contain the “SecretName” field, which allows us to access a single secret value.

Field Description
secretKey
string
secretName
string

Status

(Appears on:InterceptorResponse, StatusError)

Field Description
code
google.golang.org/grpc/codes.Code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message
string

A developer-facing error message, which should be in English.

StatusError

Field Description
s
Status

TriggerBindingInterface

TriggerBindingInterface is implemented by TriggerBinding and ClusterTriggerBinding

TriggerBindingKind (string alias)

(Appears on:TriggerSpecBinding)

Check that EventListener may be validated and defaulted. TriggerBindingKind defines the type of TriggerBinding used by the EventListener.

Value Description

"ClusterTriggerBinding"

ClusterTriggerBindingKind indicates that triggerbinding type has a cluster scope.

"TriggerBinding"

NamespacedTriggerBindingKind indicates that triggerbinding type has a namespace scope.

TriggerBindingSpec

(Appears on:ClusterTriggerBinding, TriggerBinding)

TriggerBindingSpec defines the desired state of the TriggerBinding.

Field Description
params
[]Param

Params defines the parameter mapping from the given input event.

TriggerBindingStatus

(Appears on:ClusterTriggerBinding, TriggerBinding)

TriggerBindingStatus defines the observed state of TriggerBinding.

TriggerContext

(Appears on:InterceptorRequest)

Field Description
event_url
string

EventURL is the URL of the incoming event

event_id
string

EventID is a unique ID assigned by Triggers to each event

trigger_id
string

TriggerID is of the form namespace/$ns/triggers/$name

TriggerInterceptor

(Appears on:EventListenerTrigger, EventListenerTriggerGroup, TriggerSpec)

TriggerInterceptor provides a hook to intercept and pre-process events

Field Description
name
string

Optional name to identify the current interceptor configuration

ref
InterceptorRef

Ref refers to the Interceptor to use

params
[]InterceptorParams

Params are the params to send to the interceptor

webhook
WebhookInterceptor

WebhookInterceptor refers to an old style webhook interceptor service

TriggerResourceTemplate

(Appears on:TriggerTemplateSpec)

TriggerResourceTemplate describes a resource to create

Field Description
RawExtension
k8s.io/apimachinery/pkg/runtime.RawExtension

(Members of RawExtension are embedded into this type.)

TriggerSpec

(Appears on:Trigger)

TriggerSpec represents a connection between TriggerSpecBinding, and TriggerSpecTemplate; TriggerSpecBinding provides extracted values for TriggerSpecTemplate to then create resources from.

Field Description
bindings
[]TriggerSpecBinding
template
TriggerSpecTemplate
name
string
(Optional)
interceptors
[]TriggerInterceptor
serviceAccountName
string
(Optional)

ServiceAccountName optionally associates credentials with each trigger; Unlike EventListeners, this should be scoped to the same namespace as the Trigger itself

TriggerSpecBinding

(Appears on:EventListenerTrigger, TriggerSpec)

Field Description
name
string

Name is the name of the binding param Mutually exclusive with Ref

value
string

Value is the value of the binding param. Can contain JSONPath Has to be pointer since “” is a valid value Required if Name is also specified.

ref
string

Ref is a reference to a TriggerBinding kind. Mutually exclusive with Name

kind
TriggerBindingKind

Kind can only be provided if Ref is also provided. Defaults to TriggerBinding

apiversion
string

APIVersion of the binding ref

TriggerSpecTemplate

(Appears on:EventListenerTrigger, TriggerSpec)

Field Description
ref
string
apiversion
string
spec
TriggerTemplateSpec


TriggerTemplate

TriggerTemplate takes parameters and uses them to create CRDs

Field Description
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TriggerTemplateSpec
(Optional)

Spec holds the desired state of the TriggerTemplate from the client



params
[]ParamSpec
resourcetemplates
[]TriggerResourceTemplate
status
TriggerTemplateStatus
(Optional)

TriggerTemplateSpec

(Appears on:TriggerSpecTemplate, TriggerTemplate)

TriggerTemplateSpec holds the desired state of TriggerTemplate

Field Description
params
[]ParamSpec
resourcetemplates
[]TriggerResourceTemplate

TriggerTemplateStatus

(Appears on:TriggerTemplate)

TriggerTemplateStatus describes the desired state of TriggerTemplate

WebhookInterceptor

(Appears on:TriggerInterceptor)

WebhookInterceptor provides a webhook to intercept and pre-process events

Field Description
objectRef
Kubernetes core/v1.ObjectReference
(Optional)

ObjectRef is a reference to an object that will resolve to a cluster DNS name to use as the EventInterceptor. Either objectRef or url can be specified

url
knative.dev/pkg/apis.URL
(Optional)
header
[]github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1.Param

Header is a group of key-value pairs that can be appended to the interceptor request headers. This allows the interceptor to make decisions specific to an EventListenerTrigger.


Generated with gen-crd-api-reference-docs .