Skip to content

Commit

Permalink
chore: regen doc
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolaferraro committed Feb 15, 2021
1 parent 0925c4e commit 300538e
Show file tree
Hide file tree
Showing 8 changed files with 217 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/modules/ROOT/assets/images/kamelets/bitcoin-source.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/modules/ROOT/assets/images/kamelets/http-source.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/modules/ROOT/assets/images/kamelets/mqtt-source.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
58 changes: 58 additions & 0 deletions docs/modules/ROOT/pages/bitcoin-source.adoc
Original file line number Diff line number Diff line change
@@ -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
60 changes: 60 additions & 0 deletions docs/modules/ROOT/pages/http-source.adoc
Original file line number Diff line number Diff line change
@@ -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
62 changes: 62 additions & 0 deletions docs/modules/ROOT/pages/mqtt-source.adoc
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion http-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ spec:
steps:
- set-header:
name: "Accept"
constant: {{contentType}}
constant: "{{contentType}}"
- to: "netty-http:{{url}}"
- to: "kamelet:sink"

0 comments on commit 300538e

Please sign in to comment.