ssh sink SSH Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send command through SSH session.

Configuration Options

The following table summarizes the configuration options available for the ssh-sink 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

username

Username

Required The SSH username to use.

string

Dependencies

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

  • camel:ssh

  • camel:gson

  • camel:kamelet

Usage

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

Knative sink

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

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

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

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

  2. Run the sink by using the following command:

    kubectl apply -f ssh-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

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

This command creates the KameletBinding in the current namespace on the cluster.

Kafka sink

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

ssh-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: ssh-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: ssh-sink
    properties:
      connectionHost: The Connection Host
      connectionPort: The Connection Port
      password: The Password
      username: The Username

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-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f ssh-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

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

This command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

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

Back to top