You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2021/03/26 08:07:52 UTC

[camel-kamelets] 04/06: Added AWS SNS Sink Kamelet

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

acosentino pushed a commit to branch aws-sns
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git

commit 377d5499e06a7590862eb48cbfacfda56ddc4568
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Fri Mar 26 09:06:22 2021 +0100

    Added AWS SNS Sink Kamelet
---
 .../ROOT/assets/images/kamelets/aws-sns-sink.svg   | 14 +++++
 docs/modules/ROOT/pages/aws-sns-sink.adoc          | 67 ++++++++++++++++++++++
 2 files changed, 81 insertions(+)

diff --git a/docs/modules/ROOT/assets/images/kamelets/aws-sns-sink.svg b/docs/modules/ROOT/assets/images/kamelets/aws-sns-sink.svg
new file mode 100644
index 0000000..192b2c8
--- /dev/null
+++ b/docs/modules/ROOT/assets/images/kamelets/aws-sns-sink.svg
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg   viewBox="0 0 256 257" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid">
+	<g>
+		<path d="M98.875,232.033 L72.442,224.625 L47.441,196.117 L78.713,195.254 L98.875,232.033" fill="#995B80"></path>
+		<path d="M37.75,213.233 L22.875,209.067 L8.817,193.033 L25.899,190.224 L37.75,213.233" fill="#995B80"></path>
+		<path d="M0,191.017 L15.204,194.108 L17.411,190.226 L17.411,58.503 L15.204,55.942 L0,64.6 L0,191.017" fill="#7B3F65"></path>
+		<path d="M73.933,69.708 L15.208,55.942 L15.208,194.108 L24.006,193.29 L37.75,213.233 L48.35,191.028 L73.933,188.65 L73.933,69.708" fill="#C17B9D"></path>
+		<path d="M33.958,198.133 L60.021,203.383 L61.737,199.338 L61.737,37.44 L60.021,33.775 L33.958,46.983 L33.958,198.133" fill="#7B3F65"></path>
+		<path d="M208.734,81.516 L60.021,33.775 L60.021,203.387 L77.242,201.171 L98.875,232.033 L116.001,196.183 L208.734,184.25 L208.734,81.516" fill="#C17B9D"></path>
+		<path d="M181.833,256.492 L144.267,245.967 L108.758,205.467 L154.791,204.999 L181.833,256.492" fill="#995B80"></path>
+		<path d="M89.591,208.95 L127.921,216.367 L130.898,213.801 L130.898,4.117 L127.921,0 L89.591,19.158 L89.591,208.95" fill="#7B3F65"></path>
+		<path d="M256,64.033 L127.925,0 L127.925,216.367 L150.522,211.839 L181.833,256.492 L208.734,200.183 L208.717,200.181 L256,190.708 L256,64.033" fill="#C17B9D"></path>
+	</g>
+</svg>
diff --git a/docs/modules/ROOT/pages/aws-sns-sink.adoc b/docs/modules/ROOT/pages/aws-sns-sink.adoc
new file mode 100644
index 0000000..2bc703a
--- /dev/null
+++ b/docs/modules/ROOT/pages/aws-sns-sink.adoc
@@ -0,0 +1,67 @@
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
+= image:kamelets/aws-sns-sink.svg[] AWS SNS Sink
+
+*Provided by: "Apache Software Foundation"*
+
+Send message to an AWS SNS Queue
+
+== Configuration Options
+
+The following table summarizes the configuration options available for the `aws-sns-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| string| | `"eu-west-1"`
+| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| | 
+| *topicNameOrArn {empty}* *| Topic Name| The SQS Topic name or ARN| string| | 
+| autoCreateTopic| Autocreate topic| Setting the autocreation of the SNS topic.| boolean| `false`| 
+|===
+
+NOTE: Fields marked with ({empty}*) are mandatory.
+
+== Usage
+
+This section summarizes how the `aws-sns-sink` can be used in various contexts.
+
+=== Knative Sink
+
+The `aws-sns-sink` Kamelet can be used as Knative sink by binding it to a Knative object.
+
+.aws-sns-sink-binding.yaml
+[source,yaml]
+----
+apiVersion: camel.apache.org/v1alpha1
+kind: KameletBinding
+metadata:
+  name: aws-sns-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-sns-sink
+    properties:
+      accessKey: "The Access Key"
+      region: "eu-west-1"
+      secretKey: "The Secret Key"
+      topicNameOrArn: "The Topic 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-sns-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-sns-sink-binding.yaml
+----
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT