[pulsar] branch master updated: [Doc] Add *Kinesis sink connector guide* (#5214)

[hj...@apache.org]

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

hjf pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 4f037e3  [Doc] Add *Kinesis sink connector guide*  (#5214)
4f037e3 is described below

commit 4f037e30f8acdd8ef84287d9e2f375fbead85e21
Author: Anonymitaet <50...@users.noreply.github.com>
AuthorDate: Fri Sep 27 13:41:00 2019 +0800

    [Doc] Add *Kinesis sink connector guide*  (#5214)
    
    * Add *Kinesis sink connector guide*
    
    * Add *Kinesis sink connector guide*
    
    * Update
---
 site2/docs/io-connectors.md   |  4 +++-
 site2/docs/io-kinesis-sink.md | 54 +++++++++++++++++++++++++++++++++++++++++++
 site2/docs/io-kinesis.md      | 36 -----------------------------
 3 files changed, 57 insertions(+), 37 deletions(-)

diff --git a/site2/docs/io-connectors.md b/site2/docs/io-connectors.md
index 149e75a..00ec746 100644
--- a/site2/docs/io-connectors.md
+++ b/site2/docs/io-connectors.md
@@ -60,9 +60,11 @@ Pulsar has various sink connectors, which are sorted alphabetically as below.
 
 - [Kafka sink connector](io-kafka-sink.md)
 
+- [Kinesis sink connector](io-kinesis-sink.md)
+
 - [MongoDB sink connector](io-mongo.md)
 
-- [RabbitMQ sink connector](io-rabbitmq.md)
+- [RabbitMQ sink connector](io-rabbitmq-sink.md)
 
 - [Redis sink connector](io-redis.md)
 
diff --git a/site2/docs/io-kinesis-sink.md b/site2/docs/io-kinesis-sink.md
new file mode 100644
index 0000000..132b317
--- /dev/null
+++ b/site2/docs/io-kinesis-sink.md
@@ -0,0 +1,54 @@
+---
+id: io-kinesis-sink
+title: Kinesis sink connector
+sidebar_label: Kinesis sink connector
+---
+
+The Kinesis sink connector pulls data from Pulsar and persists data into Amazon Kinesis.
+
+## Configuration
+
+The configuration of the Kinesis sink connector has the following parameters.
+
+### Parameter
+
+| Name | Type|Required | Default | Description 
+|------|----------|----------|---------|-------------|
+`messageFormat`|MessageFormat|true|ONLY_RAW_PAYLOAD|Message format in which Kinesis sink converts Pulsar messages and publishes to Kinesis streams.<br/><br/>Below are the available options:<br/><br/><li>`ONLY_RAW_PAYLOAD`: Kinesis sink directly publishes Pulsar message payload as a message into the configured Kinesis stream. <br/><br/><li>`FULL_MESSAGE_IN_JSON`: Kinesis sink creates a JSON payload with Pulsar message payload, properties and encryptionCtx, and publishes JSON payload into  [...]
+`retainOrdering`|boolean|false|false|Whether Pulsar connectors to retain ordering when moving messages from Pulsar to Kinesis or not.
+`awsEndpoint`|String|false|" " (empty string)|The Kinesis end-point URL, which can be found at [here](https://docs.aws.amazon.com/general/latest/gr/rande.html).
+`awsRegion`|String|false|" " (empty string)|The AWS region. <br/><br/>**Example**<br/> us-west-1, us-west-2
+`awsKinesisStreamName`|String|true|" " (empty string)|The Kinesis stream name.
+`awsCredentialPluginName`|String|false|" " (empty string)|The fully-qualified class name of implementation of {@inject: github:`AwsCredentialProviderPlugin`:/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/AwsCredentialProviderPlugin.java}. <br/><br/>It is a factory class which creates an AWSCredentialsProvider that is used by Kinesis sink. <br/><br/>If it is empty, the Kinesis sink creates a default AWSCredentialsProvider which accepts json-map of credentials in `awsCredent [...]
+`awsCredentialPluginParam`|String |false|" " (empty string)|The JSON parameter to initialize `awsCredentialsProviderPlugin`.
+
+### Example
+
+Before using the Kinesis sink connector, you need to create a configuration file through one of the following methods.
+
+* JSON 
+
+    ```json
+    {
+        "awsEndpoint": "https://some.endpoint.aws",
+        "awsRegion": "us-east-1",
+        "awsKinesisStreamName": "my-stream",
+        "awsCredentialPluginParam": "{\"accessKey\":\"myKey\",\"secretKey\":\"my-Secret\"}",
+        "messageFormat": "ONLY_RAW_PAYLOAD",
+        "retainOrdering": "true"
+    }
+    ```
+
+* YAML
+
+    ```yaml
+    configs:
+        awsEndpoint: "https://some.endpoint.aws"
+        awsRegion: "us-east-1"
+        awsKinesisStreamName: "my-stream"
+        awsCredentialPluginParam: "{\"accessKey\":\"myKey\",\"secretKey\":\"my-Secret\"}"
+        messageFormat: "ONLY_RAW_PAYLOAD"
+        retainOrdering: "true"
+    ```
+
+
diff --git a/site2/docs/io-kinesis.md b/site2/docs/io-kinesis.md
deleted file mode 100644
index e3eef08..0000000
--- a/site2/docs/io-kinesis.md
+++ /dev/null
@@ -1,36 +0,0 @@
----
-id: io-kinesis
-title: AWS Kinesis Connector
-sidebar_label: AWS Kinesis Connector
----
-
-## Sink
-
-The Kinesis Sink connector is used to pull data from Pulsar topics and persist the data into
-AWS Kinesis.
-
-### Sink Configuration Options
-
-| Name | Required | Default | Description |
-|------|----------|---------|-------------|
-| awsEndpoint | `true` | null | kinesis end-point url can be found at : https://docs.aws.amazon.com/general/latest/gr/rande.html |
-| awsRegion | `true` | null | appropriate aws region eg: us-west-1, us-west-2 |
-| awsKinesisStreamName | `true` | null | kinesis stream name |
-| awsCredentialPluginName | `false` | null | Fully-Qualified class name of implementation of {@inject: github:`AwsCredentialProviderPlugin`:/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/AwsCredentialProviderPlugin.java}. It is a factory class which creates an AWSCredentialsProvider that will be used by Kinesis Sink. If it is empty then KinesisSink will create a default AWSCredentialsProvider which accepts json-map of credentials in `awsCredentialPluginParam` | 
-| awsCredentialPluginParam | `false` | null | json-parameters to initialize `AwsCredentialsProviderPlugin` |
-| messageFormat | `true` | `ONLY_RAW_PAYLOAD` | Message format in which kinesis sink converts pulsar messages and publishes to kinesis streams |
-
-### Message Formats
-
-The available message formats are listed as below:
-
-#### **ONLY_RAW_PAYLOAD**
-
-Kinesis sink directly publishes pulsar message payload as a message into the configured kinesis stream.
-#### **FULL_MESSAGE_IN_JSON**
-
-Kinesis sink creates a json payload with pulsar message payload, properties and encryptionCtx, and publishes json payload into the configured kinesis stream.
-
-#### **FULL_MESSAGE_IN_FB**
-
-Kinesis sink creates a flatbuffer serialized paylaod with pulsar message payload, properties and encryptionCtx, and publishes flatbuffer payload into the configured kinesis stream.