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.

FieldDescription
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.)

delivery
DeliverySpec
(Optional)

DeliverySpec contains options controlling the event delivery

status
ChannelableStatus

ChannelableCombined

ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of both v1alpha1 and v1beta1 duck types. This is not to be used by resource writers and is only used by Subscription Controller to synthesize patches and read the Status of the Channelable Resources. This is not a real resource.

FieldDescription
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ChannelableCombinedSpec

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



SubscribableTypeSpec
SubscribableTypeSpec

(Members of SubscribableTypeSpec are embedded into this type.)

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

SubscribableSpec
SubscribableSpec

(Members of SubscribableSpec are embedded into this type.)

SubscribableSpec is for the v1beta1 spec compatibility.

delivery
DeliverySpec
(Optional)

DeliverySpec contains options controlling the event delivery

status
ChannelableCombinedStatus

ChannelableCombinedSpec

(Appears on: ChannelableCombined)

ChannelableSpec contains Spec of the Channelable object

FieldDescription
SubscribableTypeSpec
SubscribableTypeSpec

(Members of SubscribableTypeSpec are embedded into this type.)

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

SubscribableSpec
SubscribableSpec

(Members of SubscribableSpec are embedded into this type.)

SubscribableSpec is for the v1beta1 spec compatibility.

delivery
DeliverySpec
(Optional)

DeliverySpec contains options controlling the event delivery

ChannelableCombinedStatus

(Appears on: ChannelableCombined)

ChannelableStatus contains the Status of a Channelable object.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/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.)

SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

SubscribableStatus
SubscribableStatus

(Members of SubscribableStatus are embedded into this type.)

SubscribableStatus is the v1beta1 part of the Subscribers status.

errorChannel
Kubernetes core/v1.ObjectReference
(Optional)

ErrorChannel is set by the channel when it supports native error handling via a channel

ChannelableSpec

(Appears on: Channelable)

ChannelableSpec contains Spec of the Channelable object

FieldDescription
SubscribableTypeSpec
SubscribableTypeSpec

(Members of SubscribableTypeSpec are embedded into this type.)

delivery
DeliverySpec
(Optional)

DeliverySpec contains options controlling the event delivery

ChannelableStatus

(Appears on: Channelable)

ChannelableStatus contains the Status of a Channelable object.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/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.

errorChannel
Kubernetes core/v1.ObjectReference
(Optional)

ErrorChannel is set by the channel when it supports native error handling via a channel

Resource

Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch arbitrary other resources (such as any Source or Addressable). This is not a real resource.

FieldDescription
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.

Subscribable

(Appears on: ChannelSpec, InMemoryChannelSpec, SubscribableTypeSpec)

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

FieldDescription
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.

FieldDescription
subscribers
[]SubscriberStatus

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

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.

FieldDescription
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.

SubscribableTypeSpec

(Appears on: ChannelableCombinedSpec, ChannelableSpec, SubscribableType)

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

FieldDescription
subscribable
Subscribable

SubscribableTypeStatus

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

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

FieldDescription
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

FieldDescription
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
knative.dev/pkg/apis.URL
(Optional)
replyURI
knative.dev/pkg/apis.URL
(Optional)
deadLetterSink
knative.dev/pkg/apis.URL
(Optional)
delivery
DeliverySpec
(Optional)

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.

FieldDescription
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.



channelTemplateSpec
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the Broker. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace). Deprecated: See spec.config to configure aditional broker options. Unless class is for channel based broker implementation.

config
knative.dev/pkg/apis/duck/v1.KReference
(Optional)

Config is a KReference to the configuration that specifies configuration options for this Broker. For example, this could be a pointer to a ConfigMap. NOTE: this is for backwards compatibility with v1alpha1 <-> v1beta1 conversions.

delivery
DeliverySpec
(Optional)

Delivery is the delivery specification to be used internally by the broker to create subscriptions.

status
BrokerStatus
(Optional)

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

EventType

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

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

TODO remove https://github.com/knative/eventing/issues/2750 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. TODO might be removed https://github.com/knative/eventing/issues/2750

Trigger

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

FieldDescription
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
knative.dev/pkg/apis/duck/v1.Destination

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)

FieldDescription
channelTemplateSpec
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the Broker. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace). Deprecated: See spec.config to configure aditional broker options. Unless class is for channel based broker implementation.

config
knative.dev/pkg/apis/duck/v1.KReference
(Optional)

Config is a KReference to the configuration that specifies configuration options for this Broker. For example, this could be a pointer to a ConfigMap. NOTE: this is for backwards compatibility with v1alpha1 <-> v1beta1 conversions.

delivery
DeliverySpec
(Optional)

Delivery is the delivery specification to be used internally by the broker to create subscriptions.

BrokerStatus

(Appears on: Broker)

BrokerStatus represents the current state of a Broker.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/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

EventTypeSpec

(Appears on: EventType)

FieldDescription
type
string

Type represents the CloudEvents type. It is authoritative.

source
string
(Optional)

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

TODO remove https://github.com/knative/eventing/issues/2750 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.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

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

TriggerFilter

(Appears on: TriggerSpec)

FieldDescription
sourceAndType
TriggerFilterSourceAndType
(Optional)

DeprecatedSourceAndType filters events based on exact matches on the CloudEvents type and source attributes. This field has been replaced by the Attributes field.

attributes
TriggerFilterAttributes
(Optional)

Attributes filters events by exact match on event context attributes. Each key in the map is compared with the equivalent key in the event context. An event passes the filter if all values are equal to the specified values.

Nested context attributes are not supported as keys. Only string values are supported.

TriggerFilterAttributes (map[string]string alias)

(Appears on: TriggerFilter)

TriggerFilterAttributes is a map of context attribute names to values for filtering by equality. Only exact matches will pass the filter. You can use the value “ to indicate all strings match.

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 “ to indicate all strings match.

FieldDescription
type
string
source
string

TriggerSpec

(Appears on: Trigger)

FieldDescription
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
knative.dev/pkg/apis/duck/v1.Destination

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.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/pkg/apis.URL

SubscriberURI is the resolved URI of the receiver for this Trigger.


eventing.knative.dev/v1beta1

Package v1beta1 is the v1beta1 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.

FieldDescription
apiVersion
string
eventing.knative.dev/v1beta1
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.



config
knative.dev/pkg/apis/duck/v1.KReference
(Optional)

Config is a KReference to the configuration that specifies configuration options for this Broker. For example, this could be a pointer to a ConfigMap.

delivery
DeliverySpec
(Optional)

Delivery is the delivery specification for Events within the Broker mesh. This includes things like retries, DLQ, etc.

status
BrokerStatus
(Optional)

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

EventType

FieldDescription
apiVersion
string
eventing.knative.dev/v1beta1
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
knative.dev/pkg/apis.URL
(Optional)

Source is a URI, it represents the CloudEvents source.

schema
knative.dev/pkg/apis.URL
(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.

schemaData
string
(Optional)

SchemaData allows the CloudEvents schema to be stored directly in the EventType. Content is dependent on the encoding. Optional attribute. The contents are not validated or manipulated by the system.

broker
string
(Optional)

TODO remove https://github.com/knative/eventing/issues/2750 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. TODO might be removed https://github.com/knative/eventing/issues/2750

Trigger

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

FieldDescription
apiVersion
string
eventing.knative.dev/v1beta1
kind
string
Trigger
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TriggerSpec

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
knative.dev/pkg/apis/duck/v1.Destination

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)

FieldDescription
config
knative.dev/pkg/apis/duck/v1.KReference
(Optional)

Config is a KReference to the configuration that specifies configuration options for this Broker. For example, this could be a pointer to a ConfigMap.

delivery
DeliverySpec
(Optional)

Delivery is the delivery specification for Events within the Broker mesh. This includes things like retries, DLQ, etc.

BrokerStatus

(Appears on: Broker)

BrokerStatus represents the current state of a Broker.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/pkg/apis/duck/v1.Addressable

Broker is Addressable. It exposes the endpoint as an URI to get events delivered into the Broker mesh.

EventTypeSpec

(Appears on: EventType)

FieldDescription
type
string

Type represents the CloudEvents type. It is authoritative.

source
knative.dev/pkg/apis.URL
(Optional)

Source is a URI, it represents the CloudEvents source.

schema
knative.dev/pkg/apis.URL
(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.

schemaData
string
(Optional)

SchemaData allows the CloudEvents schema to be stored directly in the EventType. Content is dependent on the encoding. Optional attribute. The contents are not validated or manipulated by the system.

broker
string
(Optional)

TODO remove https://github.com/knative/eventing/issues/2750 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.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

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

TriggerFilter

(Appears on: TriggerSpec)

FieldDescription
attributes
TriggerFilterAttributes
(Optional)

Attributes filters events by exact match on event context attributes. Each key in the map is compared with the equivalent key in the event context. An event passes the filter if all values are equal to the specified values.

Nested context attributes are not supported as keys. Only string values are supported.

TriggerFilterAttributes (map[string]string alias)

(Appears on: TriggerFilter)

TriggerFilterAttributes is a map of context attribute names to values for filtering by equality. Only exact matches will pass the filter. You can use the value “ to indicate all strings match.

TriggerSpec

(Appears on: Trigger)

FieldDescription
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
knative.dev/pkg/apis/duck/v1.Destination

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.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/pkg/apis.URL

SubscriberURI is the resolved URI of the receiver for this Trigger.


flows.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

Parallel

Parallel defines conditional branches that will be wired in series through Channels and Subscriptions.

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

Spec defines the desired state of the Parallel.



branches
[]ParallelBranch

Branches is the list of Filter/Subscribers pairs.

channelTemplate
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace).

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Reply is a Reference to where the result of a case Subscriber gets sent to when the case does not have a Reply

status
ParallelStatus
(Optional)

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

ParallelBranch

(Appears on: ParallelSpec)

FieldDescription
filter
knative.dev/pkg/apis/duck/v1.Destination

Filter is the expression guarding the branch

subscriber
knative.dev/pkg/apis/duck/v1.Destination

Subscriber receiving the event when the filter passes

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Reply is a Reference to where the result of Subscriber of this case gets sent to. If not specified, sent the result to the Parallel Reply

delivery
DeliverySpec
(Optional)

Delivery is the delivery specification for events to the subscriber This includes things like retries, DLQ, etc. Needed for Roundtripping v1alpha1 <-> v1beta1.

ParallelBranchStatus

(Appears on: ParallelStatus)

ParallelBranchStatus represents the current state of a Parallel branch

FieldDescription
filterSubscriptionStatus
ParallelSubscriptionStatus

FilterSubscriptionStatus corresponds to the filter subscription status.

filterChannelStatus
ParallelChannelStatus

FilterChannelStatus corresponds to the filter channel status.

subscriberSubscriptionStatus
ParallelSubscriptionStatus

SubscriptionStatus corresponds to the subscriber subscription status.

ParallelChannelStatus

(Appears on: ParallelBranchStatus, ParallelStatus)

FieldDescription
channel
Kubernetes core/v1.ObjectReference

Channel is the reference to the underlying channel.

ready
knative.dev/pkg/apis.Condition

ReadyCondition indicates whether the Channel is ready or not.

ParallelSpec

(Appears on: Parallel)

FieldDescription
branches
[]ParallelBranch

Branches is the list of Filter/Subscribers pairs.

channelTemplate
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace).

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Reply is a Reference to where the result of a case Subscriber gets sent to when the case does not have a Reply

ParallelStatus

(Appears on: Parallel)

ParallelStatus represents the current state of a Parallel.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

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

ingressChannelStatus
ParallelChannelStatus

IngressChannelStatus corresponds to the ingress channel status.

branchStatuses
[]ParallelBranchStatus

BranchStatuses is an array of corresponding to branch statuses. Matches the Spec.Branches array in the order.

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

(Members of AddressStatus are embedded into this type.)

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

ParallelSubscriptionStatus

(Appears on: ParallelBranchStatus)

FieldDescription
subscription
Kubernetes core/v1.ObjectReference

Subscription is the reference to the underlying Subscription.

ready
knative.dev/pkg/apis.Condition

ReadyCondition indicates whether the Subscription is ready or not.

Sequence

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

FieldDescription
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
[]SequenceStep

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

channelTemplate
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace).

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

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

status
SequenceStatus
(Optional)

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

SequenceChannelStatus

(Appears on: SequenceStatus)

FieldDescription
channel
Kubernetes core/v1.ObjectReference

Channel is the reference to the underlying channel.

ready
knative.dev/pkg/apis.Condition

ReadyCondition indicates whether the Channel is ready or not.

SequenceSpec

(Appears on: Sequence)

FieldDescription
steps
[]SequenceStep

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

channelTemplate
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace).

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

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

SequenceStatus

(Appears on: Sequence)

SequenceStatus represents the current state of a Sequence.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/pkg/apis/duck/v1.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}

SequenceStep

(Appears on: SequenceSpec)

FieldDescription
Destination
knative.dev/pkg/apis/duck/v1.Destination

(Members of Destination are embedded into this type.)

Subscriber receiving the step event

delivery
DeliverySpec
(Optional)

Delivery is the delivery specification for events to the subscriber This includes things like retries, DLQ, etc. Needed for Roundtripping v1alpha1 <-> v1beta1.

SequenceSubscriptionStatus

(Appears on: SequenceStatus)

FieldDescription
subscription
Kubernetes core/v1.ObjectReference

Subscription is the reference to the underlying Subscription.

ready
knative.dev/pkg/apis.Condition

ReadyCondition indicates whether the Subscription is ready or not.


messaging.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

Channel

Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.

FieldDescription
apiVersion
string
messaging.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.



channelTemplate
ChannelTemplateSpec

ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.

subscribable
Subscribable

Channel conforms to Duck type Subscribable.

delivery
DeliverySpec

Delivery options.

status
ChannelStatus
(Optional)

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

InMemoryChannel

InMemoryChannel is a resource representing an in memory channel

FieldDescription
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.

delivery
DeliverySpec

For round tripping (v1beta1 <-> v1alpha1>

status
InMemoryChannelStatus
(Optional)

Status represents the current state of the Channel. 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.

FieldDescription
apiVersion
string
messaging.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
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Subscriber is reference to (optional) function for processing events. Events from the Channel will be delivered here and replies are sent to a Destination as specified by the Reply.

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

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

delivery
DeliverySpec
(Optional)

Delivery configuration

status
SubscriptionStatus

ChannelSpec

(Appears on: Channel)

ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.

FieldDescription
channelTemplate
ChannelTemplateSpec

ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.

subscribable
Subscribable

Channel conforms to Duck type Subscribable.

delivery
DeliverySpec

Delivery options.

ChannelStatus

(Appears on: Channel)

ChannelStatus represents the current state of a Channel.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/pkg/apis/duck/v1alpha1.AddressStatus

(Members of AddressStatus are embedded into this type.)

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}

SubscribableTypeStatus
SubscribableTypeStatus

(Members of SubscribableTypeStatus are embedded into this type.)

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

channel
Kubernetes core/v1.ObjectReference

Channel is an ObjectReference to the Channel CRD backing this Channel.

InMemoryChannelSpec

(Appears on: InMemoryChannel)

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

FieldDescription
subscribable
Subscribable

Channel conforms to Duck type Subscribable.

delivery
DeliverySpec

For round tripping (v1beta1 <-> v1alpha1>

InMemoryChannelStatus

(Appears on: InMemoryChannel)

ChannelStatus represents the current state of a Channel.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/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.

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

FieldDescription
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
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Subscriber is reference to (optional) function for processing events. Events from the Channel will be delivered here and replies are sent to a Destination as specified by the Reply.

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

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

delivery
DeliverySpec
(Optional)

Delivery configuration

SubscriptionStatus

(Appears on: Subscription)

SubscriptionStatus (computed) for a subscription

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

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

FieldDescription
subscriberURI
knative.dev/pkg/apis.URL

SubscriberURI is the fully resolved URI for spec.subscriber.

replyURI
knative.dev/pkg/apis.URL

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

deadLetterSinkURI
knative.dev/pkg/apis.URL

ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.


configs.internal.knative.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

ConfigMapPropagation

ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace

FieldDescription
apiVersion
string
configs.internal.knative.dev/v1alpha1
kind
string
ConfigMapPropagation
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ConfigMapPropagationSpec

Spec defines the desired state of the ConfigMapPropagation



originalNamespace
string

OriginalNamespace is the namespace where the original configMaps are in

selector
Kubernetes meta/v1.LabelSelector
(Optional)

Selector only selects original configMaps with corresponding labels

status
ConfigMapPropagationStatus
(Optional)

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

ConfigMapPropagationSpec

(Appears on: ConfigMapPropagation)

FieldDescription
originalNamespace
string

OriginalNamespace is the namespace where the original configMaps are in

selector
Kubernetes meta/v1.LabelSelector
(Optional)

Selector only selects original configMaps with corresponding labels

ConfigMapPropagationStatus

(Appears on: ConfigMapPropagation)

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

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

copyConfigmaps
[]ConfigMapPropagationStatusCopyConfigMap
(Optional)

CopyConfigMaps is the status for each copied configmap.

ConfigMapPropagationStatusCopyConfigMap

(Appears on: ConfigMapPropagationStatus)

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

FieldDescription
name
string

Name is copy configmap’s name

source
string

Source is “originalNamespace/originalConfigMapName”

operation
string

Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop

ready
string

Ready represents the operation is ready or not

reason
string

Reason indicates reasons if the operation is not ready

resourceVersionFromSource
string

ResourceVersion is the resourceVersion of original configmap


duck.knative.dev/v1beta1

Package v1beta1 is the v1beta1 version of the API.

Resource Types:

BackoffPolicyType (string alias)

(Appears on: DeliverySpec)

BackoffPolicyType is the type for backoff policies

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.

FieldDescription
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.



SubscribableSpec
SubscribableSpec

(Members of SubscribableSpec are embedded into this type.)

delivery
DeliverySpec
(Optional)

DeliverySpec contains options controlling the event delivery

status
ChannelableStatus

ChannelableSpec

(Appears on: ChannelSpec, Channelable, InMemoryChannelSpec)

ChannelableSpec contains Spec of the Channelable object

FieldDescription
SubscribableSpec
SubscribableSpec

(Members of SubscribableSpec are embedded into this type.)

delivery
DeliverySpec
(Optional)

DeliverySpec contains options controlling the event delivery

ChannelableStatus

(Appears on: ChannelStatus, Channelable, InMemoryChannelStatus)

ChannelableStatus contains the Status of a Channelable object.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/pkg/apis/duck/v1.AddressStatus

(Members of AddressStatus are embedded into this type.)

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

SubscribableStatus
SubscribableStatus

(Members of SubscribableStatus are embedded into this type.)

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

deadLetterChannel
knative.dev/pkg/apis/duck/v1.KReference
(Optional)

DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel Failed messages are delivered here.

DeliverySpec

(Appears on: BrokerSpec, BrokerSpec, ChannelSpec, ChannelableCombinedSpec, ChannelableSpec, ChannelableSpec, InMemoryChannelSpec, ParallelBranch, ParallelBranch, SequenceStep, SequenceStep, SubscriberSpec, SubscriberSpec, SubscriptionSpec, SubscriptionSpec)

DeliverySpec contains the delivery options for event senders, such as channelable and source.

FieldDescription
deadLetterSink
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

DeadLetterSink is the sink receiving event that could not be sent to a destination.

retry
int32
(Optional)

Retry is the minimum number of retries the sender should attempt when sending an event before moving it to the dead letter sink.

backoffPolicy
BackoffPolicyType
(Optional)

BackoffPolicy is the retry backoff policy (linear, exponential).

backoffDelay
string
(Optional)

BackoffDelay is the delay before retrying. More information on Duration format: https://www.ietf.org/rfc/rfc3339.txt

For linear policy, backoff delay is the time interval between retries. For exponential policy , backoff delay is backoffDelay*2^.

DeliveryStatus

DeliveryStatus contains the Status of an object supporting delivery options.

FieldDescription
deadLetterChannel
knative.dev/pkg/apis/duck/v1.KReference
(Optional)

DeadLetterChannel is a KReference that is the reference to the native, platform specific channel where failed events are sent to.

Subscribable

Subscribable 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.

FieldDescription
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SubscribableSpec

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



subscribers
[]SubscriberSpec

This is the list of subscriptions for this subscribable.

status
SubscribableStatus

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

SubscribableSpec

(Appears on: ChannelableCombinedSpec, ChannelableSpec, Subscribable)

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

FieldDescription
subscribers
[]SubscriberSpec

This is the list of subscriptions for this subscribable.

SubscribableStatus

(Appears on: ChannelableCombinedStatus, ChannelableStatus, Subscribable)

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

FieldDescription
subscribers
[]SubscriberStatus

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

SubscriberSpec

(Appears on: SubscribableSpec)

SubscriberSpec defines a single subscriber to a Subscribable.

At least one of SubscriberURI and ReplyURI must be present

FieldDescription
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
knative.dev/pkg/apis.URL
(Optional)

SubscriberURI is the endpoint for the subscriber

replyUri
knative.dev/pkg/apis.URL
(Optional)

ReplyURI is the endpoint for the reply

delivery
DeliverySpec
(Optional)

DeliverySpec contains options controlling the event delivery

SubscriberStatus

(Appears on: SubscribableStatus, SubscribableStatus)

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

FieldDescription
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

Status of the subscriber.

message
string
(Optional)

A human readable message indicating details of Ready status.


flows.knative.dev/v1beta1

Package v1beta1 is the v1beta1 version of the API.

Resource Types:

Parallel

Parallel defines conditional branches that will be wired in series through Channels and Subscriptions.

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

Spec defines the desired state of the Parallel.



branches
[]ParallelBranch

Branches is the list of Filter/Subscribers pairs.

channelTemplate
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace).

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Reply is a Reference to where the result of a case Subscriber gets sent to when the case does not have a Reply

status
ParallelStatus
(Optional)

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

ParallelBranch

(Appears on: ParallelSpec)

FieldDescription
filter
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Filter is the expression guarding the branch

subscriber
knative.dev/pkg/apis/duck/v1.Destination

Subscriber receiving the event when the filter passes

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Reply is a Reference to where the result of Subscriber of this case gets sent to. If not specified, sent the result to the Parallel Reply

delivery
DeliverySpec
(Optional)

Delivery is the delivery specification for events to the subscriber This includes things like retries, DLQ, etc. Needed for Roundtripping v1alpha1 <-> v1beta1.

ParallelBranchStatus

(Appears on: ParallelStatus)

ParallelBranchStatus represents the current state of a Parallel branch

FieldDescription
filterSubscriptionStatus
ParallelSubscriptionStatus

FilterSubscriptionStatus corresponds to the filter subscription status.

filterChannelStatus
ParallelChannelStatus

FilterChannelStatus corresponds to the filter channel status.

subscriberSubscriptionStatus
ParallelSubscriptionStatus

SubscriptionStatus corresponds to the subscriber subscription status.

ParallelChannelStatus

(Appears on: ParallelBranchStatus, ParallelStatus)

FieldDescription
channel
Kubernetes core/v1.ObjectReference

Channel is the reference to the underlying channel.

ready
knative.dev/pkg/apis.Condition

ReadyCondition indicates whether the Channel is ready or not.

ParallelSpec

(Appears on: Parallel)

FieldDescription
branches
[]ParallelBranch

Branches is the list of Filter/Subscribers pairs.

channelTemplate
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace).

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Reply is a Reference to where the result of a case Subscriber gets sent to when the case does not have a Reply

ParallelStatus

(Appears on: Parallel)

ParallelStatus represents the current state of a Parallel.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

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

ingressChannelStatus
ParallelChannelStatus

IngressChannelStatus corresponds to the ingress channel status.

branchStatuses
[]ParallelBranchStatus

BranchStatuses is an array of corresponding to branch statuses. Matches the Spec.Branches array in the order.

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

(Members of AddressStatus are embedded into this type.)

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

ParallelSubscriptionStatus

(Appears on: ParallelBranchStatus)

FieldDescription
subscription
Kubernetes core/v1.ObjectReference

Subscription is the reference to the underlying Subscription.

ready
knative.dev/pkg/apis.Condition

ReadyCondition indicates whether the Subscription is ready or not.

Sequence

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

FieldDescription
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
[]SequenceStep

Steps is the list of Destinations (processors / functions) that will be called in the order provided. Each step has its own delivery options

channelTemplate
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace).

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

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

status
SequenceStatus
(Optional)

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

SequenceChannelStatus

(Appears on: SequenceStatus)

FieldDescription
channel
Kubernetes core/v1.ObjectReference

Channel is the reference to the underlying channel.

ready
knative.dev/pkg/apis.Condition

ReadyCondition indicates whether the Channel is ready or not.

SequenceSpec

(Appears on: Sequence)

FieldDescription
steps
[]SequenceStep

Steps is the list of Destinations (processors / functions) that will be called in the order provided. Each step has its own delivery options

channelTemplate
ChannelTemplateSpec
(Optional)

ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there are no defaults for the namespace).

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

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

SequenceStatus

(Appears on: Sequence)

SequenceStatus represents the current state of a Sequence.

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

inherits duck/v1 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
knative.dev/pkg/apis/duck/v1.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}

SequenceStep

(Appears on: SequenceSpec)

FieldDescription
Destination
knative.dev/pkg/apis/duck/v1.Destination

(Members of Destination are embedded into this type.)

Subscriber receiving the step event

delivery
DeliverySpec
(Optional)

Delivery is the delivery specification for events to the subscriber This includes things like retries, DLQ, etc.

SequenceSubscriptionStatus

(Appears on: SequenceStatus)

FieldDescription
subscription
Kubernetes core/v1.ObjectReference

Subscription is the reference to the underlying Subscription.

ready
knative.dev/pkg/apis.Condition

ReadyCondition indicates whether the Subscription is ready or not.


messaging.knative.dev/v1beta1

Package v1beta1 is the v1beta1 version of the API.

Resource Types:

Channel

Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.

FieldDescription
apiVersion
string
messaging.knative.dev/v1beta1
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.



channelTemplate
ChannelTemplateSpec

ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.

ChannelableSpec
ChannelableSpec

(Members of ChannelableSpec are embedded into this type.)

Channel conforms to ChannelableSpec

status
ChannelStatus
(Optional)

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

InMemoryChannel

InMemoryChannel is a resource representing an in memory channel

FieldDescription
apiVersion
string
messaging.knative.dev/v1beta1
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.



ChannelableSpec
ChannelableSpec

(Members of ChannelableSpec are embedded into this type.)

Channel conforms to Duck type Channelable.

status
InMemoryChannelStatus
(Optional)

Status represents the current state of the Channel. 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.

FieldDescription
apiVersion
string
messaging.knative.dev/v1beta1
kind
string
Subscription
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SubscriptionSpec


channel
Kubernetes core/v1.ObjectReference

Reference to a channel that will be used to create the subscription You can specify only the following fields of the ObjectReference: - Kind - APIVersion - Name The resource pointed by this ObjectReference must meet the contract to the ChannelableSpec duck type. If the resource does not meet this contract it will be reflected in the Subscription’s status.

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
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Subscriber is reference to (optional) function for processing events. Events from the Channel will be delivered here and replies are sent to a Destination as specified by the Reply.

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

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

delivery
DeliverySpec
(Optional)

Delivery configuration

status
SubscriptionStatus

ChannelDefaulter

ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not specify any implementation.

ChannelSpec

(Appears on: Channel)

ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.

FieldDescription
channelTemplate
ChannelTemplateSpec

ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.

ChannelableSpec
ChannelableSpec

(Members of ChannelableSpec are embedded into this type.)

Channel conforms to ChannelableSpec

ChannelStatus

(Appears on: Channel)

ChannelStatus represents the current state of a Channel.

FieldDescription
ChannelableStatus
ChannelableStatus

(Members of ChannelableStatus are embedded into this type.)

Channel conforms to ChannelableStatus

channel
knative.dev/pkg/apis/duck/v1.KReference

Channel is an KReference to the Channel CRD backing this Channel.

ChannelTemplateSpec

(Appears on: BrokerSpec, ChannelSpec, ChannelSpec, ParallelSpec, ParallelSpec, SequenceSpec, SequenceSpec)

FieldDescription
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

ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that we can easily create new Channels off of it.

FieldDescription
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.

FieldDescription
ChannelableSpec
ChannelableSpec

(Members of ChannelableSpec are embedded into this type.)

Channel conforms to Duck type Channelable.

InMemoryChannelStatus

(Appears on: InMemoryChannel)

ChannelStatus represents the current state of a Channel.

FieldDescription
ChannelableStatus
ChannelableStatus

(Members of ChannelableStatus are embedded into this type.)

Channel conforms to Duck type Channelable.

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

FieldDescription
channel
Kubernetes core/v1.ObjectReference

Reference to a channel that will be used to create the subscription You can specify only the following fields of the ObjectReference: - Kind - APIVersion - Name The resource pointed by this ObjectReference must meet the contract to the ChannelableSpec duck type. If the resource does not meet this contract it will be reflected in the Subscription’s status.

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
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

Subscriber is reference to (optional) function for processing events. Events from the Channel will be delivered here and replies are sent to a Destination as specified by the Reply.

reply
knative.dev/pkg/apis/duck/v1.Destination
(Optional)

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

delivery
DeliverySpec
(Optional)

Delivery configuration

SubscriptionStatus

(Appears on: Subscription)

SubscriptionStatus (computed) for a subscription

FieldDescription
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

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

FieldDescription
subscriberUri
knative.dev/pkg/apis.URL

SubscriberURI is the fully resolved URI for spec.subscriber.

replyUri
knative.dev/pkg/apis.URL

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

deadLetterSinkUri
knative.dev/pkg/apis.URL

ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.


sources.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

FieldDescription
apiVersion
string
sources.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
knative.dev/pkg/apis/duck/v1beta1.Destination
(Optional)

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

ceOverrides
knative.dev/pkg/apis/duck/v1.CloudEventOverrides
(Optional)

CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink.

owner
APIVersionKind
(Optional)

ResourceOwner is an additional filter to only track resources that are owned by a specific resource type. If ResourceOwner matches Resources[n] then Resources[n] is allowed to pass the ResourceOwner filter.

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

PingSource

PingSource is the Schema for the PingSources API.

FieldDescription
apiVersion
string
sources.knative.dev/v1alpha1
kind
string
PingSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
PingSourceSpec


schedule
string

Schedule is the cronjob schedule.

data
string

Data is the data posted to the target function.

sink
knative.dev/pkg/apis/duck/v1.Destination

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

ceOverrides
knative.dev/pkg/apis/duck/v1.CloudEventOverrides
(Optional)

CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment. Deprecated: v1beta1 drops this field.

resources
PingResourceSpec

Resource limits and Request specifications of the Receive Adapter Deployment Deprecated: v1beta1 drops this field.

status
PingSourceStatus

SinkBinding

SinkBinding describes a Binding that is also a Source. The sink (from the Source duck) is resolved to a URL and then projected into the subject by augmenting the runtime contract of the referenced containers to have a K_SINK environment variable holding the endpoint to which to send cloud events.

FieldDescription
apiVersion
string
sources.knative.dev/v1alpha1
kind
string
SinkBinding
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SinkBindingSpec


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

(Members of SourceSpec are embedded into this type.)

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

(Members of BindingSpec are embedded into this type.)

status
SinkBindingStatus

ApiServerResource

(Appears on: ApiServerSourceSpec)

ApiServerResource defines the resource to watch

FieldDescription
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/sig-architecture/api-conventions.md#types-kinds

labelSelector
Kubernetes meta/v1.LabelSelector

LabelSelector restricts this source to objects with the selected labels More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

controllerSelector
Kubernetes meta/v1.OwnerReference

ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. Only apiVersion and kind are used. Both are optional. Deprecated: Per-resource owner refs will no longer be supported in v1alpha2, please use Spec.Owner as a GKV.

controller
bool

If true, send an event referencing the object controlling the resource Deprecated: Per-resource controller flag will no longer be supported in v1alpha2, please use Spec.Owner as a GKV.

ApiServerSourceSpec

(Appears on: ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

FieldDescription
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
knative.dev/pkg/apis/duck/v1beta1.Destination
(Optional)

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

ceOverrides
knative.dev/pkg/apis/duck/v1.CloudEventOverrides
(Optional)

CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink.

owner
APIVersionKind
(Optional)

ResourceOwner is an additional filter to only track resources that are owned by a specific resource type. If ResourceOwner matches Resources[n] then Resources[n] is allowed to pass the ResourceOwner filter.

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

FieldDescription
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus

(Members of SourceStatus are embedded into this type.)

inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source.

PingLimitsSpec

(Appears on: PingResourceSpec)

FieldDescription
cpu
string
memory
string

PingRequestsSpec

(Appears on: PingResourceSpec)

FieldDescription
cpu
string
memory
string

PingResourceSpec

(Appears on: PingSourceSpec)

FieldDescription
requests
PingRequestsSpec
limits
PingLimitsSpec

PingSourceSpec

(Appears on: PingSource)

PingSourceSpec defines the desired state of the PingSource.

FieldDescription
schedule
string

Schedule is the cronjob schedule.

data
string

Data is the data posted to the target function.

sink
knative.dev/pkg/apis/duck/v1.Destination

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

ceOverrides
knative.dev/pkg/apis/duck/v1.CloudEventOverrides
(Optional)

CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink.

serviceAccountName
string

ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive Adapter Deployment. Deprecated: v1beta1 drops this field.

resources
PingResourceSpec

Resource limits and Request specifications of the Receive Adapter Deployment Deprecated: v1beta1 drops this field.

PingSourceStatus

(Appears on: PingSource)

PingSourceStatus defines the observed state of PingSource.

FieldDescription
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus

(Members of SourceStatus are embedded into this type.)

inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source.

SinkBindingSpec

(Appears on: SinkBinding)

SinkBindingSpec holds the desired state of the SinkBinding (from the client).

FieldDescription
SourceSpec
knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

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

(Members of BindingSpec are embedded into this type.)

SinkBindingStatus

(Appears on: SinkBinding)

SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

FieldDescription
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus

(Members of SourceStatus are embedded into this type.)


sources.knative.dev/v1alpha2

Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group

Resource Types:

ApiServerSource

ApiServerSource is the Schema for the apiserversources API

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


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

(Members of SourceSpec are embedded into this type.)

inherits duck/v1 SourceSpec, which currently provides: Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.

resources
[]APIVersionKindSelector

Resource are the resources this source will track and send related lifecycle events from the Kubernetes ApiServer, with an optional label selector to help filter.

owner
APIVersionKind
(Optional)

ResourceOwner is an additional filter to only track resources that are owned by a specific resource type. If ResourceOwner matches Resources[n] then Resources[n] is allowed to pass the ResourceOwner filter.

mode
string
(Optional)

EventMode controls the format of the event. Reference sends a dataref event type for the resource under watch. Resource send the full resource lifecycle event. Defaults to Reference

serviceAccountName
string
(Optional)

ServiceAccountName is the name of the ServiceAccount to use to run this source. Defaults to default if not set.

status
ApiServerSourceStatus

ContainerSource

ContainerSource is the Schema for the containersources API

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


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

(Members of SourceSpec are embedded into this type.)

inherits duck/v1 SourceSpec, which currently provides: Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.

template
Kubernetes core/v1.PodTemplateSpec

Template describes the pods that will be created

status
ContainerSourceStatus

PingSource

PingSource is the Schema for the PingSources API.

FieldDescription
apiVersion
string
sources.knative.dev/v1alpha2
kind
string
PingSource
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
PingSourceSpec


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

(Members of SourceSpec are embedded into this type.)

inherits duck/v1 SourceSpec, which currently provides: Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.

schedule
string
(Optional)

Schedule is the cronjob schedule. Defaults to *.

jsonData
string
(Optional)

JsonData is json encoded data used as the body of the event posted to the sink. Default is empty. If set, datacontenttype will also be set to “application/json”.

status
PingSourceStatus

SinkBinding

SinkBinding describes a Binding that is also a Source. The sink (from the Source duck) is resolved to a URL and then projected into the subject by augmenting the runtime contract of the referenced containers to have a K_SINK environment variable holding the endpoint to which to send cloud events.

FieldDescription
apiVersion
string
sources.knative.dev/v1alpha2
kind
string
SinkBinding
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SinkBindingSpec


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

(Members of SourceSpec are embedded into this type.)

inherits duck/v1 SourceSpec, which currently provides: Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.

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

(Members of BindingSpec are embedded into this type.)

inherits duck/v1alpha1 BindingSpec, which currently provides: * Subject - Subject references the resource(s) whose “runtime contract” should be augmented by Binding implementations.

status
SinkBindingStatus

APIVersionKind

(Appears on: ApiServerSourceSpec, ApiServerSourceSpec)

APIVersionKind is an APIVersion and Kind tuple.

FieldDescription
apiVersion
string

APIVersion - the API version of the resource to watch.

kind
string

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

APIVersionKindSelector

(Appears on: ApiServerSourceSpec)

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

FieldDescription
apiVersion
string

APIVersion - the API version of the resource to watch.

kind
string

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

selector
Kubernetes meta/v1.LabelSelector
(Optional)

LabelSelector filters this source to objects to those resources pass the label selector. More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

ApiServerSourceSpec

(Appears on: ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

FieldDescription
SourceSpec
knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

inherits duck/v1 SourceSpec, which currently provides: Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.

resources
[]APIVersionKindSelector

Resource are the resources this source will track and send related lifecycle events from the Kubernetes ApiServer, with an optional label selector to help filter.

owner
APIVersionKind
(Optional)

ResourceOwner is an additional filter to only track resources that are owned by a specific resource type. If ResourceOwner matches Resources[n] then Resources[n] is allowed to pass the ResourceOwner filter.

mode
string
(Optional)

EventMode controls the format of the event. Reference sends a dataref event type for the resource under watch. Resource send the full resource lifecycle event. Defaults to Reference

serviceAccountName
string
(Optional)

ServiceAccountName is the name of the ServiceAccount to use to run this source. Defaults to default if not set.

ApiServerSourceStatus

(Appears on: ApiServerSource)

ApiServerSourceStatus defines the observed state of ApiServerSource

FieldDescription
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus

(Members of SourceStatus are embedded into this type.)

inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source.

ContainerSourceSpec

(Appears on: ContainerSource)

ContainerSourceSpec defines the desired state of ContainerSource

FieldDescription
SourceSpec
knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

inherits duck/v1 SourceSpec, which currently provides: Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.

template
Kubernetes core/v1.PodTemplateSpec

Template describes the pods that will be created

ContainerSourceStatus

(Appears on: ContainerSource)

ContainerSourceStatus defines the observed state of ContainerSource

FieldDescription
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus

(Members of SourceStatus are embedded into this type.)

inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source.

PingSourceSpec

(Appears on: PingSource)

PingSourceSpec defines the desired state of the PingSource.

FieldDescription
SourceSpec
knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

inherits duck/v1 SourceSpec, which currently provides: Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.

schedule
string
(Optional)

Schedule is the cronjob schedule. Defaults to *.

jsonData
string
(Optional)

JsonData is json encoded data used as the body of the event posted to the sink. Default is empty. If set, datacontenttype will also be set to “application/json”.

PingSourceStatus

(Appears on: PingSource)

PingSourceStatus defines the observed state of PingSource.

FieldDescription
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus

(Members of SourceStatus are embedded into this type.)

inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source.

SinkBindingSpec

(Appears on: SinkBinding)

SinkBindingSpec holds the desired state of the SinkBinding (from the client).

FieldDescription
SourceSpec
knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

inherits duck/v1 SourceSpec, which currently provides: Sink - a reference to an object that will resolve to a domain name or a URI directly to use as the sink. CloudEventOverrides - defines overrides to control the output format and modifications of the event sent to the sink.

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

(Members of BindingSpec are embedded into this type.)

inherits duck/v1alpha1 BindingSpec, which currently provides: * Subject - Subject references the resource(s) whose “runtime contract” should be augmented by Binding implementations.

SinkBindingStatus

(Appears on: SinkBinding)

SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

FieldDescription
SourceStatus
knative.dev/pkg/apis/duck/v1.SourceStatus

(Members of SourceStatus are embedded into this type.)

inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the Source.


Generated with gen-crd-api-reference-docs on git commit a00ee26a.