[camel-kafka-connector] branch master updated: Added a page in docs related to basic configuration of camel kafka connector

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-kafka-connector.git


The following commit(s) were added to refs/heads/master by this push:
     new bdd884a  Added a page in docs related to basic configuration of camel kafka connector
bdd884a is described below

commit bdd884a44cab97f6328e52de2ad15bd0478d4434
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Mon Nov 2 09:29:28 2020 +0100

    Added a page in docs related to basic configuration of camel kafka connector
---
 docs/modules/ROOT/nav.adoc                       |  1 +
 docs/modules/ROOT/pages/basic-configuration.adoc | 44 ++++++++++++++++++++++++
 2 files changed, 45 insertions(+)

diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index c18d0c7..70cf3f6 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -1,5 +1,6 @@
 * xref:about.adoc[What is it?]
 ** xref:basic-concepts.adoc[Basic concepts]
+** xref:basic-configuration.adoc[Basic configuration]
 ** xref:aggregation.adoc[Aggregation]
 * xref:archetypes.adoc[Archetypes]
 ** xref:archetype-connector.adoc[Extensible connector archetype]
diff --git a/docs/modules/ROOT/pages/basic-configuration.adoc b/docs/modules/ROOT/pages/basic-configuration.adoc
new file mode 100644
index 0000000..89eb903
--- /dev/null
+++ b/docs/modules/ROOT/pages/basic-configuration.adoc
@@ -0,0 +1,44 @@
+[[BasicConfiguration-BasicConfiguration]]
+= Basic Configuration
+
+In this page we list the Camel Kafka Configuration which are not part of the camel-catalog material and are not part of the kafka connect framework. For the specific connector configuration you can have a look at the single documentation pages.
+
+For a Sink connector the basic options are:
+
+[width="100%",cols="2,5,^2,1",options="header"]
+|===
+| Name | Description | Default | Priority
+| camel.sink.marshal | The camel dataformat name to use to marshal data to the destination | null | HIGH
+| camel.sink.unmarshal | The camel dataformat name to use to unmarshal data from the topic | null | HIGH
+| camel.sink.contentLogLevel | og level for the record's content. Valid values: TRACE, DEBUG, INFO, WARN, ERROR, OFF. | OFF | HIGH
+| camel.beans.aggregate | A reference to an aggregate bean, in the form of #class: | null | MEDIUM
+| camel.aggregation.size | The size of the aggregation, to be used in combination with camel.beans.aggregate | 10 | MEDIUM
+| camel.aggregation.timeout | The timeout of the aggregation, to be used in combination with camel.beans.aggregate | 500L | MEDIUM
+| camel.error.handler | The error handler to use: possible value are 'no' or 'default' | default | MEDIUM
+| camel.error.handler.max.redeliveries | The maximum redeliveries to be use in case of Default Error Handler | 0 | MEDIUM
+| camel.error.handler.redelivery.delay | The initial redelivery delay in milliseconds in case of Default Error Handler | 1000L | MEDIUM
+|===
+
+For a Source connector the basic options are:
+
+[width="100%",cols="2,5,^2,1",options="header"]
+|===
+| Name | Description | Default | Priority
+| camel.source.marshal | The camel dataformat name to use to marshal data to the destination | null | HIGH
+| camel.source.unmarshal | The camel dataformat name to use to unmarshal data from the topic | null | HIGH
+| camel.source.contentLogLevel | og level for the record's content. Valid values: TRACE, DEBUG, INFO, WARN, ERROR, OFF. | OFF | HIGH
+| camel.source.maxBatchPollSize | The max number of messages retrieved in a single poll() | 1000L | MEDIUM
+| camel.source.maxPollDuration | The maximum time in milliseconds spent in a single call to poll() | 1000L | MEDIUM
+| camel.source.pollingConsumerQueueSize | The queue size for the internal hand-off queue between the polling consumer, and producers sending data into the queue. | 1000L | MEDIUM
+| camel.source.pollingConsumerBlockTimeout | To use a timeout (in milliseconds) when the producer is blocked if the internal queue is full. If the value is 0 or negative then no timeout is in use. | 0L | MEDIUM
+| camel.source.pollingConsumerBlockWhenFull | Whether to block any producer if the internal queue is full. | true | MEDIUM
+| camel.source.camelMessageHeaderKey | The name of a camel message header containing an unique key that can be used as a Kafka message key. If this is not specified, then the Kafka message will not have a key. | null | MEDIUM
+| camel.beans.aggregate | A reference to an aggregate bean, in the form of #class: | null | MEDIUM
+| camel.aggregation.size | The size of the aggregation, to be used in combination with camel.beans.aggregate | 10 | MEDIUM
+| camel.aggregation.timeout | The timeout of the aggregation, to be used in combination with camel.beans.aggregate | 500L | MEDIUM
+| camel.error.handler | The error handler to use: possible value are 'no' or 'default' | default | MEDIUM
+| camel.error.handler.max.redeliveries | The maximum redeliveries to be use in case of Default Error Handler | 0 | MEDIUM
+| camel.error.handler.redelivery.delay | The initial redelivery delay in milliseconds in case of Default Error Handler | 1000L | MEDIUM
+|===
+
+For more options related to single connector you can have a look at xref:connectors.adoc[Connectors list].