You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ServiceAccountName holds the name of the Kubernetes service account
as which the underlying K8s resources should be run. If unspecified
this will default to the “default” service account for the namespace
in which the GitHubSource exists.
ownerAndRepository
string
OwnerAndRepository is the GitHub owner/org and repository to
receive events from. The repository may be left off to receive
events from an entire organization.
Examples:
myuser/project
myorganization
GitHubSourceSpec defines the desired state of GitHubSource
Field
Description
serviceAccountName
string
(Optional)
ServiceAccountName holds the name of the Kubernetes service account
as which the underlying K8s resources should be run. If unspecified
this will default to the “default” service account for the namespace
in which the GitHubSource exists.
ownerAndRepository
string
OwnerAndRepository is the GitHub owner/org and repository to
receive events from. The repository may be left off to receive
events from an entire organization.
Examples:
myuser/project
myorganization
inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource’s current state.
webhookIDKey
string
WebhookIDKey is the ID of the webhook registered with GitHub
sinkUri
string
(Optional)
SinkURI is the current active sink URI that has been configured
for the GitHubSource.
Package v1alpha1 is the v1alpha1 version of the API.
Resource Types:
Channel
Channel is a skeleton type wrapping Subscribable in the manner we expect resource writers
defining compatible resources to embed it. We will typically use this type to deserialize
Channel ObjectReferences and access the Subscription data. This is not a real resource.
ChannelSubscriberSpec defines a single subscriber to a Channel.
Ref is a reference to the Subscription this ChannelSubscriberSpec was created for
SubscriberURI is the endpoint for the subscriber
ReplyURI is the endpoint for the reply
At least one of SubscriberURI and ReplyURI must be present
ChannelTemplate, if specified will be used to create all the Channels used internally by the
Broker. Only Provisioner and Arguments may be specified. If left unspecified, the default
Channel for the namespace will be used.
Status represents the current state of the Broker. This data may be out of
date.
Channel
Channel is an abstract resource that implements the Addressable contract.
The Provisioner provisions infrastructure to accepts events and
deliver to Subscriptions.
Reference to a channel that will be used to create the subscription
for receiving events. The channel must have spec.subscriptions
list which will then be modified accordingly.
You can specify only the following fields of the ObjectReference:
- Kind
- APIVersion
- Name
Kind must be “Channel” and APIVersion must be
“eventing.knative.dev/v1alpha1”
This field is immutable. We have no good answer on what happens to
the events that are currently in the channel being consumed from
and what the semantics there should be. For now, you can always
delete the Subscription and recreate it to point to a different
channel, giving the user more control over what semantics should
be used (drain the channel first, possibly have events dropped,
etc.)
Subscriber is reference to (optional) function for processing events.
Events from the Channel will be delivered here and replies are
sent to a channel as specified by the Reply.
Filter is the filter to apply against all events from the Broker. Only events that pass this
filter will be sent to the Subscriber. If not specified, will default to allowing all events.
ChannelTemplate, if specified will be used to create all the Channels used internally by the
Broker. Only Provisioner and Arguments may be specified. If left unspecified, the default
Channel for the namespace will be used.
inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource’s current state.
Broker is Addressable. It currently exposes the endpoint as a
fully-qualified DNS name which will distribute traffic over the
provided targets from inside the cluster.
It generally has the form {broker}-router.{namespace}.svc.{cluster domain name}
ChannelProvisionerDefaulter
ChannelProvisionerDefaulter sets the default Provisioner and Arguments on Channels that do not
specify any Provisioner.
inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource’s current state.
Channel is Addressable. It currently exposes the endpoint as a
fully-qualified DNS name which will distribute traffic over the
provided targets from inside the cluster.
It generally has the form {channel}.{namespace}.svc.{cluster domain name}
inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource’s current state.
You can specify only the following fields of the ObjectReference:
- Kind
- APIVersion
- Name
Kind must be “Channel” and APIVersion must be
“eventing.knative.dev/v1alpha1”
SubscriberSpec specifies the reference to an object that’s expected to
provide the resolved target of the action.
Currently we inspect the objects Status and see if there’s a predefined
Status field that we will then use to dispatch events to be processed by
the target. Currently must resolve to a k8s service.
Note that in the future we should try to utilize subresources (/resolve ?) to
make this cleaner, but CRDs do not support subresources yet, so we need
to rely on a specified Status field today. By relying on this behaviour
we can utilize a dynamic client instead of having to understand all
kinds of different types of objects. As long as they adhere to this
particular contract, they can be used as a Target.
This ensures that we can support external targets and for ease of use
we also allow for an URI to be specified.
There of course is also a requirement for the resolved SubscriberSpec to
behave properly at the data plane level.
TODO: Add a pointer to a real spec for this.
For now, this means: Receive an event payload, and respond with one of:
success and an optional response event, or failure.
Delivery failures may be retried by the channel
Reference to an object that will be used to find the target
endpoint, which should implement the Addressable duck type.
For example, this could be a reference to a Route resource
or a Knative Service resource.
TODO: Specify the required fields the target object must
have in the status.
You can specify only the following fields of the ObjectReference:
- Kind
- APIVersion
- Name
SubscriptionSpec specifies the Channel for incoming events, a Subscriber target
for processing those events and where to put the result of the processing. Only
From (where the events are coming from) is always required. You can optionally
only Process the events (results in no output events) by leaving out the Result.
You can also perform an identity transformation on the invoming events by leaving
out the Subscriber and only specifying Result.
The following are all valid specifications:
channel –[subscriber]–> reply
Sink, no outgoing events:
channel – subscriber
no-op function (identity transformation):
channel –> reply
Field
Description
generation
int64
(Optional)
TODO By enabling the status subresource metadata.generation should increment
thus making this property obsolete.
We should be able to drop this property with a CRD conversion webhook
in the future
Reference to a channel that will be used to create the subscription
for receiving events. The channel must have spec.subscriptions
list which will then be modified accordingly.
You can specify only the following fields of the ObjectReference:
- Kind
- APIVersion
- Name
Kind must be “Channel” and APIVersion must be
“eventing.knative.dev/v1alpha1”
This field is immutable. We have no good answer on what happens to
the events that are currently in the channel being consumed from
and what the semantics there should be. For now, you can always
delete the Subscription and recreate it to point to a different
channel, giving the user more control over what semantics should
be used (drain the channel first, possibly have events dropped,
etc.)
Subscriber is reference to (optional) function for processing events.
Events from the Channel will be delivered here and replies are
sent to a channel as specified by the Reply.
inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource’s current state.
TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and
source attributes. Only exact matches will pass the filter. Either or both type and source can
use the value ‘Any’ to indicate all strings match.
Filter is the filter to apply against all events from the Broker. Only events that pass this
filter will be sent to the Subscriber. If not specified, will default to allowing all events.
inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource’s current state.
subscriberURI
string
SubscriberURI is the resolved URI of the receiver for this Trigger.
sources.eventing.knative.dev
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
Sink is a reference to an object that will resolve to a domain name to use as the sink.
mode
string
Mode is the mode the receive adapter controller runs under: Ref or Resource.
Ref sends only the reference to the resource.
Resource send the full resource.
Sink is a reference to an object that will resolve to a domain name to use as the sink.
mode
string
Mode is the mode the receive adapter controller runs under: Ref or Resource.
Ref sends only the reference to the resource.
Resource send the full resource.
inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource’s current state.
sinkUri
string
(Optional)
SinkURI is the current active sink URI that has been configured for the ApiServerSource.
inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource’s current state.
sinkUri
string
(Optional)
SinkURI is the current active sink URI that has been configured for the ContainerSource.
inherits duck/v1alpha1 Status, which currently provides:
* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller.
* Conditions - the latest available observations of a resource’s current state.
sinkUri
string
(Optional)
SinkURI is the current active sink URI that has been configured for the CronJobSource.
Generated with gen-crd-api-reference-docs
on git commit e9e81345.
