@@ -54,7 +57,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -92,7 +95,7 @@ string
awsCredsSecret
-
+
Kubernetes core/v1.SecretKeySelector
@@ -105,7 +108,7 @@ Kubernetes core/v1.SecretKeySelector
sink
-
+
Kubernetes core/v1.ObjectReference
@@ -179,7 +182,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -217,36 +220,9 @@ CamelSourceOriginSpec
serviceAccountName
-
-string
-
-DEPRECATED: moved inside the specific CamelSourceOriginSpec -ServiceAccountName is the name of the ServiceAccount to use to run this -source.
-image
-
-string
-
-DEPRECATED: use the context field in CamelSourceOriginSpec -Image is an optional base image used to run the source.
-sink
-
+
Kubernetes core/v1.ObjectReference
@@ -307,7 +283,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -334,7 +310,7 @@ GcpPubSubSourceSpec
gcpCredsSecret
-
+
Kubernetes core/v1.SecretKeySelector
@@ -342,8 +318,8 @@ Kubernetes core/v1.SecretKeySelector
GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used to create or delete the Subscription, only to poll it. The value of the secret entry must be -a service account key in the JSON format (see -https://cloud.google.com/iam/docs/creating-managing-service-account-keys.
+a service account key in the JSON format +( see https://cloud.google.com/iam/docs/creating-managing-service-account-keys ).sink
-
+
Kubernetes core/v1.ObjectReference
@@ -388,7 +364,7 @@ Kubernetes core/v1.ObjectReference
transformer
-
+
Kubernetes core/v1.ObjectReference
@@ -461,7 +437,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -561,7 +537,7 @@ secret token
sink
-
+
Kubernetes core/v1.ObjectReference
@@ -647,7 +623,7 @@ string
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -719,7 +695,7 @@ KafkaSourceNetSpec
sink
-
+
Kubernetes core/v1.ObjectReference
@@ -803,7 +779,7 @@ string
awsCredsSecret
-
+
Kubernetes core/v1.SecretKeySelector
@@ -816,7 +792,7 @@ Kubernetes core/v1.SecretKeySelector
sink
-
+
Kubernetes core/v1.ObjectReference
@@ -862,9 +838,7 @@ run the Receive Adapter Deployment.
Status
-
-github.com/knative/pkg/apis/duck/v1alpha1.Status
-
+knative.dev/pkg/apis/duck/v1alpha1.Status
Component is a kind of source that directly references a Camel component
+Component is a kind of source that directly references a Camel component +DEPRECATED
Integration is a kind of source that contains a Camel K integration
flow
+
+string
+
+Flow is a kind of source that contains a single Camel YAML flow route
+serviceAccountName
-
-string
-
-DEPRECATED: moved inside the specific CamelSourceOriginSpec -ServiceAccountName is the name of the ServiceAccount to use to run this -source.
-image
-
-string
-
-DEPRECATED: use the context field in CamelSourceOriginSpec -Image is an optional base image used to run the source.
-sink
-
+
Kubernetes core/v1.ObjectReference
@@ -1090,9 +1049,7 @@ Kubernetes core/v1.ObjectReference
Status
-
-github.com/knative/pkg/apis/duck/v1alpha1.Status
-
+knative.dev/pkg/apis/duck/v1alpha1.Status
gcpCredsSecret
-
+
Kubernetes core/v1.SecretKeySelector
@@ -1147,8 +1104,8 @@ Kubernetes core/v1.SecretKeySelector
GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used to create or delete the Subscription, only to poll it. The value of the secret entry must be -a service account key in the JSON format (see -https://cloud.google.com/iam/docs/creating-managing-service-account-keys).
+a service account key in the JSON format +( see https://cloud.google.com/iam/docs/creating-managing-service-account-keys ).sink
-
+
Kubernetes core/v1.ObjectReference
@@ -1193,7 +1150,7 @@ Kubernetes core/v1.ObjectReference
transformer
-
+
Kubernetes core/v1.ObjectReference
@@ -1238,9 +1195,7 @@ Adapter Deployment.
Status
-
-github.com/knative/pkg/apis/duck/v1alpha1.Status
-
+knative.dev/pkg/apis/duck/v1alpha1.Status
sink
-
+
Kubernetes core/v1.ObjectReference
@@ -1430,9 +1385,7 @@ bool
Status
-
-github.com/knative/pkg/apis/duck/v1alpha1.Status
-
+knative.dev/pkg/apis/duck/v1alpha1.Status
sink
-
+
Kubernetes core/v1.ObjectReference
@@ -1810,9 +1763,7 @@ KafkaResourceSpec
Status
-
-github.com/knative/pkg/apis/duck/v1alpha1.Status
-
+knative.dev/pkg/apis/duck/v1alpha1.Status
(Appears on: +GitHubSourceSpec) +
++
SecretValueFromSource represents the source of a secret value
+ +| Field | +Description | +
|---|---|
+secretKeyRef
+
+
+Kubernetes core/v1.SecretKeySelector
+
+
+ |
+
+ The Secret key to select from. + |
+
+(Appears on: KafkaSourceSASLSpec, KafkaSourceTLSSpec)
@@ -1930,39 +1913,7 @@ SecretValueFromSourcesecretKeyRef
-
-Kubernetes core/v1.SecretKeySelector
-
-
-The Secret key to select from.
--(Appears on: -GitHubSourceSpec) -
--
SecretValueFromSource represents the source of a secret value
- -| Field | -Description | -
|---|---|
-secretKeyRef
-
-
+
Kubernetes core/v1.SecretKeySelector
@@ -1974,7 +1925,246 @@ Kubernetes core/v1.SecretKeySelector
|
+
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
+
+github.com/knative/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/v1beta1.Status
+
+ |
+
+
+(Members of inherits duck/v1beta1 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
+
+github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
+
+ |
+
+
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. + |
+
Generated with gen-crd-api-reference-docs
-on git commit 641f98fe.
+on git commit 4bda4fca.
Packages:
Package v1alpha1 is the v1alpha1 version of the API.
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.
+Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
-duck.knative.dev/v1alpha1
-
- |
-
-|||
-kind
-string
- |
-Channelable |
-||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec
-
-
-ChannelableSpec
-
-
- |
-
- Spec is the part where the Channelable fulfills the Subscribable contract. -- -
|
-||
-status
-
-
-ChannelableStatus
-
-
- |
-- | -
-
SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
- -| Field | -Description | -||
|---|---|---|---|
-apiVersion
-string |
-
-
-duck.knative.dev/v1alpha1
-
- |
-||
-kind
-string
- |
-SubscribableType |
-||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec
-
-
-SubscribableTypeSpec
-
-
- |
-
- SubscribableTypeSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. -- -
|
-||
-status
-
-
-SubscribableTypeStatus
-
-
- |
-
- SubscribableTypeStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. - |
-
-(Appears on: -Channelable) -
--
ChannelableSpec contains Spec of the Channelable object
- -| Field | -Description | -
|---|---|
-SubscribableTypeSpec
-
-
-SubscribableTypeSpec
-
-
- |
-
-
-(Members of |
-
-(Appears on: -Channelable) -
--
ChannelableStatus contains the Status of a Channelable object.
- -| Field | -Description | -
|---|---|
-Status
-
-
-github.com/knative/pkg/apis/duck/v1beta1.Status
-
-
- |
-
-
-(Members of inherits duck/v1beta1 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
-
-
-github.com/knative/pkg/apis/duck/v1alpha1.AddressStatus
-
-
- |
-
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. - |
-
-SubscribableTypeStatus
-
-
-SubscribableTypeStatus
-
-
- |
-
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. - |
-
-(Appears on: -ChannelSpec, -InMemoryChannelSpec, -SubscribableTypeSpec) -
--
Subscribable is the schema for the subscribable portion of the spec -section of the resource.
- -| Field | -Description | -
|---|---|
-subscribers
-
-
-[]SubscriberSpec
-
-
- |
-
- This is the list of subscriptions for this subscribable. - |
-
-(Appears on: -SubscribableTypeStatus) -
--
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
- -| Field | -Description | -
|---|---|
-subscribers
-
-
-[]SubscriberStatus
-
-
- |
-
- This is the list of subscription’s statuses for this channel. - |
-
-(Appears on: -SubscribableType, -ChannelableSpec) -
--
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
- -| Field | -Description | -
|---|---|
-subscribable
-
-
-Subscribable
-
-
- |
-- | -
-(Appears on: -SubscribableType, -ChannelStatus, -ChannelableStatus, -InMemoryChannelStatus) -
--
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
- -| Field | -Description | -
|---|---|
-subscribablestatus
-
-
-SubscribableStatus
-
-
- |
-- | -
-(Appears on: -Subscribable) -
--
SubscriberSpec defines a single subscriber to a Subscribable. -Ref is a reference to the Subscription this SubscriberSpec was created for -SubscriberURI is the endpoint for the subscriber -ReplyURI is the endpoint for the reply -At least one of SubscriberURI and ReplyURI must be present
- -| Field | -Description | -
|---|---|
-ref
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
-(Optional)
- Deprecated: use UID. - |
-
-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
-
-string
-
- |
--(Optional) - | -
-replyURI
-
-string
-
- |
--(Optional) - | -
-(Appears on: -SubscribableStatus) -
--
SubscriberStatus defines the status of a single subscriber to a Channel.
- -| Field | -Description | -
|---|---|
-uid
-
-k8s.io/apimachinery/pkg/types.UID
-
- |
-
-(Optional)
- UID is used to understand the origin of the subscriber. - |
-
-observedGeneration
-
-int64
-
- |
-
-(Optional)
- Generation of the origin of the subscriber with uid:UID. - |
-
-ready
-
-
-Kubernetes core/v1.ConditionStatus
-
-
- |
-
-(Optional)
- Status of the subscriber. - |
-
-message
-
-string
-
- |
-
-(Optional)
- A human readable message indicating details of Ready status. - |
-
-
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. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.
- -| Field | -Description | -||||
|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
-
- |
-||||
-kind
-string
- |
-Broker |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-BrokerSpec
-
-
- |
-
- Spec defines the desired state of the Broker. -- -
|
-||||
-status
-
-
-BrokerStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Broker. This data may be out of -date. - |
-
-
Channel is an abstract resource that implements the Addressable contract. -The Provisioner provisions infrastructure to accepts events and -deliver to Subscriptions.
- -| Field | -Description | -||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-eventing.knative.dev/v1alpha1
+messaging.knative.dev/v1alpha1
|
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -779,7 +72,7 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-
+
ChannelSpec
@@ -791,43 +84,16 @@ ChannelSpec
ClusterChannelProvisioner --- ClusterChannelProvisioner encapsulates a provisioning strategy for the -backing resources required to realize a particular resource type. - -
EventType --- -
Subscription --- Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD. - -
Trigger --- Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool. - -
BrokerSpec ---(Appears on: -Broker) - -- -
BrokerStatus ---(Appears on: -Broker) - -- BrokerStatus represents the current state of a Broker. - -
ChannelProvisionerDefaulter --- ChannelProvisionerDefaulter sets the default Provisioner and Arguments on Channels that do not -specify any Provisioner. - -ChannelSpec ---(Appears on: -Channel, -BrokerSpec) - -- ChannelSpec specifies the Provisioner backing a channel and the configuration -arguments for a Channel. - -
ChannelStatus ---(Appears on: -Channel) - -- ChannelStatus represents the current state of a Channel. - -
ChannelTemplateSpec ---(Appears on: -BrokerSpec) - -- This should be duck so that Broker can also use this - -
ChannelTemplateSpecInternal --- Internal version of ChannelTemplateSpec that includes ObjectMeta so that -we can easily create new Channels off of it. - -
ClusterChannelProvisionerSpec ---(Appears on: -ClusterChannelProvisioner) - -- ClusterChannelProvisionerSpec is the spec for a ClusterChannelProvisioner resource. - -
ClusterChannelProvisionerStatus ---(Appears on: -ClusterChannelProvisioner) - -- ClusterChannelProvisionerStatus is the status for a ClusterChannelProvisioner resource - -
EventTypeSpec ---(Appears on: -EventType) - -- -
EventTypeStatus ---(Appears on: -EventType) - -- EventTypeStatus represents the current state of a EventType. - -
HasSpec --- -ReplyStrategy ---(Appears on: -SubscriptionSpec) - -- ReplyStrategy specifies the handling of the SubscriberSpec’s returned replies. -If no SubscriberSpec is specified, the identity function is assumed. - -
SubscriberSpec ---(Appears on: -SequenceSpec, -SubscriptionSpec, -TriggerSpec) - -- SubscriberSpec specifies the reference to an object that’s expected to -provide the resolved target of the action. -Currently we inspect the objects Status and see if there’s a predefined -Status field that we will then use to dispatch events to be processed by -the target. Currently must resolve to a k8s service. -Note that in the future we should try to utilize subresources (/resolve ?) to -make this cleaner, but CRDs do not support subresources yet, so we need -to rely on a specified Status field today. By relying on this behaviour -we can utilize a dynamic client instead of having to understand all -kinds of different types of objects. As long as they adhere to this -particular contract, they can be used as a Target. -This ensures that we can support external targets and for ease of use -we also allow for an URI to be specified. -There of course is also a requirement for the resolved SubscriberSpec to -behave properly at the data plane level. -TODO: Add a pointer to a real spec for this. -For now, this means: Receive an event payload, and respond with one of: -success and an optional response event, or failure. -Delivery failures may be retried by the channel - -
SubscriptionSpec ---(Appears on: -Subscription) - -- SubscriptionSpec specifies the Channel for incoming events, a Subscriber target -for processing those events and where to put the result of the processing. Only -From (where the events are coming from) is always required. You can optionally -only Process the events (results in no output events) by leaving out the Result. -You can also perform an identity transformation on the incoming events by leaving -out the Subscriber and only specifying Result. -The following are all valid specifications: -channel –[subscriber]–> reply -Sink, no outgoing events: -channel – subscriber -no-op function (identity transformation): -channel –> reply - -
SubscriptionStatus ---(Appears on: -Subscription) - -- SubscriptionStatus (computed) for a subscription - -
SubscriptionStatusPhysicalSubscription ---(Appears on: -SubscriptionStatus) - -- SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription. - -
TriggerFilter ---(Appears on: -TriggerSpec) - -- -
TriggerFilterSourceAndType ---(Appears on: -TriggerFilter) - -- TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and -source attributes. Only exact matches will pass the filter. Either or both type and source can -use the value ‘Any’ to indicate all strings match. - -
TriggerSpec ---(Appears on: -Trigger) - -- -
TriggerStatus ---(Appears on: -Trigger) - -- TriggerStatus represents the current state of a Trigger. - -
- messaging.knative.dev/v1alpha1-- Package v1alpha1 is the v1alpha1 version of the API. - -Resource Types: -InMemoryChannel@@ -2501,7 +163,7 @@ string |
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -2559,14 +221,15 @@ date.
|
(Appears on: -SequenceSpec) +Channel)
-
This should be duck so that Broker can also use this
+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.
-spec
+channelTemplate
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ChannelTemplateSpec
+
|
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - 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. + |
+
+subscribable
+
+
+Subscribable
+
+
+ |
+
+ Channel conforms to Duck type Subscribable. |
-
Internal version of ChannelTemplateSpec that includes ObjectMeta so that -we can easily create new Channels off of it.
+(Appears on: +Channel) + ++
ChannelStatus represents the current state of a Channel.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1beta1.Status
+
+ |
+
+
+(Members of inherits duck/v1beta1 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 Channel is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster. +It generally has the form {channel}.{namespace}.svc.{cluster domain name} + |
+
+SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+ |
+
+
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. + |
+
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Channel is an ObjectReference to the Channel CRD backing this Channel. + |
+
+
Choice defines conditional branches that will be wired in +series through Channels and Subscriptions.
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -2628,19 +382,441 @@ Refer to the Kubernetes API documentation for the fields of the
|
spec
-k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ChoiceSpec
+
+
+ |
+
+ Spec defines the desired state of the Choice. ++ +
ChoiceCase +++(Appears on: +ChoiceSpec) + ++ +
ChoiceCaseStatus +++(Appears on: +ChoiceStatus) + ++ ChoiceCaseStatus represents the current state of a Choice case + +
ChoiceChannelStatus +++(Appears on: +ChoiceCaseStatus, +ChoiceStatus) + ++ +
ChoiceSpec +++(Appears on: +Choice) + ++ +
ChoiceStatus +++(Appears on: +Choice) + ++ ChoiceStatus represents the current state of a Choice. + +
ChoiceSubscriptionStatus +++(Appears on: +ChoiceCaseStatus) + ++ +
InMemoryChannelSpec
@@ -2698,9 +874,7 @@ Subscribable
Status
-
-github.com/knative/pkg/apis/duck/v1beta1.Status
-
+knative.dev/pkg/apis/duck/v1beta1.Status
AddressStatus
-
-github.com/knative/pkg/apis/duck/v1alpha1.AddressStatus
-
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -2810,20 +982,22 @@ provided.
channelTemplate
-
+
ChannelTemplateSpec
| reply
-
+
Kubernetes core/v1.ObjectReference
@@ -2880,7 +1054,7 @@ date.
| channel
-
+
Kubernetes core/v1.ObjectReference
@@ -2893,7 +1067,7 @@ Kubernetes core/v1.ObjectReference
|
ready
-github.com/knative/pkg/apis.Condition
+knative.dev/pkg/apis.Condition
@@ -2936,20 +1110,22 @@ provided.
|
|
channelTemplate
-
+
ChannelTemplateSpec
- |
ChannelTemplate specifies which Channel CRD to use +(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
-
+
Kubernetes core/v1.ObjectReference
@@ -2989,9 +1165,7 @@ it will be reflected in the Subscription’s status.
|
Status
-
-github.com/knative/pkg/apis/duck/v1beta1.Status
-
+knative.dev/pkg/apis/duck/v1beta1.Status
@@ -3005,7 +1179,7 @@ github.com/knative/pkg/apis/duck/v1beta1.Status
|
- | SubscriptionStatuses
+subscriptionStatuses
[]SequenceSubscriptionStatus
@@ -3019,7 +1193,7 @@ Matches the Spec.Steps array in the order.
- | ChannelStatuses
+channelStatuses
[]SequenceChannelStatus
@@ -3035,9 +1209,7 @@ Matches the Spec.Steps array in the order.
|
AddressStatus
-
-github.com/knative/pkg/apis/duck/v1alpha1.AddressStatus
-
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
@@ -3071,7 +1243,7 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}
|
| subscription
-
+
Kubernetes core/v1.ObjectReference
@@ -3084,7 +1256,7 @@ Kubernetes core/v1.ObjectReference
|
ready
-github.com/knative/pkg/apis.Condition
+knative.dev/pkg/apis.Condition
@@ -3140,7 +1312,7 @@ string
|
| metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -3193,7 +1365,7 @@ source.
| sink
-
+
Kubernetes core/v1.ObjectReference
@@ -3267,7 +1439,7 @@ string
| metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -3294,7 +1466,7 @@ ContainerSourceSpec
| template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -3334,7 +1506,7 @@ When Template is set, this field is ignored.
| env
-
+
[]Kubernetes core/v1.EnvVar
@@ -3366,7 +1538,7 @@ When Template is set, this field is ignored.
| sink
-
+
Kubernetes core/v1.ObjectReference
@@ -3427,7 +1599,7 @@ string
| metadata
-
+
Kubernetes meta/v1.ObjectMeta
@@ -3476,7 +1648,7 @@ string
| sink
-
+
Kubernetes core/v1.ObjectReference
@@ -3628,7 +1800,7 @@ source.
| sink
-
+
Kubernetes core/v1.ObjectReference
@@ -3674,9 +1846,7 @@ string
|
Status
-
-github.com/knative/pkg/apis/duck/v1beta1.Status
-
+knative.dev/pkg/apis/duck/v1beta1.Status
@@ -3723,7 +1893,7 @@ string
|
| template
-
+
Kubernetes core/v1.PodTemplateSpec
@@ -3763,7 +1933,7 @@ When Template is set, this field is ignored.
| env
-
+
[]Kubernetes core/v1.EnvVar
@@ -3795,7 +1965,7 @@ When Template is set, this field is ignored.
| sink
-
+
Kubernetes core/v1.ObjectReference
@@ -3828,9 +1998,7 @@ Kubernetes core/v1.ObjectReference
|
Status
-
-github.com/knative/pkg/apis/duck/v1beta1.Status
-
+knative.dev/pkg/apis/duck/v1beta1.Status
@@ -4017,7 +2185,7 @@ string
|
| sink
-
+
Kubernetes core/v1.ObjectReference
@@ -4075,9 +2243,7 @@ CronJobResourceSpec
|
Status
-
-github.com/knative/pkg/apis/duck/v1beta1.Status
-
+knative.dev/pkg/apis/duck/v1beta1.Status
@@ -4104,7 +2270,2482 @@ string
| |
ChannelTemplate specifies which Channel CRD to use
+(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).
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +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.
+ +| Field | +Description | +||
|---|---|---|---|
+apiVersion
+string |
+
+
+duck.knative.dev/v1alpha1
+
+ |
+||
+kind
+string
+ |
+Channelable |
+||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||
+spec
+
+
+ChannelableSpec
+
+
+ |
+
+ Spec is the part where the Channelable fulfills the Subscribable contract. ++ +
|
+||
+status
+
+
+ChannelableStatus
+
+
+ |
++ | +
+
Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch +arbitrary other resources (such as any Importer or Addressable). This is not a real resource.
+ +| Field | +Description | +
|---|---|
+apiVersion
+string |
+
+
+duck.knative.dev/v1alpha1
+
+ |
+
+kind
+string
+ |
+Resource |
+
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+
SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers +defining compatible resources to embed it. We will typically use this type to deserialize +SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
+ +| Field | +Description | +||
|---|---|---|---|
+apiVersion
+string |
+
+
+duck.knative.dev/v1alpha1
+
+ |
+||
+kind
+string
+ |
+SubscribableType |
+||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||
+spec
+
+
+SubscribableTypeSpec
+
+
+ |
+
+ SubscribableTypeSpec is the part where Subscribable object is +configured as to be compatible with Subscribable contract. ++ +
|
+||
+status
+
+
+SubscribableTypeStatus
+
+
+ |
+
+ 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: +BrokerSpec, +ChannelSpec, +ChoiceSpec, +SequenceSpec) +
++
+| Field | +Description | +
|---|---|
+spec
+
+k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ |
+
+(Optional)
+ Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
+
+
ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.
+ +| Field | +Description | +
|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+spec
+
+k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ |
+
+(Optional)
+ Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
+
+(Appears on: +Channelable) +
++
ChannelableSpec contains Spec of the Channelable object
+ +| Field | +Description | +
|---|---|
+SubscribableTypeSpec
+
+
+SubscribableTypeSpec
+
+
+ |
+
+
+(Members of |
+
+(Appears on: +Channelable) +
++
ChannelableStatus contains the Status of a Channelable object.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1beta1.Status
+
+ |
+
+
+(Members of inherits duck/v1beta1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+AddressStatus
+
+knative.dev/pkg/apis/duck/v1alpha1.AddressStatus
+
+ |
+
+
+(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. + |
+
+SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+ |
+
+
+(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. + |
+
+(Appears on: +ChannelSpec, +ChannelSpec, +InMemoryChannelSpec, +SubscribableTypeSpec) +
++
Subscribable is the schema for the subscribable portion of the spec +section of the resource.
+ +| Field | +Description | +
|---|---|
+subscribers
+
+
+[]SubscriberSpec
+
+
+ |
+
+ This is the list of subscriptions for this subscribable. + |
+
+(Appears on: +SubscribableTypeStatus) +
++
SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
+ +| Field | +Description | +
|---|---|
+subscribers
+
+
+[]SubscriberStatus
+
+
+ |
+
+ This is the list of subscription’s statuses for this channel. + |
+
+(Appears on: +SubscribableType, +ChannelableSpec) +
++
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
+ +| Field | +Description | +
|---|---|
+subscribable
+
+
+Subscribable
+
+
+ |
++ | +
+(Appears on: +SubscribableType, +ChannelStatus, +ChannelStatus, +ChannelableStatus, +InMemoryChannelStatus) +
++
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+ +| Field | +Description | +
|---|---|
+subscribablestatus
+
+
+SubscribableStatus
+
+
+ |
++ | +
+(Appears on: +Subscribable) +
++
SubscriberSpec defines a single subscriber to a Subscribable. +Ref is a reference to the Subscription this SubscriberSpec was created for +SubscriberURI is the endpoint for the subscriber +ReplyURI is the endpoint for the reply +At least one of SubscriberURI and ReplyURI must be present
+ +| Field | +Description | +
|---|---|
+ref
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+(Optional)
+ Deprecated: use UID. + |
+
+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
+
+string
+
+ |
++(Optional) + | +
+replyURI
+
+string
+
+ |
++(Optional) + | +
+(Appears on: +SubscribableStatus) +
++
SubscriberStatus defines the status of a single subscriber to a Channel.
+ +| Field | +Description | +
|---|---|
+uid
+
+k8s.io/apimachinery/pkg/types.UID
+
+ |
+
+(Optional)
+ UID is used to understand the origin of the subscriber. + |
+
+observedGeneration
+
+int64
+
+ |
+
+(Optional)
+ Generation of the origin of the subscriber with uid:UID. + |
+
+ready
+
+
+Kubernetes core/v1.ConditionStatus
+
+
+ |
+
+(Optional)
+ Status of the subscriber. + |
+
+message
+
+string
+
+ |
+
+(Optional)
+ A human readable message indicating details of Ready status. + |
+
+
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. Receivers use Triggers to +request delivery of events from a Broker’s pool to a specific URL or +Addressable endpoint.
+ +| Field | +Description | +||||
|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+eventing.knative.dev/v1alpha1
+
+ |
+||||
+kind
+string
+ |
+Broker |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+BrokerSpec
+
+
+ |
+
+ Spec defines the desired state of the Broker. ++ +
|
+||||
+status
+
+
+BrokerStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Broker. This data may be out of +date. + |
+
+
Channel is an abstract resource that implements the Addressable contract. +The Provisioner provisions infrastructure to accepts events and +deliver to Subscriptions.
+ +| Field | +Description | +||||||||
|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+eventing.knative.dev/v1alpha1
+
+ |
+||||||||
+kind
+string
+ |
+Channel |
+||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec
+
+
+ChannelSpec
+
+
+ |
+
+ Spec defines the desired state of the Channel. ++ +
|
+||||||||
+status
+
+
+ChannelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. + |
+
+
ClusterChannelProvisioner encapsulates a provisioning strategy for the +backing resources required to realize a particular resource type.
+ +| Field | +Description | +||
|---|---|---|---|
+apiVersion
+string |
+
+
+eventing.knative.dev/v1alpha1
+
+ |
+||
+kind
+string
+ |
+ClusterChannelProvisioner |
+||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||
+spec
+
+
+ClusterChannelProvisionerSpec
+
+
+ |
+
+ Spec defines the Types provisioned by this Provisioner. ++ +
|
+||
+status
+
+
+ClusterChannelProvisionerStatus
+
+
+ |
+
+(Optional)
+ Status is the current status of the Provisioner. + |
+
+
+| Field | +Description | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+eventing.knative.dev/v1alpha1
+
+ |
+||||||||||
+kind
+string
+ |
+EventType |
+||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec
+
+
+EventTypeSpec
+
+
+ |
+
+ Spec defines the desired state of the EventType. ++ +
|
+||||||||||
+status
+
+
+EventTypeStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the EventType. +This data may be out of date. + |
+
+
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/v1alpha1
+
+ |
+||||||||
+kind
+string
+ |
+Subscription |
+||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec
+
+
+SubscriptionSpec
+
+
+ |
+
+ + +
|
+||||||||
+status
+
+
+SubscriptionStatus
+
+
+ |
++ | +
+
Trigger represents a request to have events delivered to a consumer from a +Broker’s event pool.
+ +| Field | +Description | +||||||
|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+eventing.knative.dev/v1alpha1
+
+ |
+||||||
+kind
+string
+ |
+Trigger |
+||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+TriggerSpec
+
+
+ |
+
+ Spec defines the desired state of the Trigger. ++ +
|
+||||||
+status
+
+
+TriggerStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Trigger. This data may be out of +date. + |
+
+(Appears on: +Broker) +
++
+| Field | +Description | +
|---|---|
+channelTemplate
+
+
+ChannelSpec
+
+
+ |
+
+(Optional)
+ DeprecatedChannelTemplate, if specified will be used to create all the Channels used internally by the +Broker. Only Provisioner and Arguments may be specified. If left unspecified, the default +Channel CRD for the namespace will be used using the channelTemplateSpec attribute. + |
+
+channelTemplateSpec
+
+
+ChannelTemplateSpec
+
+
+ |
+
+(Optional)
+ ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the +Broker. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there +are no defaults for the namespace). + |
+
+(Appears on: +Broker) +
++
BrokerStatus represents the current state of a Broker.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1beta1.Status
+
+ |
+
+
+(Members of inherits duck/v1beta1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+address
+
+knative.dev/pkg/apis/duck/v1alpha1.Addressable
+
+ |
+
+ Broker is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster. +It generally has the form {broker}-router.{namespace}.svc.{cluster domain name} + |
+
+triggerChannel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ TriggerChannel is an objectref to the object for the TriggerChannel + |
+
+IngressChannel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ IngressChannel is an objectref to the object for the IngressChannel + |
+
+
ChannelProvisionerDefaulter sets the default Provisioner and Arguments on Channels that do not +specify any Provisioner.
+ ++(Appears on: +Channel, +BrokerSpec) +
++
ChannelSpec specifies the Provisioner backing a channel and the configuration +arguments for a Channel.
+ +| Field | +Description | +
|---|---|
+generation
+
+int64
+
+ |
+
+(Optional)
+ TODO By enabling the status subresource metadata.generation should increment +thus making this property obsolete. +We should be able to drop this property with a CRD conversion webhook +in the future + |
+
+provisioner
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Provisioner defines the name of the Provisioner backing this channel. + |
+
+arguments
+
+k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ |
+
+(Optional)
+ Arguments defines the arguments to pass to the Provisioner which +provisions this Channel. + |
+
+subscribable
+
+
+Subscribable
+
+
+ |
+
+ Channel conforms to Duck type Subscribable. + |
+
+(Appears on: +Channel) +
++
ChannelStatus represents the current state of a Channel.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1beta1.Status
+
+ |
+
+
+(Members of inherits duck/v1beta1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+address
+
+knative.dev/pkg/apis/duck/v1alpha1.Addressable
+
+ |
+
+ Channel is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster. +It generally has the form {channel}.{namespace}.svc.{cluster domain name} + |
+
+internal
+
+k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ |
+
+(Optional)
+ Internal is status unique to each ClusterChannelProvisioner. + |
+
+SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+ |
+
+
+(Members of |
+
+(Appears on: +ClusterChannelProvisioner) +
++
ClusterChannelProvisionerSpec is the spec for a ClusterChannelProvisioner resource.
+ +| Field | +Description | +
|---|---|
+generation
+
+int64
+
+ |
+
+(Optional)
+ TODO By enabling the status subresource metadata.generation should increment +thus making this property obsolete. +We should be able to drop this property with a CRD conversion webhook +in the future + |
+
+(Appears on: +ClusterChannelProvisioner) +
++
ClusterChannelProvisionerStatus is the status for a ClusterChannelProvisioner resource
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1beta1.Status
+
+ |
+
+
+(Members of inherits duck/v1beta1 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: +EventType) +
++
+| Field | +Description | +
|---|---|
+type
+
+string
+
+ |
+
+ Type represents the CloudEvents type. It is authoritative. + |
+
+source
+
+string
+
+ |
+
+ Source is a URI, it represents the CloudEvents source. + |
+
+schema
+
+string
+
+ |
+
+(Optional)
+ Schema is a URI, it represents the CloudEvents schemaurl extension attribute. +It may be a JSON schema, a protobuf schema, etc. It is optional. + |
+
+broker
+
+string
+
+ |
+
+ Broker refers to the Broker that can provide the EventType. + |
+
+description
+
+string
+
+ |
+
+(Optional)
+ Description is an optional field used to describe the EventType, in any meaningful way. + |
+
+(Appears on: +EventType) +
++
EventTypeStatus represents the current state of a EventType.
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1beta1.Status
+
+ |
+
+
+(Members of inherits duck/v1beta1 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: +SubscriptionSpec) +
++
ReplyStrategy specifies the handling of the SubscriberSpec’s returned replies. +If no SubscriberSpec is specified, the identity function is assumed.
+ +| Field | +Description | +
|---|---|
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+(Optional)
+ You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name +The resource pointed by this ObjectReference must meet the Addressable contract +with a reference to the Addressable duck type. If the resource does not meet this contract, +it will be reflected in the Subscription’s status. + |
+
+(Appears on: +ChoiceCase, +SequenceSpec, +SubscriptionSpec, +TriggerSpec) +
++
SubscriberSpec specifies the reference to an object that’s expected to +provide the resolved target of the action. +Currently we inspect the objects Status and see if there’s a predefined +Status field that we will then use to dispatch events to be processed by +the target. Currently must resolve to a k8s service. +Note that in the future we should try to utilize subresources (/resolve ?) to +make this cleaner, but CRDs do not support subresources yet, so we need +to rely on a specified Status field today. By relying on this behaviour +we can utilize a dynamic client instead of having to understand all +kinds of different types of objects. As long as they adhere to this +particular contract, they can be used as a Target.
+This ensures that we can support external targets and for ease of use +we also allow for an URI to be specified. +There of course is also a requirement for the resolved SubscriberSpec to +behave properly at the data plane level. +TODO: Add a pointer to a real spec for this. +For now, this means: Receive an event payload, and respond with one of: +success and an optional response event, or failure. +Delivery failures may be retried by the channel
+ +| Field | +Description | +
|---|---|
+ref
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+(Optional)
+ Reference to an object that will be used to find the target +endpoint, which should implement the Addressable duck type. +For example, this could be a reference to a Route resource +or a Knative Service resource. +TODO: Specify the required fields the target object must +have in the status. +You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name + |
+
+dnsName
+
+string
+
+ |
+
+(Optional)
+ Deprecated: Use URI instead. +Reference to a ‘known’ endpoint where no resolving is done. +http://k8s-service for example +http://myexternalhandler.example.com/foo/bar + |
+
+uri
+
+string
+
+ |
+
+(Optional)
+ Reference to a ‘known’ endpoint where no resolving is done. +http://k8s-service for example +http://myexternalhandler.example.com/foo/bar + |
+
+(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 | +
|---|---|
+generation
+
+int64
+
+ |
+
+(Optional)
+ TODO By enabling the status subresource metadata.generation should increment +thus making this property obsolete. +We should be able to drop this property with a CRD conversion webhook +in the future + |
+
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ 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
+
+
+SubscriberSpec
+
+
+ |
+
+(Optional)
+ Subscriber is reference to (optional) function for processing events. +Events from the Channel will be delivered here and replies are +sent to a channel as specified by the Reply. + |
+
+reply
+
+
+ReplyStrategy
+
+
+ |
+
+(Optional)
+ Reply specifies (optionally) how to handle events returned from +the Subscriber target. + |
+
+(Appears on: +Subscription) +
++
SubscriptionStatus (computed) for a subscription
+ +| Field | +Description | +
|---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1beta1.Status
+
+ |
+
+
+(Members of inherits duck/v1beta1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+physicalSubscription
+
+
+SubscriptionStatusPhysicalSubscription
+
+
+ |
+
+ PhysicalSubscription is the fully resolved values that this Subscription represents. + |
+
+(Appears on: +SubscriptionStatus) +
++
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
+ +| Field | +Description | +
|---|---|
+subscriberURI
+
+string
+
+ |
+
+ SubscriberURI is the fully resolved URI for spec.subscriber. + |
+
+replyURI
+
+string
+
+ |
+
+ ReplyURI is the fully resolved URI for the spec.reply. + |
+
+(Appears on: +TriggerSpec) +
++
+| Field | +Description | +
|---|---|
+sourceAndType
+
+
+TriggerFilterSourceAndType
+
+
+ |
+
+(Optional)
+ DeprecatedSourceAndType filters events based on exact matches on the +CloudEvents type and source attributes. This field has been replaced by the +Attributes field. + |
+
+attributes
+
+
+TriggerFilterAttributes
+
+
+ |
+
+(Optional)
+ Attributes filters events by exact match on event context attributes. +Each key in the map is compared with the equivalent key in the event +context. An event passes the filter if all values are equal to the +specified values. +Nested context attributes are not supported as keys. Only string values are supported. + |
+
map[string]string alias)+(Appears on: +TriggerFilter) +
++
TriggerFilterAttributes is a map of context attribute names to values for +filtering by equality. Only exact matches will pass the filter. You can use the value “ +to indicate all strings match.
+ ++(Appears on: +TriggerFilter) +
++
TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and +source attributes. Only exact matches will pass the filter. Either or both type and source can +use the value “ to indicate all strings match.
+ +| Field | +Description | +
|---|---|
+type
+
+string
+
+ |
++ | +
+source
+
+string
+
+ |
++ | +
+(Appears on: +Trigger) +
++
+| Field | +Description | +
|---|---|
+broker
+
+string
+
+ |
+
+ Broker is the broker that this trigger receives events from. If not specified, will default +to ‘default’. + |
+
+filter
+
+
+TriggerFilter
+
+
+ |
+
+(Optional)
+ Filter is the filter to apply against all events from the Broker. Only events that pass this +filter will be sent to the Subscriber. If not specified, will default to allowing all events. + |
+
+subscriber
+
+
+SubscriberSpec
+
+
+ |
+
+ 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/v1beta1.Status
+
+ |
+
+
+(Members of inherits duck/v1beta1 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
+
+string
+
+ |
+
+ SubscriberURI is the resolved URI of the receiver for this Trigger. + |
+
Generated with gen-crd-api-reference-docs
-on git commit ab260095.
+on git commit a59dae6f.