Triggers API

Spec holds the desired state of the ClusterTriggerBinding from the client

Spec holds the desired state of the EventListener from the client

Spec holds the desired state of the Trigger

Spec holds the desired state of the TriggerBinding

CaBundle is a PEM encoded CA bundle which will be used to validate the clusterinterceptor server certificate

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

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

(Members of Status are embedded into this type.)

(Members of AddressStatus are embedded into this type.)

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

(Members of RawExtension are embedded into this type.)

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

(Members of Status are embedded into this type.)

(Members of AddressStatus are embedded into this type.)

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

Configuration stores configuration for the EventListener service

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

"ClusterInterceptor"

ClusterInterceptorKind indicates that Interceptor type has a cluster scope.

"NamespacedInterceptor"

NamespacedInterceptorKind indicated that interceptor has a namespaced scope

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

InterceptorKind indicates the kind of the Interceptor, namespaced or cluster scoped.

API version of the referent

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 are the headers for the incoming HTTP event

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

InterceptorParams are the user specified params for interceptor in the Trigger

Context contains additional metadata about the event being processed

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

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

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

(Members of Status are embedded into this type.)

(Members of AddressStatus are embedded into this type.)

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

List of namespace names.

Name declares the name by which a parameter is referenced.

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

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

Name is the name of the service

Namespace is the namespace of the service

Path is an optional URL path

Port is a valid port number

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

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

"ClusterTriggerBinding"

ClusterTriggerBindingKind indicates that triggerbinding type has a cluster scope.

"TriggerBinding"

NamespacedTriggerBindingKind indicates that triggerbinding type has a namespace scope.

Params defines the parameter mapping from the given input event.

EventURL is the URL of the incoming event

EventID is a unique ID assigned by Triggers to each event

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

Optional name to identify the current interceptor configuration

Ref refers to the Interceptor to use

Params are the params to send to the interceptor

WebhookInterceptor refers to an old style webhook interceptor service

Deprecated old fields below

(Members of RawExtension are embedded into this type.)

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

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

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 is a reference to a TriggerBinding kind. Mutually exclusive with Name

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

APIVersion of the binding ref

Spec holds the desired state of the TriggerTemplate from the client

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

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.

Spec holds the desired state of the ClusterTriggerBinding from the client

Spec holds the desired state of the EventListener from the client

Spec holds the desired state of the Trigger

Spec holds the desired state of the TriggerBinding

"all"

Set the checkType to all if both repo members or org members can submit or comment on PR to proceed

"none"

Set the checkType to none if neither of repo members or org members can not submit or comment on PR to proceed

"orgMembers"

Set the checkType to orgMembers to allow org members to submit or comment on PR to proceed

"repoMembers"

Set the checkType to repoMembers to allow repo members to submit or comment on PR to proceed

(Members of RawExtension are embedded into this type.)

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

Trigger groups allow for centralized processing of an interceptor chain

(Members of Status are embedded into this type.)

(Members of AddressStatus are embedded into this type.)

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

Configuration stores configuration for the EventListener service

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

This param/variable is required for private repos or when checkType is set to orgMembers or repoMembers or all

Set the value to one of the supported values (orgMembers, repoMembers, both, none)

"ClusterInterceptor"

ClusterInterceptorKind indicates that Interceptor type has a cluster scope.

"NamespacedInterceptor"

NamespacedInterceptorKind indicates that Interceptor type has a namespace scope.

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

InterceptorKind indicates the kind of the Interceptor, namespaced or cluster scoped.

API version of the referent

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 are the headers for the incoming HTTP event

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

InterceptorParams are the user specified params for interceptor in the Trigger

Context contains additional metadata about the event being processed

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

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

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

List of namespace names.

Name declares the name by which a parameter is referenced.

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

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

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

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

"ClusterTriggerBinding"

ClusterTriggerBindingKind indicates that triggerbinding type has a cluster scope.

"TriggerBinding"

NamespacedTriggerBindingKind indicates that triggerbinding type has a namespace scope.

Params defines the parameter mapping from the given input event.

EventURL is the URL of the incoming event

EventID is a unique ID assigned by Triggers to each event

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

Optional name to identify the current interceptor configuration

Ref refers to the Interceptor to use

Params are the params to send to the interceptor

WebhookInterceptor refers to an old style webhook interceptor service

(Members of RawExtension are embedded into this type.)

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

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

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 is a reference to a TriggerBinding kind. Mutually exclusive with Name

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

APIVersion of the binding ref

Spec holds the desired state of the TriggerTemplate from the client

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

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.