sftp sink SFTP Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send data to an SFTP Server.

In the header, you can set the file / ce-file property to specify the filename to upload.

If you do not set the property in the header, the Kamelet uses the exchange ID for the filename.

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 The hostname of the FTP server.

string

connectionPort

Connection Port

Required The port of the FTP server.

string

22

directoryName

Directory Name

Required The starting directory.

string

binary

Binary

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).

boolean

false

fileExist

File Existence

How to behave in case of file already existent. There are 4 enums. Possible values are Override, Append, Fail, or Ignore.

string

Override

passiveMode

Passive Mode

Specifies to use passive mode connection.

boolean

false

password

Password

The password to access the FTP server.

string

privateKeyFile

Private Key File

Set the private key file so that the SFTP endpoint can do private key verification.

string

privateKeyPassphrase

Private Key Passphrase

Set the private key file passphrase so that the SFTP endpoint can do private key verification.

string

privateKeyUri

Private Key URI

Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification.

string

strictHostKeyChecking

Strict Host Checking

Sets whether to use strict host key checking.

string

no

useUserKnownHostsFile

Use User Known Hosts File

If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts.

boolean

true

username

Username

The username to access the FTP server.

string

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

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" 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

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" 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