[camel] 07/11: CAMEL-13165 - Docs updated

[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.git

commit fc41b4d4dd475a584b90dfeaac0b0cce4b54881e
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Feb 28 14:05:57 2019 +0100

    CAMEL-13165 - Docs updated
---
 .../src/main/docs/aws-msk-component.adoc           | 151 +++++++++++++++++++++
 1 file changed, 151 insertions(+)

diff --git a/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc b/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc
new file mode 100644
index 0000000..e1d5432
--- /dev/null
+++ b/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc
@@ -0,0 +1,151 @@
+[[aws-msk-component]]
+== AWS MSK Component
+
+*Available as of Camel version 3.0*
+
+The KMS component supports create, run, start, stop and terminate
+https://aws.amazon.com/it/msk/[AWS MSK] instances.
+
+Prerequisites
+
+You must have a valid Amazon Web Services developer account, and be
+signed up to use Amazon MSK. More information are available at
+https://aws.amazon.com/it/msk/[Amazon MSK].
+
+### URI Format
+
+[source,java]
+-------------------------
+aws-msk://label[?options]
+-------------------------
+
+You can append query options to the URI in the following format,
+?options=value&option2=value&...
+
+### URI Options
+
+
+// component options: START
+The AWS MSK component supports 5 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *configuration* (advanced) | The AWS KMS default configuration |  | MSKConfiguration
+| *accessKey* (producer) | Amazon AWS Access Key |  | String
+| *secretKey* (producer) | Amazon AWS Secret Key |  | String
+| *region* (producer) | The region in which KMS client needs to work |  | String
+| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
+|===
+// component options: END
+
+
+
+
+// endpoint options: START
+The AWS MSK endpoint is configured using URI syntax:
+
+----
+aws-msk:label
+----
+
+with the following path and query parameters:
+
+==== Path Parameters (1 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *label* | *Required* Logical name |  | String
+|===
+
+
+==== Query Parameters (8 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *accessKey* (producer) | Amazon AWS Access Key |  | String
+| *mskClient* (producer) | To use a existing configured AWS MSK as client |  | AWSKafka
+| *operation* (producer) | *Required* The operation to perform |  | MSKOperations
+| *proxyHost* (producer) | To define a proxy host when instantiating the KMS client |  | String
+| *proxyPort* (producer) | To define a proxy port when instantiating the KMS client |  | Integer
+| *region* (producer) | The region in which KMS client needs to work |  | String
+| *secretKey* (producer) | Amazon AWS Secret Key |  | String
+| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+|===
+// endpoint options: END
+
+// spring-boot-auto-configure options: START
+// spring-boot-auto-configure options: END
+
+
+
+
+Required MSK component options
+
+You have to provide the amazonKmsClient in the
+Registry or your accessKey and secretKey to access
+the https://aws.amazon.com/it/msk/[Amazon MSK] service.
+
+### Usage
+
+#### Message headers evaluated by the MSK producer
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Header |Type |Description
+
+|`CamelAwsMSKOperation` |`String` |The operation to perform
+
+|`CamelAwsMSKClusterFilter` |`String` |The cluster name filter for list operation
+
+|`CamelAwsMSKClusterName` |`String` |The cluster name for list and create operation
+
+|`CamelAwsMSKClusterArn` |`String` |The cluster arn for delete operation
+
+|`CamelAwsMSKClusterKafkaVersion` |`String` | The Kafka for the cluster during create operation
+
+|`CamelAwsMSKBrokerNodesNumber` |`Integer`| The number of nodes for the cluster during create operation
+
+|`CamelAwsMSKBrokerNodesGroupInfo` |`com.amazonaws.services.kafka.model.BrokerNodeGroupInfo`| The Broker nodes group info to provide during the create operation
+|=======================================================================
+
+#### KMS Producer operations
+
+Camel-AWS KMS component provides the following operation on the producer side:
+
+- listClusters
+- createCluster
+- deleteCluster
+
+Dependencies
+
+Maven users will need to add the following dependency to their pom.xml.
+
+*pom.xml*
+
+[source,xml]
+---------------------------------------
+<dependency>
+    <groupId>org.apache.camel</groupId>
+    <artifactId>camel-aws-msk</artifactId>
+    <version>${camel-version}</version>
+</dependency>
+---------------------------------------
+
+where `${camel-version`} must be replaced by the actual version of Camel
+(2.16 or higher).
+
+### See Also
+
+* Configuring Camel
+* Component
+* Endpoint
+* Getting Started
+
+* AWS Component