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 an asterisk (*) are mandatory.

Dependencies

At runtime, the `sftp-source 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-source.

Knative Source

You can use the sftp-source Kamelet as a 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: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the sftp-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f sftp-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following 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 command creates the KameletBinding 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-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

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-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f sftp-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following 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 command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

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

Back to top