-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
79 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |