Skip to content

Document all event delivery parameters #2752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 18, 2020
Merged

Document all event delivery parameters #2752

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfbac96
Document all event delivery parameters
pierDipi Aug 18, 2020
9d6585a
Fix typo: linerar -> linear
pierDipi Aug 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/eventing/event-delivery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ The `deadLetterSink` specifies where to send events that failed be consumed by `

## 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)

### deadLetterSink

When present, events that failed to be consumed are sent to the `deadLetterSink`.
Expand All @@ -50,6 +52,9 @@ The `deadLetterSink` value must be a [Destination](https://pkg.go.dev/knative.de
spec:
delivery:
deadLetterSink: <Destination>
retry: <number of retries>
backoffPolicy: <linear or exponential>
backoffDelay: <ISO8601 duration>
```

## Channel Support
Expand All @@ -58,7 +63,7 @@ The table below summarizes what delivery parameters are supported for each chann

| Channel Type | Supported Delivery Parameters |
| - | - |
| In-Memory | `deadLetterSink` |
| Kafka | none |
| In-Memory | `deadLetterSink`, `retry`, `backoffPolicy`, `backoffDelay` |
| Kafka | `deadLetterSink`, `retry`, `backoffPolicy`, `backoffDelay` |
| Natss | none |
| GCP PubSub | none |