Chapter 53. SFTP Sink

Send data to an SFTP Server.

The Kamelet expects the following headers to be set:

  • file / ce-file: as the file name to upload

If the header won’t be set the exchange ID will be used as file name.

53.1. Configuration Options

The following table summarizes the configuration options available for the sftp-sink Kamelet:

PropertyNameDescriptionTypeDefaultExample

connectionHost *

Connection Host

Hostname of the FTP server

string

  

connectionPort *

Connection Port

Port of the FTP server

string

22

 

directoryName *

Directory Name

The starting directory

string

  

password *

Password

The password to access the FTP server

string

  

username *

Username

The username to access the FTP server

string

  

fileExist

File Existence

How to behave in case of file already existent. There are 4 enums and the value can be one of Override, Append, Fail or Ignore

string

"Override"

 

passiveMode

Passive Mode

Sets passive mode connection

boolean

false

 
Note

Fields marked with an asterisk (*) are mandatory.

53.2. Dependencies

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

  • camel:ftp
  • camel:core
  • camel:kamelet

53.3. Usage

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

53.3.1. Knative Sink

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

sftp-sink-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: sftp-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: sftp-sink
    properties:
      connectionHost: "The Connection Host"
      directoryName: "The Directory Name"
      password: "The Password"
      username: "The Username"

53.3.1.1. Prerequisite

Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

53.3.1.2. Procedure for using the cluster CLI

  1. Save the sftp-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: 

    oc apply -f sftp-sink-binding.yaml

53.3.1.3. Procedure for using the Kamel CLI

Configure and run the sink by using the following command: 

kamel bind channel:mychannel sftp-sink -p "sink.connectionHost=The Connection Host" -p "sink.directoryName=The Directory Name" -p "sink.password=The Password" -p "sink.username=The Username"

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

53.3.2. Kafka Sink

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

sftp-sink-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: sftp-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: sftp-sink
    properties:
      connectionHost: "The Connection Host"
      directoryName: "The Directory Name"
      password: "The Password"
      username: "The Username"

53.3.2.1. Prerequisites

Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

53.3.2.2. Procedure for using the cluster CLI

  1. Save the sftp-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: 

    oc apply -f sftp-sink-binding.yaml

53.3.2.3. Procedure for using the Kamel CLI

Configure and run the sink by using the following command: 

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic sftp-sink -p "sink.connectionHost=The Connection Host" -p "sink.directoryName=The Directory Name" -p "sink.password=The Password" -p "sink.username=The Username"

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

53.4. Kamelet source file

https://github.com/openshift-integration/kamelet-catalog/tree/kamelet-catalog-1.8//sftp-sink.kamelet.yaml