From 0816a3ca901a7359c762686ea780a52fc5c8671d Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 13 Jan 2021 12:01:20 -0800 Subject: [PATCH] Knative API docs for v0.20.0 (#3141) * update API docs for v0.20.0 * remove whitespace -> happy linter --- docs/reference/api/eventing/eventing.md | 8042 ++++++++++++----------- docs/reference/api/serving.md | 47 +- hack/gen-api-reference-docs.sh | 2 +- 3 files changed, 4262 insertions(+), 3829 deletions(-) diff --git a/docs/reference/api/eventing/eventing.md b/docs/reference/api/eventing/eventing.md index 996ab92f401..6215c10c0fa 100644 --- a/docs/reference/api/eventing/eventing.md +++ b/docs/reference/api/eventing/eventing.md @@ -1,6 +1,9 @@

Packages:

-

duck.knative.dev/v1

+

configs.internal.knative.dev/v1alpha1

-

Package v1 is the v1 version of the API.

+

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types: - -

BackoffPolicyType -(string alias)

-

-(Appears on: -DeliverySpec) -

-

-

BackoffPolicyType is the type for backoff policies

-

-

Channelable + +

ConfigMapPropagation

-

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.

+

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

@@ -75,6 +69,23 @@ Channelable ObjectReferences and access their subscription and address data. Th + + + + + + + + @@ -91,43 +103,39 @@ Refer to the Kubernetes API documentation for the fields of the
+apiVersion
+string
+ +configs.internal.knative.dev/v1alpha1 + +
+kind
+string +
ConfigMapPropagation
metadata
@@ -83,6 +94,7 @@ Kubernetes meta/v1.ObjectMeta
+(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ChannelableSpec + +ConfigMapPropagationSpec
-

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

+

Spec defines the desired state of the ConfigMapPropagation



-SubscribableSpec
+originalNamespace
- -SubscribableSpec - +string
-

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

+

OriginalNamespace is the namespace where the original configMaps are in

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

DeliverySpec contains options controlling the event delivery

+

Selector only selects original configMaps with corresponding labels

@@ -137,26 +145,26 @@ DeliverySpec
status
- -ChannelableStatus + +ConfigMapPropagationStatus
+(Optional) +

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

-

ChannelableSpec +

ConfigMapPropagationSpec

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

-

ChannelableSpec contains Spec of the Channelable object

@@ -168,45 +176,39 @@ ChannelableStatus
-SubscribableSpec
+originalNamespace
- -SubscribableSpec - +string
-

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

+

OriginalNamespace is the namespace where the original configMaps are in

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

DeliverySpec contains options controlling the event delivery

+

Selector only selects original configMaps with corresponding labels

-

ChannelableStatus +

ConfigMapPropagationStatus

(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) +ConfigMapPropagation)

-

ChannelableStatus contains the Status of a Channelable object.

+

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

@@ -234,63 +236,28 @@ knative.dev/pkg/apis/duck/v1.Status - - - - - - - -
-AddressStatus
- -knative.dev/pkg/apis/duck/v1.AddressStatus - -
-

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

-

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

-
-SubscribableStatus
+copyConfigmaps
- -SubscribableStatus + +[]ConfigMapPropagationStatusCopyConfigMap
-

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

+

CopyConfigMaps is the status for each copied configmap.

-

DeliverySpec +

ConfigMapPropagationStatusCopyConfigMap

(Appears on: -BrokerSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriptionSpec) +ConfigMapPropagationStatus)

-

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

+

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

@@ -302,103 +269,115 @@ such as channelable and source.

- -
-deadLetterSink
+name
-knative.dev/pkg/apis/duck/v1.Destination +string
-(Optional) -

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

+

Name is copy configmap’s name

-retry
+source
-int32 +string
-(Optional) -

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

+

Source is “originalNamespace/originalConfigMapName”

-backoffPolicy
+operation
- -BackoffPolicyType - +string
-(Optional) -

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

+

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

-backoffDelay
+ready
string
-(Optional) -

BackoffDelay is the delay before retrying. -More information on Duration format: -- https://www.iso.org/iso-8601-date-and-time-format.html -- https://en.wikipedia.org/wiki/ISO_8601

-

For linear policy, backoff delay is backoffDelay*. -For exponential policy, backoff delay is backoffDelay*2^.

+

Ready represents the operation is ready or not

-

DeliveryStatus -

-

-

DeliveryStatus contains the Status of an object supporting delivery options.

-

- - - - + + - -
FieldDescription +reason
+ +string + +
+

Reason indicates reasons if the operation is not ready

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

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

+

ResourceVersion is the resourceVersion of original configmap

-

Subscribable -

+
+

duck.knative.dev/v1

-

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.

+

Package v1 is the v1 version of the API.

- - - - - +Resource Types: + +

BackoffPolicyType +(string alias)

+

+(Appears on: +DeliverySpec) +

+

+

BackoffPolicyType is the type for backoff policies

+

+
FieldDescription
+ + + + + + + + + + + +
ValueDescription

"exponential"

Exponential backoff policy

+

"linear"

Linear backoff policy

+
+

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.

+

+ + + + + @@ -420,28 +399,45 @@ Refer to the Kubernetes API documentation for the fields of the
FieldDescription
spec
- -SubscribableSpec + +ChannelableSpec
-

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

+

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



+ + + +
-subscribers
+SubscribableSpec
- -[]SubscriberSpec + +SubscribableSpec
-

This is the list of subscriptions for this subscribable.

+

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

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

DeliverySpec contains the default delivery spec for each subscription +to this Channelable. Each subscription delivery spec, if any, overrides this +global delivery spec.

@@ -451,27 +447,27 @@ configured as to be compatible with Subscribable contract.

status
- -SubscribableStatus + +ChannelableStatus
-

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

-

SubscribableSpec +

ChannelableSpec

(Appears on: -ChannelableSpec, -Subscribable) +Channelable, +ChannelSpec, +ChannelTemplateSpecInternalSpec, +InMemoryChannelSpec)

-

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

+

ChannelableSpec contains Spec of the Channelable object

@@ -483,62 +479,47 @@ configured as to be compatible with Subscribable contract.

- - -
-subscribers
+SubscribableSpec
- -[]SubscriberSpec + +SubscribableSpec
-

This is the list of subscriptions for this subscribable.

-
-

SubscribableStatus -

-

-(Appears on: -ChannelableStatus, -Subscribable) -

-

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

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

- - - - - + - -
FieldDescription
-subscribers
+delivery
- -[]SubscriberStatus + +DeliverySpec
-

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

+(Optional) +

DeliverySpec contains the default delivery spec for each subscription +to this Channelable. Each subscription delivery spec, if any, overrides this +global delivery spec.

-

SubscriberSpec +

ChannelableStatus

(Appears on: -SubscribableSpec) +Channelable, +ChannelStatus, +InMemoryChannelStatus)

-

SubscriberSpec defines a single subscriber to a Subscribable.

-

At least one of SubscriberURI and ReplyURI must be present

+

ChannelableStatus contains the Status of a Channelable object.

@@ -550,76 +531,79 @@ section of the resource.

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

UID is used to understand the origin of the subscriber.

-
-generation
+Status
-int64 +knative.dev/pkg/apis/duck/v1.Status
-(Optional) -

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

+

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

SubscriberURI is the endpoint for the subscriber

+

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

+

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

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

ReplyURI is the endpoint for the reply

+

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

+

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

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

DeliverySpec contains options controlling the event delivery

+

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

-

SubscriberStatus +

DeliverySpec

(Appears on: -SubscribableStatus) +ChannelableSpec, +SubscriberSpec, +BrokerSpec, +ParallelBranch, +SequenceStep, +SubscriptionSpec)

-

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

+

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

@@ -631,68 +615,67 @@ DeliverySpec
-uid
+deadLetterSink
-k8s.io/apimachinery/pkg/types.UID +knative.dev/pkg/apis/duck/v1.Destination
(Optional) -

UID is used to understand the origin of the subscriber.

+

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

-observedGeneration
+retry
-int64 +int32
(Optional) -

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

+

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

-ready
+backoffPolicy
- -Kubernetes core/v1.ConditionStatus + +BackoffPolicyType
-

Status of the subscriber.

+(Optional) +

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

-message
+backoffDelay
string
(Optional) -

A human readable message indicating details of Ready status.

+

BackoffDelay is the delay before retrying. +More information on Duration format: +- https://www.iso.org/iso-8601-date-and-time-format.html +- https://en.wikipedia.org/wiki/ISO_8601

+

For linear policy, backoff delay is backoffDelay*. +For exponential policy, backoff delay is backoffDelay*2^.

-
-

duck.knative.dev/v1alpha1

-

-

Package v1alpha1 is the v1alpha1 version of the API.

-

-Resource Types: - -

Channelable +

DeliveryStatus

-

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.

+

DeliveryStatus contains the Status of an object supporting delivery options.

@@ -704,86 +687,25 @@ Channelable ObjectReferences and access their subscription and address data. Th - - - - - - - -
-metadata
+deadLetterChannel
- -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ChannelableSpec - - -
-

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

-
-
- - - - - - - - - -
-SubscribableTypeSpec
- - -SubscribableTypeSpec - - -
-

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

-
-delivery
- - -DeliverySpec - - -
-(Optional) -

DeliverySpec contains options controlling the event delivery

-
-
-status
- - -ChannelableStatus - +knative.dev/pkg/apis/duck/v1.KReference
+(Optional) +

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

-

ChannelableCombined +

Subscribable

-

ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of -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.

+

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.

@@ -811,60 +733,28 @@ Refer to the Kubernetes API documentation for the fields of the
spec
- -ChannelableCombinedSpec + +SubscribableSpec
-

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

+

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



- - - - - - - -
-SubscribableTypeSpec
- - -SubscribableTypeSpec - - -
-

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

-

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

-
-SubscribableSpec
- - -SubscribableSpec - - -
-

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

-

SubscribableSpec is for the v1beta1 spec compatibility.

-
-delivery
+subscribers
- -DeliverySpec + +[]SubscriberSpec
-(Optional) -

DeliverySpec contains options controlling the event delivery

+

This is the list of subscriptions for this subscribable.

@@ -874,24 +764,27 @@ DeliverySpec
status
- -ChannelableCombinedStatus + +SubscribableStatus
+

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

-

ChannelableCombinedSpec +

SubscribableSpec

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

-

ChannelableSpec contains Spec of the Channelable object

+

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

@@ -903,60 +796,62 @@ ChannelableCombinedStatus - - - +
-SubscribableTypeSpec
+subscribers
- -SubscribableTypeSpec + +[]SubscriberSpec
-

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

-

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

+

This is the list of subscriptions for this subscribable.

-SubscribableSpec
- - -SubscribableSpec - - -
+
+

SubscribableStatus +

-(Members of SubscribableSpec are embedded into this type.) +(Appears on: +ChannelableStatus, +Subscribable)

-

SubscribableSpec is for the v1beta1 spec compatibility.

- +

+

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

+

+ + + + + + +
FieldDescription
-delivery
+subscribers
- -DeliverySpec + +[]SubscriberStatus
-(Optional) -

DeliverySpec contains options controlling the event delivery

+

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

-

ChannelableCombinedStatus +

SubscriberSpec

(Appears on: -ChannelableCombined) +SubscribableSpec)

-

ChannelableStatus contains the Status of a Channelable object.

+

SubscriberSpec defines a single subscriber to a Subscribable.

+

At least one of SubscriberURI and ReplyURI must be present

@@ -968,90 +863,76 @@ DeliverySpec
-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.

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

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

-

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

+(Optional) +

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

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

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

-

SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

+(Optional) +

SubscriberURI is the endpoint for the subscriber

-SubscribableStatus
+replyUri
- -SubscribableStatus - +knative.dev/pkg/apis.URL
-

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

-

SubscribableStatus is the v1beta1 part of the Subscribers status.

+(Optional) +

ReplyURI is the endpoint for the reply

-errorChannel
+delivery
- -Kubernetes core/v1.ObjectReference + +DeliverySpec
(Optional) -

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

+

DeliverySpec contains options controlling the event delivery

-

ChannelableSpec +

SubscriberStatus

(Appears on: -Channelable) +SubscribableStatus)

-

ChannelableSpec contains Spec of the Channelable object

+

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

@@ -1063,119 +944,68 @@ Kubernetes core/v1.ObjectReference - - -
-SubscribableTypeSpec
+uid
- -SubscribableTypeSpec - +k8s.io/apimachinery/pkg/types.UID
-

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

+(Optional) +

UID is used to understand the origin of the subscriber.

-delivery
+observedGeneration
- -DeliverySpec - +int64
(Optional) -

DeliverySpec contains options controlling the event delivery

-
-

ChannelableStatus -

-

-(Appears on: -Channelable) -

-

-

ChannelableStatus contains the Status of a Channelable object.

-

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

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

-

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

-
-AddressStatus
- -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus - -
-

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

-

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

+

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

-SubscribableTypeStatus
+ready
- -SubscribableTypeStatus + +Kubernetes core/v1.ConditionStatus
-

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

-

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

+

Status of the subscriber.

-errorChannel
+message
- -Kubernetes core/v1.ObjectReference - +string
(Optional) -

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

+

A human readable message indicating details of Ready status.

-

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.

@@ -1199,80 +1029,74 @@ Refer to the Kubernetes API documentation for the fields of the metadata field. - -
-

Subscribable -

-

-(Appears on: -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 +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.

@@ -1300,73 +1124,71 @@ Refer to the Kubernetes API documentation for the fields of the + + -
spec
- -SubscribableTypeSpec + +ChannelableCombinedSpec
-

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

+

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



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

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

+

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

+
+SubscribableSpec
+ + +SubscribableSpec + + +
+

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

+

SubscribableSpec is for the v1beta1 spec compatibility.

-status
+delivery
- -SubscribableTypeStatus + +DeliverySpec
-

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

+(Optional) +

DeliverySpec contains options controlling the event delivery

-

SubscribableTypeSpec -

-

-(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -SubscribableType) -

-

-

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

-

- - - - - + - - @@ -1375,16 +1197,14 @@ Subscribable
FieldDescription
-subscribable
+status
- -Subscribable + +ChannelableCombinedStatus
-

SubscribableTypeStatus +

ChannelableCombinedSpec

(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -SubscribableType) +ChannelableCombined)

-

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

+

ChannelableSpec contains Spec of the Channelable object

@@ -1396,94 +1216,34 @@ Subscribable - - -
-subscribableStatus
+SubscribableTypeSpec
- -SubscribableStatus + +SubscribableTypeSpec
-
-

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

-

- - - - - - - - - - - - - - - - - - - - - - - @@ -1497,32 +1257,19 @@ DeliverySpec
FieldDescription
-uid
- -k8s.io/apimachinery/pkg/types.UID - -
-(Optional) -

UID is used to understand the origin of the subscriber.

-
-generation
- -int64 - -
-(Optional) -

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

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

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

+

SubscribableTypeSpec is for the v1alpha1 spec compatibility.

-deadLetterSink
+SubscribableSpec
-knative.dev/pkg/apis.URL + +SubscribableSpec +
-(Optional) +

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

+

SubscribableSpec is for the v1beta1 spec compatibility.

(Optional) +

DeliverySpec contains options controlling the event delivery

-
-

duck.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

BackoffPolicyType -(string alias)

+

ChannelableCombinedStatus +

(Appears on: -DeliverySpec) -

-

-

BackoffPolicyType is the type for backoff policies

+ChannelableCombined)

-

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.

+

ChannelableStatus contains the Status of a Channelable object.

@@ -1534,85 +1281,87 @@ Channelable ObjectReferences and access their subscription and address data. Th
-metadata
+Status
- -Kubernetes meta/v1.ObjectMeta - +knative.dev/pkg/apis/duck/v1.Status
-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

+(Members of 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
+AddressStatus
- -ChannelableSpec - +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
-

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

-
-
- +

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

+

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

+ + - -
-SubscribableSpec
+SubscribableTypeStatus
- -SubscribableSpec + +SubscribableTypeStatus

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

+

SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

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

DeliverySpec contains options controlling the event delivery

-
+

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

+

SubscribableStatus is the v1beta1 part of the Subscribers status.

-status
+errorChannel
- -ChannelableStatus + +Kubernetes core/v1.ObjectReference
+(Optional) +

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

-

ChannelableSpec +

ChannelableSpec

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

ChannelableSpec contains Spec of the Channelable object

@@ -1627,16 +1376,16 @@ ChannelableStatus -SubscribableSpec
+SubscribableTypeSpec
- -SubscribableSpec + +SubscribableTypeSpec

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

@@ -1656,13 +1405,11 @@ DeliverySpec -

ChannelableStatus +

ChannelableStatus

(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) +Channelable)

ChannelableStatus contains the Status of a Channelable object.

@@ -1695,7 +1442,7 @@ knative.dev/pkg/apis/duck/v1.Status AddressStatus
-knative.dev/pkg/apis/duck/v1.AddressStatus +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus @@ -1707,52 +1454,41 @@ knative.dev/pkg/apis/duck/v1.AddressStatus -SubscribableStatus
+SubscribableTypeStatus
- -SubscribableStatus + +SubscribableTypeStatus

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

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

-deadLetterChannel
+errorChannel
-knative.dev/pkg/apis/duck/v1.KReference + +Kubernetes core/v1.ObjectReference + (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.

+

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

-

DeliverySpec +

Resource

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

-

-

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

+

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.

@@ -1764,67 +1500,62 @@ such as channelable and source.

+ +
-deadLetterSink
+metadata
-knative.dev/pkg/apis/duck/v1.Destination + +Kubernetes meta/v1.ObjectMeta +
-(Optional) -

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

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
+

Subscribable +

+

+(Appears on: +SubscribableTypeSpec) +

+

+

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

+

+ + + + + + + + - - - - - - - -
FieldDescription
-retry
+subscribers
-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 + +[]SubscriberSpec
-(Optional) -

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

-
-backoffDelay
- -string - -
-(Optional) -

BackoffDelay is the delay before retrying. -More information on Duration format: -- https://www.iso.org/iso-8601-date-and-time-format.html -- https://en.wikipedia.org/wiki/ISO_8601

-

For linear policy, backoff delay is backoffDelay*. -For exponential policy, backoff delay is backoffDelay*2^.

+

This is the list of subscriptions for this subscribable.

-

DeliveryStatus +

SubscribableStatus

-

DeliveryStatus contains the Status of an object supporting delivery options.

+(Appears on: +SubscribableTypeStatus) +

+

+

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

@@ -1836,23 +1567,23 @@ For exponential policy, backoff delay is backoffDelay*2^.

-deadLetterChannel
+subscribers
-knative.dev/pkg/apis/duck/v1.KReference + +[]SubscriberStatus +
-(Optional) -

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

+

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

-

Subscribable +

SubscribableType

-

Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers +

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

@@ -1882,28 +1613,27 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -SubscribableSpec + +SubscribableTypeSpec -

SubscribableSpec is the part where Subscribable object is +

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



-subscribers
+subscribable
- -[]SubscriberSpec + +Subscribable
-

This is the list of subscriptions for this subscribable.

@@ -1913,28 +1643,28 @@ configured as to be compatible with Subscribable contract.

status
- -SubscribableStatus + +SubscribableTypeStatus -

SubscribableStatus is the part where SubscribableStatus object is +

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

-

SubscribableSpec +

SubscribableTypeSpec

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

-

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

+

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

@@ -1946,30 +1676,28 @@ configured as to be compatible with Subscribable contract.

-subscribers
+subscribable
- -[]SubscriberSpec + +Subscribable
-

This is the list of subscriptions for this subscribable.

-

SubscribableStatus +

SubscribableTypeStatus

(Appears on: ChannelableCombinedStatus, -ChannelableStatus, -Subscribable) +ChannelableStatus, +SubscribableType)

-

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

+

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

@@ -1981,28 +1709,30 @@ section of the resource.

-subscribers
+subscribableStatus
- -[]SubscriberStatus + +SubscribableStatus
-

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

-

SubscriberSpec +

SubscriberSpec

(Appears on: -SubscribableSpec) +Subscribable)

-

SubscriberSpec defines a single subscriber to a Subscribable.

-

At least one of SubscriberURI and ReplyURI must be present

+

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

@@ -2038,26 +1768,35 @@ int64 + + + + @@ -2071,92 +1810,47 @@ DeliverySpec
-subscriberUri
+subscriberURI
knative.dev/pkg/apis.URL
(Optional) -

SubscriberURI is the endpoint for the subscriber

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

ReplyURI is the endpoint for the reply

(Optional) -

DeliverySpec contains options controlling the event delivery

-

SubscriberStatus -

+
+

duck.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 version of the API.

+

+Resource Types: + +

BackoffPolicyType +(string alias)

(Appears on: -SubscribableStatus, -SubscribableStatus) +DeliverySpec)

-

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

+

BackoffPolicyType is the type for backoff policies

- + - - - - - - - - - - - - - - - + - + - - +
FieldValue Description
-uid
- -k8s.io/apimachinery/pkg/types.UID - -
-(Optional) -

UID is used to understand the origin of the subscriber.

-
-observedGeneration
- -int64 - -
-(Optional) -

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

-
-ready
- - -Kubernetes core/v1.ConditionStatus - - -
-

Status of the subscriber.

-
-message
- -string - +

"exponential"

Exponential backoff policy

-(Optional) -

A human readable message indicating details of Ready status.

+

"linear"

Linear backoff policy

-
-

flows.knative.dev/v1beta1

-

-

Package v1beta1 is the v1beta1 version of the API.

-

-Resource Types: - -

Parallel +

Channelable

-

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

+

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.

@@ -2176,7 +1870,6 @@ Kubernetes meta/v1.ObjectMeta @@ -2185,84 +1878,122 @@ 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 + +ChannelableSpec
-

Spec defines the desired state of the Parallel.

+

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



+ +
-branches
+SubscribableSpec
- -[]ParallelBranch + +SubscribableSpec
-

Branches is the list of Filter/Subscribers pairs.

+

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

-channelTemplate
+delivery
- -ChannelTemplateSpec + +DeliverySpec
(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).

+

DeliverySpec contains options controlling the event delivery

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

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

- +

ChannelableSpec +

+

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

+

+

ChannelableSpec contains Spec of the Channelable object

+

+ + + + + + + + + + +
FieldDescription
-status
+SubscribableSpec
- -ParallelStatus + +SubscribableSpec + + +
+

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

+
+delivery
+ + +DeliverySpec
(Optional) -

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

+

DeliverySpec contains options controlling the event delivery

-

ParallelBranch +

ChannelableStatus

(Appears on: -ParallelSpec) +Channelable, +ChannelStatus, +InMemoryChannelStatus)

+

ChannelableStatus contains the Status of a Channelable object.

@@ -2274,66 +2005,82 @@ date.

-filter
+Status
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.Status
-(Optional) -

Filter is the expression guarding the branch

+

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

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

Subscriber receiving the event when the filter passes

+

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

+

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

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

+

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

+

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

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

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

+

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

-

ParallelBranchStatus +

DeliverySpec

(Appears on: -ParallelStatus) +ChannelableCombinedSpec, +ChannelableSpec, +SubscriberSpec, +ChannelableSpec, +SubscriberSpec, +BrokerSpec, +ParallelBranch, +SequenceStep, +SubscriptionSpec)

-

ParallelBranchStatus represents the current state of a Parallel branch

+

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

@@ -2345,53 +2092,67 @@ Needed for Roundtripping v1alpha1 <-> v1beta1.

+ + + +
-filterSubscriptionStatus
+deadLetterSink
- -ParallelSubscriptionStatus - +knative.dev/pkg/apis/duck/v1.Destination
-

FilterSubscriptionStatus corresponds to the filter subscription status.

+(Optional) +

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

-filterChannelStatus
+retry
- -ParallelChannelStatus - +int32
-

FilterChannelStatus corresponds to the filter channel status.

+(Optional) +

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

-subscriberSubscriptionStatus
+backoffPolicy
- -ParallelSubscriptionStatus + +BackoffPolicyType
-

SubscriptionStatus corresponds to the subscriber subscription status.

+(Optional) +

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

+
+backoffDelay
+ +string + +
+(Optional) +

BackoffDelay is the delay before retrying. +More information on Duration format: +- https://www.iso.org/iso-8601-date-and-time-format.html +- https://en.wikipedia.org/wiki/ISO_8601

+

For linear policy, backoff delay is backoffDelay*. +For exponential policy, backoff delay is backoffDelay*2^.

-

ParallelChannelStatus +

DeliveryStatus

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

-

+

DeliveryStatus contains the Status of an object supporting delivery options.

@@ -2403,37 +2164,25 @@ ParallelSubscriptionStatus - - - -
-channel
- - -Kubernetes core/v1.ObjectReference - - -
-

Channel is the reference to the underlying channel.

-
-ready
+deadLetterChannel
-knative.dev/pkg/apis.Condition +knative.dev/pkg/apis/duck/v1.KReference
-

ReadyCondition indicates whether the Channel is ready or not.

+(Optional) +

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

-

ParallelSpec +

Subscribable

-(Appears on: -Parallel) -

-

+

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.

@@ -2445,55 +2194,75 @@ knative.dev/pkg/apis.Condition
-branches
+metadata
- -[]ParallelBranch + +Kubernetes meta/v1.ObjectMeta
-

Branches is the list of Filter/Subscribers pairs.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-channelTemplate
+spec
- -ChannelTemplateSpec + +SubscribableSpec
-(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).

+

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

+
+
+ + + + + +
+subscribers
+ + +[]SubscriberSpec + + +
+

This is the list of subscriptions for this subscribable.

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

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

+

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

-

ParallelStatus +

SubscribableSpec

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

-

ParallelStatus represents the current state of a Parallel.

+

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

@@ -2505,72 +2274,30 @@ when the case does not have a Reply

- - - - - - - - - - - -
-Status
+subscribers
-knative.dev/pkg/apis/duck/v1.Status + +[]SubscriberSpec +
-

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

+

This is the list of subscriptions for this subscribable.

-

ParallelSubscriptionStatus +

SubscribableStatus

(Appears on: -ParallelBranchStatus) +ChannelableCombinedStatus, +ChannelableStatus, +Subscribable)

+

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

@@ -2582,35 +2309,28 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

- - - -
-subscription
+subscribers
- -Kubernetes core/v1.ObjectReference + +[]SubscriberStatus
-

Subscription is the reference to the underlying Subscription.

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

ReadyCondition indicates whether the Subscription is ready or not.

+

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

-

Sequence +

SubscriberSpec

-

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

+(Appears on: +SubscribableSpec) +

+

+

SubscriberSpec defines a single subscriber to a Subscribable.

+

At least one of SubscriberURI and ReplyURI must be present

@@ -2622,101 +2342,77 @@ series through Channels and Subscriptions.

-
-metadata
+uid
- -Kubernetes meta/v1.ObjectMeta - +k8s.io/apimachinery/pkg/types.UID
(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

UID is used to understand the origin of the subscriber.

-spec
- - -SequenceSpec - - -
-

Spec defines the desired state of the Sequence.

-
-
- - - - -
-steps
+generation
- -[]SequenceStep - +int64
-

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

+(Optional) +

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

-channelTemplate
+subscriberUri
- -ChannelTemplateSpec - +knative.dev/pkg/apis.URL
(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).

+

SubscriberURI is the endpoint for the subscriber

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

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

-
+

ReplyURI is the endpoint for the reply

-status
+delivery
- -SequenceStatus + +DeliverySpec
(Optional) -

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

+

DeliverySpec contains options controlling the event delivery

-

SequenceChannelStatus +

SubscriberStatus

(Appears on: -SequenceStatus) +SubscribableStatus, +SubscribableStatus)

+

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

@@ -2728,97 +2424,74 @@ date.

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

-

SequenceSpec -

-

-(Appears on: -Sequence) -

-

-

- - - - - - - -
FieldDescription
-steps
+observedGeneration
- -[]SequenceStep - +int64
-

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

+(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 the last Subscriber gets sent to.

+

A human readable message indicating details of Ready status.

-

SequenceStatus -

+
+

eventing.knative.dev/v1

-(Appears on: -Sequence) +

Package v1 is the v1 version of the API.

+Resource Types: + +

Broker +

-

SequenceStatus represents the current state of a Sequence.

+

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. Subscribers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.

@@ -2830,174 +2503,104 @@ knative.dev/pkg/apis/duck/v1.Destination + + + + - - - - - - -
-Status
- -knative.dev/pkg/apis/duck/v1.Status - +apiVersion
+string
+ +eventing.knative.dev/v1 +
-

-(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
Broker
-subscriptionStatuses
+metadata
- -[]SequenceSubscriptionStatus + +Kubernetes meta/v1.ObjectMeta
-

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

+(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
-channelStatuses
+spec
- -[]SequenceChannelStatus + +BrokerSpec
-

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

-

-

+

Spec defines the desired state of the Broker.

+
+
- - - - - - - -
FieldDescription
-Destination
+config
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.KReference
-

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

-

Subscriber receiving the step event

+(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 to the subscriber +

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

-

SequenceSubscriptionStatus -

-

-(Appears on: -SequenceStatus) -

-

-

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

Subscription is the reference to the underlying Subscription.

-ready
+status
-knative.dev/pkg/apis.Condition + +BrokerStatus +
-

ReadyCondition indicates whether the Subscription is ready or not.

+(Optional) +

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

-
-

sources.knative.dev/v1beta1

-

-

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

-

-Resource Types: - -

ApiServerSource +

Trigger

-

ApiServerSource is the Schema for the apiserversources API

+

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

@@ -3013,7 +2616,7 @@ Resource Types: string @@ -3022,7 +2625,7 @@ sources.knative.dev/v1beta1 kind
string - + @@ -3042,113 +2646,129 @@ Refer to the Kubernetes API documentation for the fields of the + +
-sources.knative.dev/v1beta1 +eventing.knative.dev/v1
ApiServerSourceTrigger
@@ -3034,6 +2637,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ApiServerSourceSpec + +TriggerSpec
+

Spec defines the desired state of the Trigger.



+ +
-SourceSpec
+broker
-knative.dev/pkg/apis/duck/v1.SourceSpec +string
-

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

+

Broker is the broker that this trigger receives events from.

-resources
+filter
- -[]APIVersionKindSelector + +TriggerFilter
-

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

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

-owner
+subscriber
- -APIVersionKind - +knative.dev/pkg/apis/duck/v1.Destination
-(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.

+

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

+
-mode
+status
-string + +TriggerStatus +
(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

+

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

+

BrokerSpec +

+

+(Appears on: +Broker) +

+

+

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

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

-
+

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

-status
+delivery
- -ApiServerSourceStatus + +DeliverySpec +(Optional) +

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

-

ContainerSource +

BrokerStatus

-

ContainerSource is the Schema for the containersources API

+(Appears on: +Broker) +

+

+

BrokerStatus represents the current state of a Broker.

@@ -3160,100 +2780,204 @@ ApiServerSourceStatus +Status
+ +knative.dev/pkg/apis/duck/v1.Status + + - + + + +
-apiVersion
-string
- -sources.knative.dev/v1beta1 - +

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

+

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

-kind
-string +address
+ +knative.dev/pkg/apis/duck/v1.Addressable +
ContainerSource +

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

+
+

TriggerFilter +

+

+(Appears on: +TriggerSpec) +

+

+

+ + + + + + + + +
FieldDescription
-metadata
+attributes
- -Kubernetes meta/v1.ObjectMeta + +TriggerFilterAttributes
-Refer to the Kubernetes API documentation for the fields of the -metadata field. +(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
-spec
+broker
- -ContainerSourceSpec - +string
-
-
- +

Broker is the broker that this trigger receives events from.

+ + +
-SourceSpec
+filter
-knative.dev/pkg/apis/duck/v1.SourceSpec + +TriggerFilter +
-

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

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

-template
+subscriber
- -Kubernetes core/v1.PodTemplateSpec - +knative.dev/pkg/apis/duck/v1.Destination
-

Template describes the pods that will be created

+

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 Trigger that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.

-status
+subscriberUri
- -ContainerSourceStatus - +knative.dev/pkg/apis.URL
+

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

-

PingSource +
+

eventing.knative.dev/v1beta1

+

+

Package v1beta1 is the v1beta1 version of the API.

+

+Resource Types: + +

Broker

-

PingSource is the Schema for the PingSources API.

+

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.

@@ -3269,7 +2993,7 @@ ContainerSourceStatus string @@ -3278,7 +3002,7 @@ sources.knative.dev/v1beta1 kind
string - + @@ -3298,71 +3023,43 @@ Refer to the Kubernetes API documentation for the fields of the
-sources.knative.dev/v1beta1 +eventing.knative.dev/v1beta1
PingSourceBroker
@@ -3290,6 +3014,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -PingSourceSpec + +BrokerSpec
+

Spec defines the desired state of the Broker.



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

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

-
-timezone
- -string - -
-

Timezone modifies the actual time relative to the specified timezone. -Defaults to the system time zone. -More general information about time zones: https://www.iana.org/time-zones -List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

+

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

-jsonData
+delivery
-string + +DeliverySpec +
(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”.

+

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

@@ -3372,25 +3069,23 @@ to “application/json”.

status
- -PingSourceStatus + +BrokerStatus
+(Optional) +

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

-

SinkBinding +

EventType

-

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.

+

EventType represents a type of event that can be consumed from a Broker.

@@ -3406,7 +3101,7 @@ cloud events.

string @@ -3415,7 +3110,7 @@ sources.knative.dev/v1beta1 kind
string - + @@ -3435,174 +3131,117 @@ Refer to the Kubernetes API documentation for the fields of the - -
-sources.knative.dev/v1beta1 +eventing.knative.dev/v1beta1
SinkBindingEventType
@@ -3427,6 +3122,7 @@ Kubernetes meta/v1.ObjectMeta +(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -SinkBindingSpec + +EventTypeSpec
+

Spec defines the desired state of the EventType.



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

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

+

Type represents the CloudEvents type. It is authoritative.

-BindingSpec
+source
-knative.dev/pkg/apis/duck/v1beta1.BindingSpec +knative.dev/pkg/apis.URL
-

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

-

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

-
+(Optional) +

Source is a URI, it represents the CloudEvents source.

-status
+schema
- -SinkBindingStatus - +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.

-

APIVersionKind -

-

-(Appears on: -ApiServerSourceSpec) -

-

-

APIVersionKind is an APIVersion and Kind tuple.

-

- - - - - - - - - -
FieldDescription
-apiVersion
+schemaData
string
-

APIVersion - the API version of the resource to watch.

+(Optional) +

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

-kind
+broker
string
-

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

+(Optional) +

TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.

-

APIVersionKindSelector -

-

-(Appears on: -ApiServerSourceSpec) -

-

-

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

-

- - - - - - - - - - -
FieldDescription
-apiVersion
+description
string
-

APIVersion - the API version of the resource to watch.

+(Optional) +

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

-kind
- -string - -
-

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

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

+

Status represents the current state of the EventType. +This data may be out of date. +TODO might be removed https://github.com/knative/eventing/issues/2750

-

ApiServerSourceSpec +

Trigger

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceSpec defines the desired state of ApiServerSource

+

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

@@ -3614,130 +3253,116 @@ More info: -[]APIVersionKindSelector + +Kubernetes meta/v1.ObjectMeta
-

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

+(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
-owner
+spec
- -APIVersionKind + +TriggerSpec
-(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.

+

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

-mode
+filter
-string + +TriggerFilter +
(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

+

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.

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

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

+

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

-

ApiServerSourceStatus -

-

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceStatus defines the observed state of ApiServerSource

-

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

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

+(Optional) +

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

-

ContainerSourceSpec +

BrokerSpec

(Appears on: -ContainerSource) +Broker)

-

ContainerSourceSpec defines the desired state of ContainerSource

@@ -3749,45 +3374,43 @@ Source.

-SourceSpec
+config
-knative.dev/pkg/apis/duck/v1.SourceSpec +knative.dev/pkg/apis/duck/v1.KReference
-

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

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

-template
+delivery
- -Kubernetes core/v1.PodTemplateSpec + +DeliverySpec
-

Template describes the pods that will be created

+(Optional) +

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

-

ContainerSourceStatus +

BrokerStatus

(Appears on: -ContainerSource) +Broker)

-

ContainerSourceStatus defines the observed state of ContainerSource

+

BrokerStatus represents the current state of a Broker.

@@ -3799,34 +3422,41 @@ Kubernetes core/v1.PodTemplateSpec + + + +
-SourceStatus
+Status
-knative.dev/pkg/apis/duck/v1.SourceStatus +knative.dev/pkg/apis/duck/v1.Status

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

+

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.

-

PingSourceSpec +

EventTypeSpec

(Appears on: -PingSource) +EventType)

-

PingSourceSpec defines the desired state of the PingSource.

@@ -3838,111 +3468,89 @@ Source.

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

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

+

Type represents the CloudEvents type. It is authoritative.

-schedule
+source
-string +knative.dev/pkg/apis.URL
(Optional) -

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

+

Source is a URI, it represents the CloudEvents source.

-timezone
+schema
-string +knative.dev/pkg/apis.URL
-

Timezone modifies the actual time relative to the specified timezone. -Defaults to the system time zone. -More general information about time zones: https://www.iana.org/time-zones -List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

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

-jsonData
+schemaData
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”.

+

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

-

PingSourceStatus -

-

-(Appears on: -PingSource) -

-

-

PingSourceStatus defines the observed state of PingSource.

-

- - - - + + - -
FieldDescription +broker
+ +string + +
+(Optional) +

TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType.

+
-SourceStatus
+description
-knative.dev/pkg/apis/duck/v1.SourceStatus +string
-

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

+(Optional) +

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

-

SinkBindingSpec +

EventTypeStatus

(Appears on: -SinkBinding) +EventType)

-

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

+

EventTypeStatus represents the current state of a EventType.

@@ -3954,48 +3562,29 @@ Source.

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

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

-

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

-
-BindingSpec
+Status
-knative.dev/pkg/apis/duck/v1beta1.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/v1beta1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations.

+

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.

-

SinkBindingStatus +

TriggerFilter

(Appears on: -SinkBinding) +TriggerSpec)

-

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

@@ -4007,45 +3596,42 @@ should be augmented by Binding implementations.

-SourceStatus
+attributes
-knative.dev/pkg/apis/duck/v1.SourceStatus + +TriggerFilterAttributes +
-

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

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

-
-

eventing.knative.dev/v1

+

TriggerFilterAttributes +(map[string]string alias)

-

Package v1 is the v1 version of the API.

+(Appears on: +TriggerFilter)

-Resource Types: - -

Broker +

+

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

-

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. Subscribers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.

+(Appears on: +Trigger) +

+

@@ -4057,104 +3643,103 @@ Addressable endpoint.

- - - - + + +
-apiVersion
-string
- -eventing.knative.dev/v1 - +broker
+ +string +
-kind
-string +

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

Broker
-metadata
+filter
- -Kubernetes meta/v1.ObjectMeta + +TriggerFilter
(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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.

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

Spec defines the desired state of the Broker.

-
-
+

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.

+

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

-
FieldDescription
-delivery
+Status
- -DeliverySpec - +knative.dev/pkg/apis/duck/v1.Status
-(Optional) -

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

-
+

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

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

+

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

-

Trigger +
+

flows.knative.dev/v1

+

+

Package v1 is the v1 version of the API.

+

+Resource Types: + +

Parallel

-

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

+

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

@@ -4166,23 +3751,6 @@ Broker’s event pool.

- - - - - - - -
-apiVersion
-string
- -eventing.knative.dev/v1 - -
-kind
-string -
Trigger
metadata
@@ -4200,52 +3768,55 @@ Refer to the Kubernetes API documentation for the fields of the
spec
- -TriggerSpec + +ParallelSpec
-

Spec defines the desired state of the Trigger.

+

Spec defines the desired state of the Parallel.



-broker
+branches
-string + +[]ParallelBranch +
-

Broker is the broker that this trigger receives events from.

+

Branches is the list of Filter/Subscribers pairs.

-filter
+channelTemplate
- -TriggerFilter + +ChannelTemplateSpec
(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.

+

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

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

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

+(Optional) +

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

@@ -4255,24 +3826,24 @@ is required.

status
- -TriggerStatus + +ParallelStatus
(Optional) -

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

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

-

BrokerSpec +

ParallelBranch

(Appears on: -Broker) +ParallelSpec)

@@ -4286,16 +3857,38 @@ date.

-config
+filter
-knative.dev/pkg/apis/duck/v1.KReference +knative.dev/pkg/apis/duck/v1.Destination (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.

+

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

@@ -4309,20 +3902,20 @@ DeliverySpec (Optional) -

Delivery is the delivery specification for Events within the Broker mesh. +

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

-

BrokerStatus +

ParallelBranchStatus

(Appears on: -Broker) +ParallelStatus)

-

BrokerStatus represents the current state of a Broker.

+

ParallelBranchStatus represents the current state of a Parallel branch

@@ -4334,39 +3927,51 @@ This includes things like retries, DLQ, etc.

+ + + +
-Status
+filterSubscriptionStatus
-knative.dev/pkg/apis/duck/v1.Status + +ParallelSubscriptionStatus +
-

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

-

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

+

FilterSubscriptionStatus corresponds to the filter subscription status.

-address
+filterChannelStatus
-knative.dev/pkg/apis/duck/v1.Addressable + +ParallelChannelStatus +
-

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

+

FilterChannelStatus corresponds to the filter channel status.

+
+subscriberSubscriptionStatus
+ + +ParallelSubscriptionStatus + + +
+

SubscriptionStatus corresponds to the subscriber subscription status.

-

TriggerFilter +

ParallelChannelStatus

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

@@ -4380,40 +3985,35 @@ delivered into the Broker mesh.

-attributes
+channel
- -TriggerFilterAttributes + +Kubernetes core/v1.ObjectReference -(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.

+

Channel is the reference to the underlying channel.

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

ReadyCondition indicates whether the Channel is ready or not.

-

TriggerFilterAttributes -(map[string]string alias)

+

ParallelSpec +

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

@@ -4427,52 +4027,55 @@ to indicate all strings match.

-broker
+branches
-string + +[]ParallelBranch + -

Broker is the broker that this trigger receives events from.

+

Branches is the list of Filter/Subscribers pairs.

-filter
+channelTemplate
- -TriggerFilter + +ChannelTemplateSpec (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.

+

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

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

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

+(Optional) +

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

-

TriggerStatus +

ParallelStatus

(Appears on: -Trigger) +Parallel)

-

TriggerStatus represents the current state of a Trigger.

+

ParallelStatus represents the current state of a Parallel.

@@ -4494,40 +4097,62 @@ 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 Trigger that was last processed by the controller. +* 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
+ingressChannelStatus
-knative.dev/pkg/apis.URL + +ParallelChannelStatus +
-

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

+

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}

-
-

sources.knative.dev/v1

+

ParallelSubscriptionStatus +

-

Package v1 contains API Schema definitions for the sources v1 API group.

+(Appears on: +ParallelBranchStatus)

-Resource Types: - -

ApiServerSource -

-

ApiServerSource is the Schema for the apiserversources API

@@ -4539,21 +4164,44 @@ Resource Types: +subscription
+ + +Kubernetes core/v1.ObjectReference + + + - + + + +
-apiVersion
-string
- -sources.knative.dev/v1 - +

Subscription is the reference to the underlying Subscription.

-kind
-string +ready
+ +knative.dev/pkg/apis.Condition +
ApiServerSource +

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.

+

+ + + + + + + @@ -4572,113 +4221,126 @@ Refer to the Kubernetes API documentation for the fields of the + +
FieldDescription
metadata
@@ -4564,6 +4212,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.



+ +
-SourceSpec
+steps
-knative.dev/pkg/apis/duck/v1.SourceSpec + +[]SequenceStep +
-

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

+

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

-resources
+channelTemplate
- -[]APIVersionKindSelector + +ChannelTemplateSpec
-

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

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

-owner
+reply
- -APIVersionKind - +knative.dev/pkg/apis/duck/v1.Destination
(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.

+

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

+
-mode
+status
-string + +SequenceStatus +
(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

+

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

+

SequenceChannelStatus +

+

+(Appears on: +SequenceStatus) +

+

+

+ + + + + + + + - -
FieldDescription
-serviceAccountName
+channel
-string + +Kubernetes core/v1.ObjectReference +
-(Optional) -

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

-
+

Channel is the reference to the underlying channel.

-status
+ready
- -ApiServerSourceStatus - +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) +

+

@@ -4690,105 +4352,55 @@ ApiServerSourceStatus +steps
+ + +[]SequenceStep + + + - - - - - - - - -
-apiVersion
-string
- -sources.knative.dev/v1 - +

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

-kind
-string -
ContainerSource
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -
-Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -ContainerSourceSpec - - -
-
-
- - - - - - - - -
-SourceSpec
- -knative.dev/pkg/apis/duck/v1.SourceSpec - -
-

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

-

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

-
-template
+channelTemplate
- -Kubernetes core/v1.PodTemplateSpec + +ChannelTemplateSpec
-

Template describes the pods that will be created

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

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

-

SinkBinding +

SequenceStatus

-

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: +Sequence) +

+

+

SequenceStatus represents the current state of a Sequence.

@@ -4800,107 +4412,120 @@ cloud events.

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

SinkBinding
-metadata
+subscriptionStatuses
- -Kubernetes meta/v1.ObjectMeta + +[]SequenceSubscriptionStatus
-Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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

-spec
+channelStatuses
- -SinkBindingSpec + +[]SequenceChannelStatus
-
-
- +

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

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

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

+

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

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

-

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

-
+

Subscriber receiving the step event

-status
+delivery
- -SinkBindingStatus + +DeliverySpec
+(Optional) +

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

-

APIVersionKind +

SequenceSubscriptionStatus

(Appears on: -ApiServerSourceSpec) +SequenceStatus)

-

APIVersionKind is an APIVersion and Kind tuple.

@@ -4912,37 +4537,42 @@ SinkBindingStatus
-apiVersion
+subscription
-string + +Kubernetes core/v1.ObjectReference +
-

APIVersion - the API version of the resource to watch.

+

Subscription is the reference to the underlying Subscription.

-kind
+ready
-string +knative.dev/pkg/apis.Condition
-

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

+

ReadyCondition indicates whether the Subscription is ready or not.

-

APIVersionKindSelector -

+
+

flows.knative.dev/v1beta1

-(Appears on: -ApiServerSourceSpec) +

Package v1beta1 is the v1beta1 version of the API.

+Resource Types: + +

Parallel +

-

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

+

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

@@ -4954,53 +4584,101 @@ More info: +Kubernetes meta/v1.ObjectMeta + + + + +
-

APIVersion - the API version of the resource to watch.

+(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
-kind
+spec
-string + +ParallelSpec +
-

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

+

Spec defines the desired state of the Parallel.

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

Branches is the list of Filter/Subscribers pairs.

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

+

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.

-

ApiServerSourceSpec +

ParallelBranch

(Appears on: -ApiServerSource) +ParallelSpec)

-

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -5012,91 +4690,66 @@ More info: -[]APIVersionKindSelector - +knative.dev/pkg/apis/duck/v1.Destination
-

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

+(Optional) +

Filter is the expression guarding the branch

-owner
+subscriber
- -APIVersionKind - +knative.dev/pkg/apis/duck/v1.Destination
-(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.

+

Subscriber receiving the event when the filter passes

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

+

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

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

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

+

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

-

ApiServerSourceStatus +

ParallelBranchStatus

(Appears on: -ApiServerSource) +ParallelStatus)

-

ApiServerSourceStatus defines the observed state of ApiServerSource

+

ParallelBranchStatus represents the current state of a Parallel branch

@@ -5108,84 +4761,53 @@ source. Defaults to default if not set.

- -
-SourceStatus
+filterSubscriptionStatus
-knative.dev/pkg/apis/duck/v1.SourceStatus + +ParallelSubscriptionStatus +
-

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

+

FilterSubscriptionStatus corresponds to the filter subscription status.

-

ContainerSourceSpec -

-

-(Appears on: -ContainerSource) -

-

-

ContainerSourceSpec defines the desired state of ContainerSource

-

- - - - - - - -
FieldDescription
-SourceSpec
+filterChannelStatus
-knative.dev/pkg/apis/duck/v1.SourceSpec + +ParallelChannelStatus +
-

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

+

FilterChannelStatus corresponds to the filter channel status.

-template
+subscriberSubscriptionStatus
- -Kubernetes core/v1.PodTemplateSpec + +ParallelSubscriptionStatus
-

Template describes the pods that will be created

+

SubscriptionStatus corresponds to the subscriber subscription status.

-

ContainerSourceStatus +

ParallelChannelStatus

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

-

ContainerSourceStatus defines the observed state of ContainerSource

@@ -5197,34 +4819,37 @@ Kubernetes core/v1.PodTemplateSpec + + + +
-SourceStatus
+channel
-knative.dev/pkg/apis/duck/v1.SourceStatus + +Kubernetes core/v1.ObjectReference +
-

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

+

Channel is the reference to the underlying channel.

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

ReadyCondition indicates whether the Channel is ready or not.

-

SinkBindingSpec +

ParallelSpec

(Appears on: -SinkBinding) +Parallel)

-

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

@@ -5236,48 +4861,55 @@ Source.

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

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

+

Branches is the list of Filter/Subscribers pairs.

-BindingSpec
+channelTemplate
-knative.dev/pkg/apis/duck/v1.BindingSpec + +ChannelTemplateSpec +
-

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

-

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

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

-

SinkBindingStatus +

ParallelStatus

(Appears on: -SinkBinding) +Parallel)

-

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

+

ParallelStatus represents the current state of a Parallel.

@@ -5289,41 +4921,72 @@ should be augmented by Binding implementations.

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

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

+

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}

-
-

sources.knative.dev/v1alpha1

+

ParallelSubscriptionStatus +

-

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

+(Appears on: +ParallelBranchStatus)

-Resource Types: - -

ApiServerSource -

-

ApiServerSource is the Schema for the apiserversources API

@@ -5335,21 +4998,44 @@ Resource Types: +subscription
+ + +Kubernetes core/v1.ObjectReference + + + + - + +
-apiVersion
-string
- -sources.knative.dev/v1alpha1 - +

Subscription is the reference to the underlying Subscription.

-kind
-string +ready
+ +knative.dev/pkg/apis.Condition + +
+

ReadyCondition indicates whether the Subscription is ready or not.

ApiServerSource
+

Sequence +

+

+

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

+

+ + + + + + + + @@ -5368,121 +5055,126 @@ Refer to the Kubernetes API documentation for the fields of the + +
FieldDescription
metadata
@@ -5360,6 +5046,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.

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

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

+
-owner
+status
- -APIVersionKind + +SequenceStatus
(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.

+

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

+

SequenceChannelStatus +

+

+(Appears on: +SequenceStatus) +

+

+

+ + + + + + + + - -
FieldDescription
-mode
+channel
-string + +Kubernetes core/v1.ObjectReference +
-

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.

-
+

Channel is the reference to the underlying channel.

-status
+ready
- -ApiServerSourceStatus - +knative.dev/pkg/apis.Condition +

ReadyCondition indicates whether the Channel is ready or not.

-

SinkBinding +

SequenceSpec

-

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: +Sequence) +

+

@@ -5494,99 +5186,133 @@ cloud events.

- - - - + +
-apiVersion
-string
- -sources.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

SinkBinding
-metadata
+channelTemplate
- -Kubernetes meta/v1.ObjectMeta + +ChannelTemplateSpec
-Refer to the Kubernetes API documentation for the fields of the -metadata field. +(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).

-spec
+reply
- -SinkBindingSpec - +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
-SourceSpec
+Status
-knative.dev/pkg/apis/duck/v1.SourceSpec +knative.dev/pkg/apis/duck/v1.Status

-(Members of SourceSpec 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.

-BindingSpec
+subscriptionStatuses
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +[]SequenceSubscriptionStatus +
-

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

+

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.

-status
+AddressStatus
- -SinkBindingStatus - +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}

-

ApiServerResource +

SequenceStep

(Appears on: -ApiServerSourceSpec) +SequenceSpec)

-

ApiServerResource defines the resource to watch

@@ -5598,80 +5324,94 @@ SinkBindingStatus + +
-apiVersion
+Destination
-string +knative.dev/pkg/apis/duck/v1.Destination
-

API version of the resource to watch.

+

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

+

Subscriber receiving the step event

-kind
+delivery
-string + +DeliverySpec +
-

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

+(Optional) +

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

+

SequenceSubscriptionStatus +

+

+(Appears on: +SequenceStatus) +

+

+

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

-
FieldDescription
-controllerSelector
+subscription
- -Kubernetes meta/v1.OwnerReference + +Kubernetes core/v1.ObjectReference
-

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.

+

Subscription is the reference to the underlying Subscription.

-controller
+ready
-bool +knative.dev/pkg/apis.Condition
-

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.

+

ReadyCondition indicates whether the Subscription is ready or not.

-

ApiServerSourceSpec -

+
+

messaging.knative.dev/v1

-(Appears on: -ApiServerSource) +

Package v1 is the v1 version of the API.

+Resource Types: + +

Channel +

-

ApiServerSourceSpec defines the desired state of ApiServerSource

+

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

@@ -5683,223 +5423,104 @@ v1alpha2, please use Spec.Owner as a GKV.

+ + + + - +

Spec defines the desired state of the Channel.

+
+
+
-resources
- - -[]ApiServerResource - - +apiVersion
+string
+ +messaging.knative.dev/v1 +
-

Resources is the list of resources to watch

+kind
+string
Channel
-serviceAccountName
+metadata
-string + +Kubernetes meta/v1.ObjectMeta +
(Optional) -

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

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-sink
+spec
-knative.dev/pkg/apis/duck/v1beta1.Destination + +ChannelSpec +
-(Optional) -

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

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

CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to 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.

-owner
+ChannelableSpec
- -APIVersionKind + +ChannelableSpec
-(Optional) -

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

+

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

+

Channel conforms to ChannelableSpec

+
-mode
+status
-string + +ChannelStatus + -

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 Channel. This data may be out of +date.

-

ApiServerSourceStatus +

InMemoryChannel

-(Appears on: -ApiServerSource) -

-

-

ApiServerSourceStatus defines the observed state of ApiServerSource

-

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

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

-

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

-
-

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

-
-
-

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.

+

InMemoryChannel is a resource representing an in memory channel

@@ -5915,7 +5536,7 @@ Addressable endpoint.

string @@ -5924,7 +5545,7 @@ eventing.knative.dev/v1beta1 kind
string - +
-eventing.knative.dev/v1beta1 +messaging.knative.dev/v1
BrokerInMemoryChannel
@@ -5945,43 +5566,30 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -BrokerSpec + +InMemoryChannelSpec
-

Spec defines the desired state of the Broker.

+

Spec defines the desired state of the Channel.



- - - -
-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
+ChannelableSpec
- -DeliverySpec + +ChannelableSpec
-(Optional) -

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

+

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

+

Channel conforms to Duck type Channelable.

@@ -5991,23 +5599,24 @@ This includes things like retries, DLQ, etc.

status
- -BrokerStatus + +InMemoryChannelStatus
(Optional) -

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

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

-

EventType +

Subscription

-

EventType represents a type of event that can be consumed from a Broker.

+

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

@@ -6023,7 +5632,7 @@ date.

string @@ -6032,7 +5641,7 @@ eventing.knative.dev/v1beta1 kind
string - + @@ -6053,117 +5661,115 @@ Refer to the Kubernetes API documentation for the fields of the +
-eventing.knative.dev/v1beta1 +messaging.knative.dev/v1
EventTypeSubscription
@@ -6044,7 +5653,6 @@ Kubernetes meta/v1.ObjectMeta -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -EventTypeSpec + +SubscriptionSpec
-

Spec defines the desired state of the EventType.



- - -
-type
+channel
-string + +Kubernetes core/v1.ObjectReference +
-

Type represents the CloudEvents type. It is authoritative.

+

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

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

Source is a URI, it represents the CloudEvents 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.

-schema
+reply
-knative.dev/pkg/apis.URL +knative.dev/pkg/apis/duck/v1.Destination
(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.

+

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

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

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

+

Delivery configuration

-broker
- -string - -
-(Optional) -

TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType.

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

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

- - - - -status
- - -EventTypeStatus - - - - -(Optional) -

Status represents the current state of the EventType. -This data may be out of date. -TODO might be removed https://github.com/knative/eventing/issues/2750

- - - - -

Trigger +

ChannelDefaulter

-

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

+

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

+

+

ChannelSpec +

+

+(Appears on: +Channel) +

+

+

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

@@ -6175,116 +5781,124 @@ Broker’s event pool.

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

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.

-spec
+ChannelableSpec
- -TriggerSpec + +ChannelableSpec
-

Spec defines the desired state of the Trigger.

-
-
+

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

+

Channel conforms to ChannelableSpec

+
+

ChannelStatus +

+

+(Appears on: +Channel) +

+

+

ChannelStatus represents the current state of a Channel.

+

+ - - + + + + +
-broker
- -string - -
-

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

-
FieldDescription
-filter
+ChannelableStatus
- -TriggerFilter + +ChannelableStatus
-(Optional) -

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

+

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

+

Channel conforms to ChannelableStatus

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

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

+

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

- +

ChannelTemplateSpec +

+

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

+

+

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

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

+

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

+
+
+ +
-

BrokerSpec +

ChannelTemplateSpecInternal

-(Appears on: -Broker) -

-

+

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

@@ -6296,43 +5910,48 @@ date.

-config
+metadata
-knative.dev/pkg/apis/duck/v1.KReference + +Kubernetes meta/v1.ObjectMeta +
(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.

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-delivery
+spec
- -DeliverySpec + +ChannelTemplateSpecInternalSpec
-(Optional) -

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

+

Spec includes the Channel CR ChannelableSpec and the physical channel spec. +In order to create a new ChannelTemplateSpecInternalSpec, you must use NewChannelTemplateSpecInternalSpec

+
+
+ +
-

BrokerStatus +

ChannelTemplateSpecInternalSpec

(Appears on: -Broker) +ChannelTemplateSpecInternal)

-

BrokerStatus represents the current state of a Broker.

+

ChannelTemplateSpecInternalSpec merges the “general” spec from Channel CR and the template of the physical channel spec. +Note that this struct properly implements only Marshalling, unmarshalling doesn’t work!

@@ -6344,41 +5963,42 @@ This includes things like retries, DLQ, etc.

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

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

+

ChannelableSpec includes the fields from the Channel Spec section

-address
+PhysicalChannelSpec
-knative.dev/pkg/apis/duck/v1.Addressable +k8s.io/apimachinery/pkg/runtime.RawExtension
-

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

+(Optional) +

PhysicalChannelSpec includes the fields from the physical channel Spec. Passed +in verbatim to the Channel CRD as Spec section.

-

EventTypeSpec +

InMemoryChannelSpec

(Appears on: -EventType) +InMemoryChannel)

+

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

@@ -6390,89 +6010,163 @@ delivered into the Broker mesh.

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

Type represents the CloudEvents type. It is authoritative.

+

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

+

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

Source is a URI, it represents the CloudEvents source.

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

+

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

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

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

+

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.

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

TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType.

+

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

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

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

+

Delivery configuration

-

EventTypeStatus +

SubscriptionStatus

(Appears on: -EventType) +Subscription)

-

EventTypeStatus represents the current state of a EventType.

+

SubscriptionStatus (computed) for a subscription

@@ -6498,62 +6192,30 @@ knative.dev/pkg/apis/duck/v1.Status * Conditions - the latest available observations of a resource’s current state.

- -
-

TriggerFilter -

-

-(Appears on: -TriggerSpec) -

-

-

- - - - - - - -
FieldDescription
-attributes
+physicalSubscription
- -TriggerFilterAttributes + +SubscriptionStatusPhysicalSubscription
-(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.

+

PhysicalSubscription is the fully resolved values that this Subscription represents.

-

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 +

SubscriptionStatusPhysicalSubscription

(Appears on: -Trigger) +SubscriptionStatus)

+

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

@@ -6565,105 +6227,53 @@ to indicate all strings match.

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

+

SubscriberURI is the fully resolved URI for spec.subscriber.

-

TriggerStatus -

-

-(Appears on: -Trigger) -

-

-

TriggerStatus represents the current state of a Trigger.

-

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

+

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

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

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

+

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


-

messaging.knative.dev/v1

+

messaging.knative.dev/v1beta1

-

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

@@ -6682,7 +6292,7 @@ Resource Types: string -messaging.knative.dev/v1 +messaging.knative.dev/v1beta1 @@ -6712,7 +6322,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + ChannelSpec @@ -6726,7 +6336,7 @@ ChannelSpec channelTemplate
- + ChannelTemplateSpec @@ -6740,7 +6350,7 @@ This is immutable after creation. Normally this is set by the Channel defaulter, ChannelableSpec
- + ChannelableSpec @@ -6759,7 +6369,7 @@ ChannelableSpec status
- + ChannelStatus @@ -6772,7 +6382,7 @@ date.

-

InMemoryChannel +

InMemoryChannel

InMemoryChannel is a resource representing an in memory channel

@@ -6791,7 +6401,7 @@ date.

string -messaging.knative.dev/v1 +messaging.knative.dev/v1beta1 @@ -6821,7 +6431,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + InMemoryChannelSpec @@ -6835,7 +6445,7 @@ InMemoryChannelSpec ChannelableSpec
- + ChannelableSpec @@ -6854,7 +6464,7 @@ ChannelableSpec status
- + InMemoryChannelStatus @@ -6867,7 +6477,7 @@ date.

-

Subscription +

Subscription

Subscription routes events received on a Channel to a DNS name and @@ -6887,7 +6497,7 @@ corresponds to the subscriptions.channels.knative.dev CRD.

string -messaging.knative.dev/v1 +messaging.knative.dev/v1beta1 @@ -6916,7 +6526,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + SubscriptionSpec @@ -6983,7 +6593,7 @@ the Subscriber target.

delivery
- + DeliverySpec @@ -7000,7 +6610,7 @@ DeliverySpec status
- + SubscriptionStatus @@ -7010,17 +6620,17 @@ SubscriptionStatus -

ChannelDefaulter +

ChannelDefaulter

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

-

ChannelSpec +

ChannelSpec

(Appears on: -Channel) +Channel)

ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. @@ -7038,7 +6648,7 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba channelTemplate
- + ChannelTemplateSpec @@ -7052,7 +6662,7 @@ This is immutable after creation. Normally this is set by the Channel defaulter, ChannelableSpec
- + ChannelableSpec @@ -7066,11 +6676,11 @@ ChannelableSpec -

ChannelStatus +

ChannelStatus

(Appears on: -Channel) +Channel)

ChannelStatus represents the current state of a Channel.

@@ -7087,7 +6697,7 @@ ChannelableSpec ChannelableStatus
- + ChannelableStatus @@ -7112,13 +6722,13 @@ knative.dev/pkg/apis/duck/v1.KReference -

ChannelTemplateSpec +

ChannelTemplateSpec

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

@@ -7149,7 +6759,7 @@ in verbatim to the Channel CRD as Spec section.

-

ChannelTemplateSpecInternal +

ChannelTemplateSpecInternal

ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that @@ -7197,11 +6807,11 @@ in verbatim to the Channel CRD as Spec section.

-

InMemoryChannelSpec +

InMemoryChannelSpec

(Appears on: -InMemoryChannel) +InMemoryChannel)

InMemoryChannelSpec defines which subscribers have expressed interest in @@ -7220,7 +6830,7 @@ arguments for a Channel.

ChannelableSpec
- + ChannelableSpec @@ -7234,11 +6844,11 @@ ChannelableSpec -

InMemoryChannelStatus +

InMemoryChannelStatus

(Appears on: -InMemoryChannel) +InMemoryChannel)

ChannelStatus represents the current state of a Channel.

@@ -7255,7 +6865,7 @@ ChannelableSpec ChannelableStatus
- + ChannelableStatus @@ -7269,11 +6879,11 @@ ChannelableStatus -

SubscriptionSpec +

SubscriptionSpec

(Appears on: -Subscription) +Subscription)

SubscriptionSpec specifies the Channel for incoming events, a Subscriber target @@ -7355,7 +6965,7 @@ the Subscriber target.

delivery
- + DeliverySpec @@ -7367,11 +6977,11 @@ DeliverySpec -

SubscriptionStatus +

SubscriptionStatus

(Appears on: -Subscription) +Subscription)

SubscriptionStatus (computed) for a subscription

@@ -7404,7 +7014,7 @@ knative.dev/pkg/apis/duck/v1.Status physicalSubscription
- + SubscriptionStatusPhysicalSubscription @@ -7415,11 +7025,11 @@ SubscriptionStatusPhysicalSubscription -

SubscriptionStatusPhysicalSubscription +

SubscriptionStatusPhysicalSubscription

(Appears on: -SubscriptionStatus) +SubscriptionStatus)

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this @@ -7469,22 +7079,22 @@ knative.dev/pkg/apis.URL


-

messaging.knative.dev/v1beta1

+

sources.knative.dev/v1

-

Package v1beta1 is the v1beta1 version of the API.

+

Package v1 contains API Schema definitions for the sources v1 API group.

Resource Types: -

Channel +

ApiServerSource

-

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

+

ApiServerSource is the Schema for the apiserversources API

@@ -7500,7 +7110,7 @@ Resource Types: string @@ -7509,7 +7119,7 @@ messaging.knative.dev/v1beta1 kind
string - + @@ -7530,44 +7139,90 @@ Refer to the Kubernetes API documentation for the fields of the
-messaging.knative.dev/v1beta1 +sources.knative.dev/v1
ChannelApiServerSource
@@ -7521,7 +7131,6 @@ Kubernetes meta/v1.ObjectMeta -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ChannelSpec + +ApiServerSourceSpec
-

Spec defines the desired state of the Channel.



+ + + + + + + + + + + +
-channelTemplate
+SourceSpec
- -ChannelTemplateSpec +knative.dev/pkg/apis/duck/v1.SourceSpec + +
+

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

+

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

+
+resources
+ + +[]APIVersionKindSelector
-

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.

+

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

-ChannelableSpec
+owner
- -ChannelableSpec + +APIVersionKind
-

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

-

Channel conforms to ChannelableSpec

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

@@ -7577,23 +7232,20 @@ ChannelableSpec
status
- -ChannelStatus + +ApiServerSourceStatus
-(Optional) -

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

-

InMemoryChannel +

ContainerSource

-

InMemoryChannel is a resource representing an in memory channel

+

ContainerSource is the Schema for the containersources API

@@ -7609,7 +7261,7 @@ date.

string @@ -7618,7 +7270,7 @@ messaging.knative.dev/v1beta1 kind
string - + @@ -7639,30 +7290,44 @@ Refer to the Kubernetes API documentation for the fields of the
-messaging.knative.dev/v1beta1 +sources.knative.dev/v1
InMemoryChannelContainerSource
@@ -7630,7 +7282,6 @@ Kubernetes meta/v1.ObjectMeta -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -InMemoryChannelSpec + +ContainerSourceSpec
-

Spec defines the desired state of the Channel.



+ + + +
-ChannelableSpec
+SourceSpec
- -ChannelableSpec - +knative.dev/pkg/apis/duck/v1.SourceSpec

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

-

Channel conforms to Duck type Channelable.

+

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

+
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +
+

Template describes the pods that will be created

@@ -7672,24 +7337,25 @@ ChannelableSpec
status
- -InMemoryChannelStatus + +ContainerSourceStatus
-(Optional) -

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

-

Subscription +

SinkBinding

-

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

+

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.

@@ -7705,7 +7371,7 @@ corresponds to the subscriptions.channels.knative.dev CRD.

string @@ -7714,7 +7380,7 @@ messaging.knative.dev/v1beta1 kind
string - + @@ -7745,70 +7411,36 @@ SubscriptionSpec
-messaging.knative.dev/v1beta1 +sources.knative.dev/v1
SubscriptionSinkBinding
@@ -7734,8 +7400,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
- -SubscriptionSpec + +SinkBindingSpec
- - - - - - - -
-channel
+SourceSpec
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1.SourceSpec
-

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

+

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

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

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

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

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

-
-delivery
- - -DeliverySpec - - -
-(Optional) -

Delivery configuration

+

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

+

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

@@ -7818,8 +7450,8 @@ DeliverySpec status
- -SubscriptionStatus + +SinkBindingStatus @@ -7828,21 +7460,14 @@ SubscriptionStatus -

ChannelDefaulter -

-

-

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

-

-

ChannelSpec +

APIVersionKind

(Appears on: -Channel) +ApiServerSourceSpec)

-

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.

+

APIVersionKind is an APIVersion and Kind tuple.

@@ -7854,44 +7479,37 @@ It also defines the ChannelTemplate to use in order to create the CRD Channel ba
-channelTemplate
+apiVersion
- -ChannelTemplateSpec - +string
-

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

+

APIVersion - the API version of the resource to watch.

-ChannelableSpec
+kind
- -ChannelableSpec - +string
-

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

-

Channel conforms to ChannelableSpec

+

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

-

ChannelStatus +

APIVersionKindSelector

(Appears on: -Channel) +ApiServerSourceSpec)

-

ChannelStatus represents the current state of a Channel.

+

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

@@ -7903,42 +7521,53 @@ ChannelableSpec + + + +
-ChannelableStatus
+apiVersion
- -ChannelableStatus - +string
-

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

-

Channel conforms to ChannelableStatus

+

APIVersion - the API version of the resource to watch.

-channel
+kind
-knative.dev/pkg/apis/duck/v1.KReference +string
-

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

+

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

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

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

-

ChannelTemplateSpec +

ApiServerSourceSpec

(Appears on: -ChannelSpec, -ParallelSpec, -SequenceSpec) +ApiServerSource)

+

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -7950,81 +7579,91 @@ knative.dev/pkg/apis/duck/v1.KReference - - -
-spec
+SourceSpec
-k8s.io/apimachinery/pkg/runtime.RawExtension +knative.dev/pkg/apis/duck/v1.SourceSpec
-(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.

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

+ + - - + + - - + + + +
FieldDescription +resources
+ + +[]APIVersionKindSelector + + +
+

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

+
-metadata
+owner
- -Kubernetes meta/v1.ObjectMeta + +APIVersionKind
(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. +

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.

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

-
-
- -
+

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.

-

InMemoryChannelSpec +

ApiServerSourceStatus

(Appears on: -InMemoryChannel) +ApiServerSource)

-

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

+

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -8036,30 +7675,34 @@ arguments for a Channel.

-ChannelableSpec
+SourceStatus
- -ChannelableSpec - +knative.dev/pkg/apis/duck/v1.SourceStatus

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

-

Channel conforms to Duck type Channelable.

+

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.

-

InMemoryChannelStatus +

ContainerSourceSpec

(Appears on: -InMemoryChannel) +ContainerSource)

-

ChannelStatus represents the current state of a Channel.

+

ContainerSourceSpec defines the desired state of ContainerSource

@@ -8071,41 +7714,446 @@ ChannelableSpec + + + +
-ChannelableStatus
+SourceSpec
- -ChannelableStatus - +knative.dev/pkg/apis/duck/v1.SourceSpec

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

-

Channel conforms to Duck type Channelable.

+

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

+
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +
+

Template describes the pods that will be created

-

SubscriptionSpec +

ContainerSourceStatus +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceStatus defines the observed state of ContainerSource

+

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

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

+

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

+
+

SinkBindingSpec +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

+

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

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

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

+

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

+
+

SinkBindingStatus +

+

+(Appears on: +SinkBinding) +

+

+

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

+

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

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

+

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

+
+
+

sources.knative.dev/v1alpha1

+

+

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

+

+Resource Types: + +

ApiServerSource +

+

+

ApiServerSource is the Schema for the apiserversources API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string
+ +sources.knative.dev/v1alpha1 + +
+kind
+string +
ApiServerSource
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ApiServerSourceSpec + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+resources
+ + +[]ApiServerResource + + +
+

Resources is the list of resources to watch

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

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

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

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

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

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

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

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

+
+mode
+ +string + +
+

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

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

SinkBinding +

+

+

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

+

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

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

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

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

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

ApiServerResource

(Appears on: -Subscription) +ApiServerSourceSpec)

-

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

+

ApiServerResource defines the resource to watch

@@ -8117,82 +8165,179 @@ channel –> reply

+ + + + + + + + + + + + + + + + + + +
-channel
+apiVersion
- -Kubernetes core/v1.ObjectReference +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
-

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

+

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

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

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

+
+controller
+ +bool + +
+

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

+
+

ApiServerSourceSpec +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceSpec defines the desired state of ApiServerSource

+

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

Resources is the list of resources to watch

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

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

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

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

-subscriber
+ceOverrides
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.CloudEventOverrides
(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.

+

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

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

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

+

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.

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

Delivery configuration

+

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.

-

SubscriptionStatus +

ApiServerSourceStatus

(Appears on: -Subscription) +ApiServerSource)

-

SubscriptionStatus (computed) for a subscription

+

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -8204,44 +8349,34 @@ 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.

-
-physicalSubscription
- - -SubscriptionStatusPhysicalSubscription - - -
-

PhysicalSubscription is the fully resolved values that this Subscription represents.

+

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.

-

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

@@ -8253,52 +8388,83 @@ 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).

+

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


-

configs.internal.knative.dev/v1alpha1

+

sources.knative.dev/v1alpha2

-

Package v1alpha1 is the v1alpha1 version of the API.

+

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

Resource Types: -

ConfigMapPropagation +

ApiServerSource

-

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

+

ApiServerSource is the Schema for the apiserversources API

@@ -8314,7 +8480,7 @@ Resource Types: string @@ -8323,7 +8489,7 @@ configs.internal.knative.dev/v1alpha1 kind
string - + @@ -8344,161 +8509,113 @@ Refer to the Kubernetes API documentation for the fields of the - -
-configs.internal.knative.dev/v1alpha1 +sources.knative.dev/v1alpha2
ConfigMapPropagationApiServerSource
@@ -8335,7 +8501,6 @@ Kubernetes meta/v1.ObjectMeta -(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ConfigMapPropagationSpec + +ApiServerSourceSpec
-

Spec defines the desired state of the ConfigMapPropagation



- -
-originalNamespace
+SourceSpec
-string +knative.dev/pkg/apis/duck/v1.SourceSpec
-

OriginalNamespace is the namespace where the original configMaps are in

+

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

-selector
+resources
- -Kubernetes meta/v1.LabelSelector + +[]APIVersionKindSelector
-(Optional) -

Selector only selects original configMaps with corresponding labels

-
+

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

-status
+owner
- -ConfigMapPropagationStatus + +APIVersionKind
(Optional) -

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

+

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.

-

ConfigMapPropagationSpec -

-

-(Appears on: -ConfigMapPropagation) -

-

-

- - - - - - - - -
FieldDescription
-originalNamespace
+mode
string
-

OriginalNamespace is the namespace where the original configMaps are in

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

-selector
+serviceAccountName
- -Kubernetes meta/v1.LabelSelector - +string
(Optional) -

Selector only selects original configMaps with corresponding labels

+

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

-

ConfigMapPropagationStatus -

-

-(Appears on: -ConfigMapPropagation) -

-

-

ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.

-

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

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

-

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

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

CopyConfigMaps is the status for each copied configmap.

-

ConfigMapPropagationStatusCopyConfigMap +

ContainerSource

-(Appears on: -ConfigMapPropagationStatus) -

-

-

ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap

+

ContainerSource is the Schema for the containersources API

@@ -8510,84 +8627,100 @@ knative.dev/pkg/apis/duck/v1.Status + + + + - +
+
+
-name
- -string - +apiVersion
+string
+ +sources.knative.dev/v1alpha2 +
-

Name is copy configmap’s name

+kind
+string
ContainerSource
-source
+metadata
-string + +Kubernetes meta/v1.ObjectMeta +
-

Source is “originalNamespace/originalConfigMapName”

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-operation
+spec
-string + +ContainerSourceSpec +
-

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

-
+ +
-ready
+SourceSpec
-string +knative.dev/pkg/apis/duck/v1.SourceSpec
-

Ready represents the operation is ready or not

+

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

-reason
+template
-string + +Kubernetes core/v1.PodTemplateSpec +
-

Reason indicates reasons if the operation is not ready

+

Template describes the pods that will be created

+
-resourceVersionFromSource
+status
-string + +ContainerSourceStatus + -

ResourceVersion is the resourceVersion of original configmap

-
-

flows.knative.dev/v1

-

-

Package v1 is the v1 version of the API.

-

-Resource Types: - -

Parallel +

PingSource

-

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

+

PingSource is the Schema for the PingSources API.

@@ -8599,6 +8732,23 @@ series through Channels and Subscriptions.

+ + + + + + + + @@ -8616,55 +8765,57 @@ Refer to the Kubernetes API documentation for the fields of the
+apiVersion
+string
+ +sources.knative.dev/v1alpha2 + +
+kind
+string +
PingSource
metadata
@@ -8607,7 +8757,6 @@ Kubernetes meta/v1.ObjectMeta
-(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
- -ParallelSpec + +PingSourceSpec
-

Spec defines the desired state of the Parallel.



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

+

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.

-channelTemplate
+schedule
- -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).

+

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

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

+

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

@@ -8674,26 +8825,25 @@ when the case does not have a Reply

status
- -ParallelStatus + +PingSourceStatus
-(Optional) -

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

-

ParallelBranch +

SinkBinding

-(Appears on: -ParallelSpec) -

-

+

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.

@@ -8705,123 +8855,108 @@ date.

+apiVersion
+string - + - - -
-filter
- -knative.dev/pkg/apis/duck/v1.Destination - -
-(Optional) -

Filter is the expression guarding the branch

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

Subscriber receiving the event when the filter passes

+kind
+string
SinkBinding
-reply
+metadata
-knative.dev/pkg/apis/duck/v1.Destination + +Kubernetes meta/v1.ObjectMeta +
-(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

+Refer to the Kubernetes API documentation for the fields of the +metadata field.
-delivery
+spec
- -DeliverySpec + +SinkBindingSpec
-(Optional) -

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

-
-

ParallelBranchStatus -

-

-(Appears on: -ParallelStatus) -

-

-

ParallelBranchStatus represents the current state of a Parallel branch

-

+
+
- - - - - - - - + +
FieldDescription
-filterSubscriptionStatus
+SourceSpec
- -ParallelSubscriptionStatus - +knative.dev/pkg/apis/duck/v1.SourceSpec
-

FilterSubscriptionStatus corresponds to the filter subscription status.

+

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

-filterChannelStatus
+BindingSpec
- -ParallelChannelStatus - +knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
-

FilterChannelStatus corresponds to the filter channel status.

+
+

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

+
-subscriberSubscriptionStatus
+status
- -ParallelSubscriptionStatus + +SinkBindingStatus -

SubscriptionStatus corresponds to the subscriber subscription status.

-

ParallelChannelStatus +

APIVersionKind

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

+

APIVersionKind is an APIVersion and Kind tuple.

@@ -8833,37 +8968,37 @@ ParallelSubscriptionStatus
-channel
+apiVersion
- -Kubernetes core/v1.ObjectReference - +string
-

Channel is the reference to the underlying channel.

+

APIVersion - the API version of the resource to watch.

-ready
+kind
-knative.dev/pkg/apis.Condition +string
-

ReadyCondition indicates whether the Channel is ready or not.

+

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

-

ParallelSpec +

APIVersionKindSelector

(Appears on: -Parallel) +ApiServerSourceSpec)

+

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

@@ -8875,55 +9010,53 @@ knative.dev/pkg/apis.Condition
-branches
+apiVersion
- -[]ParallelBranch - +string
-

Branches is the list of Filter/Subscribers pairs.

+

APIVersion - the API version of the resource to watch.

-channelTemplate
+kind
- -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).

+

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

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

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

+

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

-

ParallelStatus +

ApiServerSourceSpec

(Appears on: -Parallel) +ApiServerSource)

-

ParallelStatus represents the current state of a Parallel.

+

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -8935,112 +9068,91 @@ when the case does not have a Reply

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

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

-ingressChannelStatus
+resources
- -ParallelChannelStatus + +[]APIVersionKindSelector
-

IngressChannelStatus corresponds to the ingress channel status.

+

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

-branchStatuses
+owner
- -[]ParallelBranchStatus + +APIVersionKind
-

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}

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

-

ParallelSubscriptionStatus -

-

-(Appears on: -ParallelBranchStatus) -

-

-

- - - - - - - -
FieldDescription
-subscription
+mode
- -Kubernetes core/v1.ObjectReference - +string
-

Subscription is the reference to the underlying Subscription.

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

-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. Defaults to default if not set.

-

Sequence +

ApiServerSourceStatus

-

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

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -9052,101 +9164,34 @@ series through Channels and Subscriptions.

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

Spec defines the desired state of the Sequence.

-
-
- - - - - - - - - - - - - -
-steps
- - -[]SequenceStep - - -
-

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

-
-channelTemplate
- - -ChannelTemplateSpec - - -
-(Optional) -

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

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

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

-
-
-status
+SourceStatus
- -SequenceStatus - +knative.dev/pkg/apis/duck/v1.SourceStatus
-(Optional) -

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

+
+

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

-

SequenceChannelStatus +

ContainerSourceSpec

(Appears on: -SequenceStatus) +ContainerSource)

+

ContainerSourceSpec defines the desired state of ContainerSource

@@ -9158,37 +9203,45 @@ date.

-channel
+SourceSpec
- -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/duck/v1.SourceSpec
-

Channel is the reference to the underlying channel.

+

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

-ready
+template
-knative.dev/pkg/apis.Condition + +Kubernetes core/v1.PodTemplateSpec +
-

ReadyCondition indicates whether the Channel is ready or not.

+

Template describes the pods that will be created

-

SequenceSpec +

ContainerSourceStatus

(Appears on: -Sequence) +ContainerSource)

+

ContainerSourceStatus defines the observed state of ContainerSource

@@ -9200,55 +9253,34 @@ knative.dev/pkg/apis.Condition - - - - - - - -
-steps
- - -[]SequenceStep - - -
-

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

-
-channelTemplate
- - -ChannelTemplateSpec - - -
-(Optional) -

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

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

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

-

SequenceStatus +

PingSourceSpec

(Appears on: -Sequence) +PingSource)

-

SequenceStatus represents the current state of a Sequence.

+

PingSourceSpec defines the desired state of the PingSource.

@@ -9260,73 +9292,97 @@ knative.dev/pkg/apis/duck/v1.Destination + +
-Status
+SourceSpec
-knative.dev/pkg/apis/duck/v1.Status +knative.dev/pkg/apis/duck/v1.SourceSpec

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

-subscriptionStatuses
+schedule
- -[]SequenceSubscriptionStatus - +string
-

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

+(Optional) +

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

-channelStatuses
+jsonData
- -[]SequenceChannelStatus - +string
-

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

+(Optional) +

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

+

PingSourceStatus +

+

+(Appears on: +PingSource) +

+

+

PingSourceStatus defines the observed state of PingSource.

+

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

-(Members of AddressStatus are embedded into this type.) +(Members of SourceStatus 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}

+

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.

-

SequenceStep +

SinkBindingSpec

(Appears on: -SequenceSpec) +SinkBinding)

+

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

@@ -9338,42 +9394,48 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

-Destination
+SourceSpec
-knative.dev/pkg/apis/duck/v1.Destination +knative.dev/pkg/apis/duck/v1.SourceSpec

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

-

Subscriber receiving the step event

+

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.

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

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

+

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

-

SequenceSubscriptionStatus +

SinkBindingStatus

(Appears on: -SequenceStatus) +SinkBinding)

+

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

@@ -9385,46 +9447,42 @@ This includes things like retries, DLQ, etc.

- - - -
-subscription
- - -Kubernetes core/v1.ObjectReference - - -
-

Subscription is the reference to the underlying Subscription.

-
-ready
+SourceStatus
-knative.dev/pkg/apis.Condition +knative.dev/pkg/apis/duck/v1.SourceStatus
-

ReadyCondition indicates whether the Subscription 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.


-

sources.knative.dev/v1alpha2

+

sources.knative.dev/v1beta1

-

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

+

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

Resource Types: -

ApiServerSource +

ApiServerSource

ApiServerSource is the Schema for the apiserversources API

@@ -9443,7 +9501,7 @@ Resource Types: string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1beta1 @@ -9472,7 +9530,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + ApiServerSourceSpec @@ -9503,7 +9561,7 @@ and modifications of the event sent to the sink.

resources
- + []APIVersionKindSelector @@ -9518,7 +9576,7 @@ selector to help filter.

owner
- + APIVersionKind @@ -9565,7 +9623,7 @@ source. Defaults to default if not set.

status
- + ApiServerSourceStatus @@ -9575,7 +9633,7 @@ ApiServerSourceStatus -

ContainerSource +

ContainerSource

ContainerSource is the Schema for the containersources API

@@ -9594,7 +9652,7 @@ ApiServerSourceStatus string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1beta1 @@ -9623,7 +9681,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + ContainerSourceSpec @@ -9670,7 +9728,7 @@ Kubernetes core/v1.PodTemplateSpec status
- + ContainerSourceStatus @@ -9680,7 +9738,7 @@ ContainerSourceStatus -

PingSource +

PingSource

PingSource is the Schema for the PingSources API.

@@ -9699,7 +9757,7 @@ ContainerSourceStatus string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1beta1 @@ -9728,7 +9786,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + PingSourceSpec @@ -9769,6 +9827,20 @@ string +timezone
+ +string + + + +

Timezone modifies the actual time relative to the specified timezone. +Defaults to the system time zone. +More general information about time zones: https://www.iana.org/time-zones +List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

+ + + + jsonData
string @@ -9788,7 +9860,7 @@ to “application/json”.

status
- + PingSourceStatus @@ -9798,7 +9870,7 @@ PingSourceStatus -

SinkBinding +

SinkBinding

SinkBinding describes a Binding that is also a Source. @@ -9822,7 +9894,7 @@ cloud events.

string -sources.knative.dev/v1alpha2 +sources.knative.dev/v1beta1 @@ -9851,7 +9923,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + SinkBindingSpec @@ -9882,14 +9954,14 @@ and modifications of the event sent to the sink.

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

(Members of BindingSpec are embedded into this type.)

-

inherits duck/v1alpha1 BindingSpec, which currently provides: +

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

@@ -9901,7 +9973,7 @@ should be augmented by Binding implementations.

status
- + SinkBindingStatus @@ -9911,12 +9983,11 @@ SinkBindingStatus -

APIVersionKind +

APIVersionKind

(Appears on: -ApiServerSourceSpec, -ApiServerSourceSpec) +ApiServerSourceSpec)

APIVersionKind is an APIVersion and Kind tuple.

@@ -9954,11 +10025,11 @@ More info: APIVersionKindSelector +

APIVersionKindSelector

(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

@@ -10012,11 +10083,11 @@ More info: ApiServerSourceSpec +

ApiServerSourceSpec

(Appears on: -ApiServerSource) +ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -10051,7 +10122,7 @@ and modifications of the event sent to the sink.

resources
- + []APIVersionKindSelector @@ -10064,58 +10135,263 @@ selector to help filter.

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

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

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

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

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

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

+ + + + +

ApiServerSourceStatus +

+

+(Appears on: +ApiServerSource) +

+

+

ApiServerSourceStatus defines the observed state of ApiServerSource

+

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

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

+

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

+
+

ContainerSourceSpec +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceSpec defines the desired state of ContainerSource

+

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

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

+

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

+
+template
+ + +Kubernetes core/v1.PodTemplateSpec + + +
+

Template describes the pods that will be created

+
+

ContainerSourceStatus +

+

+(Appears on: +ContainerSource) +

+

+

ContainerSourceStatus defines the observed state of ContainerSource

+

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

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

+

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

+
+

PingSourceSpec +

+

+(Appears on: +PingSource) +

+

+

PingSourceSpec defines the desired state of the PingSource.

+

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

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

+

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

+
+schedule
- -APIVersionKind - +string
(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.

+

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

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

+

Timezone modifies the actual time relative to the specified timezone. +Defaults to the system time zone. +More general information about time zones: https://www.iana.org/time-zones +List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

-serviceAccountName
+jsonData
string
(Optional) -

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

+

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

-

ApiServerSourceStatus +

PingSourceStatus

(Appears on: -ApiServerSource) +PingSource)

-

ApiServerSourceStatus defines the observed state of ApiServerSource

+

PingSourceStatus defines the observed state of PingSource.

@@ -10147,14 +10423,14 @@ Source.

-

ContainerSourceSpec +

SinkBindingSpec

(Appears on: -ContainerSource) +SinkBinding)

-

ContainerSourceSpec defines the desired state of ContainerSource

+

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

@@ -10184,27 +10460,30 @@ and modifications of the event sent to the sink.

-template
+BindingSpec
- -Kubernetes core/v1.PodTemplateSpec - +knative.dev/pkg/apis/duck/v1beta1.BindingSpec
-

Template describes the pods that will be created

+

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

+

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

-

ContainerSourceStatus +

SinkBindingStatus

(Appears on: -ContainerSource) +SinkBinding)

-

ContainerSourceStatus defines the observed state of ContainerSource

+

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

@@ -10236,14 +10515,19 @@ Source.

-

PingSourceSpec -

+
+

sources.knative.dev/v1beta2

-(Appears on: -PingSource) +

Package v1beta2 contains API Schema definitions for the sources v1beta2 API group.

+Resource Types: + +

PingSource +

-

PingSourceSpec defines the desired state of the PingSource.

+

PingSource is the Schema for the PingSources API.

@@ -10255,6 +10539,50 @@ Source.

+ + + + + + + + + + + + + + + +
+apiVersion
+string
+ +sources.knative.dev/v1beta2 + +
+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 @@ -10280,72 +10608,86 @@ string
(Optional) -

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

+

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

-jsonData
+timezone
+ +string + +
+

Timezone modifies the actual time relative to the specified timezone. +Defaults to the system time zone. +More general information about time zones: https://www.iana.org/time-zones +List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

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

+

ContentType is the media type of Data or DataBase64. Default is empty.

-

PingSourceStatus -

-

-(Appears on: -PingSource) -

-

-

PingSourceStatus defines the observed state of PingSource.

-

- - - - + + - - + + +
FieldDescription +data
+ +string + +
+(Optional) +

Data is data used as the body of the event posted to the sink. Default is empty. +Mutually exclusive with DataBase64.

+
-SourceStatus
+dataBase64
-knative.dev/pkg/apis/duck/v1.SourceStatus +string + +
+(Optional) +

DataBase64 is base64 encoded binary data used as the body of the event posted to the sink. Default is empty. +Mutually exclusive with Data.

+
+
+status
+ + +PingSourceStatus +
-

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

PingSourceSpec

(Appears on: -SinkBinding) +PingSource)

-

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

+

PingSourceSpec defines the desired state of the PingSource.

@@ -10375,30 +10717,78 @@ and modifications of the event sent to the sink.

+ + + + + + + + + + + + + + + +
-BindingSpec
+schedule
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +string
-

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

+(Optional) +

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

+
+timezone
+ +string + +
+

Timezone modifies the actual time relative to the specified timezone. +Defaults to the system time zone. +More general information about time zones: https://www.iana.org/time-zones +List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

+
+contentType
+ +string + +
+(Optional) +

ContentType is the media type of Data or DataBase64. Default is empty.

+
+data
+ +string + +
+(Optional) +

Data is data used as the body of the event posted to the sink. Default is empty. +Mutually exclusive with DataBase64.

+
+dataBase64
+ +string + +
+(Optional) +

DataBase64 is base64 encoded binary data used as the body of the event posted to the sink. Default is empty. +Mutually exclusive with Data.

-

SinkBindingStatus +

PingSourceStatus

(Appears on: -SinkBinding) +PingSource)

-

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

+

PingSourceStatus defines the observed state of PingSource.

@@ -10433,5 +10823,5 @@ Source.


Generated with gen-crd-api-reference-docs -on git commit 0f9a8c55c. +on git commit a414aee50.

diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md index 9f07f4d958c..91f96fb97c6 100644 --- a/docs/reference/api/serving.md +++ b/docs/reference/api/serving.md @@ -24,7 +24,7 @@ Resource Types:

PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative components instantiate autoscalers. This definition is an abstraction that may be backed by multiple definitions. For more information, see the Knative Pluggability presentation: -https://docs.google.com/presentation/d/e/2PACX-1vQ4kT92QNXvBF9dJzVfF_zqUROoG1wZXf-ATMKi8d43htvt3Osq6k-1YUWAO9M27gZ8C-cGBQA8-bwJ/pub

+https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit

@@ -673,6 +673,25 @@ int32

ReachabilityType is the enumeration type for the different states of reachability to the ScaleTarget of a PodAutoscaler

+
+ + + + + + + + + + + + + +
ValueDescription

"Reachable"

ReachabilityReachable means the ScaleTarget is reachable, ie. it has an active route.

+

""

ReachabilityUnknown means the reachability of the ScaleTarget is unknown. +Used when the reachability cannot be determined, eg. during activation.

+

"Unreachable"

ReachabilityUnreachable means the ScaleTarget is not reachable, ie. it does not have an active route.

+

serving.knative.dev/v1

@@ -1704,6 +1723,30 @@ LatestReadyRevisionName that we last observed.

RoutingState represents states of a revision with regards to serving a route.

+ + + + + + + + + + + + + + + + +
ValueDescription

"active"

RoutingStateActive is a state for a revision which are actively referenced by a Route.

+

"pending"

RoutingStatePending is a state after a revision is created, but before +its routing state has been determined. It is treated like active for the purposes +of revision garbage collection.

+

"reserve"

RoutingStateReserve is a state for a revision which is no longer referenced by a Route, +and is scaled down, but may be rapidly pinned to a route to be made active again.

+

""

RoutingStateUnset is the empty value for routing state, this state is unexpected.

+

ServiceSpec

@@ -2173,5 +2216,5 @@ knative.dev/pkg/apis/duck/v1.Addressable


Generated with gen-crd-api-reference-docs -on git commit db4879e0f. +on git commit 560a4f678.

diff --git a/hack/gen-api-reference-docs.sh b/hack/gen-api-reference-docs.sh index 372ea6100fd..a3118ca14b3 100755 --- a/hack/gen-api-reference-docs.sh +++ b/hack/gen-api-reference-docs.sh @@ -23,7 +23,7 @@ SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" REFDOCS_PKG="github.com/ahmetb/gen-crd-api-reference-docs" REFDOCS_REPO="https://${REFDOCS_PKG}.git" -REFDOCS_VER="v0.2.0" +REFDOCS_VER="df869c1245d4ba97142a224ab81e5ced86094bba" KNATIVE_SERVING_REPO="github.com/knative/serving" KNATIVE_SERVING_IMPORT_PATH="knative.dev/serving"