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/07/30 06:23:58 UTC
[camel-kamelets] 06/06: Regen docs
This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch s3-and-regen
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit 25609d4256830a60d8979f8d61d88f3abb3f722c
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Fri Jul 30 08:22:59 2021 +0200
Regen docs
---
.../ROOT/assets/images/kamelets/log-sink.svg | 41 +++++++
docs/modules/ROOT/pages/log-sink.adoc | 121 +++++++++++++++++++++
2 files changed, 162 insertions(+)
diff --git a/docs/modules/ROOT/assets/images/kamelets/log-sink.svg b/docs/modules/ROOT/assets/images/kamelets/log-sink.svg
new file mode 100644
index 0000000..eb7ab89
--- /dev/null
+++ b/docs/modules/ROOT/assets/images/kamelets/log-sink.svg
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- Generator: Adobe Illustrator 16.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+ width="512px" height="512px" viewBox="0 0 512 512" style="enable-background:new 0 0 512 512;" xml:space="preserve">
+<g>
+ <path d="M448,0H64C46.328,0,32,14.313,32,32v448c0,17.688,14.328,32,32,32h384c17.688,0,32-14.312,32-32V32
+ C480,14.313,465.688,0,448,0z M64,480V128h80v64H96v16h48v48H96v16h48v48H96v16h48v48H96v16h48v80H64z M448,480H160v-80h256v-16
+ H160v-48h256v-16H160v-48h256v-16H160v-48h256v-16H160v-64h288V480z"/>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+</svg>
diff --git a/docs/modules/ROOT/pages/log-sink.adoc b/docs/modules/ROOT/pages/log-sink.adoc
new file mode 100644
index 0000000..c0d1b51
--- /dev/null
+++ b/docs/modules/ROOT/pages/log-sink.adoc
@@ -0,0 +1,121 @@
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
+= image:kamelets/log-sink.svg[] Log Sink
+
+*Provided by: "Apache Software Foundation"*
+
+*Support Level for this Kamelet is: "Preview"*
+
+A sink that logs all data that it receives, useful for debugging purposes.
+
+== Configuration Options
+
+The following table summarizes the configuration options available for the `log-sink` Kamelet:
+[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
+|===
+| Property| Name| Description| Type| Default| Example
+| showHeaders| Show Headers| Show the headers received| boolean| `false`|
+| showStreams| Show Streams| Show the stream bodies (they may not be available in following steps)| boolean| `false`|
+|===
+
+NOTE: Fields marked with ({empty}*) are mandatory.
+
+== Usage
+
+This section summarizes how the `log-sink` can be used in various contexts.
+
+=== Knative Sink
+
+The `log-sink` Kamelet can be used as Knative sink by binding it to a Knative object.
+
+.log-sink-binding.yaml
+[source,yaml]
+----
+apiVersion: camel.apache.org/v1alpha1
+kind: KameletBinding
+metadata:
+ name: log-sink-binding
+spec:
+ source:
+ ref:
+ kind: InMemoryChannel
+ apiVersion: messaging.knative.dev/v1
+ name: mychannel
+ sink:
+ ref:
+ kind: Kamelet
+ apiVersion: camel.apache.org/v1alpha1
+ name: log-sink
+
+----
+
+Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.
+
+Save the `log-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 log-sink-binding.yaml
+----
+
+==== *Binding to Knative using the Kamel CLI:*
+
+The procedure described above can be simplified into a single execution of the `kamel bind` command:
+
+[source,shell]
+----
+kamel bind channel/mychannel log-sink
+----
+
+This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.
+
+=== Kafka Sink
+
+The `log-sink` Kamelet can be used as Kafka sink by binding it to a Kafka topic.
+
+.log-sink-binding.yaml
+[source,yaml]
+----
+apiVersion: camel.apache.org/v1alpha1
+kind: KameletBinding
+metadata:
+ name: log-sink-binding
+spec:
+ source:
+ ref:
+ kind: KafkaTopic
+ apiVersion: kafka.strimzi.io/v1beta1
+ name: my-topic
+ sink:
+ ref:
+ kind: Kamelet
+ apiVersion: camel.apache.org/v1alpha1
+ name: log-sink
+
+----
+
+Ensure that you've installed https://strimzi.io/[Strimzi] and created a topic named `my-topic` in the current namespace.
+Make also sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.
+
+Save the `log-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 log-sink-binding.yaml
+----
+
+==== *Binding to Kafka using the Kamel CLI:*
+
+The procedure described above can be simplified into a single execution of the `kamel bind` command:
+
+[source,shell]
+----
+kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic log-sink
+----
+
+This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.
+
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT