From 6b021f9020e99f61a13a6eb1a64cf3e56212dada Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan <40172997+abrennan89@users.noreply.github.com> Date: Wed, 27 Mar 2019 18:48:01 +0000 Subject: [PATCH] Add KafkaSource information and link to example (#1099) --- docs/eventing/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/eventing/README.md b/docs/eventing/README.md index 35a22ebca..34a61d646 100644 --- a/docs/eventing/README.md +++ b/docs/eventing/README.md @@ -256,6 +256,18 @@ The CronJobSource fires events based on given See the [Cronjob Source](samples/cronjob-source) example. +### KafkaSource + +The KafkaSource reads events from an Apache Kafka Cluster, and passes these to a Knative Serving application so that they can be consumed. + +**Spec fields**: + +- `consumerGroup`: `string` Name of a Kafka consumer group. +- `bootstrapServers`: `string` Comma separated list of `hostname:port` pairs for the Kafka Broker. +- `topics`: `string` Name of the Kafka topic to consume messages from. + +See the [Kafka Source](https://github.com/knative/eventing-sources/tree/master/contrib/kafka/samples) example. + ## Getting Started - [Setup Knative Serving](../install/README.md)