diff --git a/docs/reference/api/eventing/eventing.md b/docs/reference/api/eventing/eventing.md index 996ab92f4..6215c10c0 100644 --- a/docs/reference/api/eventing/eventing.md +++ b/docs/reference/api/eventing/eventing.md @@ -1,6 +1,9 @@
Packages:
+
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.
+ |
+||||
+spec
+
+
+ConfigMapPropagationSpec
+
+
+ |
+
+ Spec defines the desired state of the ConfigMapPropagation ++ +
|
+||||
+status
+
+
+ConfigMapPropagationStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the EventType. +This data may be out of date. + |
+
+(Appears on: +ConfigMapPropagation) +
++
+Field | +Description | +
---|---|
+originalNamespace
+
+string
+
+ |
+
+ OriginalNamespace is the namespace where the original configMaps are in + |
+
+selector
+
+
+Kubernetes meta/v1.LabelSelector
+
+
+ |
+
+(Optional)
+ Selector only selects original configMaps with corresponding labels + |
+
+(Appears on: +ConfigMapPropagation) +
++
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
+ +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. + |
+
+copyConfigmaps
+
+
+[]ConfigMapPropagationStatusCopyConfigMap
+
+
+ |
+
+(Optional)
+ CopyConfigMaps is the status for each copied configmap. + |
+
+(Appears on: +ConfigMapPropagationStatus) +
++
ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
+ +Field | +Description | +
---|---|
+name
+
+string
+
+ |
+
+ Name is copy configmap’s name + |
+
+source
+
+string
+
+ |
+
+ Source is “originalNamespace/originalConfigMapName” + |
+
+operation
+
+string
+
+ |
+
+ Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop + |
+
+ready
+
+string
+
+ |
+
+ Ready represents the operation is ready or not + |
+
+reason
+
+string
+
+ |
+
+ Reason indicates reasons if the operation is not ready + |
+
+resourceVersionFromSource
+
+string
+
+ |
+
+ ResourceVersion is the resourceVersion of original configmap + |
+
Package v1 is the v1 version of the API.
@@ -58,6 +351,21 @@ Resource Types:
BackoffPolicyType is the type for backoff policies
+Value | +Description | +
---|---|
"exponential" |
+Exponential backoff policy + |
+
"linear" |
+Linear backoff policy + |
+
@@ -127,7 +435,9 @@ DeliverySpec
DeliverySpec contains options controlling the event delivery
+DeliverySpec contains the default delivery spec for each subscription +to this Channelable. Each subscription delivery spec, if any, overrides this +global delivery spec.
(Appears on: -ChannelSpec, Channelable, +ChannelSpec, +ChannelTemplateSpecInternalSpec, InMemoryChannelSpec)
@@ -192,7 +503,9 @@ DeliverySpec
DeliverySpec contains options controlling the event delivery
+DeliverySpec contains the default delivery spec for each subscription +to this Channelable. Each subscription delivery spec, if any, overrides this +global delivery spec.
(Appears on: -ChannelStatus, Channelable, +ChannelStatus, InMemoryChannelStatus)
@@ -281,11 +594,11 @@ Failed messages are delivered here.
(Appears on: -BrokerSpec, ChannelableSpec, +SubscriberSpec, +BrokerSpec, ParallelBranch, SequenceStep, -SubscriberSpec, SubscriptionSpec)
@@ -1517,6 +1830,21 @@ Resource Types:
BackoffPolicyType is the type for backoff policies
+Value | +Description | +
---|---|
"exponential" |
+Exponential backoff policy + |
+
"linear" |
+Linear backoff policy + |
+
@@ -1610,8 +1938,8 @@ ChannelableStatus
(Appears on: -ChannelSpec, Channelable, +ChannelSpec, InMemoryChannelSpec)
@@ -1660,8 +1988,8 @@ DeliverySpec
(Appears on: -ChannelStatus, Channelable, +ChannelStatus, InMemoryChannelStatus)
@@ -1740,14 +2068,14 @@ Failed messages are delivered here.
(Appears on: -BrokerSpec, ChannelableCombinedSpec, -ChannelableSpec, ChannelableSpec, +SubscriberSpec, +ChannelableSpec, +SubscriberSpec, +BrokerSpec, ParallelBranch, SequenceStep, -SubscriberSpec, -SubscriberSpec, SubscriptionSpec)
@@ -2080,8 +2408,8 @@ DeliverySpec
(Appears on: -SubscribableStatus, -SubscribableStatus) +SubscribableStatus, +SubscribableStatus)
SubscriberStatus defines the status of a single subscriber to a Channel.
@@ -2146,6 +2474,2094 @@ string+
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. Subscribers 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/v1
+
+ |
+||||
+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. + |
+
+
Trigger represents a request to have events delivered to a subscriber from a +Broker’s event pool.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+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.
+ |
+||||||
+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 Broker 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: +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. + |
+
+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 Trigger 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 v1beta1 is the v1beta1 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/v1beta1
+
+ |
+||||
+kind
+string
+ |
+Broker |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+BrokerSpec
+
+
+ |
+
+ Spec defines the desired state of the Broker. ++ +
|
+||||
+status
+
+
+BrokerStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Broker. This data may be out of +date. + |
+
+
EventType represents a type of event that can be consumed from a Broker.
+ +Field | +Description | +||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+eventing.knative.dev/v1beta1
+
+ |
+||||||||||||
+kind
+string
+ |
+EventType |
+||||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||
+spec
+
+
+EventTypeSpec
+
+
+ |
+
+ Spec defines the desired state of the EventType. ++ +
|
+||||||||||||
+status
+
+
+EventTypeStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the EventType. +This data may be out of date. +TODO might be removed https://github.com/knative/eventing/issues/2750 + |
+
+
Trigger 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 is the v1 version of the API.
+ +Resource Types: ++
Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+ParallelSpec
+
+
+ |
+
+ Spec defines the desired state of the Parallel. ++ +
|
+||||||
+status
+
+
+ParallelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Parallel. This data may be out of +date. + |
+
+(Appears on: +ParallelSpec) +
++
+Field | +Description | +
---|---|
+filter
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Filter is the expression guarding the branch + |
+
+subscriber
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+ Subscriber receiving the event when the filter passes + |
+
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Reply is a Reference to where the result of Subscriber of this case gets sent to. +If not specified, sent the result to the Parallel Reply + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. + |
+
+(Appears on: +ParallelStatus) +
++
ParallelBranchStatus represents the current state of a Parallel branch
+ +Field | +Description | +
---|---|
+filterSubscriptionStatus
+
+
+ParallelSubscriptionStatus
+
+
+ |
+
+ FilterSubscriptionStatus corresponds to the filter subscription status. + |
+
+filterChannelStatus
+
+
+ParallelChannelStatus
+
+
+ |
+
+ FilterChannelStatus corresponds to the filter channel status. + |
+
+subscriberSubscriptionStatus
+
+
+ParallelSubscriptionStatus
+
+
+ |
+
+ SubscriptionStatus corresponds to the subscriber subscription status. + |
+
+(Appears on: +ParallelBranchStatus, +ParallelStatus) +
++
+Field | +Description | +
---|---|
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Channel is the reference to the underlying channel. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Channel is ready or not. + |
+
+(Appears on: +Parallel) +
++
+Field | +Description | +
---|---|
+branches
+
+
+[]ParallelBranch
+
+
+ |
+
+ Branches is the list of Filter/Subscribers pairs. + |
+
+channelTemplate
+
+
+ChannelTemplateSpec
+
+
+ |
+
+(Optional)
+ ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace). + |
+
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Reply is a Reference to where the result of a case Subscriber gets sent to +when the case does not have a Reply + |
+
+(Appears on: +Parallel) +
++
ParallelStatus represents the current state of a Parallel.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+ingressChannelStatus
+
+
+ParallelChannelStatus
+
+
+ |
+
+ IngressChannelStatus corresponds to the ingress channel status. + |
+
+branchStatuses
+
+
+[]ParallelBranchStatus
+
+
+ |
+
+ BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order. + |
+
+AddressStatus
+
+knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ |
+
+
+(Members of AddressStatus is the starting point to this Parallel. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name} + |
+
+(Appears on: +ParallelBranchStatus) +
++
+Field | +Description | +
---|---|
+subscription
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Subscription is the reference to the underlying Subscription. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Subscription is ready or not. + |
+
+
Sequence defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+SequenceSpec
+
+
+ |
+
+ Spec defines the desired state of the Sequence. ++ +
|
+||||||
+status
+
+
+SequenceStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Sequence. This data may be out of +date. + |
+
+(Appears on: +SequenceStatus) +
++
+Field | +Description | +
---|---|
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Channel is the reference to the underlying channel. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Channel is ready or not. + |
+
+(Appears on: +Sequence) +
++
+Field | +Description | +
---|---|
+steps
+
+
+[]SequenceStep
+
+
+ |
+
+ Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options + |
+
+channelTemplate
+
+
+ChannelTemplateSpec
+
+
+ |
+
+(Optional)
+ ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD +for the namespace (or cluster, in case there are no defaults for the namespace). + |
+
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Reply is a Reference to where the result of the last Subscriber gets sent to. + |
+
+(Appears on: +Sequence) +
++
SequenceStatus represents the current state of a Sequence.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+subscriptionStatuses
+
+
+[]SequenceSubscriptionStatus
+
+
+ |
+
+ SubscriptionStatuses is an array of corresponding Subscription statuses. +Matches the Spec.Steps array in the order. + |
+
+channelStatuses
+
+
+[]SequenceChannelStatus
+
+
+ |
+
+ ChannelStatuses is an array of corresponding Channel statuses. +Matches the Spec.Steps array in the order. + |
+
+AddressStatus
+
+knative.dev/pkg/apis/duck/v1.AddressStatus
+
+ |
+
+
+(Members of AddressStatus is the starting point to this Sequence. Sending to this +will target the first subscriber. +It generally has the form {channel}.{namespace}.svc.{cluster domain name} + |
+
+(Appears on: +SequenceSpec) +
++
+Field | +Description | +
---|---|
+Destination
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+
+(Members of Subscriber receiving the step event + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. + |
+
+(Appears on: +SequenceStatus) +
++
+Field | +Description | +
---|---|
+subscription
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Subscription is the reference to the underlying Subscription. + |
+
+ready
+
+knative.dev/pkg/apis.Condition
+
+ |
+
+ ReadyCondition indicates whether the Subscription is ready or not. + |
+
Package v1beta1 is the v1beta1 version of the API.
@@ -2980,1072 +5396,22 @@ knative.dev/pkg/apis.Condition-
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
- -Field | -Description | -||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1beta1
-
- |
-||||||||||
-kind
-string
- |
-ApiServerSource |
-||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||
-spec
-
-
-ApiServerSourceSpec
-
-
- |
-
- - -
|
-||||||||||
-status
-
-
-ApiServerSourceStatus
-
-
- |
-- | -
-
ContainerSource is the Schema for the containersources API
- -Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1beta1
-
- |
-||||
-kind
-string
- |
-ContainerSource |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-ContainerSourceSpec
-
-
- |
-
- - -
|
-||||
-status
-
-
-ContainerSourceStatus
-
-
- |
-- | -
-
PingSource is the Schema for the PingSources API.
- -Field | -Description | -||||||||
---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1beta1
-
- |
-||||||||
-kind
-string
- |
-PingSource |
-||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||
-spec
-
-
-PingSourceSpec
-
-
- |
-
- - -
|
-||||||||
-status
-
-
-PingSourceStatus
-
-
- |
-- | -
-
SinkBinding describes a Binding that is also a Source.
-The sink
(from the Source duck) is resolved to a URL and
-then projected into the subject
by augmenting the runtime
-contract of the referenced containers to have a K_SINK
-environment variable holding the endpoint to which to send
-cloud events.
Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1beta1
-
- |
-||||
-kind
-string
- |
-SinkBinding |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-SinkBindingSpec
-
-
- |
-
- - -
|
-||||
-status
-
-
-SinkBindingStatus
-
-
- |
-- | -
-(Appears on: -ApiServerSourceSpec) -
--
APIVersionKind is an APIVersion and Kind tuple.
- -Field | -Description | -
---|---|
-apiVersion
-
-string
-
- |
-
- APIVersion - the API version of the resource to watch. - |
-
-kind
-
-string
-
- |
-
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - |
-
-(Appears on: -ApiServerSourceSpec) -
--
APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
- -Field | -Description | -
---|---|
-apiVersion
-
-string
-
- |
-
- APIVersion - the API version of the resource to watch. - |
-
-kind
-
-string
-
- |
-
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - |
-
-selector
-
-
-Kubernetes meta/v1.LabelSelector
-
-
- |
-
-(Optional)
- LabelSelector filters this source to objects to those resources pass the -label selector. -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors - |
-
-(Appears on: -ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
- -Field | -Description | -
---|---|
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-resources
-
-
-[]APIVersionKindSelector
-
-
- |
-
- Resource are the resources this source will track and send related -lifecycle events from the Kubernetes ApiServer, with an optional label -selector to help filter. - |
-
-owner
-
-
-APIVersionKind
-
-
- |
-
-(Optional)
- ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter. - |
-
-mode
-
-string
-
- |
-
-(Optional)
- EventMode controls the format of the event.
- |
-
-serviceAccountName
-
-string
-
- |
-
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set. - |
-
-(Appears on: -ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-(Appears on: -ContainerSource) -
--
ContainerSourceSpec defines the desired state of ContainerSource
- -Field | -Description | -
---|---|
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-template
-
-
-Kubernetes core/v1.PodTemplateSpec
-
-
- |
-
- Template describes the pods that will be created - |
-
-(Appears on: -ContainerSource) -
--
ContainerSourceStatus defines the observed state of ContainerSource
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-(Appears on: -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) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
- -Field | -Description | -
---|---|
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-BindingSpec
-
-knative.dev/pkg/apis/duck/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: --
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.
+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/v1
+messaging.knative.dev/v1
|
@@ -4070,7 +5436,7 @@ eventing.knative.dev/v1
Broker |
+Channel |
||||||||
@@ -4091,43 +5457,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. |
-
Trigger represents a request to have events delivered to a subscriber from a -Broker’s event pool.
+InMemoryChannel is a resource representing an in memory channel
-eventing.knative.dev/v1
+messaging.knative.dev/v1
|
@@ -4179,7 +5545,7 @@ eventing.knative.dev/v1
Trigger |
+InMemoryChannel |
||
@@ -4200,40 +5566,135 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-TriggerSpec
+
+InMemoryChannelSpec
|
- Spec defines the desired state of the Trigger. +Spec defines the desired state of the Channel.
|
||
-filter
+status
-
-TriggerFilter
+
+InMemoryChannelStatus
|
(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. +Status represents the current state of the Channel. This data may be out of +date. + |
+
+
Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
+ +Field | +Description | +|||
---|---|---|---|---|
+apiVersion
+string |
+
+
+messaging.knative.dev/v1
+
+ |
+|||
+kind
+string
+ |
+Subscription |
+|||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+|||
+spec
+
+
+SubscriptionSpec
+
+
+ |
+
+ + +
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. |
|||
-status
+reply
-
-TriggerStatus
-
+knative.dev/pkg/apis/duck/v1.Destination
|
(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. +Reply specifies (optionally) how to handle events returned from +the Subscriber target. |
(Optional)
- Delivery is the delivery specification for Events within the Broker mesh. -This includes things like retries, DLQ, etc. +Delivery configuration + |
+
status
+
+
+SubscriptionStatus
+
+
++
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ +(Appears on: -Broker) +Channel)
-
BrokerStatus represents the current state of a Broker.
+ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. +It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.
+ +Field | +Description | +
---|---|
+channelTemplate
+
+
+ChannelTemplateSpec
+
+
+ |
+
+ ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. +This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user. + |
+
+ChannelableSpec
+
+
+ChannelableSpec
+
+
+ |
+
+
+(Members of Channel conforms to ChannelableSpec + |
+
+(Appears on: +Channel) +
++
ChannelStatus represents the current state of a Channel.
+ +Field | +Description | +
---|---|
+ChannelableStatus
+
+
+ChannelableStatus
+
+
+ |
+
+
+(Members of Channel conforms to ChannelableStatus + |
+
+channel
+
+knative.dev/pkg/apis/duck/v1.KReference
+
+ |
+
+ Channel is an KReference to the Channel CRD backing this Channel. + |
+
+(Appears on: +ParallelSpec, +SequenceSpec, +ChannelSpec) +
++
+Field | +Description | +
---|---|
+spec
+
+k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ |
+
+(Optional)
+ Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
+
+
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
+
+
+ChannelTemplateSpecInternalSpec
+
+
+ |
+
+ Spec includes the Channel CR ChannelableSpec and the physical channel spec. +In order to create a new ChannelTemplateSpecInternalSpec, you must use NewChannelTemplateSpecInternalSpec ++ + |
+
+(Appears on: +ChannelTemplateSpecInternal) +
++
ChannelTemplateSpecInternalSpec merges the “general” spec from Channel CR and the template of the physical channel spec. +Note that this struct properly implements only Marshalling, unmarshalling doesn’t work!
+ +Field | +Description | +
---|---|
+ChannelableSpec
+
+
+ChannelableSpec
+
+
+ |
+
+ ChannelableSpec includes the fields from the Channel Spec section + |
+
+PhysicalChannelSpec
+
+k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ |
+
+(Optional)
+ PhysicalChannelSpec includes the fields from the physical channel Spec. Passed +in verbatim to the Channel CRD as Spec section. + |
+
+(Appears on: +InMemoryChannel) +
++
InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
+ +Field | +Description | +
---|---|
+ChannelableSpec
+
+
+ChannelableSpec
+
+
+ |
+
+
+(Members of Channel conforms to Duck type Channelable. + |
+
+(Appears on: +InMemoryChannel) +
++
ChannelStatus represents the current state of a Channel.
+ +Field | +Description | +
---|---|
+ChannelableStatus
+
+
+ChannelableStatus
+
+
+ |
+
+
+(Members of Channel conforms to Duck type Channelable. + |
+
+(Appears on: +Subscription) +
++
SubscriptionSpec specifies the Channel for incoming events, a Subscriber target +for processing those events and where to put the result of the processing. Only +From (where the events are coming from) is always required. You can optionally +only Process the events (results in no output events) by leaving out the Result. +You can also perform an identity transformation on the incoming events by leaving +out the Subscriber and only specifying Result.
+The following are all valid specifications: +channel –[subscriber]–> reply +Sink, no outgoing events: +channel – subscriber +no-op function (identity transformation): +channel –> reply
+ +Field | +Description | +
---|---|
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Reference to a channel that will be used to create the subscription +You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name +The resource pointed by this ObjectReference must meet the +contract to the ChannelableSpec duck type. If the resource does not +meet this contract it will be reflected in the Subscription’s status. +This field is immutable. We have no good answer on what happens to +the events that are currently in the channel being consumed from +and what the semantics there should be. For now, you can always +delete the Subscription and recreate it to point to a different +channel, giving the user more control over what semantics should +be used (drain the channel first, possibly have events dropped, +etc.) + |
+
+subscriber
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Subscriber is reference to (optional) function for processing events. +Events from the Channel will be delivered here and replies are +sent to a Destination as specified by the Reply. + |
+
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Reply specifies (optionally) how to handle events returned from +the Subscriber target. + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ Delivery configuration + |
+
+(Appears on: +Subscription) +
++
SubscriptionStatus (computed) for a subscription
-address
+physicalSubscription
-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) -
--
-Field | -Description | -
---|---|
-attributes
-
-
-TriggerFilterAttributes
+
+SubscriptionStatusPhysicalSubscription
|
-(Optional)
- Attributes filters events by exact match on event context attributes. -Each key in the map is compared with the equivalent key in the event -context. An event passes the filter if all values are equal to the -specified values. -Nested context attributes are not supported as keys. Only string values are supported. +PhysicalSubscription is the fully resolved values that this Subscription represents. |
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) +SubscriptionStatus)
+
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
-broker
-
-string
-
- |
-
- Broker is the broker that this trigger receives events from. - |
-
-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 Trigger 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. +SubscriberURI is the fully resolved URI for spec.subscriber. + |
+
+replyUri
+
+knative.dev/pkg/apis.URL
+
+ |
+
+ ReplyURI is the fully resolved URI for the spec.reply. + |
+
+deadLetterSinkUri
+
+knative.dev/pkg/apis.URL
+
+ |
+
+ ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. + |
+
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: ++
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
+ +Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion
+string |
+
+
+messaging.knative.dev/v1beta1
+
+ |
+||||
+kind
+string
+ |
+Channel |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+ChannelSpec
+
+
+ |
+
+ Spec defines the desired state of the Channel. ++ +
|
+||||
+status
+
+
+ChannelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. + |
+
+
InMemoryChannel is a resource representing an in memory channel
+ +Field | +Description | +||
---|---|---|---|
+apiVersion
+string |
+
+
+messaging.knative.dev/v1beta1
+
+ |
+||
+kind
+string
+ |
+InMemoryChannel |
+||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||
+spec
+
+
+InMemoryChannelSpec
+
+
+ |
+
+ Spec defines the desired state of the Channel. ++ +
|
+||
+status
+
+
+InMemoryChannelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. + |
+
+
Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
+ +Field | +Description | +||||||||
---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+messaging.knative.dev/v1beta1
+
+ |
+||||||||
+kind
+string
+ |
+Subscription |
+||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec
+
+
+SubscriptionSpec
+
+
+ |
+
+ + +
|
+||||||||
+status
+
+
+SubscriptionStatus
+
+
+ |
++ | +
+
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ ++(Appears on: +Channel) +
++
ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. +It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.
+ +Field | +Description | +
---|---|
+channelTemplate
+
+
+ChannelTemplateSpec
+
+
+ |
+
+ ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. +This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user. + |
+
+ChannelableSpec
+
+
+ChannelableSpec
+
+
+ |
+
+
+(Members of Channel conforms to ChannelableSpec + |
+
+(Appears on: +Channel) +
++
ChannelStatus represents the current state of a Channel.
+ +Field | +Description | +
---|---|
+ChannelableStatus
+
+
+ChannelableStatus
+
+
+ |
+
+
+(Members of Channel conforms to ChannelableStatus + |
+
+channel
+
+knative.dev/pkg/apis/duck/v1.KReference
+
+ |
+
+ Channel is an KReference to the Channel CRD backing this Channel. + |
+
+(Appears on: +ParallelSpec, +SequenceSpec, +ChannelSpec) +
++
+Field | +Description | +
---|---|
+spec
+
+k8s.io/apimachinery/pkg/runtime.RawExtension
+
+ |
+
+(Optional)
+ Spec defines the Spec to use for each channel created. Passed +in verbatim to the Channel CRD as Spec section. ++ + |
+
+
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: +InMemoryChannel) +
++
InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
+ +Field | +Description | +
---|---|
+ChannelableSpec
+
+
+ChannelableSpec
+
+
+ |
+
+
+(Members of Channel conforms to Duck type Channelable. + |
+
+(Appears on: +InMemoryChannel) +
++
ChannelStatus represents the current state of a Channel.
+ +Field | +Description | +
---|---|
+ChannelableStatus
+
+
+ChannelableStatus
+
+
+ |
+
+
+(Members of Channel conforms to Duck type Channelable. + |
+
+(Appears on: +Subscription) +
++
SubscriptionSpec specifies the Channel for incoming events, a Subscriber target +for processing those events and where to put the result of the processing. Only +From (where the events are coming from) is always required. You can optionally +only Process the events (results in no output events) by leaving out the Result. +You can also perform an identity transformation on the incoming events by leaving +out the Subscriber and only specifying Result.
+The following are all valid specifications: +channel –[subscriber]–> reply +Sink, no outgoing events: +channel – subscriber +no-op function (identity transformation): +channel –> reply
+ +Field | +Description | +
---|---|
+channel
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+ Reference to a channel that will be used to create the subscription +You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name +The resource pointed by this ObjectReference must meet the +contract to the ChannelableSpec duck type. If the resource does not +meet this contract it will be reflected in the Subscription’s status. +This field is immutable. We have no good answer on what happens to +the events that are currently in the channel being consumed from +and what the semantics there should be. For now, you can always +delete the Subscription and recreate it to point to a different +channel, giving the user more control over what semantics should +be used (drain the channel first, possibly have events dropped, +etc.) + |
+
+subscriber
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Subscriber is reference to (optional) function for processing events. +Events from the Channel will be delivered here and replies are +sent to a Destination as specified by the Reply. + |
+
+reply
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+(Optional)
+ Reply specifies (optionally) how to handle events returned from +the Subscriber target. + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ Delivery configuration + |
+
+(Appears on: +Subscription) +
++
SubscriptionStatus (computed) for a subscription
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of inherits duck/v1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state. + |
+
+physicalSubscription
+
+
+SubscriptionStatusPhysicalSubscription
+
+
+ |
+
+ PhysicalSubscription is the fully resolved values that this Subscription represents. + |
+
+(Appears on: +SubscriptionStatus) +
++
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
+ +Field | +Description | +
---|---|
+subscriberUri
+
+knative.dev/pkg/apis.URL
+
+ |
+
+ SubscriberURI is the fully resolved URI for spec.subscriber. + |
+
+replyUri
+
+knative.dev/pkg/apis.URL
+
+ |
+
+ ReplyURI is the fully resolved URI for the spec.reply. + |
+
+deadLetterSinkUri
+
+knative.dev/pkg/apis.URL
+
+ |
+
+ ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. |
-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: - --
Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.
- -Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-eventing.knative.dev/v1beta1
-
- |
-||||
-kind
-string
- |
-Broker |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-BrokerSpec
-
-
- |
-
- Spec defines the desired state of the Broker. -- -
|
-||||
-status
-
-
-BrokerStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Broker. This data may be out of -date. - |
-
-
EventType represents a type of event that can be consumed from a Broker.
- -Field | -Description | -||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-eventing.knative.dev/v1beta1
-
- |
-||||||||||||
-kind
-string
- |
-EventType |
-||||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||||
-spec
-
-
-EventTypeSpec
-
-
- |
-
- Spec defines the desired state of the EventType. -- -
|
-||||||||||||
-status
-
-
-EventTypeStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the EventType. -This data may be out of date. -TODO might be removed https://github.com/knative/eventing/issues/2750 - |
-
-
Trigger 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 is the v1 version of the API.
- -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
- -Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1
-
- |
-||||
-kind
-string
- |
-Channel |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-ChannelSpec
-
-
- |
-
- Spec defines the desired state of the Channel. -- -
|
-||||
-status
-
-
-ChannelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
InMemoryChannel is a resource representing an in memory channel
- -Field | -Description | -||
---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1
-
- |
-||
-kind
-string
- |
-InMemoryChannel |
-||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec
-
-
-InMemoryChannelSpec
-
-
- |
-
- Spec defines the desired state of the Channel. -- -
|
-||
-status
-
-
-InMemoryChannelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
- -Field | -Description | -||||||||
---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1
-
- |
-||||||||
-kind
-string
- |
-Subscription |
-||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||
-spec
-
-
-SubscriptionSpec
-
-
- |
-
- - -
|
-||||||||
-status
-
-
-SubscriptionStatus
-
-
- |
-- | -
-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- --(Appears on: -Channel) -
--
ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. -It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.
- -Field | -Description | -
---|---|
-channelTemplate
-
-
-ChannelTemplateSpec
-
-
- |
-
- ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. -This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user. - |
-
-ChannelableSpec
-
-
-ChannelableSpec
-
-
- |
-
-
-(Members of Channel conforms to ChannelableSpec - |
-
-(Appears on: -Channel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | -
---|---|
-ChannelableStatus
-
-
-ChannelableStatus
-
-
- |
-
-
-(Members of Channel conforms to ChannelableStatus - |
-
-channel
-
-knative.dev/pkg/apis/duck/v1.KReference
-
- |
-
- Channel is an KReference to the Channel CRD backing this Channel. - |
-
-(Appears on: -ChannelSpec, -ParallelSpec, -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: -InMemoryChannel) -
--
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
- -Field | -Description | -
---|---|
-ChannelableSpec
-
-
-ChannelableSpec
-
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on: -InMemoryChannel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | -
---|---|
-ChannelableStatus
-
-
-ChannelableStatus
-
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on: -Subscription) -
--
SubscriptionSpec specifies the Channel for incoming events, a Subscriber target -for processing those events and where to put the result of the processing. Only -From (where the events are coming from) is always required. You can optionally -only Process the events (results in no output events) by leaving out the Result. -You can also perform an identity transformation on the incoming events by leaving -out the Subscriber and only specifying Result.
-The following are all valid specifications: -channel –[subscriber]–> reply -Sink, no outgoing events: -channel – subscriber -no-op function (identity transformation): -channel –> reply
- -Field | -Description | -
---|---|
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status. -This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.) - |
-
-subscriber
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply. - |
-
-reply
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. - |
-
-delivery
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- Delivery configuration - |
-
-(Appears on: -Subscription) -
--
SubscriptionStatus (computed) for a subscription
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-physicalSubscription
-
-
-SubscriptionStatusPhysicalSubscription
-
-
- |
-
- PhysicalSubscription is the fully resolved values that this Subscription represents. - |
-
-(Appears on: -SubscriptionStatus) -
--
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
- -Field | -Description | -
---|---|
-subscriberUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- SubscriberURI is the fully resolved URI for spec.subscriber. - |
-
-replyUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- ReplyURI is the fully resolved URI for the spec.reply. - |
-
-deadLetterSinkUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. - |
-
-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
- -Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
- |
-||||
-kind
-string
- |
-Channel |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-ChannelSpec
-
-
- |
-
- Spec defines the desired state of the Channel. -- -
|
-||||
-status
-
-
-ChannelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
InMemoryChannel is a resource representing an in memory channel
- -Field | -Description | -||
---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
- |
-||
-kind
-string
- |
-InMemoryChannel |
-||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec
-
-
-InMemoryChannelSpec
-
-
- |
-
- Spec defines the desired state of the Channel. -- -
|
-||
-status
-
-
-InMemoryChannelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
- -Field | -Description | -||||||||
---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1beta1
-
- |
-||||||||
-kind
-string
- |
-Subscription |
-||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||
-spec
-
-
-SubscriptionSpec
-
-
- |
-
- - -
|
-||||||||
-status
-
-
-SubscriptionStatus
-
-
- |
-- | -
-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- --(Appears on: -Channel) -
--
ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. -It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.
- -Field | -Description | -
---|---|
-channelTemplate
-
-
-ChannelTemplateSpec
-
-
- |
-
- ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. -This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user. - |
-
-ChannelableSpec
-
-
-ChannelableSpec
-
-
- |
-
-
-(Members of Channel conforms to ChannelableSpec - |
-
-(Appears on: -Channel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | -
---|---|
-ChannelableStatus
-
-
-ChannelableStatus
-
-
- |
-
-
-(Members of Channel conforms to ChannelableStatus - |
-
-channel
-
-knative.dev/pkg/apis/duck/v1.KReference
-
- |
-
- Channel is an KReference to the Channel CRD backing this Channel. - |
-
-(Appears on: -ChannelSpec, -ParallelSpec, -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: -InMemoryChannel) -
--
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
- -Field | -Description | -
---|---|
-ChannelableSpec
-
-
-ChannelableSpec
-
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on: -InMemoryChannel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | -
---|---|
-ChannelableStatus
-
-
-ChannelableStatus
-
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on: -Subscription) -
--
SubscriptionSpec specifies the Channel for incoming events, a Subscriber target -for processing those events and where to put the result of the processing. Only -From (where the events are coming from) is always required. You can optionally -only Process the events (results in no output events) by leaving out the Result. -You can also perform an identity transformation on the incoming events by leaving -out the Subscriber and only specifying Result.
-The following are all valid specifications: -channel –[subscriber]–> reply -Sink, no outgoing events: -channel – subscriber -no-op function (identity transformation): -channel –> reply
- -Field | -Description | -
---|---|
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status. -This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.) - |
-
-subscriber
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply. - |
-
-reply
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. - |
-
-delivery
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- Delivery configuration - |
-
-(Appears on: -Subscription) -
--
SubscriptionStatus (computed) for a subscription
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-physicalSubscription
-
-
-SubscriptionStatusPhysicalSubscription
-
-
- |
-
- PhysicalSubscription is the fully resolved values that this Subscription represents. - |
-
-(Appears on: -SubscriptionStatus) -
--
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
- -Field | -Description | -
---|---|
-subscriberUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- SubscriberURI is the fully resolved URI for spec.subscriber. - |
-
-replyUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- ReplyURI is the fully resolved URI for the spec.reply. - |
-
-deadLetterSinkUri
-
-knative.dev/pkg/apis.URL
-
- |
-
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. - |
-
-
Package 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.
- |
-||||
-spec
-
-
-ConfigMapPropagationSpec
-
-
- |
-
- Spec defines the desired state of the ConfigMapPropagation -- -
|
-||||
-status
-
-
-ConfigMapPropagationStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the EventType. -This data may be out of date. - |
-
-(Appears on: -ConfigMapPropagation) -
--
-Field | -Description | -
---|---|
-originalNamespace
-
-string
-
- |
-
- OriginalNamespace is the namespace where the original configMaps are in - |
-
-selector
-
-
-Kubernetes meta/v1.LabelSelector
-
-
- |
-
-(Optional)
- Selector only selects original configMaps with corresponding labels - |
-
-(Appears on: -ConfigMapPropagation) -
--
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
- -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. - |
-
-copyConfigmaps
-
-
-[]ConfigMapPropagationStatusCopyConfigMap
-
-
- |
-
-(Optional)
- CopyConfigMaps is the status for each copied configmap. - |
-
-(Appears on: -ConfigMapPropagationStatus) -
--
ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
- -Field | -Description | -
---|---|
-name
-
-string
-
- |
-
- Name is copy configmap’s name - |
-
-source
-
-string
-
- |
-
- Source is “originalNamespace/originalConfigMapName” - |
-
-operation
-
-string
-
- |
-
- Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop - |
-
-ready
-
-string
-
- |
-
- Ready represents the operation is ready or not - |
-
-reason
-
-string
-
- |
-
- Reason indicates reasons if the operation is not ready - |
-
-resourceVersionFromSource
-
-string
-
- |
-
- ResourceVersion is the resourceVersion of original configmap - |
-
-
Package v1 is the v1 version of the API.
- -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec
-
-
-ParallelSpec
-
-
- |
-
- Spec defines the desired state of the Parallel. -- -
|
-||||||
-status
-
-
-ParallelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. - |
-
-(Appears on: -ParallelSpec) -
--
-Field | -Description | -
---|---|
-filter
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Filter is the expression guarding the branch - |
-
-subscriber
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
- Subscriber receiving the event when the filter passes - |
-
-reply
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Reply is a Reference to where the result of Subscriber of this case gets sent to. -If not specified, sent the result to the Parallel Reply - |
-
-delivery
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. - |
-
-(Appears on: -ParallelStatus) -
--
ParallelBranchStatus represents the current state of a Parallel branch
- -Field | -Description | -
---|---|
-filterSubscriptionStatus
-
-
-ParallelSubscriptionStatus
-
-
- |
-
- FilterSubscriptionStatus corresponds to the filter subscription status. - |
-
-filterChannelStatus
-
-
-ParallelChannelStatus
-
-
- |
-
- FilterChannelStatus corresponds to the filter channel status. - |
-
-subscriberSubscriptionStatus
-
-
-ParallelSubscriptionStatus
-
-
- |
-
- SubscriptionStatus corresponds to the subscriber subscription status. - |
-
-(Appears on: -ParallelBranchStatus, -ParallelStatus) -
--
-Field | -Description | -
---|---|
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Channel is the reference to the underlying channel. - |
-
-ready
-
-knative.dev/pkg/apis.Condition
-
- |
-
- ReadyCondition indicates whether the Channel is ready or not. - |
-
-(Appears on: -Parallel) -
--
-Field | -Description | -
---|---|
-branches
-
-
-[]ParallelBranch
-
-
- |
-
- Branches is the list of Filter/Subscribers pairs. - |
-
-channelTemplate
-
-
-ChannelTemplateSpec
-
-
- |
-
-(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). - |
-
-reply
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply - |
-
-(Appears on: -Parallel) -
--
ParallelStatus represents the current state of a Parallel.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-ingressChannelStatus
-
-
-ParallelChannelStatus
-
-
- |
-
- IngressChannelStatus corresponds to the ingress channel status. - |
-
-branchStatuses
-
-
-[]ParallelBranchStatus
-
-
- |
-
- BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order. - |
-
-AddressStatus
-
-knative.dev/pkg/apis/duck/v1.AddressStatus
-
- |
-
-
-(Members of AddressStatus is the starting point to this Parallel. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-(Appears on: -ParallelBranchStatus) -
--
-Field | -Description | -
---|---|
-subscription
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Subscription is the reference to the underlying Subscription. - |
-
-ready
-
-knative.dev/pkg/apis.Condition
-
- |
-
- ReadyCondition indicates whether the Subscription is ready or not. - |
-
-
Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec
-
-
-SequenceSpec
-
-
- |
-
- Spec defines the desired state of the Sequence. -- -
|
-||||||
-status
-
-
-SequenceStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. - |
-
-(Appears on: -SequenceStatus) -
--
-Field | -Description | -
---|---|
-channel
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Channel is the reference to the underlying channel. - |
-
-ready
-
-knative.dev/pkg/apis.Condition
-
- |
-
- ReadyCondition indicates whether the Channel is ready or not. - |
-
-(Appears on: -Sequence) -
--
-Field | -Description | -
---|---|
-steps
-
-
-[]SequenceStep
-
-
- |
-
- Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options - |
-
-channelTemplate
-
-
-ChannelTemplateSpec
-
-
- |
-
-(Optional)
- ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace). - |
-
-reply
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Reply is a Reference to where the result of the last Subscriber gets sent to. - |
-
-(Appears on: -Sequence) -
--
SequenceStatus represents the current state of a Sequence.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-subscriptionStatuses
-
-
-[]SequenceSubscriptionStatus
-
-
- |
-
- SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order. - |
-
-channelStatuses
-
-
-[]SequenceChannelStatus
-
-
- |
-
- ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order. - |
-
-AddressStatus
-
-knative.dev/pkg/apis/duck/v1.AddressStatus
-
- |
-
-
-(Members of AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-(Appears on: -SequenceSpec) -
--
-Field | -Description | -
---|---|
-Destination
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-
-(Members of Subscriber receiving the step event - |
-
-delivery
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. - |
-
-(Appears on: -SequenceStatus) -
--
-Field | -Description | -
---|---|
-subscription
-
-
-Kubernetes core/v1.ObjectReference
-
-
- |
-
- Subscription is the reference to the underlying Subscription. - |
-
-ready
-
-knative.dev/pkg/apis.Condition
-
- |
-
- ReadyCondition indicates whether the Subscription is ready or not. - |
-
Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
@@ -10431,7 +9468,1360 @@ Source.+
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.
+ +Resource Types: ++
ApiServerSource is the Schema for the apiserversources API
+ +Field | +Description | +||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1beta1
+
+ |
+||||||||||
+kind
+string
+ |
+ApiServerSource |
+||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec
+
+
+ApiServerSourceSpec
+
+
+ |
+
+ + +
|
+||||||||||
+status
+
+
+ApiServerSourceStatus
+
+
+ |
++ | +
+
ContainerSource is the Schema for the containersources API
+ +Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1beta1
+
+ |
+||||
+kind
+string
+ |
+ContainerSource |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+ContainerSourceSpec
+
+
+ |
+
+ + +
|
+||||
+status
+
+
+ContainerSourceStatus
+
+
+ |
++ | +
+
PingSource is the Schema for the PingSources API.
+ +Field | +Description | +||||||||
---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1beta1
+
+ |
+||||||||
+kind
+string
+ |
+PingSource |
+||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec
+
+
+PingSourceSpec
+
+
+ |
+
+ + +
|
+||||||||
+status
+
+
+PingSourceStatus
+
+
+ |
++ | +
+
SinkBinding describes a Binding that is also a Source.
+The sink
(from the Source duck) is resolved to a URL and
+then projected into the subject
by augmenting the runtime
+contract of the referenced containers to have a K_SINK
+environment variable holding the endpoint to which to send
+cloud events.
Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1beta1
+
+ |
+||||
+kind
+string
+ |
+SinkBinding |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+SinkBindingSpec
+
+
+ |
+
+ + +
|
+||||
+status
+
+
+SinkBindingStatus
+
+
+ |
++ | +
+(Appears on: +ApiServerSourceSpec) +
++
APIVersionKind is an APIVersion and Kind tuple.
+ +Field | +Description | +
---|---|
+apiVersion
+
+string
+
+ |
+
+ APIVersion - the API version of the resource to watch. + |
+
+kind
+
+string
+
+ |
+
+ Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+
+(Appears on: +ApiServerSourceSpec) +
++
APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
+ +Field | +Description | +
---|---|
+apiVersion
+
+string
+
+ |
+
+ APIVersion - the API version of the resource to watch. + |
+
+kind
+
+string
+
+ |
+
+ Kind of the resource to watch. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |
+
+selector
+
+
+Kubernetes meta/v1.LabelSelector
+
+
+ |
+
+(Optional)
+ LabelSelector filters this source to objects to those resources pass the +label selector. +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceSpec defines the desired state of ApiServerSource
+ +Field | +Description | +
---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink. + |
+
+resources
+
+
+[]APIVersionKindSelector
+
+
+ |
+
+ Resource are the resources this source will track and send related +lifecycle events from the Kubernetes ApiServer, with an optional label +selector to help filter. + |
+
+owner
+
+
+APIVersionKind
+
+
+ |
+
+(Optional)
+ ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter. + |
+
+mode
+
+string
+
+ |
+
+(Optional)
+ EventMode controls the format of the event.
+ |
+
+serviceAccountName
+
+string
+
+ |
+
+(Optional)
+ ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set. + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceStatus defines the observed state of ApiServerSource
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. + |
+
+(Appears on: +ContainerSource) +
++
ContainerSourceSpec defines the desired state of ContainerSource
+ +Field | +Description | +
---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink. + |
+
+template
+
+
+Kubernetes core/v1.PodTemplateSpec
+
+
+ |
+
+ Template describes the pods that will be created + |
+
+(Appears on: +ContainerSource) +
++
ContainerSourceStatus defines the observed state of ContainerSource
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of inherits duck/v1 SourceStatus, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last +processed by the controller. +* Conditions - the latest available observations of a resource’s current +state. +* SinkURI - the current active sink URI that has been configured for the +Source. + |
+
+(Appears on: +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) +
++
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ +Field | +Description | +
---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink. + |
+
+BindingSpec
+
+knative.dev/pkg/apis/duck/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 v1beta2 contains API Schema definitions for the sources v1beta2 API group.
+ +Resource Types: ++
PingSource is the Schema for the PingSources API.
+ +Field | +Description | +||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1beta2
+
+ |
+||||||||||||
+kind
+string
+ |
+PingSource |
+||||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||
+spec
+
+
+PingSourceSpec
+
+
+ |
+
+ + +
|
+||||||||||||
+status
+
+
+PingSourceStatus
+
+
+ |
++ | +
+(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 cron schedule. Defaults to |
+
+timezone
+
+string
+
+ |
+
+ Timezone modifies the actual time relative to the specified timezone. +Defaults to the system time zone. +More general information about time zones: https://www.iana.org/time-zones +List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones + |
+
+contentType
+
+string
+
+ |
+
+(Optional)
+ ContentType is the media type of Data or DataBase64. Default is empty. + |
+
+data
+
+string
+
+ |
+
+(Optional)
+ Data is data used as the body of the event posted to the sink. Default is empty. +Mutually exclusive with DataBase64. + |
+
+dataBase64
+
+string
+
+ |
+
+(Optional)
+ DataBase64 is base64 encoded binary data used as the body of the event posted to the sink. Default is empty. +Mutually exclusive with Data. + |
+
+(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. + |
+
Generated with gen-crd-api-reference-docs
-on git commit 0f9a8c55c
.
+on git commit a414aee50
.
PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative components instantiate autoscalers. This definition is an abstraction that may be backed by multiple definitions. For more information, see the Knative Pluggability presentation: -https://docs.google.com/presentation/d/e/2PACX-1vQ4kT92QNXvBF9dJzVfF_zqUROoG1wZXf-ATMKi8d43htvt3Osq6k-1YUWAO9M27gZ8C-cGBQA8-bwJ/pub
+https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/editValue | +Description | +
---|---|
"Reachable" |
+ReachabilityReachable means the |
+
"" |
+ReachabilityUnknown means the reachability of the |
+
"Unreachable" |
+ReachabilityUnreachable means the |
+
@@ -1704,6 +1723,30 @@ LatestReadyRevisionName that we last observed.
RoutingState represents states of a revision with regards to serving a route.
+Value | +Description | +
---|---|
"active" |
+RoutingStateActive is a state for a revision which are actively referenced by a Route. + |
+
"pending" |
+RoutingStatePending is a state after a revision is created, but before +its routing state has been determined. It is treated like active for the purposes +of revision garbage collection. + |
+
"reserve" |
+RoutingStateReserve is a state for a revision which is no longer referenced by a Route, +and is scaled down, but may be rapidly pinned to a route to be made active again. + |
+
"" |
+RoutingStateUnset is the empty value for routing state, this state is unexpected. + |
+
@@ -2173,5 +2216,5 @@ knative.dev/pkg/apis/duck/v1.Addressable
Generated with gen-crd-api-reference-docs
-on git commit db4879e0f
.
+on git commit 560a4f678
.