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

Required Hostname of the FTP server.

string

connectionPort

Connection Port

Required Port of the FTP server.

string

22

directoryName

Directory Name

Required The starting directory.

string

password

Password

Required The password to access the FTP server.

string

username

Username

Required 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

Dependencies

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

  • camel:ftp

  • camel:core

  • camel:kamelet

Usage

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

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
      connectionPort: The Connection Port
      directoryName: The Directory Name
      password: The Password
      username: The Username

Prerequisite

You have Camel K installed on the cluster.

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:

    kubectl apply -f sftp-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind sftp-sink -p "sink.connectionHost=The Connection Host" -p "sink.connectionPort=The Connection Port" -p "sink.directoryName=The Directory Name" -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 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
      connectionPort: The Connection Port
      directoryName: The Directory Name
      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 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:

    kubectl apply -f sftp-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind sftp-sink -p "sink.connectionHost=The Connection Host" -p "sink.connectionPort=The Connection Port" -p "sink.directoryName=The Directory Name" -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/sftp-sink.kamelet.yaml

Back to top