Important
You are viewing documentation for an older version of Confluent Platform. For the latest, click here.
FTPS Connector (Source and Sink) for Confluent Platform¶
The Kafka Connect FTPS connector is used to integrate with FTPS servers. The Kafka Connect FTPS Source Connector provides the capability to watch a directory on an FTPS server for files and read the data as new files are written to the FTPS input directory. Each record in the input file is converted based on the user-supplied schema or an auto-generated schema and sent to a Apache Kafka® topic. The Kafka Connect FTPS Sink Connector provides the capability to export data from Apache Kafka® topics to files in an FTPS servers directory. Supported formats are CSV/TSV, Avro, JSON and Parquet. The FTPS Sink connector periodically polls data from Kafka and in turn writes it to the FTPS files.
Install the FTPS Connector¶
The FTPS connector is compatible with Confluent Platform from version 4.1 (and later). Prior versions do not work with this connector.
You can install this connector by using the Confluent Hub client (recommended) or you can manually download the ZIP file.
Install the connector using Confluent Hub¶
- Prerequisite
- Confluent Hub Client must be installed. This is installed by default with Confluent Enterprise.
Navigate to your Confluent Platform installation directory and run the following command to install the latest (latest) connector version. The connector must be installed on every machine where Connect will run.
confluent-hub install confluentinc/kafka-connect-ftps:latest
You can install a specific version by replacing latest with a version number. For example:
confluent-hub install confluentinc/kafka-connect-ftps:1.1.0-preview
Install the connector manually¶
Download and extract the ZIP file for your connector and then follow the manual connector installation instructions.
License¶
You can use this connector for a 30-day trial period without a license key.
After 30 days, this connector is available under a Confluent enterprise license. Confluent issues enterprise license keys to subscribers, along with providing enterprise-level support for Confluent Platform and your connectors. If you are a subscriber, please contact Confluent Support at support@confluent.io for more information.
See Confluent Licensing and Confluent Licensing for license properties and License topic configuration and License topic configuration for information about the license topic.
Configuration Properties¶
For a complete list of configuration properties for the source connector, see FTPS Source Connector Configuration Properties.
For a complete list of configuration properties for the sink connector, see FTPS Sink Connector Configuration Properties.