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:

-

sources.eventing.knative.dev/v1alpha1

+

sources.knative.dev/v1alpha1

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

Resource Types: -

AwsSqsSource +

AwsSqsSource

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 @@ -73,7 +71,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + AwsSqsSourceSpec @@ -140,7 +138,7 @@ run the Receive Adapter Deployment.

status
- + AwsSqsSourceStatus @@ -150,7 +148,7 @@ AwsSqsSourceStatus -

CamelSource +

CamelSource

CamelSource is the Schema for the camelsources API

@@ -169,7 +167,7 @@ AwsSqsSourceStatus string -sources.eventing.knative.dev/v1alpha1 +sources.knative.dev/v1alpha1 @@ -198,7 +196,7 @@ Refer to the Kubernetes API documentation for the fields of the 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 +

CouchDbSource

CouchDbSource is the Schema for the githubsources API

@@ -281,7 +279,7 @@ CamelSourceStatus string -sources.eventing.knative.dev/v1alpha1 +sources.knative.dev/v1alpha1 @@ -310,7 +308,7 @@ Refer to the Kubernetes API documentation for the fields of the 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 +

GitHubSource

GitHubSource is the Schema for the githubsources API

@@ -421,7 +419,7 @@ CouchDbSourceStatus string -sources.eventing.knative.dev/v1alpha1 +sources.knative.dev/v1alpha1 @@ -450,7 +448,7 @@ Refer to the Kubernetes API documentation for the fields of the 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 -

-

-

KafkaSource is the Schema for the kafkasources API.

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-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 - - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-bootstrapServers
- -string - -
-

Bootstrap servers are the Kafka servers the consumer will connect to.

-
-topics
- -string - -
-

Topic topics to consume messages from

-
-consumerGroup
- -string - -
-

ConsumerGroupID is the consumer group ID.

-
-net
- - -KafkaSourceNetSpec - - -
-
-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.

-
-serviceAccountName
- -string - -
-

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

-
-resources
- - -KafkaResourceSpec - - -
-

Resource limits and Request specifications of the Receive Adapter Deployment

-
-
-status
- - -KafkaSourceStatus - - -
-
-

PrometheusSource +

PrometheusSource

PrometheusSource is the Schema for the prometheussources API

@@ -761,7 +603,7 @@ KafkaSourceStatus string -sources.eventing.knative.dev/v1alpha1 +sources.knative.dev/v1alpha1 @@ -790,7 +632,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + PrometheusSourceSpec @@ -905,7 +747,7 @@ name to use as the sink.

status
- + PrometheusSourceStatus @@ -915,11 +757,11 @@ PrometheusSourceStatus -

AwsSqsSourceSpec +

AwsSqsSourceSpec

(Appears on: -AwsSqsSource) +AwsSqsSource)

AwsSqsSourceSpec defines the desired state of the source.

@@ -985,11 +827,11 @@ run the Receive Adapter Deployment.

-

AwsSqsSourceStatus +

AwsSqsSourceStatus

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

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.

-

CamelSourceOriginSpec +

CamelSourceOriginSpec

(Appears on: -CamelSourceSpec) +CamelSourceSpec)

CamelSourceOriginSpec is the integration flow to run

@@ -1053,7 +887,7 @@ string integration
-github.com/apache/camel-k/pkg/apis/camel/v1alpha1.IntegrationSpec +github.com/apache/camel-k/pkg/apis/camel/v1.IntegrationSpec @@ -1064,7 +898,7 @@ github.com/apache/camel-k/pkg/apis/camel/v1alpha1.IntegrationSpec flow
- + Flow @@ -1075,11 +909,11 @@ Flow -

CamelSourceSpec +

CamelSourceSpec

(Appears on: -CamelSource) +CamelSource)

CamelSourceSpec defines the desired state of CamelSource

@@ -1096,7 +930,7 @@ Flow source
- + CamelSourceOriginSpec @@ -1132,11 +966,11 @@ modifications of the event sent to the sink.

-

CamelSourceStatus +

CamelSourceStatus

(Appears on: -CamelSource) +CamelSource)

CamelSourceStatus defines the observed state of CamelSource

@@ -1179,11 +1013,11 @@ string -

CouchDbSourceSpec +

CouchDbSourceSpec

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

CouchDbSourceStatus +

CouchDbSourceStatus

(Appears on: -CouchDbSource) +CouchDbSource)

CouchDbSourceStatus defines the observed state of CouchDbSource

@@ -1312,29 +1146,29 @@ for the CouchDbSource.

-

FeedType +

FeedType (string alias)

(Appears on: -CouchDbSourceSpec) +CouchDbSourceSpec)

FeedType is the type of Feed

-

Flow +

Flow (map[string]interface{} alias)

(Appears on: -CamelSourceOriginSpec) +CamelSourceOriginSpec)

Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL

-

GitHubSourceSpec +

GitHubSourceSpec

(Appears on: -GitHubSource) +GitHubSource)

GitHubSourceSpec defines the desired state of GitHubSource

@@ -1396,7 +1230,7 @@ correspond to the “Webhook event name” values listed at accessToken
- + SecretValueFromSource @@ -1410,7 +1244,7 @@ access token

secretToken
- + SecretValueFromSource @@ -1459,11 +1293,11 @@ bool -

GitHubSourceStatus +

GitHubSourceStatus

(Appears on: -GitHubSource) +GitHubSource)

GitHubSourceStatus defines the observed state of GitHubSource

@@ -1518,11 +1352,11 @@ for the GitHubSource.

-

KafkaLimitsSpec +

KafkaLimitsSpec

(Appears on: -KafkaResourceSpec) +KafkaResourceSpec)

@@ -1556,11 +1390,11 @@ string -

KafkaRequestsSpec +

KafkaRequestsSpec

(Appears on: -KafkaResourceSpec) +KafkaResourceSpec)

@@ -1594,11 +1428,11 @@ string -

KafkaResourceSpec +

KafkaResourceSpec

(Appears on: -KafkaSourceSpec) +KafkaSourceSpec)

@@ -1614,7 +1448,7 @@ string requests
- + KafkaRequestsSpec @@ -1626,7 +1460,7 @@ KafkaRequestsSpec limits
- + KafkaLimitsSpec @@ -1636,11 +1470,150 @@ KafkaLimitsSpec -

KafkaSourceNetSpec +

KafkaSource +

+

+

KafkaSource is the Schema for the kafkasources API.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +KafkaSourceSpec + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+bootstrapServers
+ +string + +
+

Bootstrap servers are the Kafka servers the consumer will connect to.

+
+topics
+ +string + +
+

Topic topics to consume messages from

+
+consumerGroup
+ +string + +
+

ConsumerGroupID is the consumer group ID.

+
+net
+ + +KafkaSourceNetSpec + + +
+
+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.

+
+serviceAccountName
+ +string + +
+

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

+
+resources
+ + +KafkaResourceSpec + + +
+

Resource limits and Request specifications of the Receive Adapter Deployment

+
+
+status
+ + +KafkaSourceStatus + + +
+
+

KafkaSourceNetSpec

(Appears on: -KafkaSourceSpec) +KafkaSourceSpec)

@@ -1656,7 +1629,7 @@ KafkaLimitsSpec sasl
- + KafkaSourceSASLSpec @@ -1668,7 +1641,7 @@ KafkaSourceSASLSpec tls
- + KafkaSourceTLSSpec @@ -1678,11 +1651,11 @@ KafkaSourceTLSSpec -

KafkaSourceSASLSpec +

KafkaSourceSASLSpec

(Appears on: -KafkaSourceNetSpec) +KafkaSourceNetSpec)

@@ -1708,7 +1681,7 @@ bool user
- + SecretValueFromSource @@ -1722,7 +1695,7 @@ SecretValueFromSource password
- + SecretValueFromSource @@ -1734,11 +1707,11 @@ SecretValueFromSource -

KafkaSourceSpec +

KafkaSourceSpec

(Appears on: -KafkaSource) +KafkaSource)

KafkaSourceSpec defines the desired state of the KafkaSource.

@@ -1788,7 +1761,7 @@ string net
- + KafkaSourceNetSpec @@ -1824,7 +1797,7 @@ Adapter Deployment.

resources
- + KafkaResourceSpec @@ -1835,11 +1808,11 @@ KafkaResourceSpec -

KafkaSourceStatus +

KafkaSourceStatus

(Appears on: -KafkaSource) +KafkaSource)

KafkaSourceStatus defines the observed state of KafkaSource.

@@ -1882,11 +1855,11 @@ string -

KafkaSourceTLSSpec +

KafkaSourceTLSSpec

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

PrometheusSourceSpec +

PrometheusSourceSpec

(Appears on: -PrometheusSource) +PrometheusSource)

PrometheusSourceSpec defines the desired state of PrometheusSource

@@ -2070,11 +2043,11 @@ name to use as the sink.

-

PrometheusSourceStatus +

PrometheusSourceStatus

(Appears on: -PrometheusSource) +PrometheusSource)

PrometheusSourceStatus defines the observed state of PrometheusSource

@@ -2118,12 +2091,12 @@ for the PrometheusSource.

-

SecretValueFromSource +

SecretValueFromSource

(Appears on: -KafkaSourceSASLSpec, -KafkaSourceTLSSpec) +KafkaSourceSASLSpec, +KafkaSourceTLSSpec)

SecretValueFromSource represents the source of a secret value

@@ -2151,11 +2124,11 @@ Kubernetes core/v1.SecretKeySelector -

SecretValueFromSource +

SecretValueFromSource

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

diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index 44b4e3c2a66..e3163febf66 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -1,13 +1,13 @@

Packages:

-

sources.knative.dev/v1alpha1

+

configs.internal.knative.dev/v1alpha1

-

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

+

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types: -

ApiServerSource +

ConfigMapPropagation

-

ApiServerSource is the Schema for the apiserversources API

+

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

@@ -48,7 +64,7 @@ Resource Types: string @@ -57,7 +73,7 @@ sources.knative.dev/v1alpha1 kind
string - + @@ -77,64 +94,39 @@ Refer to the Kubernetes API documentation for the fields of the
-sources.knative.dev/v1alpha1 +configs.internal.knative.dev/v1alpha1
ApiServerSourceConfigMapPropagation
@@ -69,6 +85,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ApiServerSourceSpec + +ConfigMapPropagationSpec
+

Spec defines the desired state of the ConfigMapPropagation



- - - - - - - -
-resources
- - -[]ApiServerResource - - -
-

Resources is the list of resources to watch

-
-serviceAccountName
+originalNamespace
string
-(Optional) -

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

+

OriginalNamespace is the namespace where the original configMaps are in

-sink
+selector
-knative.dev/pkg/apis/duck/v1beta1.Destination + +Kubernetes meta/v1.LabelSelector +
(Optional) -

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

-
-mode
- -string - -
-

Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

+

Selector only selects original configMaps with corresponding labels

@@ -144,25 +136,26 @@ string
status
- -ApiServerSourceStatus + +ConfigMapPropagationStatus
+(Optional) +

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

-

SinkBinding +

ConfigMapPropagationSpec

-

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.

+(Appears on: +ConfigMapPropagation) +

+

@@ -174,99 +167,88 @@ cloud events.

- - - - - - - - +

+

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

+

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

Selector only selects original configMaps with corresponding labels

+
+

ConfigMapPropagationStatus +

-(Members of SourceSpec are embedded into this type.) +(Appears on: +ConfigMapPropagation)

-
+ + + + + + - -
FieldDescription
-BindingSpec
+Status
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +knative.dev/pkg/apis/duck/v1.Status

-(Members of BindingSpec are embedded into this type.) +(Members of Status are embedded into this type.)

-
+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

-status
+copyConfigmaps
- -SinkBindingStatus + +[]ConfigMapPropagationStatusCopyConfigMap +(Optional) +

CopyConfigMaps is the status for each copied configmap.

-

ApiServerResource +

ConfigMapPropagationStatusCopyConfigMap

(Appears on: -ApiServerSourceSpec) +ConfigMapPropagationStatus)

-

ApiServerResource defines the resource to watch

+

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

@@ -278,76 +260,93 @@ SinkBindingStatus + + + +
-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

-

ApiServerSourceSpec -

+
+

eventing.knative.dev/v1alpha1

-(Appears on: -ApiServerSource) +

Package v1alpha1 is the v1alpha1 version of the API.

+Resource Types: + +

Broker +

-

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.

@@ -359,65 +358,3941 @@ bool +apiVersion
+string - + +

Spec defines the desired state of the Broker.

+
+
+
-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. -Ref sends only the reference to the resource. -Resource send the full 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 for channel based broker implementation.

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

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

+
+delivery
+ + +DeliverySpec + + +
+(Optional) +

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

+
+ + + + +status
+ + +BrokerStatus + + + + +(Optional) +

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

+ + + + +

EventType +

+

+

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

Spec defines the desired state of the EventType.

+
+
+ + + + + + + + + + + + + + + + + + + + + +
+type
+ +string + +
+

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +string + +
+

Source is a URI, it represents the CloudEvents source.

+
+schema
+ +string + +
+(Optional) +

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

+
+broker
+ +string + +
+

Broker refers to the Broker that can provide the EventType.

+
+description
+ +string + +
+(Optional) +

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

+
+
+status
+ + +EventTypeStatus + + +
+(Optional) +

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

+
+

Trigger +

+

+

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

+

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

Spec defines the desired state of the Trigger.

+
+
+ + + + + + + + + + + + + +
+broker
+ +string + +
+

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

+
+filter
+ + +TriggerFilter + + +
+(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

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

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

+
+
+status
+ + +TriggerStatus + + +
+(Optional) +

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

+
+

BrokerSpec +

+

+(Appears on: +Broker) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+channelTemplateSpec
+ + +ChannelTemplateSpec + + +
+(Optional) +

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

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

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

+
+delivery
+ + +DeliverySpec + + +
+(Optional) +

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

+
+

BrokerStatus +

+

+(Appears on: +Broker) +

+

+

BrokerStatus represents the current state of a Broker.

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+address
+ +knative.dev/pkg/apis/duck/v1alpha1.Addressable + +
+

Broker is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster.

+

It generally has the form {broker}-router.{namespace}.svc.{cluster domain name}

+
+triggerChannel
+ + +Kubernetes core/v1.ObjectReference + + +
+

TriggerChannel is an objectref to the object for the TriggerChannel

+
+

EventTypeSpec +

+

+(Appears on: +EventType) +

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+type
+ +string + +
+

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +string + +
+

Source is a URI, it represents the CloudEvents source.

+
+schema
+ +string + +
+(Optional) +

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

+
+broker
+ +string + +
+

Broker refers to the Broker that can provide the EventType.

+
+description
+ +string + +
+(Optional) +

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

+
+

EventTypeStatus +

+

+(Appears on: +EventType) +

+

+

EventTypeStatus represents the current state of a EventType.

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+

TriggerFilter +

+

+(Appears on: +TriggerSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+sourceAndType
+ + +TriggerFilterSourceAndType + + +
+(Optional) +

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

+
+attributes
+ + +TriggerFilterAttributes + + +
+(Optional) +

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

+

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

+
+

TriggerFilterAttributes +(map[string]string alias)

+

+(Appears on: +TriggerFilter) +

+

+

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

+

+

TriggerFilterSourceAndType +

+

+(Appears on: +TriggerFilter) +

+

+

TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and +source attributes. Only exact matches will pass the filter. Either or both type and source can +use the value “ to indicate all strings match.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+type
+ +string + +
+
+source
+ +string + +
+
+

TriggerSpec +

+

+(Appears on: +Trigger) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+broker
+ +string + +
+

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

+
+filter
+ + +TriggerFilter + + +
+(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

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

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

+
+

TriggerStatus +

+

+(Appears on: +Trigger) +

+

+

TriggerStatus represents the current state of a Trigger.

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+subscriberURI
+ +knative.dev/pkg/apis.URL + +
+

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

+
+
+

eventing.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 version of the API.

+

+Resource Types: + +

Broker +

+

+

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

+

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

Spec defines the desired state of the Broker.

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

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

+
+delivery
+ + +DeliverySpec + + +
+(Optional) +

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

+
+
+status
+ + +BrokerStatus + + +
+(Optional) +

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

+
+

EventType +

+

+

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

Spec defines the desired state of the EventType.

+
+
+ + + + + + + + + + + + + + + + + + + + + +
+type
+ +string + +
+

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +knative.dev/pkg/apis.URL + +
+

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.

+
+
+status
+ + +EventTypeStatus + + +
+(Optional) +

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

+
+

Trigger +

+

+

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

+

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

Spec defines the desired state of the Trigger.

+
+
+ + + + + + + + + + + + + +
+broker
+ +string + +
+

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

+
+filter
+ + +TriggerFilter + + +
+(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

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

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

+
+
+status
+ + +TriggerStatus + + +
+(Optional) +

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

+
+

BrokerSpec +

+

+(Appears on: +Broker) +

+

+

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

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

+
+delivery
+ + +DeliverySpec + + +
+(Optional) +

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

+
+

BrokerStatus +

+

+(Appears on: +Broker) +

+

+

BrokerStatus represents the current state of a Broker.

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+address
+ +knative.dev/pkg/apis/duck/v1.Addressable + +
+

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

+
+

EventTypeSpec +

+

+(Appears on: +EventType) +

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+type
+ +string + +
+

Type represents the CloudEvents type. It is authoritative.

+
+source
+ +knative.dev/pkg/apis.URL + +
+

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.

+
+

EventTypeStatus +

+

+(Appears on: +EventType) +

+

+

EventTypeStatus represents the current state of a EventType.

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+

TriggerFilter +

+

+(Appears on: +TriggerSpec) +

+

+

+ + + + + + + + + + + + + +
FieldDescription
+attributes
+ + +TriggerFilterAttributes + + +
+(Optional) +

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

+

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

+
+

TriggerFilterAttributes +(map[string]string alias)

+

+(Appears on: +TriggerFilter) +

+

+

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

+

+

TriggerSpec +

+

+(Appears on: +Trigger) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+broker
+ +string + +
+

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

+
+filter
+ + +TriggerFilter + + +
+(Optional) +

Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events.

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

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

+
+

TriggerStatus +

+

+(Appears on: +Trigger) +

+

+

TriggerStatus represents the current state of a Trigger.

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+subscriberUri
+ +knative.dev/pkg/apis.URL + +
+

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

+
+
+

flows.knative.dev/v1alpha1

+

+

Package v1alpha1 is the v1alpha1 version of the API.

+

+Resource Types: + +

Parallel +

+

+

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

+

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

Spec defines the desired state of the Parallel.

+
+
+ + + + + + + + + + + + + +
+branches
+ + +[]ParallelBranch + + +
+

Branches is the list of Filter/Subscribers pairs.

+
+channelTemplate
+ + +ChannelTemplateSpec + + +
+(Optional) +

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

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

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

+
+
+status
+ + +ParallelStatus + + +
+(Optional) +

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

+
+

ParallelBranch +

+

+(Appears on: +ParallelSpec) +

+

+

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

Filter is the expression guarding the branch

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

Subscriber receiving the event when the filter passes

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

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

+
+

ParallelBranchStatus +

+

+(Appears on: +ParallelStatus) +

+

+

ParallelBranchStatus represents the current state of a Parallel branch

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+filterSubscriptionStatus
+ + +ParallelSubscriptionStatus + + +
+

FilterSubscriptionStatus corresponds to the filter subscription status.

+
+filterChannelStatus
+ + +ParallelChannelStatus + + +
+

FilterChannelStatus corresponds to the filter channel status.

+
+subscriberSubscriptionStatus
+ + +ParallelSubscriptionStatus + + +
+

SubscriptionStatus corresponds to the subscriber subscription status.

+
+

ParallelChannelStatus +

+

+(Appears on: +ParallelBranchStatus, +ParallelStatus) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+channel
+ + +Kubernetes core/v1.ObjectReference + + +
+

Channel is the reference to the underlying channel.

+
+ready
+ +knative.dev/pkg/apis.Condition + +
+

ReadyCondition indicates whether the Channel is ready or not.

+
+

ParallelSpec +

+

+(Appears on: +Parallel) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+branches
+ + +[]ParallelBranch + + +
+

Branches is the list of Filter/Subscribers pairs.

+
+channelTemplate
+ + +ChannelTemplateSpec + + +
+(Optional) +

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

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

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

+
+

ParallelStatus +

+

+(Appears on: +Parallel) +

+

+

ParallelStatus represents the current state of a Parallel.

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+ingressChannelStatus
+ + +ParallelChannelStatus + + +
+

IngressChannelStatus corresponds to the ingress channel status.

+
+branchStatuses
+ + +[]ParallelBranchStatus + + +
+

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

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

+(Members of AddressStatus are embedded into this type.) +

+

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

+
+

ParallelSubscriptionStatus +

+

+(Appears on: +ParallelBranchStatus) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+subscription
+ + +Kubernetes core/v1.ObjectReference + + +
+

Subscription is the reference to the underlying Subscription.

+
+ready
+ +knative.dev/pkg/apis.Condition + +
+

ReadyCondition indicates whether the Subscription is ready or not.

+
+

Sequence +

+

+

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

+

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

Spec defines the desired state of the Sequence.

+
+
+ + + + + + + + + + + + + +
+steps
+ + +[]SequenceStep + + +
+

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

+
+channelTemplate
+ + +ChannelTemplateSpec + + +
+(Optional) +

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

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

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

+
+
+status
+ + +SequenceStatus + + +
+(Optional) +

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

+
+

SequenceChannelStatus +

+

+(Appears on: +SequenceStatus) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+channel
+ + +Kubernetes core/v1.ObjectReference + + +
+

Channel is the reference to the underlying channel.

+
+ready
+ +knative.dev/pkg/apis.Condition + +
+

ReadyCondition indicates whether the Channel is ready or not.

+
+

SequenceSpec +

+

+(Appears on: +Sequence) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+steps
+ + +[]SequenceStep + + +
+

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

+
+channelTemplate
+ + +ChannelTemplateSpec + + +
+(Optional) +

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

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

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

+
+

SequenceStatus +

+

+(Appears on: +Sequence) +

+

+

SequenceStatus represents the current state of a Sequence.

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+subscriptionStatuses
+ + +[]SequenceSubscriptionStatus + + +
+

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

+
+channelStatuses
+ + +[]SequenceChannelStatus + + +
+

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

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

+(Members of AddressStatus are embedded into this type.) +

+

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

+
+

SequenceStep +

+

+(Appears on: +SequenceSpec) +

+

+

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

+(Members of Destination are embedded into this type.) +

+

Subscriber receiving the step event

+
+delivery
+ + +DeliverySpec + + +
+(Optional) +

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

+
+

SequenceSubscriptionStatus +

+

+(Appears on: +SequenceStatus) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+subscription
+ + +Kubernetes core/v1.ObjectReference + + +
+

Subscription is the reference to the underlying Subscription.

+
+ready
+ +knative.dev/pkg/apis.Condition + +
+

ReadyCondition indicates whether the Subscription is ready or not.

+
+
+

sources.eventing.knative.dev/v1alpha1

+

+

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

+

+Resource Types: + +

ApiServerSource +

+

+

ApiServerSource is the Schema for the apiserversources API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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 + + +
+
+
+ + + + + + + + + + + + + + + + + +
+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. +Ref sends only the reference to the resource. +Resource send the full resource.

+
+
+status
+ + +ApiServerSourceStatus + + +
+
+

ContainerSource +

+

+

ContainerSource is the Schema for the containersources API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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 + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +
+(Optional) +

Template describes the pods that will be created

+
+image
+ +string + +
+

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

+
+args
+ +[]string + +
+

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

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

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

+
+serviceAccountName
+ +string + +
+(Optional) +

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

+
+sink
+ +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.

+
+
+status
+ + +ContainerSourceStatus + + +
+
+

CronJobSource +

+

+

CronJobSource is the Schema for the cronjobsources API.

+

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

+
+
+status
+ + +CronJobSourceStatus + + +
+
+

SinkBinding +

+

+

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

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string
+ +sources.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 + + +
+
+
+ + + + + + + + + +
+SourceSpec
+ +knative.dev/pkg/apis/duck/v1.SourceSpec + +
+

+(Members of SourceSpec are embedded into this type.) +

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

+(Members of BindingSpec are embedded into this type.) +

+
+
+status
+ + +SinkBindingStatus + + +
+
+

ApiServerResource +

+

+(Appears on: +ApiServerSourceSpec) +

+

+

ApiServerResource defines the resource to watch

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+ +string + +
+

API version of the resource to watch.

+
+kind
+ +string + +
+

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

+
+labelSelector
+ + +Kubernetes meta/v1.LabelSelector + + +
+

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

+
+controllerSelector
+ + +Kubernetes meta/v1.OwnerReference + + +
+

ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. +Only apiVersion and kind are used. Both are optional.

+
+controller
+ +bool + +
+

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

+
+

ApiServerSourceSpec +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceSpec defines the desired state of ApiServerSource

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+resources
+ + +[]ApiServerResource + + +
+

Resources is the list of resources to watch

+
+serviceAccountName
+ +string + +
+(Optional) +

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

+
+sink
+ +knative.dev/pkg/apis/duck/v1beta1.Destination + +
+(Optional) +

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

+
+mode
+ +string + +
+

Mode is the mode the receive adapter controller runs under: Ref or Resource. +Ref sends only the reference to the resource. +Resource send the full resource.

+
+

ApiServerSourceStatus +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceStatus defines the observed state of ApiServerSource

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+sinkUri
+ +string + +
+(Optional) +

SinkURI is the current active sink URI that has been configured for the ApiServerSource.

+
+

ContainerSourceSpec +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceSpec defines the desired state of ContainerSource

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +
+(Optional) +

Template describes the pods that will be created

+
+image
+ +string + +
+

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

+
+args
+ +[]string + +
+

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

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

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

+
+serviceAccountName
+ +string + +
+(Optional) +

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

+
+sink
+ +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.

+
+

ContainerSourceStatus +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceStatus defines the observed state of ContainerSource

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+sinkUri
+ +string + +
+(Optional) +

SinkURI is the current active sink URI that has been configured for the ContainerSource.

+
+

CronJobLimitsSpec +

+

+(Appears on: +CronJobResourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+cpu
+ +string + +
+
+memory
+ +string + +
+
+

CronJobRequestsSpec +

+

+(Appears on: +CronJobResourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+cpu
+ +string + +
+
+memory
+ +string + +
+
+

CronJobResourceSpec +

+

+(Appears on: +CronJobSourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+requests
+ + +CronJobRequestsSpec + + +
+
+limits
+ + +CronJobLimitsSpec + + +
+
+

CronJobSourceSpec +

+

+(Appears on: +CronJobSource) +

+

+

CronJobSourceSpec defines the desired state of the CronJobSource.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+schedule
+ +string + +
+

Schedule is the cronjob schedule.

+
+data
+ +string + +
+

Data is the data posted to the target function.

+
+sink
+ +knative.dev/pkg/apis/duck/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

+
+

CronJobSourceStatus +

+

+(Appears on: +CronJobSource) +

+

+

CronJobSourceStatus defines the observed state of CronJobSource.

+

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

+(Members of Status are embedded into this type.) +

+

inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

+
+sinkUri
+ +string + +
+(Optional) +

SinkURI is the current active sink URI that has been configured for the CronJobSource.

+
+

Deprecated +

+

+(Appears on: +ApiServerSource, +ContainerSource, +CronJobSource, +SinkBinding) +

+

+

+

SinkBindingSpec +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

+(Members of SourceSpec are embedded into this type.) +

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

+(Members of BindingSpec are embedded into this type.) +

+
+

SinkBindingStatus +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

+(Members of SourceStatus are embedded into this type.) +

+
-

ApiServerSourceStatus +
+

sources.knative.dev/v1alpha2

+

+

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

+

+Resource Types: + +

ApiServerSource

-(Appears on: -ApiServerSource) +

ApiServerSource is the Schema for the apiserversources API

+

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

+(Members of SourceSpec are embedded into this type.) +

+

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

+
+resources
+ + +[]APIVersionKind + + +
+

Resource is the resource this source will track and send related +lifecycle events from the Kubernetes ApiServer.

+
+selector
+ + +Kubernetes meta/v1.LabelSelector + + +
+(Optional) +

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

+
+owner
+ + +APIVersionKind + + +
+(Optional) +

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

+
+mode
+ +string + +
+(Optional) +

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

+
+serviceAccountName
+ +string + +
+(Optional) +

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

+
+
+status
+ + +ApiServerSourceStatus + + +
+
+

PingSource +

+

+

PingSource is the Schema for the PingSources API.

+

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

+(Members of SourceSpec are embedded into this type.)

+

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

+
+schedule
+ +string + +
+(Optional) +

Schedule is the cronjob schedule. Defaults to * * * * *.

+
+jsonData
+ +string + +
+(Optional) +

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

+
+
+status
+ + +PingSourceStatus + + +
+
+

SinkBinding +

-

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.

@@ -429,51 +4304,48 @@ string + + + + - -
-Status
- -knative.dev/pkg/apis/duck/v1.Status - +apiVersion
+string
+ +sources.knative.dev/v1alpha2 +
-

-(Members of Status are embedded into this type.) -

-

inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

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

SinkBindingSpec -

-

-(Appears on: -SinkBinding) -

-

-

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

-

- - - - - - - + + + + - -
FieldDescription
+spec
+ + +SinkBindingSpec + + +
+
+
+ @@ -498,109 +4375,37 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec

(Members of BindingSpec are embedded into this type.)

+

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

-
SourceSpec
@@ -485,6 +4357,11 @@ knative.dev/pkg/apis/duck/v1.SourceSpec

(Members of SourceSpec are embedded into this type.)

+

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

-

SinkBindingStatus -

-

-(Appears on: -SinkBinding) -

-

-

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

-

- - - - - + - -
FieldDescription
-SourceStatus
+status
-knative.dev/pkg/apis/duck/v1.SourceStatus + +SinkBindingStatus +
-

-(Members of SourceStatus are embedded into this type.) -

-
-

duck.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: -
    -

    BackoffPolicyType -(string alias)

    -

    -(Appears on: -DeliverySpec) -

    -

    -

    BackoffPolicyType is the type for backoff policies

    -

    -

    ChannelDefaulter -

    -

    -

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

    -

    -

    ChannelTemplateSpec +

    APIVersionKind

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

    -

    +ApiServerSourceSpec, +ApiServerSourceSpec)

    - - - - - - - - - - - - - -
    FieldDescription
    -spec
    - -k8s.io/apimachinery/pkg/runtime.RawExtension - -
    -(Optional) -

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

    -
    -
    - -
    -
    -

    ChannelTemplateSpecInternal -

    -

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

    +

    APIVersionKind is an APIVersion and Kind tuple.

    @@ -612,44 +4417,39 @@ we can easily create new Channels off of it.

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

    ApiServerSourceSpec

    -

    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

    @@ -661,134 +4461,106 @@ Channelable ObjectReferences and access their subscription and address data. Th - - -
    -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 SourceSpec are embedded into this type.) +

    +

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

    -spec
    - - -ChannelableSpec - - -
    -

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

    -
    -
    - - - - -
    -SubscribableTypeSpec
    +resources
    - -SubscribableTypeSpec + +[]APIVersionKind
    -

    -(Members of SubscribableTypeSpec are embedded into this type.) -

    +

    Resource is the resource this source will track and send related +lifecycle events from the Kubernetes ApiServer.

    -delivery
    +selector
    - -DeliverySpec + +Kubernetes meta/v1.LabelSelector
    (Optional) -

    DeliverySpec contains options controlling the event delivery

    -
    +

    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.

    -

    ChannelableSpec -

    -

    -(Appears on: -Channelable) -

    -

    -

    ChannelableSpec contains Spec of the Channelable object

    -

    - - - - - - - -
    FieldDescription
    -SubscribableTypeSpec
    +mode
    - -SubscribableTypeSpec - +string
    -

    -(Members of SubscribableTypeSpec are embedded into this type.) -

    +(Optional) +

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

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

    -

    ChannelableStatus +

    ApiServerSourceStatus

    (Appears on: -Channelable) +ApiServerSource)

    -

    ChannelableStatus contains the Status of a Channelable object.

    +

    ApiServerSourceStatus defines the observed state of ApiServerSource

    @@ -800,77 +4572,97 @@ DeliverySpec + +
    -Status
    +SourceStatus
    -knative.dev/pkg/apis/duck/v1.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/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.

    +

    PingSourceSpec +

    +

    +(Appears on: +PingSource) +

    +

    +

    PingSourceSpec defines the desired state of the PingSource.

    +

    + + + + + + + +
    FieldDescription
    -AddressStatus
    +SourceSpec
    -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus +knative.dev/pkg/apis/duck/v1.SourceSpec

    -(Members of AddressStatus are embedded into this type.) +(Members of SourceSpec are embedded into this type.)

    -

    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 SubscribableTypeStatus are embedded into this type.) -

    -

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

    -

    DeliverySpec +

    PingSourceStatus

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

    @@ -882,65 +4674,87 @@ such as channelable and source.

    + +
    -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 SourceStatus are embedded into this type.) +

    +

    inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source.

    +

    SinkBindingSpec +

    +

    +(Appears on: +SinkBinding) +

    +

    +

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

    +

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

    -
    FieldDescription
    -backoffPolicy
    +SourceSpec
    - -BackoffPolicyType - +knative.dev/pkg/apis/duck/v1.SourceSpec
    -(Optional) -

    BackoffPolicy is the retry backoff policy (linear, exponential)

    +

    +(Members of SourceSpec are embedded into this type.) +

    +

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

    -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 BindingSpec are embedded into this type.) +

    +

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

    -

    DeliveryStatus +

    SinkBindingStatus

    -

    DeliveryStatus contains the Status of an object supporting delivery options.

    +(Appears on: +SinkBinding) +

    +

    +

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

    @@ -952,26 +4766,39 @@ For exponential policy , backoff delay is backoffDelay*2^

    -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 SourceStatus are embedded into this type.) +

    +

    inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source.

    -

    Resource +
    +

    duck.knative.dev/v1alpha1

    +

    +

    Package v1alpha1 is the v1alpha1 version of the API.

    +

    +Resource Types: +
      +

      Channelable

      -

      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.

      @@ -995,82 +4822,74 @@ Refer to the Kubernetes API documentation for the fields of the metadata field. - -
      -

      Subscribable -

      -

      -(Appears on: -ChannelSpec, -InMemoryChannelSpec, -SubscribableTypeSpec) -

      -

      -

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

      -

      +
      +spec
      + + +ChannelableSpec + + +
      +

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

      +
      +
      - - - + + - - -
      FieldDescription +SubscribableTypeSpec
      + + +SubscribableTypeSpec + + +
      +

      +(Members of SubscribableTypeSpec are embedded into this type.) +

      +
      -subscribers
      +delivery
      - -[]SubscriberSpec + +DeliverySpec
      -

      This is the list of subscriptions for this subscribable.

      +(Optional) +

      DeliverySpec contains options controlling the event delivery

      -

      SubscribableStatus -

      -

      -(Appears on: -SubscribableTypeStatus) -

      -

      -

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

      -

      - - - - - + - -
      FieldDescription
      -subscribers
      +status
      - -[]SubscriberStatus + +ChannelableStatus
      -

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

      -

      SubscribableType +

      ChannelableCombined

      -

      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.

      @@ -1084,41 +4903,74 @@ SubscribableType ObjectReferences and access the Subscription data. This is not + + + + + + + + +
      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
      + + +SubscribableTypeSpec
      -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

      +(Members of SubscribableTypeSpec are embedded into this type.) +

      +

      SubscribableTypeSpec is for the v1alpha1 spec compatibility.

      -spec
      +SubscribableSpec
      - -SubscribableTypeSpec + +SubscribableSpec
      -

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

      -
      -
      - +

      +(Members of SubscribableSpec are embedded into this type.) +

      +

      SubscribableSpec is for the v1beta1 spec compatibility.

      + +
      -subscribable
      +delivery
      - -Subscribable + +DeliverySpec
      +(Optional) +

      DeliverySpec contains options controlling the event delivery

      @@ -1128,27 +4980,24 @@ Subscribable
      status
      - -SubscribableTypeStatus + +ChannelableCombinedStatus
      -

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

      -

      SubscribableTypeSpec +

      ChannelableCombinedSpec

      (Appears on: -ChannelableSpec, -SubscribableType) +ChannelableCombined)

      -

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

      +

      ChannelableSpec contains Spec of the Channelable object

      @@ -1160,64 +5009,60 @@ configured as to be compatible with Subscribable contract.

      - - -
      -subscribable
      +SubscribableTypeSpec
      - -Subscribable + +SubscribableTypeSpec
      -
      -

      SubscribableTypeStatus -

      -(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 of SubscribableSpec are embedded into this type.)

      - - - - - +

      SubscribableSpec is for the v1beta1 spec compatibility.

      + - -
      FieldDescription
      -subscribableStatus
      +delivery
      - -SubscribableStatus + +DeliverySpec
      +(Optional) +

      DeliverySpec contains options controlling the event delivery

      -

      SubscriberSpec +

      ChannelableCombinedStatus

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

      @@ -1229,71 +5074,90 @@ At least one of SubscriberURI and ReplyURI must be present

      -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 Status are embedded into this type.) +

      +

      inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

      -generation
      +AddressStatus
      -int64 +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
      -(Optional) -

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

      +

      +(Members of AddressStatus are embedded into this type.) +

      +

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

      -subscriberURI
      +SubscribableTypeStatus
      -knative.dev/pkg/apis.URL + +SubscribableTypeStatus +
      -(Optional) +

      +(Members of SubscribableTypeStatus are embedded into this type.) +

      +

      SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

      -replyURI
      +SubscribableStatus
      -knative.dev/pkg/apis.URL + +SubscribableStatus +
      -(Optional) +

      +(Members of SubscribableStatus are embedded into this type.) +

      +

      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

      -

      SubscriberStatus +

      ChannelableSpec

      (Appears on: -SubscribableStatus) +Channelable)

      -

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

      +

      ChannelableSpec contains Spec of the Channelable object

      @@ -1305,77 +5169,43 @@ knative.dev/pkg/apis.URL - - - - - - - -
      -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 SubscribableTypeSpec are embedded into this type.) +

      -message
      +delivery
      -string + +DeliverySpec +
      (Optional) -

      A human readable message indicating details of Ready status.

      +

      DeliverySpec contains options controlling the event delivery

      -
      -

      eventing.knative.dev/v1alpha1

      +

      ChannelableStatus +

      -

      Package v1alpha1 is the v1alpha1 version of the API.

      +(Appears on: +Channelable)

      -Resource Types: - -

      Broker -

      -

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

      +

      ChannelableStatus contains the Status of a Channelable object.

      @@ -1387,104 +5217,71 @@ Addressable endpoint.

      - - - - - - - - -
      -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 Status are embedded into this type.) +

      +

      inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

      -spec
      - - -BrokerSpec - - -
      -

      Spec defines the desired state of the Broker.

      -
      -
      - - - - -
      -channelTemplateSpec
      - - -ChannelTemplateSpec - +AddressStatus
      + +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
      -(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).

      +

      +(Members of AddressStatus are embedded into this type.) +

      +

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

      -delivery
      +SubscribableTypeStatus
      - -DeliverySpec + +SubscribableTypeStatus
      -(Optional) -

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

      -
      +

      +(Members of SubscribableTypeStatus are embedded into this type.) +

      +

      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

      -

      EventType +

      Resource

      +

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

      @@ -1496,23 +5293,6 @@ date.

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

      Subscribable +

      +

      +(Appears on: +ChannelSpec, +InMemoryChannelSpec, +SubscribableTypeSpec) +

      +

      +

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

      +

      + + + + + + + + + + +
      FieldDescription
      -spec
      +subscribers
      - -EventTypeSpec + +[]SubscriberSpec
      -

      Spec defines the desired state of the EventType.

      -
      -
      +

      This is the list of subscriptions for this subscribable.

      +
      +

      SubscribableStatus +

      +

      +(Appears on: +SubscribableTypeStatus) +

      +

      +

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

      +

      + - - + + + + + +
      -type
      - -string - -
      -

      Type represents the CloudEvents type. It is authoritative.

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

      +

      +

      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.

      +

      + + + + + + + + - +

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

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

      @@ -1605,24 +5438,28 @@ string
      status
      - -EventTypeStatus + +SubscribableTypeStatus
      -(Optional) -

      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 +

      SubscribableTypeSpec

      -

      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.

      @@ -1634,166 +5471,154 @@ Broker’s event pool.

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

      SubscribableTypeStatus +

      +

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

      +

      +

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

      +

      + + + + + + + + + + +
      FieldDescription
      -spec
      +subscribableStatus
      - -TriggerSpec + +SubscribableStatus
      -

      Spec defines the desired state of the Trigger.

      -
      -
      +
      +

      SubscriberSpec +

      +

      +(Appears on: +Subscribable) +

      +

      +

      SubscriberSpec defines a single subscriber to a Subscribable. +Ref is a reference to the Subscription this SubscriberSpec was created for +SubscriberURI is the endpoint for the subscriber +ReplyURI is the endpoint for the reply +At least one of SubscriberURI and ReplyURI must be present

      +

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

      -
      +(Optional)
      -status
      +replyURI
      - -TriggerStatus - +knative.dev/pkg/apis.URL
      (Optional) -

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

      -

      BrokerSpec -

      -

      -(Appears on: -Broker) -

      -

      -

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

      -

      BrokerStatus +

      SubscriberStatus

      (Appears on: -Broker) +SubscribableStatus)

      -

      BrokerStatus represents the current state of a Broker.

      +

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

      @@ -1805,56 +5630,78 @@ create subscriptions.

      + + + +
      -Status
      +uid
      -knative.dev/pkg/apis/duck/v1.Status +k8s.io/apimachinery/pkg/types.UID
      -

      -(Members of Status are embedded into this type.) -

      -

      inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

      +(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.

      -

      EventTypeSpec -

      +
      +

      duck.knative.dev/v1beta1

      +

      +

      Package v1beta1 is the v1beta1 version of the API.

      +

      +Resource Types: + +

      BackoffPolicyType +(string alias)

      (Appears on: -EventType) +DeliverySpec) +

      +

      +

      BackoffPolicyType is the type for backoff policies

      +

      Channelable +

      +

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

      @@ -1866,106 +5713,88 @@ Kubernetes core/v1.ObjectReference - - - - - +

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

      +
      +
      +
      -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 SubscribableSpec are embedded into this type.) +

      -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

      -

      EventTypeStatus -

      -

      -(Appears on: -EventType) -

      -

      -

      EventTypeStatus represents the current state of a EventType.

      -

      - - - - - + - -
      FieldDescription
      -Status
      +status
      -knative.dev/pkg/apis/duck/v1.Status + +ChannelableStatus +
      -

      -(Members of Status are embedded into this type.) -

      -

      inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

      -

      TriggerFilter +

      ChannelableSpec

      (Appears on: -TriggerSpec) +ChannelSpec, +Channelable, +InMemoryChannelSpec)

      +

      ChannelableSpec contains Spec of the Channelable object

      @@ -1977,61 +5806,45 @@ knative.dev/pkg/apis/duck/v1.Status
      -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 SubscribableSpec are embedded into this type.) +

      -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

      -

      TriggerFilterAttributes -(map[string]string alias)

      -

      -(Appears on: -TriggerFilter) -

      -

      -

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

      -

      -

      TriggerFilterSourceAndType +

      ChannelableStatus

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

      @@ -2043,33 +5856,86 @@ use the value “ to indicate all strings match.

      + + + + + + + +
      -type
      +Status
      -string +knative.dev/pkg/apis/duck/v1.Status
      +

      +(Members of Status are embedded into this type.) +

      +

      inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

      -source
      +AddressStatus
      -string +knative.dev/pkg/apis/duck/v1.AddressStatus + +
      +

      +(Members of AddressStatus are embedded into this type.) +

      +

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

      +
      +SubscribableStatus
      + + +SubscribableStatus +
      +

      +(Members of SubscribableStatus are embedded into this type.) +

      +

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

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

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

      -

      TriggerSpec +

      DeliverySpec

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

      @@ -2081,53 +5947,65 @@ string + + + +
      -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^

      -

      TriggerStatus +

      DeliveryStatus

      -(Appears on: -Trigger) -

      -

      -

      TriggerStatus represents the current state of a Trigger.

      +

      DeliveryStatus contains the Status of an object supporting delivery options.

      @@ -2139,45 +6017,25 @@ is required.

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

      -(Members of Status are embedded into this type.) -

      -

      inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

      -
      -subscriberURI
      +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.

      -
      -

      flows.knative.dev/v1alpha1

      -

      -

      Package v1alpha1 is the v1alpha1 version of the API.

      -

      -Resource Types: - -

      Parallel +

      Subscribable

      -

      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.

      @@ -2197,7 +6055,6 @@ Kubernetes meta/v1.ObjectMeta @@ -2206,55 +6063,28 @@ Refer to the Kubernetes API documentation for the fields of the
      -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. 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.



      - - - - - - - -
      -branches
      - - -[]ParallelBranch - - -
      -

      Branches is the list of Filter/Subscribers pairs.

      -
      -channelTemplate
      +subscribers
      - -ChannelTemplateSpec + +[]SubscriberSpec
      -(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

      +

      This is the list of subscriptions for this subscribable.

      @@ -2264,26 +6094,28 @@ when the case does not have a Reply

      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.

      -

      ParallelBranch +

      SubscribableSpec

      (Appears on: -ParallelSpec) +ChannelableCombinedSpec, +ChannelableSpec, +Subscribable)

      +

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

      @@ -2295,49 +6127,63 @@ date.

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

      +

      SubscribableStatus +

      +

      +(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

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

      -

      ParallelBranchStatus +

      SubscriberSpec

      (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

      @@ -2349,53 +6195,76 @@ If not specified, sent the result to the Parallel Reply

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

      -

      ParallelChannelStatus +

      SubscriberStatus

      (Appears on: -ParallelBranchStatus, -ParallelStatus) +SubscribableStatus)

      +

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

      @@ -2407,97 +6276,67 @@ ParallelSubscriptionStatus - - - - - -
      -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.

      -

      ParallelSpec -

      -

      -(Appears on: -Parallel) -

      -

      -

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

      -

      ParallelStatus -

      +
      +

      flows.knative.dev/v1beta1

      -(Appears on: -Parallel) +

      Package v1beta1 is the v1beta1 version of the API.

      +Resource Types: + +

      Parallel +

      -

      ParallelStatus represents the current state of a Parallel.

      +

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

      @@ -2509,112 +6348,101 @@ when the case does not have a Reply

      - +

      Spec defines the desired state of the Parallel.

      +
      +
      +
      -Status
      +metadata
      -knative.dev/pkg/apis/duck/v1.Status + +Kubernetes meta/v1.ObjectMeta +
      -

      -(Members of Status are embedded into this type.) -

      -

      inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

      +(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 are embedded into this type.) -

      -

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

      +(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).

      -

      ParallelSubscriptionStatus -

      -

      -(Appears on: -ParallelBranchStatus) -

      -

      -

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

      ParallelBranch

      -

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

      +(Appears on: +ParallelSpec) +

      +

      @@ -2626,97 +6454,106 @@ series through Channels and Subscriptions.

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

      -
      -
      - +

      Subscriber receiving the event when the filter passes

      + + + +
      -steps
      +reply
      -[]knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.Destination
      -

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

      +(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

      +

      ParallelBranchStatus +

      +

      +(Appears on: +ParallelStatus) +

      +

      +

      ParallelBranchStatus represents the current state of a Parallel branch

      +

      + + + + + + + + - -
      FieldDescription
      -channelTemplate
      +filterSubscriptionStatus
      - -ChannelTemplateSpec + +ParallelSubscriptionStatus
      -(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).

      +

      FilterSubscriptionStatus corresponds to the filter subscription status.

      -reply
      +filterChannelStatus
      -knative.dev/pkg/apis/duck/v1.Destination + +ParallelChannelStatus +
      -(Optional) -

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

      -
      +

      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.

      -

      SequenceChannelStatus +

      ParallelChannelStatus

      (Appears on: -SequenceStatus) +ParallelBranchStatus, +ParallelStatus)

      @@ -2754,11 +6591,11 @@ knative.dev/pkg/apis.Condition -

      SequenceSpec +

      ParallelSpec

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

      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

      -

      SequenceStatus +

      ParallelStatus

      (Appears on: -Sequence) +Parallel)

      -

      SequenceStatus represents the current state of a Sequence.

      +

      ParallelStatus represents the current state of a Parallel.

      @@ -2846,30 +6685,29 @@ knative.dev/pkg/apis/duck/v1.Status @@ -2883,18 +6721,18 @@ knative.dev/pkg/apis/duck/v1.AddressStatus

      (Members of AddressStatus are embedded into this type.)

      -

      AddressStatus is the starting point to this Sequence. Sending to this +

      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}

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

      -

      SequenceSubscriptionStatus +

      ParallelSubscriptionStatus

      (Appears on: -SequenceStatus) +ParallelBranchStatus)

      @@ -2932,25 +6770,11 @@ knative.dev/pkg/apis.Condition -
      -

      sources.eventing.knative.dev/v1alpha1

      -

      -

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

      -

      -Resource Types: - -

      ApiServerSource +

      Sequence

      -

      ApiServerSource is the Schema for the apiserversources API

      +

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

      @@ -2962,36 +6786,6 @@ Resource Types: - - - - - - - - - - - - @@ -3008,87 +6803,126 @@ Refer to the Kubernetes API documentation for the fields of the +
      -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. spec
      - -ApiServerSourceSpec + +SequenceSpec
      +

      Spec defines the desired state of the Sequence.



      + +
      -resources
      +steps
      - -[]ApiServerResource + +[]SequenceStep
      -

      Resources is the list of resources to watch

      +

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

      -serviceAccountName
      +channelTemplate
      -string + +ChannelTemplateSpec +
      (Optional) -

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

      +

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

      -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 is a Reference to where the result of the last Subscriber gets sent to.

      +
      -mode
      +status
      -string + +SequenceStatus +
      -

      Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

      +(Optional) +

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

      - +

      SequenceChannelStatus +

      +

      +(Appears on: +SequenceStatus) +

      +

      +

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

      SequenceSpec

      -

      ContainerSource is the Schema for the containersources API

      +(Appears on: +Sequence) +

      +

      @@ -3100,165 +6934,232 @@ ApiServerSourceStatus - - - - + +
      -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.

      +

      SequenceStatus +

      +

      +(Appears on: +Sequence) +

      +

      +

      SequenceStatus represents the current state of a Sequence.

      +

      + + + + + + + +
      FieldDescription
      -spec
      +Status
      - -ContainerSourceSpec - +knative.dev/pkg/apis/duck/v1.Status
      -
      -
      - +

      +(Members of Status are embedded into this type.) +

      +

      inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

      + + + +
      -template
      +subscriptionStatuses
      - -Kubernetes core/v1.PodTemplateSpec + +[]SequenceSubscriptionStatus
      -(Optional) -

      Template describes the pods that will be created

      +

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

      -image
      +channelStatuses
      -string + +[]SequenceChannelStatus +
      -

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

      +

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

      -args
      +AddressStatus
      -[]string +knative.dev/pkg/apis/duck/v1.AddressStatus
      -

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

      +

      +(Members of AddressStatus are embedded into this type.) +

      +

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

      +

      SequenceStep +

      +

      +(Appears on: +SequenceSpec) +

      +

      +

      + + + + + + + + + +
      FieldDescription
      -env
      +Destination
      - -[]Kubernetes core/v1.EnvVar - +knative.dev/pkg/apis/duck/v1.Destination
      -(Optional) -

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

      +

      +(Members of Destination are embedded into this type.) +

      +

      Subscriber receiving the step event

      -serviceAccountName
      +delivery
      -string + +DeliverySpec +
      (Optional) -

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

      +

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

      +

      SequenceSubscriptionStatus +

      +

      +(Appears on: +SequenceStatus) +

      +

      +

      + + + + + + + + - -
      FieldDescription
      -sink
      +subscription
      -knative.dev/pkg/apis/duck/v1beta1.Destination + +Kubernetes core/v1.ObjectReference +
      -

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

      -
      +

      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.

      -

      CronJobSource +
      +

      messaging.knative.dev/v1alpha1

      +

      +

      Package v1alpha1 is the v1alpha1 version of the API.

      +

      +Resource Types: + +

      Channel

      -

      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.

      @@ -3274,7 +7175,7 @@ ContainerSourceStatus string @@ -3283,20 +7184,7 @@ sources.eventing.knative.dev/v1alpha1 kind
      string - - - - - + @@ -3316,71 +7205,54 @@ Refer to the Kubernetes API documentation for the fields of the
      -sources.eventing.knative.dev/v1alpha1 +messaging.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. spec
      - -CronJobSourceSpec + +ChannelSpec
      +

      Spec defines the desired state of the Channel.



      - - - - - - - -
      -schedule
      - -string - -
      -

      Schedule is the cronjob schedule.

      -
      -data
      - -string - -
      -

      Data is the data posted to the target function.

      -
      -sink
      +channelTemplate
      -knative.dev/pkg/apis/duck/v1beta1.Destination + +ChannelTemplateSpec +
      -

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

      +

      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.

      -serviceAccountName
      +subscribable
      -string + +Subscribable +
      -

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

      +

      Channel conforms to Duck type Subscribable.

      -resources
      +delivery
      - -CronJobResourceSpec + +DeliverySpec
      -

      Resource limits and Request specifications of the Receive Adapter Deployment

      +

      Delivery options.

      @@ -3390,25 +7262,23 @@ CronJobResourceSpec
      status
      - -CronJobSourceStatus + +ChannelStatus
      +(Optional) +

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

      -

      SinkBinding +

      InMemoryChannel

      -

      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

      @@ -3424,7 +7294,7 @@ cloud events.

      string @@ -3433,20 +7303,7 @@ sources.eventing.knative.dev/v1alpha1 kind
      string - - - - - + @@ -3466,39 +7324,40 @@ Refer to the Kubernetes API documentation for the fields of the
      -sources.eventing.knative.dev/v1alpha1 +messaging.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. spec
      - -SinkBindingSpec + +InMemoryChannelSpec
      +

      Spec defines the desired state of the Channel.



      -SourceSpec
      +subscribable
      -knative.dev/pkg/apis/duck/v1.SourceSpec + +Subscribable +
      -

      -(Members of SourceSpec are embedded into this type.) -

      +

      Channel conforms to Duck type Subscribable.

      -BindingSpec
      +delivery
      -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +DeliverySpec +
      -

      -(Members of BindingSpec are embedded into this type.) -

      +

      For round tripping (v1beta1 <-> v1alpha1>

      @@ -3508,24 +7367,24 @@ knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
      status
      - -SinkBindingStatus + +InMemoryChannelStatus
      +(Optional) +

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

      -

      ApiServerResource +

      Subscription

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

      @@ -3538,192 +7397,148 @@ SinkBindingStatus +string - + - +
      +
      +
      apiVersion
      - -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

      -

      ApiServerSourceSpec -

      -

      -(Appears on: -ApiServerSource) -

      -

      -

      ApiServerSourceSpec defines the desired state of ApiServerSource

      -

      - - - - - - - - -
      FieldDescription
      -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. -Ref sends only the reference to the resource. -Resource send the full resource.

      +(Optional) +

      Delivery configuration

      -

      ApiServerSourceStatus -

      -

      -(Appears on: -ApiServerSource) -

      -

      -

      ApiServerSourceStatus defines the observed state of ApiServerSource

      -

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

      -(Members of Status are embedded into this type.) -

      -

      inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

      -sinkUri
      +status
      -string + +SubscriptionStatus +
      -(Optional) -

      SinkURI is the current active sink URI that has been configured for the ApiServerSource.

      -

      ContainerSourceSpec +

      ChannelSpec

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

      @@ -3735,97 +7550,54 @@ string - - - - - - - - - - - -
      -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 Template instead. -When Template is set, this field is ignored.

      -
      -args
      - -[]string - -
      -

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

      +

      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 Template instead. -When Template is set, this field is ignored.

      -
      -serviceAccountName
      - -string - -
      -(Optional) -

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

      +

      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.

      -

      ContainerSourceStatus +

      ChannelStatus

      (Appears on: -ContainerSource) +Channel)

      -

      ContainerSourceStatus defines the observed state of ContainerSource

      +

      ChannelStatus represents the current state of a Channel.

      @@ -3853,25 +7625,62 @@ knative.dev/pkg/apis/duck/v1.Status + + + + + + + +
      -sinkUri
      +AddressStatus
      + +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus + +
      +

      +(Members of AddressStatus are embedded into this type.) +

      +

      Channel is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster.

      +

      It generally has the form {channel}.{namespace}.svc.{cluster domain name}

      +
      +SubscribableTypeStatus
      + + +SubscribableTypeStatus + + +
      +

      +(Members of SubscribableTypeStatus are embedded into this type.) +

      +

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

      +
      +channel
      -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.

      -

      CronJobLimitsSpec +

      InMemoryChannelSpec

      (Appears on: -CronJobResourceSpec) +InMemoryChannel)

      +

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

      @@ -3883,33 +7692,40 @@ string
      -cpu
      +subscribable
      -string + +Subscribable +
      +

      Channel conforms to Duck type Subscribable.

      -memory
      +delivery
      -string + +DeliverySpec +
      +

      For round tripping (v1beta1 <-> v1alpha1>

      -

      CronJobRequestsSpec +

      InMemoryChannelStatus

      (Appears on: -CronJobResourceSpec) +InMemoryChannel)

      +

      ChannelStatus represents the current state of a Channel.

      @@ -3921,76 +7737,74 @@ string - - -
      -cpu
      +Status
      -string +knative.dev/pkg/apis/duck/v1.Status
      +

      +(Members of Status are embedded into this type.) +

      +

      inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

      -memory
      +AddressStatus
      -string +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
      -
      -

      CronJobResourceSpec -

      -

      -(Appears on: -CronJobSourceSpec) -

      +(Members of AddressStatus are embedded into this type.)

      - - - - - - - - - - -
      FieldDescription
      -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 SubscribableTypeStatus are embedded into this type.) +

      +

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

      -

      CronJobSourceSpec +

      SubscriptionSpec

      (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

      @@ -4002,72 +7816,89 @@ CronJobLimitsSpec
      -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

      -

      CronJobSourceStatus +

      SubscriptionStatus

      (Appears on: -CronJobSource) +Subscription)

      -

      CronJobSourceStatus defines the observed state of CronJobSource.

      +

      SubscriptionStatus (computed) for a subscription

      @@ -4095,37 +7926,28 @@ knative.dev/pkg/apis/duck/v1.Status
      -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.

      -

      Deprecated -

      -

      -(Appears on: -ApiServerSource, -ContainerSource, -CronJobSource, -SinkBinding) -

      -

      -

      -

      SinkBindingSpec +

      SubscriptionStatusPhysicalSubscription

      (Appears on: -SinkBinding) +SubscriptionStatus)

      -

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

      +

      SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

      @@ -4137,78 +7959,53 @@ string - -
      -SourceSpec
      +subscriberURI
      -knative.dev/pkg/apis/duck/v1.SourceSpec +knative.dev/pkg/apis.URL
      -

      -(Members of SourceSpec are embedded into this type.) -

      +

      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 BindingSpec are embedded into this type.) -

      +

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

      -

      SinkBindingStatus -

      -

      -(Appears on: -SinkBinding) -

      -

      -

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

      -

      - - - - - - - -
      FieldDescription
      -SourceStatus
      +deadLetterSinkURI
      -knative.dev/pkg/apis/duck/v1.SourceStatus +knative.dev/pkg/apis.URL
      -

      -(Members of SourceStatus are embedded into this type.) -

      +

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


      -

      messaging.knative.dev/v1alpha1

      +

      messaging.knative.dev/v1beta1

      -

      Package v1alpha1 is the v1alpha1 version of the API.

      +

      Package v1beta1 is the v1beta1 version of the API.

      Resource Types: -

      Channel +

      Channel

      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 @@ -4257,7 +8054,7 @@ Refer to the Kubernetes API documentation for the fields of the 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

      @@ -4301,7 +8101,7 @@ Subscribable status
      - + ChannelStatus @@ -4314,7 +8114,7 @@ date.

      -

      InMemoryChannel +

      InMemoryChannel

      InMemoryChannel is a resource representing an in memory channel

      @@ -4333,7 +8133,7 @@ date.

      string -messaging.knative.dev/v1alpha1 +messaging.knative.dev/v1beta1 @@ -4363,7 +8163,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
      - + InMemoryChannelSpec @@ -4375,15 +8175,18 @@ InMemoryChannelSpec
      -subscribable
      - - -Subscribable +ChannelableSpec
      + +
      +ChannelableSpec
      -

      Channel conforms to Duck type Subscribable.

      +

      +(Members of ChannelableSpec are embedded into this type.) +

      +

      Channel conforms to Duck type Channelable.

      @@ -4393,7 +8196,7 @@ Subscribable status
      - + InMemoryChannelStatus @@ -4406,7 +8209,7 @@ date.

      -

      Subscription +

      Subscription

      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 @@ -4455,7 +8258,7 @@ Refer to the Kubernetes API documentation for the fields of the 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
      -

      ChannelSpec +

      ChannelDefaulter +

      +

      +

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

      +

      +

      ChannelSpec

      (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

      -

      ChannelStatus +

      ChannelStatus

      (Appears on: -Channel) +Channel)

      ChannelStatus represents the current state of a Channel.

      @@ -4622,78 +8427,300 @@ Subscribable -Status
      +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.

      + + + + +

      ChannelTemplateSpec +

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

      +

      +

      + + + + + + + + + + + + + +
      FieldDescription
      +spec
      + +k8s.io/apimachinery/pkg/runtime.RawExtension + +
      +(Optional) +

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

      +
      +
      + +
      +
      +

      ChannelTemplateSpecInternal +

      +

      +

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

      +

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

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

      +
      +
      + +
      +
      +

      InMemoryChannelSpec +

      +

      +(Appears on: +InMemoryChannel) +

      +

      +

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

      +

      + + + + + + + + + + + + + +
      FieldDescription
      +ChannelableSpec
      + + +ChannelableSpec + + +
      +

      +(Members of ChannelableSpec are embedded into this type.) +

      +

      Channel conforms to Duck type Channelable.

      +
      +

      InMemoryChannelStatus +

      +

      +(Appears on: +InMemoryChannel) +

      +

      +

      ChannelStatus represents the current state of a Channel.

      +

      + + + + + + + + + + + + + +
      FieldDescription
      +ChannelableStatus
      + + +ChannelableStatus + + +
      +

      +(Members of ChannelableStatus are embedded into this type.) +

      +

      Channel conforms to Duck type Channelable.

      +
      +

      SubscriptionSpec +

      +

      +(Appears on: +Subscription) +

      +

      +

      SubscriptionSpec specifies the Channel for incoming events, a Subscriber target +for processing those events and where to put the result of the processing. Only +From (where the events are coming from) is always required. You can optionally +only Process the events (results in no output events) by leaving out the Result. +You can also perform an identity transformation on the incoming events by leaving +out the Subscriber and only specifying Result.

      +

      The following are all valid specifications: +channel –[subscriber]–> reply +Sink, no outgoing events: +channel – subscriber +no-op function (identity transformation): +channel –> reply

      +

      + + + + + + + + + + + + + + +
      FieldDescription
      +channel
      + + +Kubernetes core/v1.ObjectReference + + +
      +

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

      +

      This field is immutable. We have no good answer on what happens to +the events that are currently in the channel being consumed from +and what the semantics there should be. For now, you can always +delete the Subscription and recreate it to point to a different +channel, giving the user more control over what semantics should +be used (drain the channel first, possibly have events dropped, +etc.)

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

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

      -SubscribableTypeStatus
      +reply
      - -SubscribableTypeStatus - +knative.dev/pkg/apis/duck/v1.Destination
      -

      -(Members of SubscribableTypeStatus are embedded into this type.) -

      -

      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

      -

      InMemoryChannelSpec +

      SubscriptionStatus

      (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

      @@ -4705,27 +8732,44 @@ arguments for a Channel.

      + + + +
      -subscribable
      +Status
      - -Subscribable +knative.dev/pkg/apis/duck/v1.Status + +
      +

      +(Members of Status are embedded into this type.) +

      +

      inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

      +
      +physicalSubscription
      + + +SubscriptionStatusPhysicalSubscription
      -

      Channel conforms to Duck type Subscribable.

      +

      PhysicalSubscription is the fully resolved values that this Subscription represents.

      -

      InMemoryChannelStatus +

      SubscriptionStatusPhysicalSubscription

      (Appears on: -InMemoryChannel) +SubscriptionStatus)

      -

      ChannelStatus represents the current state of a Channel.

      +

      SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

      @@ -4737,60 +8781,56 @@ Subscribable
      -Status
      +subscriberUri
      -knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis.URL
      -

      -(Members of Status are embedded into this type.) -

      -

      inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

      +

      SubscriberURI is the fully resolved URI for spec.subscriber.

      -AddressStatus
      +replyUri
      -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus +knative.dev/pkg/apis.URL
      -

      -(Members of AddressStatus are embedded into this type.) -

      -

      InMemoryChannel is Addressable. It currently exposes the endpoint as a -fully-qualified DNS name which will distribute traffic over the -provided targets from inside the cluster.

      -

      It generally has the form {channel}.{namespace}.svc.{cluster domain name}

      +

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

      -SubscribableTypeStatus
      +deadLetterSinkUri
      - -SubscribableTypeStatus - +knative.dev/pkg/apis.URL
      -

      -(Members of SubscribableTypeStatus are embedded into this type.) -

      -

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

      +

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

      -

      Parallel +
      +

      sources.knative.dev/v1alpha1

      +

      +

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

      +

      +Resource Types: + +

      ApiServerSource

      -

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

      +

      ApiServerSource is the Schema for the apiserversources API

      @@ -4802,6 +8842,23 @@ series through Channels and Subscriptions.

      + + + + + + + + @@ -4819,55 +8875,109 @@ Refer to the Kubernetes API documentation for the fields of the
      +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. spec
      - -ParallelSpec + +ApiServerSourceSpec
      -

      Spec defines the desired state of the Parallel.



      + + + + + + + + + + + + + + + +
      -branches
      +resources
      - -[]ParallelBranch + +[]ApiServerResource
      -

      Branches is the list of Filter/Subscribers pairs.

      +

      Resources is the list of resources to watch

      -channelTemplate
      +serviceAccountName
      - -ChannelTemplateSpec +string + +
      +(Optional) +

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

      +
      +sink
      + +knative.dev/pkg/apis/duck/v1beta1.Destination + +
      +(Optional) +

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

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

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

      +
      +selector
      + + +Kubernetes meta/v1.LabelSelector
      (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).

      +

      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

      -reply
      +owner
      -knative.dev/pkg/apis/duck/v1.Destination + +APIVersionKind +
      (Optional) -

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

      +

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

      +
      +mode
      + +string + +
      +

      Mode is the mode the receive adapter controller runs under: Ref or Resource. +Ref sends only the reference to the resource. +Resource send the full resource.

      @@ -4877,26 +8987,20 @@ when the case does not have a Reply

      status
      - -ParallelStatus + +ApiServerSourceStatus
      -(Optional) -

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

      -

      ParallelBranch +

      PingSource

      -(Appears on: -ParallelSpec) -

      -

      +

      PingSource is the Schema for the PingSources API.

      @@ -4904,111 +9008,151 @@ date.

      - - + + + + + + + + + + + + + + + + +
      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 + + +
      +
      +
      + + + + + - -
      +schedule
      + +string + +
      +

      Schedule is the cronjob schedule.

      +
      -filter
      +data
      -knative.dev/pkg/apis/duck/v1.Destination +string
      -

      Filter is the expression guarding the branch

      +

      Data is the data posted to the target function.

      -subscriber
      +sink
      knative.dev/pkg/apis/duck/v1.Destination
      -

      Subscriber receiving the event when the filter passes

      +

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

      +

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

      -

      ParallelBranchStatus -

      -

      -(Appears on: -ParallelStatus) -

      -

      -

      ParallelBranchStatus represents the current state of a Parallel branch

      -

      - - - - - - - - + +
      FieldDescription
      -filterSubscriptionStatus
      +serviceAccountName
      - -ParallelSubscriptionStatus - +string
      -

      FilterSubscriptionStatus corresponds to the filter subscription status.

      +

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

      -filterChannelStatus
      +resources
      - -ParallelChannelStatus + +PingResourceSpec
      -

      FilterChannelStatus corresponds to the filter channel status.

      +

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

      +
      -subscriberSubscriptionStatus
      +status
      - -ParallelSubscriptionStatus + +PingSourceStatus
      -

      SubscriptionStatus corresponds to the subscriber subscription status.

      -

      ParallelChannelStatus +

      SinkBinding

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

      @@ -5020,97 +9164,99 @@ ParallelSubscriptionStatus + + + + + + + + - - -
      -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.

      -
      -

      ParallelSpec -

      -

      -(Appears on: -Parallel) -

      -

      -

      +
      +
      - - - - - - - + +
      FieldDescription
      -branches
      +SourceSpec
      - -[]ParallelBranch - +knative.dev/pkg/apis/duck/v1.SourceSpec
      -

      Branches is the list of Filter/Subscribers pairs.

      +

      +(Members of SourceSpec are embedded into this type.) +

      -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 BindingSpec are embedded into this type.) +

      +
      -reply
      +status
      -knative.dev/pkg/apis/duck/v1.Destination + +SinkBindingStatus + -(Optional) -

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

      -

      ParallelStatus +

      ApiServerResource

      (Appears on: -Parallel) +ApiServerSourceSpec)

      -

      ParallelStatus represents the current state of a Parallel.

      +

      ApiServerResource defines the resource to watch

      @@ -5122,72 +9268,82 @@ when the case does not have a Reply

      + + + +
      -Status
      +apiVersion
      -knative.dev/pkg/apis/duck/v1.Status +string
      -

      -(Members of Status are embedded into this type.) -

      -

      inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

      +

      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 are embedded into this type.) -

      -

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

      +

      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.

      -

      ParallelSubscriptionStatus +

      ApiServerSourceSpec

      (Appears on: -ParallelBranchStatus) +ApiServerSource)

      +

      ApiServerSourceSpec defines the desired state of ApiServerSource

      @@ -5199,139 +9355,110 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

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

      -

      -

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

      -

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

      -
      -
      - - - - -
      -steps
      +ceOverrides
      -[]knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.CloudEventOverrides
      -

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

      +(Optional) +

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

      -channelTemplate
      +selector
      - -ChannelTemplateSpec + +Kubernetes meta/v1.LabelSelector
      (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).

      +

      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

      -reply
      +owner
      -knative.dev/pkg/apis/duck/v1.Destination + +APIVersionKind +
      (Optional) -

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

      -
      +

      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. +Ref sends only the reference to the resource. +Resource send the full resource.

      -

      SequenceChannelStatus +

      ApiServerSourceStatus

      (Appears on: -SequenceStatus) +ApiServerSource)

      +

      ApiServerSourceStatus defines the observed state of ApiServerSource

      @@ -5343,35 +9470,31 @@ date.

      - - - -
      -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 SourceStatus are embedded into this type.) +

      +

      inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source.

      -

      SequenceSpec +

      PingLimitsSpec

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

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

      -

      SequenceStatus +

      PingRequestsSpec

      (Appears on: -Sequence) +PingResourceSpec)

      -

      SequenceStatus represents the current state of a Sequence.

      @@ -5443,71 +9546,31 @@ knative.dev/pkg/apis/duck/v1.Destination - - - - - - - -
      -Status
      - -knative.dev/pkg/apis/duck/v1.Status - -
      -

      -(Members of Status are embedded into this type.) -

      -

      inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state.

      -
      -subscriptionStatuses
      - - -[]SequenceSubscriptionStatus - - -
      -

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

      -
      -channelStatuses
      +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 are embedded into this type.) -

      -

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

      -

      SequenceSubscriptionStatus +

      PingResourceSpec

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

      -

      SubscriptionSpec +

      PingSourceSpec

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

      @@ -5575,89 +9627,87 @@ channel –> reply

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

      -

      SubscriptionStatus +

      PingSourceStatus

      (Appears on: -Subscription) +PingSource)

      -

      SubscriptionStatus (computed) for a subscription

      +

      PingSourceStatus defines the observed state of PingSource.

      @@ -5685,28 +9735,26 @@ knative.dev/pkg/apis/duck/v1.Status
      -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.

      -

      SubscriptionStatusPhysicalSubscription +

      SinkBindingSpec

      (Appears on: -SubscriptionStatus) +SinkBinding)

      -

      SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

      +

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

      @@ -5718,35 +9766,60 @@ Subscription.

      + +
      -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 SourceSpec are embedded into this type.) +

      -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 BindingSpec are embedded into this type.) +

      +

      SinkBindingStatus +

      +

      +(Appears on: +SinkBinding) +

      +

      +

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

      +

      + + + + + + + + @@ -5754,5 +9827,5 @@ knative.dev/pkg/apis.URL

      Generated with gen-crd-api-reference-docs -on git commit 8a92a8c9. +on git commit 200ea1ae.

      FieldDescription
      -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 SourceStatus are embedded into this type.) +