You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by nf...@apache.org on 2021/02/15 15:56:29 UTC
[camel-kamelets] 08/08: chore: regen doc
This is an automated email from the ASF dual-hosted git repository.
nferraro pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit 359a65d42bc886be9d8a7c4c6d03d03d7a360c27
Author: nicolaferraro <ni...@gmail.com>
AuthorDate: Mon Feb 15 16:34:32 2021 +0100
chore: regen doc
---
.../ROOT/assets/images/kamelets/bitcoin-source.svg | 7 +++
.../ROOT/assets/images/kamelets/http-source.svg | 8 +++
.../ROOT/assets/images/kamelets/mqtt-source.svg | 18 +++++++
docs/modules/ROOT/nav.adoc | 3 ++
docs/modules/ROOT/pages/bitcoin-source.adoc | 58 ++++++++++++++++++++
docs/modules/ROOT/pages/http-source.adoc | 60 +++++++++++++++++++++
docs/modules/ROOT/pages/mqtt-source.adoc | 62 ++++++++++++++++++++++
http-source.kamelet.yaml | 2 +-
8 files changed, 217 insertions(+), 1 deletion(-)
diff --git a/docs/modules/ROOT/assets/images/kamelets/bitcoin-source.svg b/docs/modules/ROOT/assets/images/kamelets/bitcoin-source.svg
new file mode 100644
index 0000000..04079be
--- /dev/null
+++ b/docs/modules/ROOT/assets/images/kamelets/bitcoin-source.svg
@@ -0,0 +1,7 @@
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns="http://www.w3.org/2000/svg" height="64" width="64" version="1.1" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/">
+<g transform="translate(0.00630876,-0.00301984)">
+<path fill="#f7931a" d="m63.033,39.744c-4.274,17.143-21.637,27.576-38.782,23.301-17.138-4.274-27.571-21.638-23.295-38.78,4.272-17.145,21.635-27.579,38.775-23.305,17.144,4.274,27.576,21.64,23.302,38.784z"/>
+<path fill="#FFF" d="m46.103,27.444c0.637-4.258-2.605-6.547-7.038-8.074l1.438-5.768-3.511-0.875-1.4,5.616c-0.923-0.23-1.871-0.447-2.813-0.662l1.41-5.653-3.509-0.875-1.439,5.766c-0.764-0.174-1.514-0.346-2.242-0.527l0.004-0.018-4.842-1.209-0.934,3.75s2.605,0.597,2.55,0.634c1.422,0.355,1.679,1.296,1.636,2.042l-1.638,6.571c0.098,0.025,0.225,0.061,0.365,0.117-0.117-0.029-0.242-0.061-0.371-0.092l-2.296,9.205c-0.174,0.432-0.615,1.08-1.609,0.834,0.035,0.051-2.552-0.637-2.552-0.637l-1.743,4.019,4 [...]
+</g>
+</svg>
diff --git a/docs/modules/ROOT/assets/images/kamelets/http-source.svg b/docs/modules/ROOT/assets/images/kamelets/http-source.svg
new file mode 100644
index 0000000..651a94f
--- /dev/null
+++ b/docs/modules/ROOT/assets/images/kamelets/http-source.svg
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="420"
+height="420" stroke="#000" fill="none">
+<path stroke-width="26"
+d="M209,15a195,195 0 1,0 2,0z"/>
+<path stroke-width="18"
+d="m210,15v390m195-195H15M59,90a260,260 0 0,0 302,0 m0,240 a260,260 0 0,0-302,0M195,20a250,250 0 0,0 0,382 m30,0 a250,250 0 0,0 0-382"/>
+</svg>
\ No newline at end of file
diff --git a/docs/modules/ROOT/assets/images/kamelets/mqtt-source.svg b/docs/modules/ROOT/assets/images/kamelets/mqtt-source.svg
new file mode 100644
index 0000000..9cad0a1
--- /dev/null
+++ b/docs/modules/ROOT/assets/images/kamelets/mqtt-source.svg
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 24.3.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
+<svg version="1.2" baseProfile="tiny" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px"
+ y="0px" viewBox="0 0 320 320" overflow="visible" xml:space="preserve">
+<g id="black_bg" display="none">
+ <rect display="inline" width="320" height="320"/>
+</g>
+<g id="logos">
+ <g>
+ <path fill="#660066" d="M7.1,180.6v117.1c0,8.4,6.8,15.3,15.3,15.3H142C141,239.8,80.9,180.7,7.1,180.6z"/>
+ <path fill="#660066" d="M7.1,84.1v49.8c99,0.9,179.4,80.7,180.4,179.1h51.7C238.2,186.6,134.5,84.2,7.1,84.1z"/>
+ <path fill="#660066" d="M312.9,297.6V193.5C278.1,107.2,207.3,38.9,119,7.1H22.4c-8.4,0-15.3,6.8-15.3,15.3v15
+ c152.6,0.9,276.6,124,277.6,275.6h13C306.1,312.9,312.9,306.1,312.9,297.6z"/>
+ <path fill="#660066" d="M272.6,49.8c14.5,14.4,28.6,31.7,40.4,47.8V22.4c0-8.4-6.8-15.3-15.3-15.3h-77.3
+ C238.4,19.7,256.6,33.9,272.6,49.8z"/>
+ </g>
+</g>
+</svg>
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index 68a4450..e09c04a 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -2,7 +2,10 @@
* xref:ROOT:index.adoc[Kamelet Catalog]
** xref:ROOT:aws-kinesis-source.adoc[image:kamelets/aws-kinesis-source.svg[] AWS Kinesis Source]
** xref:ROOT:aws-sqs-source.adoc[image:kamelets/aws-sqs-source.svg[] AWS SQS Source]
+** xref:ROOT:bitcoin-source.adoc[image:kamelets/bitcoin-source.svg[] Bitcoin Source]
+** xref:ROOT:http-source.adoc[image:kamelets/http-source.svg[] HTTP Source]
** xref:ROOT:jira-source.adoc[image:kamelets/jira-source.svg[] Jira Source]
+** xref:ROOT:mqtt-source.adoc[image:kamelets/mqtt-source.svg[] MQTT Source]
** xref:ROOT:salesforce-source.adoc[image:kamelets/salesforce-source.svg[] Salesforce Source]
** xref:ROOT:slack-source.adoc[image:kamelets/slack-source.svg[] Slack Source]
** xref:ROOT:telegram-source.adoc[image:kamelets/telegram-source.svg[] Telegram Source]
diff --git a/docs/modules/ROOT/pages/bitcoin-source.adoc b/docs/modules/ROOT/pages/bitcoin-source.adoc
new file mode 100644
index 0000000..19346c4
--- /dev/null
+++ b/docs/modules/ROOT/pages/bitcoin-source.adoc
@@ -0,0 +1,58 @@
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
+= image:kamelets/bitcoin-source.svg[] Bitcoin Source
+
+*Provided by: "Apache Software Foundation"*
+
+Provides a feed of the value of the Bitcoin compared to USDT using the Binance service.
+
+== Configuration Options
+
+The following table summarizes the configuration options available for the `bitcoin-source` Kamelet:
+[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
+|===
+| Property| Name| Description| Type| Default| Example
+| period| Period between updates| The interval between updates in milliseconds| integer| `10000`|
+|===
+
+NOTE: Fields marked with ({empty}*) are mandatory.
+
+== Usage
+
+This section summarizes how the `bitcoin-source` can be used in various contexts.
+
+=== Knative Source
+
+The `bitcoin-source` Kamelet can be used as Knative source by binding it to a Knative object.
+
+.bitcoin-source-binding.yaml
+[source,yaml]
+----
+apiVersion: camel.apache.org/v1alpha1
+kind: KameletBinding
+metadata:
+ name: bitcoin-source-binding
+spec:
+ source:
+ ref:
+ kind: Kamelet
+ apiVersion: camel.apache.org/v1alpha1
+ name: bitcoin-source
+ sink:
+ ref:
+ kind: InMemoryChannel
+ apiVersion: messaging.knative.dev/v1
+ name: mychannel
+
+----
+
+Make sure you have xref:latest@camel-k::installation/installation.html[Camel K installed] into the Kubernetes cluster you're connected to.
+
+Save the `bitcoin-source-binding.yaml` file into your hard drive, then configure it according to your needs.
+
+You can run the source using the following command:
+
+[source,shell]
+----
+kubectl apply -f bitcoin-source-binding.yaml
+----
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
diff --git a/docs/modules/ROOT/pages/http-source.adoc b/docs/modules/ROOT/pages/http-source.adoc
new file mode 100644
index 0000000..45d35b4
--- /dev/null
+++ b/docs/modules/ROOT/pages/http-source.adoc
@@ -0,0 +1,60 @@
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
+= image:kamelets/http-source.svg[] HTTP Source
+
+*Provided by: "Apache Software Foundation"*
+
+Periodically fetches an HTTP resource and provides the content as output.
+
+== Configuration Options
+
+The following table summarizes the configuration options available for the `http-source` Kamelet:
+[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
+|===
+| Property| Name| Description| Type| Default| Example
+| contentType| Content type| The content type of the resource| string| `"application/json"`|
+| period| Period between updates| The interval between fetches in milliseconds| integer| `10000`|
+| url| URL| The URL to fetch for data| string| | `"https://gist.githubusercontent.com/nicolaferraro/e3c72ace3c751f9f88273896611ce5fe/raw/3b6f54060bacb56b6719b7386a4645cb59ad6cc1/quote.json"`
+|===
+
+NOTE: Fields marked with ({empty}*) are mandatory.
+
+== Usage
+
+This section summarizes how the `http-source` can be used in various contexts.
+
+=== Knative Source
+
+The `http-source` Kamelet can be used as Knative source by binding it to a Knative object.
+
+.http-source-binding.yaml
+[source,yaml]
+----
+apiVersion: camel.apache.org/v1alpha1
+kind: KameletBinding
+metadata:
+ name: http-source-binding
+spec:
+ source:
+ ref:
+ kind: Kamelet
+ apiVersion: camel.apache.org/v1alpha1
+ name: http-source
+ sink:
+ ref:
+ kind: InMemoryChannel
+ apiVersion: messaging.knative.dev/v1
+ name: mychannel
+
+----
+
+Make sure you have xref:latest@camel-k::installation/installation.html[Camel K installed] into the Kubernetes cluster you're connected to.
+
+Save the `http-source-binding.yaml` file into your hard drive, then configure it according to your needs.
+
+You can run the source using the following command:
+
+[source,shell]
+----
+kubectl apply -f http-source-binding.yaml
+----
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
diff --git a/docs/modules/ROOT/pages/mqtt-source.adoc b/docs/modules/ROOT/pages/mqtt-source.adoc
new file mode 100644
index 0000000..ef1e07d
--- /dev/null
+++ b/docs/modules/ROOT/pages/mqtt-source.adoc
@@ -0,0 +1,62 @@
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
+= image:kamelets/mqtt-source.svg[] MQTT Source
+
+*Provided by: "Apache Software Foundation"*
+
+Allows receiving messages from any endpoint that supports the MQTT protocol, such as a message broker.
+
+== Configuration Options
+
+The following table summarizes the configuration options available for the `mqtt-source` Kamelet:
+[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
+|===
+| Property| Name| Description| Type| Default| Example
+| *topic {empty}* *| Topic| The topic to subscribe to| string| | `"mytopic"`
+| brokerUrl| Broker URL| The URL of the broker where to establish the connection| string| | `"tcp://mosquitto:1883"`
+| clientId| Client ID| The client ID to use when connecting to the resource| string| `"mqtt-source"`|
+|===
+
+NOTE: Fields marked with ({empty}*) are mandatory.
+
+== Usage
+
+This section summarizes how the `mqtt-source` can be used in various contexts.
+
+=== Knative Source
+
+The `mqtt-source` Kamelet can be used as Knative source by binding it to a Knative object.
+
+.mqtt-source-binding.yaml
+[source,yaml]
+----
+apiVersion: camel.apache.org/v1alpha1
+kind: KameletBinding
+metadata:
+ name: mqtt-source-binding
+spec:
+ source:
+ ref:
+ kind: Kamelet
+ apiVersion: camel.apache.org/v1alpha1
+ name: mqtt-source
+ properties:
+ topic: "mytopic"
+ sink:
+ ref:
+ kind: InMemoryChannel
+ apiVersion: messaging.knative.dev/v1
+ name: mychannel
+
+----
+
+Make sure you have xref:latest@camel-k::installation/installation.html[Camel K installed] into the Kubernetes cluster you're connected to.
+
+Save the `mqtt-source-binding.yaml` file into your hard drive, then configure it according to your needs.
+
+You can run the source using the following command:
+
+[source,shell]
+----
+kubectl apply -f mqtt-source-binding.yaml
+----
+// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
diff --git a/http-source.kamelet.yaml b/http-source.kamelet.yaml
index f16a890..a656693 100644
--- a/http-source.kamelet.yaml
+++ b/http-source.kamelet.yaml
@@ -36,6 +36,6 @@ spec:
steps:
- set-header:
name: "Accept"
- constant: {{contentType}}
+ constant: "{{contentType}}"
- to: "netty-http:{{url}}"
- to: "kamelet:sink"