diff --git a/docs/eventing/event-delivery.md b/docs/eventing/event-delivery.md index f8186448d..843539aeb 100644 --- a/docs/eventing/event-delivery.md +++ b/docs/eventing/event-delivery.md @@ -72,22 +72,51 @@ after the specified number of retries. ## Common Delivery Parameters -The `delivery` value must be a [Delivery Spec](https://pkg.go.dev/knative.dev/eventing/pkg/apis/duck/v1?tab=doc#DeliverySpec) +The `delivery` value must be a Delivery Spec, which is a partial schema that is embedded in resources like `Broker`, `Trigger` and `Subscription`. + +```yaml +# DeadLetterSink is the sink receiving event that could not be sent to +# a destination. +deadLetterSink: + ref: + apiVersion: v1 + kind: Service + name: my-service + uri: /my-path + +# Retry is the minimum number of retries the sender should attempt when +# sending an event before moving it to the dead letter sink. +retry: 5 + +// BackoffPolicy is the retry backoff policy (linear, exponential). +backoffPolicy: exponential + +# 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*. +# For exponential policy, backoff delay is backoffDelay*2^. +backoffDelay: PT2S +``` ### deadLetterSink When present, events that failed to be consumed are sent to the `deadLetterSink`. In case of failure, the event is dropped and an error is logged into the system. -The `deadLetterSink` value must be a [Destination](https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Destination). +The `deadLetterSink` value must be a Destination. ```yaml -spec: - delivery: - deadLetterSink: - retry: - backoffPolicy: - backoffDelay: +# DeadLetterSink is the sink receiving event that could not be sent to +# a destination. +deadLetterSink: + ref: + apiVersion: v1 + kind: Service + name: my-service + uri: /my-path ``` Failed events may, depending on the specific Channel implementation in use, be