SFTP Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive data from an SFTP server.

Configuration Options

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

Property	Name	Description	Type	Default
connectionHost	Connection Host	Required The hostname of the SFTP server.	string
connectionPort	Connection Port	Required The port of the FTP server.	string	22
directoryName	Directory Name	Required The starting directory.	string
autoCreate	Autocreate Missing Directories	Automatically create starting directory.	boolean	true
binary	Binary	Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).	boolean	false
delete	Delete	If true, the file will be deleted after it is processed successfully.	boolean	false
idempotent	Idempotency	Skip already-processed files.	boolean	true
ignoreFileNotFoundOrPermissionError	Ignore File Not Found Or Permission Error	Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exists or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead.	boolean	false
passiveMode	Passive Mode	Sets the passive mode connection.	boolean	false
password	Password	The password to access the SFTP 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
recursive	Recursive	If a directory, look for files in all sub-directories as well.	boolean	false
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 SFTP server.	string

Property

Name

Description

Type

Default

Example

connectionHost

Connection Host

Required The hostname of the SFTP server.

string

connectionPort

Connection Port

Required The port of the FTP server.

string

directoryName

Directory Name

Required The starting directory.

string

autoCreate

Autocreate Missing Directories

Automatically create starting directory.

boolean

true

binary

Binary

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

boolean

false

delete

Delete

If true, the file will be deleted after it is processed successfully.

boolean

false

idempotent

Idempotency

Skip already-processed files.

boolean

true

ignoreFileNotFoundOrPermissionError

Ignore File Not Found Or Permission Error

Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exists or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead.

boolean

false

passiveMode

Passive Mode

Sets the passive mode connection.

boolean

false

password

Password

The password to access the SFTP 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

recursive

Recursive

If a directory, look for files in all sub-directories as well.

boolean

false

strictHostKeyChecking

Strict Host Checking

Sets whether to use strict host key checking.

string

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 SFTP server.

string

Dependencies

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

camel:ftp
camel:core
camel:kamelet

Camel JBang usage

Prerequisites

You’ve installed JBang.
You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

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

Knative source

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

sftp-source-pipe.yaml

apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: sftp-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: sftp-source
    properties:
      connectionHost: The Connection Host
      connectionPort: The Connection Port
      directoryName: The Directory Name
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

Save the sftp-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.
Run the source by using the following command:
```
kubectl apply -f sftp-source-pipe.yaml
```

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind channel:mychannel -p "source.connectionHost=The Connection Host" -p "source.connectionPort=The Connection Port" -p "source.directoryName=The Directory Name" sftp-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

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

sftp-source-pipe.yaml

apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: sftp-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: sftp-source
    properties:
      connectionHost: The Connection Host
      connectionPort: The Connection Port
      directoryName: The Directory Name
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

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

Save the sftp-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.
Run the source by using the following command:
```
kubectl apply -f sftp-source-pipe.yaml
```

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "source.connectionHost=The Connection Host" -p "source.connectionPort=The Connection Port" -p "source.directoryName=The Directory Name" sftp-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

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