SERVICENOW SOURCE AND SINK
To use this connector, specify the name of the connector class in the connector.class configuration property.
connector.class
connector.class=io.confluent.connect.sftp.SftpSinkConnector
Connector-specific configuration properties are described below.
format.class
The format class to use when writing data to the store.
flush.size
Number of records written to store before invoking file commits.
rotate.interval.ms
The time interval in milliseconds to invoke file commits. This configuration ensures that file commits are invoked every configured interval. This configuration is useful when data ingestion rate is low and the connector didn’t write enough messages to commit files. The default value -1 means that this feature is disabled.
rotate.schedule.interval.ms
The time interval in milliseconds to periodically invoke file commits. This configuration ensures that file commits are invoked every configured interval. Time of commit will be adjusted to 00:00 of selected timezone. Commit will be performed at scheduled time regardless previous commit time or number of messages. This configuration is useful when you have to commit your data based on current server time, like at the beginning of every hour. The default value -1 means that this feature is disabled.
The following Avro converter properties can be used in the connector configuration:
schema.cache.config
The size of the schema cache used in the Avro converter.
enhanced.avro.schema.support
Enable enhanced Avro schema support in the Avro Converter. When set to true, this property preserves Avro schema package information and Enums when going from Avro schema to Connect schema. This information is added back in when going from Connect schema to Avro schema.
true
connect.meta.data
Allow the Connect converter to add its metadata to the output schema.
The connect.meta.data property preserves the following Connect schema metadata when going from Connect schema to Avro schema. The following metadata is added back in when going from Avro schema to Connect schema.
For detailed information and configuration examples for Avro converters listed above, see Using Kafka Connect with Schema Registry.
retry.backoff.ms
The retry backoff in milliseconds. This config is used to notify Kafka connect to retry delivering a message batch or performing recovery in case of transient exceptions.
filename.offset.zero.pad.width
Width to zero-pad offsets in store’s filenames if offsets are too short in order to provide fixed-width filenames that can be ordered by simple lexicographic sorting.
avro.codec
The Avro compression codec to be used for output files. Available values: null, deflate, snappy and bzip2 (CodecSource is org.apache.avro.file.CodecFactory)
schema.compatibility
The schema compatibility rule to use when the connector is observing schema changes. The supported configurations are NONE, BACKWARD, FORWARD and FULL.
sftp.host
Sftp host to connect with
sftp.port
Port number of SFTP server
sftp.username
Username for sftp server
sftp.password
Password for sftp server
sftp.proxy.url
Proxy url for sftp connection.
proxy.username
Proxy username for sftp server if proxy is to used
proxy.password
Proxy password for sftp server if proxy is to used
sftp.compression.type
Compression type for file written to sftp. Applied when using JsonFormat or ByteArrayFormat. Available values: none, gzip.
sftp.working.dir
Home directory on SFTP server.This will be the top most directory that will contain all the files
tls.private.key
Private key that will be used for public-key authentication.
tls.public.key
Public key that will be used to decrypt the private key if the given private key is encrypted.
Note
When authenticating with SSL:
'\r\n'
For example:
RSA_PRIVATE_KEY=$(awk '{printf "%s\\r\\n", $0}' ssh_host_rsa_key)
tls.passphrase
Passphrase that will be used to decrypt the private key if the given private key is encrypted.
Important
The SFTP Sink Connector will fail if tls.passphrase is empty.
tls.pemfile
Path to pemfile.
storage.class
The underlying storage layer.
topics.dir
Top level directory to store the data ingested from Kafka.
store.url
Store’s connection URL, if applicable.
directory.delim
Directory delimiter pattern
file.delim
File delimiter pattern
partitioner.class
The partitioner to use when writing data to the store. You can use DefaultPartitioner, which preserves the Kafka partitions; FieldPartitioner, which partitions the data to different directories according to the value of the partitioning field specified in partition.field.name; TimeBasedPartitioner, which partitions data according to ingestion time.
DefaultPartitioner
FieldPartitioner
partition.field.name
TimeBasedPartitioner
partition.duration.ms
path.format
locale
timezone
The name of the partitioning field when FieldPartitioner is used.
The duration of a partition milliseconds used by TimeBasedPartitioner. The default value -1 means that we are not using TimeBasedPartitioner.
This configuration is used to set the format of the data directories when partitioning with TimeBasedPartitioner. The format set in this configuration converts the Unix timestamp to proper directories strings. For example, if you set path.format='year'=YYYY/'month'=MM/'day'=dd/'hour'=HH, the data directories will have the format /year=2015/month=12/day=07/hour=15/.
path.format='year'=YYYY/'month'=MM/'day'=dd/'hour'=HH
/year=2015/month=12/day=07/hour=15/
The locale to use when partitioning with TimeBasedPartitioner. Used to format dates and times. For example, use en-US for US English, en-GB for UK English, or fr-FR for French (in France). These may vary by Java version. See the available locales.
en-US
en-GB
fr-FR
The timezone to use when partitioning with TimeBasedPartitioner. Used to format and compute dates and times. All timezone IDs must be specified in the long format, such as America/Los_Angeles, America/New_York, and Europe/Paris, or UTC. Alternatively a locale independent, fixed offset, datetime zone can be specified in form [+-]hh:mm. Support for these timezones may vary by Java version. See the available timezones within each locale, such as those within the US English locale.
America/Los_Angeles
America/New_York
Europe/Paris
UTC
[+-]hh:mm
timestamp.extractor
The extractor that gets the timestamp for records when partitioning with TimeBasedPartitioner. It can be set to Wallclock, Record or RecordField in order to use one of the built-in timestamp extractors or be given the fully-qualified class name of a user-defined class that extends the TimestampExtractor interface.
Wallclock
Record
RecordField
TimestampExtractor
timestamp.field
The record field to be used as timestamp by the timestamp extractor.
confluent.topic.bootstrap.servers
A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the form <code>host1:port1,host2:port2,…</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).
confluent.topic
Name of the Kafka topic used for Confluent Platform configuration, including licensing information.
confluent.topic.replication.factor
The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).
Tip
While it is possible to include license-related properties in the connector configuration, starting with Confluent Platform version 6.0, you can now put license-related properties in the Connect worker configuration instead of in each connector configuration.
This connector is proprietary and requires a license. The license information is stored in the _confluent-command topic. If the broker requires SSL for connections, you must include the security-related confluent.topic.* properties as described below.
_confluent-command
confluent.topic.*
confluent.license
Confluent issues enterprise license keys to each subscriber. The license key is text that you can copy and paste as the value for confluent.license. A trial license allows using the connector for a 30-day trial period. A developer license allows using the connector indefinitely for single-broker development environments.
If you are a subscriber, please contact Confluent Support for more information.
confluent.topic.ssl.truststore.location
The location of the trust store file.
confluent.topic.ssl.truststore.password
The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled.
confluent.topic.ssl.keystore.location
The location of the key store file. This is optional for client and can be used for two-way authentication for client.
confluent.topic.ssl.keystore.password
The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured.
confluent.topic.ssl.key.password
The password of the private key in the key store file. This is optional for client.
confluent.topic.security.protocol
Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.
A Confluent enterprise license is stored in the _confluent-command topic. This topic is created by default and contains the license that corresponds to the license key supplied through the confluent.license property.
No public keys are stored in Kafka topics.
The following describes how the default _confluent-command topic is generated under different scenarios:
_confluent command
confluent.license=
confluent.license=<valid-license-key>
Here is an example of the minimal properties for development and testing.
You can change the name of the _confluent-command topic using the confluent.topic property (for instance, if your environment has strict naming conventions). The example below shows this change and the configured Kafka bootstrap server.
confluent.topic=foo_confluent-command confluent.topic.bootstrap.servers=localhost:9092
The example above shows the minimally required bootstrap server property that you can use for development and testing. For a production environment, you add the normal producer, consumer, and topic configuration properties to the connector properties, prefixed with confluent.topic..
confluent.topic.
The _confluent-command topic contains the license that corresponds to the license key supplied through the confluent.license property. It is created by default. Connectors that access this topic require the following ACLs configured:
You can provide access either individually for each principal that will use the license or use a wildcard entry to allow all clients. The following examples show commands that you can use to configure ACLs for the resource cluster and _confluent-command topic.
Set a CREATE and DESCRIBE ACL on the resource cluster:
kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User:<principal> \ --operation CREATE --operation DESCRIBE --cluster
Set a DESCRIBE, READ, and WRITE ACL on the _confluent-command topic:
kafka-acls --bootstrap-server localhost:9092 --command-config adminclient-configs.conf \ --add --allow-principal User:<principal> \ --operation DESCRIBE --operation READ --operation WRITE --topic _confluent-command
You can override the replication factor using confluent.topic.replication.factor. For example, when using a Kafka cluster as a destination with less than three brokers (for development and testing) you should set the confluent.topic.replication.factor property to 1.
1
You can override producer-specific properties by using the confluent.topic.producer. prefix and consumer-specific properties by using the confluent.topic.consumer. prefix.
confluent.topic.producer.
confluent.topic.consumer.
You can use the defaults or customize the other properties as well. For example, the confluent.topic.client.id property defaults to the name of the connector with -licensing suffix. You can specify the configuration settings for brokers that require SSL or SASL for client connections using this prefix.
confluent.topic.client.id
-licensing
You cannot override the cleanup policy of a topic because the topic always has a single partition and is compacted. Also, do not specify serializers and deserializers using this prefix; they are ignored if added.