From bd3a322c366849a81243aaf0176b1a1ccd72ec04 Mon Sep 17 00:00:00 2001 From: Knative Prow Robot Date: Fri, 3 May 2024 10:42:12 +0100 Subject: [PATCH] Adding Kafka Source details on delivery spec (#5953) Signed-off-by: Matthias Wessendorf Co-authored-by: Matthias Wessendorf --- docs/eventing/sources/kafka-source/README.md | 35 ++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/eventing/sources/kafka-source/README.md b/docs/eventing/sources/kafka-source/README.md index ee27fbb2e2..eea64922f3 100644 --- a/docs/eventing/sources/kafka-source/README.md +++ b/docs/eventing/sources/kafka-source/README.md @@ -264,6 +264,41 @@ can add to the `config-kafka-features` configmap, [read about the experimental K } ``` +## Handling Delivery Failures + +The `KafkaSource` implements the `Delivery` Specificiation, allowing you to configure event delivery parameters for it, which are applied in cases where an event fails to be delivered: + +```yaml + + apiVersion: sources.knative.dev/v1beta1 + kind: KafkaSource + metadata: + name: kafka-source + spec: + consumerGroup: knative-group + bootstrapServers: + - my-cluster-kafka-bootstrap.kafka:9092 # note the kafka namespace + topics: + - knative-demo-topic + delivery: + deadLetterSink: + ref: + apiVersion: serving.knative.dev/v1 + kind: Service + name: example-sink + backoffDelay: + backoffPolicy: + retry: + sink: + ref: + apiVersion: serving.knative.dev/v1 + kind: Service + name: event-display + +``` + +The `delivery` API is discussed in the [Handling Delivery Failure](../../event-delivery) chapter. + ## Optional: Specify the key deserializer When `KafkaSource` receives a message from Kafka, it dumps the key in the Event extension called