Chapter 19. FTP Source
Receive data from an FTP Server.
19.1. Configuration Options
The following table summarizes the configuration options available for the ftp-source Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
| connectionHost * | Connection Host | Hostname of the FTP server | string | ||
| connectionPort * | Connection Port | Port of the FTP server | string |
| |
| directoryName * | Directory Name | The starting directory | string | ||
| password * | Password | The password to access the FTP server | string | ||
| username * | Username | The username to access the FTP server | string | ||
| idempotent | Idempotency | Skip already processed files. | boolean |
| |
| passiveMode | Passive Mode | Sets passive mode connection | boolean |
| |
| recursive | Recursive | If a directory, will look for files in all the sub-directories as well. | boolean |
|
Fields marked with an asterisk (*) are mandatory.
19.2. Dependencies
At runtime, the ftp-source Kamelet relies upon the presence of the following dependencies:
- camel:ftp
- camel:core
- camel:kamelet
19.3. Usage
This section describes how you can use the ftp-source.
19.3.1. Knative Source
You can use the ftp-source Kamelet as a Knative source by binding it to a Knative object.
ftp-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: ftp-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: ftp-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
19.3.1.1. Prerequisite
Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
19.3.1.2. Procedure for using the cluster CLI
-
Save the
ftp-source-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the source by using the following command:
oc apply -f ftp-source-binding.yaml
19.3.1.3. Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind ftp-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.
19.3.2. Kafka Source
You can use the ftp-source Kamelet as a Kafka source by binding it to a Kafka topic.
ftp-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: ftp-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: ftp-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
19.3.2.1. Prerequisites
Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
19.3.2.2. Procedure for using the cluster CLI
-
Save the
ftp-source-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the source by using the following command:
oc apply -f ftp-source-binding.yaml
19.3.2.3. Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind ftp-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.
