Configuration Reference for Marketo Source Connector for Confluent Platform

To use this connector, specify the name of the connector class in the connector.class configuration property. Confluent recommends you initialize the configuration parameter tasks.max to use the same number of entities specified in the entity.names configuration property of the connector, treating all activities activity types as a single entity.

connector.class=io.confluent.connect.marketo.MarketoSourceConnector

Connector-specific configuration properties are described below.

Marketo

marketo.url

Marketo server hostname/URL to which the Kafka source connector connects.

  • Type: string

  • Valid Values: URI with one of these schemes: ‘http’, ‘https’

  • Importance: high

entity.names

The Marketo entities that are to be exported from Marketo and written to Kafka.

  • Type: list

  • Valid Values: one of [leads, programs, staticLists, campaigns, activities_<activityType>]. Here, activities can be listed as activities_add_to_nurture, activities_add_to_opportunity , etc.

  • Importance: high

marketo.since

ISO 8601 format of the starting time from whence the data should be exported to Kafka topics; only used during the first run of a connector. Any eventual restart of the connector would use the committed entity offset, if any. The datetime can include the offset but not the time zone (Refer to Marketo Field types for the datetime format.)

  • Type: string

  • Default: If the start datetime isn’t provided, then the current datetime when connector is started will be used as a default value. It will fetch the records updated and created from the time connector starts.

  • Valid Values: either blank, or timestamp in one of these formats: YYYY-MM-DD, YYYY-MM-DD'T'hh:mm:ss, YYYY-MM-DD'T'hh:mm:ssTZD` (where TZD is ``+hh:mm or -hh:mm).

  • Importance: medium

Topics

topic.name.pattern

The pattern to use for the topic name, where the ${entityName} literal will be replaced with each entity name. For example, a value such as marketo_topic_${entityName} with tables leads and campaigns would create two topics marketo_topic_leads and marketo_topic_campaigns, and ensure that table leads is exported to topic marketo_topic_leads, etc. Further, if the entity.names config contains any activities entities like activities_add_to_nurture, or activities_add_to_opportunity, then all such entities are grouped into a single topic marketo_topic_activities from the previous example. For all the activities entities, Kafka records will be directed to a single topic where ${entityName} is populated to activities.

  • Type: string

  • Default: ${entityName}

  • Importance: high

Limits

max.batch.size

The maximum number of records that should be returned and written to Kafka at once.

  • Type: int

  • Default: 100

  • Valid Values: [1,…,2147483647]

  • Importance: high

max.in.flight.requests

The maximum number of requests that may be in-flight at once.

  • Type: int

  • Default: 10

  • Valid Values: [1,…,200]

  • Importance: high

max.poll.interval.ms

The time in milliseconds to wait while polling for a full batch of records.

  • Type: long

  • Default: 100

  • Valid Values: [1,…,300000]

  • Importance: medium

request.interval.ms

The time in milliseconds to wait before checking for updated records.

  • Type: long

  • Default: 15000

  • Valid Values: [1,…,2147483647]

  • Importance: medium

Retries

max.retries

The maximum number of times to retry on errors before failing the task.

  • Type: int

  • Default: 10

  • Valid Values: [0,…,10]

  • Importance: medium

retry.backoff.ms

The time in milliseconds to wait following an error before a retry attempt is made.

  • Type: int

  • Default: 3000

  • Valid Values: [0,…,3600000]

  • Importance: medium

Authorization

oauth2.client.id

The client ID used when fetching OAuth2 token from the Marketo server instance.

  • Type: string

  • Valid Values: non-null string

  • Importance: high

oauth2.client.secret

The secret used when fetching the OAuth2 token.

  • Type: password

  • Valid Values: non-null string

  • Importance: high

SSL

https.ssl.enabled

Indicates whether or not to connect to the endpoint using SSL.

  • Type: boolean

  • Default: false

  • Importance: high

  • Dependents: https.ssl.protocol, https.ssl.provider, https.ssl.cipher.suites, https.ssl.enabled.protocols, https.ssl.keystore.type, https.ssl.keystore.location, https.ssl.keystore.password, https.ssl.key.password, https.ssl.truststore.type, https.ssl.truststore.location, https.ssl.truststore.password, https.ssl.keymanager.algorithm, https.ssl.trustmanager.algorithm, https.ssl.endpoint.identification.algorithm, https.ssl.secure.random.implementation

https.ssl.protocol

The SSL protocol used to generate the SSLContext. The default setting is TLS, which is fine for most cases. Allowed values in recent JVMs are: TLS, TLSv1.1, and TLSv1.2. SSL, SSLv2, and SSLv3 may be supported in older JVMs, but their use is discouraged due to known security vulnerabilities.

  • Type: string

  • Default: TLS

  • Importance: medium

https.ssl.provider

The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.

  • Type: string

  • Default: null

  • Importance: medium

https.ssl.cipher.suites

A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default all the available cipher suites are supported.

  • Type: list

  • Default: null

  • Importance: low

https.ssl.enabled.protocols

The list of protocols enabled for SSL connections.

  • Type: list

  • Default: TLSv1.2,TLSv1.1,TLSv1

  • Importance: medium

https.ssl.keystore.type

The file format of the key store file. This is optional for the client.

  • Type: string

  • Default: JKS

  • Importance: medium

https.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.

  • Type: string

  • Default: null

  • Importance: high

https.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.

  • Type: password

  • Default: null

  • Importance: high

https.ssl.key.password

The password of the private key in the key store file. This is optional for client.

  • Type: password

  • Default: null

  • Importance: high

https.ssl.truststore.type

The file format of the trust store file.

  • Type: string

  • Default: JKS

  • Importance: medium

https.ssl.truststore.location

The location of the trust store file.

  • Type: string

  • Default: null

  • Importance: high

https.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.

  • Type: password

  • Default: null

  • Importance: high

https.ssl.keymanager.algorithm

The algorithm used by key manager factory for SSL connections. The default value is the key manager factory algorithm configured for the Java Virtual Machine.

  • Type: string

  • Default: SunX509

  • Importance: low

https.ssl.trustmanager.algorithm

The algorithm used by trust manager factory for SSL connections. The default value is the trust manager factory algorithm configured for the Java Virtual Machine.

  • Type: string

  • Default: PKIX

  • Importance: low

https.ssl.endpoint.identification.algorithm

The endpoint identification algorithm to validate the server hostname using a server certificate.

  • Type: string

  • Default: https

  • Importance: low

https.ssl.secure.random.implementation

The SecureRandom PRNG implementation to use for SSL cryptography operations.

  • Type: string

  • Default: null

  • Importance: low

Proxy

http.proxy.host

The host or IP of the HTTP proxy.

  • Type: string

  • Default: “”

  • Importance: high

http.proxy.port

The port number of the HTTP proxy.

  • Type: int

  • Default: 0

  • Valid Values: [0,…,65535]

  • Importance: high

http.proxy.user

The username to be used when authenticating with the HTTP proxy.

  • Type: string

  • Default: “”

  • Importance: high

http.proxy.password

The password to be used when authenticating with the HTTP proxy.

  • Type: password

  • Default: [hidden]

  • Importance: high

Confluent Platform license

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 host1:port1,host2:port2,.... 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).

  • Type: list

  • Importance: high

confluent.topic Name of the Kafka topic used for Confluent Platform configuration, including licensing information.

  • Type: string

  • Default: _confluent-command

  • Importance: low

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).

  • Type: int

  • Default: 3

  • Importance: low

Confluent license properties

You can put license-related properties in the connector configuration, or starting with Confluent Platform version 6.0, you can 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.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, contact Confluent Support for more information.

  • Type: string

  • Default: “”

  • Valid Values: Confluent Platform license

  • Importance: high

confluent.topic.ssl.truststore.location

The location of the trust store file.

  • Type: string

  • Default: null

  • Importance: high

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.

  • Type: password

  • Default: null

  • Importance: high

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.

  • Type: string

  • Default: null

  • Importance: high

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.

  • Type: password

  • Default: null

  • Importance: high

confluent.topic.ssl.key.password

The password of the private key in the key store file. This is optional for client.

  • Type: password

  • Default: null

  • Importance: high

confluent.topic.security.protocol

Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

  • Type: string

  • Default: “PLAINTEXT”

  • Importance: medium

License topic configuration

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:

  • A 30-day trial license is automatically generated for the _confluent command topic if you do not add the confluent.license property or leave this property empty (for example, confluent.license=).

  • Adding a valid license key (for example, confluent.license=<valid-license-key>) adds a valid license in the _confluent-command topic.

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..

License topic ACLs

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:

  • CREATE and DESCRIBE on the resource cluster, if the connector needs to create the topic.

  • DESCRIBE, READ, and WRITE on the _confluent-command topic.

    Important

    You can also use DESCRIBE and READ without WRITE to restrict access to read-only for license topic ACLs. If a topic exists, the LicenseManager will not try to create the topic.

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.

  1. 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

  2. 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

Override Default Configuration Properties

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.

You can override producer-specific properties by using the producer.override.* prefix (for source connectors) and consumer-specific properties by using the consumer.override.* prefix (for sink connectors).

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.

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.