From 04129357775a99ec45d6b02946d89145f2e7377f Mon Sep 17 00:00:00 2001
From: Ellen Evans Packages:
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API groupsources.eventing.knative.dev/v1alpha1
+sources.knative.dev/v1alpha1
AwsSqsSource is the Schema for the AWS SQS API
@@ -44,7 +42,7 @@ Resource Types: string
-sources.eventing.knative.dev/v1alpha1
+sources.knative.dev/v1alpha1
spec
-
+
AwsSqsSourceSpec
@@ -140,7 +138,7 @@ run the Receive Adapter Deployment.
status
-
+
AwsSqsSourceStatus
@@ -150,7 +148,7 @@ AwsSqsSourceStatus
-
CamelSource is the Schema for the camelsources API
@@ -169,7 +167,7 @@ AwsSqsSourceStatus string
-sources.eventing.knative.dev/v1alpha1
+sources.knative.dev/v1alpha1
spec
-
+
CamelSourceSpec
@@ -211,7 +209,7 @@ CamelSourceSpec
source
-
+
CamelSourceOriginSpec
@@ -252,7 +250,7 @@ modifications of the event sent to the sink.
status
-
+
CamelSourceStatus
@@ -262,7 +260,7 @@ CamelSourceStatus
-
CouchDbSource is the Schema for the githubsources API
@@ -281,7 +279,7 @@ CamelSourceStatus string
-sources.eventing.knative.dev/v1alpha1
+sources.knative.dev/v1alpha1
spec
-
+
CouchDbSourceSpec
@@ -352,7 +350,7 @@ Must be a secret. Only Name and Namespace are used.
feed
-
+
FeedType
@@ -392,7 +390,7 @@ knative.dev/pkg/apis/duck/v1beta1.Destination
status
-
+
CouchDbSourceStatus
@@ -402,7 +400,7 @@ CouchDbSourceStatus
-
GitHubSource is the Schema for the githubsources API
@@ -421,7 +419,7 @@ CouchDbSourceStatus string
-sources.eventing.knative.dev/v1alpha1
+sources.knative.dev/v1alpha1
spec
-
+
GitHubSourceSpec
@@ -508,7 +506,7 @@ correspond to the “Webhook event name” values listed at
accessToken
-
+
SecretValueFromSource
@@ -522,7 +520,7 @@ access token
secretToken
-
+
SecretValueFromSource
@@ -576,7 +574,7 @@ bool
status
-
+
GitHubSourceStatus
@@ -586,163 +584,7 @@ GitHubSourceStatus
--
KafkaSource is the Schema for the kafkasources API.
- -| Field | -Description | -||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.eventing.knative.dev/v1alpha1
-
- |
-||||||||||||||
-kind
-string
- |
-KafkaSource |
-||||||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||||||
-spec
-
-
-KafkaSourceSpec
-
-
- |
-
- - -
|
-||||||||||||||
-status
-
-
-KafkaSourceStatus
-
-
- |
-- | -
PrometheusSource is the Schema for the prometheussources API
@@ -761,7 +603,7 @@ KafkaSourceStatus string
-sources.eventing.knative.dev/v1alpha1
+sources.knative.dev/v1alpha1
spec
-
+
PrometheusSourceSpec
@@ -905,7 +747,7 @@ name to use as the sink.
status
-
+
PrometheusSourceStatus
@@ -915,11 +757,11 @@ PrometheusSourceStatus
-(Appears on: -AwsSqsSource) +AwsSqsSource)
AwsSqsSourceSpec defines the desired state of the source.
@@ -985,11 +827,11 @@ run the Receive Adapter Deployment. -(Appears on: -AwsSqsSource) +AwsSqsSource)
AwsSqsSourceStatus defines the observed state of the source.
@@ -1004,39 +846,31 @@ run the Receive Adapter Deployment.Status
+SourceStatus
-knative.dev/pkg/apis/duck/v1alpha1.Status
+knative.dev/pkg/apis/duck/v1.SourceStatus
-(Members of Status are embedded into this type.)
+(Members of SourceStatus 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.
-sinkUri
-
-string
-
-SinkURI is the current active sink URI that has been configured for the source.
+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.
(Appears on: -CamelSourceSpec) +CamelSourceSpec)
CamelSourceOriginSpec is the integration flow to run
@@ -1053,7 +887,7 @@ stringintegration
-github.com/apache/camel-k/pkg/apis/camel/v1alpha1.IntegrationSpec
+github.com/apache/camel-k/pkg/apis/camel/v1.IntegrationSpec
flow
-
+
Flow
@@ -1075,11 +909,11 @@ Flow
-(Appears on: -CamelSource) +CamelSource)
CamelSourceSpec defines the desired state of CamelSource
@@ -1096,7 +930,7 @@ Flowsource
-
+
CamelSourceOriginSpec
@@ -1132,11 +966,11 @@ modifications of the event sent to the sink.
-(Appears on: -CamelSource) +CamelSource)
CamelSourceStatus defines the observed state of CamelSource
@@ -1179,11 +1013,11 @@ string -(Appears on: -CouchDbSource) +CouchDbSource)
CouchDbSourceSpec defines the desired state of CouchDbSource
@@ -1229,7 +1063,7 @@ Must be a secret. Only Name and Namespace are used.feed
-
+
FeedType
@@ -1264,11 +1098,11 @@ knative.dev/pkg/apis/duck/v1beta1.Destination
-(Appears on: -CouchDbSource) +CouchDbSource)
CouchDbSourceStatus defines the observed state of CouchDbSource
@@ -1312,29 +1146,29 @@ for the CouchDbSource. -string alias)(Appears on: -CouchDbSourceSpec) +CouchDbSourceSpec)
FeedType is the type of Feed
-map[string]interface{} alias)(Appears on: -CamelSourceOriginSpec) +CamelSourceOriginSpec)
Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL
-(Appears on: -GitHubSource) +GitHubSource)
GitHubSourceSpec defines the desired state of GitHubSource
@@ -1396,7 +1230,7 @@ correspond to the “Webhook event name” values listed ataccessToken
-
+
SecretValueFromSource
@@ -1410,7 +1244,7 @@ access token
secretToken
-
+
SecretValueFromSource
@@ -1459,11 +1293,11 @@ bool
-(Appears on: -GitHubSource) +GitHubSource)
GitHubSourceStatus defines the observed state of GitHubSource
@@ -1518,11 +1352,11 @@ for the GitHubSource. -(Appears on: -KafkaResourceSpec) +KafkaResourceSpec)
@@ -1556,11 +1390,11 @@ string -
(Appears on: -KafkaResourceSpec) +KafkaResourceSpec)
@@ -1594,11 +1428,11 @@ string -
(Appears on: -KafkaSourceSpec) +KafkaSourceSpec)
@@ -1614,7 +1448,7 @@ string
requests
-
+
KafkaRequestsSpec
@@ -1626,7 +1460,7 @@ KafkaRequestsSpec
limits
-
+
KafkaLimitsSpec
@@ -1636,11 +1470,150 @@ KafkaLimitsSpec
-+
KafkaSource is the Schema for the kafkasources API.
+ +| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec
+
+
+KafkaSourceSpec
+
+
+ |
+
+ + +
|
+||||||||||||||
+status
+
+
+KafkaSourceStatus
+
+
+ |
++ | +
(Appears on: -KafkaSourceSpec) +KafkaSourceSpec)
@@ -1656,7 +1629,7 @@ KafkaLimitsSpec
sasl
-
+
KafkaSourceSASLSpec
@@ -1668,7 +1641,7 @@ KafkaSourceSASLSpec
tls
-
+
KafkaSourceTLSSpec
@@ -1678,11 +1651,11 @@ KafkaSourceTLSSpec
-(Appears on: -KafkaSourceNetSpec) +KafkaSourceNetSpec)
@@ -1708,7 +1681,7 @@ bool
user
-
+
SecretValueFromSource
@@ -1722,7 +1695,7 @@ SecretValueFromSource
password
-
+
SecretValueFromSource
@@ -1734,11 +1707,11 @@ SecretValueFromSource
-(Appears on: -KafkaSource) +KafkaSource)
KafkaSourceSpec defines the desired state of the KafkaSource.
@@ -1788,7 +1761,7 @@ stringnet
-
+
KafkaSourceNetSpec
@@ -1824,7 +1797,7 @@ Adapter Deployment.
resources
-
+
KafkaResourceSpec
@@ -1835,11 +1808,11 @@ KafkaResourceSpec
-(Appears on: -KafkaSource) +KafkaSource)
KafkaSourceStatus defines the observed state of KafkaSource.
@@ -1882,11 +1855,11 @@ string -(Appears on: -KafkaSourceNetSpec) +KafkaSourceNetSpec)
@@ -1912,7 +1885,7 @@ bool
cert
-
+
SecretValueFromSource
@@ -1926,7 +1899,7 @@ SecretValueFromSource
key
-
+
SecretValueFromSource
@@ -1940,7 +1913,7 @@ SecretValueFromSource
caCert
-
+
SecretValueFromSource
@@ -1952,11 +1925,11 @@ SecretValueFromSource
-(Appears on: -PrometheusSource) +PrometheusSource)
PrometheusSourceSpec defines the desired state of PrometheusSource
@@ -2070,11 +2043,11 @@ name to use as the sink. -(Appears on: -PrometheusSource) +PrometheusSource)
PrometheusSourceStatus defines the observed state of PrometheusSource
@@ -2118,12 +2091,12 @@ for the PrometheusSource. -(Appears on: -KafkaSourceSASLSpec, -KafkaSourceTLSSpec) +KafkaSourceSASLSpec, +KafkaSourceTLSSpec)
SecretValueFromSource represents the source of a secret value
@@ -2151,11 +2124,11 @@ Kubernetes core/v1.SecretKeySelector -(Appears on: -GitHubSourceSpec) +GitHubSourceSpec)
SecretValueFromSource represents the source of a secret value
@@ -2613,5 +2586,5 @@ knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
Generated with gen-crd-api-reference-docs
-on git commit 395598e8.
+on git commit a49a7c73.
Packages:
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+Package v1beta1 is the v1beta1 version of the API.
Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-sources.knative.dev/v1alpha1
+messaging.knative.dev/v1beta1
|
@@ -57,7 +77,7 @@ sources.knative.dev/v1alpha1
ApiServerSource |
+Channel |
|||||||||||
| @@ -69,6 +89,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -77,64 +98,44 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ApiServerSourceSpec
+
+ChannelSpec
|
+ Spec defines the desired state of the Channel.
|
status
-
-ApiServerSourceStatus
+
+ChannelStatus
|
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. |
-
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.
InMemoryChannel is a resource representing an in memory channel
-sources.knative.dev/v1alpha1
+messaging.knative.dev/v1beta1
|
@@ -187,7 +186,7 @@ sources.knative.dev/v1alpha1
SinkBinding |
+InMemoryChannel |
|||||||
| @@ -199,6 +198,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -207,39 +207,30 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SinkBindingSpec
+
+InMemoryChannelSpec
|
+ Spec defines the desired state of the Channel.
|
status
-
-SinkBindingStatus
+
+InMemoryChannelStatus
|
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. |
-(Appears on: -ApiServerSourceSpec) -
--
ApiServerResource defines the resource to watch
+Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
apiVersion
-
-string
-
- |
+string
- API version of the resource to watch. +
+messaging.knative.dev/v1beta1
+
|
|
kind
-
string
-
- |
-
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
+Subscription |
-labelSelector
+metadata
-
-Kubernetes meta/v1.LabelSelector
+
+Kubernetes meta/v1.ObjectMeta
|
- LabelSelector restricts this source to objects with the selected labels -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|
-controllerSelector
+spec
-
-Kubernetes meta/v1.OwnerReference
+
+SubscriptionSpec
|
- ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. - |
-
-controller
+channel
-bool
+
+Kubernetes core/v1.ObjectReference
+
|
- If true, send an event referencing the object controlling the resource +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.) |
-(Appears on: -ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
- -| Field | -Description | -
|---|---|
-resources
+subscriber
-
-[]ApiServerResource
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- Resources is the list of resources to watch +(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. |
-serviceAccountName
+reply
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-sink
+delivery
-knative.dev/pkg/apis/duck/v1beta1.Destination
+
+DeliverySpec
+
|
(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +Delivery configuration + |
+
mode
+status
-string
+
+SubscriptionStatus
+
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.
+
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ +(Appears on: -ApiServerSource) +Channel)
-
ApiServerSourceStatus defines the observed state of ApiServerSource
+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.
-Status
+channelTemplate
-knative.dev/pkg/apis/duck/v1.Status
+
+ChannelTemplateSpec
+
|
-
-(Members of 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. +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. |
-sinkUri
+ChannelableSpec
-string
+
+ChannelableSpec
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the ApiServerSource. +
+(Members of Channel conforms to ChannelableSpec |
(Appears on: -SinkBinding) +Channel)
-
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ChannelStatus represents the current state of a Channel.
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of |
-
-BindingSpec
+ChannelableStatus
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+ChannelableStatus
+
|
-(Members of Channel conforms to ChannelableStatus |
-(Appears on: -SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -| Field | -Description | -
|---|---|
-SourceStatus
+channel
-knative.dev/pkg/apis/duck/v1.SourceStatus
+knative.dev/pkg/apis/duck/v1.KReference
|
-
-(Members of Channel is an KReference to the Channel CRD backing this Channel. |
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: -string alias)-(Appears on: -DeliverySpec) -
--
BackoffPolicyType is the type for backoff policies
- --
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- -(Appears on: BrokerSpec, +ChannelSpec, ChannelSpec, ParallelSpec, -ParallelSpec, -SequenceSpec, +ParallelSpec, +SequenceSpec, SequenceSpec)
@@ -596,7 +539,7 @@ in verbatim to the Channel CRD as Spec section.
-
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that @@ -644,12 +587,16 @@ in verbatim to the Channel CRD as Spec section.
--
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.
+(Appears on: +InMemoryChannel) + ++
InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
-metadata
+ChannelableSpec
-
-Kubernetes meta/v1.ObjectMeta
+
+ChannelableSpec
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of Channel conforms to Duck type Channelable. |
+(Appears on: +InMemoryChannel) +
++
ChannelStatus represents the current state of a Channel.
+ +| Field | +Description | +
|---|---|
-spec
+ChannelableStatus
-
-ChannelableSpec
+
+ChannelableStatus
|
- Spec is the part where the Channelable fulfills the Subscribable contract. -- +
+(Members of Channel conforms to Duck type Channelable. + |
+
+(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 | +
|---|---|
-SubscribableTypeSpec
+channel
-
-SubscribableTypeSpec
+
+Kubernetes core/v1.ObjectReference
|
-
-(Members of 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.) |
-delivery
+subscriber
-
-DeliverySpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- DeliverySpec contains options controlling the event delivery +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
+
+Reply specifies (optionally) how to handle events returned from +the Subscriber target.
status
+delivery
-
-ChannelableStatus
+
+DeliverySpec
Delivery configuration
(Appears on: -Channelable) +Subscription)
-
ChannelableSpec contains Spec of the Channelable object
+SubscriptionStatus (computed) for a subscription
-SubscribableTypeSpec
+Status
-
-SubscribableTypeSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of 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. |
-delivery
+physicalSubscription
-
-DeliverySpec
+
+SubscriptionStatusPhysicalSubscription
|
-(Optional)
- DeliverySpec contains options controlling the event delivery +PhysicalSubscription is the fully resolved values that this Subscription represents. |
(Appears on: -Channelable) +SubscriptionStatus)
-
ChannelableStatus contains the Status of a Channelable object.
+SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
-Status
+subscriberUri
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis.URL
|
-
-(Members of 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 is the fully resolved URI for spec.subscriber. |
-AddressStatus
+replyUri
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+knative.dev/pkg/apis.URL
|
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +ReplyURI is the fully resolved URI for the spec.reply. |
-SubscribableTypeStatus
+deadLetterSinkUri
-
-SubscribableTypeStatus
-
+knative.dev/pkg/apis.URL
|
-
-(Members of 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 +ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. |
-(Appears on: -BrokerSpec, -ChannelableSpec, -SubscriptionSpec) +
Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types: + +-
DeliverySpec contains the delivery options for event senders, -such as channelable and source.
+ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
-deadLetterSink
-
-knative.dev/pkg/apis/duck/v1.Destination
-
+apiVersion
+string |
+
+
+configs.internal.knative.dev/v1alpha1
+
|
+|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-(Optional)
- DeadLetterSink is the sink receiving event that couldn’t be sent to -a destination. +kind
+string
|
+ConfigMapPropagation |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-retry
+metadata
-int32
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
- Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-backoffPolicy
+spec
-
-BackoffPolicyType
+
+ConfigMapPropagationSpec
|
-(Optional)
- BackoffPolicy is the retry backoff policy (linear, exponential) +Spec defines the desired state of the ConfigMapPropagation ++ +
DeliveryStatus --- DeliveryStatus contains the Status of an object supporting delivery options. - -
Resource
+ |
-metadata
+originalNamespace
-
-Kubernetes meta/v1.ObjectMeta
+string
+
+ |
+
+ OriginalNamespace is the namespace where the original configMaps are in + |
+
+selector
+
+
+Kubernetes meta/v1.LabelSelector
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+(Optional)
+Selector only selects original configMaps with corresponding labels |
(Appears on: -ChannelSpec, -InMemoryChannelSpec, -SubscribableTypeSpec) +ConfigMapPropagation)
-
Subscribable is the schema for the subscribable portion of the spec -section of the resource.
+ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
-subscribers
+Status
-
-[]SubscriberSpec
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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
|
- This is the list of subscriptions for this subscribable. +(Optional) +CopyConfigMaps is the status for each copied configmap. |
(Appears on: -SubscribableTypeStatus) +ConfigMapPropagationStatus)
-
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
+ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
-subscribers
+name
-
-[]SubscriberStatus
-
+string
|
- This is the list of subscription’s statuses for this channel. +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 |
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: +string alias)+(Appears on: +DeliverySpec) +
++
BackoffPolicyType is the type for backoff policies
+ +-
SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers +
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 -SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
+Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
spec
-
-SubscribableTypeSpec
+
+ChannelableSpec
|
- SubscribableTypeSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. +Spec is the part where the Channelable fulfills the Subscribable contract.
|
status
-
-SubscribableTypeStatus
+
+ChannelableStatus
|
- SubscribableTypeStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. |
(Appears on: -ChannelableSpec, -SubscribableType) +ChannelSpec, +Channelable, +InMemoryChannelSpec)
-
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
+ChannelableSpec contains Spec of the Channelable object
-subscribable
+SubscribableSpec
-
-Subscribable
+
+SubscribableSpec
|
+
+(Members of |
-(Appears on: -ChannelStatus, -ChannelableStatus, -InMemoryChannelStatus, -SubscribableType) -
--
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
- -| Field | -Description | -
|---|---|
-subscribableStatus
+delivery
-
-SubscribableStatus
+
+DeliverySpec
|
+(Optional)
+ DeliverySpec contains options controlling the event delivery |
(Appears on: -Subscribable) +ChannelStatus, +Channelable, +InMemoryChannelStatus)
-
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
+ChannelableStatus contains the Status of a Channelable object.
-uid
-
-k8s.io/apimachinery/pkg/types.UID
-
- |
-
-(Optional)
- UID is used to understand the origin of the subscriber. - |
-
-generation
+Status
-int64
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- Generation of the origin of the subscriber with uid:UID. +
+(Members of 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
+AddressStatus
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis/duck/v1.AddressStatus
|
-(Optional)
+
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. |
-replyURI
+SubscribableStatus
-knative.dev/pkg/apis.URL
+
+SubscribableStatus
+
|
-(Optional)
+
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
-deadLetterSink
+deadLetterChannel
-knative.dev/pkg/apis.URL
+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. |
(Appears on: -SubscribableStatus) +BrokerSpec, +BrokerSpec, +ChannelSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ChannelableSpec, +InMemoryChannelSpec, +SequenceStep, +SequenceStep, +SubscriberSpec, +SubscriberSpec, +SubscriptionSpec, +SubscriptionSpec)
-
SubscriberStatus defines the status of a single subscriber to a Channel.
+DeliverySpec contains the delivery options for event senders, +such as channelable and source.
-uid
+deadLetterSink
-k8s.io/apimachinery/pkg/types.UID
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- UID is used to understand the origin of the subscriber. +DeadLetterSink is the sink receiving event that couldn’t be sent to +a destination. |
-observedGeneration
+retry
-int64
+int32
|
(Optional)
- Generation of the origin of the subscriber with uid:UID. +Retry is the minimum number of retries the sender should attempt when +sending an event before moving it to the dead letter sink. |
-ready
+backoffPolicy
-
-Kubernetes core/v1.ConditionStatus
+
+BackoffPolicyType
|
(Optional)
- Status of the subscriber. +BackoffPolicy is the retry backoff policy (linear, exponential) |
-message
+backoffDelay
string
|
(Optional)
- A human readable message indicating details of Ready status. +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^ |
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: - --
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.
+DeliveryStatus contains the Status of an object supporting delivery options.
-apiVersion
-string |
+
-
-eventing.knative.dev/v1alpha1
-
+(Optional)
+DeadLetterChannel is a KReference that is the reference to the native, platform specific channel +where failed events are sent to. |
+
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.
+ +
-kind
-string
- |
-Broker |
+Field | +Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
metadata
@@ -1412,7 +1523,6 @@ Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -1421,45 +1531,28 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-BrokerSpec
+
+SubscribableSpec
|
- Spec defines the desired state of the Broker. +SubscribableSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract.
|
status
-
-BrokerStatus
+
+SubscribableStatus
|
-(Optional)
- Status represents the current state of the Broker. This data may be out of -date. +SubscribableStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract. |
+(Appears on: +ChannelableCombinedSpec, +ChannelableSpec, +Subscribable) +
++
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
-apiVersion
-string |
+
-
-eventing.knative.dev/v1alpha1
-
+This is the list of subscriptions for this subscribable. |
+(Appears on: +ChannelableCombinedStatus, +ChannelableStatus, +Subscribable) +
++
SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
+ +
-kind
-string
- |
-EventType |
+Field | +Description |
|---|---|---|---|
-metadata
+subscribers
-
-Kubernetes meta/v1.ObjectMeta
+
+[]SubscriberStatus
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+This is the list of subscription’s statuses for this channel. |
+(Appears on: +SubscribableSpec) +
++
SubscriberSpec defines a single subscriber to a Subscribable.
+At least one of SubscriberURI and ReplyURI must be present
+ +| Field | +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-spec
+uid
-
-EventTypeSpec
-
+k8s.io/apimachinery/pkg/types.UID
|
- Spec defines the desired state of the EventType. -- -
SubscriberStatus +++(Appears on: +SubscribableStatus) + ++ SubscriberStatus defines the status of a single subscriber to a Channel. + +
| ||||||||||||
+observedGeneration
+
+int64
+
+ |
+
+(Optional)
+ Generation of the origin of the subscriber with uid:UID. |
||||||||||||
-status
+ready
-
-EventTypeStatus
+
+Kubernetes core/v1.ConditionStatus
|
+ Status of the subscriber. + |
+||||||||||||
+message
+
+string
+
+ |
+
(Optional)
- Status represents the current state of the EventType. -This data may be out of date. +A human readable message indicating details of Ready status. |
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: +-
Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
- |
-|||||||||
-kind
-string
- |
-Trigger |
-|||||||||
metadata
@@ -1668,53 +1833,55 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-TriggerSpec
+
+ParallelSpec
- | Spec defines the desired state of the Trigger. +Spec defines the desired state of the Parallel.
|
status
-
-TriggerStatus
+
+ParallelStatus
(Optional)
- |
Status represents the current state of the Trigger. This data may be out of + Status represents the current state of the Parallel. This data may be out of date. |
(Appears on: -Broker) +ParallelSpec)
@@ -1755,45 +1922,50 @@ date.
channelTemplateSpec
+filter
-
-ChannelTemplateSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
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).
+Filter is the expression guarding the branch
delivery
+subscriber
-
-DeliverySpec
-
+knative.dev/pkg/apis/duck/v1.Destination
+
+Subscriber receiving the event when the filter passes
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
Delivery is the delivery specification to be used internally by the broker to -create subscriptions.
+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
(Appears on: -Broker) +ParallelStatus)
-
BrokerStatus represents the current state of a Broker.
+ParallelBranchStatus represents the current state of a Parallel branch
-Status
+filterSubscriptionStatus
-knative.dev/pkg/apis/duck/v1.Status
+
+ParallelSubscriptionStatus
+
|
-
-(Members of 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. +FilterSubscriptionStatus corresponds to the filter subscription status. |
-address
+filterChannelStatus
-knative.dev/pkg/apis/duck/v1alpha1.Addressable
+
+ParallelChannelStatus
+
|
- 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} +FilterChannelStatus corresponds to the filter channel status. |
-triggerChannel
+subscriberSubscriptionStatus
-
-Kubernetes core/v1.ObjectReference
+
+ParallelSubscriptionStatus
|
- TriggerChannel is an objectref to the object for the TriggerChannel +SubscriptionStatus corresponds to the subscriber subscription status. |
(Appears on: -EventType) +ParallelBranchStatus, +ParallelStatus)
@@ -1866,72 +2035,97 @@ Kubernetes core/v1.ObjectReference
type
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
Type represents the CloudEvents type. It is authoritative.
+Channel is the reference to the underlying channel.
source
+ready
-string
+knative.dev/pkg/apis.Condition
Source is a URI, it represents the CloudEvents source.
+ReadyCondition indicates whether the Channel is ready or not.
+(Appears on: +Parallel) +
++
+| Field | +Description | +
|---|---|
-schema
+branches
-string
+
+[]ParallelBranch
+
|
-(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. +Branches is the list of Filter/Subscribers pairs. |
-broker
+channelTemplate
-string
+
+ChannelTemplateSpec
+
|
- Broker refers to the Broker that can provide the EventType. +(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). |
-description
+reply
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. +Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply |
(Appears on: -EventType) +Parallel)
-
EventTypeStatus represents the current state of a EventType.
+ParallelStatus represents the current state of a Parallel.
-(Appears on: -TriggerSpec) -
--
-| Field | -Description | -
|---|---|
-sourceAndType
+ingressChannelStatus
-
-TriggerFilterSourceAndType
+
+ParallelChannelStatus
|
-(Optional)
- DeprecatedSourceAndType filters events based on exact matches on the -CloudEvents type and source attributes. This field has been replaced by the -Attributes field. +IngressChannelStatus corresponds to the ingress channel status. |
-attributes
+branchStatuses
-
-TriggerFilterAttributes
+
+[]ParallelBranchStatus
|
-(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. - |
-
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.
- --(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.
- -| Field | -Description | -
|---|---|
-type
-
-string
-
- |
-
+ BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order. |
-source
+AddressStatus
-string
+knative.dev/pkg/apis/duck/v1.AddressStatus
|
- | -
-(Appears on: -Trigger) -
+(Members of AddressStatus are embedded into this type.)
| 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
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
- Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required. +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} |
(Appears on: -Trigger) +ParallelBranchStatus)
-
TriggerStatus represents the current state of a Trigger.
-Status
+subscription
-knative.dev/pkg/apis/duck/v1.Status
+
+Kubernetes core/v1.ObjectReference
+
|
-
-(Members of 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. +Subscription is the reference to the underlying Subscription. |
-subscriberURI
+ready
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis.Condition
|
- SubscriberURI is the resolved URI of the receiver for this Trigger. +ReadyCondition indicates whether the Subscription is ready or not. |
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: --
Parallel defines conditional branches that will be wired in +
Sequence defines a sequence of Subscribers that will be wired in series through Channels and Subscriptions.
spec
-
-ParallelSpec
+
+SequenceSpec
|
- Spec defines the desired state of the Parallel. +Spec defines the desired state of the Sequence.
|
status
-
-ParallelStatus
+
+SequenceStatus
|
(Optional)
- Status represents the current state of the Parallel. This data may be out of + Status represents the current state of the Sequence. This data may be out of date. |
(Appears on: -ParallelSpec) +SequenceStatus)
@@ -2295,49 +2360,37 @@ date.
filter
-
-knative.dev/pkg/apis/duck/v1.Destination
-
-Filter is the expression guarding the branch
-subscriber
+channel
-knative.dev/pkg/apis/duck/v1.Destination
+
+Kubernetes core/v1.ObjectReference
+
Subscriber receiving the event when the filter passes
+Channel is the reference to the underlying channel.
reply
+ready
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis.Condition
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
+ReadyCondition indicates whether the Channel is ready or not.
(Appears on: -ParallelStatus) +Sequence)
-
ParallelBranchStatus represents the current state of a Parallel branch
-filterSubscriptionStatus
+steps
-
-ParallelSubscriptionStatus
+
+[]SequenceStep
|
- FilterSubscriptionStatus corresponds to the filter subscription status. +Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options |
-filterChannelStatus
+channelTemplate
-
-ParallelChannelStatus
+
+ChannelTemplateSpec
|
- FilterChannelStatus corresponds to the filter channel status. +(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). |
-subscriberSubscriptionStatus
+reply
-
-ParallelSubscriptionStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- SubscriptionStatus corresponds to the subscriber subscription status. +(Optional) +Reply is a Reference to where the result of the last Subscriber gets sent to. |
(Appears on: -ParallelBranchStatus, -ParallelStatus) +Sequence)
+
SequenceStatus represents the current state of a Sequence.
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Channel is the reference to the underlying channel. - |
-
-ready
+Status
-knative.dev/pkg/apis.Condition
+knative.dev/pkg/apis/duck/v1.Status
|
- ReadyCondition indicates whether the Channel is ready or not. - |
-
-(Appears on: -Parallel) -
+(Members of Status are embedded into this type.)
| Field | -Description | +
|---|---|
-branches
+subscriptionStatuses
-
-[]ParallelBranch
+
+[]SequenceSubscriptionStatus
|
- Branches is the list of Filter/Subscribers pairs. +SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order. |
-channelTemplate
+channelStatuses
-
-ChannelTemplateSpec
+
+[]SequenceChannelStatus
|
-(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). +ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order. |
-reply
+AddressStatus
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.AddressStatus
|
-(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply +
+(Members of 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} |
(Appears on: -Parallel) +SequenceSpec)
-
ParallelStatus represents the current state of a Parallel.
-Status
+Destination
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.Destination
|
-(Members of 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. +Subscriber receiving the step event |
-branchStatuses
+delivery
-
-[]ParallelBranchStatus
+
+DeliverySpec
|
- 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 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} +(Optional) +Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. |
(Appears on: -ParallelBranchStatus) +SequenceStatus)
@@ -2610,11 +2611,25 @@ knative.dev/pkg/apis.Condition -
+
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+ +Resource Types: +-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
+ApiServerSource is the Schema for the apiserversources API
+apiVersion
+string |
+
+
+sources.eventing.knative.dev/v1alpha1
+
+ |
+||||||||||||
+kind
+string
+ |
+ApiServerSource |
+||||||||||||
+Deprecated
+
+
+Deprecated
+
+
+ |
+
+ Deprecated allows ApiServerSource to have a deprecated message. + |
+||||||||||||
metadata
@@ -2634,7 +2679,6 @@ Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -2643,53 +2687,64 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SequenceSpec
+
+ApiServerSourceSpec
|
- Spec defines the desired state of the Sequence.
|
status
-
-SequenceStatus
+
+ApiServerSourceStatus
|
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. |
-(Appears on: -SequenceStatus) -
-+
ContainerSource is the Schema for the containersources API
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
+apiVersion
+string |
+
+
+sources.eventing.knative.dev/v1alpha1
+
|
+
|
- Channel is the reference to the underlying channel. +kind
+string
|
+ContainerSource |
-ready
+Deprecated
-knative.dev/pkg/apis.Condition
+
+Deprecated
+
|
- ReadyCondition indicates whether the Channel is ready or not. +Deprecated allows ContainerSource to have a deprecated message. |
-(Appears on: -Sequence) -
--
-| Field | -Description | -
|---|---|
-steps
+metadata
-[]knative.dev/pkg/apis/duck/v1.Destination
+
+Kubernetes meta/v1.ObjectMeta
+
|
- Steps is the list of Destinations (processors / functions) that will be called in the order -provided. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-channelTemplate
+spec
-
-ChannelTemplateSpec
+
+ContainerSourceSpec
|
-(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
+template
-knative.dev/pkg/apis/duck/v1.Destination
+
+Kubernetes core/v1.PodTemplateSpec
+
|
(Optional)
- Reply is a Reference to where the result of the last Subscriber gets sent to. +Template describes the pods that will be created |
-(Appears on: -Sequence) -
--
SequenceStatus represents the current state of a Sequence.
- -| Field | -Description | -
|---|---|
-Status
+image
-knative.dev/pkg/apis/duck/v1.Status
+string
|
-
-(Members of 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. +DeprecatedImage is the image to run inside of the container.
+This field is to be deprecated. Use |
-subscriptionStatuses
+args
-
-[]SequenceSubscriptionStatus
-
+[]string
|
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. +DeprecatedArgs are passed to the ContainerSpec as they are.
+This field is to be deprecated. Use |
-channelStatuses
+env
-
-[]SequenceChannelStatus
+
+[]Kubernetes core/v1.EnvVar
|
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. +(Optional) +DeprecatedEnv is the list of environment variables to set in the container.
+Cannot be updated.
+This field is to be deprecated. Use |
-AddressStatus
+serviceAccountName
-knative.dev/pkg/apis/duck/v1.AddressStatus
+string
|
-
-(Members of 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} +(Optional) +DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this
+source.
+This field is to be deprecated. Use |
-(Appears on: -SequenceStatus) -
--
-| Field | -Description | -
|---|---|
-subscription
+sink
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1beta1.Destination
|
- Subscription is the reference to the underlying Subscription. +Sink is a reference to an object that will resolve to a domain name to use as the sink. + |
+
ready
+status
-knative.dev/pkg/apis.Condition
+
+ContainerSourceStatus
+
ReadyCondition indicates whether the Subscription is ready or not.
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+CronJobSource is the Schema for the cronjobsources API.
ApiServerSource |
+CronJobSource |
|||||||||
| @@ -2987,7 +2974,7 @@ Deprecated |
- Deprecated allows ApiServerSource to have a deprecated message. +Deprecated allows CronJobSource to have a deprecated message. |
|||||||||
spec
-
-ApiServerSourceSpec
+
+CronJobSourceSpec
|
@@ -3019,28 +3006,24 @@ ApiServerSourceSpec
-resources
+schedule
-
-[]ApiServerResource
-
+string
|
- Resources is the list of resources to watch +Schedule is the cronjob schedule. |
-serviceAccountName
+data
string
|
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. +Data is the data posted to the target function. |
|
-(Optional)
Sink is a reference to an object that will resolve to a domain name to use as the sink. |
|
-mode
+serviceAccountName
string
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
- 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
-
-ApiServerSourceStatus
+
+CronJobSourceStatus
-
ContainerSource is the Schema for the containersources API
+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.
ContainerSource |
+SinkBinding |
||||||||||||
| @@ -3125,7 +3124,7 @@ Deprecated |
- Deprecated allows ContainerSource to have a deprecated message. +Deprecated allows ApiServerSource to have a deprecated message. |
||||||||||||
spec
-
-ContainerSourceSpec
+
+SinkBindingSpec
|
@@ -3157,85 +3156,28 @@ 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 |
-
-args
-
-[]string
-
- |
-
- DeprecatedArgs are passed to the ContainerSpec as they are.
-This field is to be deprecated. Use |
-
-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 |
-
-serviceAccountName
+SourceSpec
-string
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Optional)
- DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this
-source.
-This field is to be deprecated. Use
+(Members of |
-sink
+BindingSpec
-knative.dev/pkg/apis/duck/v1beta1.Destination
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +
+(Members of |
status
-
-ContainerSourceStatus
+
+SinkBindingStatus
-
CronJobSource is the Schema for the cronjobsources API.
+(Appears on: +ApiServerSourceSpec) + ++
ApiServerResource defines the resource to watch
apiVersion
-string |
+
+string
+
+
-
-sources.eventing.knative.dev/v1alpha1
-
+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 |
-CronJobSource |
-Deprecated
+labelSelector
-
-Deprecated
+
+Kubernetes meta/v1.LabelSelector
|
- Deprecated allows CronJobSource to have a deprecated message. +LabelSelector restricts this source to objects with the selected labels +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
|
-metadata
+controllerSelector
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes meta/v1.OwnerReference
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. +Only apiVersion and kind are used. Both are optional. |
|
-spec
+controller
-
-CronJobSourceSpec
-
+bool
|
- - + If true, send an event referencing the object controlling the resource + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceSpec defines the desired state of ApiServerSource
+| Field | +Description | +
|---|---|
-schedule
+resources
-string
+
+[]ApiServerResource
+
|
- Schedule is the cronjob schedule. +Resources is the list of resources to watch |
-data
+serviceAccountName
string
|
- Data is the data posted to the target function. +(Optional) +ServiceAccountName is the name of the ServiceAccount to use to run this +source. |
|
+(Optional)
Sink is a reference to an object that will resolve to a domain name to use as the sink. |
|
-serviceAccountName
+mode
string
|
- ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. +Mode is the mode the receive adapter controller runs under: Ref or Resource.
+ |
+(Appears on: +ApiServerSource) +
++
ApiServerSourceStatus defines the observed state of ApiServerSource
+ +| Field | +Description | +
|---|---|
-resources
+Status
-
-CronJobResourceSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
- Resource limits and Request specifications of the Receive Adapter Deployment - |
-
+(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.
status
+sinkUri
-
-CronJobSourceStatus
-
+string
SinkURI is the current active sink URI that has been configured for the ApiServerSource.
-
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.
+
ContainerSourceSpec defines the desired state of ContainerSource
-apiVersion
-string |
+
-
-sources.eventing.knative.dev/v1alpha1
-
+(Optional)
+Template describes the pods that will be created |
||||||
-kind
+image
+
string
+
+ |
+
+ DeprecatedImage is the image to run inside of the container.
+This field is to be deprecated. Use |
-SinkBinding |
|||||
-Deprecated
+args
-
-Deprecated
-
+[]string
|
- Deprecated allows ApiServerSource to have a deprecated message. +DeprecatedArgs are passed to the ContainerSpec as they are.
+This field is to be deprecated. Use |
||||||
-metadata
+env
-
-Kubernetes meta/v1.ObjectMeta
+
+[]Kubernetes core/v1.EnvVar
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+(Optional)
+DeprecatedEnv is the list of environment variables to set in the container.
+Cannot be updated.
+This field is to be deprecated. Use |
||||||
-spec
+serviceAccountName
-
-SinkBindingSpec
-
+string
|
- - -
ContainerSourceStatus +
-(Members of |
+
| Field | +Description |
|---|---|
-BindingSpec
+Status
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of |
-
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.
status
+sinkUri
-
-SinkBindingStatus
-
+string
SinkURI is the current active sink URI that has been configured for the ContainerSource.
(Appears on: -ApiServerSourceSpec) +CronJobResourceSpec)
-
ApiServerResource defines the resource to watch
-apiVersion
+cpu
string
|
- API version of the resource to watch. |
-kind
+memory
string
|
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
+(Appears on: +CronJobResourceSpec) +
++
+| Field | +Description | +
|---|---|
-labelSelector
+cpu
-
-Kubernetes meta/v1.LabelSelector
-
+string
|
- 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
+memory
-
-Kubernetes meta/v1.OwnerReference
+string
+
+ |
++ | +
+(Appears on: +CronJobSourceSpec) +
++
+| Field | +Description | +
|---|---|
+requests
+
+
+CronJobRequestsSpec
|
- ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. |
-controller
+limits
-bool
+
+CronJobLimitsSpec
+
|
- If true, send an event referencing the object controlling the resource |
(Appears on: -ApiServerSource) +CronJobSource)
-
ApiServerSourceSpec defines the desired state of ApiServerSource
+CronJobSourceSpec defines the desired state of the CronJobSource.
-resources
+schedule
-
-[]ApiServerResource
-
+string
|
- Resources is the list of resources to watch +Schedule is the cronjob schedule. |
-serviceAccountName
+data
string
|
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. +Data is the data posted to the target function. |
|
-(Optional)
Sink is a reference to an object that will resolve to a domain name to use as the sink. |
|
-mode
+serviceAccountName
string
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
- 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 |
(Appears on: -ApiServerSource) +CronJobSource)
-
ApiServerSourceStatus defines the observed state of ApiServerSource
+CronJobSourceStatus defines the observed state of CronJobSource.
|
(Optional)
- SinkURI is the current active sink URI that has been configured for the ApiServerSource. +SinkURI is the current active sink URI that has been configured for the CronJobSource. |
(Appears on: -ContainerSource) +ApiServerSource, +ContainerSource, +CronJobSource, +SinkBinding)
-
ContainerSourceSpec defines the desired state of ContainerSource
+ ++(Appears on: +SinkBinding) +
++
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
-template
+SourceSpec
-
-Kubernetes core/v1.PodTemplateSpec
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Optional)
- Template describes the pods that will be created +
+(Members of |
-image
+BindingSpec
-string
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
- DeprecatedImage is the image to run inside of the container.
-This field is to be deprecated. Use |
-
+(Appears on: +SinkBinding) +
++
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
+ +| Field | +Description | +
|---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of |
+
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: ++
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
+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. ++ +
|
+||||||
+status
+
+
+ChannelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. + |
+
+
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. ++ +
|
+||||
+status
+
+
+InMemoryChannelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. + |
+
+
Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
+ +| Field | +Description | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
+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
+
+
+ |
+
+ + +
|
+||||||||||
+status
+
+
+SubscriptionStatus
+
+
+ |
++ | +
+(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.
+ +| Field | +Description | +
|---|---|
+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. + |
+
+(Appears on: +Channel) +
++
ChannelStatus represents the current state of a Channel.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 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 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. + |
+
+(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. + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+ For round tripping (v1beta1 <-> v1alpha1> + |
+
+(Appears on: +InMemoryChannel) +
++
ChannelStatus represents the current state of a Channel.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 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 Subscribers is populated with the statuses of each of the Channelable’s subscribers. + |
+
+(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
+
+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 + |
+
+(Appears on: +Subscription) +
++
SubscriptionStatus (computed) for a subscription
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +SubscriptionStatus) +
++
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
+ +| Field | +Description | +
|---|---|
+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. + |
+
+
Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
+ +Resource Types: ++
ApiServerSource is the Schema for the apiserversources API
+ +| Field | +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+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
+
+
+ |
+
+ + +
|
+||||||||||||
+status
+
+
+ApiServerSourceStatus
+
+
+ |
++ | +
+
PingSource is the Schema for the PingSources API.
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
+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
+
+
+ |
+
+ + +
|
+||||||
+status
+
+
+PingSourceStatus
+
+
+ |
++ | +
+
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.
| Field | +Description | +||||
|---|---|---|---|---|---|
+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
+
+
+ |
+
+ + +
|
+||||
+status
+
+
+SinkBindingStatus
+
+
+ |
++ | +
+(Appears on: +ApiServerSourceSpec, +ApiServerSourceSpec) +
++
APIVersionKind is an APIVersion and Kind tuple.
+ +| Field | +Description | +
|---|---|
+apiVersion
+
+string
+
+ |
+
+(Optional)
+ APIVersion - the API version of the resource to watch. + |
+
+kind
+
+string
+
+ |
+
+(Optional)
+ Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceSpec defines the desired state of ApiServerSource
+ +| Field | +Description | +
|---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of 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
+
+
+[]APIVersionKind
+
+
+ |
+
+ Resource is the resource this source will track and send related +lifecycle events from the Kubernetes ApiServer. + |
+
+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 + |
+
+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.
+ |
+
+serviceAccountName
+
+string
+
+ |
+
+(Optional)
+ ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set. + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceStatus defines the observed state of ApiServerSource
+ +| Field | +Description | +
|---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +PingSource) +
++
PingSourceSpec defines the desired state of the PingSource.
+ +| Field | +Description | +
|---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of 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”. + |
+
+(Appears on: +PingSource) +
++
PingSourceStatus defines the observed state of PingSource.
+ +| Field | +Description | +
|---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +SinkBinding) +
++
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ +| Field | +Description | +
|---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of 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 inherits duck/v1alpha1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations. + |
+
+(Appears on: +SinkBinding) +
++
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
+ +| Field | +Description | +
|---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. + |
+
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: ++
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 | +||||
|---|---|---|---|---|---|
+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. ++ +
|
+||||
+status
+
+
+ChannelableStatus
+
+
+ |
++ | +
+
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.
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
+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. ++ +
|
+||||||
+status
+
+
+ChannelableCombinedStatus
+
+
+ |
++ | +
+(Appears on: +ChannelableCombined) +
++
ChannelableSpec contains Spec of the Channelable object
+ +| Field | +Description | +
|---|---|
+SubscribableTypeSpec
+
+
+SubscribableTypeSpec
+
+
+ |
+
+
+(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. + |
+
+SubscribableSpec
+
+
+SubscribableSpec
+
+
+ |
+
+
+(Members of SubscribableSpec is for the v1beta1 spec compatibility. + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ DeliverySpec contains options controlling the event delivery + |
+
+(Appears on: +ChannelableCombined) +
++
ChannelableStatus contains the Status of a Channelable object.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 is the part where the Channelable fulfills the Addressable contract. + |
+
+SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+ |
+
+
+(Members of SubscribableTypeStatus is the v1alpha1 part of the Subscribers status + |
+
+SubscribableStatus
+
+
+SubscribableStatus
+
+
+ |
+
+
+(Members of 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 + |
+
+(Appears on: +Channelable) +
++
ChannelableSpec contains Spec of the Channelable object
+ +| Field | +Description | +
|---|---|
+SubscribableTypeSpec
+
+
+SubscribableTypeSpec
+
+
+ |
+
+
+(Members of |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ DeliverySpec contains options controlling the event delivery + |
+
+(Appears on: +Channelable) +
++
ChannelableStatus contains the Status of a Channelable object.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 is the part where the Channelable fulfills the Addressable contract. + |
+
+SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+ |
+
+
+(Members of 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 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.
+ +| Field | +Description | +
|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+(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. + |
+
+(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. + |
+
+
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 | +||
|---|---|---|---|
+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. ++ +
|
+||
+status
+
+
+SubscribableTypeStatus
+
+
+ |
+
+ SubscribableTypeStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract. + |
+
+(Appears on: +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType) +
++
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
+ +| Field | +Description | +
|---|---|
+subscribable
+
+
+Subscribable
+
+
+ |
++ | +
+(Appears on: +ChannelStatus, +ChannelableCombinedStatus, +ChannelableStatus, +InMemoryChannelStatus, +SubscribableType) +
++
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+ +| Field | +Description | +
|---|---|
+subscribableStatus
+
+
+SubscribableStatus
+
+
+ |
++ | +
+(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 | +
|---|---|
+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) + | +
+(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. + |
+
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: + ++
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. ++ +
|
+||||||
+status
+
+
+BrokerStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Broker. This data may be out of +date. + |
+
+
+| 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. ++ +
|
+||||||||||
+status
+
+
+EventTypeStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the EventType. +This data may be out of date. + |
+
+
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. ++ +
|
+||||||
+status
+
+
+TriggerStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Trigger. This data may be out of +date. + |
+
+(Appears on: +Broker) +
++
+| Field | +Description | +
|---|---|
+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 |
+
+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. + |
+
+(Appears on: +Broker) +
++
BrokerStatus represents the current state of a Broker.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 + |
+
+(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. + |
+
+(Appears on: +EventType) +
++
EventTypeStatus represents the current state of a EventType.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +TriggerSpec) +
++
+| Field | +Description | +
|---|---|
+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. + |
+
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.
+ ++(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.
+ +| Field | +Description | +
|---|---|
+type
+
+string
+
+ |
++ | +
+source
+
+string
+
+ |
++ | +
+(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
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required. + |
+
+(Appears on: +Trigger) +
++
TriggerStatus represents the current state of a Trigger.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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. + |
+
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: + ++
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/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. ++ +
|
+||||
+status
+
+
+BrokerStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Broker. This data may be out of +date. + |
+
+
+| Field | +Description | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
+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. ++ +
|
+||||||||||
+status
+
+
+EventTypeStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the EventType. +This data may be out of date. + |
+
+
Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
+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. ++ +
|
+||||||
+status
+
+
+TriggerStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Trigger. This data may be out of +date. + |
+
+(Appears on: +Broker) +
++
+| Field | +Description | +
|---|---|
-args
+config
-[]string
+knative.dev/pkg/apis/duck/v1.KReference
|
- DeprecatedArgs are passed to the ContainerSpec as they are.
-This field is to be deprecated. Use Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap. |
-env
+delivery
-
-[]Kubernetes core/v1.EnvVar
+
+DeliverySpec
|
(Optional)
- DeprecatedEnv is the list of environment variables to set in the container.
-Cannot be updated.
-This field is to be deprecated. Use Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc. |
+(Appears on: +Broker) +
++
BrokerStatus represents the current state of a Broker.
+ +| Field | +Description | +
|---|---|
-serviceAccountName
+Status
-string
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this
-source.
-This field is to be deprecated. Use
+(Members of 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. |
-sink
+address
-knative.dev/pkg/apis/duck/v1beta1.Destination
+knative.dev/pkg/apis/duck/v1.Addressable
|
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh. |
(Appears on: -ContainerSource) +EventType)
-
ContainerSourceStatus defines the observed state of ContainerSource
-Status
+type
-knative.dev/pkg/apis/duck/v1.Status
+string
|
-
-(Members of 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. +Type represents the CloudEvents type. It is authoritative. |
-sinkUri
+source
+
+knative.dev/pkg/apis.URL
+
+ |
+
+ 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. + |
+
+broker
+
+string
+
+ |
+
+ Broker refers to the Broker that can provide the EventType. + |
+
+description
string
|
(Optional)
- SinkURI is the current active sink URI that has been configured for the ContainerSource. +Description is an optional field used to describe the EventType, in any meaningful way. |
(Appears on: -CronJobResourceSpec) +EventType)
+
EventTypeStatus represents the current state of a EventType.
-cpu
+Status
-string
+knative.dev/pkg/apis/duck/v1.Status
|
+
+(Members of 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. |
+(Appears on: +TriggerSpec) +
++
+| Field | +Description | +
|---|---|
-memory
+attributes
-string
+
+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. |
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.
+ +(Appears on: -CronJobResourceSpec) +Trigger)
@@ -3921,33 +7911,53 @@ string
cpu
+broker
string
Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.
memory
+filter
-string
+
+TriggerFilter
+
+
+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.
(Appears on: -CronJobSourceSpec) +Trigger)
+
TriggerStatus represents the current state of a Trigger.
-requests
+Status
-
-CronJobRequestsSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
+
+(Members of 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. |
-limits
+subscriberUri
-
-CronJobLimitsSpec
-
+knative.dev/pkg/apis.URL
|
+ SubscriberURI is the resolved URI of the receiver for this Trigger. |
-(Appears on: -CronJobSource) +
Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types: +-
CronJobSourceSpec defines the desired state of the CronJobSource.
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
-schedule
+metadata
-string
+
+Kubernetes meta/v1.ObjectMeta
+
|
- Schedule is the cronjob schedule. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-data
+spec
-string
+
+ParallelSpec
+
|
- Data is the data posted to the target function. +Spec defines the desired state of the Parallel. ++ +
|
||||||
-resources
+status
-
-CronJobResourceSpec
+
+ParallelStatus
|
- Resource limits and Request specifications of the Receive Adapter Deployment +(Optional) +Status represents the current state of the Parallel. This data may be out of +date. |
(Appears on: -CronJobSource) +ParallelSpec)
-
CronJobSourceStatus defines the observed state of CronJobSource.
-Status
+filter
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of 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. +Filter is the expression guarding the branch |
-sinkUri
+subscriber
-string
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Subscriber receiving the event when the filter passes + |
+
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- SinkURI is the current active sink URI that has been configured for the CronJobSource. +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 |
-(Appears on: -ApiServerSource, -ContainerSource, -CronJobSource, -SinkBinding) -
--
-(Appears on: -SinkBinding) +ParallelStatus)
-
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ParallelBranchStatus represents the current state of a Parallel branch
-SourceSpec
+filterSubscriptionStatus
-knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ParallelSubscriptionStatus
+
|
-
-(Members of FilterSubscriptionStatus corresponds to the filter subscription status. |
-BindingSpec
+filterChannelStatus
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+ParallelChannelStatus
+
|
-
-(Members of FilterChannelStatus corresponds to the filter channel status. + |
+
+subscriberSubscriptionStatus
+
+
+ParallelSubscriptionStatus
+
+
+ |
+
+ SubscriptionStatus corresponds to the subscriber subscription status. |
(Appears on: -SinkBinding) +ParallelBranchStatus, +ParallelStatus)
-
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
-SourceStatus
+channel
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+Kubernetes core/v1.ObjectReference
+
|
-
-(Members of Channel is the reference to the underlying channel. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Channel is ready or not. |
-
Package v1alpha1 is the v1alpha1 version of the API.
+(Appears on: +Parallel) -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-apiVersion
-string |
-
-
-messaging.knative.dev/v1alpha1
-
- |
-||||
-kind
-string
- |
-Channel |
-||||
-metadata
+branches
-
-Kubernetes meta/v1.ObjectMeta
+
+[]ParallelBranch
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Branches is the list of Filter/Subscribers pairs. |
||||
-spec
-
-
-ChannelSpec
-
-
- |
-
- Spec defines the desired state of the Channel. -- -
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). |
||||
-status
+reply
-
-ChannelStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- Status represents the current state of the Channel. This data may be out of -date. +Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply |
-
InMemoryChannel is a resource representing an in memory channel
+(Appears on: +Parallel) -| Field | -Description | -|||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1alpha1
-
- |
-|||||||||||||||||||||||||||||||||
-kind
-string
- |
-InMemoryChannel |
+
| Field | +Description | ||
|---|---|---|---|
-metadata
+Status
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of 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. |
||
-spec
+ingressChannelStatus
-
-InMemoryChannelSpec
+
+ParallelChannelStatus
|
- Spec defines the desired state of the Channel. -- -
BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order. |
||
-status
+AddressStatus
-
-InMemoryChannelStatus
-
+knative.dev/pkg/apis/duck/v1.AddressStatus
|
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. +
+(Members of 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} |
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
+(Appears on: +ParallelBranchStatus) + +
-apiVersion
-string |
+
-
-messaging.knative.dev/v1alpha1
-
+Subscription is the reference to the underlying Subscription. |
|
-kind
-string
+ready
+
+knative.dev/pkg/apis.Condition
+
|
-Subscription |
+
+ ReadyCondition indicates whether the Subscription is ready or not. + |
+
+
Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
+ +| Field | +Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
metadata
@@ -4447,6 +8464,7 @@ Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -4455,116 +8473,126 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SubscriptionSpec
+
+SequenceSpec
|
+ Spec defines the desired state of the Sequence.
|
||||||
-reply
+status
-knative.dev/pkg/apis/duck/v1.Destination
+
+SequenceStatus
+
|
(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. +Status represents the current state of the Sequence. This data may be out of +date. |
+(Appears on: +SequenceStatus) +
++
+| Field | +Description | +
|---|---|
-delivery
+channel
-
-DeliverySpec
+
+Kubernetes core/v1.ObjectReference
|
-(Optional)
- Delivery configuration - |
-
Channel is the reference to the underlying channel.
status
+ready
-
-SubscriptionStatus
-
+knative.dev/pkg/apis.Condition
ReadyCondition indicates whether the Channel is ready or not.
(Appears on: -Channel) +Sequence)
-
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.
+steps
+
+
+[]SequenceStep
+
+
+ |
+
+ Steps is the list of Destinations (processors / functions) that will be called in the order +provided. + |
+
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. +(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). |
-subscribable
+reply
-
-Subscribable
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- Channel conforms to Duck type Subscribable. +(Optional) +Reply is a Reference to where the result of the last Subscriber gets sent to. |
(Appears on: -Channel) +Sequence)
-
ChannelStatus represents the current state of a Channel.
+SequenceStatus represents the current state of a Sequence.
-AddressStatus
+subscriptionStatuses
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+[]SequenceSubscriptionStatus
+
|
-
-(Members of 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} +SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order. |
-SubscribableTypeStatus
+channelStatuses
-
-SubscribableTypeStatus
+
+[]SequenceChannelStatus
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order. |
-channel
+AddressStatus
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.AddressStatus
|
- Channel is an ObjectReference to the Channel CRD backing this Channel. +
+(Members of 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} |
(Appears on: -InMemoryChannel) +SequenceSpec)
-
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
-subscribable
+Destination
-
-Subscribable
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+
+(Members of Subscriber receiving the step event + |
+
+delivery
+
+
+DeliverySpec
|
- Channel conforms to Duck type Subscribable. +(Optional) +Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. +Needed for Roundtripping v1alpha1 <-> v1beta1. |
(Appears on: -InMemoryChannel) +SequenceStatus)
-
ChannelStatus represents the current state of a Channel.
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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
+subscription
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+Kubernetes core/v1.ObjectReference
+
|
-
-(Members of 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} +Subscription is the reference to the underlying Subscription. |
-SubscribableTypeStatus
+ready
-
-SubscribableTypeStatus
-
+knative.dev/pkg/apis.Condition
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +ReadyCondition indicates whether the Subscription is ready or not. |
+
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+ +Resource Types: +-
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
+ApiServerSource is the Schema for the apiserversources API
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha1
+
+ |
+||||||||||||||||||
+kind
+string
+ |
+ApiServerSource |
+||||||||||||||||||
metadata
@@ -4810,7 +8867,6 @@ Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -4819,55 +8875,109 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ParallelSpec
+
+ApiServerSourceSpec
|
- Spec defines the desired state of the Parallel.
|
status
-
-ParallelStatus
+
+ApiServerSourceStatus
|
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. |
-(Appears on: -ParallelSpec) -
-+
PingSource is the Schema for the PingSources API.
| Field | Description | - - + + +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+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
+
+
+ |
+
+ + +
ParallelBranchStatus ---(Appears on: -ParallelStatus) - -- ParallelBranchStatus represents the current state of a Parallel branch - -
|
||||||||||||||
-subscriberSubscriptionStatus
+status
-
-ParallelSubscriptionStatus
+
+PingSourceStatus
|
- SubscriptionStatus corresponds to the subscriber subscription status. |
-(Appears on: -ParallelBranchStatus, -ParallelStatus) -
-+
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.
-channel
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha1
+
+ |
+
+kind
+string
+ |
+SinkBinding |
+
+metadata
-
-Kubernetes core/v1.ObjectReference
+
+Kubernetes meta/v1.ObjectMeta
|
- Channel is the reference to the underlying channel. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-ready
+spec
-knative.dev/pkg/apis.Condition
+
+SinkBindingSpec
+
|
- ReadyCondition indicates whether the Channel is ready or not. - |
-
-(Appears on: -Parallel) -
--
+| Field | -Description | -
|---|---|
-branches
+SourceSpec
-
-[]ParallelBranch
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
- Branches is the list of Filter/Subscribers pairs. +
+(Members of |
-channelTemplate
+BindingSpec
-
-ChannelTemplateSpec
-
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
-(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). +
+(Members of |
+
reply
+status
-knative.dev/pkg/apis/duck/v1.Destination
+
+SinkBindingStatus
+
Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply
(Appears on: -Parallel) +ApiServerSourceSpec)
-
ParallelStatus represents the current state of a Parallel.
+ApiServerResource defines the resource to watch
-Status
+apiVersion
-knative.dev/pkg/apis/duck/v1.Status
+string
|
-
-(Members of 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. +API version of the resource to watch. |
-ingressChannelStatus
+kind
-
-ParallelChannelStatus
+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
|
- IngressChannelStatus corresponds to the ingress channel status. +LabelSelector restricts this source to objects with the selected labels +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors +Deprecated: Per-resource label selectors will no longer be supported in +v1alpha2, please use Spec.LabelSelector. |
-branchStatuses
+controllerSelector
-
-[]ParallelBranchStatus
+
+Kubernetes meta/v1.OwnerReference
|
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. +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. |
-AddressStatus
+controller
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+bool
|
-
-(Members of 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} +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. |
(Appears on: -ParallelBranchStatus) +ApiServerSource)
+
ApiServerSourceSpec defines the desired state of ApiServerSource
-subscription
+resources
-
-Kubernetes core/v1.ObjectReference
+
+[]ApiServerResource
|
- Subscription is the reference to the underlying Subscription. +Resources is the list of resources to watch |
-ready
+serviceAccountName
-knative.dev/pkg/apis.Condition
+string
|
- ReadyCondition indicates whether the Subscription is ready or not. +(Optional) +ServiceAccountName is the name of the ServiceAccount to use to run this +source. |
-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
- -| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-metadata
+sink
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1beta1.Destination
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Sink is a reference to an object that will resolve to a domain name to use as the sink. |
||||||
-spec
-
-
-SequenceSpec
-
-
- |
-
- Spec defines the desired state of the Sequence. -- -
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. |
||||||
-status
+mode
-
-SequenceStatus
-
+string
|
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. +Mode is the mode the receive adapter controller runs under: Ref or Resource.
+ |
(Appears on: -SequenceStatus) +ApiServerSource)
+
ApiServerSourceStatus defines the observed state of ApiServerSource
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Channel is the reference to the underlying channel. - |
-
-ready
+SourceStatus
-knative.dev/pkg/apis.Condition
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
- ReadyCondition indicates whether the Channel is ready or not. +
+(Members of 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. |
(Appears on: -Sequence) +PingResourceSpec)
@@ -5385,53 +9508,33 @@ knative.dev/pkg/apis.Condition
steps
-
-[]knative.dev/pkg/apis/duck/v1.Destination
-
-Steps is the list of Destinations (processors / functions) that will be called in the order -provided.
-channelTemplate
+cpu
-
-ChannelTemplateSpec
-
+string
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
+memory
-knative.dev/pkg/apis/duck/v1.Destination
+string
Reply is a Reference to where the result of the last Subscriber gets sent to.
(Appears on: -Sequence) +PingResourceSpec)
-
SequenceStatus represents the current state of a Sequence.
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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
+cpu
-
-[]SequenceChannelStatus
-
+string
|
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. |
-AddressStatus
+memory
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+string
|
-
-(Members of 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} |
(Appears on: -SequenceStatus) +PingSourceSpec)
@@ -5521,49 +9584,38 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}
subscription
+requests
-
-Kubernetes core/v1.ObjectReference
+
+PingRequestsSpec
Subscription is the reference to the underlying Subscription.
ready
+limits
-knative.dev/pkg/apis.Condition
+
+PingLimitsSpec
+
ReadyCondition indicates whether the Subscription is ready or not.
(Appears on: -Subscription) +PingSource)
-
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
+PingSourceSpec defines the desired state of the PingSource.
-generation
+schedule
-int64
+string
|
-(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 +Schedule is the cronjob schedule. |
-channel
+data
-
-Kubernetes core/v1.ObjectReference
-
+string
|
- 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.) +Data is the data posted to the target function. |
-subscriber
+sink
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. +Sink is a reference to an object that will resolve to a uri to use as the sink. |
-reply
+ceOverrides
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.CloudEventOverrides
|
(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. +CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink. |
-delivery
+serviceAccountName
-
-DeliverySpec
+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
|
-(Optional)
- Delivery configuration +Resource limits and Request specifications of the Receive Adapter Deployment +Deprecated: v1beta1 drops this field. |
(Appears on: -Subscription) +PingSource)
-
SubscriptionStatus (computed) for a subscription
+PingSourceStatus defines the observed state of PingSource.
-physicalSubscription
+sinkUri
-
-SubscriptionStatusPhysicalSubscription
-
+knative.dev/pkg/apis.URL
|
- PhysicalSubscription is the fully resolved values that this Subscription represents. +(Optional) +SinkURI is the current active sink URI that has been configured for the PingSource. |
(Appears on: -SubscriptionStatus) +SinkBinding)
-
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
+SinkBindingSpec holds the desired state of the SinkBinding (from the client).
-subscriberURI
+SourceSpec
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
- SubscriberURI is the fully resolved URI for spec.subscriber. +
+(Members of |
-replyURI
+BindingSpec
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
- ReplyURI is the fully resolved URI for the spec.reply. +
+(Members of |
+(Appears on: +SinkBinding) +
++
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
+ +| Field | +Description | +|||||||
|---|---|---|---|---|---|---|---|---|
-deadLetterSinkURI
+SourceStatus
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. +
+(Members of |
-messaging.knative.dev/v1beta1
+configs.internal.knative.dev/v1alpha1
|
@@ -77,7 +73,7 @@ messaging.knative.dev/v1beta1
Channel |
+ConfigMapPropagation |
||||||
| @@ -98,44 +94,39 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-ChannelSpec
+
+ConfigMapPropagationSpec
|
- Spec defines the desired state of the Channel. +Spec defines the desired state of the ConfigMapPropagation
|
status
-
-ChannelStatus
+
+ConfigMapPropagationStatus
|
(Optional)
- Status represents the current state of the Channel. This data may be out of -date. +Status represents the current state of the EventType. +This data may be out of date. |
-
InMemoryChannel is a resource representing an in memory channel
+(Appears on: +ConfigMapPropagation) + +
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
+originalNamespace
+
+string
+
|
-
-kind
-string
+OriginalNamespace is the namespace where the original configMaps are in |
-InMemoryChannel |
-metadata
+selector
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes meta/v1.LabelSelector
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Selector only selects original configMaps with corresponding labels |
-spec
-
-
-InMemoryChannelSpec
-
-
- |
-
- Spec defines the desired state of the Channel. -- + |
+(Appears on: +ConfigMapPropagation) +
++
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
+| Field | +Description | +
|---|---|
-ChannelableSpec
+Status
-
-ChannelableSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of Channel conforms to Duck type Channelable. - |
-
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.
status
+copyConfigmaps
-
-InMemoryChannelStatus
+
+[]ConfigMapPropagationStatusCopyConfigMap
Status represents the current state of the Channel. This data may be out of -date.
+CopyConfigMaps is the status for each copied configmap.
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
+(Appears on: +ConfigMapPropagationStatus) + ++
ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
- |
-||||||||
-kind
-string
- |
-Subscription |
-||||||||
-metadata
+name
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Name is copy configmap’s name |
||||||||
-spec
+source
-
-SubscriptionSpec
-
+string
|
- - -
|
-||||||||
-status
-
-
-SubscriptionStatus
-
-
- |
-- | -
-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- --(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.
- -| Field | -Description | -
|---|---|
-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 Channel conforms to ChannelableSpec - |
-
-(Appears on: -Channel) -
--
ChannelStatus represents the current state of a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableStatus
-
-
-ChannelableStatus
-
-
- |
-
-
-(Members of Channel conforms to ChannelableStatus - |
-
-channel
-
-knative.dev/pkg/apis/duck/v1.KReference
-
- |
-
- Channel is an KReference to the Channel CRD backing this Channel. - |
-
-(Appears on: -BrokerSpec, -ChannelSpec, -ChannelSpec, -ParallelSpec, -ParallelSpec, -SequenceSpec, -SequenceSpec) -
--
-| 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 is an internal only version 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. -- - |
-
-(Appears on: -InMemoryChannel) -
--
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableSpec
-
-
-ChannelableSpec
-
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on: -InMemoryChannel) -
--
ChannelStatus represents the current state of a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableStatus
-
-
-ChannelableStatus
-
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(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 | -
|---|---|
-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 - |
-
-(Appears on: -Subscription) -
--
SubscriptionStatus (computed) for a subscription
- -| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -SubscriptionStatus) -
--
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
- -| Field | -Description | -
|---|---|
-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. - |
-
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: - --
ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
- -| Field | -Description | -||||
|---|---|---|---|---|---|
-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 -- -
|
-||||
-status
-
-
-ConfigMapPropagationStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the EventType. -This data may be out of date. - |
-
-(Appears on: -ConfigMapPropagation) -
--
-| Field | -Description | -
|---|---|
-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 - |
-
-(Appears on: -ConfigMapPropagation) -
--
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
- -| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
+ + eventing.knative.dev/v1alpha1
-(Members of Package v1alpha1 is the v1alpha1 version of the API. -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. - |
-
-(Appears on: -ConfigMapPropagationStatus) -
--
ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
+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.
-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 +
+eventing.knative.dev/v1alpha1
+
|
|
-resourceVersionFromSource
-
+kind
string
-
- |
-
- ResourceVersion is the resourceVersion of original configmap |
+Broker |
-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: -string alias)-(Appears on: -DeliverySpec) -
--
BackoffPolicyType is the type for backoff policies
- --
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 | -|||||||||
|---|---|---|---|---|---|---|---|---|---|---|
metadata
@@ -1189,6 +383,7 @@ Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -1197,29 +392,47 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ChannelableSpec
+
+BrokerSpec
|
- Spec is the part where the Channelable fulfills the Subscribable contract. +Spec defines the desired state of the Broker.
|
status
-
-ChannelableStatus
+
+BrokerStatus
|
+(Optional)
+ Status represents the current state of the Broker. This data may be out of +date. |
-(Appears on: -ChannelSpec, -Channelable, -InMemoryChannelSpec) -
--
ChannelableSpec contains Spec of the Channelable object
-SubscribableSpec
-
-
-SubscribableSpec
-
-
+apiVersion
+string |
+
+
+eventing.knative.dev/v1alpha1
+
|
+
|
-
-(Members of kind
+string
|
+EventType |
-delivery
+metadata
-
-DeliverySpec
+
+Kubernetes meta/v1.ObjectMeta
|
(Optional)
- DeliverySpec contains options controlling the event delivery +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) -
--
ChannelableStatus contains the Status of a Channelable object.
- -| Field | -Description | -
|---|---|
-Status
+spec
-knative.dev/pkg/apis/duck/v1.Status
+
+EventTypeSpec
+
|
-
-(Members of 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
+type
-knative.dev/pkg/apis/duck/v1.AddressStatus
+string
|
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +Type represents the CloudEvents type. It is authoritative. |
-SubscribableStatus
+source
-
-SubscribableStatus
-
+string
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +Source is a URI, it represents the CloudEvents source. |
-deadLetterChannel
+schema
-knative.dev/pkg/apis/duck/v1.KReference
+string
|
(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. +Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional. |
-(Appears on: -BrokerSpec, -BrokerSpec, -ChannelSpec, -ChannelableCombinedSpec, -ChannelableSpec, -ChannelableSpec, -InMemoryChannelSpec, -SequenceStep, -SequenceStep, -SubscriberSpec, -SubscriberSpec, -SubscriptionSpec, -SubscriptionSpec) -
--
DeliverySpec contains the delivery options for event senders, -such as channelable and source.
- -| Field | -Description | -
|---|---|
-deadLetterSink
+broker
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
-(Optional)
- DeadLetterSink is the sink receiving event that couldn’t be sent to -a destination. +Broker refers to the Broker that can provide the EventType. |
-retry
+description
-int32
+string
|
(Optional)
- Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink. +Description is an optional field used to describe the EventType, in any meaningful way. |
-backoffPolicy
-
-
-BackoffPolicyType
-
-
- |
-
-(Optional)
- BackoffPolicy is the retry backoff policy (linear, exponential) + |
backoffDelay
+status
-string
+
+EventTypeStatus
+
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^
Status represents the current state of the EventType. +This data may be out of date.
-
DeliveryStatus contains the Status of an object supporting delivery options.
+Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.
-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. +
+eventing.knative.dev/v1alpha1
+
|
-
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.
- -| Field | -Description | +
+kind
+string
+ |
+Trigger |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
metadata
@@ -1523,6 +647,7 @@ Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -1531,28 +656,53 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SubscribableSpec
+
+TriggerSpec
|
- SubscribableSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. +Spec defines the desired state of the Trigger.
|
status
-
-SubscribableStatus
+
+TriggerStatus
|
- SubscribableStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. +(Optional) +Status represents the current state of the Trigger. This data may be out of +date. |
(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -Subscribable) +Broker)
-
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
-subscribers
+channelTemplateSpec
-
-[]SubscriberSpec
+
+ChannelTemplateSpec
|
- This is the list of subscriptions for this subscribable. +(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 |
+
+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. |
(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -Subscribable) +Broker)
-
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
+BrokerStatus represents the current state of a Broker.
-subscribers
+Status
-
-[]SubscriberStatus
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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
|
- This is the list of subscription’s statuses for this channel. +TriggerChannel is an objectref to the object for the TriggerChannel |
(Appears on: -SubscribableSpec) +EventType)
-
SubscriberSpec defines a single subscriber to a Subscribable.
-At least one of SubscriberURI and ReplyURI must be present
-uid
+type
-k8s.io/apimachinery/pkg/types.UID
+string
|
-(Optional)
- UID is used to understand the origin of the subscriber. +Type represents the CloudEvents type. It is authoritative. |
-generation
+source
-int64
+string
|
-(Optional)
- Generation of the origin of the subscriber with uid:UID. +Source is a URI, it represents the CloudEvents source. |
-subscriberUri
+schema
-knative.dev/pkg/apis.URL
+string
|
(Optional)
- SubscriberURI is the endpoint for the subscriber +Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional. |
-replyUri
+broker
-knative.dev/pkg/apis.URL
+string
|
-(Optional)
- ReplyURI is the endpoint for the reply +Broker refers to the Broker that can provide the EventType. |
-delivery
+description
-
-DeliverySpec
-
+string
|
(Optional)
- DeliverySpec contains options controlling the event delivery +Description is an optional field used to describe the EventType, in any meaningful way. |
(Appears on: -SubscribableStatus) +EventType)
-
SubscriberStatus defines the status of a single subscriber to a Channel.
+EventTypeStatus represents the current state of a EventType.
-uid
+Status
-k8s.io/apimachinery/pkg/types.UID
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- UID is used to understand the origin of the subscriber. +
+(Members of 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. |
+(Appears on: +TriggerSpec) +
++
+
-observedGeneration
-
-int64
-
- |
-
-(Optional)
- Generation of the origin of the subscriber with uid:UID. - |
+Field | +Description |
|---|---|---|---|
-ready
+sourceAndType
-
-Kubernetes core/v1.ConditionStatus
+
+TriggerFilterSourceAndType
|
- Status of the subscriber. +(Optional) +DeprecatedSourceAndType filters events based on exact matches on the +CloudEvents type and source attributes. This field has been replaced by the +Attributes field. |
||
-message
+attributes
-string
+
+TriggerFilterAttributes
+
|
(Optional)
- A human readable message indicating details of Ready status. +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. |
map[string]string alias)-
Package v1beta1 is the v1beta1 version of the API.
+(Appears on: +TriggerFilter) -Resource Types: -+
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.
+ +-
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
+(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.
-metadata
+type
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
|
-spec
+source
-
-ParallelSpec
-
+string
|
- Spec defines the desired state of the Parallel. -- + |
+
+(Appears on: +Trigger) +
++
-branches
-
-
-[]ParallelBranch
-
-
- |
-
- Branches is the list of Filter/Subscribers pairs. - |
+Field | +Description |
|---|---|---|---|
-channelTemplate
+broker
-
-ChannelTemplateSpec
-
+string
|
-(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). +Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’. |
||
-reply
+filter
-knative.dev/pkg/apis/duck/v1.Destination
+
+TriggerFilter
+
|
(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply - |
-
Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.
status
+subscriber
-
-ParallelStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
Status represents the current state of the Parallel. This data may be out of -date.
+Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required.
(Appears on: -ParallelSpec) +Trigger)
+
TriggerStatus represents the current state of a Trigger.
-filter
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Filter is the expression guarding the branch - |
-
-subscriber
+Status
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.Status
|
- Subscriber receiving the event when the filter passes +
+(Members of 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. |
-reply
+subscriberURI
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis.URL
|
-(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 +SubscriberURI is the resolved URI of the receiver for this Trigger. |
-(Appears on: -ParallelStatus) +
Package v1beta1 is the v1beta1 version of the API.
+Resource Types: + +-
ParallelBranchStatus represents the current state of a Parallel branch
+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.
-filterSubscriptionStatus
-
-
-ParallelSubscriptionStatus
-
-
+apiVersion
+string |
+
+
+eventing.knative.dev/v1beta1
+
|
+
|
- FilterSubscriptionStatus corresponds to the filter subscription status. +kind
+string
|
+Broker |
-filterChannelStatus
+metadata
-
-ParallelChannelStatus
+
+Kubernetes meta/v1.ObjectMeta
|
- FilterChannelStatus corresponds to the filter channel status. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-subscriberSubscriptionStatus
+spec
-
-ParallelSubscriptionStatus
+
+BrokerSpec
|
- SubscriptionStatus corresponds to the subscriber subscription status. - |
-
-(Appears on: -ParallelBranchStatus, -ParallelStatus) -
--
+Spec defines the desired state of the Broker.
+| Field | -Description | +
+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. + |
|---|---|---|---|
-channel
+delivery
-
-Kubernetes core/v1.ObjectReference
+
+DeliverySpec
|
- Channel is the reference to the underlying channel. +(Optional) +Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc. + |
+
ready
+status
-knative.dev/pkg/apis.Condition
+
+BrokerStatus
+
ReadyCondition indicates whether the Channel is ready or not.
+(Optional) +Status represents the current state of the Broker. This data may be out of +date.
-(Appears on: -Parallel) -
-
-branches
-
-
-[]ParallelBranch
-
-
+apiVersion
+string |
+
+
+eventing.knative.dev/v1beta1
+
|
+
|
- Branches is the list of Filter/Subscribers pairs. +kind
+string
|
+EventType |
-channelTemplate
+metadata
-
-ChannelTemplateSpec
+
+Kubernetes meta/v1.ObjectMeta
|
(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). +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-reply
+spec
-knative.dev/pkg/apis/duck/v1.Destination
+
+EventTypeSpec
+
|
-(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply - |
-
-(Appears on: -Parallel) -
--
ParallelStatus represents the current state of a Parallel.
- +Spec defines the desired state of the EventType.
+| Field | -Description | -
|---|---|
-Status
+type
-knative.dev/pkg/apis/duck/v1.Status
+string
|
-
-(Members of 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. +Type represents the CloudEvents type. It is authoritative. |
-ingressChannelStatus
+source
-
-ParallelChannelStatus
-
+knative.dev/pkg/apis.URL
|
- IngressChannelStatus corresponds to the ingress channel status. +Source is a URI, it represents the CloudEvents source. |
-branchStatuses
+schema
-
-[]ParallelBranchStatus
-
+knative.dev/pkg/apis.URL
|
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. +(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. |
-AddressStatus
+broker
-knative.dev/pkg/apis/duck/v1.AddressStatus
+string
|
-
-(Members of 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} +Broker refers to the Broker that can provide the EventType. |
-(Appears on: -ParallelBranchStatus) -
--
-| Field | -Description | -
|---|---|
-subscription
+description
-
-Kubernetes core/v1.ObjectReference
-
+string
|
- Subscription is the reference to the underlying Subscription. +(Optional) +Description is an optional field used to describe the EventType, in any meaningful way. + |
+
ready
+status
-knative.dev/pkg/apis.Condition
+
+EventTypeStatus
+
ReadyCondition indicates whether the Subscription is ready or not.
+(Optional) +Status represents the current state of the EventType. +This data may be out of date.
-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
+Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.
+apiVersion
+string |
+
+
+eventing.knative.dev/v1beta1
+
+ |
+|||||||||
+kind
+string
+ |
+Trigger |
+|||||||||
metadata
@@ -2271,55 +1482,53 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-SequenceSpec
+
+TriggerSpec
- | Spec defines the desired state of the Sequence. +Spec defines the desired state of the Trigger.
|
status
-
-SequenceStatus
+
+TriggerStatus
(Optional)
- |
Status represents the current state of the Sequence. This data may be out of + Status represents the current state of the Trigger. This data may be out of date. |
+(Appears on: +Broker) +
++
+| Field | +Description | +
|---|---|
+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. + |
+
(Appears on: -SequenceStatus) +Broker)
+
BrokerStatus represents the current state of a Broker.
-channel
+Status
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.Status
|
- Channel is the reference to the underlying channel. +
+(Members of 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. |
-ready
+address
-knative.dev/pkg/apis.Condition
+knative.dev/pkg/apis/duck/v1.Addressable
|
- ReadyCondition indicates whether the Channel is ready or not. +Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh. |
(Appears on: -Sequence) +EventType)
@@ -2402,55 +1663,72 @@ knative.dev/pkg/apis.Condition
steps
+type
-
-[]SequenceStep
-
+string
Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options
+Type represents the CloudEvents type. It is authoritative.
channelTemplate
+source
-
-ChannelTemplateSpec
-
+knative.dev/pkg/apis.URL
+
+Source is a URI, it represents the CloudEvents source.
+schema
+
+knative.dev/pkg/apis.URL
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).
+Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional.
reply
+broker
-knative.dev/pkg/apis/duck/v1.Destination
+string
+
+Broker refers to the Broker that can provide the EventType.
+description
+
+string
Reply is a Reference to where the result of the last Subscriber gets sent to.
+Description is an optional field used to describe the EventType, in any meaningful way.
(Appears on: -Sequence) +EventType)
-
SequenceStatus represents the current state of a Sequence.
+EventTypeStatus represents the current state of a EventType.
+(Appears on: +TriggerSpec) +
++
+
-subscriptionStatuses
-
-
-[]SequenceSubscriptionStatus
-
-
- |
-
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. - |
+Field | +Description |
|---|---|---|---|
-channelStatuses
+attributes
-
-[]SequenceChannelStatus
+
+TriggerFilterAttributes
|
- 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 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} +(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. |
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.
+ +(Appears on: -SequenceSpec) +Trigger)
@@ -2540,42 +1821,53 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}
Destination
+broker
-knative.dev/pkg/apis/duck/v1.Destination
+string
-(Members of Destination are embedded into this type.)
-
Subscriber receiving the step event
+Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’.
delivery
+filter
-
-DeliverySpec
+
+TriggerFilter
Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc.
+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.
(Appears on: -SequenceStatus) +Trigger)
+
TriggerStatus represents the current state of a Trigger.
-subscription
+Status
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.Status
|
- Subscription is the reference to the underlying Subscription. +
+(Members of 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. |
-ready
+subscriberUri
-knative.dev/pkg/apis.Condition
+knative.dev/pkg/apis.URL
|
- ReadyCondition indicates whether the Subscription is ready or not. +SubscriberURI is the resolved URI of the receiver for this Trigger. |
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+Package v1alpha1 is the v1alpha1 version of the API.
Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
| Field | -Description | -||||||||
|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.eventing.knative.dev/v1alpha1
-
- |
-||||||||
-kind
-string
- |
-ApiServerSource |
-||||||||
-Deprecated
-
-
-Deprecated
-
-
- |
-
- Deprecated allows ApiServerSource to have a deprecated message. - |
+Field | +Description | ||||||
metadata
@@ -2679,6 +1937,7 @@ Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -2687,87 +1946,138 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ApiServerSourceSpec
+
+ParallelSpec
|
+ Spec defines the desired state of the Parallel.
|
||||||
-mode
+status
-string
+
+ParallelStatus
+
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
- Status represents the current state of the Parallel. This data may be out of +date. |
+(Appears on: +ParallelSpec) +
++
+| Field | +Description | +
|---|---|
+filter
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Filter is the expression guarding the branch |
-status
+subscriber
-
-ApiServerSourceStatus
-
+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 |
-
ContainerSource is the Schema for the containersources API
+(Appears on: +ParallelStatus) + ++
ParallelBranchStatus represents the current state of a Parallel branch
-apiVersion
-string |
+
-
-sources.eventing.knative.dev/v1alpha1
-
+FilterSubscriptionStatus corresponds to the filter subscription status. |
|
-kind
-string
+filterChannelStatus
+
+
+ParallelChannelStatus
+
+
+ |
+
+ FilterChannelStatus corresponds to the filter channel status. |
-ContainerSource |
-Deprecated
+subscriberSubscriptionStatus
-
-Deprecated
+
+ParallelSubscriptionStatus
|
- Deprecated allows ContainerSource to have a deprecated message. +SubscriptionStatus corresponds to the subscriber subscription status. |
+(Appears on: +ParallelBranchStatus, +ParallelStatus) +
++
+| Field | +Description | +
|---|---|
-metadata
+channel
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes core/v1.ObjectReference
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Channel is the reference to the underlying channel. |
-spec
+ready
-
-ContainerSourceSpec
-
+knative.dev/pkg/apis.Condition
|
- - + ReadyCondition indicates whether the Channel is ready or not. + |
+
+(Appears on: +Parallel) +
++
| Field | +Description | +
|---|---|
-template
+branches
-
-Kubernetes core/v1.PodTemplateSpec
+
+[]ParallelBranch
|
-(Optional)
- Template describes the pods that will be created +Branches is the list of Filter/Subscribers pairs. |
-image
+channelTemplate
-string
+
+ChannelTemplateSpec
+
|
- DeprecatedImage is the image to run inside of the container.
-This field is to be deprecated. Use 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). |
-args
+reply
-[]string
+knative.dev/pkg/apis/duck/v1.Destination
|
- DeprecatedArgs are passed to the ContainerSpec as they are.
-This field is to be deprecated. Use Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply |
+(Appears on: +Parallel) +
++
ParallelStatus represents the current state of a Parallel.
+ +| Field | +Description | +
|---|---|
-env
+Status
-
-[]Kubernetes core/v1.EnvVar
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- DeprecatedEnv is the list of environment variables to set in the container.
-Cannot be updated.
-This field is to be deprecated. Use
+(Members of 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. |
-serviceAccountName
+ingressChannelStatus
-string
+
+ParallelChannelStatus
+
|
-(Optional)
- DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this
-source.
-This field is to be deprecated. Use IngressChannelStatus corresponds to the ingress channel status. |
-sink
+branchStatuses
-knative.dev/pkg/apis/duck/v1beta1.Destination
+
+[]ParallelBranchStatus
+
|
- Sink is a reference to an object that will resolve to a domain name to use as the sink. - |
-
BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order.
status
+AddressStatus
-
-ContainerSourceStatus
-
+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}
-
CronJobSource is the Schema for the cronjobsources API.
+(Appears on: +ParallelBranchStatus) + +
-apiVersion
-string |
-
-
-sources.eventing.knative.dev/v1alpha1
-
+subscription
+
+
+Kubernetes core/v1.ObjectReference
+
+
|
-
-kind
-string
+Subscription is the reference to the underlying Subscription. |
-CronJobSource |
-Deprecated
+ready
-
-Deprecated
-
+knative.dev/pkg/apis.Condition
|
- Deprecated allows CronJobSource to have a deprecated message. +ReadyCondition indicates whether the Subscription is ready or not. |
+
Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
+ +| Field | +Description | +||||||||
|---|---|---|---|---|---|---|---|---|---|
metadata
@@ -2987,6 +2374,7 @@ Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -2995,99 +2383,126 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-CronJobSourceSpec
+
+SequenceSpec
|
+ Spec defines the desired state of the Sequence.
|
||||||
-serviceAccountName
+status
-string
+
+SequenceStatus
+
|
- ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. +(Optional) +Status represents the current state of the Sequence. This data may be out of +date. |
+(Appears on: +SequenceStatus) +
++
+| Field | +Description | +
|---|---|
-resources
+channel
-
-CronJobResourceSpec
+
+Kubernetes core/v1.ObjectReference
|
- Resource limits and Request specifications of the Receive Adapter Deployment - |
-
Channel is the reference to the underlying channel.
status
+ready
-
-CronJobSourceStatus
-
+knative.dev/pkg/apis.Condition
ReadyCondition indicates whether the Channel is ready or not.
-
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.
-apiVersion
-string |
+
-
-sources.eventing.knative.dev/v1alpha1
-
+Steps is the list of Destinations (processors / functions) that will be called in the order +provided. |
|
-kind
-string
+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). |
-SinkBinding |
-Deprecated
+reply
-
-Deprecated
-
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Reply is a Reference to where the result of the last Subscriber gets sent to. + |
+
+(Appears on: +Sequence) +
++
SequenceStatus represents the current state of a Sequence.
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
|
- Deprecated allows ApiServerSource to have a deprecated message. +
+(Members of 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. |
||||||
-metadata
+subscriptionStatuses
-
-Kubernetes meta/v1.ObjectMeta
+
+[]SequenceSubscriptionStatus
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order. |
||||||
-spec
+channelStatuses
-
-SinkBindingSpec
+
+[]SequenceChannelStatus
|
- - -
SequenceStep +++(Appears on: +SequenceSpec) + ++ +
Subscriber receiving the step event |
||||||
-status
+delivery
-
-SinkBindingStatus
+
+DeliverySpec
|
+(Optional)
+ Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. +Needed for Roundtripping v1alpha1 <-> v1beta1. |
(Appears on: -ApiServerSourceSpec) +SequenceStatus)
-
ApiServerResource defines the resource to watch
-apiVersion
+subscription
-string
+
+Kubernetes core/v1.ObjectReference
+
|
- API version of the resource to watch. +Subscription is the reference to the underlying Subscription. |
-kind
+ready
-string
+knative.dev/pkg/apis.Condition
|
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +ReadyCondition indicates whether the Subscription is ready or not. + |
+
+
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+ +Resource Types: ++
ApiServerSource is the Schema for the apiserversources API
+ +| Field | +Description | +
|---|---|
+apiVersion
+string |
+
+
+sources.eventing.knative.dev/v1alpha1
+
|
-labelSelector
+kind
+string
+ |
+ApiServerSource |
+
+Deprecated
-
-Kubernetes meta/v1.LabelSelector
+
+Deprecated
|
- LabelSelector restricts this source to objects with the selected labels -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors +Deprecated allows ApiServerSource to have a deprecated message. |
-controllerSelector
+metadata
-
-Kubernetes meta/v1.OwnerReference
+
+Kubernetes meta/v1.ObjectMeta
|
- ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-controller
+spec
-bool
+
+ApiServerSourceSpec
+
|
- If true, send an event referencing the object controlling the resource - |
-
-(Appears on: -ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
- +| Field | -Description | -
|---|---|
resources
@@ -3346,16 +2860,27 @@ string
Resource send the full resource.
|
status
+
+
+ApiServerSourceStatus
+
+
+-(Appears on: -ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
+ContainerSource is the Schema for the containersources API
-Status
+apiVersion
+string |
+
+
+sources.eventing.knative.dev/v1alpha1
+
+ |
+
+kind
+string
+ |
+ContainerSource |
+
+Deprecated
-knative.dev/pkg/apis/duck/v1.Status
+
+Deprecated
+
|
-
-(Members of 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. +Deprecated allows ContainerSource to have a deprecated message. + |
+
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
-sinkUri
+spec
-string
+
+ContainerSourceSpec
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the ApiServerSource. - |
-
-(Appears on: -ContainerSource) -
--
ContainerSourceSpec defines the desired state of ContainerSource
- +| Field | -Description | -
|---|---|
template
@@ -3495,62 +3030,27 @@ knative.dev/pkg/apis/duck/v1beta1.Destination
Sink is a reference to an object that will resolve to a domain name to use as the sink. |
-(Appears on: -ContainerSource) -
--
ContainerSourceStatus defines the observed state of ContainerSource
- -| Field | -Description | -
|---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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. |
-sinkUri
+status
-string
+
+ContainerSourceStatus
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the ContainerSource. |
-(Appears on: -CronJobResourceSpec) -
-+
CronJobSource is the Schema for the cronjobsources API.
-cpu
-
-string
-
- |
-- | -
-memory
-
-string
-
- |
+
+
+sources.eventing.knative.dev/v1alpha1
+
|
-(Appears on: -CronJobResourceSpec) -
--
-| Field | -Description | -|
|---|---|---|
-cpu
-
+kind
string
-
- |
-+ | CronJobSource |
-memory
+Deprecated
-string
+
+Deprecated
+
|
+ Deprecated allows CronJobSource to have a deprecated message. |
-(Appears on: -CronJobSourceSpec) -
--
-| Field | -Description | -
|---|---|
-requests
+metadata
-
-CronJobRequestsSpec
+
+Kubernetes meta/v1.ObjectMeta
|
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
-limits
+spec
-
-CronJobLimitsSpec
+
+CronJobSourceSpec
|
- | -
-(Appears on: -CronJobSource) -
--
CronJobSourceSpec defines the desired state of the CronJobSource.
- +| Field | -Description | -
|---|---|
schedule
@@ -3737,16 +3175,32 @@ CronJobResourceSpec
Resource limits and Request specifications of the Receive Adapter Deployment |
status
+
+
+CronJobSourceStatus
+
+
+-(Appears on: -CronJobSource) -
--
CronJobSourceStatus defines the observed state of CronJobSource.
+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.
-Status
+apiVersion
+string |
+
+
+sources.eventing.knative.dev/v1alpha1
+
+ |
+
+kind
+string
+ |
+SinkBinding |
+
+Deprecated
-knative.dev/pkg/apis/duck/v1.Status
+
+Deprecated
+
|
-
-(Members of 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. +Deprecated allows ApiServerSource to have a deprecated message. + |
+
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
-sinkUri
+spec
-string
+
+SinkBindingSpec
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the CronJobSource. - |
-
-(Appears on: -ApiServerSource, -ContainerSource, -CronJobSource, -SinkBinding) -
--
--(Appears on: -SinkBinding) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
- +| Field | -Description | -
|---|---|
SourceSpec
@@ -3840,57 +3293,31 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
-(Appears on: -SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -| Field | -Description | +
|---|---|
-SourceStatus
+status
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+SinkBindingStatus
+
|
-
-(Members of |
-
Package v1alpha1 is the v1alpha1 version of the API.
+(Appears on: +ApiServerSourceSpec) -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
+ApiServerResource defines the resource to watch
apiVersion
-string |
+
+string
+
+
-
-messaging.knative.dev/v1alpha1
-
+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 |
-Channel |
|||||||
-metadata
+labelSelector
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes meta/v1.LabelSelector
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+LabelSelector restricts this source to objects with the selected labels +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
||||||||
-spec
+controllerSelector
-
-ChannelSpec
+
+Kubernetes meta/v1.OwnerReference
|
- Spec defines the desired state of the Channel. -- -
ApiServerSourceSpec +++(Appears on: +ApiServerSource) + ++ ApiServerSourceSpec defines the desired state of ApiServerSource + +
| ||||||||
+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. |
||||||||
-status
+mode
-
-ChannelStatus
-
+string
|
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. +Mode is the mode the receive adapter controller runs under: Ref or Resource.
+ |
-
InMemoryChannel is a resource representing an in memory channel
+(Appears on: +ApiServerSource) + ++
ApiServerSourceStatus defines the observed state of ApiServerSource
-apiVersion
-string |
+
-
-messaging.knative.dev/v1alpha1
-
+
+(Members of 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. |
|
-kind
+sinkUri
+
string
+
|
-InMemoryChannel |
+
+(Optional)
+ SinkURI is the current active sink URI that has been configured for the ApiServerSource. + |
+
+(Appears on: +ContainerSource) +
++
ContainerSourceSpec defines the desired state of ContainerSource
+ +| Field | +Description | ||||
|---|---|---|---|---|---|
-metadata
+template
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes core/v1.PodTemplateSpec
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Template describes the pods that will be created |
||||
-spec
+image
-
-InMemoryChannelSpec
-
+string
|
- Spec defines the desired state of the Channel. -- -
| ||||
+serviceAccountName
+
+string
+
+ |
+
+(Optional)
+ DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this
+source.
+This field is to be deprecated. Use |
||||
-status
+sink
-
-InMemoryChannelStatus
-
+knative.dev/pkg/apis/duck/v1beta1.Destination
|
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. +Sink is a reference to an object that will resolve to a domain name to use as the sink. |
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
+(Appears on: +ContainerSource) + ++
ContainerSourceStatus defines the observed state of ContainerSource
-apiVersion
-string |
-
-
-messaging.knative.dev/v1alpha1
-
- |
-
-kind
-string
- |
-Subscription |
-
-metadata
+Status
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.Status
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of 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. |
-spec
+sinkUri
-
-SubscriptionSpec
-
+string
|
- - +(Optional) + SinkURI is the current active sink URI that has been configured for the ContainerSource. + |
+
+(Appears on: +CronJobResourceSpec) +
++
| Field | +Description | +
|---|---|
-generation
+cpu
-int64
+string
|
-(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
+memory
-
-Kubernetes core/v1.ObjectReference
-
+string
|
- 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.) |
+(Appears on: +CronJobResourceSpec) +
++
+| Field | +Description | +
|---|---|
-subscriber
+cpu
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
-(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
+memory
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
-(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. |
+(Appears on: +CronJobSourceSpec) +
++
+| Field | +Description | +
|---|---|
-delivery
+requests
-
-DeliverySpec
+
+CronJobRequestsSpec
|
-(Optional)
- Delivery configuration - |
-
status
+limits
-
-SubscriptionStatus
+
+CronJobLimitsSpec
(Appears on: -Channel) +CronJobSource)
-
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.
+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. + |
+
-channelTemplate
+sink
-
-ChannelTemplateSpec
-
+knative.dev/pkg/apis/duck/v1beta1.Destination
|
- 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. +Sink is a reference to an object that will resolve to a domain name to use as the sink. |
-subscribable
+serviceAccountName
-
-Subscribable
-
+string
|
- Channel conforms to Duck type Subscribable. +ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. |
-delivery
+resources
-
-DeliverySpec
+
+CronJobResourceSpec
|
- Delivery options. +Resource limits and Request specifications of the Receive Adapter Deployment |
(Appears on: -Channel) +CronJobSource)
-
ChannelStatus represents the current state of a Channel.
+CronJobSourceStatus defines the observed state of CronJobSource.
-AddressStatus
+sinkUri
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+string
|
+(Optional)
+ SinkURI is the current active sink URI that has been configured for the CronJobSource. + |
+
-(Members of AddressStatus are embedded into this type.)
+(Appears on:
+ApiServerSource,
+ContainerSource,
+CronJobSource,
+SinkBinding)
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}
- ++
++(Appears on: +SinkBinding) +
++
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ +| Field | +Description |
|---|---|
-SubscribableTypeStatus
+SourceSpec
-
-SubscribableTypeStatus
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
-channel
+BindingSpec
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
- Channel is an ObjectReference to the Channel CRD backing this Channel. +
+(Members of |
(Appears on: -InMemoryChannel) +SinkBinding)
-
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
+SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
-subscribable
-
-
-Subscribable
-
-
- |
-
- Channel conforms to Duck type Subscribable. - |
-
-delivery
+SourceStatus
-
-DeliverySpec
-
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
- For round tripping (v1beta1 <-> v1alpha1> +
+(Members of |
-(Appears on: -InMemoryChannel) +
Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
+Resource Types: +-
ChannelStatus represents the current state of a Channel.
+ApiServerSource is the Schema for the apiserversources API
-Status
+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
+
+
+ |
+
+ + +
|
||||||||||||
-SubscribableTypeStatus
+status
-
-SubscribableTypeStatus
+
+ApiServerSourceStatus
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
-(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
+PingSource is the Schema for the PingSources API.
-generation
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
+ |
+||||||
+kind
+string
+ |
+PingSource |
+||||||
+metadata
-int64
+
+Kubernetes meta/v1.ObjectMeta
+
|
-(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 +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-channel
+spec
-
-Kubernetes core/v1.ObjectReference
+
+PingSourceSpec
|
- 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.) ++ +
|
||||||
-delivery
+status
-
-DeliverySpec
+
+PingSourceStatus
|
-(Optional)
- Delivery configuration |
-(Appears on: -Subscription) -
--
SubscriptionStatus (computed) for a subscription
+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.
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
|
+
|
-
-(Members of 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. +kind
+string
|
+SinkBinding |
-physicalSubscription
+metadata
-
-SubscriptionStatusPhysicalSubscription
+
+Kubernetes meta/v1.ObjectMeta
|
- PhysicalSubscription is the fully resolved values that this Subscription represents. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-(Appears on: -SubscriptionStatus) -
--
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
- -| Field | -Description | -
+spec
+
+
+SinkBindingSpec
+
+
+ |
+
+ + +
|
|---|---|
-deadLetterSinkURI
+status
-knative.dev/pkg/apis.URL
+
+SinkBindingStatus
+
|
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. |
-
Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
+(Appears on: +ApiServerSourceSpec, +ApiServerSourceSpec) -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+APIVersionKind is an APIVersion and Kind tuple.
apiVersion
-string |
-
-
-sources.knative.dev/v1alpha2
-
- |
-
-kind
-string
- |
-ApiServerSource |
-
-metadata
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+(Optional)
+APIVersion - the API version of the resource to watch. |
-spec
+kind
-
-ApiServerSourceSpec
-
+string
|
- - +(Optional) + Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceSpec defines the desired state of ApiServerSource
+| Field | +Description | +
|---|---|
SourceSpec
@@ -4885,27 +4551,210 @@ string
source. Defaults to default if not set.
|
+(Appears on: +ApiServerSource) +
++
ApiServerSourceStatus defines the observed state of ApiServerSource
+ +| Field | +Description | +
|---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +PingSource) +
++
PingSourceSpec defines the desired state of the PingSource.
+ +| Field | +Description | +
|---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of 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”. + |
+
+(Appears on: +PingSource) +
++
PingSourceStatus defines the observed state of PingSource.
+ +| Field | +Description | +
|---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. |
+(Appears on: +SinkBinding) +
++
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ +| Field | +Description | +
|---|---|
-status
+SourceSpec
-
-ApiServerSourceStatus
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of 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 inherits duck/v1alpha1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations. |
-
PingSource is the Schema for the PingSources API.
+(Appears on: +SinkBinding) + ++
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
-apiVersion
-string |
+
-
-sources.knative.dev/v1alpha2
-
+
+(Members of 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. |
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: ++
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.
+ +
-kind
-string
- |
-PingSource |
+Field | +Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
metadata
@@ -4950,57 +4826,43 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-PingSourceSpec
+
+ChannelableSpec
|
+ Spec is the part where the Channelable fulfills the Subscribable contract.
|
status
-
-PingSourceStatus
+
+ChannelableStatus
|
@@ -5020,15 +4882,14 @@ PingSourceStatus
-
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.
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.
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha2
-
- |
-||||||||
-kind
-string
- |
-SinkBinding |
-||||||||
metadata
@@ -5073,47 +4917,60 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-SinkBindingSpec
+
+ChannelableCombinedSpec
+ | Spec is the part where the Channelable fulfills the Subscribable contract.
|
@@ -5133,15 +4990,14 @@ SinkBindingStatus
status
-
-SinkBindingStatus
+
+ChannelableCombinedStatus
|
(Appears on: -ApiServerSourceSpec, -ApiServerSourceSpec) +ChannelableCombined)
-
APIVersionKind is an APIVersion and Kind tuple.
+ChannelableSpec contains Spec of the Channelable object
-apiVersion
+SubscribableTypeSpec
-string
+
+SubscribableTypeSpec
+
|
-(Optional)
- APIVersion - the API version of the resource to watch. +
+(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. |
-kind
+SubscribableSpec
-string
+
+SubscribableSpec
+
+
+ |
+
+
+(Members of SubscribableSpec is for the v1beta1 spec compatibility. + |
+
+delivery
+
+
+DeliverySpec
+
|
(Optional)
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +DeliverySpec contains options controlling the event delivery |
(Appears on: -ApiServerSource) +ChannelableCombined)
-
ApiServerSourceSpec defines the desired state of ApiServerSource
+ChannelableStatus contains the Status of a Channelable object.
|
- Resource is the resource this source will track and send related -lifecycle events from the Kubernetes ApiServer. +
+(Members of 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. |
|
-selector
+AddressStatus
-
-Kubernetes meta/v1.LabelSelector
-
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
-(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 +
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. |
-owner
+SubscribableTypeStatus
-
-APIVersionKind
+
+SubscribableTypeStatus
|
-(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. +
+(Members of SubscribableTypeStatus is the v1alpha1 part of the Subscribers status |
-mode
+SubscribableStatus
-string
+
+SubscribableStatus
+
|
-(Optional)
- EventMode controls the format of the event.
-
+(Members of SubscribableStatus is the v1beta1 part of the Subscribers status. |
-serviceAccountName
+errorChannel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set. +ErrorChannel is set by the channel when it supports native error handling via a channel |
(Appears on: -ApiServerSource) +Channelable)
-
ApiServerSourceStatus defines the observed state of ApiServerSource
+ChannelableSpec contains Spec of the Channelable object
-SourceStatus
+SubscribableTypeSpec
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+SubscribableTypeSpec
+
|
-(Members of 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. + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ DeliverySpec contains options controlling the event delivery |
(Appears on: -PingSource) +Channelable)
-
PingSourceSpec defines the desired state of the PingSource.
+ChannelableStatus contains the Status of a Channelable object.
-SourceSpec
+Status
-knative.dev/pkg/apis/duck/v1.SourceSpec
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of 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. +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. |
-schedule
+AddressStatus
-string
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
-(Optional)
- Schedule is the cronjob schedule. Defaults to
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. |
-jsonData
+SubscribableTypeStatus
-string
+
+SubscribableTypeStatus
+
+
+ |
+
+
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. + |
+
+errorChannel
+
+
+Kubernetes core/v1.ObjectReference
+
|
(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”. +ErrorChannel is set by the channel when it supports native error handling via a channel |
-(Appears on: -PingSource) -
--
PingSourceStatus defines the observed state of PingSource.
+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.
-SourceStatus
+metadata
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-(Members of 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. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
(Appears on: -SinkBinding) +ChannelSpec, +InMemoryChannelSpec, +SubscribableTypeSpec)
-
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+Subscribable is the schema for the subscribable portion of the spec +section of the resource.
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of 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
+subscribers
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+[]SubscriberSpec
+
|
-
-(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations. +This is the list of subscriptions for this subscribable. |
(Appears on: -SinkBinding) +SubscribableTypeStatus)
-
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
+SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
-SourceStatus
+subscribers
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+[]SubscriberStatus
+
|
-
-(Members of 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. +This is the list of subscription’s statuses for this channel. |
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: --
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers +
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 -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
+SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
spec
-
-ChannelableSpec
+
+SubscribableTypeSpec
|
- Spec is the part where the Channelable fulfills the Subscribable contract. +SubscribableTypeSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract.
|
-delivery
+status
-
-DeliverySpec
+
+SubscribableTypeStatus
|
-(Optional)
- DeliverySpec contains options controlling the event delivery +SubscribableTypeStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract. |
+(Appears on: +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType) +
++
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
+ +| Field | +Description |
|---|---|
-status
+subscribable
-
-ChannelableStatus
+
+Subscribable
|
@@ -5618,14 +5483,18 @@ ChannelableStatus
-
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.
+(Appears on: +ChannelStatus, +ChannelableCombinedStatus, +ChannelableStatus, +InMemoryChannelStatus, +SubscribableType) + ++
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
-metadata
+subscribableStatus
-
-Kubernetes meta/v1.ObjectMeta
+
+SubscribableStatus
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
|
+(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 | +||||||
|---|---|---|---|---|---|---|---|
-spec
+uid
-
-ChannelableCombinedSpec
-
+k8s.io/apimachinery/pkg/types.UID
|
- Spec is the part where the Channelable fulfills the Subscribable contract. -- -
| ||||||
+deadLetterSink
+
+knative.dev/pkg/apis.URL
+
+ |
++(Optional) | ||||||
-status
+delivery
-
-ChannelableCombinedStatus
+
+DeliverySpec
|
+(Optional) |
(Appears on: -ChannelableCombined) +SubscribableStatus)
-
ChannelableSpec contains Spec of the Channelable object
+SubscriberStatus defines the status of a single subscriber to a Channel.
-SubscribableTypeSpec
+uid
-
-SubscribableTypeSpec
-
+k8s.io/apimachinery/pkg/types.UID
|
-
-(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. +(Optional) +UID is used to understand the origin of the subscriber. |
-SubscribableSpec
+observedGeneration
-
-SubscribableSpec
-
+int64
|
-
-(Members of SubscribableSpec is for the v1beta1 spec compatibility. +(Optional) +Generation of the origin of the subscriber with uid:UID. |
-delivery
+ready
-
-DeliverySpec
+
+Kubernetes core/v1.ConditionStatus
|
(Optional)
- DeliverySpec contains options controlling the event delivery +Status of the subscriber. + |
+
+message
+
+string
+
+ |
+
+(Optional)
+ A human readable message indicating details of Ready status. |
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: +string alias)(Appears on: -ChannelableCombined) +DeliverySpec)
-
ChannelableStatus contains the Status of a Channelable object.
+BackoffPolicyType is the type for backoff policies
+ ++
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.
-Status
+metadata
-knative.dev/pkg/apis/duck/v1.Status
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-
-(Members of 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. - |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
-AddressStatus
+spec
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+ChannelableSpec
+
|
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. - |
-
-SubscribableTypeStatus
+SubscribableSpec
-
-SubscribableTypeStatus
+
+SubscribableSpec
|
-(Members of SubscribableTypeStatus is the v1alpha1 part of the Subscribers status |
-SubscribableStatus
+delivery
-
-SubscribableStatus
+
+DeliverySpec
|
-
-(Members of SubscribableStatus is the v1beta1 part of the Subscribers status. +(Optional) +DeliverySpec contains options controlling the event delivery + |
+
errorChannel
+status
-
-Kubernetes core/v1.ObjectReference
+
+ChannelableStatus
ErrorChannel is set by the channel when it supports native error handling via a channel
(Appears on: -Channelable) +ChannelSpec, +Channelable, +InMemoryChannelSpec)
ChannelableSpec contains Spec of the Channelable object
@@ -5905,16 +5806,16 @@ Kubernetes core/v1.ObjectReferenceSubscribableTypeSpec
+SubscribableSpec
-
-SubscribableTypeSpec
+
+SubscribableSpec
-(Members of SubscribableTypeSpec are embedded into this type.)
+(Members of SubscribableSpec are embedded into this type.)
(Appears on: -Channelable) +ChannelStatus, +Channelable, +InMemoryChannelStatus)
ChannelableStatus contains the Status of a Channelable object.
@@ -5971,7 +5874,7 @@ knative.dev/pkg/apis/duck/v1.StatusAddressStatus
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+knative.dev/pkg/apis/duck/v1.AddressStatus
SubscribableTypeStatus
+SubscribableStatus
-
-SubscribableTypeStatus
+
+SubscribableStatus
-(Members of SubscribableTypeStatus are embedded into this type.)
+(Members of SubscribableStatus are embedded into this type.)
Subscribers is populated with the statuses of each of the Channelable’s subscribers.
errorChannel
+deadLetterChannel
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.KReference
ErrorChannel is set by the channel when it supports native error handling via a channel
+DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel +Failed messages are delivered here.
-
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.
+(Appears on: +BrokerSpec, +BrokerSpec, +ChannelSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ChannelableSpec, +InMemoryChannelSpec, +SequenceStep, +SequenceStep, +SubscriberSpec, +SubscriberSpec, +SubscriptionSpec, +SubscriptionSpec) + ++
DeliverySpec contains the delivery options for event senders, +such as channelable and source.
-metadata
+deadLetterSink
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.Destination
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+(Optional)
+DeadLetterSink is the sink receiving event that couldn’t be sent to +a destination. |
-(Appears on: -ChannelSpec, -InMemoryChannelSpec, -SubscribableTypeSpec) -
--
Subscribable is the schema for the subscribable portion of the spec -section of the resource.
- -| Field | -Description | +
+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. + |
|---|---|---|---|
-subscribers
+backoffPolicy
-
-[]SubscriberSpec
+
+BackoffPolicyType
|
- This is the list of subscriptions for this subscribable. +(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^ |
-(Appears on: -SubscribableTypeStatus) -
--
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
+DeliveryStatus contains the Status of an object supporting delivery options.
-subscribers
+deadLetterChannel
-
-[]SubscriberStatus
-
+knative.dev/pkg/apis/duck/v1.KReference
|
- This is the list of subscription’s statuses for this channel. +(Optional) +DeadLetterChannel is a KReference that is the reference to the native, platform specific channel +where failed events are sent to. |
-
SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers +
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.
@@ -6144,27 +6063,28 @@ Refer to the Kubernetes API documentation for the fields of thespec
-
-SubscribableTypeSpec
+
+SubscribableSpec
SubscribableTypeSpec is the part where Subscribable object is +
SubscribableSpec is the part where Subscribable object is configured as to be compatible with Subscribable contract.
-subscribable
+subscribers
-
-Subscribable
+
+[]SubscriberSpec
|
+ This is the list of subscriptions for this subscribable. |
status
-
-SubscribableTypeStatus
+
+SubscribableStatus
SubscribableTypeStatus is the part where SubscribableStatus object is +
SubscribableStatus is the part where SubscribableStatus object is configured as to be compatible with Subscribable contract.
(Appears on: ChannelableCombinedSpec, -ChannelableSpec, -SubscribableType) +ChannelableSpec, +Subscribable)
-
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
+SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
-subscribable
+subscribers
-
-Subscribable
+
+[]SubscriberSpec
|
+ This is the list of subscriptions for this subscribable. |
(Appears on: -ChannelStatus, ChannelableCombinedStatus, -ChannelableStatus, -InMemoryChannelStatus, -SubscribableType) +ChannelableStatus, +Subscribable)
-
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
-subscribableStatus
+subscribers
-
-SubscribableStatus
+
+[]SubscriberStatus
|
+ This is the list of subscription’s statuses for this channel. |
(Appears on: -Subscribable) +SubscribableSpec)
-
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
+SubscriberSpec defines a single subscriber to a Subscribable.
+At least one of SubscriberURI and ReplyURI must be present
-subscriberURI
-
-knative.dev/pkg/apis.URL
-
- |
--(Optional) - | -
-replyURI
+subscriberUri
knative.dev/pkg/apis.URL
|
(Optional)
+ SubscriberURI is the endpoint for the subscriber |
-deadLetterSink
+replyUri
knative.dev/pkg/apis.URL
|
(Optional)
+ ReplyURI is the endpoint for the reply |
|
(Optional)
+ DeliverySpec contains options controlling the event delivery |
(Appears on: -SubscribableStatus) +SubscribableStatus)
SubscriberStatus defines the status of a single subscriber to a Channel.
@@ -6398,7 +6308,6 @@ Kubernetes core/v1.ConditionStatusStatus of the subscriber.
-
Package v1alpha1 is the v1alpha1 version of the API.
+Package v1beta1 is the v1beta1 version of the API.
Resource Types: - --
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.
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
- |
-|||||||||
-kind
-string
- |
-Broker |
-|||||||||
metadata
@@ -6482,62 +6365,55 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-BrokerSpec
+
+ParallelSpec
- | Spec defines the desired state of the Broker. +Spec defines the desired state of the Parallel.
|
status
-
-BrokerStatus
+
+ParallelStatus
(Optional)
- |
Status represents the current state of the Broker. This data may be out of + Status represents the current state of the Parallel. This data may be out of date. |
+(Appears on: +ParallelSpec) +
+
-apiVersion
-string |
+
-
-eventing.knative.dev/v1alpha1
-
+(Optional)
+Filter is the expression guarding the branch |
|
-kind
-string
+subscriber
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Subscriber receiving the event when the filter passes |
-EventType |
-metadata
+reply
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+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 |
+(Appears on: +ParallelStatus) +
++
ParallelBranchStatus represents the current state of a Parallel branch
+ +| Field | +Description | +||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-spec
+filterSubscriptionStatus
-
-EventTypeSpec
+
+ParallelSubscriptionStatus
|
- Spec defines the desired state of the EventType. -- -
ParallelChannelStatus +++(Appears on: +ParallelBranchStatus, +ParallelStatus) + ++ +
ParallelSpec +++(Appears on: +Parallel) + ++ +
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). |
||||||||||||||||
-status
+reply
-
-EventTypeStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- Status represents the current state of the EventType. -This data may be out of date. +Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply |
-
Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.
+(Appears on: +Parallel) + ++
ParallelStatus represents the current state of a Parallel.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
|
-||||||||
-kind
-string
+
+(Members of 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. |
-Trigger |
||||||||
-metadata
+ingressChannelStatus
-
-Kubernetes meta/v1.ObjectMeta
+
+ParallelChannelStatus
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+IngressChannelStatus corresponds to the ingress channel status. |
||||||||
-spec
+branchStatuses
-
-TriggerSpec
+
+[]ParallelBranchStatus
|
- Spec defines the desired state of the Trigger. -- -
ParallelSubscriptionStatus +++(Appears on: +ParallelBranchStatus) + ++ +
Subscription is the reference to the underlying Subscription. |
||||||||
-status
+ready
-
-TriggerStatus
-
+knative.dev/pkg/apis.Condition
|
-(Optional)
- Status represents the current state of the Trigger. This data may be out of -date. +ReadyCondition indicates whether the Subscription is ready or not. |
-(Appears on: -Broker) -
-+
Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
-channelTemplateSpec
+metadata
-
-ChannelTemplateSpec
+
+Kubernetes meta/v1.ObjectMeta
|
(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 metadata field.
|
-config
+spec
-knative.dev/pkg/apis/duck/v1.KReference
+
+SequenceSpec
+
|
-(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
+steps
-
-DeliverySpec
+
+[]SequenceStep
|
-(Optional)
- Delivery is the delivery specification to be used internally by the broker to -create subscriptions. +Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options |
-(Appears on: -Broker) -
--
BrokerStatus represents the current state of a Broker.
- -| Field | -Description | -
|---|---|
-Status
+channelTemplate
-knative.dev/pkg/apis/duck/v1.Status
+
+ChannelTemplateSpec
+
|
-
-(Members of 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. +(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). |
-address
+reply
-knative.dev/pkg/apis/duck/v1alpha1.Addressable
+knative.dev/pkg/apis/duck/v1.Destination
|
- 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} +(Optional) +Reply is a Reference to where the result of the last Subscriber gets sent to. + |
+
triggerChannel
+status
-
-Kubernetes core/v1.ObjectReference
+
+SequenceStatus
TriggerChannel is an objectref to the object for the TriggerChannel
+(Optional) +Status represents the current state of the Sequence. This data may be out of +date.
(Appears on: -EventType) +SequenceStatus)
@@ -6961,72 +6892,97 @@ Kubernetes core/v1.ObjectReference
type
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
Type represents the CloudEvents type. It is authoritative.
+Channel is the reference to the underlying channel.
source
+ready
-string
+knative.dev/pkg/apis.Condition
Source is a URI, it represents the CloudEvents source.
+ReadyCondition indicates whether the Channel is ready or not.
+(Appears on: +Sequence) +
++
+| Field | +Description | +
|---|---|
-schema
+steps
-string
+
+[]SequenceStep
+
|
-(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. +Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options |
-broker
+channelTemplate
-string
+
+ChannelTemplateSpec
+
|
- Broker refers to the Broker that can provide the EventType. +(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). |
-description
+reply
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. +Reply is a Reference to where the result of the last Subscriber gets sent to. |
(Appears on: -EventType) +Sequence)
-
EventTypeStatus represents the current state of a EventType.
+SequenceStatus represents the current state of a Sequence.
+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 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} + |
+
(Appears on: -TriggerSpec) +SequenceSpec)
@@ -7072,61 +7072,42 @@ knative.dev/pkg/apis/duck/v1.Status
sourceAndType
+Destination
-
-TriggerFilterSourceAndType
-
+knative.dev/pkg/apis/duck/v1.Destination
DeprecatedSourceAndType filters events based on exact matches on the -CloudEvents type and source attributes. This field has been replaced by the -Attributes field.
+
+(Members of Destination are embedded into this type.)
+
Subscriber receiving the step event
attributes
+delivery
-
-TriggerFilterAttributes
+
+DeliverySpec
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.
+Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc.
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.
- -(Appears on: -TriggerFilter) +SequenceStatus)
-
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.
-type
+subscription
-string
+
+Kubernetes core/v1.ObjectReference
+
|
+ Subscription is the reference to the underlying Subscription. |
-source
+ready
-string
+knative.dev/pkg/apis.Condition
|
+ ReadyCondition indicates whether the Subscription is ready or not. |
-(Appears on: -Trigger) +
Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types: ++
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-broker
-
-string
-
+apiVersion
+string |
+
+
+messaging.knative.dev/v1alpha1
+
|
+||||||||
|
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. +kind
+string
|
+Channel |
||||||||
-filter
+metadata
-
-TriggerFilter
+
+Kubernetes meta/v1.ObjectMeta
|
(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. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||
-subscriber
+spec
-knative.dev/pkg/apis/duck/v1.Destination
+
+ChannelSpec
+
|
- Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required. +Spec defines the desired state of the Channel. ++ +
TriggerStatus ---(Appears on: -Trigger) - -- TriggerStatus represents the current state of a Trigger. - -
|
||||||||
-subscriberURI
+status
-knative.dev/pkg/apis.URL
+
+ChannelStatus
+
|
- SubscriberURI is the resolved URI of the receiver for this Trigger. +(Optional) +Status represents the current state of the Channel. This data may be out of +date. |
-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: - --
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.
+InMemoryChannel is a resource representing an in memory channel
-eventing.knative.dev/v1beta1
+messaging.knative.dev/v1alpha1
|
@@ -7306,7 +7303,7 @@ eventing.knative.dev/v1beta1
Broker |
+InMemoryChannel |
|||||
| @@ -7327,28 +7324,27 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-BrokerSpec
+
+InMemoryChannelSpec
|
- Spec defines the desired state of the Broker. +Spec defines the desired state of the Channel.
|
status
-
-BrokerStatus
+
+InMemoryChannelStatus
|
(Optional)
- Status represents the current state of the Broker. This data may be out of + Status represents the current state of the Channel. This data may be out of date. |
+
Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
-eventing.knative.dev/v1beta1
+messaging.knative.dev/v1alpha1
|
@@ -7413,7 +7409,7 @@ eventing.knative.dev/v1beta1
EventType |
+Subscription |
|||||||||||||
| @@ -7425,7 +7421,6 @@ Kubernetes meta/v1.ObjectMeta |
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -7434,72 +7429,88 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-EventTypeSpec
+
+SubscriptionSpec
|
- Spec defines the desired state of the EventType.
|
status
-
-EventTypeStatus
+
+SubscriptionStatus
|
-(Optional)
- Status represents the current state of the EventType. -This data may be out of date. |
-
Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.
+(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.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1beta1
-
+channelTemplate
+
+
+ChannelTemplateSpec
+
+
|
-
-kind
-string
+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. |
-Trigger |
-metadata
+subscribable
-
-Kubernetes meta/v1.ObjectMeta
+
+Subscribable
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Channel conforms to Duck type Subscribable. |
-spec
+delivery
-
-TriggerSpec
+
+DeliverySpec
|
- Spec defines the desired state of the Trigger. -- + Delivery options. + |
+
+(Appears on: +Channel) +
++
ChannelStatus represents the current state of a Channel.
+| Field | +Description | +
|---|---|
-broker
+Status
-string
+knative.dev/pkg/apis/duck/v1.Status
|
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. +
+(Members of 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. |
-filter
+AddressStatus
-
-TriggerFilter
-
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
-(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. +
+(Members of 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} |
-subscriber
+SubscribableTypeStatus
-knative.dev/pkg/apis/duck/v1.Destination
+
+SubscribableTypeStatus
+
|
- Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required. - |
-
+(Members of SubscribableTypeStatus are embedded into this type.)
+
Subscribers is populated with the statuses of each of the Channelable’s subscribers.
status
+channel
-
-TriggerStatus
+
+Kubernetes core/v1.ObjectReference
Status represents the current state of the Trigger. This data may be out of -date.
+Channel is an ObjectReference to the Channel CRD backing this Channel.
(Appears on: -Broker) +InMemoryChannel)
+
InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
-config
+subscribable
-knative.dev/pkg/apis/duck/v1.KReference
+
+Subscribable
+
|
-(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. +Channel conforms to Duck type Subscribable. |
|
-(Optional)
- Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc. +For round tripping (v1beta1 <-> v1alpha1> |
(Appears on: -Broker) +InMemoryChannel)
-
BrokerStatus represents the current state of a Broker.
+ChannelStatus represents the current state of a Channel.
-address
+AddressStatus
-knative.dev/pkg/apis/duck/v1.Addressable
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
- Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh. +
+(Members of 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 Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
(Appears on: -EventType) +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
-type
-
-string
-
- |
-
- Type represents the CloudEvents type. It is authoritative. - |
-
-source
-
-knative.dev/pkg/apis.URL
-
- |
-
- Source is a URI, it represents the CloudEvents source. - |
-
-schema
+generation
-knative.dev/pkg/apis.URL
+int64
|
(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. +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 |
-broker
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
- Broker refers to the Broker that can provide the EventType. +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.) |
-description
+subscriber
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. +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. |
-(Appears on: -EventType) -
--
EventTypeStatus represents the current state of a EventType.
- -| Field | -Description | -
|---|---|
-Status
+reply
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of 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. +(Optional) +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-(Appears on: -TriggerSpec) -
--
-| Field | -Description | -
|---|---|
-attributes
+delivery
-
-TriggerFilterAttributes
+
+DeliverySpec
|
(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. +Delivery configuration |
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.
- -(Appears on: -Trigger) +Subscription)
+
SubscriptionStatus (computed) for a subscription
-broker
-
-string
-
- |
-
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. - |
-|
-filter
+Status
-
-TriggerFilter
-
+knative.dev/pkg/apis/duck/v1.Status
|
-
-(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. + |
+
+(Members of 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. |
-subscriber
+physicalSubscription
-knative.dev/pkg/apis/duck/v1.Destination
+
+SubscriptionStatusPhysicalSubscription
+
|
- Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required. +PhysicalSubscription is the fully resolved values that this Subscription represents. |
(Appears on: -Trigger) +SubscriptionStatus)
-
TriggerStatus represents the current state of a Trigger.
+SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
-Status
+subscriberURI
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis.URL
|
-
-(Members of 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 is the fully resolved URI for spec.subscriber. |
-subscriberUri
+replyURI
knative.dev/pkg/apis.URL
|
- SubscriberURI is the resolved URI of the receiver for this Trigger. +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. |
-
Package v1alpha1 is the v1alpha1 version of the API.
+Package v1beta1 is the v1beta1 version of the API.
Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
+Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
+apiVersion
+string |
+
+
+messaging.knative.dev/v1beta1
+
+ |
+|||||||||
+kind
+string
+ |
+Channel |
+|||||||||
metadata
@@ -8036,31 +8054,18 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-ParallelSpec
+
+ChannelSpec
- | Spec defines the desired state of the Parallel. +Spec defines the desired state of the Channel.
|
status
-
-ParallelStatus
+
+ChannelStatus
(Optional)
- |
Status represents the current state of the Parallel. This data may be out of + Status represents the current state of the Channel. This data may be out of date. |
-(Appears on: -ParallelSpec) -
-+
InMemoryChannel is a resource representing an in memory channel
-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 +
+messaging.knative.dev/v1beta1
+
|
|
-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 +kind
+string
|
+InMemoryChannel |
-(Appears on: -ParallelStatus) -
--
ParallelBranchStatus represents the current state of a Parallel branch
- -| Field | -Description | -
|---|---|
-filterSubscriptionStatus
+metadata
-
-ParallelSubscriptionStatus
+
+Kubernetes meta/v1.ObjectMeta
|
- FilterSubscriptionStatus corresponds to the filter subscription status. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-filterChannelStatus
+spec
-
-ParallelChannelStatus
+
+InMemoryChannelSpec
|
- FilterChannelStatus corresponds to the filter channel status. - |
-
-subscriberSubscriptionStatus
+ChannelableSpec
-
-ParallelSubscriptionStatus
+
+ChannelableSpec
|
- SubscriptionStatus corresponds to the subscriber subscription status. - |
-
-(Appears on: -ParallelBranchStatus, -ParallelStatus) -
+(Members of ChannelableSpec are embedded into this type.)
| Field | -Description | -
|---|---|
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
+Channel conforms to Duck type Channelable. |
-
- Channel is the reference to the underlying channel. + |
ready
+status
-knative.dev/pkg/apis.Condition
+
+InMemoryChannelStatus
+
ReadyCondition indicates whether the Channel is ready or not.
+(Optional) +Status represents the current state of the Channel. This data may be out of +date.
-(Appears on: -Parallel) -
-+
Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
-branches
-
-
-[]ParallelBranch
-
-
+apiVersion
+string |
+
+
+messaging.knative.dev/v1beta1
+
|
+
|
- Branches is the list of Filter/Subscribers pairs. +kind
+string
|
+Subscription |
-channelTemplate
+metadata
-
-ChannelTemplateSpec
+
+Kubernetes meta/v1.ObjectMeta
|
-(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). +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-reply
+spec
-knative.dev/pkg/apis/duck/v1.Destination
+
+SubscriptionSpec
+
|
-(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply - |
-
-(Appears on: -Parallel) -
--
ParallelStatus represents the current state of a Parallel.
- +| Field | -Description | +
+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.) + |
|---|---|---|---|
-Status
+subscriber
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of 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. +(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. |
||
-ingressChannelStatus
+reply
-
-ParallelChannelStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- IngressChannelStatus corresponds to the ingress channel status. +(Optional) +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
||
-branchStatuses
+delivery
-
-[]ParallelBranchStatus
+
+DeliverySpec
|
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. +(Optional) +Delivery configuration + |
+
AddressStatus
+status
-knative.dev/pkg/apis/duck/v1.AddressStatus
+
+SubscriptionStatus
+
-(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}
+
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ +(Appears on: -ParallelBranchStatus) +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.
-subscription
+channelTemplate
-
-Kubernetes core/v1.ObjectReference
+
+ChannelTemplateSpec
|
- Subscription is the reference to the underlying Subscription. +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. |
-ready
+ChannelableSpec
-knative.dev/pkg/apis.Condition
+
+ChannelableSpec
+
|
- ReadyCondition indicates whether the Subscription is ready or not. +
+(Members of Channel conforms to ChannelableSpec |
-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
+(Appears on: +Channel) + ++
ChannelStatus represents the current state of a Channel.
-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. -- -
|
+
| Field | +Description |
|---|---|
-status
+spec
-
-SequenceStatus
-
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
-(Appears on: -SequenceStatus) -
-+
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.
-channel
+metadata
-
-Kubernetes core/v1.ObjectReference
+
+Kubernetes meta/v1.ObjectMeta
|
- Channel is the reference to the underlying channel. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-ready
+spec
-knative.dev/pkg/apis.Condition
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
- ReadyCondition indicates whether the Channel is ready or not. +(Optional) +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
(Appears on: -Sequence) +InMemoryChannel)
+
InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
-steps
+ChannelableSpec
-
-[]SequenceStep
+
+ChannelableSpec
|
- Steps is the list of Destinations (processors / functions) that will be called in the order -provided. +
+(Members of Channel conforms to Duck type Channelable. |
+(Appears on: +InMemoryChannel) +
++
ChannelStatus represents the current state of a Channel.
+ +
-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). - |
+Field | +Description |
|---|---|---|---|
-reply
+ChannelableStatus
-knative.dev/pkg/apis/duck/v1.Destination
+
+ChannelableStatus
+
|
-(Optional)
- Reply is a Reference to where the result of the last Subscriber gets sent to. +
+(Members of Channel conforms to Duck type Channelable. |
(Appears on: -Sequence) +Subscription)
-
SequenceStatus represents the current state of a Sequence.
+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
-Status
+channel
-knative.dev/pkg/apis/duck/v1.Status
+
+Kubernetes core/v1.ObjectReference
+
|
-
-(Members of 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. +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.) |
-subscriptionStatuses
+subscriber
-
-[]SequenceSubscriptionStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. +(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. |
-channelStatuses
+reply
-
-[]SequenceChannelStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. +(Optional) +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-AddressStatus
+delivery
-knative.dev/pkg/apis/duck/v1.AddressStatus
+
+DeliverySpec
+
|
-
-(Members of 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} +(Optional) +Delivery configuration |
(Appears on: -SequenceSpec) +Subscription)
+
SubscriptionStatus (computed) for a subscription
-Destination
+Status
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of Subscriber receiving the step event +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. |
-delivery
+physicalSubscription
-
-DeliverySpec
+
+SubscriptionStatusPhysicalSubscription
|
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. -Needed for Roundtripping v1alpha1 <-> v1beta1. +PhysicalSubscription is the fully resolved values that this Subscription represents. |
(Appears on: -SequenceStatus) +SubscriptionStatus)
+
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
-subscription
+subscriberUri
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis.URL
|
- Subscription is the reference to the underlying Subscription. +SubscriberURI is the fully resolved URI for spec.subscriber. |
-ready
+replyUri
-knative.dev/pkg/apis.Condition
+knative.dev/pkg/apis.URL
|
- ReadyCondition indicates whether the Subscription is ready or not. +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. |