From 1dd806f69943019210714970de23c6a05af259eb Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan <40172997+abrennan89@users.noreply.github.com> Date: Thu, 28 Mar 2019 17:25:53 +0000 Subject: [PATCH] Added details for Camel Source and link to example (#1108) * Added details for Camel Source and link to example * Added note about Camel-K requirement for CamelSource and link to installation docs --- docs/eventing/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/eventing/README.md b/docs/eventing/README.md index 34a61d646..ab158cee4 100644 --- a/docs/eventing/README.md +++ b/docs/eventing/README.md @@ -268,6 +268,24 @@ The KafkaSource reads events from an Apache Kafka Cluster, and passes these to a See the [Kafka Source](https://github.com/knative/eventing-sources/tree/master/contrib/kafka/samples) example. +### CamelSource + +A CamelSource is an event source that can represent any existing [Apache Camel component](https://github.com/apache/camel/tree/master/components) that provides a consumer side, and enables publishing events to an addressable endpoint. Each Camel endpoint has the form of a URI where the scheme is the ID of the component to use. + +CamelSource requires [Camel-K](https://github.com/apache/camel-k#installation) to be installed into the current namespace. + +**Spec fields**: + +- source: information on the kind of Camel source that should be created. + - component: the default kind of source, enables creating an EventSource by configuring a single Camel component. + - uri: `string` contains the Camel URI that should be used to push events into the target sink. + - properties: `key/value map` contains Camel global options or component specific configuration. Options are available in the documentation of each existing Apache Camel component. +- serviceAccountName: `string` an optional service account that can be used to run the source pod. +- image: `string` an optional base image to use for the source pod, mainly for development purposes. + +See the [CamelSource](https://github.com/knative/eventing-sources/blob/master/contrib/camel/samples/README.md) example. + + ## Getting Started - [Setup Knative Serving](../install/README.md)