Connect Configuration
Default Configuration
The default values for Connect are in platform-deploy/include/defaults/connect.sh
To override them for a specific Connect instance, you will need to modify platform-config/tenants/{tenant-name}/instances/{instance-name}/axual-connect.sh file
Axual Connect Configuration
| Configuration | Required / Optional | Description | Default Value | Since |
|---|---|---|---|---|
|
Optional |
When the Worker is out of sync with other Workers and fails to catch up within Worker.sync.timeout.ms, leave the Connect cluster for this long before rejoining. |
300000 |
2020.2 |
|
Optional |
When the Worker is out of sync with other Workers and needs to resynchronize configurations, wait up to this amount of time before giving up, leaving the group, and waiting a backoff period before rejoining. |
3000 |
2020.2 |
|
Optional |
Determines the docker image version to use for connect |
2.2.0 |
2020.2 |
|
Optional |
The Vault path to connect during initialisation to verify connectivity |
<no default> |
2020.2 |
|
Optional |
Perform an SSL verification of the certificate provided by the Vault server |
true |
2020.2 |
|
Required |
The Secret ID for your Axual Connect instance |
<no default> |
2020.2 |
|
Required |
The Role ID for your Axual Connect instance |
<no default> |
2020.2 |
|
Required |
The name to use for the Vault configuration provider |
vault |
2020.2 |
|
Required |
If set to true the Vault Config Provider will be added to the configuration. This provider can provide any secrets stored in a HashiCorp Vault KeyValue store |
true |
2020.2 |
|
Required |
The class implementing the configuration provider |
|
2020.2 |
|
Required |
The URL of the HashiCorp Vault server |
<no default> |
2020.2 |
|
Required |
Use schemas for the value converter |
true |
2020.2 |
|
Required |
Converter class for value Connect data. This controls the format of the data that will be written to Kafka for source connectors or read from Kafka for sink connectors. |
|
2020.2 |
|
Optional |
Amount of time to wait for tasks to shutdown gracefully. This is the total amount of time, not per task. All tasks have shutdown triggered, then they are waited on sequentially. |
5000 |
2020.2 |
|
Optional |
The topic to store connector status |
<no default, generated> |
2020.2 |
|
Optional |
The file format of the trust store file |
JKS |
2020.2 |
|
Required |
The password of the private key in the key store file for the REST API Server |
<no default> |
2020.2 |
|
Required |
The store password for the key store file used for the REST API Server |
<no default> |
2020.2 |
|
Required |
The SSL protocol used to generate the SSLContext. 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 usage is discouraged due to known security vulnerabilities. |
TLS |
2020.2 |
|
Optional |
The file format of the trust store file |
JKS |
2020.2 |
|
Required |
The endpoint identification algorithm to validate server hostname using server certificate. |
<empty> |
2020.2 |
|
Optional |
The list of protocols enabled for SSL connections. |
TLSv1.2,TLSv1.1,TLSv1 |
2020.2 |
|
Required |
The password of the private key in the key store file for the REST API Server |
<no default> |
2020.2 |
|
Required |
The store password for the key store file used for the Kafka Clients |
<no default> |
2020.2 |
|
Optional |
The timeout used to detect failures when using Kafka’s group management facilities. |
30000 |
2020.2 |
|
Optional |
The size of the TCP send buffer ( |
131072 |
2020.2 |
|
Optional |
Sets the Kafka Client security protocol to use |
SSL |
2020.2 |
|
Optional |
The amount of time to wait before attempting to retry a failed fetch request to a given topic partition. This avoids repeated fetching-and-failing in a tight loop. |
100 |
2020.2 |
|
Optional |
Resolve the system resource names. |
disabled |
2020.2 |
|
Optional |
The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted. |
40000 |
2020.2 |
|
Optional |
The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker. |
50 |
2020.2 |
|
Optional |
The size of the TCP receive buffer ( |
32768 |
2020.2 |
|
Required |
Expose prometheus endpoint |
enabled |
2020.2 |
|
Optional |
The port number where the prometheus agent exposes the metrics |
<no default> |
2020.2 |
|
Required |
The endpoint identification algorithm to validate server hostname using server certificate for the producer. |
<empty> |
2020.2 |
|
Optional |
The Distinguished Name of the Axual Connect Principal with the signing CA DNs chained. |
<no default> |
2020.2 |
|
Optional |
The Distinguished Name of the Axual Connect Principal. |
<no default> |
2020.2 |
|
Required |
The path to the directory containing the connector-plugin and transformation-plugins. |
<no default> |
2020.2 |
|
Optional |
The topic to store connector offsets |
<no default, generated> |
2020.2 |
|
Optional |
Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. |
5000 |
2020.2 |
|
Optional |
Interval at which to try committing offsets for tasks |
60000 |
2020.2 |
|
Optional |
The number of samples maintained to compute metrics |
30000 |
2020.2 |
|
Optional |
The number of samples maintained to compute metrics |
2 |
2020.2 |
|
Optional |
The period of time in milliseconds after which we force a refresh of metadata even if we haven’t seen any partition leadership changes to proactively discover any new brokers or partitions. |
300000 |
2020.2 |
|
Optional |
The maximum amount of records to return in a single poll command |
100 |
2020.2 |
|
Optional |
The maximum amount of time to wait for a poll |
60000 |
2020.2 |
|
Required |
Use schemas for the key converter |
true |
2020.2 |
|
Required |
Converter class for key Connect data. This controls the format of the data that will be written to Kafka for source connectors or read from Kafka for sink connectors. |
|
2020.2 |
|
Optional |
The Vault path to connect during initialisation to verify connectivity |
<no default> |
2020.2 |
|
Optional |
Perform an SSL verification of the certificate provided by the Vault server |
true |
2020.2 |
|
Required |
The Secret ID for your Axual Connect instance |
<no default> |
2020.2 |
|
Required |
The Role ID for your Axual Connect instance |
<no default> |
2020.2 |
|
Required |
The name to use for the Vault configuration provider |
vault |
2020.2 |
|
Required |
If set to true the Keystore Config Provider will be added to the configuration. |
true |
2020.2 |
|
Required |
The class implementing the configuration provider |
|
2020.2 |
|
Required |
The URL of the HashiCorp Vault server |
<no default> |
2020.2 |
|
Required |
The key name used to store the private key in a Vault location |
private.key |
2020.2 |
|
Required |
The key name used to store the certificate chain in a Vault location |
private.key |
2020.2 |
|
Optional |
Specify the JVM performance settings. |
-server -XX:+UseG1GC |
2020.2 |
|
Optional |
Specify Heap size for JVM |
-Xmx2048M |
2020.2 |
|
Required |
Expose JMX port |
disabled |
2020.2 |
|
Required |
Use schemas for the internal value converter |
false |
2020.2 |
|
Required |
Default converter for the values in a record of the internal system topics |
|
2020.2 |
|
Required |
Use schemas for the internal key converter |
true |
2020.2 |
|
Required |
Default converter for the keys in a record of the internal system topics |
|
2020.2 |
|
Optional |
The port used for incoming JMX connections |
<no default> |
2020.2 |
|
Required |
The port used for non TLS Rest API calls |
<no default> |
2020.2 |
|
Required |
The port used for non TLS Rest API calls |
<no default> |
2020.2 |
|
Optional |
Set the Kafka Client Heartbeat Interval |
3000 |
2020.2 |
|
Optional |
Use this Consumer Group ID |
<no default> |
2020.2 |
|
Optional |
Provides a default environment used for discovery api and resource resolving |
<no default> |
2020.2 |
|
Required |
Enables connect for this instance |
false |
2020.2 |
|
Required |
The endpoint identification algorithm to validate server hostname using server certificate for the consumer. |
<empty> |
2020.2 |
|
Optional |
Class name or alias of implementation of |
All |
2020.2 |
|
Optional |
Close idle connections after the number of milliseconds specified by this config. |
540000 |
2020.2 |
|
Optional |
The topic to store connector config |
<no default, generated> |
2020.2 |
|
Required |
The path to the directory containing the configuration files. |
<no default> |
2020.2 |
|
Required |
The path to the directory containing the common JAR files. |
<no default> |
2020.2 |
|
Required |
The path to the directory containing client certificates for the connectors. |
<no default> |
2020.2 |
|
Optional |
The HTTP Basic Authentication username, required when Basic Authentication is enabled |
<no default> |
2020.2 |
|
Optional |
The HTTP Basic Authentication password, required when Basic Authentication is enabled |
<no default> |
2020.2 |
|
Required |
Determines if HTTP Basic Authentication needs to be enabled |
true |
2020.2 |
|
Optional |
Application Version used by Axual Connect |
<no default> |
2020.2 |
|
Required |
Application ID used by Axual Connect |
<no default, generated> |
2020.2 |
|
Required |
The endpoint identification algorithm to validate server hostname using server certificate for the admin client. |
<empty> |
2020.2 |
|
Optional |
Should be enabled when using Amazon S3 Connector |
false |
2020.2 |
|
Optional |
Amazon access key ID |
<empty> |
2020.2 |
|
Optional |
Amazon secret access key ID |
<empty> |
2020.2 |