Knative Eventing Component

Packages:

duck.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

Channelable

Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers defining compatible resources to embed it. We will typically use this type to deserialize Channelable ObjectReferences and access their subscription and address data. This is not a real resource.

Field Description
apiVersion
string
duck.knative.dev/v1alpha1
kind
string
Channelable
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ChannelableSpec

Spec is the part where the Channelable fulfills the Subscribable contract.



SubscribableTypeSpec
SubscribableTypeSpec

(Members of SubscribableTypeSpec are embedded into this type.)

status
ChannelableStatus

SubscribableType

SubscribableType 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 SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.

Field Description
apiVersion
string
duck.knative.dev/v1alpha1
kind
string
SubscribableType
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SubscribableTypeSpec

SubscribableTypeSpec is the part where Subscribable object is configured as to be compatible with Subscribable contract.



subscribable
Subscribable
status
SubscribableTypeStatus

SubscribableTypeStatus is the part where SubscribableStatus object is configured as to be compatible with Subscribable contract.

ChannelableSpec

(Appears on: Channelable)

ChannelableSpec contains Spec of the Channelable object

Field Description
SubscribableTypeSpec
SubscribableTypeSpec

(Members of SubscribableTypeSpec are embedded into this type.)

ChannelableStatus

(Appears on: Channelable)

ChannelableStatus contains the Status of a Channelable object.

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.

AddressStatus
github.com/knative/pkg/apis/duck/v1alpha1.AddressStatus

(Members of AddressStatus are embedded into this type.)

AddressStatus is the part where the Channelable fulfills the Addressable contract.

SubscribableTypeStatus
SubscribableTypeStatus

(Members of SubscribableTypeStatus are embedded into this type.)

Subscribers is populated with the statuses of each of the Channelable’s subscribers.

Subscribable

(Appears on: ChannelSpec, InMemoryChannelSpec, SubscribableTypeSpec)

Subscribable is the schema for the subscribable portion of the spec section of the resource.

Field Description
subscribers
[]SubscriberSpec

This is the list of subscriptions for this subscribable.

SubscribableStatus

(Appears on: SubscribableTypeStatus)

SubscribableStatus is the schema for the subscribable’s status portion of the status section of the resource.

Field Description
subscribers
[]SubscriberStatus

This is the list of subscription’s statuses for this channel.

SubscribableTypeSpec

(Appears on: SubscribableType, ChannelableSpec)

SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.

Field Description
subscribable
Subscribable

SubscribableTypeStatus

(Appears on: SubscribableType, ChannelStatus, ChannelableStatus, InMemoryChannelStatus)

SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.

Field Description
subscribablestatus
SubscribableStatus

SubscriberSpec

(Appears on: Subscribable)

SubscriberSpec defines a single subscriber to a Subscribable. Ref is a reference to the Subscription this SubscriberSpec 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

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

Deprecated: use UID.

uid
k8s.io/apimachinery/pkg/types.UID
(Optional)

UID is used to understand the origin of the subscriber.

generation
int64
(Optional)

Generation of the origin of the subscriber with uid:UID.

subscriberURI
string
(Optional)
replyURI
string
(Optional)

SubscriberStatus

(Appears on: SubscribableStatus)

SubscriberStatus defines the status of a single subscriber to a Channel.

Field Description
uid
k8s.io/apimachinery/pkg/types.UID
(Optional)

UID is used to understand the origin of the subscriber.

observedGeneration
int64
(Optional)

Generation of the origin of the subscriber with uid:UID.

ready
Kubernetes core/v1.ConditionStatus
(Optional)

Status of the subscriber.

message
string
(Optional)

A human readable message indicating details of Ready status.


eventing.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

Broker

Broker collects a pool of events that are consumable using Triggers. Brokers provide a well-known endpoint for event delivery that senders can use with minimal knowledge of the event routing strategy. Receivers use Triggers to request delivery of events from a Broker’s pool to a specific URL or Addressable endpoint.

Field Description
apiVersion
string
eventing.knative.dev/v1alpha1
kind
string
Broker
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
BrokerSpec

Spec defines the desired state of the Broker.



channelTemplate
ChannelSpec
(Optional)

DeprecatedChannelTemplate, 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.

channelTemplateSpec
ChannelTemplateSpec

ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the Broker.

status
BrokerStatus
(Optional)

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.

Field Description
apiVersion
string
eventing.knative.dev/v1alpha1
kind
string
Channel
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ChannelSpec

Spec defines the desired state of the Channel.



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

provisioner
Kubernetes core/v1.ObjectReference

Provisioner defines the name of the Provisioner backing this channel.

arguments
k8s.io/apimachinery/pkg/runtime.RawExtension
(Optional)

Arguments defines the arguments to pass to the Provisioner which provisions this Channel.

subscribable
Subscribable

Channel conforms to Duck type Subscribable.

status
ChannelStatus
(Optional)

Status represents the current state of the Channel. This data may be out of date.

ClusterChannelProvisioner

ClusterChannelProvisioner encapsulates a provisioning strategy for the backing resources required to realize a particular resource type.

Field Description
apiVersion
string
eventing.knative.dev/v1alpha1
kind
string
ClusterChannelProvisioner
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ClusterChannelProvisionerSpec

Spec defines the Types provisioned by this Provisioner.



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

status
ClusterChannelProvisionerStatus
(Optional)

Status is the current status of the Provisioner.

EventType

Field Description
apiVersion
string
eventing.knative.dev/v1alpha1
kind
string
EventType
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
EventTypeSpec

Spec defines the desired state of the EventType.



type
string

Type represents the CloudEvents type. It is authoritative.

source
string

Source is a URI, it represents the CloudEvents source.

schema
string
(Optional)

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. It may be a JSON schema, a protobuf schema, etc. It is optional.

broker
string

Broker refers to the Broker that can provide the EventType.

description
string
(Optional)

Description is an optional field used to describe the EventType, in any meaningful way.

status
EventTypeStatus
(Optional)

Status represents the current state of the EventType. This data may be out of date.

Subscription

Subscription routes events received on a Channel to a DNS name and corresponds to the subscriptions.channels.knative.dev CRD.

Field Description
apiVersion
string
eventing.knative.dev/v1alpha1
kind
string
Subscription
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SubscriptionSpec


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

channel
Kubernetes core/v1.ObjectReference

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
SubscriberSpec
(Optional)

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.

reply
ReplyStrategy
(Optional)

Reply specifies (optionally) how to handle events returned from the Subscriber target.

status
SubscriptionStatus

Trigger

Trigger represents a request to have events delivered to a consumer from a Broker’s event pool.

Field Description
apiVersion
string
eventing.knative.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

Spec defines the desired state of the Trigger.



broker
string

Broker is the broker that this trigger receives events from. If not specified, will default to ‘default’.

filter
TriggerFilter
(Optional)

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.

subscriber
SubscriberSpec

Subscriber is the addressable that receives events from the Broker that pass the Filter. It is required.

status
TriggerStatus
(Optional)

Status represents the current state of the Trigger. This data may be out of date.

BrokerSpec

(Appears on: Broker)

Field Description
channelTemplate
ChannelSpec
(Optional)

DeprecatedChannelTemplate, 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.

channelTemplateSpec
ChannelTemplateSpec

ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the Broker.

BrokerStatus

(Appears on: Broker)

BrokerStatus represents the current state of a Broker.

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.

address
github.com/knative/pkg/apis/duck/v1alpha1.Addressable

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}

triggerChannel
Kubernetes core/v1.ObjectReference

TriggerChannel is an objectref to the object for the TriggerChannel

IngressChannel
Kubernetes core/v1.ObjectReference

IngressChannel is an objectref to the object for the IngressChannel

ChannelProvisionerDefaulter

ChannelProvisionerDefaulter sets the default Provisioner and Arguments on Channels that do not specify any Provisioner.

ChannelSpec

(Appears on: Channel, BrokerSpec)

ChannelSpec specifies the Provisioner backing a channel and the configuration arguments for a Channel.

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

provisioner
Kubernetes core/v1.ObjectReference

Provisioner defines the name of the Provisioner backing this channel.

arguments
k8s.io/apimachinery/pkg/runtime.RawExtension
(Optional)

Arguments defines the arguments to pass to the Provisioner which provisions this Channel.

subscribable
Subscribable

Channel conforms to Duck type Subscribable.

ChannelStatus

(Appears on: Channel)

ChannelStatus represents the current state of a Channel.

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.

address
github.com/knative/pkg/apis/duck/v1alpha1.Addressable

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}

internal
k8s.io/apimachinery/pkg/runtime.RawExtension
(Optional)

Internal is status unique to each ClusterChannelProvisioner.

SubscribableTypeStatus
SubscribableTypeStatus

(Members of SubscribableTypeStatus are embedded into this type.)

ChannelTemplateSpec

(Appears on: BrokerSpec)

This should be duck so that Broker can also use this

Field Description
spec
k8s.io/apimachinery/pkg/runtime.RawExtension
(Optional)

Spec defines the Spec to use for each channel created. Passed in verbatim to the Channel CRD as Spec section.



Raw
[]byte

Raw is the underlying serialization of this object.

TODO: Determine how to detect ContentType and ContentEncoding of ‘Raw’ data.

-
k8s.io/apimachinery/pkg/runtime.Object

Object can hold a representation of this extension - useful for working with versioned structs.

ChannelTemplateSpecInternal

Internal version of ChannelTemplateSpec that includes ObjectMeta so that we can easily create new Channels off of it.

Field Description
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
k8s.io/apimachinery/pkg/runtime.RawExtension
(Optional)

Spec defines the Spec to use for each channel created. Passed in verbatim to the Channel CRD as Spec section.



Raw
[]byte

Raw is the underlying serialization of this object.

TODO: Determine how to detect ContentType and ContentEncoding of ‘Raw’ data.

-
k8s.io/apimachinery/pkg/runtime.Object

Object can hold a representation of this extension - useful for working with versioned structs.

ClusterChannelProvisionerSpec

(Appears on: ClusterChannelProvisioner)

ClusterChannelProvisionerSpec is the spec for a ClusterChannelProvisioner resource.

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

ClusterChannelProvisionerStatus

(Appears on: ClusterChannelProvisioner)

ClusterChannelProvisionerStatus is the status for a ClusterChannelProvisioner resource

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.

EventTypeSpec

(Appears on: EventType)

Field Description
type
string

Type represents the CloudEvents type. It is authoritative.

source
string

Source is a URI, it represents the CloudEvents source.

schema
string
(Optional)

Schema is a URI, it represents the CloudEvents schemaurl extension attribute. It may be a JSON schema, a protobuf schema, etc. It is optional.

broker
string

Broker refers to the Broker that can provide the EventType.

description
string
(Optional)

Description is an optional field used to describe the EventType, in any meaningful way.

EventTypeStatus

(Appears on: EventType)

EventTypeStatus represents the current state of a EventType.

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.

HasSpec

ReplyStrategy

(Appears on: SubscriptionSpec)

ReplyStrategy specifies the handling of the SubscriberSpec’s returned replies. If no SubscriberSpec is specified, the identity function is assumed.

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

You can specify only the following fields of the ObjectReference: - Kind - APIVersion - Name The resource pointed by this ObjectReference must meet the Addressable contract with a reference to the Addressable duck type. If the resource does not meet this contract, it will be reflected in the Subscription’s status.

SubscriberSpec

(Appears on: SequenceSpec, SubscriptionSpec, TriggerSpec)

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

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

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

dnsName
string
(Optional)

Deprecated: Use URI instead. Reference to a ‘known’ endpoint where no resolving is done. http://k8s-service for example http://myexternalhandler.example.com/foo/bar

uri
string
(Optional)

Reference to a ‘known’ endpoint where no resolving is done. http://k8s-service for example http://myexternalhandler.example.com/foo/bar

SubscriptionSpec

(Appears on: Subscription)

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 incoming 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

channel
Kubernetes core/v1.ObjectReference

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
SubscriberSpec
(Optional)

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.

reply
ReplyStrategy
(Optional)

Reply specifies (optionally) how to handle events returned from the Subscriber target.

SubscriptionStatus

(Appears on: Subscription)

SubscriptionStatus (computed) for a subscription

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.

physicalSubscription
SubscriptionStatusPhysicalSubscription

PhysicalSubscription is the fully resolved values that this Subscription represents.

SubscriptionStatusPhysicalSubscription

(Appears on: SubscriptionStatus)

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this Subscription.

Field Description
subscriberURI
string

SubscriberURI is the fully resolved URI for spec.subscriber.

replyURI
string

ReplyURI is the fully resolved URI for the spec.reply.

TriggerFilter

(Appears on: TriggerSpec)

Field Description
sourceAndType
TriggerFilterSourceAndType

TriggerFilterSourceAndType

(Appears on: TriggerFilter)

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.

Field Description
type
string
source
string

TriggerSpec

(Appears on: Trigger)

Field Description
broker
string

Broker is the broker that this trigger receives events from. If not specified, will default to ‘default’.

filter
TriggerFilter
(Optional)

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.

subscriber
SubscriberSpec

Subscriber is the addressable that receives events from the Broker that pass the Filter. It is required.

TriggerStatus

(Appears on: Trigger)

TriggerStatus represents the current state of a Trigger.

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.


messaging.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

InMemoryChannel

InMemoryChannel is a resource representing an in memory channel

Field Description
apiVersion
string
messaging.knative.dev/v1alpha1
kind
string
InMemoryChannel
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
InMemoryChannelSpec

Spec defines the desired state of the Channel.



subscribable
Subscribable

Channel conforms to Duck type Subscribable.

status
InMemoryChannelStatus
(Optional)

Status represents the current state of the Channel. This data may be out of date.

ChannelTemplateSpec

(Appears on: SequenceSpec)

This should be duck so that Broker can also use this

Field Description
spec
k8s.io/apimachinery/pkg/runtime.RawExtension
(Optional)

Spec defines the Spec to use for each channel created. Passed in verbatim to the Channel CRD as Spec section.



ChannelTemplateSpecInternal

Internal version of ChannelTemplateSpec that includes ObjectMeta so that we can easily create new Channels off of it.

Field Description
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
k8s.io/apimachinery/pkg/runtime.RawExtension
(Optional)

Spec defines the Spec to use for each channel created. Passed in verbatim to the Channel CRD as Spec section.



InMemoryChannelSpec

(Appears on: InMemoryChannel)

InMemoryChannelSpec defines which subscribers have expressed interest in receiving events from this InMemoryChannel. arguments for a Channel.

Field Description
subscribable
Subscribable

Channel conforms to Duck type Subscribable.

InMemoryChannelStatus

(Appears on: InMemoryChannel)

ChannelStatus represents the current state of a Channel.

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.

AddressStatus
github.com/knative/pkg/apis/duck/v1alpha1.AddressStatus

(Members of AddressStatus are embedded into this type.)

InMemoryChannel 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}

SubscribableTypeStatus
SubscribableTypeStatus

(Members of SubscribableTypeStatus are embedded into this type.)

Subscribers is populated with the statuses of each of the Channelable’s subscribers.

Sequence

Sequence defines a sequence of Subscribers that will be wired in series through Channels and Subscriptions.

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

Spec defines the desired state of the Sequence.



steps
[]SubscriberSpec

Steps is the list of Subscribers (processors / functions) that will be called in the order provided.

channelTemplate
ChannelTemplateSpec

ChannelTemplate specifies which Channel CRD to use

reply
Kubernetes core/v1.ObjectReference
(Optional)

Reply is a Reference to where the result of the last Subscriber gets sent to.

You can specify only the following fields of the ObjectReference: - Kind - APIVersion - Name

The resource pointed by this ObjectReference must meet the Addressable contract with a reference to the Addressable duck type. If the resource does not meet this contract, it will be reflected in the Subscription’s status.

status
SequenceStatus
(Optional)

Status represents the current state of the Sequence. This data may be out of date.

SequenceChannelStatus

(Appears on: SequenceStatus)

Field Description
channel
Kubernetes core/v1.ObjectReference

Channel is the reference to the underlying channel.

ready
github.com/knative/pkg/apis.Condition

ReadyCondition indicates whether the Channel is ready or not.

SequenceSpec

(Appears on: Sequence)

Field Description
steps
[]SubscriberSpec

Steps is the list of Subscribers (processors / functions) that will be called in the order provided.

channelTemplate
ChannelTemplateSpec

ChannelTemplate specifies which Channel CRD to use

reply
Kubernetes core/v1.ObjectReference
(Optional)

Reply is a Reference to where the result of the last Subscriber gets sent to.

You can specify only the following fields of the ObjectReference: - Kind - APIVersion - Name

The resource pointed by this ObjectReference must meet the Addressable contract with a reference to the Addressable duck type. If the resource does not meet this contract, it will be reflected in the Subscription’s status.

SequenceStatus

(Appears on: Sequence)

SequenceStatus represents the current state of a Sequence.

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

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.

SubscriptionStatuses
[]SequenceSubscriptionStatus

SubscriptionStatuses is an array of corresponding Subscription statuses. Matches the Spec.Steps array in the order.

ChannelStatuses
[]SequenceChannelStatus

ChannelStatuses is an array of corresponding Channel statuses. Matches the Spec.Steps array in the order.

AddressStatus
github.com/knative/pkg/apis/duck/v1alpha1.AddressStatus

(Members of AddressStatus are embedded into this type.)

AddressStatus is the starting point to this Sequence. Sending to this will target the first subscriber. It generally has the form {channel}.{namespace}.svc.{cluster domain name}

SequenceSubscriptionStatus

(Appears on: SequenceStatus)

Field Description
subscription
Kubernetes core/v1.ObjectReference

Subscription is the reference to the underlying Subscription.

ready
github.com/knative/pkg/apis.Condition

ReadyCondition indicates whether the Subscription is ready or not.


sources.eventing.knative.dev/v1alpha1

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

Resource Types:

ApiServerSource

ApiServerSource is the Schema for the apiserversources API

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
ApiServerSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ApiServerSourceSpec


resources
[]ApiServerResource

Resources is the list of resources to watch

serviceAccountName
string
(Optional)

ServiceAccountName is the name of the ServiceAccount to use to run this source.

sink
Kubernetes core/v1.ObjectReference
(Optional)

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.

status
ApiServerSourceStatus

ContainerSource

ContainerSource is the Schema for the containersources API

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
ContainerSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ContainerSourceSpec


template
Kubernetes core/v1.PodTemplateSpec
(Optional)

Template describes the pods that will be created

image
string

DeprecatedImage is the image to run inside of the container. This field is to be deprecated. Use Template instead. When Template is set, this field is ignored.

args
[]string

DeprecatedArgs are passed to the ContainerSpec as they are. This field is to be deprecated. Use Template instead. When Template is set, this field is ignored.

env
[]Kubernetes core/v1.EnvVar
(Optional)

DeprecatedEnv is the list of environment variables to set in the container. Cannot be updated. This field is to be deprecated. Use Template instead. When Template is set, this field is ignored.

serviceAccountName
string
(Optional)

DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this source. This field is to be deprecated. Use Template instead. When Template is set, this field is ignored.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

status
ContainerSourceStatus

CronJobSource

CronJobSource is the Schema for the cronjobsources API.

Field Description
apiVersion
string
sources.eventing.knative.dev/v1alpha1
kind
string
CronJobSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
CronJobSourceSpec


schedule
string

Schedule is the cronjob schedule.

data
string

Data is the data posted to the target function.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

resources
CronJobResourceSpec

Resource limits and Request specifications of the Receive Adapter Deployment

status
CronJobSourceStatus

ApiServerResource

(Appears on: ApiServerSourceSpec)

ApiServerResource defines the resource to watch

Field Description
apiVersion
string

API version of the resource to watch.

kind
string

Kind of the resource to watch. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

controller
bool

If true, send an event referencing the object controlling the resource

ApiServerSourceSpec

(Appears on: ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

Field Description
resources
[]ApiServerResource

Resources is the list of resources to watch

serviceAccountName
string
(Optional)

ServiceAccountName is the name of the ServiceAccount to use to run this source.

sink
Kubernetes core/v1.ObjectReference
(Optional)

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.

ApiServerSourceStatus

(Appears on: ApiServerSource)

ApiServerSourceStatus defines the observed state of ApiServerSource

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.

ContainerSourceSpec

(Appears on: ContainerSource)

ContainerSourceSpec defines the desired state of ContainerSource

Field Description
template
Kubernetes core/v1.PodTemplateSpec
(Optional)

Template describes the pods that will be created

image
string

DeprecatedImage is the image to run inside of the container. This field is to be deprecated. Use Template instead. When Template is set, this field is ignored.

args
[]string

DeprecatedArgs are passed to the ContainerSpec as they are. This field is to be deprecated. Use Template instead. When Template is set, this field is ignored.

env
[]Kubernetes core/v1.EnvVar
(Optional)

DeprecatedEnv is the list of environment variables to set in the container. Cannot be updated. This field is to be deprecated. Use Template instead. When Template is set, this field is ignored.

serviceAccountName
string
(Optional)

DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this source. This field is to be deprecated. Use Template instead. When Template is set, this field is ignored.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

ContainerSourceStatus

(Appears on: ContainerSource)

ContainerSourceStatus defines the observed state of ContainerSource

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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.

CronJobLimitsSpec

(Appears on: CronJobResourceSpec)

Field Description
cpu
string
memory
string

CronJobRequestsSpec

(Appears on: CronJobResourceSpec)

Field Description
cpu
string
memory
string

CronJobResourceSpec

(Appears on: CronJobSourceSpec)

Field Description
requests
CronJobRequestsSpec
limits
CronJobLimitsSpec

CronJobSourceSpec

(Appears on: CronJobSource)

CronJobSourceSpec defines the desired state of the CronJobSource.

Field Description
schedule
string

Schedule is the cronjob schedule.

data
string

Data is the data posted to the target function.

sink
Kubernetes core/v1.ObjectReference
(Optional)

Sink is a reference to an object that will resolve to a domain name to use as the sink.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment.

resources
CronJobResourceSpec

Resource limits and Request specifications of the Receive Adapter Deployment

CronJobSourceStatus

(Appears on: CronJobSource)

CronJobSourceStatus defines the observed state of CronJobSource.

Field Description
Status
github.com/knative/pkg/apis/duck/v1beta1.Status

(Members of Status are embedded into this type.)

inherits duck/v1beta1 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 ab260095.