From 4c2b1050a62b1f3ad1d45f605d56b29438843c77 Mon Sep 17 00:00:00 2001 From: Andrea Cosentino Date: Wed, 21 Apr 2021 14:18:52 +0200 Subject: [PATCH] Added AWS Kinesis Sink Kamelet --- .../images/kamelets/aws-kinesis-sink.svg | 1 + docs/modules/ROOT/pages/aws-kinesis-sink.adoc | 78 +++++++++++++++++++ 2 files changed, 79 insertions(+) create mode 100644 docs/modules/ROOT/assets/images/kamelets/aws-kinesis-sink.svg create mode 100644 docs/modules/ROOT/pages/aws-kinesis-sink.adoc diff --git a/docs/modules/ROOT/assets/images/kamelets/aws-kinesis-sink.svg b/docs/modules/ROOT/assets/images/kamelets/aws-kinesis-sink.svg new file mode 100644 index 000000000..26ddfef8d --- /dev/null +++ b/docs/modules/ROOT/assets/images/kamelets/aws-kinesis-sink.svg @@ -0,0 +1 @@ +aws-kinesis \ No newline at end of file diff --git a/docs/modules/ROOT/pages/aws-kinesis-sink.adoc b/docs/modules/ROOT/pages/aws-kinesis-sink.adoc new file mode 100644 index 000000000..17130d7b4 --- /dev/null +++ b/docs/modules/ROOT/pages/aws-kinesis-sink.adoc @@ -0,0 +1,78 @@ +// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT += image:kamelets/aws-kinesis-sink.svg[] AWS Kinesis Sink + +*Provided by: "Apache Software Foundation"* + +Send data to AWS Kinesis. + +The Kamelet expects the following header: + +- `partition` / `ce-partition`: to set the Kinesis partition key + +If the header won't be set the exchange ID will be used. + +The Kamelet is also able to recognize the following header: + +- `sequence-number` / `ce-sequence-number`: to set the Sequence number + +This header is optional. + +== Configuration Options + +The following table summarizes the configuration options available for the `aws-kinesis-sink` Kamelet: +[width="100%",cols="2,^2,3,^2,^2,^3",options="header"] +|=== +| Property| Name| Description| Type| Default| Example +| *accessKey {empty}* *| Access Key| The access key obtained from AWS| string| | +| *region {empty}* *| AWS Region| The AWS region to connect to (capitalized name)| string| | `"eu-west-1"` +| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| | +| *stream {empty}* *| Stream Name| The Kinesis stream that you want to access (needs to be created in advance)| string| | +|=== + +NOTE: Fields marked with ({empty}*) are mandatory. + +== Usage + +This section summarizes how the `aws-kinesis-sink` can be used in various contexts. + +=== Knative Sink + +The `aws-kinesis-sink` Kamelet can be used as Knative sink by binding it to a Knative object. + +.aws-kinesis-sink-binding.yaml +[source,yaml] +---- +apiVersion: camel.apache.org/v1alpha1 +kind: KameletBinding +metadata: + name: aws-kinesis-sink-binding +spec: + source: + ref: + kind: InMemoryChannel + apiVersion: messaging.knative.dev/v1 + name: mychannel + sink: + ref: + kind: Kamelet + apiVersion: camel.apache.org/v1alpha1 + name: aws-kinesis-sink + properties: + accessKey: "The Access Key" + region: "eu-west-1" + secretKey: "The Secret Key" + stream: "The Stream Name" + +---- + +Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to. + +Save the `aws-kinesis-sink-binding.yaml` file into your hard drive, then configure it according to your needs. + +You can run the sink using the following command: + +[source,shell] +---- +kubectl apply -f aws-kinesis-sink-binding.yaml +---- +// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT