From b3522617a766eff8b91bad8161877fb9b37b184d Mon Sep 17 00:00:00 2001
From: RichieEscarez Packages:
- Package v1beta1 contains API Schema definitions for the sources v1beta1 API group
-
-sources.knative.dev/v1beta1
-
-(Appears on: -KafkaResourceSpec) -
--
-Field | -Description | -
---|---|
-cpu
-
-string
-
- |
-- | -
-memory
-
-string
-
- |
-- | -
-(Appears on: -KafkaResourceSpec) -
--
-Field | -Description | -
---|---|
-cpu
-
-string
-
- |
-- | -
-memory
-
-string
-
- |
-- | -
-
-Field | -Description | -
---|---|
-requests
-
-
-KafkaRequestsSpec
-
-
- |
-- | -
-limits
-
-
-KafkaLimitsSpec
-
-
- |
-- | -
-
KafkaSource is the Schema for the kafkasources API.
- -Field | -Description | -||||||||
---|---|---|---|---|---|---|---|---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||
-spec
-
-
-KafkaSourceSpec
-
-
- |
-
- - -
|
-||||||||
-status
-
-
-KafkaSourceStatus
-
-
- |
-- | -
-(Appears on: -KafkaSource) -
--
KafkaSourceSpec defines the desired state of the KafkaSource.
- -Field | -Description | -
---|---|
-KafkaAuthSpec
-
-
-KafkaAuthSpec
-
-
- |
-
-
-(Members of |
-
-topics
-
-[]string
-
- |
-
- Topic topics to consume messages from - |
-
-consumerGroup
-
-string
-
- |
-
-(Optional)
- ConsumerGroupID is the consumer group ID. - |
-
-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. - |
-
-(Appears on: -KafkaSource) -
--
KafkaSourceStatus defines the observed state of KafkaSource.
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: --
KafkaChannel is a resource representing a Kafka Channel.
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1alpha1
-
- |
-||||||
-kind
-string
- |
-KafkaChannel |
-||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec
-
-
-KafkaChannelSpec
-
-
- |
-
- Spec defines the desired state of the Channel. -- -
|
-||||||
-status
-
-
-KafkaChannelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the KafkaChannel. This data may be out of -date. - |
-
-(Appears on: -KafkaChannel) -
--
KafkaChannelSpec defines the specification for a KafkaChannel.
- -Field | -Description | -
---|---|
-numPartitions
-
-int32
-
- |
-
- NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1. - |
-
-replicationFactor
-
-int16
-
- |
-
- ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1. - |
-
-subscribable
-
-knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
-
- |
-
- KafkaChannel conforms to Duck type Subscribable. - |
-
-(Appears on: -KafkaChannel) -
--
KafkaChannelStatus represents the current state of a KafkaChannel.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-AddressStatus
-
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
-
- |
-
-
-(Members of KafkaChannel is Addressable. It currently exposes the endpoint as a -fully-qualified DNS name which will distribute traffic over the -provided targets from inside the cluster. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-SubscribableTypeStatus
-
-knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
-
- |
-
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. - |
-
-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: --
KafkaChannel is a resource representing a Kafka Channel.
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
- |
-||||||
-kind
-string
- |
-KafkaChannel |
-||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec
-
-
-KafkaChannelSpec
-
-
- |
-
- Spec defines the desired state of the Channel. -- -
|
-||||||
-status
-
-
-KafkaChannelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the KafkaChannel. This data may be out of -date. - |
-
-(Appears on: -KafkaChannel) -
--
KafkaChannelSpec defines the specification for a KafkaChannel.
- -Field | -Description | -
---|---|
-numPartitions
-
-int32
-
- |
-
- NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1. - |
-
-replicationFactor
-
-int16
-
- |
-
- ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1. - |
-
-ChannelableSpec
-
-knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on: -KafkaChannel) -
--
KafkaChannelStatus represents the current state of a KafkaChannel.
- -Field | -Description | -
---|---|
-ChannelableStatus
-
-knative.dev/eventing/pkg/apis/duck/v1.ChannelableStatus
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
- -Resource Types: --(Appears on: -KafkaBindingSpec, -KafkaSourceSpec) -
--
-Field | -Description | -
---|---|
-bootstrapServers
-
-[]string
-
- |
-
- Bootstrap servers are the Kafka servers the consumer will connect to. - |
-
-net
-
-
-KafkaNetSpec
-
-
- |
-- | -
-
KafkaBinding is the Schema for the kafkasources API.
- -Field | -Description | -||||
---|---|---|---|---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-KafkaBindingSpec
-
-
- |
-
- - -
|
-||||
-status
-
-
-KafkaBindingStatus
-
-
- |
-- | -
-(Appears on: -KafkaBinding) -
--
KafkaBindingSpec defines the desired state of the KafkaBinding.
- -Field | -Description | -
---|---|
-BindingSpec
-
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
-
- |
-
-
-(Members of |
-
-KafkaAuthSpec
-
-
-KafkaAuthSpec
-
-
- |
-
-
-(Members of |
-
-(Appears on: -KafkaBinding) -
--
KafkaBindingStatus defines the observed state of KafkaBinding.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of |
-
-(Appears on: -KafkaAuthSpec) -
--
-Field | -Description | -
---|---|
-sasl
-
-
-KafkaSASLSpec
-
-
- |
-- | -
-tls
-
-
-KafkaTLSSpec
-
-
- |
-- | -
-(Appears on: -KafkaNetSpec) -
--
-Field | -Description | -
---|---|
-enable
-
-bool
-
- |
-- | -
-user
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- User is the Kubernetes secret containing the SASL username. - |
-
-password
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- Password is the Kubernetes secret containing the SASL password. - |
-
-(Appears on: -KafkaNetSpec) -
--
-Field | -Description | -
---|---|
-enable
-
-bool
-
- |
-- | -
-cert
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- Cert is the Kubernetes secret containing the client certificate. - |
-
-key
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- Key is the Kubernetes secret containing the client key. - |
-
-caCert
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- CACert is the Kubernetes secret containing the server CA cert. - |
-
-(Appears on: -KafkaSASLSpec, -KafkaTLSSpec) -
--
SecretValueFromSource represents the source of a secret value
- -Field | -Description | -
---|---|
-secretKeyRef
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
- The Secret key to select from. - |
-
-
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group
- -Resource Types: --(Appears on: -KafkaBindingSpec, -KafkaSourceSpec) -
--
-Field | -Description | -
---|---|
-bootstrapServers
-
-[]string
-
- |
-
- Bootstrap servers are the Kafka servers the consumer will connect to. - |
-
-net
-
-
-KafkaNetSpec
-
-
- |
-- | -
-
KafkaBinding is the Schema for the kafkasources API.
- -Field | -Description | -||||
---|---|---|---|---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-KafkaBindingSpec
-
-
- |
-
- - -
|
-||||
-status
-
-
-KafkaBindingStatus
-
-
- |
-- | -
-(Appears on: -KafkaBinding) -
--
KafkaBindingSpec defines the desired state of the KafkaBinding.
- -Field | -Description | -
---|---|
-BindingSpec
-
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
-
- |
-
-
-(Members of |
-
-KafkaAuthSpec
-
-
-KafkaAuthSpec
-
-
- |
-
-
-(Members of |
-
-(Appears on: -KafkaBinding) -
--
KafkaBindingStatus defines the observed state of KafkaBinding.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of |
-
-(Appears on: -KafkaAuthSpec) -
--
-Field | -Description | -
---|---|
-sasl
-
-
-KafkaSASLSpec
-
-
- |
-- | -
-tls
-
-
-KafkaTLSSpec
-
-
- |
-- | -
-(Appears on: -KafkaNetSpec) -
--
-Field | -Description | -
---|---|
-enable
-
-bool
-
- |
-- | -
-user
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- User is the Kubernetes secret containing the SASL username. - |
-
-password
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- Password is the Kubernetes secret containing the SASL password. - |
-
-(Appears on: -KafkaNetSpec) -
--
-Field | -Description | -
---|---|
-enable
-
-bool
-
- |
-- | -
-cert
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- Cert is the Kubernetes secret containing the client certificate. - |
-
-key
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- Key is the Kubernetes secret containing the client key. - |
-
-caCert
-
-
-SecretValueFromSource
-
-
- |
-
-(Optional)
- CACert is the Kubernetes secret containing the server CA cert. - |
-
-(Appears on: -KafkaSASLSpec, -KafkaTLSSpec) -
--
SecretValueFromSource represents the source of a secret value
- -Field | -Description | -
---|---|
-secretKeyRef
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
- The Secret key to select from. - |
-
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
- -Resource Types: --(Appears on: -KafkaResourceSpec) -
--
-Field | -Description | -
---|---|
-cpu
-
-string
-
- |
-- | -
-memory
-
-string
-
- |
-- | -
-(Appears on: -KafkaResourceSpec) -
--
-Field | -Description | -
---|---|
-cpu
-
-string
-
- |
-- | -
-memory
-
-string
-
- |
-- | -
-(Appears on: -KafkaSourceSpec) -
--
-Field | -Description | -
---|---|
-requests
-
-
-KafkaRequestsSpec
-
-
- |
-- | -
-limits
-
-
-KafkaLimitsSpec
-
-
- |
-- | -
-
KafkaSource is the Schema for the kafkasources API.
- -Field | -Description | -||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||||
-spec
-
-
-KafkaSourceSpec
-
-
- |
-
- - -
|
-||||||||||||
-status
-
-
-KafkaSourceStatus
-
-
- |
-- | -
-(Appears on: -KafkaSource) -
--
KafkaSourceSpec defines the desired state of the KafkaSource.
- -Field | -Description | -
---|---|
-KafkaAuthSpec
-
-
-KafkaAuthSpec
-
-
- |
-
-
-(Members of |
-
-topics
-
-[]string
-
- |
-
- Topic topics to consume messages from - |
-
-consumerGroup
-
-string
-
- |
-
-(Optional)
- ConsumerGroupID is the consumer group ID. - |
-
-sink
-
-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. - |
-
-serviceAccountName
-
-string
-
- |
-
- ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. -Deprecated: v1beta1 drops this field. - |
-
-resources
-
-
-KafkaResourceSpec
-
-
- |
-
- Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field. - |
-
-(Appears on: -KafkaSource) -
--
KafkaSourceStatus defines the observed state of KafkaSource.
- -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. - |
-
-Generated with gen-crd-api-reference-docs
-on git commit ef8b78ed
.
-
Packages:
-
Package v1 is the v1 version of the API.
+Package v1beta1 is the v1beta1 version of the API.
Resource Types:string
alias)(Appears on: -DeliverySpec) +DeliverySpec)
BackoffPolicyType is the type for backoff policies
-
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers @@ -74,7 +77,7 @@ Channelable ObjectReferences and access their subscription and address data. Th
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -88,7 +91,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ChannelableSpec
@@ -102,7 +105,7 @@ ChannelableSpec
SubscribableSpec
-
+
SubscribableSpec
@@ -117,7 +120,7 @@ SubscribableSpec
delivery
-
+
DeliverySpec
@@ -134,7 +137,7 @@ DeliverySpec
status
-
+
ChannelableStatus
@@ -144,13 +147,13 @@ ChannelableStatus
-(Appears on: -ChannelSpec, -Channelable, -InMemoryChannelSpec) +ChannelSpec, +Channelable, +InMemoryChannelSpec)
ChannelableSpec contains Spec of the Channelable object
@@ -167,7 +170,7 @@ ChannelableStatusSubscribableSpec
-
+
SubscribableSpec
@@ -182,7 +185,7 @@ SubscribableSpec
delivery
-
+
DeliverySpec
@@ -194,13 +197,13 @@ DeliverySpec
-(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) +ChannelStatus, +Channelable, +InMemoryChannelStatus)
ChannelableStatus contains the Status of a Channelable object.
@@ -247,7 +250,7 @@ knative.dev/pkg/apis/duck/v1.AddressStatusSubscribableStatus
-
+
SubscribableStatus
@@ -274,16 +277,19 @@ Failed messages are delivered here.
-(Appears on: -BrokerSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriptionSpec) +BrokerSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, +SubscriberSpec, +SubscriptionSpec)
DeliverySpec contains the delivery options for event senders, @@ -327,7 +333,7 @@ sending an event before moving it to the dead letter sink.
backoffPolicy
-
+
BackoffPolicyType
@@ -350,13 +356,13 @@ string
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 the time interval between retries.
-For exponential policy , backoff delay is backoffDelay*2^
For linear policy, backoff delay is backoffDelay*
DeliveryStatus contains the Status of an object supporting delivery options.
@@ -384,7 +390,7 @@ where failed events are sent to. -
Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers @@ -403,7 +409,7 @@ SubscribableType ObjectReferences and access the Subscription data. This is not
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -417,7 +423,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
SubscribableSpec
@@ -432,7 +438,7 @@ configured as to be compatible with Subscribable contract.
subscribers
-
+
[]SubscriberSpec
@@ -448,7 +454,7 @@ configured as to be compatible with Subscribable contract.
status
-
+
SubscribableStatus
@@ -460,12 +466,13 @@ configured as to be compatible with Subscribable contract.
-(Appears on: -ChannelableSpec, -Subscribable) +ChannelableCombinedSpec, +ChannelableSpec, +Subscribable)
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
@@ -482,7 +489,7 @@ configured as to be compatible with Subscribable contract.subscribers
-
+
[]SubscriberSpec
@@ -493,12 +500,13 @@ configured as to be compatible with Subscribable contract.
-(Appears on: -ChannelableStatus, -Subscribable) +ChannelableCombinedStatus, +ChannelableStatus, +Subscribable)
SubscribableStatus is the schema for the subscribable’s status portion of the status @@ -516,7 +524,7 @@ section of the resource.
subscribers
-
+
[]SubscriberStatus
@@ -527,11 +535,11 @@ section of the resource.
-(Appears on: -SubscribableSpec) +SubscribableSpec)
SubscriberSpec defines a single subscriber to a Subscribable.
@@ -597,7 +605,7 @@ knative.dev/pkg/apis.URLdelivery
-
+
DeliverySpec
@@ -609,11 +617,12 @@ DeliverySpec
-(Appears on: -SubscribableStatus) +SubscribableStatus, +SubscribableStatus)
SubscriberStatus defines the status of a single subscriber to a Channel.
@@ -654,7 +663,7 @@ int64ready
-
+
Kubernetes core/v1.ConditionStatus
@@ -678,27 +687,24 @@ string
-
Package v1beta1 is the v1beta1 version of the API.
+Package v1 is the v1 version of the API.
Resource Types: -string
alias)-(Appears on: -DeliverySpec) -
--
BackoffPolicyType is the type for backoff policies
- --
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
+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.
+apiVersion
+string |
+
+
+eventing.knative.dev/v1
+
+ |
+||||||||
+kind
+string
+ |
+Broker |
+||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -726,43 +750,43 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ChannelableSpec
+
+BrokerSpec
|
- Spec is the part where the Channelable fulfills the Subscribable contract. +Spec defines the desired state of the Broker.
|
status
-
-ChannelableStatus
+
+BrokerStatus
|
+(Optional)
+ Status represents the current state of the Broker. This data may be out of +date. |
-(Appears on: -ChannelSpec, -Channelable, -InMemoryChannelSpec) -
--
ChannelableSpec contains Spec of the Channelable object
+Trigger represents a request to have events delivered to a subscriber from a +Broker’s event pool.
-SubscribableSpec
-
-
-SubscribableSpec
-
-
+apiVersion
+string |
+
+
+eventing.knative.dev/v1
+
|
+
-
-(Members of kind
+string
|
+Trigger |
-delivery
+metadata
-
-DeliverySpec
+
+Kubernetes meta/v1.ObjectMeta
|
(Optional)
- DeliverySpec contains options controlling the event delivery +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) -
--
ChannelableStatus contains the Status of a Channelable object.
- -Field | -Description | -
---|---|
-Status
+spec
-knative.dev/pkg/apis/duck/v1.Status
+
+TriggerSpec
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-AddressStatus
+broker
-knative.dev/pkg/apis/duck/v1.AddressStatus
+string
|
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +Broker is the broker that this trigger receives events from. |
-SubscribableStatus
+filter
-
-SubscribableStatus
+
+TriggerFilter
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +(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. |
-deadLetterChannel
+subscriber
-knative.dev/pkg/apis/duck/v1.KReference
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required. + |
+
status
+
+
+TriggerStatus
+
DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel -Failed messages are delivered here.
+Status represents the current state of the Trigger. This data may be out of +date.
(Appears on: -BrokerSpec, -ChannelableCombinedSpec, -ChannelableSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriberSpec, -SubscriptionSpec) +Broker)
-
DeliverySpec contains the delivery options for event senders, -such as channelable and source.
-deadLetterSink
+config
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.KReference
|
(Optional)
- DeadLetterSink is the sink receiving event that could not be sent to -a destination. +Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap. |
-retry
+delivery
-int32
+
+DeliverySpec
+
|
(Optional)
- Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink. +Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc. |
+(Appears on: +Broker) +
++
BrokerStatus represents the current state of a Broker.
+ +Field | +Description | +
---|---|
-backoffPolicy
+Status
-
-BackoffPolicyType
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- BackoffPolicy is the retry backoff policy (linear, exponential). +
+(Members of 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. |
-backoffDelay
+address
-string
+knative.dev/pkg/apis/duck/v1.Addressable
|
-(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 the time interval between retries.
-For exponential policy , backoff delay is backoffDelay*2^ Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh. |
-
DeliveryStatus contains the Status of an object supporting delivery options.
+(Appears on: +TriggerSpec) + +
-deadLetterChannel
+attributes
-knative.dev/pkg/apis/duck/v1.KReference
+
+TriggerFilterAttributes
+
|
(Optional)
- DeadLetterChannel is a KReference that is the reference to the native, platform specific channel -where failed events are sent to. +Attributes filters events by exact match on event context attributes. +Each key in the map is compared with the equivalent key in the event +context. An event passes the filter if all values are equal to the +specified values. +Nested context attributes are not supported as keys. Only string values are supported. |
map[string]string
alias)+(Appears on: +TriggerFilter) +
++
TriggerFilterAttributes is a map of context attribute names to values for +filtering by equality. Only exact matches will pass the filter. You can use the value “ +to indicate all strings match.
+ +-
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.
+(Appears on: +Trigger) + +
-metadata
+broker
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Broker is the broker that this trigger receives events from. |
||
-spec
-
-
-SubscribableSpec
-
-
- |
-
- SubscribableSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. -- -
Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events. |
||
-status
+subscriber
-
-SubscribableStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- SubscribableStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. +Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required. |
(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -Subscribable) +Trigger)
-
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
+TriggerStatus represents the current state of a Trigger.
-subscribers
+Status
-
-[]SubscriberSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
- This is the list of subscriptions for this subscribable. - |
-
-(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -Subscribable) -
-
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
+(Members ofStatus
are embedded into this type.)
-Field | -Description | +
---|---|
-subscribers
+subscriberUri
-
-[]SubscriberStatus
-
+knative.dev/pkg/apis.URL
|
- This is the list of subscription’s statuses for this channel. +SubscriberURI is the resolved URI of the receiver for this Trigger. |
-(Appears on: -SubscribableSpec) +
Package v1beta1 is the v1beta1 version of the API.
+Resource Types: +-
SubscriberSpec defines a single subscriber to a Subscribable.
-At least one of SubscriberURI and ReplyURI must be present
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
-uid
+metadata
-k8s.io/apimachinery/pkg/types.UID
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
- UID is used to understand the origin of the subscriber. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-generation
+spec
-int64
+
+ParallelSpec
+
|
-(Optional)
- Generation of the origin of the subscriber with uid:UID. +Spec defines the desired state of the Parallel. ++ +
|
||||||
-delivery
+status
-
-DeliverySpec
+
+ParallelStatus
|
(Optional)
- DeliverySpec contains options controlling the event delivery +Status represents the current state of the Parallel. This data may be out of +date. |
(Appears on: -SubscribableStatus, -SubscribableStatus) +ParallelSpec)
-
SubscriberStatus defines the status of a single subscriber to a Channel.
-uid
+filter
-k8s.io/apimachinery/pkg/types.UID
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- UID is used to understand the origin of the subscriber. +Filter is the expression guarding the branch |
-observedGeneration
+subscriber
-int64
+knative.dev/pkg/apis/duck/v1.Destination
|
-(Optional)
- Generation of the origin of the subscriber with uid:UID. +Subscriber receiving the event when the filter passes |
-ready
+reply
-
-Kubernetes core/v1.ConditionStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- Status of the subscriber. +(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 |
-message
+delivery
-string
+
+DeliverySpec
+
|
(Optional)
- A human readable message indicating details of Ready status. +Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. +Needed for Roundtripping v1alpha1 <-> v1beta1. |
-
Package v1 is the v1 version of the API.
+(Appears on: +ParallelStatus) -Resource Types: - --
Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Subscribers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.
+ParallelBranchStatus represents the current state of a Parallel branch
-apiVersion
-string |
-
-
-eventing.knative.dev/v1
-
+filterSubscriptionStatus
+
+
+ParallelSubscriptionStatus
+
+
|
-
-kind
-string
+FilterSubscriptionStatus corresponds to the filter subscription status. |
-Broker |
-metadata
+filterChannelStatus
-
-Kubernetes meta/v1.ObjectMeta
+
+ParallelChannelStatus
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+FilterChannelStatus corresponds to the filter channel status. |
-spec
+subscriberSubscriptionStatus
-
-BrokerSpec
+
+ParallelSubscriptionStatus
|
- Spec defines the desired state of the Broker. -- + SubscriptionStatus corresponds to the subscriber subscription status. + |
+
+(Appears on: +ParallelBranchStatus, +ParallelStatus) +
++
-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. - |
+Field | +Description |
---|---|---|---|
-delivery
+channel
-
-DeliverySpec
+
+Kubernetes core/v1.ObjectReference
|
-(Optional)
- Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc. - |
-
Channel is the reference to the underlying channel.
status
+ready
-
-BrokerStatus
-
+knative.dev/pkg/apis.Condition
Status represents the current state of the Broker. This data may be out of -date.
+ReadyCondition indicates whether the Channel is ready or not.
-
Trigger represents a request to have events delivered to a subscriber from a -Broker’s event pool.
+(Appears on: +Parallel) + +
-apiVersion
-string |
-
-
-eventing.knative.dev/v1
-
- |
-||||||||
-kind
-string
- |
-Trigger |
-||||||||
-metadata
+branches
-
-Kubernetes meta/v1.ObjectMeta
+
+[]ParallelBranch
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Branches is the list of Filter/Subscribers pairs. |
||||||||
-spec
+channelTemplate
-
-TriggerSpec
+
+ChannelTemplateSpec
|
- Spec defines the desired state of the Trigger. -- -
ParallelStatus +++(Appears on: +Parallel) + ++ ParallelStatus represents the current state of a Parallel. + +
| ||||||||
+branchStatuses
+
+
+[]ParallelBranchStatus
+
+
+ |
+
+ BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order. |
||||||||
-status
+AddressStatus
-
-TriggerStatus
-
+knative.dev/pkg/apis/duck/v1.AddressStatus
|
-(Optional)
- Status represents the current state of the Trigger. This data may be out of -date. +
+(Members of AddressStatus is the starting point to this Parallel. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name} |
(Appears on: -Broker) +ParallelBranchStatus)
@@ -1580,43 +1607,35 @@ date.
config
+subscription
-knative.dev/pkg/apis/duck/v1.KReference
+
+Kubernetes core/v1.ObjectReference
+
Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap.
+Subscription is the reference to the underlying Subscription.
delivery
+ready
-
-DeliverySpec
-
+knative.dev/pkg/apis.Condition
Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc.
+ReadyCondition indicates whether the Subscription is ready or not.
-(Appears on: -Broker) -
--
BrokerStatus represents the current state of a Broker.
+Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
-Status
+metadata
-knative.dev/pkg/apis/duck/v1.Status
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Broker that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||
-address
+spec
-knative.dev/pkg/apis/duck/v1.Addressable
+
+SequenceSpec
+
|
- Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh. +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: -TriggerSpec) +SequenceStatus)
@@ -1674,40 +1753,35 @@ delivered into the Broker mesh.
attributes
+channel
-
-TriggerFilterAttributes
+
+Kubernetes core/v1.ObjectReference
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.
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) +Sequence)
@@ -1721,52 +1795,55 @@ to indicate all strings match.
broker
+steps
-string
+
+[]SequenceStep
+
Broker is the broker that this trigger receives events from.
+Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options
filter
+channelTemplate
-
-TriggerFilter
+
+ChannelTemplateSpec
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 the last Subscriber gets sent to.
(Appears on: -Trigger) +Sequence)
-
TriggerStatus represents the current state of a Trigger.
+SequenceStatus represents the current state of a Sequence.
-subscriberUri
+subscriptionStatuses
-knative.dev/pkg/apis.URL
+
+[]SequenceSubscriptionStatus
+
|
- SubscriberURI is the resolved URI of the receiver for this Trigger. +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.
+Package v1 is the v1 version of the API.
Resource Types: --
Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.
+Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-eventing.knative.dev/v1beta1
+messaging.knative.dev/v1
|
@@ -1850,13 +2045,13 @@ eventing.knative.dev/v1beta1
Broker |
+Channel |
||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -1871,43 +2066,44 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-BrokerSpec
+
+ChannelSpec
|
- Spec defines the desired state of the Broker. +Spec defines the desired state of the Channel.
|
status
-
-BrokerStatus
+
+ChannelStatus
|
(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 represents a type of event that can be consumed from a Broker.
+InMemoryChannel is a resource representing an in memory channel
-eventing.knative.dev/v1beta1
+messaging.knative.dev/v1
|
@@ -1958,13 +2154,13 @@ eventing.knative.dev/v1beta1
EventType |
+InMemoryChannel |
||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -1979,133 +2175,73 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-EventTypeSpec
+
+InMemoryChannelSpec
|
- Spec defines the desired state of the EventType. +Spec defines the desired state of the Channel.
|
||||
-schema
+status
-knative.dev/pkg/apis.URL
+
+InMemoryChannelStatus
+
|
(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. +Status represents the current state of the Channel. This data may be out of +date. |
|||||
-schemaData
-
-string
-
- |
-
-(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. - |
-|||||
-broker
-
-string
-
- |
-
-(Optional)
- TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType. - |
-|||||
-description
-
-string
-
- |
-
-(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. - |
-
status
-
-
-EventTypeStatus
-
-
-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 represents a request to have events delivered to a consumer from a -Broker’s event pool.
- -Field | -Description | -
---|
+
Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
+ +Field | +Description | +||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
-eventing.knative.dev/v1beta1
+messaging.knative.dev/v1
|
Trigger |
+Subscription |
||||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -2135,53 +2270,81 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-TriggerSpec
+
+SubscriptionSpec
|
- Spec defines the desired state of the Trigger.
|
status
-
-TriggerStatus
+
+SubscriptionStatus
|
-(Optional)
- Status represents the current state of the Trigger. This data may be out of -date. |
+
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ +(Appears on: -Broker) +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.
-config
+channelTemplate
-knative.dev/pkg/apis/duck/v1.KReference
+
+ChannelTemplateSpec
+
|
-(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. +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. |
-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 Channel conforms to ChannelableSpec |
(Appears on: -Broker) +Channel)
-
BrokerStatus represents the current state of a Broker.
+ChannelStatus represents the current state of a Channel.
-Status
+ChannelableStatus
-knative.dev/pkg/apis/duck/v1.Status
+
+ChannelableStatus
+
|
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +Channel conforms to ChannelableStatus |
-address
+channel
-knative.dev/pkg/apis/duck/v1.Addressable
+knative.dev/pkg/apis/duck/v1.KReference
|
- Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh. +Channel is an KReference to the Channel CRD backing this Channel. |
(Appears on: -EventType) +ChannelSpec, +ParallelSpec, +SequenceSpec)
@@ -2316,89 +2486,81 @@ delivered into the Broker mesh.
type
+spec
-string
+k8s.io/apimachinery/pkg/runtime.RawExtension
Type represents the CloudEvents type. It is authoritative.
+(Optional) +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section.
++
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.
+ +Field | +Description | +
---|---|
-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
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
(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
-
-string
-
- |
-
-(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. - |
-
-broker
-
-string
-
- |
-
-(Optional)
- TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType. - |
-
-description
-
-string
-
- |
-
-(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
(Appears on: -EventType) +InMemoryChannel)
-
EventTypeStatus represents the current state of a EventType.
+InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
-Status
+ChannelableSpec
-knative.dev/pkg/apis/duck/v1.Status
+
+ChannelableSpec
+
|
-(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. +Channel conforms to Duck type Channelable. |
(Appears on: -TriggerSpec) +InMemoryChannel)
+
ChannelStatus represents the current state of a Channel.
-attributes
+ChannelableStatus
-
-TriggerFilterAttributes
+
+ChannelableStatus
|
-(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. +
+(Members of Channel conforms to Duck type Channelable. |
map[string]string
alias)-(Appears on: -TriggerFilter) -
--
TriggerFilterAttributes is a map of context attribute names to values for -filtering by equality. Only exact matches will pass the filter. You can use the value “ -to indicate all strings match.
- -(Appears on: -Trigger) +Subscription)
+
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
-broker
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. +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.) |
-filter
+subscriber
-
-TriggerFilter
-
+knative.dev/pkg/apis/duck/v1.Destination
|
(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 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. |
-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 specifies (optionally) how to handle events returned from +the Subscriber target. + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ Delivery configuration |
(Appears on: -Trigger) +Subscription)
-
TriggerStatus represents the current state of a Trigger.
+SubscriptionStatus (computed) for a subscription
+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 resolved URI of the receiver for this Trigger. +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 is the v1 version of the API.
+Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
Resource Types:-
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
-messaging.knative.dev/v1
+sources.knative.dev/v1alpha2
|
@@ -2617,19 +2865,18 @@ messaging.knative.dev/v1
Channel |
+ApiServerSource |
|||||||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -2638,44 +2885,90 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ChannelSpec
+
+ApiServerSourceSpec
|
- Spec defines the desired state of the Channel.
|
status
-
-ChannelStatus
+
+ApiServerSourceStatus
|
-(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
+ContainerSource is the Schema for the containersources API
-messaging.knative.dev/v1
+sources.knative.dev/v1alpha2
|
@@ -2726,19 +3016,18 @@ messaging.knative.dev/v1
InMemoryChannel |
+ContainerSource |
|||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -2747,30 +3036,44 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-InMemoryChannelSpec
+
+ContainerSourceSpec
|
- Spec defines the desired state of the Channel.
|
status
-
-InMemoryChannelStatus
+
+ContainerSourceStatus
|
-(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.
+PingSource is the Schema for the PingSources API.
-messaging.knative.dev/v1
+sources.knative.dev/v1alpha2
|
@@ -2822,13 +3121,13 @@ messaging.knative.dev/v1
Subscription |
+PingSource |
||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -2842,8 +3141,8 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-SubscriptionSpec
+
+PingSourceSpec
|
@@ -2853,70 +3152,46 @@ SubscriptionSpec
-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
+SourceSpec
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(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. +
+(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. |
-reply
+schedule
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. +Schedule is the cronjob schedule. Defaults to |
-delivery
+jsonData
-
-DeliverySpec
-
+string
|
(Optional)
- Delivery configuration +JsonData is json encoded data used as the body of the event posted to +the sink. Default is empty. If set, datacontenttype will also be set +to “application/json”. |
status
-
-SubscriptionStatus
+
+PingSourceStatus
-
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.
+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.
-channelTemplate
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
+ |
+
+kind
+string
+ |
+SinkBinding |
+
+metadata
-
-ChannelTemplateSpec
+
+Kubernetes meta/v1.ObjectMeta
|
- 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. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-ChannelableSpec
+spec
-
-ChannelableSpec
+
+SinkBindingSpec
|
-
-(Members of Channel conforms to ChannelableSpec - |
-
-(Appears on: -Channel) -
--
ChannelStatus represents the current state of a Channel.
- +Field | -Description | -
---|---|
-ChannelableStatus
+SourceSpec
-
-ChannelableStatus
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Members of Channel conforms to ChannelableStatus +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. |
-channel
+BindingSpec
-knative.dev/pkg/apis/duck/v1.KReference
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
- Channel is an KReference to the Channel CRD backing this Channel. +
+(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations. |
-(Appears on: -ChannelSpec, -ParallelSpec, -SequenceSpec) -
--
-Field | -Description | +
---|---|
-spec
+status
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+SinkBindingStatus
+
|
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - |
-
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that -we can easily create new Channels off of it.
+(Appears on: +ApiServerSourceSpec, +ApiServerSourceSpec) + ++
APIVersionKind is an APIVersion and Kind tuple.
-metadata
+apiVersion
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+APIVersion - the API version of the resource to watch. |
-spec
+kind
-k8s.io/apimachinery/pkg/runtime.RawExtension
+string
|
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
(Appears on: -InMemoryChannel) +ApiServerSourceSpec)
-
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
+APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
-ChannelableSpec
+apiVersion
-
-ChannelableSpec
-
+string
|
-
-(Members of Channel conforms to Duck type Channelable. +APIVersion - the API version of the resource to watch. |
-(Appears on: -InMemoryChannel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | +
+kind
+
+string
+
+ |
+
+ Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
---|---|---|---|
-ChannelableStatus
+selector
-
-ChannelableStatus
+
+Kubernetes meta/v1.LabelSelector
|
-
-(Members of Channel conforms to Duck type Channelable. +(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: -Subscription) +ApiServerSource)
-
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
+ApiServerSourceSpec defines the desired state of ApiServerSource
-channel
+SourceSpec
-
-Kubernetes core/v1.ObjectReference
+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
|
- 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.) +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. |
-subscriber
+owner
-knative.dev/pkg/apis/duck/v1.Destination
+
+APIVersionKind
+
|
(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. +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
+mode
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. +EventMode controls the format of the event.
+ |
-delivery
+serviceAccountName
-
-DeliverySpec
-
+string
|
(Optional)
- Delivery configuration +ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set. |
(Appears on: -Subscription) +ApiServerSource)
-
SubscriptionStatus (computed) for a subscription
+ApiServerSourceStatus defines the observed state of ApiServerSource
-Status
+SourceStatus
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-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. |
(Appears on: -SubscriptionStatus) +ContainerSource)
-
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
+ContainerSourceSpec defines the desired state of ContainerSource
-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 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. |
-replyUri
+template
-knative.dev/pkg/apis.URL
+
+Kubernetes core/v1.PodTemplateSpec
+
|
- ReplyURI is the fully resolved URI for the spec.reply. +Template describes the pods that will be created |
+(Appears on: +ContainerSource) +
++
ContainerSourceStatus defines the observed state of ContainerSource
+ +Field | +Description | +
---|---|
-deadLetterSinkUri
+SourceStatus
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. +
+(Members of 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
+(Appears on: +PingSource) -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+PingSourceSpec defines the desired state of the PingSource.
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha1
-
- |
-||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-kind
-string
- |
-ApiServerSource |
-||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-metadata
+SourceSpec
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-spec
-
-
-ApiServerSourceSpec
-
-
- |
-
- - -
PingSourceStatus +++(Appears on: +PingSource) + ++ PingSourceStatus defines the observed state of PingSource. + +
SinkBindingSpec +++(Appears on: +SinkBinding) + ++ SinkBindingSpec holds the desired state of the SinkBinding (from the client). + +
|
+
Field | +Description |
---|---|
-status
+SourceStatus
-
-ApiServerSourceStatus
-
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
+
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. |
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: + +-
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.
ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
-sources.knative.dev/v1alpha1
+configs.internal.knative.dev/v1alpha1
|
@@ -3592,18 +3880,19 @@ sources.knative.dev/v1alpha1
SinkBinding |
+ConfigMapPropagation |
|||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -3612,39 +3901,39 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SinkBindingSpec
+
+ConfigMapPropagationSpec
|
+ Spec defines the desired state of the ConfigMapPropagation
|
status
-
-SinkBindingStatus
+
+ConfigMapPropagationStatus
|
+(Optional)
+ Status represents the current state of the EventType. +This data may be out of date. |
(Appears on: -ApiServerSourceSpec) +ConfigMapPropagation)
-
ApiServerResource defines the resource to watch
-apiVersion
-
-string
-
- |
-
- API version of the resource to watch. - |
-
-kind
+originalNamespace
string
|
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +OriginalNamespace is the namespace where the original configMaps are in |
-labelSelector
+selector
-
+
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 +(Optional) +Selector only selects original configMaps with corresponding labels |
+(Appears on: +ConfigMapPropagation) +
++
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
+ +Field | +Description | +
---|---|
-controllerSelector
+Status
-
-Kubernetes meta/v1.OwnerReference
-
+knative.dev/pkg/apis/duck/v1.Status
|
- 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. +
+(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. |
-controller
+copyConfigmaps
-bool
+
+[]ConfigMapPropagationStatusCopyConfigMap
+
|
- 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. +(Optional) +CopyConfigMaps is the status for each copied configmap. |
(Appears on: -ApiServerSource) +ConfigMapPropagationStatus)
-
ApiServerSourceSpec defines the desired state of ApiServerSource
+ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
-resources
+name
-
-[]ApiServerResource
-
+string
|
- Resources is the list of resources to watch +Name is copy configmap’s name |
-serviceAccountName
+source
string
|
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. +Source is “originalNamespace/originalConfigMapName” |
-sink
+operation
-knative.dev/pkg/apis/duck/v1beta1.Destination
+string
|
-(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop |
-ceOverrides
+ready
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides
+string
|
-(Optional)
- CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink. +Ready represents the operation is ready or not |
-owner
+reason
-
-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. +Reason indicates reasons if the operation is not ready |
-mode
+resourceVersionFromSource
string
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
- ResourceVersion is the resourceVersion of original configmap |
-(Appears on: -ApiServerSource) +
Package v1beta1 is the v1beta1 version of the API.
+Resource Types: + +-
ApiServerSourceStatus defines the observed state of ApiServerSource
+Broker collects a pool of events that are consumable using Triggers. Brokers +provide a well-known endpoint for event delivery that senders can use with +minimal knowledge of the event routing strategy. Receivers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.
-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. +
+eventing.knative.dev/v1beta1
+
|
-(Appears on: -SinkBinding) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
- -Field | -Description | +
+kind
+string
+ |
+Broker |
||||
---|---|---|---|---|---|---|---|
-SourceSpec
+metadata
-knative.dev/pkg/apis/duck/v1.SourceSpec
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-(Members of metadata field.
|
||||||
-BindingSpec
+spec
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+BrokerSpec
+
|
-
-(Members of Spec defines the desired state of the Broker. ++ +
SinkBindingStatus ---(Appears on: -SinkBinding) - -- SinkBindingStatus communicates the observed state of the SinkBinding (from the controller). - -
|
||||||
-SourceStatus
+status
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+BrokerStatus
+
|
-
-(Members of Status represents the current state of the Broker. This data may be out of +date. |
-
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+EventType represents a type of event that can be consumed from a Broker.
-sources.knative.dev/v1beta1
+eventing.knative.dev/v1beta1
|
@@ -4007,18 +4286,19 @@ sources.knative.dev/v1beta1
ApiServerSource |
+EventType |
|||||||||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -4027,90 +4307,89 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ApiServerSourceSpec
+
+EventTypeSpec
|
+ Spec defines the desired state of the EventType.
|
status
-
-ApiServerSourceStatus
+
+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 represents a request to have events delivered to a consumer from a +Broker’s event pool.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+eventing.knative.dev/v1beta1
+
+ |
+||||||
+kind
+string
+ |
+Trigger |
+||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+TriggerSpec
+
+
+ |
+
+ Spec defines the desired state of the Trigger. ++ +
|
+||||||
+status
+
+
+TriggerStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Trigger. This data may be out of +date. + |
+
+(Appears on: +Broker) +
++
+Field | +Description | +
---|---|
+config
+
+knative.dev/pkg/apis/duck/v1.KReference
+
+ |
+
+(Optional)
+ Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap. + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc. + |
+
+(Appears on: +Broker) +
++
BrokerStatus represents the current state of a Broker.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+address
+
+knative.dev/pkg/apis/duck/v1.Addressable
+
+ |
+
+ Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh. + |
+
+(Appears on: +EventType) +
++
+Field | +Description | +
---|---|
+type
+
+string
+
+ |
+
+ Type represents the CloudEvents type. It is authoritative. + |
+
+source
+
+knative.dev/pkg/apis.URL
+
+ |
+
+(Optional)
+ Source is a URI, it represents the CloudEvents source. + |
+
+schema
+
+knative.dev/pkg/apis.URL
+
+ |
+
+(Optional)
+ Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional. + |
+
+schemaData
+
+string
+
+ |
+
+(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. + |
+
+broker
+
+string
+
+ |
+
+(Optional)
+ TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType. + |
+
+description
+
+string
+
+ |
+
+(Optional)
+ Description is an optional field used to describe the EventType, in any meaningful way. + |
+
+(Appears on: +EventType) +
++
EventTypeStatus represents the current state of a EventType.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+(Appears on: +TriggerSpec) +
++
+Field | +Description | +
---|---|
+attributes
+
+
+TriggerFilterAttributes
+
+
+ |
+
+(Optional)
+ Attributes filters events by exact match on event context attributes. +Each key in the map is compared with the equivalent key in the event +context. An event passes the filter if all values are equal to the +specified values. +Nested context attributes are not supported as keys. Only string values are supported. + |
+
map[string]string
alias)+(Appears on: +TriggerFilter) +
++
TriggerFilterAttributes is a map of context attribute names to values for +filtering by equality. Only exact matches will pass the filter. You can use the value “ +to indicate all strings match.
+ ++(Appears on: +Trigger) +
++
+Field | +Description | +
---|---|
+broker
+
+string
+
+ |
+
+ Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’. + |
+
+filter
+
+
+TriggerFilter
+
+
+ |
+
+(Optional)
+ Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events. + |
+
+subscriber
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required. + |
+
+(Appears on: +Trigger) +
++
TriggerStatus represents the current state of a Trigger.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+subscriberUri
+
+knative.dev/pkg/apis.URL
+
+ |
+
+ SubscriberURI is the resolved URI of the receiver for this Trigger. + |
+
+
Package v1 contains API Schema definitions for the sources v1 API group.
+ +Resource Types: +-
ContainerSource is the Schema for the containersources API
+ApiServerSource is the Schema for the apiserversources API
-sources.knative.dev/v1beta1
+sources.knative.dev/v1
|
@@ -4158,13 +4945,13 @@ sources.knative.dev/v1beta1
ContainerSource |
+ApiServerSource |
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -4178,8 +4965,8 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-ContainerSourceSpec
+
+ApiServerSourceSpec
|
@@ -4207,15 +4994,61 @@ and modifications of the event sent to the sink.
-template
+resources
-
-Kubernetes core/v1.PodTemplateSpec
+
+[]APIVersionKindSelector
|
- Template describes the pods that will be created +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. |
status
-
-ContainerSourceStatus
+
+ApiServerSourceStatus
-
PingSource is the Schema for the PingSources API.
+ContainerSource is the Schema for the containersources API
-sources.knative.dev/v1beta1
+sources.knative.dev/v1
|
@@ -4263,13 +5096,13 @@ sources.knative.dev/v1beta1
PingSource |
+ContainerSource |
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -4283,8 +5116,8 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-PingSourceSpec
+
+ContainerSourceSpec
|
@@ -4312,42 +5145,15 @@ and modifications of the event sent to the sink.
-schedule
-
-string
-
- |
-
-(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 - |
-
-jsonData
+template
-string
+
+Kubernetes core/v1.PodTemplateSpec
+
|
-(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”. +Template describes the pods that will be created |
status
-
-PingSourceStatus
+
+ContainerSourceStatus
SinkBinding describes a Binding that is also a Source. @@ -4391,7 +5197,7 @@ cloud events.
string
-sources.knative.dev/v1beta1
+sources.knative.dev/v1
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -4420,7 +5226,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
SinkBindingSpec
@@ -4451,14 +5257,14 @@ and modifications of the event sent to the sink.
BindingSpec
-knative.dev/pkg/apis/duck/v1beta1.BindingSpec
+knative.dev/pkg/apis/duck/v1.BindingSpec
(Members of BindingSpec
are embedded into this type.)
inherits duck/v1beta1 BindingSpec, which currently provides: +
inherits duck/v1 BindingSpec, which currently provides: * Subject - Subject references the resource(s) whose “runtime contract” should be augmented by Binding implementations.
status
-
+
SinkBindingStatus
@@ -4480,11 +5286,11 @@ SinkBindingStatus
-(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)
APIVersionKind is an APIVersion and Kind tuple.
@@ -4522,11 +5328,11 @@ More info: APIVersionKindSelector +(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)
APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
@@ -4566,7 +5372,7 @@ More info: + Kubernetes meta/v1.LabelSelector @@ -4580,11 +5386,11 @@ More info: ApiServerSourceSpec +(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceSpec defines the desired state of ApiServerSource
@@ -4619,7 +5425,7 @@ and modifications of the event sent to the sink.resources
-
+
[]APIVersionKindSelector
@@ -4634,7 +5440,7 @@ selector to help filter.
owner
-
+
APIVersionKind
@@ -4676,11 +5482,11 @@ source. Defaults to default if not set.
-(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceStatus defines the observed state of ApiServerSource
@@ -4715,11 +5521,11 @@ Source. -(Appears on: -ContainerSource) +ContainerSource)
ContainerSourceSpec defines the desired state of ContainerSource
@@ -4754,7 +5560,7 @@ and modifications of the event sent to the sink.template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -4765,11 +5571,11 @@ Kubernetes core/v1.PodTemplateSpec
-(Appears on: -ContainerSource) +ContainerSource)
ContainerSourceStatus defines the observed state of ContainerSource
@@ -4804,127 +5610,11 @@ Source. --(Appears on: -PingSource) -
--
PingSourceSpec defines the desired state of the PingSource.
- -Field | -Description | -
---|---|
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-schedule
-
-string
-
- |
-
-(Optional)
- Schedule is the cronjob schedule. Defaults to |
-
-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
-
- |
-
-(Optional)
- JsonData is json encoded data used as the body of the event posted to -the sink. Default is empty. If set, datacontenttype will also be set -to “application/json”. - |
-
-(Appears on: -PingSource) -
--
PingSourceStatus defines the observed state of PingSource.
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
(Appears on: -SinkBinding) +SinkBinding)
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
@@ -4959,25 +5649,25 @@ and modifications of the event sent to the sink.BindingSpec
-knative.dev/pkg/apis/duck/v1beta1.BindingSpec
+knative.dev/pkg/apis/duck/v1.BindingSpec
(Members of BindingSpec
are embedded into this type.)
inherits duck/v1beta1 BindingSpec, which currently provides: +
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) +SinkBinding)
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
@@ -5013,18 +5703,17 @@ Source.-
Package v1alpha1 is the v1alpha1 version of the API.
+Package v1 is the v1 version of the API.
Resource Types: - --
ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
-apiVersion
-string |
-
-
-configs.internal.knative.dev/v1alpha1
-
- |
-|||||||||
-kind
-string
- |
-ConfigMapPropagation |
-|||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -5070,39 +5742,55 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-ConfigMapPropagationSpec
+
+ParallelSpec
|
- Spec defines the desired state of the ConfigMapPropagation +Spec defines the desired state of the Parallel.
|
status
-
-ConfigMapPropagationStatus
+
+ParallelStatus
|
(Optional)
- Status represents the current state of the EventType. -This data may be out of date. +Status represents the current state of the Parallel. This data may be out of +date. |
(Appears on: -ConfigMapPropagation) +ParallelSpec)
@@ -5143,39 +5831,65 @@ This data may be out of date.
originalNamespace
+filter
-string
+knative.dev/pkg/apis/duck/v1.Destination
OriginalNamespace is the namespace where the original configMaps are in
+(Optional) +Filter is the expression guarding the branch
selector
+subscriber
-
-Kubernetes meta/v1.LabelSelector
+knative.dev/pkg/apis/duck/v1.Destination
+
+Subscriber receiving the event when the filter passes
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+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
Selector only selects original configMaps with corresponding labels
+Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc.
(Appears on: -ConfigMapPropagation) +ParallelStatus)
-
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
+ParallelBranchStatus represents the current state of a Parallel branch
-Status
+filterSubscriptionStatus
-knative.dev/pkg/apis/duck/v1.Status
+
+ParallelSubscriptionStatus
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +FilterSubscriptionStatus corresponds to the filter subscription status. |
-copyConfigmaps
+filterChannelStatus
-
-[]ConfigMapPropagationStatusCopyConfigMap
+
+ParallelChannelStatus
|
-(Optional)
- CopyConfigMaps is the status for each copied configmap. +FilterChannelStatus corresponds to the filter channel status. + |
+
+subscriberSubscriptionStatus
+
+
+ParallelSubscriptionStatus
+
+
+ |
+
+ SubscriptionStatus corresponds to the subscriber subscription status. |
(Appears on: -ConfigMapPropagationStatus) +ParallelBranchStatus, +ParallelStatus)
-
ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
-name
+channel
-string
+
+Kubernetes core/v1.ObjectReference
+
|
- Name is copy configmap’s name +Channel is the reference to the underlying channel. |
-source
+ready
-string
+knative.dev/pkg/apis.Condition
|
- Source is “originalNamespace/originalConfigMapName” +ReadyCondition indicates whether the Channel is ready or not. |
+(Appears on: +Parallel) +
++
+
-operation
-
-string
-
- |
-
- Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop - |
+Field | +Description |
---|---|---|---|
-ready
+branches
-string
+
+[]ParallelBranch
+
|
- Ready represents the operation is ready or not +Branches is the list of Filter/Subscribers pairs. |
||
-reason
+channelTemplate
-string
+
+ChannelTemplateSpec
+
|
- Reason indicates reasons if the operation is not ready +(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). |
||
-resourceVersionFromSource
+reply
-string
+knative.dev/pkg/apis/duck/v1.Destination
|
- ResourceVersion is the resourceVersion of original configmap +(Optional) +Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply |
-
Package v1alpha1 is the v1alpha1 version of the API.
+(Appears on: +Parallel) -Resource Types: --
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
+ParallelStatus represents the current state of a Parallel.
+ +Field | +Description | +||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of
ChannelableCombined
+ |
+
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -5433,60 +6195,55 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ChannelableCombinedSpec
+
+SequenceSpec
|
- Spec is the part where the Channelable fulfills the Subscribable contract. +Spec defines the desired state of the Sequence.
|
status
-
-ChannelableCombinedStatus
+
+SequenceStatus
|
+(Optional)
+ Status represents the current state of the Sequence. This data may be out of +date. |
(Appears on: -ChannelableCombined) +SequenceStatus)
-
ChannelableSpec contains Spec of the Channelable object
-SubscribableTypeSpec
+channel
-
-SubscribableTypeSpec
+
+Kubernetes core/v1.ObjectReference
|
-
-(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. +Channel is the reference to the underlying channel. |
-SubscribableSpec
+ready
-
-SubscribableSpec
-
+knative.dev/pkg/apis.Condition
|
+ ReadyCondition indicates whether the Channel is ready or not. + |
+
-(Members of SubscribableSpec
are embedded into this type.)
+(Appears on:
+Sequence)
SubscribableSpec is for the v1beta1 spec compatibility.
++
+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 |
-delivery
+channelTemplate
-
-DeliverySpec
+
+ChannelTemplateSpec
|
(Optional)
- DeliverySpec contains options controlling the event delivery +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: -ChannelableCombined) +Sequence)
-
ChannelableStatus contains the Status of a Channelable object.
+SequenceStatus represents the current state of a Sequence.
-AddressStatus
+subscriptionStatuses
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+[]SequenceSubscriptionStatus
+
|
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order. |
-SubscribableTypeStatus
+channelStatuses
-
-SubscribableTypeStatus
+
+[]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} + |
+
-(Members of SubscribableTypeStatus
are embedded into this type.)
+(Appears on:
+SequenceSpec)
SubscribableTypeStatus is the v1alpha1 part of the Subscribers status
-+
+Field | +Description |
---|---|
-SubscribableStatus
+Destination
-
-SubscribableStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
-(Members of SubscribableStatus is the v1beta1 part of the Subscribers status. +Subscriber receiving the step event |
-errorChannel
+delivery
-
-Kubernetes core/v1.ObjectReference
+
+DeliverySpec
|
(Optional)
- ErrorChannel is set by the channel when it supports native error handling via a channel +Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. |
(Appears on: -Channelable) +SequenceStatus)
-
ChannelableSpec contains Spec of the Channelable object
-SubscribableTypeSpec
+subscription
-
-SubscribableTypeSpec
+
+Kubernetes core/v1.ObjectReference
|
-
-(Members of Subscription is the reference to the underlying Subscription. |
-delivery
+ready
-
-DeliverySpec
-
+knative.dev/pkg/apis.Condition
|
-(Optional)
- DeliverySpec contains options controlling the event delivery +ReadyCondition indicates whether the Subscription is ready or not. |
-(Appears on: -Channelable) +
Package v1beta1 is the v1beta1 version of the API.
+Resource Types: +-
ChannelableStatus contains the Status of a Channelable object.
+Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-Status
+apiVersion
+string |
+
+
+messaging.knative.dev/v1beta1
+
+ |
+||||
+kind
+string
+ |
+Channel |
+||||
+metadata
-knative.dev/pkg/apis/duck/v1.Status
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||
-AddressStatus
+spec
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+ChannelSpec
+
|
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +Spec defines the desired state of the Channel. ++ +
|
||||
-errorChannel
+status
-
-Kubernetes core/v1.ObjectReference
+
+ChannelStatus
|
(Optional)
- ErrorChannel is set by the channel when it supports native error handling via a channel +Status represents the current state of the Channel. This data may be out of +date. |
-
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.
+InMemoryChannel is a resource representing an in memory channel
+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.
|
-(Appears on: -SubscribableTypeSpec) -
--
Subscribable is the schema for the subscribable portion of the spec -section of the resource.
- -Field | -Description | -
+spec
+
+
+InMemoryChannelSpec
+
+
+ |
+
+ Spec defines the desired state of the Channel. ++ +
SubscribableStatus ---(Appears on: -SubscribableTypeStatus) - -- SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource. - -
SubscribableType
+ |
---|
+apiVersion
+string |
+
+
+messaging.knative.dev/v1beta1
+
+ |
+|||||||||||
+kind
+string
+ |
+Subscription |
+|||||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -5922,27 +6801,81 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-SubscribableTypeSpec
+
+SubscriptionSpec
|
- SubscribableTypeSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract.
|
status
-
-SubscribableTypeStatus
+
+SubscriptionStatus
|
- SubscribableTypeStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. |
+
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ +(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -SubscribableType) +Channel)
-
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
+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.
-subscribable
+channelTemplate
-
-Subscribable
+
+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: -ChannelableCombinedStatus, -ChannelableStatus, -SubscribableType) +Channel)
-
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+ChannelStatus represents the current state of a Channel.
-subscribableStatus
+ChannelableStatus
-
-SubscribableStatus
+
+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: -Subscribable) +ChannelSpec, +ParallelSpec, +SequenceSpec)
-
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
-uid
+spec
-k8s.io/apimachinery/pkg/types.UID
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
(Optional)
- UID is used to understand the origin of the subscriber. +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
+
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.
+ +
-generation
-
-int64
-
- |
-
-(Optional)
- Generation of the origin of the subscriber with uid:UID. - |
+Field | +Description |
---|---|---|---|
-subscriberURI
+metadata
-knative.dev/pkg/apis.URL
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
||
-replyURI
+spec
-knative.dev/pkg/apis.URL
+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.
+ +
-deadLetterSink
-
-knative.dev/pkg/apis.URL
-
- |
--(Optional) - | +Field | +Description |
---|---|---|---|
-delivery
+ChannelableSpec
-
-DeliverySpec
+
+ChannelableSpec
|
-(Optional)
+
+(Members of Channel conforms to Duck type Channelable. |
-
Package v1 is the v1 version of the API.
+(Appears on: +InMemoryChannel) -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
+ChannelStatus represents the current state of a Channel.
-metadata
+ChannelableStatus
-
-Kubernetes meta/v1.ObjectMeta
+
+ChannelableStatus
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of Channel conforms to Duck type Channelable. |
-spec
-
-
-ParallelSpec
-
-
- |
-
- Spec defines the desired state of the Parallel. -- + |
+(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 | +
---|---|
-branches
+channel
-
-[]ParallelBranch
+
+Kubernetes core/v1.ObjectReference
|
- Branches is the list of Filter/Subscribers pairs. +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.) |
-channelTemplate
+subscriber
-
-ChannelTemplateSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
(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). +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. |
(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply - |
-
Reply specifies (optionally) how to handle events returned from +the Subscriber target.
status
+delivery
-
-ParallelStatus
+
+DeliverySpec
Status represents the current state of the Parallel. This data may be out of -date.
+Delivery configuration
(Appears on: -ParallelSpec) +Subscription)
+
SubscriptionStatus (computed) for a subscription
-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
+Status
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.Status
|
-(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 inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-delivery
+physicalSubscription
-
-DeliverySpec
+
+SubscriptionStatusPhysicalSubscription
|
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. +PhysicalSubscription is the fully resolved values that this Subscription represents. |
(Appears on: -ParallelStatus) +SubscriptionStatus)
-
ParallelBranchStatus represents the current state of a Parallel branch
+SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
-filterSubscriptionStatus
+subscriberUri
-
-ParallelSubscriptionStatus
-
+knative.dev/pkg/apis.URL
|
- FilterSubscriptionStatus corresponds to the filter subscription status. +SubscriberURI is the fully resolved URI for spec.subscriber. |
-filterChannelStatus
+replyUri
-
-ParallelChannelStatus
-
+knative.dev/pkg/apis.URL
|
- FilterChannelStatus corresponds to the filter channel status. +ReplyURI is the fully resolved URI for the spec.reply. |
-subscriberSubscriptionStatus
+deadLetterSinkUri
-
-ParallelSubscriptionStatus
-
+knative.dev/pkg/apis.URL
|
- SubscriptionStatus corresponds to the subscriber subscription status. +ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. |
-(Appears on: -ParallelBranchStatus, -ParallelStatus) +
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+Resource Types: ++
ApiServerSource is the Schema for the apiserversources API
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha1
+
|
+
- Channel is the reference to the underlying channel. +kind
+string
|
+ApiServerSource |
-ready
+metadata
-knative.dev/pkg/apis.Condition
+
+Kubernetes meta/v1.ObjectMeta
+
|
- ReadyCondition indicates whether the Channel is ready or not. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-(Appears on: -Parallel) -
--
+spec
+
+
+ApiServerSourceSpec
+
+
+Field | -Description | -
---|---|
-branches
+resources
-
-[]ParallelBranch
+
+[]ApiServerResource
|
- Branches is the list of Filter/Subscribers pairs. +Resources is the list of resources to watch |
-channelTemplate
+serviceAccountName
-
-ChannelTemplateSpec
-
+string
|
(Optional)
- 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). +ServiceAccountName is the name of the ServiceAccount to use to run this +source. |
-reply
+sink
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1beta1.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 +Sink is a reference to an object that will resolve to a domain name to use as the sink. |
-(Appears on: -Parallel) -
--
ParallelStatus represents the current state of a Parallel.
- -Field | -Description | -
---|---|
-Status
+ceOverrides
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.CloudEventOverrides
|
-
-(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) +CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink. |
-ingressChannelStatus
+owner
-
-ParallelChannelStatus
+
+APIVersionKind
|
- IngressChannelStatus corresponds to the ingress channel status. +(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. |
-branchStatuses
+mode
-
-[]ParallelBranchStatus
-
+string
|
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. +Mode is the mode the receive adapter controller runs under: Ref or Resource.
+ |
+
AddressStatus
+status
-knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ApiServerSourceStatus
+
-(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}
-(Appears on: -ParallelBranchStatus) -
-+
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
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
+
- Subscription is the reference to the underlying Subscription. +
+sources.knative.dev/v1alpha1
+
|
|
-ready
-
-knative.dev/pkg/apis.Condition
-
- |
-
- ReadyCondition indicates whether the Subscription is ready or not. +kind
+string
|
+SinkBinding |
-
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.
|
@@ -6616,55 +7571,39 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SequenceSpec
+
+SinkBindingSpec
|
- Spec defines the desired state of the Sequence.
|
status
-
-SequenceStatus
+
+SinkBindingStatus
|
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. |
(Appears on: -SequenceStatus) +ApiServerSourceSpec)
+
ApiServerResource defines the resource to watch
-channel
+apiVersion
-
-Kubernetes core/v1.ObjectReference
-
+string
|
- Channel is the reference to the underlying channel. +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 |
-(Appears on: -Sequence) -
--
-Field | -Description | -
---|---|
-steps
+labelSelector
-
-[]SequenceStep
+
+Kubernetes meta/v1.LabelSelector
|
- Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options +LabelSelector restricts this source to objects with the selected labels +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
-channelTemplate
-
-
-ChannelTemplateSpec
+controllerSelector
+
+
+Kubernetes meta/v1.OwnerReference
|
-(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). +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. |
-reply
+controller
-knative.dev/pkg/apis/duck/v1.Destination
+bool
|
-(Optional)
- Reply is a Reference to where the result of the last Subscriber gets sent to. +If true, send an event referencing the object controlling the resource +Deprecated: Per-resource controller flag will no longer be supported in +v1alpha2, please use Spec.Owner as a GKV. |
(Appears on: -Sequence) +ApiServerSource)
-
SequenceStatus represents the current state of a Sequence.
+ApiServerSourceSpec defines the desired state of ApiServerSource
-Status
+resources
-knative.dev/pkg/apis/duck/v1.Status
+
+[]ApiServerResource
+
|
-
-(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. +Resources is the list of resources to watch |
-subscriptionStatuses
+serviceAccountName
-
-[]SequenceSubscriptionStatus
-
+string
|
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. +(Optional) +ServiceAccountName is the name of the ServiceAccount to use to run this +source. |
-channelStatuses
+sink
-
-[]SequenceChannelStatus
+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
|
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. +(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. |
-AddressStatus
+mode
-knative.dev/pkg/apis/duck/v1.AddressStatus
+string
|
-
-(Members of AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} +Mode is the mode the receive adapter controller runs under: Ref or Resource.
+ |
(Appears on: -SequenceSpec) +ApiServerSource)
+
ApiServerSourceStatus defines the observed state of ApiServerSource
-Destination
+SourceStatus
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(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. +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: -SequenceStatus) +SinkBinding)
+
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
-subscription
+SourceSpec
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
- Subscription is the reference to the underlying Subscription. +
+(Members of |
-ready
+BindingSpec
-knative.dev/pkg/apis.Condition
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
- ReadyCondition indicates whether the Subscription is ready or not. +
+(Members of |
-
Package v1beta1 is the v1beta1 version of the API.
+(Appears on: +SinkBinding) -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
+SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
-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
+SourceStatus
-
-ParallelStatus
-
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. +
+(Members of |
+
Package v1 is the v1 version of the API.
+ +Resource Types: +string
alias)(Appears on: -ParallelSpec) +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.
-filter
+metadata
-knative.dev/pkg/apis/duck/v1.Destination
+
+Kubernetes meta/v1.ObjectMeta
+
|
-(Optional)
- Filter is the expression guarding the branch +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||||
-subscriber
+spec
-knative.dev/pkg/apis/duck/v1.Destination
+
+ChannelableSpec
+
|
- Subscriber receiving the event when the filter passes - |
-
-reply
+SubscribableSpec
-knative.dev/pkg/apis/duck/v1.Destination
+
+SubscribableSpec
+
|
-(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 |
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. +DeliverySpec contains options controlling the event delivery |
-(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
+status
-
-ParallelSubscriptionStatus
+
+ChannelableStatus
|
- SubscriptionStatus corresponds to the subscriber subscription status. |
(Appears on: -ParallelBranchStatus, -ParallelStatus) +ChannelSpec, +Channelable, +InMemoryChannelSpec)
+
ChannelableSpec contains Spec of the Channelable object
-channel
+SubscribableSpec
-
-Kubernetes core/v1.ObjectReference
+
+SubscribableSpec
|
- Channel is the reference to the underlying channel. +
+(Members of |
-ready
+delivery
-knative.dev/pkg/apis.Condition
+
+DeliverySpec
+
|
- ReadyCondition indicates whether the Channel is ready or not. +(Optional) +DeliverySpec contains options controlling the event delivery |
(Appears on: -Parallel) +ChannelStatus, +Channelable, +InMemoryChannelStatus)
+
ChannelableStatus contains the Status of a Channelable object.
-branches
+Status
-
-[]ParallelBranch
-
+knative.dev/pkg/apis/duck/v1.Status
|
- Branches is the list of Filter/Subscribers pairs. +
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-channelTemplate
+AddressStatus
-
-ChannelTemplateSpec
+knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ |
+
+
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. + |
+
+SubscribableStatus
+
+
+SubscribableStatus
|
-(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). +
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
-reply
+deadLetterChannel
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.KReference
|
(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply +DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel +Failed messages are delivered here. |
(Appears on: -Parallel) +BrokerSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, +SubscriptionSpec)
-
ParallelStatus represents the current state of a Parallel.
+DeliverySpec contains the delivery options for event senders, +such as channelable and source.
-Status
+deadLetterSink
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +(Optional) +DeadLetterSink is the sink receiving event that could not be sent to +a destination. |
-ingressChannelStatus
+retry
-
-ParallelChannelStatus
-
+int32
|
- IngressChannelStatus corresponds to the ingress 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. |
-branchStatuses
+backoffPolicy
-
-[]ParallelBranchStatus
+
+BackoffPolicyType
|
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. +(Optional) +BackoffPolicy is the retry backoff policy (linear, exponential). |
-AddressStatus
+backoffDelay
-knative.dev/pkg/apis/duck/v1.AddressStatus
+string
|
-
-(Members of AddressStatus is the starting point to this Parallel. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} +(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* |
-(Appears on: -ParallelBranchStatus) -
-+
DeliveryStatus contains the Status of an object supporting delivery options.
-subscription
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Subscription is the reference to the underlying Subscription. - |
-
-ready
+deadLetterChannel
-knative.dev/pkg/apis.Condition
+knative.dev/pkg/apis/duck/v1.KReference
|
- ReadyCondition indicates whether the Subscription 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. |
-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
+Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -7450,55 +8301,28 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SequenceSpec
+
+SubscribableSpec
|
- Spec defines the desired state of the Sequence. +SubscribableSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract.
|
status
-
-SequenceStatus
+
+SubscribableStatus
|
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. +SubscribableStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract. |
(Appears on: -SequenceStatus) +ChannelableSpec, +Subscribable)
+
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
-channel
+subscribers
-
-Kubernetes core/v1.ObjectReference
+
+[]SubscriberSpec
|
- Channel is the reference to the underlying channel. - |
-
-ready
-
-knative.dev/pkg/apis.Condition
-
- |
-
- ReadyCondition indicates whether the Channel is ready or not. +This is the list of subscriptions for this subscribable. |
(Appears on: -Sequence) +ChannelableStatus, +Subscribable)
+
SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
-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
+subscribers
-
-ChannelTemplateSpec
+
+[]SubscriberStatus
|
-(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. +This is the list of subscription’s statuses for this channel. |
(Appears on: -Sequence) +SubscribableSpec)
-
SequenceStatus represents the current state of a Sequence.
+SubscriberSpec defines a single subscriber to a Subscribable.
+At least one of SubscriberURI and ReplyURI must be present
-Status
+uid
-knative.dev/pkg/apis/duck/v1.Status
+k8s.io/apimachinery/pkg/types.UID
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +(Optional) +UID is used to understand the origin of the subscriber. |
-subscriptionStatuses
+generation
-
-[]SequenceSubscriptionStatus
-
+int64
|
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. +(Optional) +Generation of the origin of the subscriber with uid:UID. |
-channelStatuses
+subscriberUri
-
-[]SequenceChannelStatus
-
+knative.dev/pkg/apis.URL
|
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. +(Optional) +SubscriberURI is the endpoint for the subscriber |
-AddressStatus
+replyUri
-knative.dev/pkg/apis/duck/v1.AddressStatus
+knative.dev/pkg/apis.URL
|
-
-(Members of AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} +(Optional) +ReplyURI is the endpoint for the reply + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ DeliverySpec contains options controlling the event delivery |
(Appears on: -SequenceSpec) +SubscribableStatus)
+
SubscriberStatus defines the status of a single subscriber to a Channel.
-Destination
+uid
-knative.dev/pkg/apis/duck/v1.Destination
+k8s.io/apimachinery/pkg/types.UID
|
-
-(Members of Subscriber receiving the step event +(Optional) +UID is used to understand the origin of the subscriber. |
-delivery
+observedGeneration
-
-DeliverySpec
-
+int64
|
(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. +Generation of the origin of the subscriber with uid:UID. |
-(Appears on: -SequenceStatus) -
--
-Field | -Description | -
---|---|
-subscription
+ready
-
-Kubernetes core/v1.ObjectReference
+
+Kubernetes core/v1.ConditionStatus
|
- Subscription is the reference to the underlying Subscription. +Status of the subscriber. |
-ready
+message
-knative.dev/pkg/apis.Condition
+string
|
- ReadyCondition indicates whether the Subscription is ready or not. +(Optional) +A human readable message indicating details of Ready status. |
-
Package v1beta1 is the v1beta1 version of the API.
+Package v1alpha1 is the v1alpha1 version of the API.
Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
+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.
-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.
|
@@ -7852,44 +8601,43 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ChannelSpec
+
+ChannelableSpec
|
- Spec defines the desired state of the Channel. +Spec is the part where the Channelable fulfills the Subscribable contract.
|
status
-
-ChannelStatus
+
+ChannelableStatus
|
-(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
+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.
-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.
|
@@ -7961,30 +8692,60 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-InMemoryChannelSpec
+
+ChannelableCombinedSpec
|
- Spec defines the desired state of the Channel. +Spec is the part where the Channelable fulfills the Subscribable contract.
|
status
-
-InMemoryChannelStatus
+
+ChannelableCombinedStatus
|
-(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.
+(Appears on: +ChannelableCombined) + ++
ChannelableSpec contains Spec of the Channelable object
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
+SubscribableTypeSpec
+
+
+SubscribableTypeSpec
+
+
|
-
-kind
-string
+
+(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. |
-Subscription |
-metadata
+SubscribableSpec
-
-Kubernetes meta/v1.ObjectMeta
+
+SubscribableSpec
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+
+(Members of SubscribableSpec is for the v1beta1 spec compatibility. |
-spec
+delivery
-
-SubscriptionSpec
+
+DeliverySpec
|
- - +(Optional) + DeliverySpec contains options controlling the event delivery + |
+
+(Appears on: +ChannelableCombined) +
++
ChannelableStatus contains the Status of a Channelable object.
+Field | +Description | +
---|---|
-channel
+Status
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.Status
|
- 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 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/v1alpha1.AddressStatus
|
-(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. +
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. |
-reply
+SubscribableTypeStatus
-knative.dev/pkg/apis/duck/v1.Destination
+
+SubscribableTypeStatus
+
|
-(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. +
+(Members of SubscribableTypeStatus is the v1alpha1 part of the Subscribers status |
-delivery
+SubscribableStatus
-
-DeliverySpec
+
+SubscribableStatus
|
-(Optional)
- Delivery configuration - |
-
+(Members of SubscribableStatus
are embedded into this type.)
+
SubscribableStatus is the v1beta1 part of the Subscribers status.
status
+errorChannel
-
-SubscriptionStatus
+
+Kubernetes core/v1.ObjectReference
ErrorChannel is set by the channel when it supports native error handling via a channel
-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- -(Appears on: -Channel) +Channelable)
-
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.
+ChannelableSpec contains Spec of the Channelable object
-channelTemplate
+SubscribableTypeSpec
-
-ChannelTemplateSpec
+
+SubscribableTypeSpec
|
- 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. +
+(Members of |
-ChannelableSpec
+delivery
-
-ChannelableSpec
+
+DeliverySpec
|
-
-(Members of Channel conforms to ChannelableSpec +(Optional) +DeliverySpec contains options controlling the event delivery |
(Appears on: -Channel) +Channelable)
-
ChannelStatus represents the current state of a Channel.
+ChannelableStatus contains the Status of a Channelable object.
-ChannelableStatus
+Status
-
-ChannelableStatus
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of Channel conforms to ChannelableStatus +inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-channel
+AddressStatus
-knative.dev/pkg/apis/duck/v1.KReference
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
- Channel is an KReference to the Channel CRD backing this Channel. - |
-
-(Appears on:
-ChannelSpec,
-ParallelSpec,
-SequenceSpec)
+(Members of AddressStatus
are embedded into this type.)
AddressStatus is the part where the Channelable fulfills the Addressable contract.
+ + +SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+
+(Members of SubscribableTypeStatus
are embedded into this type.)
Field | -Description | +
---|---|
-spec
+errorChannel
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+Kubernetes core/v1.ObjectReference
+
|
(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - ErrorChannel is set by the channel when it supports native error handling via a channel |
-
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that -we can easily create new Channels off of it.
+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.
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
-
-spec
-
-k8s.io/apimachinery/pkg/runtime.RawExtension
-
- |
-
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - |
-
(Appears on: -InMemoryChannel) +SubscribableTypeSpec)
-
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
+Subscribable is the schema for the subscribable portion of the spec +section of the resource.
-ChannelableSpec
+subscribers
-
-ChannelableSpec
+
+[]SubscriberSpec
|
-
-(Members of Channel conforms to Duck type Channelable. +This is the list of subscriptions for this subscribable. |
(Appears on: -InMemoryChannel) +SubscribableTypeStatus)
-
ChannelStatus represents the current state of a Channel.
+SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
-ChannelableStatus
+subscribers
-
-ChannelableStatus
+
+[]SubscriberStatus
|
-
-(Members of Channel conforms to Duck type Channelable. +This is the list of subscription’s statuses for this channel. |
-(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
+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.
-channel
+metadata
-
-Kubernetes core/v1.ObjectReference
+
+Kubernetes meta/v1.ObjectMeta
|
- 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.) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-subscriber
+spec
-knative.dev/pkg/apis/duck/v1.Destination
+
+SubscribableTypeSpec
+
|
-(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
+subscribable
-knative.dev/pkg/apis/duck/v1.Destination
+
+Subscribable
+
|
-(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. + |
+
delivery
+status
-
-DeliverySpec
+
+SubscribableTypeStatus
Delivery configuration
+SubscribableTypeStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract.
(Appears on: -Subscription) +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType)
-
SubscriptionStatus (computed) for a subscription
+SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
-Status
+subscribable
-knative.dev/pkg/apis/duck/v1.Status
+
+Subscribable
+
|
+ | +
-(Members of Status
are embedded into this type.)
+(Appears on:
+ChannelableCombinedStatus,
+ChannelableStatus,
+SubscribableType)
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.
-+
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+ +Field | +Description |
---|---|
-physicalSubscription
+subscribableStatus
-
-SubscriptionStatusPhysicalSubscription
+
+SubscribableStatus
|
- PhysicalSubscription is the fully resolved values that this Subscription represents. |
(Appears on: -SubscriptionStatus) +Subscribable)
-
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
+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
-subscriberUri
+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
|
- SubscriberURI is the fully resolved URI for spec.subscriber. +(Optional) |
-replyUri
+replyURI
knative.dev/pkg/apis.URL
|
- ReplyURI is the fully resolved URI for the spec.reply. +(Optional) |
-deadLetterSinkUri
+deadLetterSink
knative.dev/pkg/apis.URL
|
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. +(Optional) + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
++(Optional) |
-
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 is the Schema for the apiserversources API
@@ -8642,7 +9416,7 @@ Resource Types: string
-sources.knative.dev/v1alpha2
+sources.knative.dev/v1beta1
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -8671,7 +9445,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ApiServerSourceSpec
@@ -8702,7 +9476,7 @@ and modifications of the event sent to the sink.
resources
-
+
[]APIVersionKindSelector
@@ -8717,7 +9491,7 @@ selector to help filter.
owner
-
+
APIVersionKind
@@ -8764,7 +9538,7 @@ source. Defaults to default if not set.
status
-
+
ApiServerSourceStatus
@@ -8774,7 +9548,7 @@ ApiServerSourceStatus
-
ContainerSource is the Schema for the containersources API
@@ -8793,7 +9567,7 @@ ApiServerSourceStatus string
-sources.knative.dev/v1alpha2
+sources.knative.dev/v1beta1
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -8822,7 +9596,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ContainerSourceSpec
@@ -8853,7 +9627,7 @@ and modifications of the event sent to the sink.
template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -8869,7 +9643,7 @@ Kubernetes core/v1.PodTemplateSpec
status
-
+
ContainerSourceStatus
@@ -8879,7 +9653,7 @@ ContainerSourceStatus
-
PingSource is the Schema for the PingSources API.
@@ -8898,7 +9672,7 @@ ContainerSourceStatus string
-sources.knative.dev/v1alpha2
+sources.knative.dev/v1beta1
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -8927,7 +9701,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
PingSourceSpec
@@ -8968,6 +9742,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
@@ -8987,7 +9775,7 @@ to “application/json”.
status
-
+
PingSourceStatus
@@ -8997,7 +9785,7 @@ PingSourceStatus
SinkBinding describes a Binding that is also a Source. @@ -9021,7 +9809,7 @@ cloud events.
string
-sources.knative.dev/v1alpha2
+sources.knative.dev/v1beta1
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -9050,7 +9838,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
SinkBindingSpec
@@ -9081,14 +9869,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.
status
-
+
SinkBindingStatus
@@ -9110,12 +9898,11 @@ SinkBindingStatus
-(Appears on: -ApiServerSourceSpec, -ApiServerSourceSpec) +ApiServerSourceSpec)
APIVersionKind is an APIVersion and Kind tuple.
@@ -9153,11 +9940,11 @@ More info: APIVersionKindSelector +(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)
APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
@@ -9197,7 +9984,7 @@ More info: + Kubernetes meta/v1.LabelSelector @@ -9211,11 +9998,11 @@ More info: ApiServerSourceSpec +(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceSpec defines the desired state of ApiServerSource
@@ -9250,7 +10037,7 @@ and modifications of the event sent to the sink.resources
-
+
[]APIVersionKindSelector
@@ -9265,7 +10052,7 @@ selector to help filter.
owner
-
+
APIVersionKind
@@ -9307,11 +10094,11 @@ source. Defaults to default if not set.
-(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceStatus defines the observed state of ApiServerSource
@@ -9346,11 +10133,11 @@ Source. -(Appears on: -ContainerSource) +ContainerSource)
ContainerSourceSpec defines the desired state of ContainerSource
@@ -9385,7 +10172,7 @@ and modifications of the event sent to the sink.template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -9396,11 +10183,11 @@ Kubernetes core/v1.PodTemplateSpec
-(Appears on: -ContainerSource) +ContainerSource)
ContainerSourceStatus defines the observed state of ContainerSource
@@ -9435,11 +10222,11 @@ Source. -(Appears on: -PingSource) +PingSource)
PingSourceSpec defines the desired state of the PingSource.
@@ -9484,6 +10271,20 @@ stringtimezone
+
+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
@@ -9498,11 +10299,11 @@ to “application/json”.
(Appears on: -PingSource) +PingSource)
PingSourceStatus defines the observed state of PingSource.
@@ -9537,11 +10338,11 @@ Source. -(Appears on: -SinkBinding) +SinkBinding)
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
@@ -9576,25 +10377,25 @@ 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.
(Appears on: -SinkBinding) +SinkBinding)
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
@@ -9632,5 +10433,5 @@ Source.
Generated with gen-crd-api-reference-docs
-on git commit 74b9bed2
.
+on git commit 0f9a8c55c
.
Packages:
+
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
+ +Resource Types: + ++
DomainMapping is a mapping from a custom hostname to an Addressable.
+ +Field | +Description | +||
---|---|---|---|
+apiVersion
+string |
+
+
+serving.knative.dev/v1alpha1
+
+ |
+||
+kind
+string
+ |
+DomainMapping |
+||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+ Standard object’s metadata. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata +Refer to the Kubernetes API documentation for the fields of the +metadata field.
+ |
+||
+spec
+
+
+DomainMappingSpec
+
+
+ |
+
+(Optional)
+ Spec is the desired state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status ++ +
|
+||
+status
+
+
+DomainMappingStatus
+
+
+ |
+
+(Optional)
+ Status is the current state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + |
+
+
CannotConvertError is returned when a field cannot be converted.
+ +Field | +Description | +
---|---|
+Message
+
+string
+
+ |
++ | +
+Field
+
+string
+
+ |
++ | +
+(Appears on: +DomainMapping) +
++
DomainMappingSpec describes the DomainMapping the user wishes to exist.
+ +Field | +Description | +
---|---|
+ref
+
+knative.dev/pkg/apis/duck/v1.KReference
+
+ |
+
+ Ref points to an Addressable. +Currently, Ref must be a KSvc. + |
+
+(Appears on: +DomainMapping) +
++
DomainMappingStatus describes the current state of the DomainMapping.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of |
+
+url
+
+knative.dev/pkg/apis.URL
+
+ |
+
+(Optional)
+ URL is the URL of this DomainMapping. + |
+
+address
+
+knative.dev/pkg/apis/duck/v1.Addressable
+
+ |
+
+(Optional)
+ Address holds the information needed for a DomainMapping to be the target of an event. + |
+
+
Package v1alpha1 contains the Autoscaling v1alpha1 API types.
+ +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/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit
+ +Field | +Description | +||||||||
---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+autoscaling.internal.knative.dev/v1alpha1
+
+ |
+||||||||
+kind
+string
+ |
+PodAutoscaler |
+||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec
+
+
+PodAutoscalerSpec
+
+
+ |
+
+(Optional)
+ Spec holds the desired state of the PodAutoscaler (from the client). ++ +
|
+||||||||
+status
+
+
+PodAutoscalerStatus
+
+
+ |
+
+(Optional)
+ Status communicates the observed state of the PodAutoscaler (from the controller). + |
+
+
Metric represents a resource to configure the metric collector with.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+MetricSpec
+
+
+ |
+
+(Optional)
+ Spec holds the desired state of the Metric (from the client). ++ +
|
+||||||
+status
+
+
+MetricStatus
+
+
+ |
+
+(Optional)
+ Status communicates the observed state of the Metric (from the controller). + |
+
+(Appears on: +Metric) +
++
MetricSpec contains all values a metric collector needs to operate.
+ +Field | +Description | +
---|---|
+stableWindow
+
+time.Duration
+
+ |
+
+ StableWindow is the aggregation window for metrics in a stable state. + |
+
+panicWindow
+
+time.Duration
+
+ |
+
+ PanicWindow is the aggregation window for metrics where quick reactions are needed. + |
+
+scrapeTarget
+
+string
+
+ |
+
+ ScrapeTarget is the K8s service that publishes the metric endpoint. + |
+
+(Appears on: +Metric) +
++
MetricStatus reflects the status of metric collection for this specific entity.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of |
+
+(Appears on: +PodAutoscaler) +
++
PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).
+ +Field | +Description | +
---|---|
+containerConcurrency
+
+int64
+
+ |
+
+(Optional)
+ ContainerConcurrency specifies the maximum allowed
+in-flight (concurrent) requests per container of the Revision.
+Defaults to |
+
+scaleTargetRef
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ ScaleTargetRef defines the /scale-able resource that this PodAutoscaler +is responsible for quickly right-sizing. + |
+
+reachability
+
+
+ReachabilityType
+
+
+ |
+
+(Optional)
+ Reachability specifies whether or not the |
+
+protocolType
+
+knative.dev/networking/pkg/apis/networking.ProtocolType
+
+ |
+
+ The application-layer protocol. Matches |
+
+(Appears on: +PodAutoscaler) +
++
PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of |
+
+serviceName
+
+string
+
+ |
+
+ ServiceName is the K8s Service name that serves the revision, scaled by this PA. +The service is created and owned by the ServerlessService object owned by this PA. + |
+
+metricsServiceName
+
+string
+
+ |
+
+ MetricsServiceName is the K8s Service name that provides revision metrics. +The service is managed by the PA object. + |
+
+desiredScale
+
+int32
+
+ |
+
+ DesiredScale shows the current desired number of replicas for the revision. + |
+
+actualScale
+
+int32
+
+ |
+
+ ActualScale shows the actual number of replicas for the revision. + |
+
+
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.
Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+PodScalableSpec
+
+
+ |
+
+ + +
|
+||||||
+status
+
+
+PodScalableStatus
+
+
+ |
++ | +
+(Appears on: +PodScalable) +
++
PodScalableSpec is the specification for the desired state of a +PodScalable (or at least our shared portion).
+ +Field | +Description | +
---|---|
+replicas
+
+int32
+
+ |
++ | +
+selector
+
+
+Kubernetes meta/v1.LabelSelector
+
+
+ |
++ | +
+template
+
+
+Kubernetes core/v1.PodTemplateSpec
+
+
+ |
++ | +
+(Appears on: +PodScalable) +
++
PodScalableStatus is the observed state of a PodScalable (or at +least our shared portion).
+ +Field | +Description | +
---|---|
+replicas
+
+int32
+
+ |
++ | +
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.
Resource Types:metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -149,7 +1049,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -178,7 +1078,7 @@ RevisionSpec
PodSpec
-
+
Kubernetes core/v1.PodSpec
@@ -275,7 +1175,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -378,7 +1278,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -646,7 +1546,7 @@ string
PodSpec
-
+
Kubernetes core/v1.PodSpec
@@ -808,7 +1708,7 @@ Based on:
+
Kubernetes meta/v1.ObjectMeta
@@ -837,7 +1737,7 @@ RevisionSpec
PodSpec
-
+
Kubernetes core/v1.PodSpec
@@ -1273,5 +2173,5 @@ a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)<
Generated with gen-crd-api-reference-docs
-on git commit af83e581d
.
+on git commit db4879e0f
.
Packages:
-
Package v1beta1 is the v1beta1 version of the API.
+Package v1 is the v1 version of the API.
Resource Types:string
alias)(Appears on: -DeliverySpec) +DeliverySpec)
BackoffPolicyType is the type for backoff policies
-
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers @@ -77,7 +77,7 @@ Channelable ObjectReferences and access their subscription and address data. Th
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -91,7 +91,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ChannelableSpec
@@ -105,7 +105,7 @@ ChannelableSpec
SubscribableSpec
-
+
SubscribableSpec
@@ -120,7 +120,7 @@ SubscribableSpec
delivery
-
+
DeliverySpec
@@ -137,7 +137,7 @@ DeliverySpec
status
-
+
ChannelableStatus
@@ -147,13 +147,13 @@ ChannelableStatus
-(Appears on: -ChannelSpec, -Channelable, -InMemoryChannelSpec) +ChannelSpec, +Channelable, +InMemoryChannelSpec)
ChannelableSpec contains Spec of the Channelable object
@@ -170,7 +170,7 @@ ChannelableStatusSubscribableSpec
-
+
SubscribableSpec
@@ -185,7 +185,7 @@ SubscribableSpec
delivery
-
+
DeliverySpec
@@ -197,13 +197,13 @@ DeliverySpec
-(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) +ChannelStatus, +Channelable, +InMemoryChannelStatus)
ChannelableStatus contains the Status of a Channelable object.
@@ -250,7 +250,7 @@ knative.dev/pkg/apis/duck/v1.AddressStatusSubscribableStatus
-
+
SubscribableStatus
@@ -277,19 +277,16 @@ Failed messages are delivered here.
-(Appears on: -BrokerSpec, -ChannelableCombinedSpec, -ChannelableSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriberSpec, -SubscriptionSpec) +BrokerSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, +SubscriptionSpec)
DeliverySpec contains the delivery options for event senders, @@ -333,7 +330,7 @@ sending an event before moving it to the dead letter sink.
backoffPolicy
-
+
BackoffPolicyType
@@ -362,7 +359,7 @@ For exponential policy, backoff delay is backoffDelay*2^
DeliveryStatus contains the Status of an object supporting delivery options.
@@ -390,7 +387,7 @@ where failed events are sent to. -
Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers @@ -409,7 +406,7 @@ SubscribableType ObjectReferences and access the Subscription data. This is not
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -423,7 +420,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
SubscribableSpec
@@ -438,7 +435,7 @@ configured as to be compatible with Subscribable contract.
subscribers
-
+
[]SubscriberSpec
@@ -454,7 +451,7 @@ configured as to be compatible with Subscribable contract.
status
-
+
SubscribableStatus
@@ -466,13 +463,12 @@ configured as to be compatible with Subscribable contract.
-(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -Subscribable) +ChannelableSpec, +Subscribable)
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
@@ -489,7 +485,7 @@ configured as to be compatible with Subscribable contract.subscribers
-
+
[]SubscriberSpec
@@ -500,13 +496,12 @@ configured as to be compatible with Subscribable contract.
-(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -Subscribable) +ChannelableStatus, +Subscribable)
SubscribableStatus is the schema for the subscribable’s status portion of the status @@ -524,7 +519,7 @@ section of the resource.
subscribers
-
+
[]SubscriberStatus
@@ -535,11 +530,11 @@ section of the resource.
-(Appears on: -SubscribableSpec) +SubscribableSpec)
SubscriberSpec defines a single subscriber to a Subscribable.
@@ -605,7 +600,7 @@ knative.dev/pkg/apis.URLdelivery
-
+
DeliverySpec
@@ -617,12 +612,11 @@ DeliverySpec
-(Appears on: -SubscribableStatus, -SubscribableStatus) +SubscribableStatus)
SubscriberStatus defines the status of a single subscriber to a Channel.
@@ -663,7 +657,7 @@ int64ready
-
+
Kubernetes core/v1.ConditionStatus
@@ -687,24 +681,18 @@ string
-
Package v1 is the v1 version of the API.
+Package v1alpha1 is the v1alpha1 version of the API.
Resource Types: - --
Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Subscribers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.
+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.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1
-
- |
-||||||||
-kind
-string
- |
-Broker |
-||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -750,43 +720,43 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-BrokerSpec
+
+ChannelableSpec
|
- Spec defines the desired state of the Broker. +Spec is the part where the Channelable fulfills the Subscribable contract.
|
status
-
-BrokerStatus
+
+ChannelableStatus
|
-(Optional)
- Status represents the current state of the Broker. This data may be out of -date. |
-
Trigger represents a request to have events delivered to a subscriber from a -Broker’s event pool.
+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.
-apiVersion
-string |
-
-
-eventing.knative.dev/v1
-
- |
-||||||||||
-kind
-string
- |
-Trigger |
-||||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -859,52 +811,60 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-TriggerSpec
+
+ChannelableCombinedSpec
|
- Spec defines the desired state of the Trigger. +Spec is the part where the Channelable fulfills the Subscribable contract.
|
status
-
-TriggerStatus
+
+ChannelableCombinedStatus
|
-(Optional)
- Status represents the current state of the Trigger. This data may be out of -date. |
(Appears on: -Broker) +ChannelableCombined)
+
ChannelableSpec contains Spec of the Channelable object
-config
+SubscribableTypeSpec
-knative.dev/pkg/apis/duck/v1.KReference
+
+SubscribableTypeSpec
+
|
-(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. +
+(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. + |
+
+SubscribableSpec
+
+
+SubscribableSpec
+
+
+ |
+
+
+(Members of SubscribableSpec is for the v1beta1 spec compatibility. |
delivery
-
+
DeliverySpec
|
(Optional)
- Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc. +DeliverySpec contains options controlling the event delivery |
(Appears on: -Broker) +ChannelableCombined)
-
BrokerStatus represents the current state of a Broker.
+ChannelableStatus contains the Status of a Channelable object.
-address
+AddressStatus
-knative.dev/pkg/apis/duck/v1.Addressable
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
- Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh. +
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. |
SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+
-(Appears on:
-TriggerSpec)
+(Members of SubscribableTypeStatus
are embedded into this type.)
SubscribableTypeStatus is the v1alpha1 part of the Subscribers status
+SubscribableStatus
+
+
+SubscribableStatus
+
+
+
+(Members of SubscribableStatus
are embedded into this type.)
Field | -Description | +
---|---|
-attributes
+errorChannel
-
-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. +ErrorChannel is set by the channel when it supports native error handling via a channel |
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) +Channelable)
+
ChannelableSpec contains Spec of the Channelable object
-broker
+SubscribableTypeSpec
-string
+
+SubscribableTypeSpec
+
|
- Broker is the broker that this trigger receives events from. +
+(Members of |
-filter
+delivery
-
-TriggerFilter
+
+DeliverySpec
|
(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. +DeliverySpec contains options controlling the event delivery |
(Appears on: -Trigger) +Channelable)
-
TriggerStatus represents the current state of a Trigger.
+ChannelableStatus contains the Status of a Channelable object.
-subscriberUri
+AddressStatus
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
|
- SubscriberURI is the resolved URI of the receiver for this Trigger. +
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. |
SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+-
Package v1beta1 is the v1beta1 version of the API.
+(Members ofSubscribableTypeStatus
are embedded into this type.)
-Resource Types:
-Subscribers is populated with the statuses of each of the Channelable’s subscribers.
+errorChannel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ErrorChannel is set by the channel when it supports native error handling via a channel
+-
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
+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.
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
+
+
+(Appears on: +SubscribableTypeSpec) +
++
Subscribable is the schema for the subscribable portion of the spec +section of the resource.
+ +Field | +Description | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-spec
+subscribers
-
-ParallelSpec
-
-
- |
-
- Spec defines the desired state of the Parallel. -- -
|
+
Field | +Description |
---|---|
-status
+subscribers
-
-ParallelStatus
+
+[]SubscriberStatus
|
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. +This is the list of subscription’s statuses for this channel. |
-(Appears on: -ParallelSpec) -
-+
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.
-filter
+metadata
-knative.dev/pkg/apis/duck/v1.Destination
+
+Kubernetes meta/v1.ObjectMeta
+
|
-(Optional)
- Filter is the expression guarding the branch +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-subscriber
+spec
-knative.dev/pkg/apis/duck/v1.Destination
+
+SubscribableTypeSpec
+
|
- Subscriber receiving the event when the filter passes - |
-
-reply
+subscribable
-knative.dev/pkg/apis/duck/v1.Destination
+
+Subscribable
+
|
-(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
+status
-
-DeliverySpec
+
+SubscribableTypeStatus
Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. -Needed for Roundtripping v1alpha1 <-> v1beta1.
+SubscribableTypeStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract.
(Appears on: -ParallelStatus) +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType)
-
ParallelBranchStatus represents the current state of a Parallel branch
+SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
-filterSubscriptionStatus
-
-
-ParallelSubscriptionStatus
-
-
- |
-
- FilterSubscriptionStatus corresponds to the filter subscription status. - |
-
-filterChannelStatus
-
-
-ParallelChannelStatus
-
-
- |
-
- FilterChannelStatus corresponds to the filter channel status. - |
-
-subscriberSubscriptionStatus
+subscribable
-
-ParallelSubscriptionStatus
+
+Subscribable
|
- SubscriptionStatus corresponds to the subscriber subscription status. |
(Appears on: -ParallelBranchStatus, -ParallelStatus) +ChannelableCombinedStatus, +ChannelableStatus, +SubscribableType)
+
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
-channel
+subscribableStatus
-
-Kubernetes core/v1.ObjectReference
+
+SubscribableStatus
|
- 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) +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
-branches
+uid
-
-[]ParallelBranch
-
+k8s.io/apimachinery/pkg/types.UID
|
- Branches is the list of Filter/Subscribers pairs. +(Optional) +UID is used to understand the origin of the subscriber. |
-channelTemplate
+generation
-
-ChannelTemplateSpec
-
+int64
|
(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). +Generation of the origin of the subscriber with uid:UID. |
-reply
+subscriberURI
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis.URL
|
(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
+replyURI
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis.URL
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +(Optional) |
-ingressChannelStatus
+deadLetterSink
-
-ParallelChannelStatus
-
+knative.dev/pkg/apis.URL
|
- IngressChannelStatus corresponds to the ingress channel status. +(Optional) |
-branchStatuses
+delivery
-
-[]ParallelBranchStatus
+
+DeliverySpec
|
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. - |
-
-AddressStatus
-
-knative.dev/pkg/apis/duck/v1.AddressStatus
-
- |
-
-
-(Members of AddressStatus is the starting point to this Parallel. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} +(Optional) |
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: +string
alias)(Appears on: -ParallelBranchStatus) +DeliverySpec)
+
BackoffPolicyType is the type for backoff policies
-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.
+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.
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -1664,55 +1550,43 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SequenceSpec
+
+ChannelableSpec
|
- Spec defines the desired state of the Sequence. +Spec is the part where the Channelable fulfills the Subscribable contract.
|
status
-
-SequenceStatus
+
+ChannelableStatus
|
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. |
(Appears on: -SequenceStatus) +ChannelSpec, +Channelable, +InMemoryChannelSpec)
+
ChannelableSpec contains Spec of the Channelable object
-channel
+SubscribableSpec
-
-Kubernetes core/v1.ObjectReference
+
+SubscribableSpec
|
- Channel is the reference to the underlying channel. +
+(Members of |
-ready
+delivery
-knative.dev/pkg/apis.Condition
+
+DeliverySpec
+
|
- ReadyCondition indicates whether the Channel is ready or not. +(Optional) +DeliverySpec contains options controlling the event delivery |
(Appears on: -Sequence) +ChannelStatus, +Channelable, +InMemoryChannelStatus)
+
ChannelableStatus contains the Status of a Channelable object.
-steps
+Status
-
-[]SequenceStep
-
+knative.dev/pkg/apis/duck/v1.Status
|
- Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options +
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-channelTemplate
+AddressStatus
-
-ChannelTemplateSpec
+knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ |
+
+
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. + |
+
+SubscribableStatus
+
+
+SubscribableStatus
|
-(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). +
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. |
-reply
+deadLetterChannel
-knative.dev/pkg/apis/duck/v1.Destination
+knative.dev/pkg/apis/duck/v1.KReference
|
(Optional)
- Reply is a Reference to where the result of the last Subscriber gets sent to. +DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel +Failed messages are delivered here. |
(Appears on: -Sequence) +BrokerSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, +SubscriberSpec, +SubscriptionSpec)
-
SequenceStatus represents the current state of a Sequence.
+DeliverySpec contains the delivery options for event senders, +such as channelable and source.
-Status
+deadLetterSink
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +(Optional) +DeadLetterSink is the sink receiving event that could not be sent to +a destination. |
-subscriptionStatuses
+retry
-
-[]SequenceSubscriptionStatus
-
+int32
|
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. +(Optional) +Retry is the minimum number of retries the sender should attempt when +sending an event before moving it to the dead letter sink. |
-channelStatuses
+backoffPolicy
-
-[]SequenceChannelStatus
+
+BackoffPolicyType
|
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. +(Optional) +BackoffPolicy is the retry backoff policy (linear, exponential). |
-AddressStatus
+backoffDelay
-knative.dev/pkg/apis/duck/v1.AddressStatus
+string
|
-
-(Members of AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} +(Optional) +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* |
-(Appears on: -SequenceSpec) -
-+
DeliveryStatus contains the Status of an object supporting delivery options.
-Destination
+deadLetterChannel
-knative.dev/pkg/apis/duck/v1.Destination
+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. + |
+
-(Members of Destination
are embedded into this type.)
+
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.
-Subscriber receiving the step event
+Field | +Description | +||
---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
|
||
-delivery
+spec
-
-DeliverySpec
+
+SubscribableSpec
|
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. +SubscribableSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract. ++ +
|
+||
+status
+
+
+SubscribableStatus
+
+
+ |
+
+ SubscribableStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract. |
(Appears on: -SequenceStatus) +ChannelableCombinedSpec, +ChannelableSpec, +Subscribable)
+
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
-subscription
+subscribers
-
-Kubernetes core/v1.ObjectReference
+
+[]SubscriberSpec
|
- Subscription is the reference to the underlying Subscription. +This is the list of subscriptions for this subscribable. |
+(Appears on: +ChannelableCombinedStatus, +ChannelableStatus, +Subscribable) +
++
SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
+ +Field | +Description | +
---|---|
-ready
+subscribers
-knative.dev/pkg/apis.Condition
+
+[]SubscriberStatus
+
|
- ReadyCondition indicates whether the Subscription is ready or not. +This is the list of subscription’s statuses for this channel. |
-
Package v1 is the v1 version of the API.
+(Appears on: +SubscribableSpec) -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
+SubscriberSpec defines a single subscriber to a Subscribable.
+At least one of SubscriberURI and ReplyURI must be present
-apiVersion
-string |
-
-
-messaging.knative.dev/v1
-
- |
-||||
-kind
-string
- |
-Channel |
-||||
-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
+generation
-
-ChannelSpec
-
+int64
|
- Spec defines the desired state of the Channel. -- -
ReplyURI is the endpoint for the reply |
||||
-status
+delivery
-
-ChannelStatus
+
+DeliverySpec
|
(Optional)
- Status represents the current state of the Channel. This data may be out of -date. +DeliverySpec contains options controlling the event delivery |
-
InMemoryChannel is a resource representing an in memory channel
+(Appears on: +SubscribableStatus, +SubscribableStatus) -Field | @@ -2141,91 +2096,67 @@ date.|||
---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1
-
- |
-||
-kind
-string
- |
-InMemoryChannel |
-||
-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
+observedGeneration
-
-InMemoryChannelSpec
-
+int64
|
- Spec defines the desired state of the Channel. -- -
Status of the subscriber. |
||
-status
+message
-
-InMemoryChannelStatus
-
+string
|
(Optional)
- Status represents the current state of the Channel. This data may be out of -date. +A human readable message indicating details of Ready status. |
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: +-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
-apiVersion
-string |
-
-
-messaging.knative.dev/v1
-
- |
-|||||||||||
-kind
-string
- |
-Subscription |
-|||||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -2270,54 +2185,42 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SubscriptionSpec
+
+ParallelSpec
|
+ Spec defines the desired state of the Parallel.
|
status
-
-SubscriptionStatus
+
+ParallelStatus
|
+(Optional)
+ Status represents the current state of the Parallel. This data may be out of +date. |
-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- -(Appears on: -Channel) +ParallelSpec)
-
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.
-channelTemplate
+filter
-
-ChannelTemplateSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. -This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user. +(Optional) +Filter is the expression guarding the branch |
-ChannelableSpec
+subscriber
-
-ChannelableSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of Channel conforms to ChannelableSpec +Subscriber receiving the event when the filter passes |
-(Appears on: -Channel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | -
---|---|
-ChannelableStatus
+reply
-
-ChannelableStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of Channel conforms to ChannelableStatus +(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 |
-channel
+delivery
-knative.dev/pkg/apis/duck/v1.KReference
+
+DeliverySpec
+
|
- Channel is an KReference to the Channel CRD backing this Channel. +(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: -ChannelSpec, -ParallelSpec, -SequenceSpec) +ParallelStatus)
+
ParallelBranchStatus represents the current state of a Parallel branch
-spec
+filterSubscriptionStatus
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ParallelSubscriptionStatus
+
|
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - FilterSubscriptionStatus corresponds to the filter subscription status. |
-
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that -we can easily create new Channels off of it.
- -Field | -Description | -
---|---|
-metadata
+filterChannelStatus
-
-Kubernetes meta/v1.ObjectMeta
+
+ParallelChannelStatus
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+FilterChannelStatus corresponds to the filter channel status. |
-spec
+subscriberSubscriptionStatus
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ParallelSubscriptionStatus
+
|
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - SubscriptionStatus corresponds to the subscriber subscription status. |
(Appears on: -InMemoryChannel) +ParallelBranchStatus, +ParallelStatus)
-
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
-ChannelableSpec
+channel
-
-ChannelableSpec
+
+Kubernetes core/v1.ObjectReference
|
-
-(Members of Channel conforms to Duck type Channelable. +Channel is the reference to the underlying channel. |
-(Appears on: -InMemoryChannel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | -
---|---|
-ChannelableStatus
+ready
-
-ChannelableStatus
-
+knative.dev/pkg/apis.Condition
|
-
-(Members of Channel conforms to Duck type Channelable. +ReadyCondition indicates whether the Channel is ready or not. |
(Appears on: -Subscription) +Parallel)
-
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
-channel
+branches
-
-Kubernetes core/v1.ObjectReference
+
+[]ParallelBranch
|
- 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.) +Branches is the list of Filter/Subscribers pairs. |
-subscriber
+channelTemplate
-knative.dev/pkg/apis/duck/v1.Destination
+
+ChannelTemplateSpec
+
|
(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. +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). |
(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. - |
-|
-delivery
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- Delivery configuration +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: -Subscription) +Parallel)
-
SubscriptionStatus (computed) for a subscription
+ParallelStatus represents the current state of a Parallel.
-physicalSubscription
+ingressChannelStatus
-
-SubscriptionStatusPhysicalSubscription
+
+ParallelChannelStatus
|
- PhysicalSubscription is the fully resolved values that this Subscription represents. +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: -SubscriptionStatus) +ParallelBranchStatus)
-
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
-subscriberUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- SubscriberURI is the fully resolved URI for spec.subscriber. - |
-
-replyUri
+subscription
-knative.dev/pkg/apis.URL
+
+Kubernetes core/v1.ObjectReference
+
|
- ReplyURI is the fully resolved URI for the spec.reply. +Subscription is the reference to the underlying Subscription. |
-deadLetterSinkUri
+ready
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis.Condition
|
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. +ReadyCondition indicates whether the Subscription is ready or not. |
-
Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
+Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha2
-
- |
-||||||||||||||
-kind
-string
- |
-ApiServerSource |
-||||||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
+
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -2885,90 +2639,55 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ApiServerSourceSpec
+
+SequenceSpec
|
+ Spec defines the desired state of the Sequence.
|
status
-
-ApiServerSourceStatus
+
+SequenceStatus
|
+(Optional)
+ Status represents the current state of the Sequence. This data may be out of +date. |
-
ContainerSource is the Schema for the containersources API
+(Appears on: +SequenceStatus) + +
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha2
-
- |
-
-kind
-string
- |
-ContainerSource |
-
-metadata
+channel
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes core/v1.ObjectReference
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Channel is the reference to the underlying channel. |
-spec
+ready
-
-ContainerSourceSpec
-
+knative.dev/pkg/apis.Condition
|
- - + ReadyCondition indicates whether the Channel is ready or not. + |
+
+(Appears on: +Sequence) +
++
Field | +Description | +
---|---|
-SourceSpec
+steps
-knative.dev/pkg/apis/duck/v1.SourceSpec
+
+[]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. +Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options |
-template
+channelTemplate
-
-Kubernetes core/v1.PodTemplateSpec
+
+ChannelTemplateSpec
|
- Template describes the pods that will be created - |
-
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
Reply is a Reference to where the result of the last Subscriber gets sent to.
-
PingSource is the Schema for the PingSources 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. |
-PingSource |
||||||||||||||||||||||
-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
-
-PingSourceSpec
+
+[]SequenceChannelStatus
|
- - -
SequenceStep +++(Appears on: +SequenceSpec) + ++ +
|
+
Field | +Description |
---|---|
-status
+subscription
-
-PingSourceStatus
+
+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 contains API Schema definitions for the sources v1beta1 API group.
+ +Resource Types: +-
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.
ApiServerSource is the Schema for the apiserversources API
-sources.knative.dev/v1alpha2
+sources.knative.dev/v1beta1
|
@@ -3244,13 +3022,13 @@ sources.knative.dev/v1alpha2
SinkBinding |
+ApiServerSource |
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -3264,8 +3042,8 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-SinkBindingSpec
+
+ApiServerSourceSpec
|
@@ -3293,88 +3071,84 @@ and modifications of the event sent to the sink.
-BindingSpec
+resources
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+[]APIVersionKindSelector
+
|
-
-(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations. - |
-
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
-
-SinkBindingStatus
+
+APIVersionKind
ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.
-(Appears on: -ApiServerSourceSpec, -ApiServerSourceSpec) -
--
APIVersionKind is an APIVersion and Kind tuple.
- -Field | -Description | +
+mode
+
+string
+
+ |
+
+(Optional)
+ EventMode controls the format of the event.
+ |
---|---|---|---|
-apiVersion
+serviceAccountName
string
|
- APIVersion - the API version of the resource to watch. +(Optional) +ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set. + |
+
kind
+status
-string
+
+ApiServerSourceStatus
+
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.
+ContainerSource is the Schema for the containersources API
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|
-selector
+spec
-
-Kubernetes meta/v1.LabelSelector
+
+ContainerSourceSpec
|
-(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
@@ -3462,73 +3222,38 @@ and modifications of the event sent to the sink.
| |
-resources
+template
-
-[]APIVersionKindSelector
+
+Kubernetes core/v1.PodTemplateSpec
|
- 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. +Template describes the pods that will be created + |
+
owner
+status
-
-APIVersionKind
+
+ContainerSourceStatus
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
-
-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
-
-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
+PingSource is the Schema for the PingSources API.
-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. +
+sources.knative.dev/v1beta1
+
|
-(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. +kind
+string
|
+PingSource |
-template
+metadata
-
-Kubernetes core/v1.PodTemplateSpec
+
+Kubernetes meta/v1.ObjectMeta
|
- Template describes the pods that will be created +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-(Appears on: -ContainerSource) -
--
ContainerSourceStatus defines the observed state of ContainerSource
- -Field | -Description | -
---|---|
-SourceStatus
+spec
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+PingSourceSpec
+
|
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-(Appears on: -PingSource) -
--
PingSourceSpec defines the desired state of the PingSource.
- +Field | -Description | -
---|---|
SourceSpec
@@ -3698,6 +3339,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
@@ -3710,55 +3365,32 @@ the sink. Default is empty. If set, datacontenttype will also be set
to “application/json”.
|
-(Appears on: -PingSource) -
--
PingSourceStatus defines the observed state of PingSource.
- -Field | -Description | +
---|---|
-SourceStatus
+status
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+PingSourceStatus
+
|
-
-(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).
+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.
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
+apiVersion
+string |
+
+
+sources.knative.dev/v1beta1
+
|
+
-
-(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. +kind
+string
|
+SinkBinding |
-BindingSpec
+metadata
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations. - |
-
-(Appears on: -SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: - --
ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
- -Field | -Description | -||||||||
---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-configs.internal.knative.dev/v1alpha1
-
- |
-||||||||
-kind
-string
- |
-ConfigMapPropagation |
-||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -3901,39 +3435,47 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ConfigMapPropagationSpec
+
+SinkBindingSpec
|
- Spec defines the desired state of the ConfigMapPropagation
|
status
-
-ConfigMapPropagationStatus
+
+SinkBindingStatus
|
-(Optional)
- Status represents the current state of the EventType. -This data may be out of date. |
(Appears on: -ConfigMapPropagation) +ApiServerSourceSpec)
+
APIVersionKind is an APIVersion and Kind tuple.
-originalNamespace
+apiVersion
string
|
- OriginalNamespace is the namespace where the original configMaps are in +APIVersion - the API version of the resource to watch. |
-selector
+kind
-
-Kubernetes meta/v1.LabelSelector
-
+string
|
-(Optional)
- Selector only selects original configMaps with corresponding labels +Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
(Appears on: -ConfigMapPropagation) +ApiServerSourceSpec)
-
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
+APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
-Status
+apiVersion
-knative.dev/pkg/apis/duck/v1.Status
+string
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +APIVersion - the API version of the resource to watch. |
-copyConfigmaps
+kind
-
-[]ConfigMapPropagationStatusCopyConfigMap
+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)
- CopyConfigMaps is the status for each copied configmap. +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: -ConfigMapPropagationStatus) +ApiServerSource)
-
ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
+ApiServerSourceSpec defines the desired state of ApiServerSource
-name
-
-string
-
- |
-
- Name is copy configmap’s name - |
-
-source
+SourceSpec
-string
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
- Source is “originalNamespace/originalConfigMapName” +
+(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. |
-operation
+resources
-string
+
+[]APIVersionKindSelector
+
|
- Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop +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. |
-ready
+owner
-string
+
+APIVersionKind
+
|
- Ready represents the operation is ready or not +(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. |
-reason
+mode
string
|
- Reason indicates reasons if the operation is not ready +(Optional) +EventMode controls the format of the event.
+ |
-resourceVersionFromSource
+serviceAccountName
string
|
- ResourceVersion is the resourceVersion of original configmap +(Optional) +ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set. |
-
Package v1beta1 is the v1beta1 version of the API.
+(Appears on: +ApiServerSource) -Resource Types: - --
Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.
+ApiServerSourceStatus defines the observed state of ApiServerSource
-apiVersion
-string |
+
-
-eventing.knative.dev/v1beta1
-
+
+(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 | +|
---|---|---|
-kind
-string
+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. |
-Broker |
-metadata
+template
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes core/v1.PodTemplateSpec
|
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Template describes the pods that will be created |
+(Appears on: +ContainerSource) +
++
ContainerSourceStatus defines the observed state of ContainerSource
+ +Field | +Description | +
---|---|
-spec
+SourceStatus
-
-BrokerSpec
-
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
- Spec defines the desired state of the Broker. -- +
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. + |
+
+(Appears on: +PingSource) +
++
PingSourceSpec defines the desired state of the PingSource.
+Field | +Description | +
---|---|
-config
+SourceSpec
-knative.dev/pkg/apis/duck/v1.KReference
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink. + |
+
+schedule
+
+string
|
(Optional)
- Config is a KReference to the configuration that specifies -configuration options for this Broker. For example, this could be -a pointer to a ConfigMap. +Schedule is the cronjob schedule. Defaults to |
-delivery
+timezone
-
-DeliverySpec
-
+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
|
(Optional)
- Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc. +JsonData is json encoded data used as the body of the event posted to +the sink. Default is empty. If set, datacontenttype will also be set +to “application/json”. |
+(Appears on: +PingSource) +
++
PingSourceStatus defines the observed state of PingSource.
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. |
+(Appears on: +SinkBinding) +
++
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ +Field | +Description | +
---|---|
-status
+SourceSpec
-
-BrokerStatus
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
-(Optional)
- Status represents the current state of the Broker. This data may be out of -date. +
+(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/v1beta1.BindingSpec
+
+ |
+
+
+(Members of inherits duck/v1beta1 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 v1 is the v1 version of the API.
+ +Resource Types: + +-
EventType represents a type of event that can be consumed from a 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. Subscribers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.
-eventing.knative.dev/v1beta1
+eventing.knative.dev/v1
|
@@ -4286,13 +4070,13 @@ eventing.knative.dev/v1beta1
EventType |
+Broker |
||||||||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -4307,89 +4091,43 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-EventTypeSpec
+
+BrokerSpec
|
- Spec defines the desired state of the EventType. +Spec defines the desired state of the Broker.
|
status
-
-EventTypeStatus
+
+BrokerStatus
|
(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 +Status represents the current state of the Broker. This data may be out of +date. |
-
Trigger represents a request to have events delivered to a consumer from a +
Trigger represents a request to have events delivered to a subscriber from a Broker’s event pool.
-eventing.knative.dev/v1beta1
+eventing.knative.dev/v1
|
@@ -4448,7 +4185,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -4463,7 +4200,7 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
+
TriggerSpec
@@ -4481,15 +4218,14 @@ string
|
- Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’. +Broker is the broker that this trigger receives events from. |
filter
-
+
TriggerFilter
@@ -4519,7 +4255,7 @@ is required.
|
status
-
+
TriggerStatus
@@ -4532,11 +4268,11 @@ date.
|
(Appears on: -Broker) +Broker)
@@ -4566,7 +4302,7 @@ a pointer to a ConfigMap.
delivery
-
+
DeliverySpec
@@ -4579,154 +4315,14 @@ This includes things like retries, DLQ, etc.
--(Appears on: -Broker) -
--
BrokerStatus represents the current state of a Broker.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-address
-
-knative.dev/pkg/apis/duck/v1.Addressable
-
- |
-
- Broker is Addressable. It exposes the endpoint as an URI to get events -delivered into the Broker mesh. - |
-
-(Appears on: -EventType) -
--
-Field | -Description | -
---|---|
-type
-
-string
-
- |
-
- Type represents the CloudEvents type. It is authoritative. - |
-
-source
-
-knative.dev/pkg/apis.URL
-
- |
-
-(Optional)
- Source is a URI, it represents the CloudEvents source. - |
-
-schema
-
-knative.dev/pkg/apis.URL
-
- |
-
-(Optional)
- Schema is a URI, it represents the CloudEvents schemaurl extension attribute. -It may be a JSON schema, a protobuf schema, etc. It is optional. - |
-
-schemaData
-
-string
-
- |
-
-(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. - |
-
-broker
-
-string
-
- |
-
-(Optional)
- TODO remove https://github.com/knative/eventing/issues/2750 -Broker refers to the Broker that can provide the EventType. - |
-
-description
-
-string
-
- |
-
-(Optional)
- Description is an optional field used to describe the EventType, in any meaningful way. - |
-
(Appears on: -EventType) +Broker)
-
EventTypeStatus represents the current state of a EventType.
+BrokerStatus represents the current state of a Broker.
+address
+
+knative.dev/pkg/apis/duck/v1.Addressable
+
+ |
+
+ Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh. + |
+
(Appears on: -TriggerSpec) +TriggerSpec)
@@ -4774,7 +4382,7 @@ knative.dev/pkg/apis/duck/v1.Status
attributes
-
+
TriggerFilterAttributes
@@ -4790,22 +4398,22 @@ specified values.
-map[string]string
alias)(Appears on: -TriggerFilter) +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) +Trigger)
@@ -4825,15 +4433,14 @@ string
Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.
+Broker is the broker that this trigger receives events from.
filter
-
+
TriggerFilter
@@ -4858,11 +4465,11 @@ is required.
(Appears on: -Trigger) +Trigger)
TriggerStatus represents the current state of a Trigger.
@@ -4887,7 +4494,7 @@ knative.dev/pkg/apis/duck/v1.Status (Members ofStatus
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. +* ObservedGeneration - the ‘Generation’ of the Trigger that was last processed by the controller. * Conditions - the latest available observations of a resource’s current state.
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -5102,7 +4709,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -5147,7 +4754,7 @@ and modifications of the event sent to the sink.
template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -5212,7 +4819,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -5372,7 +4979,7 @@ More info:
+
Kubernetes meta/v1.LabelSelector
@@ -5560,7 +5167,7 @@ and modifications of the event sent to the sink.
template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -5703,17 +5310,20 @@ Source.
-
Package v1 is the v1 version of the API.
+Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
+ApiServerSource is the Schema for the apiserversources API
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha1
+
+ |
+||||||||||||||||
+kind
+string
+ |
+ApiServerSource |
+||||||||||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
-(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -5742,55 +5368,93 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ParallelSpec
+
+ApiServerSourceSpec
|
- Spec defines the desired state of the Parallel.
|
status
-
-ParallelStatus
+
+ApiServerSourceStatus
|
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. |
-(Appears on: -ParallelSpec) -
-+
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.
-filter
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha1
+
+ |
+||||
+kind
+string
+ |
+SinkBinding |
+||||
+metadata
-knative.dev/pkg/apis/duck/v1.Destination
+
+Kubernetes meta/v1.ObjectMeta
+
|
-(Optional)
- Filter is the expression guarding the branch +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||
-subscriber
+spec
-knative.dev/pkg/apis/duck/v1.Destination
+
+SinkBindingSpec
+
|
- Subscriber receiving the event when the filter passes ++ +
|
||||
-delivery
+status
-
-DeliverySpec
+
+SinkBindingStatus
|
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. |
(Appears on: -ParallelStatus) +ApiServerSourceSpec)
-
ParallelBranchStatus represents the current state of a Parallel branch
+ApiServerResource defines the resource to watch
Field | -Description | +Field | +Description | +
---|---|---|---|
+apiVersion
+
+string
+
+ |
+
+ API version of the resource to watch. + |
+||
+kind
+
+string
+
+ |
+
+ Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
||
-filterSubscriptionStatus
+labelSelector
-
-ParallelSubscriptionStatus
+
+Kubernetes meta/v1.LabelSelector
|
- FilterSubscriptionStatus corresponds to the filter subscription status. +LabelSelector restricts this source to objects with the selected labels +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
||
-filterChannelStatus
+controllerSelector
-
-ParallelChannelStatus
+
+Kubernetes meta/v1.OwnerReference
|
- FilterChannelStatus corresponds to the filter channel status. +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. |
||
-subscriberSubscriptionStatus
+controller
-
-ParallelSubscriptionStatus
-
+bool
|
- SubscriptionStatus corresponds to the subscriber subscription status. +If true, send an event referencing the object controlling the resource +Deprecated: Per-resource controller flag will no longer be supported in +v1alpha2, please use Spec.Owner as a GKV. |
(Appears on: -ParallelBranchStatus, -ParallelStatus) +ApiServerSource)
+
ApiServerSourceSpec defines the desired state of ApiServerSource
-channel
+resources
-
-Kubernetes core/v1.ObjectReference
+
+[]ApiServerResource
|
- Channel is the reference to the underlying channel. +Resources is the list of resources to watch |
-ready
+serviceAccountName
-knative.dev/pkg/apis.Condition
+string
|
- ReadyCondition indicates whether the Channel is ready or not. +(Optional) +ServiceAccountName is the name of the ServiceAccount to use to run this +source. |
-(Appears on: -Parallel) -
--
-Field | -Description | +
+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. + |
---|---|---|---|
-branches
+ceOverrides
-
-[]ParallelBranch
-
+knative.dev/pkg/apis/duck/v1.CloudEventOverrides
|
- Branches is the list of Filter/Subscribers pairs. +(Optional) +CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink. |
||
-channelTemplate
+owner
-
-ChannelTemplateSpec
+
+APIVersionKind
|
(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). +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
+mode
-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 +Mode is the mode the receive adapter controller runs under: Ref or Resource.
+ |
(Appears on: -Parallel) +ApiServerSource)
-
ParallelStatus represents the current state of a Parallel.
+ApiServerSourceStatus defines the observed state of ApiServerSource
-Status
+SourceStatus
-knative.dev/pkg/apis/duck/v1.Status
+knative.dev/pkg/apis/duck/v1.SourceStatus
|
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. |
+(Appears on: +SinkBinding) +
++
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ +
-ingressChannelStatus
-
-
-ParallelChannelStatus
-
-
- |
-
- IngressChannelStatus corresponds to the ingress channel status. - |
+Field | +Description |
---|---|---|---|
-branchStatuses
+SourceSpec
-
-[]ParallelBranchStatus
-
+knative.dev/pkg/apis/duck/v1.SourceSpec
|
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. +
+(Members of |
||
-AddressStatus
+BindingSpec
-knative.dev/pkg/apis/duck/v1.AddressStatus
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
-(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) +SinkBinding)
+
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
-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 |
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: + +-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
+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.
+apiVersion
+string |
+
+
+eventing.knative.dev/v1beta1
+
+ |
+|||||||||
+kind
+string
+ |
+Broker |
+|||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -6195,55 +5945,43 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-SequenceSpec
+
+BrokerSpec
|
- Spec defines the desired state of the Sequence. +Spec defines the desired state of the Broker.
|
status
-
-SequenceStatus
+
+BrokerStatus
|
(Optional)
- Status represents the current state of the Sequence. This data may be out of + Status represents the current state of the Broker. This data may be out of date. |
-(Appears on: -SequenceStatus) -
-+
EventType represents a type of event that can be consumed from a Broker.
-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. +
+eventing.knative.dev/v1beta1
+
|
-(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 +kind
+string
|
+EventType |
-channelTemplate
+metadata
-
-ChannelTemplateSpec
+
+Kubernetes meta/v1.ObjectMeta
|
(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
|
-reply
+spec
-knative.dev/pkg/apis/duck/v1.Destination
+
+EventTypeSpec
+
|
-(Optional)
- Reply is a Reference to where the result of the last Subscriber gets sent to. - |
-
-(Appears on: -Sequence) -
--
SequenceStatus represents the current state of a Sequence.
- +Spec defines the desired state of the EventType.
+Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-subscriptionStatuses
+type
-
-[]SequenceSubscriptionStatus
-
+string
|
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. +Type represents the CloudEvents type. It is authoritative. |
-channelStatuses
+source
-
-[]SequenceChannelStatus
-
+knative.dev/pkg/apis.URL
|
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. +(Optional) +Source is a URI, it represents the CloudEvents source. |
-AddressStatus
+schema
-knative.dev/pkg/apis/duck/v1.AddressStatus
+knative.dev/pkg/apis.URL
|
-
-(Members of AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} +(Optional) +Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional. |
-(Appears on: -SequenceSpec) -
--
-Field | -Description | -
---|---|
-Destination
+schemaData
-knative.dev/pkg/apis/duck/v1.Destination
+string
|
-
-(Members of Subscriber receiving the step event +(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
+broker
-
-DeliverySpec
-
+string
|
(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. +TODO remove https://github.com/knative/eventing/issues/2750 +Broker refers to the Broker that can provide the EventType. |
-(Appears on: -SequenceStatus) -
--
-Field | -Description | -
---|---|
-subscription
+description
-
-Kubernetes core/v1.ObjectReference
-
+string
|
- Subscription is the reference to the underlying Subscription. +(Optional) +Description is an optional field used to describe the EventType, in any meaningful way. + |
+
ready
+status
-knative.dev/pkg/apis.Condition
+
+EventTypeStatus
+
ReadyCondition indicates whether the Subscription is ready or not.
+(Optional) +Status represents the current state of the EventType. +This data may be out of date. +TODO might be removed https://github.com/knative/eventing/issues/2750
-
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.
+Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.
-messaging.knative.dev/v1beta1
+eventing.knative.dev/v1beta1
|
@@ -6576,13 +6188,13 @@ messaging.knative.dev/v1beta1
Channel |
+Trigger |
||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -6597,44 +6209,53 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-ChannelSpec
+
+TriggerSpec
|
- Spec defines the desired state of the Channel. +Spec defines the desired state of the Trigger.
|
status
-
-ChannelStatus
+
+TriggerStatus
|
(Optional)
- Status represents the current state of the Channel. This data may be out of + Status represents the current state of the Trigger. This data may be out of date. |
-
InMemoryChannel is a resource representing an in memory channel
+(Appears on: +Broker) + +
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
- |
-
-kind
-string
- |
-InMemoryChannel |
-
-metadata
+config
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis/duck/v1.KReference
|
(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Config is a KReference to the configuration that specifies +configuration options for this Broker. For example, this could be +a pointer to a ConfigMap. |
-spec
+delivery
-
-InMemoryChannelSpec
+
+DeliverySpec
|
- Spec defines the desired state of the Channel. -- +(Optional) + Delivery is the delivery specification for Events within the Broker mesh. +This includes things like retries, DLQ, etc. + |
+
+(Appears on: +Broker) +
++
BrokerStatus represents the current state of a Broker.
+Field | +Description | +
---|---|
-ChannelableSpec
+Status
-
-ChannelableSpec
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of Channel conforms to Duck type Channelable. - |
-
inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
status
+address
-
-InMemoryChannelStatus
-
+knative.dev/pkg/apis/duck/v1.Addressable
Status represents the current state of the Channel. This data may be out of -date.
+Broker is Addressable. It exposes the endpoint as an URI to get events +delivered into the Broker mesh.
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
+(Appears on: +EventType) + +
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
+type
+
+string
+
|
-|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-kind
-string
+Type represents the CloudEvents type. It is authoritative. |
-Subscription |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-metadata
+source
-
-Kubernetes meta/v1.ObjectMeta
-
+knative.dev/pkg/apis.URL
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+(Optional)
+Source is a URI, it represents the CloudEvents source. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-spec
+schema
-
-SubscriptionSpec
-
+knative.dev/pkg/apis.URL
|
- - -
EventTypeStatus +++(Appears on: +EventType) + ++ EventTypeStatus represents the current state of a EventType. + +
|
+
Field | +Description |
---|---|
-status
+attributes
-
-SubscriptionStatus
+
+TriggerFilterAttributes
|
+(Optional)
+ Attributes filters events by exact match on event context attributes. +Each key in the map is compared with the equivalent key in the event +context. An event passes the filter if all values are equal to the +specified values. +Nested context attributes are not supported as keys. Only string values are supported. |
map[string]string
alias)-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
+(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: -Channel) +Trigger)
-
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.
-channelTemplate
+broker
-
-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. +Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’. |
-ChannelableSpec
+filter
-
-ChannelableSpec
+
+TriggerFilter
|
-
-(Members of Channel conforms to ChannelableSpec +(Optional) +Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events. + |
+
+subscriber
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Subscriber is the addressable that receives events from the Broker that pass the Filter. It +is required. |
(Appears on: -Channel) +Trigger)
-
ChannelStatus represents the current state of a Channel.
+TriggerStatus represents the current state of a Trigger.
-ChannelableStatus
+Status
-
-ChannelableStatus
-
+knative.dev/pkg/apis/duck/v1.Status
|
-(Members of Channel conforms to ChannelableStatus +inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-channel
+subscriberUri
-knative.dev/pkg/apis/duck/v1.KReference
+knative.dev/pkg/apis.URL
|
- Channel is an KReference to the Channel CRD backing this Channel. +SubscriberURI is the resolved URI of the receiver for this Trigger. |
-(Appears on: -ChannelSpec, -ParallelSpec, -SequenceSpec) +
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.
-spec
+apiVersion
+string |
+
+
+messaging.knative.dev/v1
+
+ |
+||||
+kind
+string
+ |
+Channel |
+||||
+metadata
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. +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. + |
+
-
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that -we can easily create new Channels off of it.
+InMemoryChannel is a resource representing an in memory channel
+apiVersion
+string |
+
+
+messaging.knative.dev/v1
+
+ |
+|
+kind
+string
+ |
+InMemoryChannel |
+|
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -7067,45 +6821,21 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+InMemoryChannelSpec
+
|
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. +Spec defines the desired state of the Channel. |
-
-(Appears on: -InMemoryChannel) -
--
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
- -Field | -Description | -
---|---|
ChannelableSpec
-
+
ChannelableSpec
@@ -7117,62 +6847,31 @@ ChannelableSpec
Channel conforms to Duck type Channelable. |
-(Appears on: -InMemoryChannel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | +
---|---|
-ChannelableStatus
+status
-
-ChannelableStatus
+
+InMemoryChannelStatus
|
-
-(Members of Channel conforms to Duck type Channelable. +(Optional) +Status represents the current state of the Channel. This data may be out of +date. |
-(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
+Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
+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
+
+
+ |
+
+ + +
SubscriptionStatus ---(Appears on: -Subscription) - -- SubscriptionStatus (computed) for a subscription - -
SubscriptionStatusPhysicalSubscription
+ |
+
Field | -Description | -
---|---|
-subscriberUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- SubscriberURI is the fully resolved URI for spec.subscriber. - |
-
-replyUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- ReplyURI is the fully resolved URI for the spec.reply. - |
-
-deadLetterSinkUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. - |
-
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
- -Resource Types: -ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ +-
ApiServerSource is the Schema for the apiserversources API
+(Appears on: +Channel) + ++
ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. +It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha1
-
- |
-
-kind
-string
- |
-ApiServerSource |
-
-metadata
+channelTemplate
-
-Kubernetes meta/v1.ObjectMeta
+
+ChannelTemplateSpec
|
-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
-
-ApiServerSourceSpec
+
+ChannelableSpec
|
- - +
+(Members of Channel conforms to ChannelableSpec + |
+
+(Appears on: +Channel) +
++
ChannelStatus represents the current state of a Channel.
+Field | +Description | +
---|---|
-resources
+ChannelableStatus
-
-[]ApiServerResource
+
+ChannelableStatus
|
- Resources is the list of resources to watch +
+(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. +Channel is an KReference to the Channel CRD backing this Channel. |
+(Appears on: +ChannelSpec, +ParallelSpec, +SequenceSpec) +
++
+
-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. - |
+Field | +Description |
---|---|---|---|
-ceOverrides
+spec
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
(Optional)
- CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink. +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
+
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.
+ +Field | +Description | +
---|---|
-owner
+metadata
-
-APIVersionKind
+
+Kubernetes meta/v1.ObjectMeta
|
(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. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-mode
+spec
-string
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
- 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 |
---|---|
-status
+ChannelableSpec
-
-ApiServerSourceStatus
+
+ChannelableSpec
|
+
+(Members of Channel conforms to Duck type Channelable. |
-
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.
+
ChannelStatus represents the current state of a Channel.
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha1
-
+ChannelableStatus
+
+
+ChannelableStatus
+
+
|
-
-kind
-string
+
+(Members of Channel conforms to Duck type Channelable. |
-SinkBinding |
+(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 | +||||
---|---|---|---|---|---|
-metadata
+channel
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes core/v1.ObjectReference
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+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.) |
||||
-spec
-
-
-SinkBindingSpec
-
-
- |
-
- - -
Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
||||
-status
+delivery
-
-SinkBindingStatus
+
+DeliverySpec
|
+(Optional)
+ Delivery configuration |
(Appears on: -ApiServerSourceSpec) +Subscription)
-
ApiServerResource defines the resource to watch
+SubscriptionStatus (computed) for a subscription
-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
+physicalSubscription
-string
+
+SubscriptionStatusPhysicalSubscription
+
|
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +PhysicalSubscription is the fully resolved values that this Subscription represents. |
+(Appears on: +SubscriptionStatus) +
++
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
+ +Field | +Description | +
---|---|
-labelSelector
+subscriberUri
-
-Kubernetes meta/v1.LabelSelector
-
+knative.dev/pkg/apis.URL
|
- LabelSelector restricts this source to objects with the selected labels -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors +SubscriberURI is the fully resolved URI for spec.subscriber. |
-controllerSelector
+replyUri
-
-Kubernetes meta/v1.OwnerReference
-
+knative.dev/pkg/apis.URL
|
- 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. +ReplyURI is the fully resolved URI for the spec.reply. |
-controller
+deadLetterSinkUri
-bool
+knative.dev/pkg/apis.URL
|
- 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. +ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. |
-(Appears on: -ApiServerSource) +
Package v1beta1 is the v1beta1 version of the API.
+Resource Types: +-
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.
-resources
-
-
-[]ApiServerResource
-
-
- |
+
- Resources is the list of resources to watch +
+messaging.knative.dev/v1beta1
+
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-serviceAccountName
-
+kind
string
-
- |
-
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. |
+Channel |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-sink
+metadata
-knative.dev/pkg/apis/duck/v1beta1.Destination
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-ceOverrides
+spec
-knative.dev/pkg/apis/duck/v1.CloudEventOverrides
+
+ChannelSpec
+
|
-(Optional)
- CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink. - |
-
-owner
+channelTemplate
-
-APIVersionKind
+
+ChannelTemplateSpec
|
-(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. +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. |
-mode
+ChannelableSpec
-string
+
+ChannelableSpec
+
|
- Mode is the mode the receive adapter controller runs under: Ref or Resource.
-
+(Members of Channel conforms to ChannelableSpec |
-(Appears on: -ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
- -Field | -Description | +
---|---|
-SourceStatus
+status
-knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ChannelStatus
+
|
-
-(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) +Status represents the current state of the Channel. This data may be out of +date. |
-(Appears on: -SinkBinding) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+InMemoryChannel is a resource representing an in memory channel
-SourceSpec
+apiVersion
+string |
+
+
+messaging.knative.dev/v1beta1
+
+ |
+||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+kind
+string
+ |
+InMemoryChannel |
+||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+metadata
-knative.dev/pkg/apis/duck/v1.SourceSpec
+
+Kubernetes meta/v1.ObjectMeta
+
|
-
-(Members of metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-BindingSpec
+spec
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+InMemoryChannelSpec
+
+
+ |
+
+ Spec defines the desired state of the Channel. ++ +
SinkBindingStatus ---(Appears on: -SinkBinding) - -- SinkBindingStatus communicates the observed state of the SinkBinding (from the controller). - -
- duck.knative.dev/v1-- Package v1 is the v1 version of the API. - -Resource Types: -BackoffPolicyType
-(
- |
+
+apiVersion
+string |
+
+
+messaging.knative.dev/v1beta1
+
+ |
+|||||||||||
+kind
+string
+ |
+Subscription |
+|||||||||||
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -7972,43 +7734,81 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
-ChannelableSpec
+
+SubscriptionSpec
|
- Spec is the part where the Channelable fulfills the Subscribable contract.
|
status
-
-ChannelableStatus
+
+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: -ChannelSpec, -Channelable, -InMemoryChannelSpec) +Channel)
-
ChannelableSpec contains Spec of the Channelable object
+ChannelStatus represents the current state of a Channel.
-SubscribableSpec
+ChannelableStatus
-
-SubscribableSpec
+
+ChannelableStatus
|
-(Members of Channel conforms to ChannelableStatus |
-delivery
+channel
-
-DeliverySpec
-
+knative.dev/pkg/apis/duck/v1.KReference
|
-(Optional)
- DeliverySpec contains options controlling the event delivery +Channel is an KReference to the Channel CRD backing this Channel. |
(Appears on: -ChannelStatus, -Channelable, -InMemoryChannelStatus) +ChannelSpec, +ParallelSpec, +SequenceSpec)
-
ChannelableStatus contains the Status of a Channelable object.
-Status
+spec
-knative.dev/pkg/apis/duck/v1.Status
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
-
-(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) +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
-AddressStatus
-
-knative.dev/pkg/apis/duck/v1.AddressStatus
-
- |
-+ |
-(Members of AddressStatus
are embedded into this type.)
+
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.
-AddressStatus is the part where the Channelable fulfills the Addressable contract.
-Field | +Description |
---|---|
-SubscribableStatus
+metadata
-
-SubscribableStatus
+
+Kubernetes meta/v1.ObjectMeta
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-deadLetterChannel
+spec
-knative.dev/pkg/apis/duck/v1.KReference
+k8s.io/apimachinery/pkg/runtime.RawExtension
|
(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. +Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
(Appears on: -BrokerSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriptionSpec) +InMemoryChannel)
-
DeliverySpec contains the delivery options for event senders, -such as channelable and source.
+InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
-deadLetterSink
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- DeadLetterSink is the sink receiving event that could not be sent to -a destination. - |
-
-retry
-
-int32
-
- |
-
-(Optional)
- Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink. - |
-
-backoffPolicy
+ChannelableSpec
-
-BackoffPolicyType
+
+ChannelableSpec
|
-(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*
+(Members of Channel conforms to Duck type Channelable. |
-
DeliveryStatus contains the Status of an object supporting delivery options.
+(Appears on: +InMemoryChannel) + ++
ChannelStatus represents the current state of a Channel.
-deadLetterChannel
+ChannelableStatus
-knative.dev/pkg/apis/duck/v1.KReference
+
+ChannelableStatus
+
|
-(Optional)
- DeadLetterChannel is a KReference that is the reference to the native, platform specific channel -where failed events are sent to. +
+(Members of Channel conforms to Duck type Channelable. |
-
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.
+(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
-metadata
+channel
-
-Kubernetes meta/v1.ObjectMeta
+
+Kubernetes core/v1.ObjectReference
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+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.) |
||
-spec
+subscriber
-
-SubscribableSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
- SubscribableSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. -- -
Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
||
-status
+delivery
-
-SubscribableStatus
+
+DeliverySpec
|
- SubscribableStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. +(Optional) +Delivery configuration |
(Appears on: -ChannelableSpec, -Subscribable) +Subscription)
-
SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
+SubscriptionStatus (computed) for a subscription
-subscribers
+Status
-
-[]SubscriberSpec
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+physicalSubscription
+
+
+SubscriptionStatusPhysicalSubscription
|
- This is the list of subscriptions for this subscribable. +PhysicalSubscription is the fully resolved values that this Subscription represents. |
(Appears on: -ChannelableStatus, -Subscribable) +SubscriptionStatus)
-
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
+SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
-subscribers
+subscriberUri
-
-[]SubscriberStatus
-
+knative.dev/pkg/apis.URL
|
- This is the list of subscription’s statuses for this channel. +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. |
-(Appears on: -SubscribableSpec) +
Package v1alpha1 is the v1alpha1 version of the API.
+Resource Types: + +-
SubscriberSpec defines a single subscriber to a Subscribable.
-At least one of SubscriberURI and ReplyURI must be present
+ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
-uid
-
-k8s.io/apimachinery/pkg/types.UID
-
+apiVersion
+string |
+
+
+configs.internal.knative.dev/v1alpha1
+
|
+||||
-(Optional)
- UID is used to understand the origin of the subscriber. +kind
+string
|
+ConfigMapPropagation |
||||
-generation
+metadata
-int64
+
+Kubernetes meta/v1.ObjectMeta
+
|
(Optional)
- Generation of the origin of the subscriber with uid:UID. +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||
-subscriberUri
+spec
-knative.dev/pkg/apis.URL
+
+ConfigMapPropagationSpec
+
|
-(Optional)
- SubscriberURI is the endpoint for the subscriber +Spec defines the desired state of the ConfigMapPropagation ++ +
|
||||
-delivery
+status
-
-DeliverySpec
+
+ConfigMapPropagationStatus
|
(Optional)
- DeliverySpec contains options controlling the event delivery +Status represents the current state of the EventType. +This data may be out of date. |
(Appears on: -SubscribableStatus) +ConfigMapPropagation)
-
SubscriberStatus defines the status of a single subscriber to a Channel.
-uid
+originalNamespace
-k8s.io/apimachinery/pkg/types.UID
+string
|
-(Optional)
- UID is used to understand the origin of the subscriber. +OriginalNamespace is the namespace where the original configMaps are in |
-observedGeneration
+selector
-int64
+
+Kubernetes meta/v1.LabelSelector
+
|
(Optional)
- Generation of the origin of the subscriber with uid:UID. +Selector only selects original configMaps with corresponding labels |
+(Appears on: +ConfigMapPropagation) +
++
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
+ +Field | +Description | +
---|---|
-ready
+Status
-
-Kubernetes core/v1.ConditionStatus
-
+knative.dev/pkg/apis/duck/v1.Status
|
- Status of the subscriber. +
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-message
+copyConfigmaps
-string
+
+[]ConfigMapPropagationStatusCopyConfigMap
+
|
(Optional)
- A human readable message indicating details of Ready status. +CopyConfigMaps is the status for each copied configmap. |
-
Package v1alpha1 is the v1alpha1 version of the API.
+(Appears on: +ConfigMapPropagationStatus) -Resource Types: --
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
+ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
Field | Description | - - + + +||||
---|---|---|---|---|---|
+name
+
+string
+
+ |
+
+ Name is copy configmap’s name + |
+||||
-metadata
+source
-
-Kubernetes meta/v1.ObjectMeta
-
+string
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Source is “originalNamespace/originalConfigMapName” |
||||
-spec
+operation
-
-ChannelableSpec
-
+string
|
- Spec is the part where the Channelable fulfills the Subscribable contract. -- -
Reason indicates reasons if the operation is not ready |
||||
-status
+resourceVersionFromSource
-
-ChannelableStatus
-
+string
|
+ ResourceVersion is the resourceVersion of original configmap |
+
Package v1 is the v1 version of the API.
+ +Resource Types: +-
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.
+Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -8692,60 +8616,55 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-ChannelableCombinedSpec
+
+ParallelSpec
|
- Spec is the part where the Channelable fulfills the Subscribable contract. +Spec defines the desired state of the Parallel.
|
status
-
-ChannelableCombinedStatus
+
+ParallelStatus
|
+(Optional)
+ Status represents the current state of the Parallel. This data may be out of +date. |
(Appears on: -ChannelableCombined) +ParallelSpec)
-
ChannelableSpec contains Spec of the Channelable object
-SubscribableTypeSpec
+filter
-
-SubscribableTypeSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. +(Optional) +Filter is the expression guarding the branch |
-SubscribableSpec
+subscriber
-
-SubscribableSpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
-
-(Members of SubscribableSpec is for the v1beta1 spec compatibility. +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)
- DeliverySpec contains options controlling the event delivery +Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. |
(Appears on: -ChannelableCombined) +ParallelStatus)
-
ChannelableStatus contains the Status of a Channelable object.
+ParallelBranchStatus represents the current state of a Parallel branch
-Status
+filterSubscriptionStatus
-knative.dev/pkg/apis/duck/v1.Status
+
+ParallelSubscriptionStatus
+
|
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. +FilterSubscriptionStatus corresponds to the filter subscription status. |
-AddressStatus
+filterChannelStatus
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+ParallelChannelStatus
+
|
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +FilterChannelStatus corresponds to the filter channel status. |
-SubscribableTypeStatus
+subscriberSubscriptionStatus
-
-SubscribableTypeStatus
+
+ParallelSubscriptionStatus
|
+ SubscriptionStatus corresponds to the subscriber subscription status. + |
+
-(Members of SubscribableTypeStatus
are embedded into this type.)
+(Appears on:
+ParallelBranchStatus,
+ParallelStatus)
SubscribableTypeStatus is the v1alpha1 part of the Subscribers status
- ++
+Field | +Description |
---|---|
-SubscribableStatus
+channel
-
-SubscribableStatus
+
+Kubernetes core/v1.ObjectReference
|
-
-(Members of SubscribableStatus is the v1beta1 part of the Subscribers status. +Channel is the reference to the underlying channel. |
-errorChannel
+ready
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis.Condition
|
-(Optional)
- ErrorChannel is set by the channel when it supports native error handling via a channel +ReadyCondition indicates whether the Channel is ready or not. |
(Appears on: -Channelable) +Parallel)
-
ChannelableSpec contains Spec of the Channelable object
Field | Description | - - + + +
---|---|
+branches
+
+
+[]ParallelBranch
+
+
+ |
+
+ Branches is the list of Filter/Subscribers pairs. + |
+
-SubscribableTypeSpec
+channelTemplate
-
-SubscribableTypeSpec
+
+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). |
-delivery
+reply
-
-DeliverySpec
-
+knative.dev/pkg/apis/duck/v1.Destination
|
(Optional)
- DeliverySpec contains options controlling the event delivery +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: -Channelable) +Parallel)
-
ChannelableStatus contains the Status of a Channelable object.
+ParallelStatus represents the current state of a Parallel.
-AddressStatus
+ingressChannelStatus
-knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+ParallelChannelStatus
+
|
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. +IngressChannelStatus corresponds to the ingress channel status. |
-SubscribableTypeStatus
+branchStatuses
-
-SubscribableTypeStatus
+
+[]ParallelBranchStatus
|
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. +BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order. |
-errorChannel
+AddressStatus
-
-Kubernetes core/v1.ObjectReference
-
+knative.dev/pkg/apis/duck/v1.AddressStatus
|
-(Optional)
- ErrorChannel is set by the channel when it supports native error handling via a channel - |
-
-
Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch -arbitrary other resources (such as any Source or Addressable). This is not a real resource.
+(Members ofAddressStatus
are embedded into this type.)
-Field | -Description | -
---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+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: -SubscribableTypeSpec) +ParallelBranchStatus)
-
Subscribable is the schema for the subscribable portion of the spec -section of the resource.
-subscribers
+subscription
-
-[]SubscriberSpec
+
+Kubernetes core/v1.ObjectReference
|
- This is the list of subscriptions for this subscribable. +Subscription is the reference to the underlying Subscription. |
-(Appears on: -SubscribableTypeStatus) -
--
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
- -Field | -Description | -
---|---|
-subscribers
+ready
-
-[]SubscriberStatus
-
+knative.dev/pkg/apis.Condition
|
- This is the list of subscription’s statuses for this channel. +ReadyCondition indicates whether the Subscription is ready or not. |
-
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.
+Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
metadata
-
+
Kubernetes meta/v1.ObjectMeta
|
+(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
@@ -9181,27 +9069,55 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
-SubscribableTypeSpec
+
+SequenceSpec
|
- SubscribableTypeSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. +Spec defines the desired state of the Sequence.
|
status
-
-SubscribableTypeStatus
+
+SequenceStatus
|
- SubscribableTypeStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. +(Optional) +Status represents the current state of the Sequence. This data may be out of +date. |
(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -SubscribableType) +SequenceStatus)
-
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
-subscribable
+channel
-
-Subscribable
+
+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: -ChannelableCombinedStatus, -ChannelableStatus, -SubscribableType) +Sequence)
-
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
-subscribableStatus
+steps
-
-SubscribableStatus
+
+[]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: -Subscribable) +Sequence)
-
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
+SequenceStatus represents the current state of a Sequence.
-uid
+Status
-k8s.io/apimachinery/pkg/types.UID
+knative.dev/pkg/apis/duck/v1.Status
|
-(Optional)
- UID is used to understand the origin of the subscriber. +
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. |
-generation
+subscriptionStatuses
-int64
+
+[]SequenceSubscriptionStatus
+
|
-(Optional)
- Generation of the origin of the subscriber with uid:UID. +SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order. |
-subscriberURI
+channelStatuses
-knative.dev/pkg/apis.URL
+
+[]SequenceChannelStatus
+
|
-(Optional)
+ ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order. |
-replyURI
+AddressStatus
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis/duck/v1.AddressStatus
|
-(Optional)
+
+(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 | +
---|---|
-deadLetterSink
+Destination
-knative.dev/pkg/apis.URL
+knative.dev/pkg/apis/duck/v1.Destination
|
-(Optional)
+
+(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 contains API Schema definitions for the sources v1beta1 API group.
+Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
Resource Types:
ApiServerSource is the Schema for the apiserversources API
@@ -9416,7 +9443,7 @@ Resource Types: string
-sources.knative.dev/v1beta1
+sources.knative.dev/v1alpha2
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -9445,7 +9472,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ApiServerSourceSpec
@@ -9476,7 +9503,7 @@ and modifications of the event sent to the sink.
resources
-
+
[]APIVersionKindSelector
@@ -9491,7 +9518,7 @@ selector to help filter.
owner
-
+
APIVersionKind
@@ -9538,7 +9565,7 @@ source. Defaults to default if not set.
status
-
+
ApiServerSourceStatus
@@ -9548,7 +9575,7 @@ ApiServerSourceStatus
ContainerSource is the Schema for the containersources API
@@ -9567,7 +9594,7 @@ ApiServerSourceStatus string
-sources.knative.dev/v1beta1
+sources.knative.dev/v1alpha2
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -9596,7 +9623,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ContainerSourceSpec
@@ -9627,7 +9654,7 @@ and modifications of the event sent to the sink.
template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -9643,7 +9670,7 @@ Kubernetes core/v1.PodTemplateSpec
status
-
+
ContainerSourceStatus
@@ -9653,7 +9680,7 @@ ContainerSourceStatus
PingSource is the Schema for the PingSources API.
@@ -9672,7 +9699,7 @@ ContainerSourceStatus string
-sources.knative.dev/v1beta1
+sources.knative.dev/v1alpha2
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -9701,7 +9728,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
PingSourceSpec
@@ -9742,20 +9769,6 @@ 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
@@ -9775,7 +9788,7 @@ to “application/json”.
status
-
+
PingSourceStatus
@@ -9785,7 +9798,7 @@ PingSourceStatus
SinkBinding describes a Binding that is also a Source. @@ -9809,7 +9822,7 @@ cloud events.
string
-sources.knative.dev/v1beta1
+sources.knative.dev/v1alpha2
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -9838,7 +9851,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
SinkBindingSpec
@@ -9869,14 +9882,14 @@ and modifications of the event sent to the sink.
BindingSpec
-knative.dev/pkg/apis/duck/v1beta1.BindingSpec
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
(Members of BindingSpec
are embedded into this type.)
inherits duck/v1beta1 BindingSpec, which currently provides: +
inherits duck/v1alpha1 BindingSpec, which currently provides: * Subject - Subject references the resource(s) whose “runtime contract” should be augmented by Binding implementations.
status
-
+
SinkBindingStatus
@@ -9898,11 +9911,12 @@ SinkBindingStatus
(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec, +ApiServerSourceSpec)
APIVersionKind is an APIVersion and Kind tuple.
@@ -9940,11 +9954,11 @@ More info: APIVersionKindSelector +(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)
APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
@@ -9984,7 +9998,7 @@ More info: + Kubernetes meta/v1.LabelSelector @@ -9998,11 +10012,11 @@ More info: ApiServerSourceSpec +(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceSpec defines the desired state of ApiServerSource
@@ -10037,7 +10051,7 @@ and modifications of the event sent to the sink.resources
-
+
[]APIVersionKindSelector
@@ -10052,7 +10066,7 @@ selector to help filter.
owner
-
+
APIVersionKind
@@ -10094,11 +10108,11 @@ source. Defaults to default if not set.
-(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceStatus defines the observed state of ApiServerSource
@@ -10133,11 +10147,11 @@ Source. -(Appears on: -ContainerSource) +ContainerSource)
ContainerSourceSpec defines the desired state of ContainerSource
@@ -10172,7 +10186,7 @@ and modifications of the event sent to the sink.template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -10183,11 +10197,11 @@ Kubernetes core/v1.PodTemplateSpec
-(Appears on: -ContainerSource) +ContainerSource)
ContainerSourceStatus defines the observed state of ContainerSource
@@ -10222,11 +10236,11 @@ Source. -(Appears on: -PingSource) +PingSource)
PingSourceSpec defines the desired state of the PingSource.
@@ -10271,20 +10285,6 @@ stringtimezone
-
-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
@@ -10299,11 +10299,11 @@ to “application/json”.
(Appears on: -PingSource) +PingSource)
PingSourceStatus defines the observed state of PingSource.
@@ -10338,11 +10338,11 @@ Source. -(Appears on: -SinkBinding) +SinkBinding)
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
@@ -10377,25 +10377,25 @@ and modifications of the event sent to the sink.BindingSpec
-knative.dev/pkg/apis/duck/v1beta1.BindingSpec
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
(Members of BindingSpec
are embedded into this type.)
inherits duck/v1beta1 BindingSpec, which currently provides: +
inherits duck/v1alpha1 BindingSpec, which currently provides: * Subject - Subject references the resource(s) whose “runtime contract” should be augmented by Binding implementations.
(Appears on: -SinkBinding) +SinkBinding)
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md index 8784d7bc30..2e3ac53adc 100644 --- a/docs/reference/api/serving.md +++ b/docs/reference/api/serving.md @@ -1,244 +1,15 @@Packages:
-
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
- -Resource Types: - --
DomainMapping is a mapping from a custom hostname to an Addressable.
- -Field | -Description | -||
---|---|---|---|
-apiVersion
-string |
-
-
-serving.knative.dev/v1alpha1
-
- |
-||
-kind
-string
- |
-DomainMapping |
-||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
- Standard object’s metadata. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata -Refer to the Kubernetes API documentation for the fields of the -metadata field.
- |
-||
-spec
-
-
-DomainMappingSpec
-
-
- |
-
-(Optional)
- Spec is the desired state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- -
|
-||
-status
-
-
-DomainMappingStatus
-
-
- |
-
-(Optional)
- Status is the current state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - |
-
-
CannotConvertError is returned when a field cannot be converted.
- -Field | -Description | -
---|---|
-Message
-
-string
-
- |
-- | -
-Field
-
-string
-
- |
-- | -
-(Appears on: -DomainMapping) -
--
DomainMappingSpec describes the DomainMapping the user wishes to exist.
- -Field | -Description | -
---|---|
-ref
-
-knative.dev/pkg/apis/duck/v1.KReference
-
- |
-
- Ref points to an Addressable. -Currently, Ref must be a KSvc. - |
-
-(Appears on: -DomainMapping) -
--
DomainMappingStatus describes the current state of the DomainMapping.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of |
-
-url
-
-knative.dev/pkg/apis.URL
-
- |
-
-(Optional)
- URL is the URL of this DomainMapping. - |
-
-address
-
-knative.dev/pkg/apis/duck/v1.Addressable
-
- |
-
-(Optional)
- Address holds the information needed for a DomainMapping to be the target of an event. - |
-
Package v1alpha1 contains the Autoscaling v1alpha1 API types.
@@ -284,7 +55,7 @@ stringmetadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -328,7 +99,7 @@ Defaults to 0
which means unlimited concurrency.
scaleTargetRef
-
+
Kubernetes core/v1.ObjectReference
@@ -400,7 +171,7 @@ PodAutoscalerStatus
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -597,7 +368,7 @@ Defaults to 0
which means unlimited concurrency.
scaleTargetRef
-
+
Kubernetes core/v1.ObjectReference
@@ -734,7 +505,7 @@ the referenced resources may take.
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -771,7 +542,7 @@ int32
selector
-
+
Kubernetes meta/v1.LabelSelector
@@ -783,7 +554,7 @@ Kubernetes meta/v1.LabelSelector
template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -840,7 +611,7 @@ int32
selector
-
+
Kubernetes meta/v1.LabelSelector
@@ -852,7 +623,7 @@ Kubernetes meta/v1.LabelSelector
template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -955,7 +726,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -1049,7 +820,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -1078,7 +849,7 @@ RevisionSpec
PodSpec
-
+
Kubernetes core/v1.PodSpec
@@ -1175,7 +946,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -1278,7 +1049,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -1546,7 +1317,7 @@ string
PodSpec
-
+
Kubernetes core/v1.PodSpec
@@ -1708,7 +1479,7 @@ Based on:
+
Kubernetes meta/v1.ObjectMeta
@@ -1737,7 +1508,7 @@ RevisionSpec
PodSpec
-
+
Kubernetes core/v1.PodSpec
@@ -2171,6 +1942,235 @@ a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)<
+
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
+ +Resource Types: + ++
DomainMapping is a mapping from a custom hostname to an Addressable.
+ +Field | +Description | +||
---|---|---|---|
+apiVersion
+string |
+
+
+serving.knative.dev/v1alpha1
+
+ |
+||
+kind
+string
+ |
+DomainMapping |
+||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+ Standard object’s metadata. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata +Refer to the Kubernetes API documentation for the fields of the +metadata field.
+ |
+||
+spec
+
+
+DomainMappingSpec
+
+
+ |
+
+(Optional)
+ Spec is the desired state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status ++ +
|
+||
+status
+
+
+DomainMappingStatus
+
+
+ |
+
+(Optional)
+ Status is the current state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + |
+
+
CannotConvertError is returned when a field cannot be converted.
+ +Field | +Description | +
---|---|
+Message
+
+string
+
+ |
++ | +
+Field
+
+string
+
+ |
++ | +
+(Appears on: +DomainMapping) +
++
DomainMappingSpec describes the DomainMapping the user wishes to exist.
+ +Field | +Description | +
---|---|
+ref
+
+knative.dev/pkg/apis/duck/v1.KReference
+
+ |
+
+ Ref points to an Addressable. +Currently, Ref must be a KSvc. + |
+
+(Appears on: +DomainMapping) +
++
DomainMappingStatus describes the current state of the DomainMapping.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of |
+
+url
+
+knative.dev/pkg/apis.URL
+
+ |
+
+(Optional)
+ URL is the URL of this DomainMapping. + |
+
+address
+
+knative.dev/pkg/apis/duck/v1.Addressable
+
+ |
+
+(Optional)
+ Address holds the information needed for a DomainMapping to be the target of an event. + |
+
Generated with
(Appears on:
-ChannelSpec,
-Channelable,
+ChannelSpec,
+Channelable,
InMemoryChannelSpec)
@@ -201,8 +201,8 @@ DeliverySpec
(Appears on:
-ChannelStatus,
-Channelable,
+ChannelStatus,
+Channelable,
InMemoryChannelStatus)
@@ -281,11 +281,11 @@ Failed messages are delivered here.
(Appears on:
-BrokerSpec,
-ChannelableSpec,
-ParallelBranch,
-SequenceStep,
-SubscriberSpec,
+BrokerSpec,
+ChannelableSpec,
+ParallelBranch,
+SequenceStep,
+SubscriberSpec,
SubscriptionSpec)
@@ -467,7 +467,7 @@ configured as to be compatible with Subscribable contract.
(Appears on:
-ChannelableSpec,
+ChannelableSpec,
Subscribable)
@@ -500,7 +500,7 @@ configured as to be compatible with Subscribable contract.
(Appears on:
-ChannelableStatus,
+ChannelableStatus,
Subscribable)
@@ -1346,8 +1346,8 @@ configured as to be compatible with Subscribable contract.
(Appears on:
-ChannelableCombinedSpec,
-ChannelableSpec,
+ChannelableCombinedSpec,
+ChannelableSpec,
SubscribableType)
@@ -1379,8 +1379,8 @@ Subscribable
(Appears on:
-ChannelableCombinedStatus,
-ChannelableStatus,
+ChannelableCombinedStatus,
+ChannelableStatus,
SubscribableType)
@@ -1610,8 +1610,8 @@ ChannelableStatus
(Appears on:
-ChannelSpec,
-Channelable,
+ChannelSpec,
+Channelable,
InMemoryChannelSpec)
@@ -1660,8 +1660,8 @@ DeliverySpec
(Appears on:
-ChannelStatus,
-Channelable,
+ChannelStatus,
+Channelable,
InMemoryChannelStatus)
@@ -1740,14 +1740,14 @@ Failed messages are delivered here.
(Appears on:
-BrokerSpec,
-ChannelableCombinedSpec,
-ChannelableSpec,
-ChannelableSpec,
-ParallelBranch,
-SequenceStep,
-SubscriberSpec,
-SubscriberSpec,
+BrokerSpec,
+ChannelableCombinedSpec,
+ChannelableSpec,
+ChannelableSpec,
+ParallelBranch,
+SequenceStep,
+SubscriberSpec,
+SubscriberSpec,
SubscriptionSpec)
@@ -1929,8 +1929,8 @@ configured as to be compatible with Subscribable contract.
(Appears on:
-ChannelableCombinedSpec,
-ChannelableSpec,
+ChannelableCombinedSpec,
+ChannelableSpec,
Subscribable)
@@ -1963,8 +1963,8 @@ configured as to be compatible with Subscribable contract.
(Appears on:
-ChannelableCombinedStatus,
-ChannelableStatus,
+ChannelableCombinedStatus,
+ChannelableStatus,
Subscribable)
@@ -2080,7 +2080,7 @@ DeliverySpec
(Appears on:
-SubscribableStatus,
+SubscribableStatus,
SubscribableStatus)
@@ -2388,7 +2388,7 @@ ParallelSubscriptionStatus
(Appears on:
-ParallelBranchStatus,
+ParallelBranchStatus,
ParallelStatus)
@@ -7116,8 +7116,8 @@ knative.dev/pkg/apis/duck/v1.KReference
(Appears on:
-ChannelSpec,
-ParallelSpec,
+ChannelSpec,
+ParallelSpec,
SequenceSpec)
@@ -7934,8 +7934,8 @@ knative.dev/pkg/apis/duck/v1.KReference
(Appears on:
-ChannelSpec,
-ParallelSpec,
+ChannelSpec,
+ParallelSpec,
SequenceSpec)
@@ -8818,7 +8818,7 @@ ParallelSubscriptionStatus
(Appears on:
-ParallelBranchStatus,
+ParallelBranchStatus,
ParallelStatus)
@@ -9915,7 +9915,7 @@ SinkBindingStatus
(Appears on:
-ApiServerSourceSpec,
+ApiServerSourceSpec,
ApiServerSourceSpec)
diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md
index 2e3ac53adc..366e623d4f 100644
--- a/docs/reference/api/serving.md
+++ b/docs/reference/api/serving.md
@@ -1131,7 +1131,7 @@ ServiceStatus
(Appears on:
-Configuration,
+Configuration,
ServiceSpec)
@@ -1212,7 +1212,7 @@ ConfigurationStatusFields
(Appears on:
-ConfigurationStatus,
+ConfigurationStatus,
ServiceStatus)
@@ -1299,7 +1299,7 @@ string
(Appears on:
-Revision,
+Revision,
RevisionTemplateSpec)
@@ -1557,7 +1557,7 @@ be provided.
(Appears on:
-Route,
+Route,
ServiceSpec)
@@ -1639,7 +1639,7 @@ RouteStatusFields
(Appears on:
-RouteStatus,
+RouteStatus,
ServiceStatus)
@@ -1834,7 +1834,7 @@ specific to RouteStatus.
(Appears on:
-RouteSpec,
+RouteSpec,
RouteStatusFields)
From 4032aacf3145730713637b4867cfed22ae8a6bdf Mon Sep 17 00:00:00 2001
From: RichieEscarez gen-crd-api-reference-docs
on git commit db4879e0f
.
diff --git a/hack/reference-docs-gen-config.json b/hack/reference-docs-gen-config.json
index b4df81a3c1..dcd5eb9de9 100644
--- a/hack/reference-docs-gen-config.json
+++ b/hack/reference-docs-gen-config.json
@@ -13,7 +13,7 @@
},
{
"typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/",
- "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
+ "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
},
{
"typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/",
From cc591409578c41f0acdbf5de0040309b46e1727d Mon Sep 17 00:00:00 2001
From: RichieEscarez