ssh source SSH Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive data from SSH session.

Configuration Options

The following table summarizes the configuration options available for the ssh-source Kamelet:

Property Name Description Type Default Example

connectionHost

Connection Host

Required The SSH Host.

string

connectionPort

Connection Port

Required The SSH Port.

string

22

password

Password

Required The SSH password to use.

string

pollCommand

Poll Command

Required The command to run while polling the SSH session.

string

date

username

Username

Required The SSH username to use.

string

delay

Delay

The number of milliseconds before the next poll.

integer

500

Dependencies

At runtime, the ssh-source Kamelet relies upon the presence of the following dependencies:

  • camel:ssh

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the ssh-source.

Knative source

You can use the ssh-source Kamelet as a Knative source by binding it to a Knative object.

ssh-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: ssh-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: ssh-source
    properties:
      connectionHost: The Connection Host
      connectionPort: The Connection Port
      password: The Password
      pollCommand: date
      username: The Username
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the ssh-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f ssh-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind channel:mychannel -p "source.connectionHost=The Connection Host" -p "source.connectionPort=The Connection Port" -p "source.password=The Password" -p "source.pollCommand=date" -p "source.username=The Username" ssh-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

You can use the ssh-source Kamelet as a Kafka source by binding it to a Kafka topic.

ssh-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: ssh-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: ssh-source
    properties:
      connectionHost: The Connection Host
      connectionPort: The Connection Port
      password: The Password
      pollCommand: date
      username: The Username
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the ssh-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f ssh-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "source.connectionHost=The Connection Host" -p "source.connectionPort=The Connection Port" -p "source.password=The Password" -p "source.pollCommand=date" -p "source.username=The Username" ssh-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/ssh-source.kamelet.yaml

Back to top