ftp source FTP Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive data from an FTP server.

Configuration Options

The following table summarizes the configuration options available for the ftp-source 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

21

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

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

passiveMode

Passive Mode

Specifes to use passive mode connection.

boolean

false

recursive

Recursive

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

boolean

false

Dependencies

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

Knative source

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

ftp-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: ftp-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: ftp-source
    properties:
      connectionHost: The Connection Host
      connectionPort: The Connection Port
      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 ftp-source-pipe.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 ftp-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" -p "source.password=The Password" -p "source.username=The Username" ftp-source

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

Kafka source

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

ftp-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: ftp-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: ftp-source
    properties:
      connectionHost: The Connection Host
      connectionPort: The Connection Port
      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 ftp-source-pipe.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 ftp-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" -p "source.password=The Password" -p "source.username=The Username" ftp-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/ftp-source.kamelet.yaml

Back to top