diff --git a/blog/articles/event-drive-app-knative-eventing-kogito.md b/blog/articles/event-drive-app-knative-eventing-kogito.md index 5354c7883d2..5b38480574f 100644 --- a/blog/articles/event-drive-app-knative-eventing-kogito.md +++ b/blog/articles/event-drive-app-knative-eventing-kogito.md @@ -28,7 +28,7 @@ As part of the Serverless Workflow implementation, Kogito offers a Kubernetes Op To demonstrate how the Kogito workflow implementation works on Knative's event-driven architecture, we will use the [patient onboarding example](https://github.com/kiegroup/kogito-examples/tree/master/serverless-workflow-functions-events-quarkus). In this example, we simulate a workflow used in hospitals to onboard new patients and assign them to the correct doctor. -The following image taken from the [specification examples page](https://github.com/serverlessworkflow/specification/blob/master/examples/examples.md#New-Patient-Onboarding) illustrates this workflow: +The following image taken from the [specification examples page](https://github.com/serverlessworkflow/specification/tree/main/examples#New-Patient-Onboarding) illustrates this workflow:  *Patient Onboarding workflow representation* diff --git a/docs/eventing/event-registry.md b/docs/eventing/event-registry.md index 73fd25d81bf..38b7dd2c1a7 100644 --- a/docs/eventing/event-registry.md +++ b/docs/eventing/event-registry.md @@ -62,7 +62,7 @@ kubectl get eventtype dev.knative.source.github.push-34cnb -o yaml Omitting irrelevant fields: ```yaml -apiVersion: eventing.knative.dev/v1 +apiVersion: eventing.knative.dev/v1beta1 kind: EventType metadata: name: dev.knative.source.github.push-34cnb diff --git a/docs/eventing/samples/kafka/README.md b/docs/eventing/samples/kafka/README.md index a1038c0de48..b56c8ba2162 100644 --- a/docs/eventing/samples/kafka/README.md +++ b/docs/eventing/samples/kafka/README.md @@ -36,7 +36,7 @@ is to install it by using [Strimzi](https://strimzi.io). ``` 1. Describe the size of your Apache Kafka installation in `kafka.yaml`, like: ```yaml - apiVersion: kafka.strimzi.io/v1beta1 + apiVersion: kafka.strimzi.io/v1beta2 kind: Kafka metadata: name: my-cluster diff --git a/docs/eventing/samples/kafka/channel/README.md b/docs/eventing/samples/kafka/channel/README.md index bd0bbdf243e..f245739df90 100644 --- a/docs/eventing/samples/kafka/channel/README.md +++ b/docs/eventing/samples/kafka/channel/README.md @@ -96,6 +96,8 @@ with `knative-messaging-kafka`. This indicates it is an Apache Kafka channel from Knative. It contains the name of the namespace, `default` in this example, followed by the actual name of the channel. +**NOTE:** The topic of a Kafka channel is an implementation detail and records from it should not be consumed from different applications. + ## Configuring the Knative broker for Apache Kafka channels To setup a broker that will use the new default Kafka channels, you must create @@ -127,6 +129,8 @@ knative-messaging-kafka.default.default-kn2-trigger ... ``` +**NOTE:** The topic of a Kafka channel is an implementation detail and records from it should not be consumed from different applications. + ## Creating a service and trigger to use the Apache Kafka broker To use the Apache Kafka based broker, let's take a look at a simple demo. Use diff --git a/docs/eventing/samples/kafka/kafka.yaml b/docs/eventing/samples/kafka/kafka.yaml index 9188d7609af..c98cca5b14e 100644 --- a/docs/eventing/samples/kafka/kafka.yaml +++ b/docs/eventing/samples/kafka/kafka.yaml @@ -1,4 +1,4 @@ -apiVersion: kafka.strimzi.io/v1beta1 +apiVersion: kafka.strimzi.io/v1beta2 kind: Kafka metadata: name: my-cluster diff --git a/docs/eventing/sources/kafka-source/README.md b/docs/eventing/sources/kafka-source/README.md index 6fcbe7d6fb4..c05eda7082c 100644 --- a/docs/eventing/sources/kafka-source/README.md +++ b/docs/eventing/sources/kafka-source/README.md @@ -31,7 +31,7 @@ The `KafkaSource` reads all the messages, from all partitions, and sends those m - Replicas ```yaml - apiVersion: kafka.strimzi.io/v1beta1 + apiVersion: kafka.strimzi.io/v1beta2 kind: KafkaTopic metadata: name: knative-demo-topic diff --git a/docs/eventing/sources/kafka-source/kafka-topic.yaml b/docs/eventing/sources/kafka-source/kafka-topic.yaml index b7826a6ab3c..f09e63359b2 100644 --- a/docs/eventing/sources/kafka-source/kafka-topic.yaml +++ b/docs/eventing/sources/kafka-source/kafka-topic.yaml @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -apiVersion: kafka.strimzi.io/v1beta1 +apiVersion: kafka.strimzi.io/v1beta2 kind: KafkaTopic metadata: name: knative-demo-topic diff --git a/docs/getting-started/contributing/contributing.md b/docs/getting-started/contributing/contributing.md index 59ec83cf711..12606474af8 100644 --- a/docs/getting-started/contributing/contributing.md +++ b/docs/getting-started/contributing/contributing.md @@ -44,7 +44,8 @@ Once you have installed Material for MkDocs and all of the extensions, head over --8<-- "docs/snippets/links/main-docs-branch-link.md" and clone the repo. -In your terminal, find your way over to the location of the cloned repo. Once you are in the main folder (.../docs) and run: +In your terminal, find your way over to the location of the cloned repo. Once you are in the main folder and run: + === "Local Preview" ``` diff --git a/docs/reference/api/eventing/eventing.md b/docs/reference/api/eventing/eventing.md index 9257224f022..1b94c6c62f7 100644 --- a/docs/reference/api/eventing/eventing.md +++ b/docs/reference/api/eventing/eventing.md @@ -16,44 +16,29 @@ flows.knative.dev/v1
+
Package v1 is the v1 version of the API.
- +string alias)string alias)
(Appears on:DeliverySpec)
-+
BackoffPolicyType is the type for backoff policies
- ++
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers defining compatible resources to embed it. We will typically use this type to deserialize Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
- ++
DeliveryStatus contains the Status of an object supporting delivery options.
- ++
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 v1beta1 is the v1beta1 version of the API.
- +string alias)string alias)
(Appears on:DeliverySpec)
-+
BackoffPolicyType is the type for backoff policies
- ++
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers defining compatible resources to embed it. We will typically use this type to deserialize Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
- ++
DeliveryStatus contains the Status of an object supporting delivery options.
- ++
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.
- ++
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.
- ++
Trigger represents a request to have events delivered to a subscriber from a Broker’s event pool.
- +|
+(Optional)
Broker is Addressable. It exposes the endpoint as an URI to get events delivered into the Broker mesh. |
@@ -1703,8 +1690,8 @@ delivered into the Broker mesh.
map[string]string alias)map[string]string alias)
(Appears on:TriggerFilter)
-+
TriggerFilterAttributes is a map of context attribute names to values for filtering by equality. Only exact matches will pass the filter. You can use the value “ to indicate all strings match.
- +(Appears on:Trigger)
--
++
Package v1beta1 is the v1beta1 version of the 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.
- -| Field | -Description | -||||
|---|---|---|---|---|---|
-apiVersion-string |
-
-
-eventing.knative.dev/v1beta1
-
- |
-||||
-kind-string - |
-Broker |
-||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -BrokerSpec - - - |
-
- Spec defines the desired state of the Broker. -- -
|
-||||
-status- - -BrokerStatus - - - |
-
-(Optional)
- Status represents the current state of the Broker. This data may be out of -date. - |
-
+
EventType represents a type of event that can be consumed from a Broker.
- +-
Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.
+(Appears on:EventType) +
-apiVersion-string |
-
-
-eventing.knative.dev/v1beta1
-
+type+ +string + |
-||||||||
-kind-string + Type represents the CloudEvents type. It is authoritative. |
-Trigger |
||||||||
-metadata+ source- -Kubernetes meta/v1.ObjectMeta + +knative.dev/pkg/apis.URL |
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Source is a URI, it represents the CloudEvents source. |
||||||||
-spec+ schema- -TriggerSpec + +knative.dev/pkg/apis.URL |
- Spec defines the desired state of the Trigger. -- -
|
-||||||||
-status- - -TriggerStatus - - - |
-
-(Optional)
- Status represents the current state of the Trigger. This data may be out of -date. - |
-
-(Appears on:Broker) -
--
-| Field | -Description | -
|---|---|
-config- - -knative.dev/pkg/apis/duck/v1.KReference - - - |
-
-(Optional)
- Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap. - |
-
-delivery- - -DeliverySpec - +string |
(Optional)
- Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc. +Description is an optional field used to describe the EventType, in any meaningful way. |
-(Appears on:Broker) -
--
BrokerStatus represents the current state of a Broker.
+(Appears on:EventType) +EventTypeStatus represents the current state of a EventType.
+
-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. - |
-
Package v1 is the v1 version of the API.
+-(Appears on:EventType) -
--
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
+
-type- -string - - |
-
- Type represents the CloudEvents type. It is authoritative. - |
-|||||||||||||||
-source+ metadata- -knative.dev/pkg/apis.URL + +Kubernetes meta/v1.ObjectMeta |
(Optional)
- Source is a URI, it represents the CloudEvents source. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|||||||||||||||
-schema+ spec- -knative.dev/pkg/apis.URL + +ParallelSpec |
-(Optional)
- Schema is a URI, it represents the CloudEvents schemaurl extension attribute. -It may be a JSON schema, a protobuf schema, etc. It is optional. - |
-
-schemaData+ branches-string + +[]ParallelBranch + |
-(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. +Branches is the list of Filter/Subscribers pairs. |
-broker+ channelTemplate-string + +ChannelTemplateSpec + |
(Optional)
- TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType. +ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace). |
-description+ reply-string + +knative.dev/pkg/apis/duck/v1.Destination + |
(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. +Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply |
-(Appears on:EventType) -
--
EventTypeStatus represents the current state of a EventType.
- -| Field | -Description | +
|---|---|
-Status+ status- -knative.dev/pkg/apis/duck/v1.Status + +ParallelStatus |
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +(Optional) +Status represents the current state of the Parallel. This data may be out of +date. |
-(Appears on:TriggerSpec) -
-+(Appears on:ParallelSpec)
+
-attributes+ filter- -TriggerFilterAttributes + +knative.dev/pkg/apis/duck/v1.Destination |
(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. +Filter is the expression guarding the branch |
map[string]string alias)-(Appears on:TriggerFilter) -
--
TriggerFilterAttributes is a map of context attribute names to values for -filtering by equality. Only exact matches will pass the filter. You can use the value “ -to indicate all strings match.
- --(Appears on:Trigger) -
--
-| Field | -Description | -
|---|---|
-broker+ subscriber-string + +knative.dev/pkg/apis/duck/v1.Destination + |
-
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. - |
-
-filter- - -TriggerFilter - - - |
-
-(Optional)
- Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events. - |
-
-subscriber- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
- Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required. - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery contains the delivery spec for this specific trigger. - |
-
-(Appears on:Trigger) -
--
TriggerStatus represents the current state of a Trigger.
- -| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-subscriberUri- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- SubscriberURI is the resolved URI of the receiver for this Trigger. - |
-
-
Package v1 is the v1 version of the API.
- -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
- -| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec- - -ParallelSpec - - - |
-
- Spec defines the desired state of the Parallel. -- -
|
-||||||
-status- - -ParallelStatus - - - |
-
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. - |
-
-(Appears on:ParallelSpec) -
--
-| Field | -Description | -
|---|---|
-filter- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Filter is the expression guarding the branch - |
-
-subscriber- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
- Subscriber receiving the event when the filter passes - |
-
-reply- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Reply is a Reference to where the result of Subscriber of this case gets sent to. -If not specified, sent the result to the Parallel Reply - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. - |
-
-(Appears on:ParallelStatus) -
--
ParallelBranchStatus represents the current state of a Parallel branch
- -| Field | -Description | -
|---|---|
-filterSubscriptionStatus- - -ParallelSubscriptionStatus - - - |
-
- FilterSubscriptionStatus corresponds to the filter subscription status. - |
-
-filterChannelStatus- - -ParallelChannelStatus - - - |
-
- FilterChannelStatus corresponds to the filter channel status. - |
-
-subscriberSubscriptionStatus- - -ParallelSubscriptionStatus - - - |
-
- SubscriptionStatus corresponds to the subscriber subscription status. - |
-
-(Appears on:ParallelBranchStatus, ParallelStatus) -
--
-| Field | -Description | -
|---|---|
-channel- - -Kubernetes core/v1.ObjectReference - - - |
-
- Channel is the reference to the underlying channel. - |
-
-ready- -knative.dev/pkg/apis.Condition - - |
-
- ReadyCondition indicates whether the Channel is ready or not. - |
-
-(Appears on:Parallel) -
--
-| Field | -Description | -
|---|---|
-branches- - -[]ParallelBranch - - - |
-
- Branches is the list of Filter/Subscribers pairs. - |
-
-channelTemplate- - -ChannelTemplateSpec - - - |
-
-(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). - |
-
-reply- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply - |
-
-(Appears on:Parallel) -
--
ParallelStatus represents the current state of a Parallel.
- -| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-ingressChannelStatus- - -ParallelChannelStatus - - - |
-
- IngressChannelStatus corresponds to the ingress channel status. - |
-
-branchStatuses- - -[]ParallelBranchStatus - - - |
-
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. - |
-
-AddressStatus- - -knative.dev/pkg/apis/duck/v1.AddressStatus - - - |
-
-
-(Members of AddressStatus is the starting point to this Parallel. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-(Appears on:ParallelBranchStatus) -
--
-| Field | -Description | -
|---|---|
-subscription- - -Kubernetes core/v1.ObjectReference - - - |
-
- Subscription is the reference to the underlying Subscription. - |
-
-ready- -knative.dev/pkg/apis.Condition - - |
-
- ReadyCondition indicates whether the Subscription is ready or not. - |
-
-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
- -| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec- - -SequenceSpec - - - |
-
- Spec defines the desired state of the Sequence. -- -
|
-||||||
-status- - -SequenceStatus - - - |
-
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. - |
-
-(Appears on:SequenceStatus) -
--
-| Field | -Description | -
|---|---|
-channel- - -Kubernetes core/v1.ObjectReference - - - |
-
- Channel is the reference to the underlying channel. - |
-
-ready- -knative.dev/pkg/apis.Condition - - |
-
- ReadyCondition indicates whether the Channel is ready or not. - |
-
-(Appears on:Sequence) -
--
-| Field | -Description | -
|---|---|
-steps- - -[]SequenceStep - - - |
-
- Steps is the list of Destinations (processors / functions) that will be called in the order -provided. 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. - |
-
-(Appears on:Sequence) -
--
SequenceStatus represents the current state of a Sequence.
- -| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-subscriptionStatuses- - -[]SequenceSubscriptionStatus - - - |
-
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. - |
-
-channelStatuses- - -[]SequenceChannelStatus - - - |
-
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. - |
-
-AddressStatus- - -knative.dev/pkg/apis/duck/v1.AddressStatus - - - |
-
-
-(Members of AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-(Appears on:SequenceSpec) -
--
-| Field | -Description | -
|---|---|
-Destination- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-
-(Members of Subscriber receiving the step event - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. - |
-
-(Appears on:SequenceStatus) -
--
-| Field | -Description | -
|---|---|
-subscription- - -Kubernetes core/v1.ObjectReference - - - |
-
- Subscription is the reference to the underlying Subscription. - |
-
-ready- -knative.dev/pkg/apis.Condition - - |
-
- ReadyCondition indicates whether the Subscription is ready or not. - |
-
-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
- -| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec- - -ParallelSpec - - - |
-
- Spec defines the desired state of the Parallel. -- -
|
-||||||
-status- - -ParallelStatus - - - |
-
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. - |
-
-(Appears on:ParallelSpec) -
--
-| Field | -Description | -
|---|---|
-filter- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Filter is the expression guarding the branch - |
-
-subscriber- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
- Subscriber receiving the event when the filter passes - |
-
-reply- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Reply is a Reference to where the result of Subscriber of this case gets sent to. -If not specified, sent the result to the Parallel Reply - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. -Needed for Roundtripping v1alpha1 <-> v1beta1. - |
-
-(Appears on:ParallelStatus) -
--
ParallelBranchStatus represents the current state of a Parallel branch
- -| Field | -Description | -
|---|---|
-filterSubscriptionStatus- - -ParallelSubscriptionStatus - - - |
-
- FilterSubscriptionStatus corresponds to the filter subscription status. - |
-
-filterChannelStatus- - -ParallelChannelStatus - - - |
-
- FilterChannelStatus corresponds to the filter channel status. - |
-
-subscriberSubscriptionStatus- - -ParallelSubscriptionStatus - - - |
-
- SubscriptionStatus corresponds to the subscriber subscription status. - |
-
-(Appears on:ParallelBranchStatus, ParallelStatus) -
--
-| Field | -Description | -
|---|---|
-channel- - -Kubernetes core/v1.ObjectReference - - - |
-
- Channel is the reference to the underlying channel. - |
-
-ready- -knative.dev/pkg/apis.Condition - - |
-
- ReadyCondition indicates whether the Channel is ready or not. - |
-
-(Appears on:Parallel) -
--
-| Field | -Description | -
|---|---|
-branches- - -[]ParallelBranch - - - |
-
- Branches is the list of Filter/Subscribers pairs. - |
-
-channelTemplate- - -ChannelTemplateSpec - - - |
-
-(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). - |
-
-reply- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply - |
-
-(Appears on:Parallel) -
--
ParallelStatus represents the current state of a Parallel.
- -| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-ingressChannelStatus- - -ParallelChannelStatus - - - |
-
- IngressChannelStatus corresponds to the ingress channel status. - |
-
-branchStatuses- - -[]ParallelBranchStatus - - - |
-
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. - |
-
-AddressStatus- - -knative.dev/pkg/apis/duck/v1.AddressStatus - - - |
-
-
-(Members of AddressStatus is the starting point to this Parallel. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-(Appears on:ParallelBranchStatus) -
--
-| Field | -Description | -
|---|---|
-subscription- - -Kubernetes core/v1.ObjectReference - - - |
-
- Subscription is the reference to the underlying Subscription. - |
-
-ready- -knative.dev/pkg/apis.Condition - - |
-
- ReadyCondition indicates whether the Subscription is ready or not. - |
-
-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
- -| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec- - -SequenceSpec - - - |
-
- Spec defines the desired state of the Sequence. -- -
|
-||||||
-status- - -SequenceStatus - - - |
-
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. - |
-
-(Appears on:SequenceStatus) -
--
-| Field | -Description | -
|---|---|
-channel- - -Kubernetes core/v1.ObjectReference - - - |
-
- Channel is the reference to the underlying channel. - |
-
-ready- -knative.dev/pkg/apis.Condition - - |
-
- ReadyCondition indicates whether the Channel is ready or not. - |
-
-(Appears on:Sequence) -
--
-| Field | -Description | -
|---|---|
-steps- - -[]SequenceStep - - - |
-
- Steps is the list of Destinations (processors / functions) that will be called in the order -provided. 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. - |
-
-(Appears on:Sequence) -
--
SequenceStatus represents the current state of a Sequence.
- -| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-subscriptionStatuses- - -[]SequenceSubscriptionStatus - - - |
-
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. - |
-
-channelStatuses- - -[]SequenceChannelStatus - - - |
-
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. - |
-
-AddressStatus- - -knative.dev/pkg/apis/duck/v1.AddressStatus - - - |
-
-
-(Members of AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-(Appears on:SequenceSpec) -
--
-| Field | -Description | -
|---|---|
-Destination- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-
-(Members of Subscriber receiving the step event - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. - |
-
-(Appears on:SequenceStatus) -
--
-| Field | -Description | -
|---|---|
-subscription- - -Kubernetes core/v1.ObjectReference - - - |
-
- Subscription is the reference to the underlying Subscription. - |
-
-ready- -knative.dev/pkg/apis.Condition - - |
-
- ReadyCondition indicates whether the Subscription is ready or not. - |
-
-
Package v1 is the v1 version of the API.
- -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
- -| Field | -Description | -||||
|---|---|---|---|---|---|
-apiVersion-string |
-
-
-messaging.knative.dev/v1
-
- |
-||||
-kind-string - |
-Channel |
-||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -ChannelSpec - - - |
-
- Spec defines the desired state of the Channel. -- -
|
-||||
-status- - -ChannelStatus - - - |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
InMemoryChannel is a resource representing an in memory channel
- -| Field | -Description | -||
|---|---|---|---|
-apiVersion-string |
-
-
-messaging.knative.dev/v1
-
- |
-||
-kind-string - |
-InMemoryChannel |
-||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec- - -InMemoryChannelSpec - - - |
-
- Spec defines the desired state of the Channel. -- -
|
-||
-status- - -InMemoryChannelStatus - - - |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
- -| Field | -Description | -||||||||
|---|---|---|---|---|---|---|---|---|---|
-apiVersion-string |
-
-
-messaging.knative.dev/v1
-
- |
-||||||||
-kind-string - |
-Subscription |
-||||||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||
-spec- - -SubscriptionSpec - - - |
-
- - -
|
-||||||||
-status- - -SubscriptionStatus - - - |
-- | -
-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- --(Appears on:Channel) -
--
ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. -It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.
- -| Field | -Description | -
|---|---|
-channelTemplate- - -ChannelTemplateSpec - - - |
-
- ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. -This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user. - |
-
-ChannelableSpec- - -ChannelableSpec - - - |
-
-
-(Members of Channel conforms to ChannelableSpec - |
-
-(Appears on:Channel) -
--
ChannelStatus represents the current state of a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableStatus- - -ChannelableStatus - - - |
-
-
-(Members of Channel conforms to ChannelableStatus - |
-
-channel- - -knative.dev/pkg/apis/duck/v1.KReference - - - |
-
- Channel is an KReference to the Channel CRD backing this Channel. - |
-
-(Appears on:ParallelSpec, SequenceSpec, ChannelSpec) -
--
-| Field | -Description | -
|---|---|
-spec- -k8s.io/apimachinery/pkg/runtime.RawExtension - - |
-
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - |
-
-(Appears on:InMemoryChannel) -
--
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableSpec- - -ChannelableSpec - - - |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on:InMemoryChannel) -
--
ChannelStatus represents the current state of a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableStatus- - -ChannelableStatus - - - |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on:Subscription) -
--
SubscriptionSpec specifies the Channel for incoming events, a Subscriber target -for processing those events and where to put the result of the processing. Only -From (where the events are coming from) is always required. You can optionally -only Process the events (results in no output events) by leaving out the Result. -You can also perform an identity transformation on the incoming events by leaving -out the Subscriber and only specifying Result.
-The following are all valid specifications: -channel –[subscriber]–> reply -Sink, no outgoing events: -channel – subscriber -no-op function (identity transformation): -channel –> reply
- -| Field | -Description | -
|---|---|
-channel- - -Kubernetes core/v1.ObjectReference - - - |
-
- Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status. -This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.) - |
-
-subscriber- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply. - |
-
-reply- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery configuration - |
-
-(Appears on:Subscription) -
--
SubscriptionStatus (computed) for a subscription
- -| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-physicalSubscription- - -SubscriptionStatusPhysicalSubscription - - - |
-
- PhysicalSubscription is the fully resolved values that this Subscription represents. - |
-
-(Appears on:SubscriptionStatus) -
--
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
- -| Field | -Description | -
|---|---|
-subscriberUri- - -knative.dev/pkg/apis.URL - - - |
-
- SubscriberURI is the fully resolved URI for spec.subscriber. - |
-
-replyUri- - -knative.dev/pkg/apis.URL - - - |
-
- ReplyURI is the fully resolved URI for the spec.reply. - |
-
-deadLetterSinkUri- - -knative.dev/pkg/apis.URL - - - |
-
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. - |
-
-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
- -| Field | -Description | -||||
|---|---|---|---|---|---|
-apiVersion-string |
-
-
-messaging.knative.dev/v1beta1
-
- |
-||||
-kind-string - |
-Channel |
-||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -ChannelSpec - - - |
-
- Spec defines the desired state of the Channel. -- -
|
-||||
-status- - -ChannelStatus - - - |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
InMemoryChannel is a resource representing an in memory channel
- -| Field | -Description | -||
|---|---|---|---|
-apiVersion-string |
-
-
-messaging.knative.dev/v1beta1
-
- |
-||
-kind-string - |
-InMemoryChannel |
-||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec- - -InMemoryChannelSpec - - - |
-
- Spec defines the desired state of the Channel. -- -
|
-||
-status- - -InMemoryChannelStatus - - - |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
- -| Field | -Description | -||||||||
|---|---|---|---|---|---|---|---|---|---|
-apiVersion-string |
-
-
-messaging.knative.dev/v1beta1
-
- |
-||||||||
-kind-string - |
-Subscription |
-||||||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||
-spec- - -SubscriptionSpec - - - |
-
- - -
|
-||||||||
-status- - -SubscriptionStatus - - - |
-- | -
-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- --(Appears on:Channel) -
--
ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. -It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.
- -| Field | -Description | -
|---|---|
-channelTemplate- - -ChannelTemplateSpec - - - |
-
- ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. -This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user. - |
-
-ChannelableSpec- - -ChannelableSpec - - - |
-
-
-(Members of Channel conforms to ChannelableSpec - |
-
-(Appears on:Channel) -
--
ChannelStatus represents the current state of a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableStatus- - -ChannelableStatus - - - |
-
-
-(Members of Channel conforms to ChannelableStatus - |
-
-channel- - -knative.dev/pkg/apis/duck/v1.KReference - - - |
-
- Channel is an KReference to the Channel CRD backing this Channel. - |
-
-(Appears on:ParallelSpec, SequenceSpec, ChannelSpec) -
--
-| Field | -Description | -
|---|---|
-spec- -k8s.io/apimachinery/pkg/runtime.RawExtension - - |
-
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - |
-
-(Appears on:InMemoryChannel) -
--
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableSpec- - -ChannelableSpec - - - |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on:InMemoryChannel) -
--
ChannelStatus represents the current state of a Channel.
- -| Field | -Description | -
|---|---|
-ChannelableStatus- - -ChannelableStatus - - - |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on:Subscription) -
--
SubscriptionSpec specifies the Channel for incoming events, a Subscriber target -for processing those events and where to put the result of the processing. Only -From (where the events are coming from) is always required. You can optionally -only Process the events (results in no output events) by leaving out the Result. -You can also perform an identity transformation on the incoming events by leaving -out the Subscriber and only specifying Result.
-The following are all valid specifications: -channel –[subscriber]–> reply -Sink, no outgoing events: -channel – subscriber -no-op function (identity transformation): -channel –> reply
- -| Field | -Description | -
|---|---|
-channel- - -Kubernetes core/v1.ObjectReference - - - |
-
- Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status. -This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.) - |
-
-subscriber- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply. - |
-
-reply- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery configuration - |
-
-(Appears on:Subscription) -
--
SubscriptionStatus (computed) for a subscription
- -| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-physicalSubscription- - -SubscriptionStatusPhysicalSubscription - - - |
-
- PhysicalSubscription is the fully resolved values that this Subscription represents. - |
-
-(Appears on:SubscriptionStatus) -
--
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
- -| Field | -Description | -
|---|---|
-subscriberUri- - -knative.dev/pkg/apis.URL - - - |
-
- SubscriberURI is the fully resolved URI for spec.subscriber. - |
-
-replyUri- - -knative.dev/pkg/apis.URL - - - |
-
- ReplyURI is the fully resolved URI for the spec.reply. - |
-
-deadLetterSinkUri- - -knative.dev/pkg/apis.URL - - - |
-
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. - |
-
-
Package v1 contains API Schema definitions for the sources v1 API group.
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
- -| Field | -Description | -||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion-string |
-
-
-sources.knative.dev/v1
-
- |
-||||||||||
-kind-string - |
-ApiServerSource |
-||||||||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||
-spec- - -ApiServerSourceSpec - - - |
-
- - -
|
-||||||||||
-status- - -ApiServerSourceStatus - - - |
-- | -
-
ContainerSource is the Schema for the containersources API
- -| Field | -Description | -||||
|---|---|---|---|---|---|
-apiVersion-string |
-
-
-sources.knative.dev/v1
-
- |
-||||
-kind-string - |
-ContainerSource |
-||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -ContainerSourceSpec - - - |
-
- - -
|
-||||
-status- - -ContainerSourceStatus - - - |
-- | -
-
SinkBinding describes a Binding that is also a Source.
-The sink (from the Source duck) is resolved to a URL and
-then projected into the subject by augmenting the runtime
-contract of the referenced containers to have a K_SINK
-environment variable holding the endpoint to which to send
-cloud events.
| Field | -Description | -||||
|---|---|---|---|---|---|
-apiVersion-string |
-
-
-sources.knative.dev/v1
-
- |
-||||
-kind-string - |
-SinkBinding |
-||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -SinkBindingSpec - - - |
-
- - -
|
-||||
-status- - -SinkBindingStatus - - - |
-- | -
-(Appears on:ApiServerSourceSpec) -
--
APIVersionKind is an APIVersion and Kind tuple.
- -| Field | -Description | -
|---|---|
-apiVersion- -string - - |
-
- APIVersion - the API version of the resource to watch. - |
-
-kind- -string - - |
-
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - |
-
-(Appears on:ApiServerSourceSpec) -
--
APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
- -| Field | -Description | -
|---|---|
-apiVersion- -string - - |
-
- APIVersion - the API version of the resource to watch. - |
-
-kind- -string - - |
-
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - |
-
-selector- - -Kubernetes meta/v1.LabelSelector - - - |
-
-(Optional)
- LabelSelector filters this source to objects to those resources pass the -label selector. -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors - |
-
-(Appears on:ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
- -| Field | -Description | -
|---|---|
-SourceSpec- - -knative.dev/pkg/apis/duck/v1.SourceSpec - - - |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-resources- - -[]APIVersionKindSelector - - - |
-
- Resource are the resources this source will track and send related -lifecycle events from the Kubernetes ApiServer, with an optional label -selector to help filter. - |
-
-owner- - -APIVersionKind - - - |
-
-(Optional)
- ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter. - |
-
-mode- -string - - |
-
-(Optional)
- EventMode controls the format of the event.
- |
-
-serviceAccountName- -string - - |
-
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set. - |
-
-(Appears on:ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
- -| Field | -Description | -
|---|---|
-SourceStatus- - -knative.dev/pkg/apis/duck/v1.SourceStatus - - - |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-(Appears on:ContainerSource) -
--
ContainerSourceSpec defines the desired state of ContainerSource
- -| Field | -Description | -
|---|---|
-SourceSpec- - -knative.dev/pkg/apis/duck/v1.SourceSpec - - - |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-template- - -Kubernetes core/v1.PodTemplateSpec - - - |
-
- Template describes the pods that will be created - |
-
-(Appears on:ContainerSource) -
--
ContainerSourceStatus defines the observed state of ContainerSource
- -| Field | -Description | -
|---|---|
-SourceStatus- - -knative.dev/pkg/apis/duck/v1.SourceStatus - - - |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-(Appears on:SinkBinding) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
- -| Field | -Description | -
|---|---|
-SourceSpec- - -knative.dev/pkg/apis/duck/v1.SourceSpec - - - |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-BindingSpec- - -knative.dev/pkg/apis/duck/v1.BindingSpec - - - |
-
-
-(Members of inherits duck/v1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations. - |
-
-(Appears on:SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -| Field | -Description | -
|---|---|
-SourceStatus- - -knative.dev/pkg/apis/duck/v1.SourceStatus - - - |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
- -| Field | -Description | -|||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion-string |
-
-
-sources.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 - - - |
-
- - -
ParallelBranchStatus +++(Appears on:ParallelStatus) + +
+
+ParallelBranchStatus represents the current state of a Parallel branch +
FilterChannelStatus corresponds to the filter channel status. |
|||||||||||||||
-status+ subscriberSubscriptionStatus- -ApiServerSourceStatus + +ParallelSubscriptionStatus |
+ SubscriptionStatus corresponds to the subscriber subscription status. |
-
SinkBinding describes a Binding that is also a Source.
-The sink (from the Source duck) is resolved to a URL and
-then projected into the subject by augmenting the runtime
-contract of the referenced containers to have a K_SINK
-environment variable holding the endpoint to which to send
-cloud events.
-apiVersion-string |
-
-
-sources.knative.dev/v1alpha1
-
- |
-
-kind-string - |
-SinkBinding |
-
-metadata+ channel- -Kubernetes meta/v1.ObjectMeta + +Kubernetes core/v1.ObjectReference |
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Channel is the reference to the underlying channel. |
-spec+ ready- -SinkBindingSpec - +knative.dev/pkg/apis.Condition |
- - + ReadyCondition indicates whether the Channel is ready or not. + |
+
+(Appears on:Parallel) +
+| Field | +Description | +
|---|---|
-SourceSpec+ branches- -knative.dev/pkg/apis/duck/v1.SourceSpec + +[]ParallelBranch |
-
-(Members of Branches is the list of Filter/Subscribers pairs. |
-BindingSpec+ channelTemplate- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +ChannelTemplateSpec |
-
-(Members of |
-
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).
statusreplyReply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply
-(Appears on:ApiServerSourceSpec) -
--
ApiServerResource defines the resource to watch
+(Appears on:Parallel) +ParallelStatus represents the current state of a Parallel.
+
-apiVersion+ Status-string + +knative.dev/pkg/apis/duck/v1.Status + |
- API version of the resource to watch. +
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-kind+ ingressChannelStatus-string + +ParallelChannelStatus + |
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +IngressChannelStatus corresponds to the ingress channel status. |
-labelSelector+ branchStatuses- -Kubernetes meta/v1.LabelSelector + +[]ParallelBranchStatus |
- LabelSelector restricts this source to objects with the selected labels -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors +BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order. + |
+
+AddressStatus+ + +knative.dev/pkg/apis/duck/v1.AddressStatus + + + |
+
+
+(Members of AddressStatus is the starting point to this Parallel. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name} |
+(Appears on:ParallelBranchStatus) +
+| Field | +Description | +
|---|---|
-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. |
-(Appears on:ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
- +Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
+
-resources+ metadata- -[]ApiServerResource + +Kubernetes meta/v1.ObjectMeta |
- Resources is the list of resources to watch +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-serviceAccountName+ spec-string + +SequenceSpec + |
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. - |
-
-sink+ steps- -knative.dev/pkg/apis/duck/v1beta1.Destination + +[]SequenceStep |
-(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as 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 |
-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. 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. + |
+
modestatusMode 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 represents the current state of the Sequence. This data may be out of +date.
-(Appears on:ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
+(Appears on:SequenceStatus) +
-SourceStatus+ channel- -knative.dev/pkg/apis/duck/v1.SourceStatus + +Kubernetes core/v1.ObjectReference |
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. +Channel is the reference to the underlying channel. + |
+
+ready+ +knative.dev/pkg/apis.Condition + + |
+
+ ReadyCondition indicates whether the Channel is ready or not. |
-(Appears on:SinkBinding) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+(Appears on:Sequence) +
-SourceSpec+ steps- -knative.dev/pkg/apis/duck/v1.SourceSpec + +[]SequenceStep |
-
-(Members of Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options |
-BindingSpec+ channelTemplate- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +ChannelTemplateSpec |
-
-(Members of ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace). |
-(Appears on:SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -| Field | -Description | -
|---|---|
-SourceStatus+ reply- -knative.dev/pkg/apis/duck/v1.SourceStatus + +knative.dev/pkg/apis/duck/v1.Destination |
-
-(Members of Reply is a Reference to where the result of the last Subscriber gets sent to. |
-
Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+(Appears on:Sequence) +SequenceStatus represents the current state of a Sequence.
+
-apiVersion-string |
-
-
-sources.knative.dev/v1alpha2
-
+Status+ + +knative.dev/pkg/apis/duck/v1.Status + + |
-|||||||||||||||
-kind-string +
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-ApiServerSource |
|||||||||||||||
-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- -ApiServerSourceSpec + +[]SequenceChannelStatus |
- - -
SequenceStep +
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
+
| Field | +Description |
|---|---|
-resources+ Destination- -[]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. +
+(Members of Subscriber receiving the step event |
-owner+ delivery- -APIVersionKind + +DeliverySpec |
(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. +Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. |
+(Appears on:SequenceStatus) +
+
-mode- -string - - |
-
-(Optional)
- EventMode controls the format of the event.
- |
+Field | +Description |
|---|---|---|---|
-serviceAccountName+ subscription-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. - |
-
Subscription is the reference to the underlying Subscription.
+statusreadyReadyCondition indicates whether the Subscription is ready or not.
Package v1 is the v1 version of the API.
+-
ContainerSource is the Schema for the containersources API
- +Channel represents a generic Channel. It is normally used when we want a +Channel, but do not need a specific Channel implementation.
+
-sources.knative.dev/v1alpha2
+messaging.knative.dev/v1
|
ContainerSource |
+Channel |
|||||||
| @@ -7534,6 +3048,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -7542,46 +3057,46 @@ Refer to the Kubernetes API documentation for the fields of the
spec- -ContainerSourceSpec + +ChannelSpec |
+ Spec defines the desired state of the Channel.
|
status- -ContainerSourceStatus + +ChannelStatus |
+(Optional)
+ Status represents the current state of the Channel. This data may be out +of date. |
-
PingSource is the Schema for the PingSources API.
- +InMemoryChannel is a resource representing an in memory channel
+
-sources.knative.dev/v1alpha2
+messaging.knative.dev/v1
|
PingSource |
+InMemoryChannel |
|||||||||
| @@ -7641,6 +3159,7 @@ Kubernetes meta/v1.ObjectMeta |
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -7649,59 +3168,30 @@ Refer to the Kubernetes API documentation for the fields of the
spec- -PingSourceSpec + +InMemoryChannelSpec |
+ Spec defines the desired state of the Channel.
|
status- -PingSourceStatus + +InMemoryChannelStatus |
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. |
-
SinkBinding describes a Binding that is also a Source.
-The sink (from the Source duck) is resolved to a URL and
-then projected into the subject by augmenting the runtime
-contract of the referenced containers to have a K_SINK
-environment variable holding the endpoint to which to send
-cloud events.
Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
+
-sources.knative.dev/v1alpha2
+messaging.knative.dev/v1
|
SinkBinding |
+Subscription |
|||
| @@ -7774,8 +3263,8 @@ Refer to the Kubernetes API documentation for the fields of the |
spec- -SinkBindingSpec + +SubscriptionSpec |
@@ -7785,165 +3274,109 @@ SinkBindingSpec
-SourceSpec+ channel- -knative.dev/pkg/apis/duck/v1.SourceSpec + +Kubernetes core/v1.ObjectReference |
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. +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.) |
-BindingSpec+ subscriber- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +knative.dev/pkg/apis/duck/v1.Destination |
-
-(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations. - |
-
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.
statusreply-(Appears on:ApiServerSourceSpec, ApiServerSourceSpec) -
--
APIVersionKind is an APIVersion and Kind tuple.
- -| Field | -Description | -
|---|---|
-apiVersion- -string - - |
-
- APIVersion - the API version of the resource to watch. - |
-
-kind- -string - - |
-
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - |
-
-(Appears on:ApiServerSourceSpec) -
--
APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
- -| Field | -Description | -
|---|---|
-apiVersion- -string - - |
-
- APIVersion - the API version of the resource to watch. +(Optional) +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-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 configuration + |
+
selectorstatusLabelSelector 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
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+-(Appears on:ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
+(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.
+|
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. +(Optional) +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. |
|
-resources+ ChannelableSpec- -[]APIVersionKindSelector + +ChannelableSpec |
- 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. +
+(Members of Channel conforms to ChannelableSpec |
+(Appears on:Channel) +
+ChannelStatus represents the current state of a Channel.
+
-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. - |
+Field | +Description |
|---|---|---|---|
-mode+ ChannelableStatus-string + +ChannelableStatus + |
-(Optional)
- EventMode controls the format of the event.
-
+(Members of Channel conforms to ChannelableStatus |
||
-serviceAccountName+ channel-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. +Channel is an KReference to the Channel CRD backing this Channel. |
-(Appears on:ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
+(Appears on:ParallelSpec, SequenceSpec, ChannelSpec) +
-SourceStatus+ spec- -knative.dev/pkg/apis/duck/v1.SourceStatus - +k8s.io/apimachinery/pkg/runtime.RawExtension |
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. +(Optional) +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
-(Appears on:ContainerSource) -
--
ContainerSourceSpec defines the desired state of ContainerSource
+(Appears on:InMemoryChannel) +InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
+
-SourceSpec+ ChannelableSpec- -knative.dev/pkg/apis/duck/v1.SourceSpec + +ChannelableSpec |
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-template- - -Kubernetes core/v1.PodTemplateSpec - - - |
-
- Template describes the pods that will be created +Channel conforms to Duck type Channelable. |
-(Appears on:ContainerSource) -
--
ContainerSourceStatus defines the observed state of ContainerSource
+(Appears on:InMemoryChannel) +ChannelStatus represents the current state of a Channel.
+
-SourceStatus+ ChannelableStatus- -knative.dev/pkg/apis/duck/v1.SourceStatus + +ChannelableStatus |
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. +Channel conforms to Duck type Channelable. |
-(Appears on:PingSource) -
--
PingSourceSpec defines the desired state of the PingSource.
+(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
+
-SourceSpec+ channel- -knative.dev/pkg/apis/duck/v1.SourceSpec + +Kubernetes core/v1.ObjectReference |
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. +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.) |
-schedule+ subscriber-string + +knative.dev/pkg/apis/duck/v1.Destination + + + |
+
+(Optional)
+ Subscriber is reference to (optional) function for processing events. +Events from the Channel will be delivered here and replies are +sent to a Destination as specified by the Reply. + |
+
+reply+ + +knative.dev/pkg/apis/duck/v1.Destination + |
(Optional)
- Schedule is the cronjob schedule. Defaults to Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
-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 configuration |
-(Appears on:PingSource) -
--
PingSourceStatus defines the observed state of PingSource.
+(Appears on:Subscription) +SubscriptionStatus (computed) for a subscription
+
-SourceStatus+ Status- -knative.dev/pkg/apis/duck/v1.SourceStatus + +knative.dev/pkg/apis/duck/v1.Status |
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. +inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+physicalSubscription+ + +SubscriptionStatusPhysicalSubscription + + + |
+
+ PhysicalSubscription is the fully resolved values that this Subscription represents. |
-(Appears on:SinkBinding) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+(Appears on:SubscriptionStatus) +SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
+
-SourceSpec+ subscriberUri- -knative.dev/pkg/apis/duck/v1.SourceSpec + +knative.dev/pkg/apis.URL |
-
-(Members of 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) +SubscriberURI is the fully resolved URI for spec.subscriber. |
-BindingSpec+ replyUri- -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec + +knative.dev/pkg/apis.URL |
-
-(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations. +(Optional) +ReplyURI is the fully resolved URI for the spec.reply. |
-(Appears on:SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -| Field | -Description | -
|---|---|
-SourceStatus+ deadLetterSinkUri- -knative.dev/pkg/apis/duck/v1.SourceStatus + +knative.dev/pkg/apis.URL |
-
-(Members of 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) +ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. |
-
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.
- +Package v1 contains API Schema definitions for the sources v1 API group.
++
ApiServerSource is the Schema for the apiserversources API
- +
-sources.knative.dev/v1beta1
+sources.knative.dev/v1
|
spec- + ApiServerSourceSpec @@ -8460,7 +3878,7 @@ and modifications of the event sent to the sink. |
resources- + []APIVersionKindSelector @@ -8475,7 +3893,7 @@ selector to help filter. |
owner- + APIVersionKind @@ -8522,7 +3940,7 @@ source. Defaults to default if not set. |
status- + ApiServerSourceStatus @@ -8532,11 +3950,11 @@ ApiServerSourceStatus |
+
ContainerSource is the Schema for the containersources API
- +
-sources.knative.dev/v1beta1
+sources.knative.dev/v1
|
spec- + ContainerSourceSpec @@ -8629,7 +4047,7 @@ Kubernetes core/v1.PodTemplateSpec |
status- + ContainerSourceStatus @@ -8639,11 +4057,11 @@ ContainerSourceStatus |
+
PingSource is the Schema for the PingSources API.
- +
-sources.knative.dev/v1beta1
+sources.knative.dev/v1
|
spec- + PingSourceSpec @@ -8725,7 +4143,7 @@ string |
(Optional)
- Schedule is the cronjob schedule. Defaults to Schedule is the cron schedule. Defaults to |
+
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.
-sources.knative.dev/v1beta1
+sources.knative.dev/v1
|
spec- + SinkBindingSpec @@ -8859,8 +4301,8 @@ and modifications of the event sent to the sink. |
BindingSpec- -knative.dev/pkg/apis/duck/v1beta1.BindingSpec + +knative.dev/pkg/apis/duck/v1.BindingSpec |
@@ -8868,7 +4310,7 @@ knative.dev/pkg/apis/duck/v1beta1.BindingSpec
status- + SinkBindingStatus @@ -8890,14 +4332,14 @@ SinkBindingStatus |
-(Appears on:ApiServerSourceSpec) +(Appears on:ApiServerSourceSpec)
-+
APIVersionKind is an APIVersion and Kind tuple.
- +
resources- + []APIVersionKindSelector @@ -9043,7 +4485,7 @@ selector to help filter. |
owner- + APIVersionKind @@ -9085,14 +4527,14 @@ source. Defaults to default if not set. |
-(Appears on:ApiServerSource) +(Appears on:ApiServerSource)
-+
ApiServerSourceStatus defines the observed state of ApiServerSource
- +-(Appears on:ContainerSource) +(Appears on:ContainerSource)
-+
ContainerSourceSpec defines the desired state of ContainerSource
- +-(Appears on:ContainerSource) +(Appears on:ContainerSource)
-+
ContainerSourceStatus defines the observed state of ContainerSource
- +-(Appears on:PingSource) +(Appears on:PingSource)
-+
PingSourceSpec defines the desired state of the PingSource.
- +|
(Optional)
- Schedule is the cronjob schedule. Defaults to Schedule is the cron schedule. Defaults to |
-(Appears on:SinkBinding) +(Appears on:SinkBinding)
-+
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
- +
BindingSpec- -knative.dev/pkg/apis/duck/v1beta1.BindingSpec + +knative.dev/pkg/apis/duck/v1.BindingSpec |
@@ -9383,21 +4849,21 @@ knative.dev/pkg/apis/duck/v1beta1.BindingSpec
-(Appears on:SinkBinding) +(Appears on:SinkBinding)
-+
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- ++
Package v1beta2 contains API Schema definitions for the sources v1beta2 API group.
- ++
PingSource is the Schema for the PingSources API.
- ++
Metric represents a resource to configure the metric collector with.
- ++
PodScalable is a duck type that the resources referenced by the
PodAutoscaler’s ScaleTargetRef must implement. They must also
implement the /scale sub-resource for use with /scale based
implementations (e.g. HPA), but this further constrains the shape
the referenced resources may take.
string alias)string alias)
(Appears on:PodAutoscalerSpec)
-+
ReachabilityType is the enumeration type for the different states of reachability
to the ScaleTarget of a PodAutoscaler
+
Package v1 contains the Serving v1 API types.
- ++
Configuration represents the “floating HEAD” of a linear history of Revisions. Users create new Revisions by updating the Configuration’s spec. The “latest created” revision’s name is available under status, as is the “latest ready” revision’s name. See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration
- ++
Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration.
See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#revision
- ++
Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for “latest ready revision” changes, and smoothly rolling out latest revisions. See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#route
- ++
Service acts as a top-level container that manages a Route and Configuration which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which @@ -1047,7 +1047,7 @@ orchestrates ReplicaSets), and its usage is optional but recommended.
The Service’s controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own.
See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#service
- +string alias)
+(string alias)
+
RoutingState represents states of a revision with regards to serving a route.
- ++
Package v1alpha1 contains the v1alpha1 versions of the serving apis. Api versions allow the api contract for a resource to be changed while keeping backward compatibility by support multiple concurrent versions of the same resource
- ++
DomainMapping is a mapping from a custom hostname to an Addressable.
- +