sftp source SFTP Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

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 Example

connectionHost *

Connection Host

Hostname of the SFTP 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 SFTP server

string

username *

Username

The username to access the SFTP server

string

idempotent

Idempotency

Skip already processed files.

boolean

true

passiveMode

Passive Mode

Sets passive mode connection

boolean

false

recursive

Recursive

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

boolean

false

Fields marked with (*) are mandatory.

Usage

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

Knative Source

The sftp-source Kamelet can be used as Knative source by binding it to a Knative object.

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

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

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

You can run the source using the following command:

kubectl apply -f sftp-source-binding.yaml

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 sftp-source -p "source.connectionHost=The Connection Host" -p "source.directoryName=The Directory Name" -p "source.password=The Password" -p "source.username=The Username" channel/mychannel

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Source

The sftp-source Kamelet can be used as Kafka source by binding it to a Kafka topic.

sftp-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: sftp-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: sftp-source
    properties:
      connectionHost: "The Connection Host"
      directoryName: "The Directory Name"
      password: "The Password"
      username: "The Username"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

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-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f sftp-source-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 sftp-source -p "source.connectionHost=The Connection Host" -p "source.directoryName=The Directory Name" -p "source.password=The Password" -p "source.username=The Username" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.