diff --git a/docs/reference/eventing/eventing-contrib.md b/docs/reference/eventing/eventing-contrib.md index c38bc838873..1e82faf9ac4 100644 --- a/docs/reference/eventing/eventing-contrib.md +++ b/docs/reference/eventing/eventing-contrib.md @@ -1,31 +1,29 @@
Packages:
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
Resource Types:
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 v1alpha1 is the v1alpha1 version of the API.
Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
-sources.knative.dev/v1alpha1
+configs.internal.knative.dev/v1alpha1
|
@@ -57,7 +73,7 @@ sources.knative.dev/v1alpha1
ApiServerSource |
+ConfigMapPropagation |
|||||||||||
| @@ -69,6 +85,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -77,64 +94,39 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ApiServerSourceSpec
+
+ConfigMapPropagationSpec
|
+ Spec defines the desired state of the ConfigMapPropagation
|
status
-
-ApiServerSourceStatus
+
+ConfigMapPropagationStatus
|
+(Optional)
+ Status represents the current state of the EventType. +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.
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha1
-
- |
-||||||
-kind
-string
- |
-SinkBinding |
-||||||
-metadata
+originalNamespace
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+OriginalNamespace is the namespace where the original configMaps are in |
||||||
-spec
+selector
-
-SinkBindingSpec
+
+Kubernetes meta/v1.LabelSelector
|
- - -
ConfigMapPropagationStatus +
-(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
+copyConfigmaps
-
-SinkBindingStatus
+
+[]ConfigMapPropagationStatusCopyConfigMap
CopyConfigMaps is the status for each copied configmap.
(Appears on: -ApiServerSourceSpec) +ConfigMapPropagationStatus)
-
ApiServerResource defines the resource to watch
+ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
-apiVersion
+name
string
|
- API version of the resource to watch. +Name is copy configmap’s name |
-kind
+source
string
|
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +Source is “originalNamespace/originalConfigMapName” |
-labelSelector
+operation
-
-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 +Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop |
-controllerSelector
+ready
-
-Kubernetes meta/v1.OwnerReference
-
+string
|
- ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. +Ready represents the operation is ready or not |
-controller
+reason
-bool
+string
|
- If true, send an event referencing the object controlling the resource +Reason indicates reasons if the operation is not ready + |
+
+resourceVersionFromSource
+
+string
+
+ |
+
+ ResourceVersion is the resourceVersion of original configmap |
-(Appears on: -ApiServerSource) +
Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types: + +-
ApiServerSourceSpec defines the desired state of ApiServerSource
+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.
-resources
-
-
-[]ApiServerResource
-
-
- |
+
- Resources is the list of resources to watch +
+eventing.knative.dev/v1alpha1
+
|
||||||
-serviceAccountName
-
+kind
string
-
- |
-
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. |
+Broker |
|||||
-sink
+metadata
-knative.dev/pkg/apis/duck/v1beta1.Destination
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-mode
+spec
-string
+
+BrokerSpec
+
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
- |
+
+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. + |
+
status
+
+
+BrokerStatus
+
+
+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 | +
|---|---|
+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: +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/v1.Addressable
+
+ |
+
+ Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh. + |
+
+(Appears on: +EventType) +
++
+| Field | +Description | +
|---|---|
+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
+
+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)
+ 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 | +
|---|---|
+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: +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 v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: ++
Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+ParallelSpec
+
+
+ |
+
+ Spec defines the desired state of the Parallel. ++ +
|
+||||||
+status
+
+
+ParallelStatus
+
+
+ |
+
+(Optional)
+ 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 + |
+
+subscriber
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Subscriber receiving the event when the filter passes + |
+
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Reply is a Reference to where the result of Subscriber of this case gets sent to. +If not specified, sent the result to the Parallel Reply + |
+
+(Appears on: +ParallelStatus) +
++
ParallelBranchStatus represents the current state of a Parallel branch
+ +| Field | +Description | +
|---|---|
+filterSubscriptionStatus
+
+
+ParallelSubscriptionStatus
+
+
+ |
+
+ FilterSubscriptionStatus corresponds to the filter subscription status. + |
+
+filterChannelStatus
+
+
+ParallelChannelStatus
+
+
+ |
+
+ FilterChannelStatus corresponds to the filter channel status. + |
+
+subscriberSubscriptionStatus
+
+
+ParallelSubscriptionStatus
+
+
+ |
+
+ SubscriptionStatus corresponds to the subscriber subscription status. + |
+
+(Appears on: +ParallelBranchStatus, +ParallelStatus) +
++
+| Field | +Description | +
|---|---|
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Channel is the reference to the underlying channel. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Channel is ready or not. + |
+
+(Appears on: +Parallel) +
++
+| Field | +Description | +
|---|---|
+branches
+
+
+[]ParallelBranch
+
+
+ |
+
+ Branches is the list of Filter/Subscribers pairs. + |
+
+channelTemplate
+
+
+ChannelTemplateSpec
+
+
+ |
+
+(Optional)
+ ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace). + |
+
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply + |
+
+(Appears on: +Parallel) +
++
ParallelStatus represents the current state of a Parallel.
+ +| 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. + |
+
+ingressChannelStatus
+
+
+ParallelChannelStatus
+
+
+ |
+
+ IngressChannelStatus corresponds to the ingress channel status. + |
+
+branchStatuses
+
+
+[]ParallelBranchStatus
+
+
+ |
+
+ BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order. + |
+
+AddressStatus
+
+knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ |
+
+
+(Members of AddressStatus 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: +ParallelBranchStatus) +
++
+| Field | +Description | +
|---|---|
+subscription
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Subscription is the reference to the underlying Subscription. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Subscription is ready or not. + |
+
+
Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+SequenceSpec
+
+
+ |
+
+ Spec defines the desired state of the Sequence. ++ +
|
+||||||
+status
+
+
+SequenceStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Sequence. This data may be out of +date. + |
+
+(Appears on: +SequenceStatus) +
++
+| Field | +Description | +
|---|---|
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Channel is the reference to the underlying channel. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Channel is ready or not. + |
+
+(Appears on: +Sequence) +
++
+| Field | +Description | +
|---|---|
+steps
+
+
+[]SequenceStep
+
+
+ |
+
+ Steps is the list of Destinations (processors / functions) that will be called in the order +provided. + |
+
+channelTemplate
+
+
+ChannelTemplateSpec
+
+
+ |
+
+(Optional)
+ ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace). + |
+
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Reply is a Reference to where the result of the last Subscriber gets sent to. + |
+
+(Appears on: +Sequence) +
++
SequenceStatus represents the current state of a Sequence.
+ +| 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. + |
+
+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: +SequenceSpec) +
++
+| Field | +Description | +
|---|---|
+Destination
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+
+(Members of Subscriber receiving the step event + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. +Needed for Roundtripping v1alpha1 <-> v1beta1. + |
+
+(Appears on: +SequenceStatus) +
++
+| Field | +Description | +
|---|---|
+subscription
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Subscription is the reference to the underlying Subscription. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Subscription is ready or not. + |
+
+
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
+
+ |
+||||||||
+kind
+string
+ |
+ApiServerSource |
+||||||||
+Deprecated
+
+
+Deprecated
+
+
+ |
+
+ 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.
+ |
+||||||||
+spec
+
+
+ApiServerSourceSpec
+
+
+ |
+
+ + +
|
+||||||||
+status
+
+
+ApiServerSourceStatus
+
+
+ |
++ | +
+
ContainerSource is the Schema for the containersources API
+ +| Field | +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.eventing.knative.dev/v1alpha1
+
+ |
+||||||||||||
+kind
+string
+ |
+ContainerSource |
+||||||||||||
+Deprecated
+
+
+Deprecated
+
+
+ |
+
+ 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.
+ |
+||||||||||||
+spec
+
+
+ContainerSourceSpec
+
+
+ |
+
+ + +
|
+||||||||||||
+status
+
+
+ContainerSourceStatus
+
+
+ |
++ | +
+
CronJobSource is the Schema for the cronjobsources API.
+ +| Field | +Description | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.eventing.knative.dev/v1alpha1
+
+ |
+||||||||||
+kind
+string
+ |
+CronJobSource |
+||||||||||
+Deprecated
+
+
+Deprecated
+
+
+ |
+
+ Deprecated allows CronJobSource to have a deprecated message. + |
+||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec
+
+
+CronJobSourceSpec
+
+
+ |
+
+ + +
|
+||||||||||
+status
+
+
+CronJobSourceStatus
+
+
+ |
++ | +
+
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.eventing.knative.dev/v1alpha1
+
+ |
+||||
+kind
+string
+ |
+SinkBinding |
+||||
+Deprecated
+
+
+Deprecated
+
+
+ |
+
+ 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.
+ |
+||||
+spec
+
+
+SinkBindingSpec
+
+
+ |
+
+ + +
|
+||||
+status
+
+
+SinkBindingStatus
+
+
+ |
++ | +
+(Appears on: +ApiServerSourceSpec) +
++
ApiServerResource defines the resource to watch
+ +| Field | +Description | +
|---|---|
+apiVersion
+
+string
+
+ |
+
+ API version of the resource to watch. + |
+
+kind
+
+string
+
+ |
+
+ Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+
+labelSelector
+
+
+Kubernetes meta/v1.LabelSelector
+
+
+ |
+
+ LabelSelector restricts this source to objects with the selected labels +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + |
+
+controllerSelector
+
+
+Kubernetes meta/v1.OwnerReference
+
+
+ |
+
+ ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. +Only apiVersion and kind are used. Both are optional. + |
+
+controller
+
+bool
+
+ |
+
+ If true, send an event referencing the object controlling the resource + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceSpec defines the desired state of ApiServerSource
+ +| Field | +Description | +
|---|---|
+resources
+
+
+[]ApiServerResource
+
+
+ |
+
+ Resources is the list of resources to watch + |
+
+serviceAccountName
+
+string
+
+ |
+
+(Optional)
+ ServiceAccountName is the name of the ServiceAccount to use to run this +source. + |
+
+sink
+
+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. + |
+
+mode
+
+string
+
+ |
+
+ 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 | +
|---|---|
+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
+
+string
+
+ |
+
+(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
+
+
+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
+
+string
+
+ |
+
+(Optional)
+ DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this
+source.
+This field is to be deprecated. Use |
+
+sink
+
+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
+
+string
+
+ |
+
+(Optional)
+ SinkURI is the current active sink URI that has been configured for the ContainerSource. + |
+
+(Appears on: +CronJobResourceSpec) +
++
+| Field | +Description | +
|---|---|
+cpu
+
+string
+
+ |
++ | +
+memory
+
+string
+
+ |
++ | +
+(Appears on: +CronJobResourceSpec) +
++
+| Field | +Description | +
|---|---|
+cpu
+
+string
+
+ |
++ | +
+memory
+
+string
+
+ |
++ | +
+(Appears on: +CronJobSourceSpec) +
++
+| Field | +Description | +
|---|---|
+requests
+
+
+CronJobRequestsSpec
+
+
+ |
++ | +
+limits
+
+
+CronJobLimitsSpec
+
+
+ |
++ | +
+(Appears on: +CronJobSource) +
++
CronJobSourceSpec defines the desired state of the CronJobSource.
+ +| Field | +Description | +
|---|---|
+schedule
+
+string
+
+ |
+
+ Schedule is the cronjob schedule. + |
+
+data
+
+string
+
+ |
+
+ Data is the data posted to the target function. + |
+
+sink
+
+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. + |
+
+serviceAccountName
+
+string
+
+ |
+
+ ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. + |
+
+resources
+
+
+CronJobResourceSpec
+
+
+ |
+
+ Resource limits and Request specifications of the Receive Adapter Deployment + |
+
+(Appears on: +CronJobSource) +
++
CronJobSourceStatus defines the observed state of CronJobSource.
+ +| 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
+
+string
+
+ |
+
+(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
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of |
+
+BindingSpec
+
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+ |
+
+
+(Members of |
+
+(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 v1alpha2 contains API Schema definitions for the sources v1beta1 API group
+ +Resource Types: +-(Appears on: -ApiServerSource) +
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
+
+
+ |
++ | +
-
ApiServerSourceStatus defines the observed state of 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.
-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 |
-sinkUri
+metadata
-string
+
+Kubernetes meta/v1.ObjectMeta
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the ApiServerSource. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-(Appears on: -SinkBinding) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
- -| Field | -Description | -
+spec
+
+
+SinkBindingSpec
+
+
+ |
+
+ + +
SinkBindingStatus ---(Appears on: -SinkBinding) - -- SinkBindingStatus communicates the observed state of the SinkBinding (from the controller). - -
- duck.knative.dev/v1alpha1-- Package v1alpha1 is the v1alpha1 version of the API. - -Resource Types: -BackoffPolicyType
-(
- |
|---|
| 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.
+APIVersionKind is an APIVersion and Kind tuple.
-metadata
+apiVersion
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+APIVersion - the API version of the resource to watch. |
-spec
+kind
-k8s.io/apimachinery/pkg/runtime.RawExtension
+string
|
(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
-
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: +ApiServerSource) + ++
ApiServerSourceSpec defines the desired state of ApiServerSource
-metadata
+SourceSpec
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(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. |
||||
-spec
-
-
-ChannelableSpec
-
-
- |
-
- Spec is the part where the Channelable fulfills the Subscribable contract. -- -
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 |
||||
-status
+owner
-
-ChannelableStatus
+
+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. |
-(Appears on: -Channelable) -
--
ChannelableSpec contains Spec of the Channelable object
- -| Field | -Description | -
|---|---|
-SubscribableTypeSpec
+mode
-
-SubscribableTypeSpec
-
+string
|
-
-(Members of EventMode controls the format of the event.
+ |
-delivery
+serviceAccountName
-
-DeliverySpec
-
+string
|
(Optional)
- DeliverySpec contains options controlling the event delivery +ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set. |
(Appears on: -Channelable) +ApiServerSource)
-
ChannelableStatus contains the Status of a Channelable object.
+ApiServerSourceStatus defines the observed state of ApiServerSource
-Status
+SourceStatus
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(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. +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 | +
|---|---|
-AddressStatus
+SourceSpec
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +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. |
-SubscribableTypeStatus
+schedule
-
-SubscribableTypeStatus
-
+string
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +(Optional) +Schedule is the cronjob schedule. Defaults to |
-errorChannel
+jsonData
-
-Kubernetes core/v1.ObjectReference
-
+string
|
(Optional)
- ErrorChannel is set by the channel when it supports native error handling via a channel +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: -BrokerSpec, -ChannelableSpec, -SubscriptionSpec) +PingSource)
-
DeliverySpec contains the delivery options for event senders, -such as channelable and source.
+PingSourceStatus defines the observed state of PingSource.
-deadLetterSink
+SourceStatus
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(Optional)
- DeadLetterSink is the sink receiving event that couldn’t be sent to -a destination. +
+(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).
+ +
-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. - |
+Field | +Description |
|---|---|---|---|
-backoffPolicy
+SourceSpec
-
-BackoffPolicyType
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Optional)
- BackoffPolicy is the retry backoff policy (linear, exponential) +
+(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. |
||
-backoffDelay
+BindingSpec
-string
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
-(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^
+(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations. |
-
DeliveryStatus contains the Status of an object supporting delivery options.
+(Appears on: +SinkBinding) + ++
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
-deadLetterChannel
+SourceStatus
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(Optional)
- DeadLetterChannel is the reference to the native, platform specific channel -where failed events are sent to. +
+(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: +-
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.
+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: -ChannelSpec, -InMemoryChannelSpec, -SubscribableTypeSpec) -
--
Subscribable is the schema for the subscribable portion of the spec -section of the resource.
- +spec
+
+
+ChannelableSpec
+
+
+Spec is the part where the Channelable fulfills the Subscribable contract.
+| Field | -Description | +
+SubscribableTypeSpec
+
+
+SubscribableTypeSpec
+
+
+ |
+
+
+(Members of |
|---|---|---|---|
-subscribers
+delivery
-
-[]SubscriberSpec
+
+DeliverySpec
|
- This is the list of subscriptions for this subscribable. +(Optional) +DeliverySpec contains options controlling the event delivery |
-(Appears on: -SubscribableTypeStatus) -
--
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
- -| Field | -Description | +
|---|---|
-subscribers
+status
-
-[]SubscriberStatus
+
+ChannelableStatus
|
- 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.
+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.
metadata
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+spec
+
+
+ChannelableCombinedSpec
+
+
+ |
+
+ Spec is the part where the Channelable fulfills the Subscribable contract. ++ +
SubscribableTypeSpec
+ |
+
-subscribable
+SubscribableTypeSpec
-
-Subscribable
+
+SubscribableTypeSpec
|
- | -
-(Appears on:
-ChannelStatus,
-ChannelableStatus,
-InMemoryChannelStatus,
-SubscribableType)
+(Members of SubscribableTypeSpec are embedded into this type.)
SubscribableTypeSpec is for the v1alpha1 spec compatibility.
+SubscribableSpec
+
+
+SubscribableSpec
+
+
+-
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+(Members ofSubscribableSpec are embedded into this type.)
-| Field | -Description | +
|---|---|
-subscribableStatus
+delivery
-
-SubscribableStatus
+
+DeliverySpec
|
+(Optional)
+ DeliverySpec contains options controlling the event delivery |
(Appears on: -Subscribable) +ChannelableCombined)
-
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
+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. |
-generation
+AddressStatus
-int64
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
-(Optional)
- Generation of the origin of the subscriber with uid:UID. +
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. |
-subscriberURI
+SubscribableTypeStatus
-knative.dev/pkg/apis.URL
+
+SubscribableTypeStatus
+
|
-(Optional)
+
+(Members of SubscribableTypeStatus is the v1alpha1 part of the Subscribers status |
-replyURI
+SubscribableStatus
-knative.dev/pkg/apis.URL
+
+SubscribableStatus
+
|
-(Optional)
+
+(Members of SubscribableStatus is the v1beta1 part of the Subscribers status. |
-deadLetterSink
+errorChannel
-knative.dev/pkg/apis.URL
+
+Kubernetes core/v1.ObjectReference
+
|
(Optional)
+ ErrorChannel is set by the channel when it supports native error handling via a channel |
(Appears on: -SubscribableStatus) +Channelable)
-
SubscriberStatus defines the status of a single subscriber to a Channel.
+ChannelableSpec contains Spec of the Channelable object
-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
+SubscribableTypeSpec
-
-Kubernetes core/v1.ConditionStatus
+
+SubscribableTypeSpec
|
-(Optional)
- Status of the subscriber. +
+(Members of |
-message
+delivery
-string
+
+DeliverySpec
+
|
(Optional)
- A human readable message indicating details of Ready status. +DeliverySpec contains options controlling the event delivery |
-
Package v1alpha1 is the v1alpha1 version of the API.
+(Appears on: +Channelable) -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.
+ChannelableStatus contains the Status of a Channelable object.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
- |
-||||
-kind
-string
- |
-Broker |
-||||
-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
-
-
-BrokerSpec
-
-
- |
-
- Spec defines the desired state of the Broker. -- -
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
||||
-status
+errorChannel
-
-BrokerStatus
+
+Kubernetes core/v1.ObjectReference
|
(Optional)
- Status represents the current state of the Broker. This data may be out of -date. +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.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
- |
-
-kind
-string
- |
-EventType |
-
metadata
@@ -1521,81 +5301,134 @@ Kubernetes meta/v1.ObjectMeta
|
-(Optional)
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 | +
|---|---|
-spec
+subscribers
-
-EventTypeSpec
+
+[]SubscriberSpec
|
- Spec defines the desired state of the EventType. -- + 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.
+
-type
-
-string
-
- |
-
- Type represents the CloudEvents type. It is authoritative. - |
+Field | +Description |
|---|---|---|---|
-source
+subscribers
-string
+
+[]SubscriberStatus
+
|
- Source is a URI, it represents the CloudEvents source. +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 | +
|---|---|
-schema
+metadata
-string
+
+Kubernetes meta/v1.ObjectMeta
+
|
-(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. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-broker
+spec
-string
+
+SubscribableTypeSpec
+
|
- Broker refers to the Broker that can provide the EventType. - |
-
-description
+subscribable
-string
+
+Subscribable
+
|
-(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. |
status
-
-EventTypeStatus
+
+SubscribableTypeStatus
Status represents the current state of the EventType. -This data may be out of date.
+SubscribableTypeStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract.
-
Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.
+(Appears on: +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType) + ++
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
- |
-
-kind
-string
- |
-Trigger |
-
-metadata
+subscribable
-
-Kubernetes meta/v1.ObjectMeta
+
+Subscribable
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
|
+(Appears on: +ChannelStatus, +ChannelableCombinedStatus, +ChannelableStatus, +InMemoryChannelStatus, +SubscribableType) +
++
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+ +| Field | +Description | +
|---|---|
-spec
+subscribableStatus
-
-TriggerSpec
+
+SubscribableStatus
|
- Spec defines the desired state of the Trigger. -- + |
+
+(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 | +
|---|---|
-broker
+uid
-string
+k8s.io/apimachinery/pkg/types.UID
|
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. +(Optional) +UID is used to understand the origin of the subscriber. |
-filter
+generation
-
-TriggerFilter
-
+int64
|
(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. +Generation of the origin of the subscriber with uid:UID. |
-subscriber
+subscriberURI
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis.URL
|
- Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required. - |
-
status
+replyURI
-
-TriggerStatus
-
+knative.dev/pkg/apis.URL
Status represents the current state of the Trigger. This data may be out of -date.
-(Appears on: -Broker) -
--
-| Field | -Description | -
|---|---|
-channelTemplateSpec
+deadLetterSink
-
-ChannelTemplateSpec
-
+knative.dev/pkg/apis.URL
|
(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). |
delivery
-
+
DeliverySpec
|
(Optional)
- Delivery is the delivery specification to be used internally by the broker to -create subscriptions. |
(Appears on: -Broker) +SubscribableStatus)
-
BrokerStatus represents the current state of a Broker.
+SubscriberStatus defines the status of a single subscriber to a Channel.
-Status
+uid
-knative.dev/pkg/apis/duck/v1.Status
+k8s.io/apimachinery/pkg/types.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. +(Optional) +UID is used to understand the origin of the subscriber. |
-address
+observedGeneration
-knative.dev/pkg/apis/duck/v1alpha1.Addressable
+int64
|
- 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) +Generation of the origin of the subscriber with uid:UID. |
-triggerChannel
+ready
-
-Kubernetes core/v1.ObjectReference
+
+Kubernetes core/v1.ConditionStatus
|
- TriggerChannel is an objectref to the object for the TriggerChannel +(Optional) +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: -EventType) +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.
-type
-
-string
-
- |
-
- Type represents the CloudEvents type. It is authoritative. - |
-||||||||
-source
+metadata
-string
+
+Kubernetes meta/v1.ObjectMeta
+
|
- Source is a URI, it represents the CloudEvents source. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||
-schema
+spec
-string
+
+ChannelableSpec
+
|
-(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
+SubscribableSpec
-string
+
+SubscribableSpec
+
|
- Broker refers to the Broker that can provide the EventType. +
+(Members of |
-description
+delivery
-string
+
+DeliverySpec
+
|
(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. +DeliverySpec contains options controlling the event delivery |
-(Appears on: -EventType) -
--
EventTypeStatus represents the current state of a EventType.
- -| Field | -Description | +
|---|---|
-Status
+status
-knative.dev/pkg/apis/duck/v1.Status
+
+ChannelableStatus
+
|
-
-(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) +ChannelSpec, +Channelable, +InMemoryChannelSpec)
+
ChannelableSpec contains Spec of the Channelable object
-sourceAndType
+SubscribableSpec
-
-TriggerFilterSourceAndType
+
+SubscribableSpec
|
-(Optional)
- 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 |
-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. +DeliverySpec contains options controlling the event delivery |
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) +ChannelStatus, +Channelable, +InMemoryChannelStatus)
-
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.
+ChannelableStatus contains the Status of a Channelable object.
-type
+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. |
-source
+AddressStatus
-string
+knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ |
+
+
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. + |
+
+SubscribableStatus
+
+
+SubscribableStatus
+
|
+
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. + |
+
+deadLetterChannel
+
+knative.dev/pkg/apis/duck/v1.KReference
+
+ |
+
+(Optional)
+ DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel +Failed messages are delivered here. |
(Appears on: -Trigger) +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.
-broker
+deadLetterSink
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. +(Optional) +DeadLetterSink is the sink receiving event that couldn’t be sent to +a destination. |
-filter
+retry
-
-TriggerFilter
+int32
+
+ |
+
+(Optional)
+ Retry is the minimum number of retries the sender should attempt when +sending an event before moving it to the dead letter sink. + |
+
+backoffPolicy
+
+
+BackoffPolicyType
|
(Optional)
- 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. +BackoffPolicy is the retry backoff policy (linear, exponential) |
-subscriber
+backoffDelay
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
- Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required. +(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: -Trigger) -
--
TriggerStatus represents the current state of a Trigger.
+DeliveryStatus contains the Status of an object supporting delivery options.
-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
+deadLetterChannel
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis/duck/v1.KReference
|
- SubscriberURI is the resolved URI of the receiver for this Trigger. +(Optional) +DeadLetterChannel is a KReference that is the reference to the native, platform specific channel +where failed events are sent to. |
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
+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.
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -2206,55 +6063,28 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ParallelSpec
+
+SubscribableSpec
|
- Spec defines the desired state of the Parallel. +SubscribableSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract.
|
status
-
-ParallelStatus
+
+SubscribableStatus
|
-(Optional)
- Status represents the current state of the Parallel. 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: -ParallelSpec) +ChannelableCombinedSpec, +ChannelableSpec, +Subscribable)
+
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
-filter
+subscribers
-knative.dev/pkg/apis/duck/v1.Destination
+
+[]SubscriberSpec
+
|
- Filter is the expression guarding the branch +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.
+ +
-subscriber
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
- Subscriber receiving the event when the filter passes - |
+Field | +Description |
|---|---|---|---|
-reply
+subscribers
-knative.dev/pkg/apis/duck/v1.Destination
+
+[]SubscriberStatus
+
|
-(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 +This is the list of subscription’s statuses for this channel. |
(Appears on: -ParallelStatus) +SubscribableSpec)
-
ParallelBranchStatus represents the current state of a Parallel branch
+SubscriberSpec defines a single subscriber to a Subscribable.
+At least one of SubscriberURI and ReplyURI must be present
-filterSubscriptionStatus
+uid
-
-ParallelSubscriptionStatus
-
+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
|
- FilterSubscriptionStatus corresponds to the filter subscription status. +(Optional) +SubscriberURI is the endpoint for the subscriber |
-filterChannelStatus
+replyUri
-
-ParallelChannelStatus
-
+knative.dev/pkg/apis.URL
|
- FilterChannelStatus corresponds to the filter channel status. +(Optional) +ReplyURI is the endpoint for the reply |
-subscriberSubscriptionStatus
+delivery
-
-ParallelSubscriptionStatus
+
+DeliverySpec
|
- SubscriptionStatus corresponds to the subscriber subscription status. +(Optional) +DeliverySpec contains options controlling the event delivery |
(Appears on: -ParallelBranchStatus, -ParallelStatus) +SubscribableStatus)
+
SubscriberStatus defines the status of a single subscriber to a Channel.
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Channel is the reference to the underlying channel. - |
-
-ready
+uid
-knative.dev/pkg/apis.Condition
+k8s.io/apimachinery/pkg/types.UID
|
- ReadyCondition indicates whether the Channel is ready or not. +(Optional) +UID is used to understand the origin of the subscriber. |
-(Appears on: -Parallel) -
--
-| Field | -Description | -
|---|---|
-branches
+observedGeneration
-
-[]ParallelBranch
-
+int64
|
- Branches is the list of Filter/Subscribers pairs. +(Optional) +Generation of the origin of the subscriber with uid:UID. |
-channelTemplate
+ready
-
-ChannelTemplateSpec
+
+Kubernetes core/v1.ConditionStatus
|
-(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). +Status of the subscriber. |
-reply
+message
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply +A human readable message indicating details of Ready status. |
-(Appears on: -Parallel) +
Package v1beta1 is the v1beta1 version of the API.
+Resource Types: +-
ParallelStatus represents the current state of a Parallel.
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
-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. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-ingressChannelStatus
+spec
-
-ParallelChannelStatus
+
+ParallelSpec
|
- IngressChannelStatus corresponds to the ingress channel status. - |
-
-branchStatuses
+branches
-
-[]ParallelBranchStatus
+
+[]ParallelBranch
|
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. +Branches is the list of Filter/Subscribers pairs. |
-AddressStatus
+channelTemplate
-knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ChannelTemplateSpec
+
|
-
-(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) +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). |
-(Appears on: -ParallelBranchStatus) -
--
-| Field | -Description | -
|---|---|
-subscription
+reply
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- Subscription is the reference to the underlying Subscription. +(Optional) +Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply + |
+
ready
+status
-knative.dev/pkg/apis.Condition
+
+ParallelStatus
+
ReadyCondition indicates whether the Subscription is ready or not.
+(Optional) +Status represents the current state of the Parallel. This data may be out of +date.
-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
+(Appears on: +ParallelSpec) + +
-metadata
+filter
-
-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.
+Filter is the expression guarding the branch |
||||||||
-spec
+subscriber
-
-SequenceSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- Spec defines the desired state of the Sequence. -- -
ParallelBranchStatus +++(Appears on: +ParallelStatus) + ++ ParallelBranchStatus represents the current state of a Parallel branch + +
FilterChannelStatus corresponds to the filter channel status. |
||||||||
-status
+subscriberSubscriptionStatus
-
-SequenceStatus
+
+ParallelSubscriptionStatus
|
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. +SubscriptionStatus corresponds to the subscriber subscription status. |
(Appears on: -SequenceStatus) +ParallelBranchStatus, +ParallelStatus)
@@ -2754,11 +6591,11 @@ knative.dev/pkg/apis.Condition
(Appears on: -Sequence) +Parallel)
@@ -2772,21 +6609,22 @@ knative.dev/pkg/apis.Condition
steps
+branches
-[]knative.dev/pkg/apis/duck/v1.Destination
+
+[]ParallelBranch
+
Steps is the list of Destinations (processors / functions) that will be called in the order -provided.
+Branches is the list of Filter/Subscribers pairs.
channelTemplate
-
+
ChannelTemplateSpec
@@ -2806,19 +6644,20 @@ knative.dev/pkg/apis/duck/v1.Destination
Reply is a Reference to where the result of the last Subscriber gets sent to.
+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: -Sequence) +Parallel)
-
SequenceStatus represents the current state of a Sequence.
+ParallelStatus represents the current state of a Parallel.
-subscriptionStatuses
+ingressChannelStatus
-
-[]SequenceSubscriptionStatus
+
+ParallelChannelStatus
|
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. +IngressChannelStatus corresponds to the ingress channel status. |
-channelStatuses
+branchStatuses
-
-[]SequenceChannelStatus
+
+[]ParallelBranchStatus
|
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. +BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order. |
(Appears on: -SequenceStatus) +ParallelBranchStatus)
@@ -2932,25 +6770,11 @@ knative.dev/pkg/apis.Condition -
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
-apiVersion
-string |
-
-
-sources.eventing.knative.dev/v1alpha1
-
- |
-||||||||
-kind
-string
- |
-ApiServerSource |
-||||||||
-Deprecated
-
-
-Deprecated
-
-
- |
-
- Deprecated allows ApiServerSource to have a deprecated message. - |
-||||||||
metadata
@@ -3000,6 +6794,7 @@ Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -3008,87 +6803,126 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ApiServerSourceSpec
+
+SequenceSpec
|
+ Spec defines the desired state of the Sequence.
|
||||||
-mode
+status
-string
+
+SequenceStatus
+
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
- Status represents the current state of the Sequence. This data may be out of +date. |
+(Appears on: +SequenceStatus) +
++
+| Field | +Description |
|---|---|
-status
+channel
-
-ApiServerSourceStatus
+
+Kubernetes core/v1.ObjectReference
|
+ Channel is the reference to the underlying channel. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Channel is ready or not. |
-
ContainerSource is the Schema for the containersources API
+(Appears on: +Sequence) + +
-apiVersion
-string |
-
-
-sources.eventing.knative.dev/v1alpha1
-
+steps
+
+
+[]SequenceStep
+
+
|
-
-kind
-string
+Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options |
-ContainerSource |
-Deprecated
+channelTemplate
-
-Deprecated
+
+ChannelTemplateSpec
|
- Deprecated allows ContainerSource to have a deprecated message. +(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). |
-metadata
+reply
-
-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)
+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 | +||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-spec
+Status
-
-ContainerSourceSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
- - -
SequenceStep +++(Appears on: +SequenceSpec) + ++ +
SequenceSubscriptionStatus +++(Appears on: +SequenceStatus) + ++ +
Subscription is the reference to the underlying Subscription. |
||||||||||||||||
-status
+ready
-
-ContainerSourceStatus
-
+knative.dev/pkg/apis.Condition
|
+ ReadyCondition indicates whether the Subscription is ready or not. |
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: +-
CronJobSource is the Schema for the cronjobsources API.
+Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-sources.eventing.knative.dev/v1alpha1
+messaging.knative.dev/v1alpha1
|
@@ -3283,20 +7184,7 @@ sources.eventing.knative.dev/v1alpha1
CronJobSource |
-
-||||||||||||||
-Deprecated
-
-
-Deprecated
-
-
- |
-
- Deprecated allows CronJobSource to have a deprecated message. - |
+Channel |
|||||||||||||
| @@ -3308,6 +7196,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -3316,71 +7205,54 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-CronJobSourceSpec
+
+ChannelSpec
|
+ Spec defines the desired state of the Channel.
|
status
-
-CronJobSourceStatus
+
+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.eventing.knative.dev/v1alpha1
+messaging.knative.dev/v1alpha1
|
@@ -3433,20 +7303,7 @@ sources.eventing.knative.dev/v1alpha1
SinkBinding |
-
-||||||||
-Deprecated
-
-
-Deprecated
-
-
- |
-
- Deprecated allows ApiServerSource to have a deprecated message. - |
+InMemoryChannel |
|||||||
| @@ -3458,6 +7315,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -3466,39 +7324,40 @@ 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/v1alpha1
+
|
|
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
+generation
-bool
+int64
|
- If true, send an event referencing the object controlling the resource +(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 |
-(Appears on: -ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
- -| Field | -Description | -
|---|---|
-resources
+channel
-
-[]ApiServerResource
+
+Kubernetes core/v1.ObjectReference
|
- Resources is the list of resources to watch +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.) |
-serviceAccountName
+subscriber
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. +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
+reply
-knative.dev/pkg/apis/duck/v1beta1.Destination
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-mode
+delivery
-string
+
+DeliverySpec
+
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
- Delivery configuration |
-(Appears on: -ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
- -| 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
+
+SubscriptionStatus
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the ApiServerSource. |
(Appears on: -ContainerSource) +Channel)
-
ContainerSourceSpec defines the desired state of ContainerSource
+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.
-template
+channelTemplate
-
-Kubernetes core/v1.PodTemplateSpec
+
+ChannelTemplateSpec
|
-(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 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. |
-env
+subscribable
-
-[]Kubernetes core/v1.EnvVar
+
+Subscribable
|
-(Optional)
- DeprecatedEnv is the list of environment variables to set in the container.
-Cannot be updated.
-This field is to be deprecated. Use |
-
-serviceAccountName
-
-string
-
- |
-
-(Optional)
- DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this
-source.
-This field is to be deprecated. Use Channel conforms to Duck type Subscribable. |
-sink
+delivery
-knative.dev/pkg/apis/duck/v1beta1.Destination
+
+DeliverySpec
+
|
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +Delivery options. |
(Appears on: -ContainerSource) +Channel)
-
ContainerSourceStatus defines the observed state of ContainerSource
+ChannelStatus represents the current state of a Channel.
-sinkUri
+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
-string
+
+Kubernetes core/v1.ObjectReference
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the ContainerSource. +Channel is an ObjectReference to the Channel CRD backing this Channel. |
(Appears on: -CronJobResourceSpec) +InMemoryChannel)
+
InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
-cpu
+subscribable
-string
+
+Subscribable
+
|
+ Channel conforms to Duck type Subscribable. |
-memory
+delivery
-string
+
+DeliverySpec
+
|
+ For round tripping (v1beta1 <-> v1alpha1> |
(Appears on: -CronJobResourceSpec) +InMemoryChannel)
+
ChannelStatus represents the current state of a Channel.
-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. |
-memory
+AddressStatus
-string
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
- | -
-(Appears on: -CronJobSourceSpec) -
+(Members of AddressStatus are embedded into this type.)
| Field | -Description | -
|---|---|
-requests
-
-
-CronJobRequestsSpec
-
-
- |
-
+ 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} |
-limits
+SubscribableTypeStatus
-
-CronJobLimitsSpec
+
+SubscribableTypeStatus
|
+
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
(Appears on: -CronJobSource) +Subscription)
-
CronJobSourceSpec defines the desired state of the CronJobSource.
+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
-schedule
+generation
-string
+int64
|
- Schedule is the cronjob schedule. +(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 |
-data
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
- Data is the data posted to the target function. +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.) |
-sink
+subscriber
-knative.dev/pkg/apis/duck/v1beta1.Destination
+knative.dev/pkg/apis/duck/v1.Destination
|
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +(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
|
- ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. +(Optional) +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-resources
+delivery
-
-CronJobResourceSpec
+
+DeliverySpec
|
- Resource limits and Request specifications of the Receive Adapter Deployment +(Optional) +Delivery configuration |
(Appears on: -CronJobSource) +Subscription)
-
CronJobSourceStatus defines the observed state of CronJobSource.
+SubscriptionStatus (computed) for a subscription
-sinkUri
+physicalSubscription
-string
+
+SubscriptionStatusPhysicalSubscription
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the CronJobSource. +PhysicalSubscription is the fully resolved values that this Subscription represents. |
-(Appears on: -ApiServerSource, -ContainerSource, -CronJobSource, -SinkBinding) -
--
-(Appears on: -SinkBinding) +SubscriptionStatus)
-
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
-SourceSpec
+subscriberURI
-knative.dev/pkg/apis/duck/v1.SourceSpec
+knative.dev/pkg/apis.URL
|
-
-(Members of SubscriberURI is the fully resolved URI for spec.subscriber. |
-BindingSpec
+replyURI
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+knative.dev/pkg/apis.URL
|
-
-(Members of ReplyURI is the fully resolved URI for the spec.reply. |
-(Appears on: -SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -| Field | -Description | -
|---|---|
-SourceStatus
+deadLetterSinkURI
-knative.dev/pkg/apis/duck/v1.SourceStatus
+knative.dev/pkg/apis.URL
|
-
-(Members of 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: -
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
@@ -4227,7 +8024,7 @@ Resource Types: string
-messaging.knative.dev/v1alpha1
+messaging.knative.dev/v1beta1
spec
-
+
ChannelSpec
@@ -4271,7 +8068,7 @@ ChannelSpec
channelTemplate
-
+
ChannelTemplateSpec
@@ -4283,15 +8080,18 @@ This is immutable after creation. Normally this is set by the Channel defaulter,
subscribable
+ChannelableSpec
-
-Subscribable
+
+ChannelableSpec
Channel conforms to Duck type Subscribable.
+
+(Members of ChannelableSpec are embedded into this type.)
+
Channel conforms to ChannelableSpec
status
-
+
ChannelStatus
@@ -4314,7 +8114,7 @@ date.
-
InMemoryChannel is a resource representing an in memory channel
@@ -4333,7 +8133,7 @@ date. string
-messaging.knative.dev/v1alpha1
+messaging.knative.dev/v1beta1
spec
-
+
InMemoryChannelSpec
@@ -4375,15 +8175,18 @@ InMemoryChannelSpec
-subscribable
-
-
-Subscribable
+ChannelableSpec
+
+
+ChannelableSpec
|
- Channel conforms to Duck type Subscribable. +
+(Members of Channel conforms to Duck type Channelable. |
status
-
+
InMemoryChannelStatus
@@ -4406,7 +8209,7 @@ date.
-
Subscription routes events received on a Channel to a DNS name and @@ -4426,7 +8229,7 @@ corresponds to the subscriptions.channels.knative.dev CRD.
string
-messaging.knative.dev/v1alpha1
+messaging.knative.dev/v1beta1
spec
-
+
SubscriptionSpec
@@ -4466,21 +8269,6 @@ SubscriptionSpec
-generation
-
-int64
-
- |
-
-(Optional)
- TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete. -We should be able to drop this property with a CRD conversion webhook -in the future - |
-||
channel
@@ -4489,6 +8277,14 @@ 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 @@ -4529,7 +8325,7 @@ the Subscriber target. |
delivery
-
+
DeliverySpec
@@ -4546,7 +8342,7 @@ DeliverySpec
|
status
-
+
SubscriptionStatus
@@ -4556,11 +8352,17 @@ SubscriptionStatus
|
+
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ +(Appears on: -Channel) +Channel)
ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. @@ -4578,7 +8380,7 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba
channelTemplate
-
+
ChannelTemplateSpec
@@ -4590,24 +8392,27 @@ This is immutable after creation. Normally this is set by the Channel defaulter,
subscribable
+ChannelableSpec
-
-Subscribable
+
+ChannelableSpec
Channel conforms to Duck type Subscribable.
+
+(Members of ChannelableSpec are embedded into this type.)
+
Channel conforms to ChannelableSpec
(Appears on: -Channel) +Channel)
ChannelStatus represents the current state of a Channel.
@@ -4622,78 +8427,300 @@ SubscribableStatus
+ChannelableStatus
-knative.dev/pkg/apis/duck/v1.Status
+
+ChannelableStatus
+
-(Members of Status are embedded into this type.)
+(Members of ChannelableStatus 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.
+Channel conforms to ChannelableStatus
AddressStatus
+channel
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+knative.dev/pkg/apis/duck/v1.KReference
Channel is an KReference to the Channel CRD backing this Channel.
+
-(Members of AddressStatus are embedded into this type.)
+(Appears on:
+BrokerSpec,
+ChannelSpec,
+ChannelSpec,
+ParallelSpec,
+ParallelSpec,
+SequenceSpec,
+SequenceSpec)
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}
++
+| 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. |
-SubscribableTypeStatus
+reply
-
-SubscribableTypeStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +(Optional) +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-channel
+delivery
-
-Kubernetes core/v1.ObjectReference
+
+DeliverySpec
|
- Channel is an ObjectReference to the Channel CRD backing this Channel. +(Optional) +Delivery configuration |
(Appears on: -InMemoryChannel) +Subscription)
-
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
+SubscriptionStatus (computed) for a subscription
-subscribable
+Status
-
-Subscribable
+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
|
- Channel conforms to Duck type Subscribable. +PhysicalSubscription is the fully resolved values that this Subscription represents. |
(Appears on: -InMemoryChannel) +SubscriptionStatus)
-
ChannelStatus represents the current state of a Channel.
+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 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} +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. +ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. |
+
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 |