Skip to content

Commit

Permalink
Added SSH Source Kamelet
Browse files Browse the repository at this point in the history
  • Loading branch information
oscerd authored and nicolaferraro committed Mar 19, 2021
1 parent d3597cd commit 1207414
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/modules/ROOT/assets/images/kamelets/ssh-source.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
* xref:ROOT:salesforce-source.adoc[image:kamelets/salesforce-source.svg[] Salesforce Source]
* xref:ROOT:sftp-source.adoc[image:kamelets/sftp-source.svg[] SFTP Source]
* xref:ROOT:slack-source.adoc[image:kamelets/slack-source.svg[] Slack Source]
* xref:ROOT:ssh-source.adoc[image:kamelets/ssh-source.svg[] SSH Source]
* xref:ROOT:telegram-sink.adoc[image:kamelets/telegram-sink.svg[] Telegram Sink]
* xref:ROOT:telegram-source.adoc[image:kamelets/telegram-source.svg[] Telegram Source]
* xref:ROOT:timer-source.adoc[image:kamelets/timer-source.svg[] Timer Source]
Expand Down
68 changes: 68 additions & 0 deletions docs/modules/ROOT/pages/ssh-source.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/ssh-source.svg[] SSH Source

*Provided by: "Apache Software Foundation"*

Receive data from SSH session.

== Configuration Options

The following table summarizes the configuration options available for the `ssh-source` Kamelet:
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *host {empty}* *| SSH Host| The SSH Host| string| |
| *password {empty}* *| The SSH password| The SSH password to use| string| |
| *pollCommand {empty}* *| The Poll command| The command to run while polling the SSH session| string| | `"date"`
| *port {empty}* *| SSH Port| The SSH Port| string| `22`|
| *username {empty}* *| The SSH username| The SSH username to use| string| |
| delay| Delay| Milliseconds before the next poll| integer| `500`|
|===

NOTE: Fields marked with ({empty}*) are mandatory.

== Usage

This section summarizes how the `ssh-source` can be used in various contexts.

=== Knative Source

The `ssh-source` Kamelet can be used as Knative source by binding it to a Knative object.

.ssh-source-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: ssh-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: ssh-source
properties:
host: "The SSH Host"
password: "The The SSH password"
pollCommand: "date"
username: "The The SSH username"
sink:
ref:
kind: InMemoryChannel
apiVersion: messaging.knative.dev/v1
name: mychannel
----

Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.

Save the `ssh-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 ssh-source-binding.yaml
----
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT

0 comments on commit 1207414

Please sign in to comment.