sftp sink SFTP Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

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.

Configuration Options

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

Property Name Description Type Default Example

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
Fields marked with (*) are mandatory.

Usage

This section summarizes how the sftp-sink can be used in various contexts.

Knative Sink

The sftp-sink Kamelet can be used as 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"

Make sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the sftp-sink-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the sink using the following command:

kubectl apply -f sftp-sink-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:ftp

  • camel:core

  • camel:kamelet

Binding to Knative using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind 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 will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Sink

The sftp-sink Kamelet can be used as 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"

Ensure that you’ve installed Strimzi and created a topic named my-topic in the current namespace. Make also sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the sftp-sink-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the sink using the following command:

kubectl apply -f sftp-sink-binding.yaml

Binding to Kafka using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind 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 will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kamelet source file

Have a look at the following link:

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

Back to top