Packages:
-Package v1 is the v1 version of the API.
-string alias)-(Appears on:DeliverySpec) -
-BackoffPolicyType is the type for backoff policies
-| Value | -Description | -
|---|---|
"exponential" |
-Exponential backoff policy - |
-
"linear" |
-Linear backoff policy - |
-
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
-| Field | -Description | -||||
|---|---|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -ChannelableSpec - - - |
-
- Spec is the part where the Channelable fulfills the Subscribable contract. -- -
|
-||||
-status- - -ChannelableStatus - - - |
-- | -
-(Appears on:Channelable, ChannelSpec, InMemoryChannelSpec) -
-ChannelableSpec contains Spec of the Channelable object
-| Field | -Description | -
|---|---|
-SubscribableSpec- - -SubscribableSpec - - - |
-
-
-(Members of |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- DeliverySpec contains the default delivery spec for each subscription -to this Channelable. Each subscription delivery spec, if any, overrides this -global delivery spec. - |
-
-(Appears on:Channelable, ChannelStatus, InMemoryChannelStatus) -
-ChannelableStatus contains the Status of a Channelable object.
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-AddressStatus- - -knative.dev/pkg/apis/duck/v1.AddressStatus - - - |
-
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. - |
-
-SubscribableStatus- - -SubscribableStatus - - - |
-
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. - |
-
-deadLetterChannel- - -knative.dev/pkg/apis/duck/v1.KReference - - - |
-
-(Optional)
- DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel -Failed messages are delivered here. - |
-
-(Appears on:ChannelableSpec, SubscriberSpec, BrokerSpec, TriggerSpec, ParallelBranch, SequenceStep, SubscriptionSpec) -
-DeliverySpec contains the delivery options for event senders, -such as channelable and source.
-| Field | -Description | -
|---|---|
-deadLetterSink- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- DeadLetterSink is the sink receiving event that could not be sent to -a destination. - |
-
-retry- -int32 - - |
-
-(Optional)
- Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink. - |
-
-backoffPolicy- - -BackoffPolicyType - - - |
-
-(Optional)
- BackoffPolicy is the retry backoff policy (linear, exponential). - |
-
-backoffDelay- -string - - |
-
-(Optional)
- BackoffDelay is the delay before retrying. -More information on Duration format: -- https://www.iso.org/iso-8601-date-and-time-format.html -- https://en.wikipedia.org/wiki/ISO_8601 -For linear policy, backoff delay is backoffDelay* |
-
DeliveryStatus contains the Status of an object supporting delivery options.
-| Field | -Description | -
|---|---|
-deadLetterChannel- - -knative.dev/pkg/apis/duck/v1.KReference - - - |
-
-(Optional)
- DeadLetterChannel is a KReference that is the reference to the native, platform specific channel -where failed events are sent to. - |
-
Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
-| Field | -Description | -||
|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec- - -SubscribableSpec - - - |
-
- SubscribableSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. -- -
|
-||
-status- - -SubscribableStatus - - - |
-
- SubscribableStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. - |
-
-(Appears on:ChannelableSpec, Subscribable) -
-SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
-| Field | -Description | -
|---|---|
-subscribers- - -[]SubscriberSpec - - - |
-
- This is the list of subscriptions for this subscribable. - |
-
-(Appears on:ChannelableStatus, Subscribable) -
-SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
-| Field | -Description | -
|---|---|
-subscribers- - -[]SubscriberStatus - - - |
-
- This is the list of subscription’s statuses for this channel. - |
-
-(Appears on:SubscribableSpec) -
-SubscriberSpec defines a single subscriber to a Subscribable.
-At least one of SubscriberURI and ReplyURI must be present
-| Field | -Description | -
|---|---|
-uid- -k8s.io/apimachinery/pkg/types.UID - - |
-
-(Optional)
- UID is used to understand the origin of the subscriber. - |
-
-generation- -int64 - - |
-
-(Optional)
- Generation of the origin of the subscriber with uid:UID. - |
-
-subscriberUri- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- SubscriberURI is the endpoint for the subscriber - |
-
-replyUri- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- ReplyURI is the endpoint for the reply - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- DeliverySpec contains options controlling the event delivery - |
-
-(Appears on:SubscribableStatus) -
-SubscriberStatus defines the status of a single subscriber to a Channel.
-| Field | -Description | -
|---|---|
-uid- -k8s.io/apimachinery/pkg/types.UID - - |
-
-(Optional)
- UID is used to understand the origin of the subscriber. - |
-
-observedGeneration- -int64 - - |
-
-(Optional)
- Generation of the origin of the subscriber with uid:UID. - |
-
-ready- - -Kubernetes core/v1.ConditionStatus - - - |
-
- Status of the subscriber. - |
-
-message- -string - - |
-
-(Optional)
- A human readable message indicating details of Ready status. - |
-
Package v1beta1 is the v1beta1 version of the API.
-string alias)-(Appears on:DeliverySpec) -
-BackoffPolicyType is the type for backoff policies
-| Value | -Description | -
|---|---|
"exponential" |
-Exponential backoff policy - |
-
"linear" |
-Linear backoff policy - |
-
Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.
-| Field | -Description | -||||
|---|---|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -ChannelableSpec - - - |
-
- Spec is the part where the Channelable fulfills the Subscribable contract. -- -
|
-||||
-status- - -ChannelableStatus - - - |
-- | -
-(Appears on:Channelable) -
-ChannelableSpec contains Spec of the Channelable object
-| Field | -Description | -
|---|---|
-SubscribableSpec- - -SubscribableSpec - - - |
-
-
-(Members of |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- DeliverySpec contains options controlling the event delivery - |
-
-(Appears on:Channelable) -
-ChannelableStatus contains the Status of a Channelable object.
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-AddressStatus- - -knative.dev/pkg/apis/duck/v1.AddressStatus - - - |
-
-
-(Members of AddressStatus is the part where the Channelable fulfills the Addressable contract. - |
-
-SubscribableStatus- - -SubscribableStatus - - - |
-
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. - |
-
-deadLetterChannel- - -knative.dev/pkg/apis/duck/v1.KReference - - - |
-
-(Optional)
- DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel -Failed messages are delivered here. - |
-
-(Appears on:ChannelableSpec, SubscriberSpec) -
-DeliverySpec contains the delivery options for event senders, -such as channelable and source.
-| Field | -Description | -
|---|---|
-deadLetterSink- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- DeadLetterSink is the sink receiving event that could not be sent to -a destination. - |
-
-retry- -int32 - - |
-
-(Optional)
- Retry is the minimum number of retries the sender should attempt when -sending an event before moving it to the dead letter sink. - |
-
-backoffPolicy- - -BackoffPolicyType - - - |
-
-(Optional)
- BackoffPolicy is the retry backoff policy (linear, exponential). - |
-
-backoffDelay- -string - - |
-
-(Optional)
- BackoffDelay is the delay before retrying. -More information on Duration format: -- https://www.iso.org/iso-8601-date-and-time-format.html -- https://en.wikipedia.org/wiki/ISO_8601 -For linear policy, backoff delay is backoffDelay* |
-
DeliveryStatus contains the Status of an object supporting delivery options.
-| Field | -Description | -
|---|---|
-deadLetterChannel- - -knative.dev/pkg/apis/duck/v1.KReference - - - |
-
-(Optional)
- DeadLetterChannel is a KReference that is the reference to the native, platform specific channel -where failed events are sent to. - |
-
Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.
-| Field | -Description | -||
|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec- - -SubscribableSpec - - - |
-
- SubscribableSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract. -- -
|
-||
-status- - -SubscribableStatus - - - |
-
- SubscribableStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. - |
-
-(Appears on:ChannelableSpec, Subscribable) -
-SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.
-| Field | -Description | -
|---|---|
-subscribers- - -[]SubscriberSpec - - - |
-
- This is the list of subscriptions for this subscribable. - |
-
-(Appears on:ChannelableStatus, Subscribable) -
-SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
-| Field | -Description | -
|---|---|
-subscribers- - -[]SubscriberStatus - - - |
-
- This is the list of subscription’s statuses for this channel. - |
-
-(Appears on:SubscribableSpec) -
-SubscriberSpec defines a single subscriber to a Subscribable.
-At least one of SubscriberURI and ReplyURI must be present
-| Field | -Description | -
|---|---|
-uid- -k8s.io/apimachinery/pkg/types.UID - - |
-
-(Optional)
- UID is used to understand the origin of the subscriber. - |
-
-generation- -int64 - - |
-
-(Optional)
- Generation of the origin of the subscriber with uid:UID. - |
-
-subscriberUri- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- SubscriberURI is the endpoint for the subscriber - |
-
-replyUri- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- ReplyURI is the endpoint for the reply - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- DeliverySpec contains options controlling the event delivery - |
-
-(Appears on:SubscribableStatus) -
-SubscriberStatus defines the status of a single subscriber to a Channel.
-| Field | -Description | -
|---|---|
-uid- -k8s.io/apimachinery/pkg/types.UID - - |
-
-(Optional)
- UID is used to understand the origin of the subscriber. - |
-
-observedGeneration- -int64 - - |
-
-(Optional)
- Generation of the origin of the subscriber with uid:UID. - |
-
-ready- - -Kubernetes core/v1.ConditionStatus - - - |
-
- Status of the subscriber. - |
-
-message- -string - - |
-
-(Optional)
- A human readable message indicating details of Ready status. - |
-
Package v1 is the v1 version of the API.
-Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Subscribers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.
-| 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 contains the delivery spec for each trigger -to this Broker. Each trigger delivery spec, if any, overrides this -global delivery spec. - |
-
-(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 - - - |
-
-(Optional)
- 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. - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery contains the delivery spec for this specific trigger. - |
-
-(Appears on:Trigger) -
-TriggerStatus represents the current state of a Trigger.
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the 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 - - - |
-
-(Optional)
- SubscriberURI is the resolved URI of the receiver for this Trigger. - |
-
Package v1beta1 is the v1beta1 version of the API.
-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 - |
-
-(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. - |
-
Package v1 is the v1 version of the API.
-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. - |
-
-address- - -knative.dev/pkg/apis/duck/v1.Addressable - - - |
-
-(Optional)
- Address is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-(Appears on:SequenceSpec) -
-| Field | -Description | -
|---|---|
-Destination- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-
-(Members of Subscriber receiving the step event - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. - |
-
-(Appears on:SequenceStatus) -
-| Field | -Description | -
|---|---|
-subscription- - -Kubernetes core/v1.ObjectReference - - - |
-
- Subscription is the reference to the underlying Subscription. - |
-
-ready- -knative.dev/pkg/apis.Condition - - |
-
- ReadyCondition indicates whether the Subscription is ready or not. - |
-
Package v1 is the v1 version of the API.
-Channel represents a generic Channel. It is normally used when we want a -Channel, but do not 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 - - - |
-
-(Optional)
- ChannelTemplate specifies which Channel CRD to use to create the CRD -Channel backing this Channel. This is immutable after creation. -Normally this is set by the Channel defaulter, not directly by the user. - |
-
-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 - - - |
-
-(Optional)
- Channel is an KReference to the Channel CRD backing this Channel. - |
-
-(Appears on:ParallelSpec, SequenceSpec, ChannelSpec) -
-| Field | -Description | -
|---|---|
-spec- -k8s.io/apimachinery/pkg/runtime.RawExtension - - |
-
-(Optional)
- Spec defines the Spec to use for each channel created. Passed -in verbatim to the Channel CRD as Spec section. -- - |
-
-(Appears on:InMemoryChannel) -
-InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
-| Field | -Description | -
|---|---|
-ChannelableSpec- - -ChannelableSpec - - - |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on:InMemoryChannel) -
-ChannelStatus represents the current state of a Channel.
-| Field | -Description | -
|---|---|
-ChannelableStatus- - -ChannelableStatus - - - |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on:Subscription) -
-SubscriptionSpec specifies the Channel for incoming events, a Subscriber target -for processing those events and where to put the result of the processing. Only -From (where the events are coming from) is always required. You can optionally -only Process the events (results in no output events) by leaving out the Result. -You can also perform an identity transformation on the incoming events by leaving -out the Subscriber and only specifying Result.
-The following are all valid specifications: -channel –[subscriber]–> reply -Sink, no outgoing events: -channel – subscriber -no-op function (identity transformation): -channel –> reply
-| Field | -Description | -
|---|---|
-channel- - -Kubernetes core/v1.ObjectReference - - - |
-
- Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the -contract to the ChannelableSpec duck type. If the resource does not -meet this contract it will be reflected in the Subscription’s status. -This field is immutable. We have no good answer on what happens to -the events that are currently in the channel being consumed from -and what the semantics there should be. For now, you can always -delete the Subscription and recreate it to point to a different -channel, giving the user more control over what semantics should -be used (drain the channel first, possibly have events dropped, -etc.) - |
-
-subscriber- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a Destination as specified by the Reply. - |
-
-reply- - -knative.dev/pkg/apis/duck/v1.Destination - - - |
-
-(Optional)
- Reply specifies (optionally) how to handle events returned from -the Subscriber target. - |
-
-delivery- - -DeliverySpec - - - |
-
-(Optional)
- Delivery configuration - |
-
-(Appears on:Subscription) -
-SubscriptionStatus (computed) for a subscription
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of inherits duck/v1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-physicalSubscription- - -SubscriptionStatusPhysicalSubscription - - - |
-
- PhysicalSubscription is the fully resolved values that this Subscription represents. - |
-
-(Appears on:SubscriptionStatus) -
-SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
-| Field | -Description | -
|---|---|
-subscriberUri- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- SubscriberURI is the fully resolved URI for spec.subscriber. - |
-
-replyUri- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- ReplyURI is the fully resolved URI for the spec.reply. - |
-
-deadLetterSinkUri- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink. - |
-
Package v1 contains API Schema definitions for the sources v1 API group.
-ApiServerSource is the Schema for the apiserversources API
-| Field | -Description | -||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion-string |
-
-
-sources.knative.dev/v1
-
- |
-||||||||||
-kind-string - |
-ApiServerSource |
-||||||||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||
-spec- - -ApiServerSourceSpec - - - |
-
- - -
|
-||||||||||
-status- - -ApiServerSourceStatus - - - |
-- | -
ContainerSource is the Schema for the containersources API
-| Field | -Description | -||||
|---|---|---|---|---|---|
-apiVersion-string |
-
-
-sources.knative.dev/v1
-
- |
-||||
-kind-string - |
-ContainerSource |
-||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -ContainerSourceSpec - - - |
-
- - -
|
-||||
-status- - -ContainerSourceStatus - - - |
-- | -
PingSource is the Schema for the PingSources API.
-| Field | -Description | -||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion-string |
-
-
-sources.knative.dev/v1
-
- |
-||||||||||||
-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/v1
-
- |
-||||
-kind-string - |
-SinkBinding |
-||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -SinkBindingSpec - - - |
-
- - -
|
-||||
-status- - -SinkBindingStatus - - - |
-- | -
-(Appears on:ApiServerSourceSpec) -
-APIVersionKind is an APIVersion and Kind tuple.
-| Field | -Description | -
|---|---|
-apiVersion- -string - - |
-
- APIVersion - the API version of the resource to watch. - |
-
-kind- -string - - |
-
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - |
-
-(Appears on:ApiServerSourceSpec) -
-APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
-| Field | -Description | -
|---|---|
-apiVersion- -string - - |
-
- APIVersion - the API version of the resource to watch. - |
-
-kind- -string - - |
-
- Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - |
-
-selector- - -Kubernetes meta/v1.LabelSelector - - - |
-
-(Optional)
- LabelSelector filters this source to objects to those resources pass the -label selector. -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors - |
-
-(Appears on:ApiServerSource) -
-ApiServerSourceSpec defines the desired state of ApiServerSource
-| Field | -Description | -
|---|---|
-SourceSpec- - -knative.dev/pkg/apis/duck/v1.SourceSpec - - - |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-resources- - -[]APIVersionKindSelector - - - |
-
- Resource are the resources this source will track and send related -lifecycle events from the Kubernetes ApiServer, with an optional label -selector to help filter. - |
-
-owner- - -APIVersionKind - - - |
-
-(Optional)
- ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter. - |
-
-mode- -string - - |
-
-(Optional)
- EventMode controls the format of the event.
- |
-
-serviceAccountName- -string - - |
-
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set. - |
-
-(Appears on:ApiServerSource) -
-ApiServerSourceStatus defines the observed state of ApiServerSource
-| Field | -Description | -
|---|---|
-SourceStatus- - -knative.dev/pkg/apis/duck/v1.SourceStatus - - - |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-(Appears on:ContainerSource) -
-ContainerSourceSpec defines the desired state of ContainerSource
-| Field | -Description | -
|---|---|
-SourceSpec- - -knative.dev/pkg/apis/duck/v1.SourceSpec - - - |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-template- - -Kubernetes core/v1.PodTemplateSpec - - - |
-
- Template describes the pods that will be created - |
-
-(Appears on:ContainerSource) -
-ContainerSourceStatus defines the observed state of ContainerSource
-| Field | -Description | -
|---|---|
-SourceStatus- - -knative.dev/pkg/apis/duck/v1.SourceStatus - - - |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
-(Appears on: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 the base64-encoded string of the actual event’s body 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. - |
-
-(Appears on:SinkBinding) -
-SinkBindingSpec holds the desired state of the SinkBinding (from the client).
-| Field | -Description | -
|---|---|
-SourceSpec- - -knative.dev/pkg/apis/duck/v1.SourceSpec - - - |
-
-
-(Members of inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink. - |
-
-BindingSpec- - -knative.dev/pkg/apis/duck/v1.BindingSpec - - - |
-
-
-(Members of inherits duck/v1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations. - |
-
-(Appears on:SinkBinding) -
-SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
-| Field | -Description | -
|---|---|
-SourceStatus- - -knative.dev/pkg/apis/duck/v1.SourceStatus - - - |
-
-
-(Members of inherits duck/v1 SourceStatus, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last -processed by the controller. -* Conditions - the latest available observations of a resource’s current -state. -* SinkURI - the current active sink URI that has been configured for the -Source. - |
-
Package v1beta2 contains API Schema definitions for the sources v1beta2 API group.
-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 the base64-encoded string of the actual event’s body 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 200e54c6c.
-
Packages:
-Package v1alpha1 contains the Autoscaling v1alpha1 API types.
-PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative -components instantiate autoscalers. This definition is an abstraction that may be backed -by multiple definitions. For more information, see the Knative Pluggability presentation: -https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit
-| Field | -Description | -||||||||
|---|---|---|---|---|---|---|---|---|---|
-apiVersion-string |
-
-
-autoscaling.internal.knative.dev/v1alpha1
-
- |
-||||||||
-kind-string - |
-PodAutoscaler |
-||||||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||
-spec- - -PodAutoscalerSpec - - - |
-
-(Optional)
- Spec holds the desired state of the PodAutoscaler (from the client). -- -
|
-||||||||
-status- - -PodAutoscalerStatus - - - |
-
-(Optional)
- Status communicates the observed state of the PodAutoscaler (from the controller). - |
-
Metric represents a resource to configure the metric collector with.
-| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec- - -MetricSpec - - - |
-
-(Optional)
- Spec holds the desired state of the Metric (from the client). -- -
|
-||||||
-status- - -MetricStatus - - - |
-
-(Optional)
- Status communicates the observed state of the Metric (from the controller). - |
-
-(Appears on:Metric) -
-MetricSpec contains all values a metric collector needs to operate.
-| Field | -Description | -
|---|---|
-stableWindow- - -time.Duration - - - |
-
- StableWindow is the aggregation window for metrics in a stable state. - |
-
-panicWindow- - -time.Duration - - - |
-
- PanicWindow is the aggregation window for metrics where quick reactions are needed. - |
-
-scrapeTarget- -string - - |
-
- ScrapeTarget is the K8s service that publishes the metric endpoint. - |
-
-(Appears on:Metric) -
-MetricStatus reflects the status of metric collection for this specific entity.
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of |
-
-(Appears on:PodAutoscaler) -
-PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).
-| Field | -Description | -
|---|---|
-containerConcurrency- -int64 - - |
-
-(Optional)
- ContainerConcurrency specifies the maximum allowed
-in-flight (concurrent) requests per container of the Revision.
-Defaults to |
-
-scaleTargetRef- - -Kubernetes core/v1.ObjectReference - - - |
-
- ScaleTargetRef defines the /scale-able resource that this PodAutoscaler -is responsible for quickly right-sizing. - |
-
-reachability- - -ReachabilityType - - - |
-
-(Optional)
- Reachability specifies whether or not the |
-
-protocolType- - -knative.dev/networking/pkg/apis/networking.ProtocolType - - - |
-
- The application-layer protocol. Matches |
-
-(Appears on:PodAutoscaler) -
-PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of |
-
-serviceName- -string - - |
-
- ServiceName is the K8s Service name that serves the revision, scaled by this PA. -The service is created and owned by the ServerlessService object owned by this PA. - |
-
-metricsServiceName- -string - - |
-
- MetricsServiceName is the K8s Service name that provides revision metrics. -The service is managed by the PA object. - |
-
-desiredScale- -int32 - - |
-
- DesiredScale shows the current desired number of replicas for the revision. - |
-
-actualScale- -int32 - - |
-
- ActualScale shows the actual number of replicas for the revision. - |
-
PodScalable is a duck type that the resources referenced by the
-PodAutoscaler’s ScaleTargetRef must implement. They must also
-implement the /scale sub-resource for use with /scale based
-implementations (e.g. HPA), but this further constrains the shape
-the referenced resources may take.
| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec- - -PodScalableSpec - - - |
-
- - -
|
-||||||
-status- - -PodScalableStatus - - - |
-- | -
-(Appears on:PodScalable) -
-PodScalableSpec is the specification for the desired state of a -PodScalable (or at least our shared portion).
-| Field | -Description | -
|---|---|
-replicas- -int32 - - |
-- | -
-selector- - -Kubernetes meta/v1.LabelSelector - - - |
-- | -
-template- - -Kubernetes core/v1.PodTemplateSpec - - - |
-- | -
-(Appears on:PodScalable) -
-PodScalableStatus is the observed state of a PodScalable (or at -least our shared portion).
-| Field | -Description | -
|---|---|
-replicas- -int32 - - |
-- | -
string alias)-(Appears on:PodAutoscalerSpec) -
-ReachabilityType is the enumeration type for the different states of reachability
-to the ScaleTarget of a PodAutoscaler
| Value | -Description | -
|---|---|
"Reachable" |
-ReachabilityReachable means the |
-
"" |
-ReachabilityUnknown means the reachability of the |
-
"Unreachable" |
-ReachabilityUnreachable means the |
-
Package v1 contains the Serving v1 API types.
-Configuration represents the “floating HEAD” of a linear history of Revisions. -Users create new Revisions by updating the Configuration’s spec. -The “latest created” revision’s name is available under status, as is the -“latest ready” revision’s name. -See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration
-| Field | -Description | -||
|---|---|---|---|
-apiVersion-string |
-
-
-serving.knative.dev/v1
-
- |
-||
-kind-string - |
-Configuration |
-||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec- - -ConfigurationSpec - - - |
-
-(Optional)
- - -
|
-||
-status- - -ConfigurationStatus - - - |
--(Optional) - | -
Revision is an immutable snapshot of code and configuration. A revision -references a container image. Revisions are created by updates to a -Configuration.
-See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#revision
-| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-apiVersion-string |
-
-
-serving.knative.dev/v1
-
- |
-||||||
-kind-string - |
-Revision |
-||||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec- - -RevisionSpec - - - |
-
-(Optional)
- - -
|
-||||||
-status- - -RevisionStatus - - - |
--(Optional) - | -
Route is responsible for configuring ingress over a collection of Revisions. -Some of the Revisions a Route distributes traffic over may be specified by -referencing the Configuration responsible for creating them; in these cases -the Route is additionally responsible for monitoring the Configuration for -“latest ready revision” changes, and smoothly rolling out latest revisions. -See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#route
-| Field | -Description | -||
|---|---|---|---|
-apiVersion-string |
-
-
-serving.knative.dev/v1
-
- |
-||
-kind-string - |
-Route |
-||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec- - -RouteSpec - - - |
-
-(Optional)
- Spec holds the desired state of the Route (from the client). -- -
|
-||
-status- - -RouteStatus - - - |
-
-(Optional)
- Status communicates the observed state of the Route (from the controller). - |
-
Service acts as a top-level container that manages a Route and Configuration -which implement a network service. Service exists to provide a singular -abstraction which can be access controlled, reasoned about, and which -encapsulates software lifecycle decisions such as rollout policy and -team resource ownership. Service acts only as an orchestrator of the -underlying Routes and Configurations (much as a kubernetes Deployment -orchestrates ReplicaSets), and its usage is optional but recommended.
-The Service’s controller will track the statuses of its owned Configuration -and Route, reflecting their statuses and conditions as its own.
-See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#service
-| Field | -Description | -||||
|---|---|---|---|---|---|
-apiVersion-string |
-
-
-serving.knative.dev/v1
-
- |
-||||
-kind-string - |
-Service |
-||||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec- - -ServiceSpec - - - |
-
-(Optional)
- - -
|
-||||
-status- - -ServiceStatus - - - |
--(Optional) - | -
-(Appears on:Configuration, ServiceSpec) -
-ConfigurationSpec holds the desired state of the Configuration (from the client).
-| Field | -Description | -
|---|---|
-template- - -RevisionTemplateSpec - - - |
-
-(Optional)
- Template holds the latest specification for the Revision to be stamped out. - |
-
-(Appears on:Configuration) -
-ConfigurationStatus communicates the observed state of the Configuration (from the controller).
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of |
-
-ConfigurationStatusFields- - -ConfigurationStatusFields - - - |
-
-
-(Members of |
-
-(Appears on:ConfigurationStatus, ServiceStatus) -
-ConfigurationStatusFields holds the fields of Configuration’s status that -are not generally shared. This is defined separately and inlined so that -other types can readily consume these fields via duck typing.
-| Field | -Description | -
|---|---|
-latestReadyRevisionName- -string - - |
-
-(Optional)
- LatestReadyRevisionName holds the name of the latest Revision stamped out -from this Configuration that has had its “Ready” condition become “True”. - |
-
-latestCreatedRevisionName- -string - - |
-
-(Optional)
- LatestCreatedRevisionName is the last revision that was created from this -Configuration. It might not be ready yet, for that use LatestReadyRevisionName. - |
-
-(Appears on:RevisionStatus) -
-ContainerStatus holds the information of container name and image digest value
-| Field | -Description | -
|---|---|
-name- -string - - |
-- | -
-imageDigest- -string - - |
-- | -
-(Appears on:Revision, RevisionTemplateSpec) -
-RevisionSpec holds the desired state of the Revision (from the client).
-| Field | -Description | -
|---|---|
-PodSpec- - -Kubernetes core/v1.PodSpec - - - |
-
-
-(Members of |
-
-containerConcurrency- -int64 - - |
-
-(Optional)
- ContainerConcurrency specifies the maximum allowed in-flight (concurrent)
-requests per container of the Revision. Defaults to |
-
-timeoutSeconds- -int64 - - |
-
-(Optional)
- TimeoutSeconds is the maximum duration in seconds that the request routing -layer will wait for a request delivered to a container to begin replying -(send network traffic). If unspecified, a system default will be provided. - |
-
-(Appears on:Revision) -
-RevisionStatus communicates the observed state of the Revision (from the controller).
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of |
-
-serviceName- -string - - |
-
-(Optional)
- ServiceName holds the name of a core Kubernetes Service resource that -load balances over the pods backing this Revision. -Deprecated: revision service name is effectively equal to the revision name, -as per #10540. -0.23 — stop populating -0.25 — remove. - |
-
-logUrl- -string - - |
-
-(Optional)
- LogURL specifies the generated logging url for this particular revision -based on the revision url template specified in the controller’s config. - |
-
-imageDigest- -string - - |
-
-(Optional)
- DeprecatedImageDigest holds the resolved digest for the image specified -within .Spec.Container.Image. The digest is resolved during the creation -of Revision. This field holds the digest value regardless of whether -a tag or digest was originally specified in the Container object. It -may be empty if the image comes from a registry listed to skip resolution. -If multiple containers specified then DeprecatedImageDigest holds the digest -for serving container. -DEPRECATED: Use ContainerStatuses instead. -TODO(savitaashture) Remove deprecatedImageDigest. -ref https://kubernetes.io/docs/reference/using-api/deprecation-policy for deprecation. - |
-
-containerStatuses- - -[]ContainerStatus - - - |
-
-(Optional)
- ContainerStatuses is a slice of images present in .Spec.Container[*].Image -to their respective digests and their container name. -The digests are resolved during the creation of Revision. -ContainerStatuses holds the container name and image digests -for both serving and non serving containers. -ref: http://bit.ly/image-digests - |
-
-actualReplicas- -int32 - - |
-
-(Optional)
- ActualReplicas reflects the amount of ready pods running this revision. - |
-
-desiredReplicas- -int32 - - |
-
-(Optional)
- DesiredReplicas reflects the desired amount of pods running this revision. - |
-
-(Appears on:ConfigurationSpec) -
-RevisionTemplateSpec describes the data a revision should have when created from a template. -Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190
-| Field | -Description | -||||||
|---|---|---|---|---|---|---|---|
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec- - -RevisionSpec - - - |
-
-(Optional)
- - -
|
-
-(Appears on:Route, ServiceSpec) -
-RouteSpec holds the desired state of the Route (from the client).
-| Field | -Description | -
|---|---|
-traffic- - -[]TrafficTarget - - - |
-
-(Optional)
- Traffic specifies how to distribute traffic over a collection of -revisions and configurations. - |
-
-(Appears on:Route) -
-RouteStatus communicates the observed state of the Route (from the controller).
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of |
-
-RouteStatusFields- - -RouteStatusFields - - - |
-
-
-(Members of |
-
-(Appears on:RouteStatus, ServiceStatus) -
-RouteStatusFields holds the fields of Route’s status that -are not generally shared. This is defined separately and inlined so that -other types can readily consume these fields via duck typing.
-| Field | -Description | -
|---|---|
-url- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- URL holds the url that will distribute traffic over the provided traffic targets. -It generally has the form http[s]://{route-name}.{route-namespace}.{cluster-level-suffix} - |
-
-address- - -knative.dev/pkg/apis/duck/v1.Addressable - - - |
-
-(Optional)
- Address holds the information needed for a Route to be the target of an event. - |
-
-traffic- - -[]TrafficTarget - - - |
-
-(Optional)
- Traffic holds the configured traffic distribution. -These entries will always contain RevisionName references. -When ConfigurationName appears in the spec, this will hold the -LatestReadyRevisionName that we last observed. - |
-
string alias)RoutingState represents states of a revision with regards to serving a route.
-| Value | -Description | -
|---|---|
"active" |
-RoutingStateActive is a state for a revision which is 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. - |
-
-(Appears on:Service) -
-ServiceSpec represents the configuration for the Service object. -A Service’s specification is the union of the specifications for a Route -and Configuration. The Service restricts what can be expressed in these -fields, e.g. the Route must reference the provided Configuration; -however, these limitations also enable friendlier defaulting, -e.g. Route never needs a Configuration name, and may be defaulted to -the appropriate “run latest” spec.
-| Field | -Description | -
|---|---|
-ConfigurationSpec- - -ConfigurationSpec - - - |
-
-
-(Members of ServiceSpec inlines an unrestricted ConfigurationSpec. - |
-
-RouteSpec- - -RouteSpec - - - |
-
-
-(Members of ServiceSpec inlines RouteSpec and restricts/defaults its fields -via webhook. In particular, this spec can only reference this -Service’s configuration and revisions (which also influences -defaults). - |
-
-(Appears on:Service) -
-ServiceStatus represents the Status stanza of the Service resource.
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of |
-
-ConfigurationStatusFields- - -ConfigurationStatusFields - - - |
-
-
-(Members of In addition to inlining ConfigurationSpec, we also inline the fields -specific to ConfigurationStatus. - |
-
-RouteStatusFields- - -RouteStatusFields - - - |
-
-
-(Members of In addition to inlining RouteSpec, we also inline the fields -specific to RouteStatus. - |
-
-(Appears on:RouteSpec, RouteStatusFields) -
-TrafficTarget holds a single entry of the routing table for a Route.
-| Field | -Description | -
|---|---|
-tag- -string - - |
-
-(Optional)
- Tag is optionally used to expose a dedicated url for referencing -this target exclusively. - |
-
-revisionName- -string - - |
-
-(Optional)
- RevisionName of a specific revision to which to send this portion of -traffic. This is mutually exclusive with ConfigurationName. - |
-
-configurationName- -string - - |
-
-(Optional)
- ConfigurationName of a configuration to whose latest revision we will send -this portion of traffic. When the “status.latestReadyRevisionName” of the -referenced configuration changes, we will automatically migrate traffic -from the prior “latest ready” revision to the new one. This field is never -set in Route’s status, only its spec. This is mutually exclusive with -RevisionName. - |
-
-latestRevision- -bool - - |
-
-(Optional)
- LatestRevision may be optionally provided to indicate that the latest -ready Revision of the Configuration should be used for this traffic -target. When provided LatestRevision must be true if RevisionName is -empty; it must be false when RevisionName is non-empty. - |
-
-percent- -int64 - - |
-
-(Optional)
- Percent indicates that percentage based routing should be used and
-the value indicates the percent of traffic that is be routed to this
-Revision or Configuration. |
-
-url- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- URL displays the URL for accessing named traffic targets. URL is displayed in -status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and -a hostname, but may not contain anything else (e.g. basic auth, url path, etc.) - |
-
Package v1alpha1 contains the v1alpha1 versions of the serving apis. -Api versions allow the api contract for a resource to be changed while keeping -backward compatibility by support multiple concurrent versions -of the same resource
-DomainMapping is a mapping from a custom hostname to an Addressable.
-| Field | -Description | -||
|---|---|---|---|
-apiVersion-string |
-
-
-serving.knative.dev/v1alpha1
-
- |
-||
-kind-string - |
-DomainMapping |
-||
-metadata- - -Kubernetes meta/v1.ObjectMeta - - - |
-
-(Optional)
- Standard object’s metadata. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata -Refer to the Kubernetes API documentation for the fields of the -metadata field.
- |
-||
-spec- - -DomainMappingSpec - - - |
-
-(Optional)
- Spec is the desired state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- -
|
-||
-status- - -DomainMappingStatus - - - |
-
-(Optional)
- Status is the current state of the DomainMapping. -More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - |
-
CannotConvertError is returned when a field cannot be converted.
-| Field | -Description | -
|---|---|
-Message- -string - - |
-- | -
-Field- -string - - |
-- | -
-(Appears on:DomainMapping) -
-DomainMappingSpec describes the DomainMapping the user wishes to exist.
-| Field | -Description | -
|---|---|
-ref- - -knative.dev/pkg/apis/duck/v1.KReference - - - |
-
- Ref specifies the target of the Domain Mapping. -The object identified by the Ref must be an Addressable with a URL of the
-form This contract is satisfied by Knative types such as Knative Services and -Knative Routes, and by Kubernetes Services. - |
-
-(Appears on:DomainMapping) -
-DomainMappingStatus describes the current state of the DomainMapping.
-| Field | -Description | -
|---|---|
-Status- - -knative.dev/pkg/apis/duck/v1.Status - - - |
-
-
-(Members of |
-
-url- - -knative.dev/pkg/apis.URL - - - |
-
-(Optional)
- URL is the URL of this DomainMapping. - |
-
-address- - -knative.dev/pkg/apis/duck/v1.Addressable - - - |
-
-(Optional)
- Address holds the information needed for a DomainMapping to be the target of an event. - |
-
-Generated with gen-crd-api-reference-docs
-on git commit 35efb3108.
-