Triggers API
Packages:
triggers.tekton.dev/v1alpha1
Package v1alpha1 contains API Schema definitions for the triggers v1alpha1 API group
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 | ||
|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1alpha1
|
||
kindstring |
ClusterTriggerBinding |
||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||
specTriggerBindingSpec |
(Optional)
Spec holds the desired state of the ClusterTriggerBinding from the client
|
||
statusTriggerBindingStatus |
(Optional) |
EventListener
EventListener exposes a service to accept HTTP event payloads.
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1alpha1
|
||||||||||
kindstring |
EventListener |
||||||||||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
specEventListenerSpec |
(Optional)
Spec holds the desired state of the EventListener from the client
|
||||||||||
statusEventListenerStatus |
(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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1alpha1
|
||||||||||
kindstring |
Trigger |
||||||||||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
specTriggerSpec |
(Optional)
Spec holds the desired state of the Trigger
|
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 | ||
|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1alpha1
|
||
kindstring |
TriggerBinding |
||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||
specTriggerBindingSpec |
(Optional)
Spec holds the desired state of the TriggerBinding
|
||
statusTriggerBindingStatus |
(Optional) |
TriggerTemplate
TriggerTemplate takes parameters and uses them to create CRDs
| Field | Description | ||||
|---|---|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1alpha1
|
||||
kindstring |
TriggerTemplate |
||||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
specTriggerTemplateSpec |
(Optional)
Spec holds the desired state of the TriggerTemplate from the client
|
||||
statusTriggerTemplateStatus |
(Optional) |
BitbucketInterceptor
(Appears on:TriggerInterceptor)
BitbucketInterceptor provides a webhook to intercept and pre-process events
| Field | Description |
|---|---|
secretRefSecretRef |
|
eventTypes[]string |
CELInterceptor
(Appears on:TriggerInterceptor)
CELInterceptor provides a webhook to intercept and pre-process events
| Field | Description |
|---|---|
filterstring |
|
overlays[]CELOverlay |
CELOverlay
(Appears on:CELInterceptor)
CELOverlay provides a way to modify the request body using DeprecatedCEL expressions
| Field | Description |
|---|---|
keystring |
|
expressionstring |
ClientConfig
(Appears on:ClusterInterceptorSpec, InterceptorSpec)
ClientConfig describes how a client can communicate with the Interceptor
| Field | Description |
|---|---|
caBundle[]byte |
CaBundle is a PEM encoded CA bundle which will be used to validate the clusterinterceptor server certificate |
urlknative.dev/pkg/apis.URL |
URL is a fully formed URL pointing to the interceptor Mutually exclusive with Service |
serviceServiceReference |
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 | ||
|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||
specClusterInterceptorSpec |
|
||
statusClusterInterceptorStatus |
(Optional) |
ClusterInterceptorSpec
(Appears on:ClusterInterceptor)
ClusterInterceptorSpec describes the Spec for an ClusterInterceptor
| Field | Description |
|---|---|
clientConfigClientConfig |
ClusterInterceptorStatus
(Appears on:ClusterInterceptor)
ClusterInterceptorStatus holds the status of the ClusterInterceptor
| Field | Description |
|---|---|
Statusknative.dev/pkg/apis/duck/v1.Status |
(Members of |
AddressStatusknative.dev/pkg/apis/duck/v1.AddressStatus |
(Members of ClusterInterceptor is Addressable and exposes the URL where the Interceptor is running |
CustomResource
(Appears on:Resources)
| Field | Description |
|---|---|
RawExtensionk8s.io/apimachinery/pkg/runtime.RawExtension |
(Members of |
EventListenerConfig
(Appears on:EventListenerStatus)
EventListenerConfig stores configuration for resources generated by the EventListener
| Field | Description |
|---|---|
generatedNamestring |
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 |
|---|---|
serviceAccountNamestring |
|
triggers[]EventListenerTrigger |
|
namespaceSelectorNamespaceSelector |
|
labelSelectorKubernetes meta/v1.LabelSelector |
|
resourcesResources |
EventListenerStatus
(Appears on:EventListener)
EventListenerStatus holds the status of the EventListener
| Field | Description |
|---|---|
Statusknative.dev/pkg/apis/duck/v1.Status |
(Members of |
AddressStatusknative.dev/pkg/apis/duck/v1alpha1.AddressStatus |
(Members of EventListener is Addressable. It currently exposes the service DNS address of the the EventListener sink |
configurationEventListenerConfig |
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 |
|
templateTriggerSpecTemplate |
|
triggerRefstring |
|
namestring |
(Optional) |
interceptors[]TriggerInterceptor |
|
serviceAccountNamestring |
(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 |
|---|---|
secretRefSecretRef |
|
eventTypes[]string |
GitLabInterceptor
(Appears on:TriggerInterceptor)
GitLabInterceptor provides a webhook to intercept and pre-process events
| Field | Description |
|---|---|
secretRefSecretRef |
|
eventTypes[]string |
Interceptor
Interceptor 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 | ||
|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||
specInterceptorSpec |
|
||
statusInterceptorStatus |
(Optional) |
InterceptorInterface
InterceptorKind
(string alias)
(Appears on:InterceptorRef)
InterceptorKind defines the type of Interceptor used by the Trigger.
| Value | Description |
|---|---|
"ClusterInterceptor" |
ClusterInterceptorKind indicates that Interceptor type has a cluster scope. |
"NamespacedInterceptor" |
NamespacedInterceptorKind indicated that interceptor has a namespaced scope |
InterceptorParams
(Appears on:TriggerInterceptor)
InterceptorParams defines a key-value pair that can be passed on an interceptor
| Field | Description |
|---|---|
namestring |
|
valuek8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
InterceptorRef
(Appears on:TriggerInterceptor)
InterceptorRef provides a Reference to a ClusterInterceptor
| Field | Description |
|---|---|
namestring |
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |
kindInterceptorKind |
(Optional)
InterceptorKind indicates the kind of the Interceptor, namespaced or cluster scoped. |
apiVersionstring |
(Optional)
API version of the referent |
InterceptorRequest
Do not generate DeepCopy(). See #827
| Field | Description |
|---|---|
bodystring |
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, |
headermap[string][]string |
Header are the headers for the incoming HTTP event |
extensionsmap[string]interface{} |
Extensions are extra values that are added by previous interceptors in a chain |
interceptor_paramsmap[string]interface{} |
InterceptorParams are the user specified params for interceptor in the Trigger |
contextTriggerContext |
Context contains additional metadata about the event being processed |
InterceptorResponse
Do not generate Deepcopy(). See #827
| Field | Description |
|---|---|
extensionsmap[string]interface{} |
Extensions are additional fields that is added to the interceptor event. |
continuebool |
Continue indicates if the EventListener should continue processing the Trigger or not |
statusStatus |
Status is an Error status containing details on any interceptor processing errors |
InterceptorSpec
(Appears on:Interceptor)
InterceptorSpec describes the Spec for an Interceptor
| Field | Description |
|---|---|
clientConfigClientConfig |
InterceptorStatus
(Appears on:Interceptor)
InterceptorStatus holds the status of the Interceptor
| Field | Description |
|---|---|
Statusknative.dev/pkg/apis/duck/v1.Status |
(Members of |
AddressStatusknative.dev/pkg/apis/duck/v1.AddressStatus |
(Members of Interceptor is Addressable and exposes the URL where the Interceptor is running |
KubernetesResource
(Appears on:Resources)
| Field | Description | ||
|---|---|---|---|
replicasint32 |
|||
serviceTypeKubernetes core/v1.ServiceType |
|||
specknative.dev/pkg/apis/duck/v1.WithPodSpec |
|
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 |
|---|---|
namestring |
|
valuestring |
ParamSpec
(Appears on:TriggerTemplateSpec)
ParamSpec defines an arbitrary named input whose value can be supplied by a
Param.
| Field | Description |
|---|---|
namestring |
Name declares the name by which a parameter is referenced. |
descriptionstring |
(Optional)
Description is a user-facing description of the parameter that may be used to populate a UI. |
defaultstring |
(Optional)
Default is the value a parameter takes if no input value via a Param is supplied. |
Resources
(Appears on:EventListenerSpec)
| Field | Description |
|---|---|
kubernetesResourceKubernetesResource |
|
customResourceCustomResource |
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 |
|---|---|
secretKeystring |
|
secretNamestring |
ServiceReference
(Appears on:ClientConfig)
ServiceReference is a reference to a Service object with an optional path
| Field | Description |
|---|---|
namestring |
Name is the name of the service |
namespacestring |
Namespace is the namespace of the service |
pathstring |
(Optional)
Path is an optional URL path |
portint32 |
Port is a valid port number |
Status
(Appears on:InterceptorResponse, StatusError)
| Field | Description |
|---|---|
codegoogle.golang.org/grpc/codes.Code |
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. |
messagestring |
A developer-facing error message, which should be in English. |
StatusError
| Field | Description |
|---|---|
sStatus |
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_urlstring |
EventURL is the URL of the incoming event |
event_idstring |
EventID is a unique ID assigned by Triggers to each event |
trigger_idstring |
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 |
|---|---|
namestring |
Optional name to identify the current interceptor configuration |
refInterceptorRef |
Ref refers to the Interceptor to use |
params[]InterceptorParams |
Params are the params to send to the interceptor |
webhookWebhookInterceptor |
WebhookInterceptor refers to an old style webhook interceptor service |
githubGitHubInterceptor |
Deprecated old fields below |
gitlabGitLabInterceptor |
|
celCELInterceptor |
|
bitbucketBitbucketInterceptor |
TriggerResourceTemplate
(Appears on:TriggerTemplateSpec)
TriggerResourceTemplate describes a resource to create
| Field | Description |
|---|---|
RawExtensionk8s.io/apimachinery/pkg/runtime.RawExtension |
(Members of |
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 |
|
templateTriggerSpecTemplate |
|
namestring |
(Optional) |
interceptors[]TriggerInterceptor |
|
serviceAccountNamestring |
(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 |
|---|---|
namestring |
Name is the name of the binding param Mutually exclusive with Ref |
valuestring |
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. |
refstring |
Ref is a reference to a TriggerBinding kind. Mutually exclusive with Name |
kindTriggerBindingKind |
Kind can only be provided if Ref is also provided. Defaults to TriggerBinding |
apiversionstring |
APIVersion of the binding ref |
TriggerSpecTemplate
(Appears on:EventListenerTrigger, TriggerSpec)
| Field | Description |
|---|---|
refstring |
|
apiversionstring |
|
specTriggerTemplateSpec |
|
TriggerTemplateSpec
(Appears on:TriggerTemplate, TriggerSpecTemplate)
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 |
|---|---|
objectRefKubernetes 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 |
urlknative.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
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 | ||
|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1beta1
|
||
kindstring |
ClusterTriggerBinding |
||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||
specTriggerBindingSpec |
(Optional)
Spec holds the desired state of the ClusterTriggerBinding from the client
|
||
statusTriggerBindingStatus |
(Optional) |
EventListener
EventListener exposes a service to accept HTTP event payloads.
| Field | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1beta1
|
||||||||||||||
kindstring |
EventListener |
||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
specEventListenerSpec |
(Optional)
Spec holds the desired state of the EventListener from the client
|
||||||||||||||
statusEventListenerStatus |
(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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1beta1
|
||||||||||
kindstring |
Trigger |
||||||||||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
specTriggerSpec |
(Optional)
Spec holds the desired state of the Trigger
|
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 | ||
|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1beta1
|
||
kindstring |
TriggerBinding |
||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||
specTriggerBindingSpec |
(Optional)
Spec holds the desired state of the TriggerBinding
|
||
statusTriggerBindingStatus |
(Optional) |
TriggerTemplate
TriggerTemplate takes parameters and uses them to create CRDs
| Field | Description | ||||
|---|---|---|---|---|---|
apiVersionstring |
triggers.tekton.dev/v1beta1
|
||||
kindstring |
TriggerTemplate |
||||
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
specTriggerTemplateSpec |
(Optional)
Spec holds the desired state of the TriggerTemplate from the client
|
||||
statusTriggerTemplateStatus |
(Optional) |
CustomResource
(Appears on:Resources)
| Field | Description |
|---|---|
RawExtensionk8s.io/apimachinery/pkg/runtime.RawExtension |
(Members of |
EventListenerConfig
(Appears on:EventListenerStatus)
EventListenerConfig stores configuration for resources generated by the EventListener
| Field | Description |
|---|---|
generatedNamestring |
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 |
|---|---|
serviceAccountNamestring |
|
triggers[]EventListenerTrigger |
|
triggerGroups[]EventListenerTriggerGroup |
Trigger groups allow for centralized processing of an interceptor chain |
namespaceSelectorNamespaceSelector |
|
labelSelectorKubernetes meta/v1.LabelSelector |
|
resourcesResources |
|
cloudEventURIstring |
EventListenerStatus
(Appears on:EventListener)
EventListenerStatus holds the status of the EventListener
| Field | Description |
|---|---|
Statusknative.dev/pkg/apis/duck/v1.Status |
(Members of |
AddressStatusknative.dev/pkg/apis/duck/v1beta1.AddressStatus |
(Members of EventListener is Addressable. It currently exposes the service DNS address of the the EventListener sink |
configurationEventListenerConfig |
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 |
|
templateTriggerSpecTemplate |
|
triggerRefstring |
|
namestring |
(Optional) |
interceptors[]TriggerInterceptor |
|
serviceAccountNamestring |
(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 |
|---|---|
namestring |
|
interceptors[]TriggerInterceptor |
|
triggerSelectorEventListenerTriggerSelector |
EventListenerTriggerSelector
(Appears on:EventListenerTriggerGroup)
EventListenerTriggerSelector defines ways to select a group of triggers using their metadata
| Field | Description |
|---|---|
namespaceSelectorNamespaceSelector |
|
labelSelectorKubernetes meta/v1.LabelSelector |
InterceptorInterface
InterceptorKind
(string alias)
(Appears on:InterceptorRef)
InterceptorKind defines the type of Interceptor used by the Trigger.
| Value | Description |
|---|---|
"ClusterInterceptor" |
ClusterInterceptorKind indicates that Interceptor type has a cluster scope. |
"NamespacedInterceptor" |
NamespacedInterceptorKind indicates that Interceptor type has a namespace scope. |
InterceptorParams
(Appears on:TriggerInterceptor)
InterceptorParams defines a key-value pair that can be passed on an interceptor
| Field | Description |
|---|---|
namestring |
|
valuek8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
InterceptorRef
(Appears on:TriggerInterceptor)
InterceptorRef provides a Reference to a ClusterInterceptor
| Field | Description |
|---|---|
namestring |
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |
kindInterceptorKind |
(Optional)
InterceptorKind indicates the kind of the Interceptor, namespaced or cluster scoped. |
apiVersionstring |
(Optional)
API version of the referent |
InterceptorRequest
Do not generate DeepCopy(). See #827
| Field | Description |
|---|---|
bodystring |
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, |
headermap[string][]string |
Header are the headers for the incoming HTTP event |
extensionsmap[string]interface{} |
Extensions are extra values that are added by previous interceptors in a chain |
interceptor_paramsmap[string]interface{} |
InterceptorParams are the user specified params for interceptor in the Trigger |
contextTriggerContext |
Context contains additional metadata about the event being processed |
InterceptorResponse
Do not generate Deepcopy(). See #827
| Field | Description |
|---|---|
extensionsmap[string]interface{} |
Extensions are additional fields that is added to the interceptor event. |
continuebool |
Continue indicates if the EventListener should continue processing the Trigger or not |
statusStatus |
Status is an Error status containing details on any interceptor processing errors |
KubernetesResource
(Appears on:Resources)
| Field | Description | ||
|---|---|---|---|
replicasint32 |
|||
serviceTypeKubernetes core/v1.ServiceType |
|||
servicePortint32 |
|||
serviceLoadBalancerClassstring |
|||
specknative.dev/pkg/apis/duck/v1.WithPodSpec |
|
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 |
|---|---|
namestring |
|
valuestring |
ParamSpec
(Appears on:TriggerTemplateSpec)
ParamSpec defines an arbitrary named input whose value can be supplied by a
Param.
| Field | Description |
|---|---|
namestring |
Name declares the name by which a parameter is referenced. |
descriptionstring |
(Optional)
Description is a user-facing description of the parameter that may be used to populate a UI. |
defaultstring |
(Optional)
Default is the value a parameter takes if no input value via a Param is supplied. |
Resources
(Appears on:EventListenerSpec)
| Field | Description |
|---|---|
kubernetesResourceKubernetesResource |
|
customResourceCustomResource |
SecretRef
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 |
|---|---|
secretKeystring |
|
secretNamestring |
Status
(Appears on:InterceptorResponse, StatusError)
| Field | Description |
|---|---|
codegoogle.golang.org/grpc/codes.Code |
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. |
messagestring |
A developer-facing error message, which should be in English. |
StatusError
| Field | Description |
|---|---|
sStatus |
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_urlstring |
EventURL is the URL of the incoming event |
event_idstring |
EventID is a unique ID assigned by Triggers to each event |
trigger_idstring |
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 |
|---|---|
namestring |
Optional name to identify the current interceptor configuration |
refInterceptorRef |
Ref refers to the Interceptor to use |
params[]InterceptorParams |
Params are the params to send to the interceptor |
webhookWebhookInterceptor |
WebhookInterceptor refers to an old style webhook interceptor service |
TriggerResourceTemplate
(Appears on:TriggerTemplateSpec)
TriggerResourceTemplate describes a resource to create
| Field | Description |
|---|---|
RawExtensionk8s.io/apimachinery/pkg/runtime.RawExtension |
(Members of |
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 |
|
templateTriggerSpecTemplate |
|
namestring |
(Optional) |
interceptors[]TriggerInterceptor |
|
serviceAccountNamestring |
(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 |
|---|---|
namestring |
Name is the name of the binding param Mutually exclusive with Ref |
valuestring |
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. |
refstring |
Ref is a reference to a TriggerBinding kind. Mutually exclusive with Name |
kindTriggerBindingKind |
Kind can only be provided if Ref is also provided. Defaults to TriggerBinding |
apiversionstring |
APIVersion of the binding ref |
TriggerSpecTemplate
(Appears on:EventListenerTrigger, TriggerSpec)
| Field | Description |
|---|---|
refstring |
|
apiversionstring |
|
specTriggerTemplateSpec |
|
TriggerTemplateSpec
(Appears on:TriggerTemplate, TriggerSpecTemplate)
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 |
|---|---|
objectRefKubernetes 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 |
urlknative.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
.
Feedback
Was this page helpful?