Eventing

    Package v1 is the v1 version of the API.

    Resource Types:

    (Appears on:DeliverySpec)

    BackoffPolicyType is the type for backoff policies

    Channelable

    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.

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec

    Spec is the part where the Channelable fulfills the Subscribable contract.



    SubscribableSpec
    SubscribableSpec

    (Members of SubscribableSpec are embedded into this type.)

    delivery
    (Optional)

    DeliverySpec contains the default delivery spec for each subscription to this Channelable. Each subscription delivery spec, if any, overrides this global delivery spec.

    status
    ChannelableStatus

    ChannelableSpec

    (Appears on:Channelable, , InMemoryChannelSpec)

    ChannelableSpec contains Spec of the Channelable object

    FieldDescription
    SubscribableSpec

    (Members of SubscribableSpec are embedded into this type.)

    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.

    ChannelableStatus

    (Appears on:Channelable, , InMemoryChannelStatus)

    ChannelableStatus contains the Status of a Channelable object.

    FieldDescription
    Status

    (Members of Status are embedded into this type.)

    inherits duck/v1 Status, which currently provides: ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. Conditions - the latest available observations of a resource’s current state.

    AddressStatus
    knative.dev/pkg/apis/duck/v1.AddressStatus

    (Members of AddressStatus are embedded into this type.)

    (Optional)

    AddressStatus is the part where the Channelable fulfills the Addressable contract.

    SubscribableStatus

    (Members of SubscribableStatus are embedded into this type.)

    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.

    DeliverySpec

    (Appears on:ChannelableSpec, , BrokerSpec, , ParallelBranch, , SubscriptionSpec)

    DeliverySpec contains the delivery options for event senders, such as channelable and source.

    FieldDescription
    deadLetterSink
    (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.

    timeout
    string
    (Optional)

    Timeout is the timeout of each single request. The value must be greater than 0. More information on Duration format: - https://www.iso.org/iso-8601-date-and-time-format.html -

    Note: This API is EXPERIMENTAL and might break anytime. For more details: https://github.com/knative/eventing/issues/5148

    backoffPolicy
    (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 -

    For linear policy, backoff delay is backoffDelay. For exponential policy, backoff delay is backoffDelay2^.

    DeliveryStatus

    DeliveryStatus contains the Status of an object supporting delivery options.

    FieldDescription
    deadLetterChannel
    (Optional)

    DeadLetterChannel is a KReference that is the reference to the native, platform specific channel where failed events are sent to.

    Subscribable

    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.

    FieldDescription
    metadata
    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.



    subscribers

    This is the list of subscriptions for this subscribable.

    status
    SubscribableStatus

    SubscribableStatus is the part where SubscribableStatus object is configured as to be compatible with Subscribable contract.

    SubscribableSpec

    (Appears on:ChannelableSpec, )

    SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.

    FieldDescription
    subscribers
    []SubscriberSpec

    This is the list of subscriptions for this subscribable.

    SubscribableStatus

    (Appears on:ChannelableStatus, )

    SubscribableStatus is the schema for the subscribable’s status portion of the status section of the resource.

    FieldDescription
    subscribers
    []SubscriberStatus

    This is the list of subscription’s statuses for this channel.

    SubscriberSpec

    (Appears on:SubscribableSpec)

    SubscriberSpec defines a single subscriber to a Subscribable.

    At least one of SubscriberURI and ReplyURI must be present

    FieldDescription
    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
    (Optional)

    ReplyURI is the endpoint for the reply

    delivery
    DeliverySpec
    (Optional)

    DeliverySpec contains options controlling the event delivery

    SubscriberStatus

    (Appears on:SubscribableStatus)

    SubscriberStatus defines the status of a single subscriber to a Channel.

    FieldDescription
    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.


    duck.knative.dev/v1beta1

    Package v1beta1 is the v1beta1 version of the API.

    Resource Types:

    BackoffPolicyType (string alias)

    (Appears on:)

    BackoffPolicyType is the type for backoff policies

    ValueDescription

    “exponential”

    Exponential backoff policy

    “linear”

    Linear backoff policy

    Channelable

    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.

    FieldDescription
    metadata
    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.



    SubscribableSpec

    (Members of SubscribableSpec are embedded into this type.)

    delivery
    DeliverySpec
    (Optional)

    DeliverySpec contains options controlling the event delivery

    status

    ChannelableSpec

    (Appears on:)

    ChannelableSpec contains Spec of the Channelable object

    FieldDescription
    SubscribableSpec
    SubscribableSpec

    (Members of SubscribableSpec are embedded into this type.)

    delivery
    (Optional)

    DeliverySpec contains options controlling the event delivery

    ChannelableStatus

    (Appears on:)

    ChannelableStatus contains the Status of a Channelable object.

    FieldDescription
    Status
    knative.dev/pkg/apis/duck/v1.Status

    (Members of Status are embedded into this type.)

    inherits duck/v1 Status, which currently provides: ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. Conditions - the latest available observations of a resource’s current state.

    AddressStatus

    (Members of AddressStatus are embedded into this type.)

    AddressStatus is the part where the Channelable fulfills the Addressable contract.

    SubscribableStatus
    SubscribableStatus

    (Members of SubscribableStatus are embedded into this type.)

    Subscribers is populated with the statuses of each of the Channelable’s subscribers.

    deadLetterChannel
    (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.

    DeliverySpec

    (Appears on:, SubscriberSpec)

    DeliverySpec contains the delivery options for event senders, such as channelable and source.

    FieldDescription
    deadLetterSink
    (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.

    timeout
    string

    Timeout is the timeout of each single request. More information on Duration format: - https://www.iso.org/iso-8601-date-and-time-format.html -

    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://en.wikipedia.org/wiki/ISO_8601

    For linear policy, backoff delay is backoffDelay. For exponential policy, backoff delay is backoffDelay2^.

    DeliveryStatus

    DeliveryStatus contains the Status of an object supporting delivery options.

    FieldDescription
    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

    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.

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec

    SubscribableSpec is the part where Subscribable object is configured as to be compatible with Subscribable contract.



    subscribers
    []SubscriberSpec

    This is the list of subscriptions for this subscribable.

    status

    SubscribableStatus is the part where SubscribableStatus object is configured as to be compatible with Subscribable contract.

    SubscribableSpec

    (Appears on:, Subscribable)

    SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.

    FieldDescription
    subscribers

    This is the list of subscriptions for this subscribable.

    SubscribableStatus

    (Appears on:, Subscribable)

    SubscribableStatus is the schema for the subscribable’s status portion of the status section of the resource.

    FieldDescription
    subscribers

    This is the list of subscription’s statuses for this channel.

    SubscriberSpec

    (Appears on:)

    SubscriberSpec defines a single subscriber to a Subscribable.

    At least one of SubscriberURI and ReplyURI must be present

    FieldDescription
    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
    (Optional)

    SubscriberURI is the endpoint for the subscriber

    replyUri
    knative.dev/pkg/apis.URL
    (Optional)

    ReplyURI is the endpoint for the reply

    delivery
    (Optional)

    DeliverySpec contains options controlling the event delivery

    SubscriberStatus

    (Appears on:)

    SubscriberStatus defines the status of a single subscriber to a Channel.

    FieldDescription
    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

    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.

    Resource Types:

    Broker

    Broker collects a pool of events that are consumable using Triggers. Brokers provide a well-known endpoint for event delivery that senders can use with minimal knowledge of the event routing strategy. Subscribers use Triggers to request delivery of events from a Broker’s pool to a specific URL or Addressable endpoint.

    FieldDescription
    apiVersion
    string
    eventing.knative.dev/v1
    kind
    string
    Broker
    metadata
    (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    BrokerSpec

    Spec defines the desired state of the Broker.



    config
    (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.

    status
    (Optional)

    Status represents the current state of the Broker. This data may be out of date.

    Trigger

    Trigger represents a request to have events delivered to a subscriber from a Broker’s event pool.

    FieldDescription
    apiVersion
    string
    eventing.knative.dev/v1
    kind
    string
    Trigger
    metadata
    (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    TriggerSpec

    Spec defines the desired state of the Trigger.



    broker
    string

    Broker is the broker that this trigger receives events from.

    filter
    (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
    (Optional)

    Delivery contains the delivery spec for this specific trigger.

    status
    TriggerStatus
    (Optional)

    Status represents the current state of the Trigger. This data may be out of date.

    BrokerSpec

    (Appears on:Broker)

    BrokerStatus represents the current state of a Broker.

    FieldDescription
    Status

    (Members of Status are embedded into this type.)

    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.

    TriggerFilter

    (Appears on:TriggerSpec)

    FieldDescription
    attributes
    (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.

    TriggerFilterAttributes (map[string]string alias)

    (Appears on:)

    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.

    TriggerSpec

    (Appears on:)

    FieldDescription
    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

    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.

    TriggerStatus

    (Appears on:Trigger)

    TriggerStatus represents the current state of a Trigger.

    FieldDescription
    Status

    (Members of Status are embedded into this type.)

    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.

    deadLetterSinkUri
    (Optional)

    DeadLetterSinkURI is the resolved URI of the dead letter sink for this Trigger.


    eventing.knative.dev/v1beta1

    Package v1beta1 is the v1beta1 version of the API.

    Resource Types:

    EventType

    EventType represents a type of event that can be consumed from a Broker.

    FieldDescription
    apiVersion
    string
    eventing.knative.dev/v1beta1

    string
    EventType
    metadata
    (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    EventTypeSpec

    Spec defines the desired state of the EventType.



    type
    string

    Type represents the CloudEvents type. It is authoritative.

    source
    (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 Broker refers to the Broker that can provide the EventType.

    description
    string
    (Optional)

    Description is an optional field used to describe the EventType, in any meaningful way.

    status
    EventTypeStatus
    (Optional)

    Status represents the current state of the EventType. This data may be out of date. TODO might be removed

    EventTypeSpec

    (Appears on:)

    FieldDescription
    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
    (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.

    EventTypeStatus

    (Appears on:EventType)

    EventTypeStatus represents the current state of a EventType.

    FieldDescription
    Status

    (Members of Status are embedded into this type.)

    inherits duck/v1 Status, which currently provides: ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. Conditions - the latest available observations of a resource’s current state.


    Package v1 is the v1 version of the API.

    Resource Types:

    Parallel

    Parallel defines conditional branches that will be wired in series through Channels and Subscriptions.

    FieldDescription
    metadata
    (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ParallelSpec

    Spec defines the desired state of the Parallel.



    branches

    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
    (Optional)

    Reply is a Reference to where the result of a case Subscriber gets sent to when the case does not have a Reply

    status
    ParallelStatus
    (Optional)

    Status represents the current state of the Parallel. This data may be out of date.

    ParallelBranch

    (Appears on:ParallelSpec)

    FieldDescription
    filter
    (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
    (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.

    ParallelBranchStatus

    (Appears on:ParallelStatus)

    ParallelBranchStatus represents the current state of a Parallel branch

    FieldDescription
    filterSubscriptionStatus

    FilterSubscriptionStatus corresponds to the filter subscription status.

    filterChannelStatus
    ParallelChannelStatus

    FilterChannelStatus corresponds to the filter channel status.

    subscriberSubscriptionStatus

    SubscriptionStatus corresponds to the subscriber subscription status.

    ParallelChannelStatus

    (Appears on:, ParallelStatus)

    FieldDescription
    channel

    Channel is the reference to the underlying channel.

    ready
    knative.dev/pkg/apis.Condition

    ReadyCondition indicates whether the Channel is ready or not.

    ParallelSpec

    (Appears on:Parallel)

    FieldDescription
    branches

    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
    (Optional)

    Reply is a Reference to where the result of a case Subscriber gets sent to when the case does not have a Reply

    ParallelStatus

    (Appears on:)

    ParallelStatus represents the current state of a Parallel.

    FieldDescription
    Status
    knative.dev/pkg/apis/duck/v1.Status

    (Members of Status are embedded into this type.)

    inherits duck/v1 Status, which currently provides: ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. Conditions - the latest available observations of a resource’s current state.

    ingressChannelStatus

    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

    (Members of AddressStatus are embedded into this type.)

    AddressStatus is the starting point to this Parallel. Sending to this will target the first subscriber. It generally has the form {channel}.{namespace}.svc.{cluster domain name}

    ParallelSubscriptionStatus

    (Appears on:)

    FieldDescription
    subscription
    Kubernetes core/v1.ObjectReference

    Subscription is the reference to the underlying Subscription.

    ready

    ReadyCondition indicates whether the Subscription is ready or not.

    Sequence

    Sequence defines a sequence of Subscribers that will be wired in series through Channels and Subscriptions.

    FieldDescription
    metadata
    (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    SequenceSpec

    Spec defines the desired state of the Sequence.



    steps

    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
    (Optional)

    Reply is a Reference to where the result of the last Subscriber gets sent to.

    status
    SequenceStatus
    (Optional)

    Status represents the current state of the Sequence. This data may be out of date.

    SequenceChannelStatus

    (Appears on:SequenceStatus)

    FieldDescription
    channel

    Channel is the reference to the underlying channel.

    ready
    knative.dev/pkg/apis.Condition

    ReadyCondition indicates whether the Channel is ready or not.

    SequenceSpec

    (Appears on:Sequence)

    FieldDescription
    steps

    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
    (Optional)

    Reply is a Reference to where the result of the last Subscriber gets sent to.

    SequenceStatus

    (Appears on:)

    SequenceStatus represents the current state of a Sequence.

    FieldDescription
    Status
    knative.dev/pkg/apis/duck/v1.Status

    (Members of Status are embedded into this type.)

    inherits duck/v1 Status, which currently provides: ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. Conditions - the latest available observations of a resource’s current state.

    subscriptionStatuses

    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
    (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}

    SequenceStep

    (Appears on:)

    FieldDescription
    Destination
    knative.dev/pkg/apis/duck/v1.Destination

    (Members of Destination are embedded into this type.)

    Subscriber receiving the step event

    delivery
    (Optional)

    Delivery is the delivery specification for events to the subscriber This includes things like retries, DLQ, etc.

    SequenceSubscriptionStatus

    (Appears on:)

    FieldDescription
    subscription
    Kubernetes core/v1.ObjectReference

    Subscription is the reference to the underlying Subscription.

    ready

    ReadyCondition indicates whether the Subscription is ready or not.


    messaging.knative.dev/v1

    Package v1 is the v1 version of the API.

    Resource Types:

    Channel

    Channel represents a generic Channel. It is normally used when we want a Channel, but do not need a specific Channel implementation.

    FieldDescription
    apiVersion
    string
    messaging.knative.dev/v1
    kind
    string
    Channel
    metadata
    (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ChannelSpec

    Spec defines the desired state of the Channel.



    channelTemplate
    (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 ChannelableSpec are embedded into this type.)

    Channel conforms to ChannelableSpec

    status
    (Optional)

    Status represents the current state of the Channel. This data may be out of date.

    InMemoryChannel

    InMemoryChannel is a resource representing an in memory channel

    FieldDescription
    apiVersion
    string
    messaging.knative.dev/v1
    kind
    string
    InMemoryChannel
    metadata
    (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    InMemoryChannelSpec

    Spec defines the desired state of the Channel.



    ChannelableSpec

    (Members of ChannelableSpec are embedded into this type.)

    Channel conforms to Duck type Channelable.

    status
    InMemoryChannelStatus
    (Optional)

    Status represents the current state of the Channel. This data may be out of date.

    Subscription

    Subscription routes events received on a Channel to a DNS name and corresponds to the subscriptions.channels.knative.dev CRD.

    FieldDescription
    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


    channel
    knative.dev/pkg/apis/duck/v1.KReference

    Reference to a channel that will be used to create the subscription You can specify only the following fields of the KReference: - Kind - APIVersion - Name The resource pointed by this KReference 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
    (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
    (Optional)

    Delivery configuration

    status
    SubscriptionStatus

    ChannelDefaulter

    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.

    ChannelStatus

    ChannelStatus represents the current state of a Channel.

    FieldDescription
    ChannelableStatus
    ChannelableStatus

    (Members of ChannelableStatus are embedded into this type.)

    Channel conforms to ChannelableStatus

    channel
    (Optional)

    Channel is an KReference to the Channel CRD backing this Channel.

    ChannelTemplateSpec

    (Appears on:, SequenceSpec, )

    FieldDescription
    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.



    InMemoryChannelSpec

    (Appears on:)

    InMemoryChannelSpec defines which subscribers have expressed interest in receiving events from this InMemoryChannel. arguments for a Channel.

    FieldDescription
    ChannelableSpec
    ChannelableSpec

    (Members of ChannelableSpec are embedded into this type.)

    Channel conforms to Duck type Channelable.

    InMemoryChannelStatus

    (Appears on:InMemoryChannel)

    ChannelStatus represents the current state of a Channel.

    FieldDescription
    ChannelableStatus

    (Members of ChannelableStatus are embedded into this type.)

    Channel conforms to Duck type ChannelableStatus.

    SubscriptionSpec

    (Appears on:)

    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 Reply. You can also perform an identity transformation on the incoming events by leaving out the Subscriber and only specifying Reply.

    The following are all valid specifications: channel –[subscriber]–> reply Sink, no outgoing events: channel – subscriber no-op function (identity transformation): channel –> reply

    FieldDescription
    channel
    knative.dev/pkg/apis/duck/v1.KReference

    Reference to a channel that will be used to create the subscription You can specify only the following fields of the KReference: - Kind - APIVersion - Name The resource pointed by this KReference 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
    (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
    (Optional)

    Delivery configuration

    SubscriptionStatus

    (Appears on:)

    SubscriptionStatus (computed) for a subscription

    FieldDescription
    Status
    knative.dev/pkg/apis/duck/v1.Status

    (Members of Status are embedded into this type.)

    inherits duck/v1 Status, which currently provides: ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. Conditions - the latest available observations of a resource’s current state.

    physicalSubscription

    PhysicalSubscription is the fully resolved values that this Subscription represents.

    SubscriptionStatusPhysicalSubscription

    (Appears on:)

    SubscriptionStatusPhysicalSubscription represents the fully resolved values for this Subscription.

    FieldDescription
    subscriberUri
    knative.dev/pkg/apis.URL
    (Optional)

    SubscriberURI is the fully resolved URI for spec.subscriber.

    replyUri
    (Optional)

    ReplyURI is the fully resolved URI for the spec.reply.


    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.

    Resource Types:

    ApiServerSource

    ApiServerSource is the Schema for the apiserversources API

    FieldDescription
    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


    SourceSpec
    knative.dev/pkg/apis/duck/v1.SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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

    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. Reference sends a dataref event type for the resource under watch. Resource send the full resource lifecycle event. Defaults to Reference

    serviceAccountName
    string
    (Optional)

    ServiceAccountName is the name of the ServiceAccount to use to run this source. Defaults to default if not set.

    status

    ContainerSource

    ContainerSource is the Schema for the containersources API

    FieldDescription
    apiVersion
    string
    sources.knative.dev/v1
    kind
    string
    ContainerSource
    metadata
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ContainerSourceSpec


    SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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

    status

    PingSource

    PingSource is the Schema for the PingSources API.

    FieldDescription
    apiVersion
    string
    sources.knative.dev/v1
    kind
    string
    PingSource
    metadata
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    PingSourceSpec


    SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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:

    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.

    status
    PingSourceStatus

    SinkBinding

    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.

    FieldDescription
    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


    SourceSpec
    knative.dev/pkg/apis/duck/v1.SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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

    (Members of BindingSpec are embedded into this type.)

    inherits duck/v1 BindingSpec, which currently provides: * Subject - Subject references the resource(s) whose “runtime contract” should be augmented by Binding implementations.

    status
    SinkBindingStatus

    APIVersionKind

    (Appears on:ApiServerSourceSpec)

    APIVersionKind is an APIVersion and Kind tuple.

    FieldDescription
    apiVersion
    string

    APIVersion - the API version of the resource to watch.

    kind
    string

    Kind of the resource to watch. More info:

    APIVersionKindSelector

    (Appears on:)

    APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

    FieldDescription
    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
    (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

    ApiServerSourceSpec

    (Appears on:ApiServerSource)

    ApiServerSourceSpec defines the desired state of ApiServerSource

    FieldDescription
    SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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
    (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. Reference sends a dataref event type for the resource under watch. Resource send the full resource lifecycle event. Defaults to Reference

    serviceAccountName
    string
    (Optional)

    ServiceAccountName is the name of the ServiceAccount to use to run this source. Defaults to default if not set.

    ApiServerSourceStatus

    (Appears on:)

    ApiServerSourceStatus defines the observed state of ApiServerSource

    FieldDescription
    SourceStatus
    knative.dev/pkg/apis/duck/v1.SourceStatus

    (Members of SourceStatus are embedded into this type.)

    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.

    ContainerSourceSpec

    (Appears on:ContainerSource)

    ContainerSourceSpec defines the desired state of ContainerSource

    FieldDescription
    SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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

    ContainerSourceStatus

    (Appears on:ContainerSource)

    ContainerSourceStatus defines the observed state of ContainerSource

    FieldDescription
    SourceStatus

    (Members of SourceStatus are embedded into this type.)

    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.

    PingSourceSpec

    (Appears on:)

    PingSourceSpec defines the desired state of the PingSource.

    FieldDescription
    SourceSpec
    knative.dev/pkg/apis/duck/v1.SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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: 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.

    PingSourceStatus

    (Appears on:PingSource)

    PingSourceStatus defines the observed state of PingSource.

    FieldDescription
    SourceStatus

    (Members of SourceStatus are embedded into this type.)

    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.

    SinkBindingSpec

    (Appears on:)

    SinkBindingSpec holds the desired state of the SinkBinding (from the client).

    FieldDescription
    SourceSpec
    knative.dev/pkg/apis/duck/v1.SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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

    (Members of BindingSpec are embedded into this type.)

    inherits duck/v1 BindingSpec, which currently provides: * Subject - Subject references the resource(s) whose “runtime contract” should be augmented by Binding implementations.

    SinkBindingStatus

    (Appears on:)

    SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

    FieldDescription
    SourceStatus
    knative.dev/pkg/apis/duck/v1.SourceStatus

    (Members of SourceStatus are embedded into this type.)

    inherits duck/v1 SourceStatus, which currently provides: ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. Conditions - the latest available observations of a resource’s current state. * SinkURI - the current active sink URI that has been configured for the Source.


    sources.knative.dev/v1beta2

    Package v1beta2 contains API Schema definitions for the sources v1beta2 API group.

    Resource Types:

    PingSource

    PingSource is the Schema for the PingSources API.

    FieldDescription
    apiVersion
    string
    sources.knative.dev/v1beta2
    kind
    string
    PingSource
    metadata
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    PingSourceSpec


    SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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:

    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.

    status
    PingSourceStatus

    PingSourceSpec

    (Appears on:PingSource)

    PingSourceSpec defines the desired state of the PingSource.

    FieldDescription
    SourceSpec

    (Members of SourceSpec are embedded into this type.)

    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:

    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.

    PingSourceStatus

    (Appears on:)

    PingSourceStatus defines the observed state of PingSource.


    Generated with gen-crd-api-reference-docs .