Axual Connect Configuration Reference

This reference lists the Docker environment variables the Axual Connect container reads, which of them are required, their default values, and the docker run command that starts the container.

Type

Reference

Goal

Look up the environment variable that controls a given Axual Connect setting, and the value it defaults to.

Audience

Platform Operator running the Axual Connect container, with permission to change its environment.

When to use

While writing or reviewing the Axual Connect container configuration.

Contents

The sections below cover each area in this reference:

Connect Docker Environment Variables

The table below lists every Docker environment variable the Connect container reads, with its required flag and default value.

Configuration

Required

Description

Default Value

CONNECT_TENANT

Yes

Axual tenant

<no default>

CONNECT_APP_ID

Yes

Connect Application ID

<no default>

CONNECT_DISCOVERY_BOOTSTRAP_SERVERS

Yes

Bootstrap server url

<no default>

CONNECT_KEY_CONVERTER

Yes

Key converter

<no default>

CONNECT_VALUE_CONVERTER

Yes

Value converter

<no default>

CONNECT_GROUP_ID

Yes

group.id used by internal consumers

<no default>

CONNECT_CONFIG_STORAGE_TOPIC

Yes

Name of topic used to store connector configurations

<no default>

CONNECT_OFFSET_STORAGE_TOPIC

Yes

Name of topic used to store connector offsets

<no default>

CONNECT_STATUS_STORAGE_TOPIC

Yes

Name of topic used to store connector status

<no default>

LOGBACK_CONFIG_FILE

No

Logging configuration file location

/config/logback.xml

CONNECT_DISCOVERY_TENANT

Yes

Static tenant name configuration

<no default>

CONNECT_DISCOVERY_INSTANCE

Yes

Static instance name configuration

<no default>

CONNECT_DISCOVERY_CLUSTER

Yes

Static cluster name configuration

<no default>

CONNECT_DISCOVERY_SCHEMA_REGISTRY_URL

Yes

Static Apicurio Registry URL configuration

<no default>

CONNECT_DISCOVERY_GROUP_ID_PATTERN

No

Static Group ID Pattern configuration

<no default>

CONNECT_DISCOVERY_TOPIC_PATTERN

No

Static Topic Pattern configuration

<no default>

CONNECT_DISCOVERY_TRANSACTIONAL_ID_PATTERN

No

Static Transactional ID Pattern configuration

<no default>

CONNECT_APP_VERSION

No

Connect Application Version

EMPTY_STRING

CONNECT_CONNECTOR_CLIENT_CONFIG_OVERRIDE_POLICY

No

Class name or alias of implementation of ConnectorClientConfigOverridePolicy. This defines configurations that can be overridden by the connector

Axual

CLASSPATH

No

Common resources directory path

/common/*

RUN_MODE

No

distributed if multi-node or standalone

distributed

CONNECT_CONFIG_STORAGE_REPLICATION_FACTOR

No

Replication factor of topic used to store connector configurations

<no default>

CONNECT_OFFSET_STORAGE_REPLICATION_FACTOR

No

Replication factor of topic used to store connector offsets

<no default>

CONNECT_STATUS_STORAGE_REPLICATION_FACTOR

No

Replication factor of topic used to store connector status

<no default>

CONNECT_OFFSET_STORAGE_FILE_FILENAME

No

File to store offsets (used on standalone mode)

/tmp/connect-offsets

CONNECT_RESOLVING_SYSTEM_RESOURCES

No

Enable/disable resolving for backing store topic

disabled

CONNECT_LINEAGE_ENABLED

No

Axual Lineage headers feature flag, enabling all has a significant impact on throughput

true

CONNECT_LINEAGE_APPLICATION_ID_ENABLED

No

Axual Lineage application.id feature flag

true

CONNECT_LINEAGE_MESSAGE_ID_ENABLED

No

Axual Lineage message.id feature flag

true

CONNECT_LINEAGE_TIMESTAMPS_ENABLED

No

Axual Lineage timestamps feature flag

true

CONNECT_LINEAGE_SYSTEM_ENABLED

No

Axual Lineage system feature flag

true

CONNECT_LINEAGE_REMOVE_EXISTING_ENABLED

No

Removes existing headers from messages prior to adding the new ones

true

KAFKA_HEAP_OPTS

No

Kafka heap options

-Xmx512M

KAFKA_JVM_PERFORMANCE_OPTS

No

Kafka JVM performance options

<no default>

CONNECT_SSL_TRUSTSTORE_LOCATION

No

Truststore location

<no default>

CONNECT_SSL_TRUSTSTORE_PASSWORD

No

Truststore password

<no default>

CONNECT_SSL_KEYSTORE_LOCATION

No

Keystore location

<no default>

CONNECT_SSL_KEYSTORE_PASSWORD

No

Keystore password

<no default>

CONNECT_SSL_KEY_PASSWORD

No

Key password

<no default>

CONNECT_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM

No

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

https

CONNECT_KEY_CONVERTER_SSL_TRUSTSTORE_LOCATION

No

KeyConverter keystore location

<no default>

CONNECT_KEY_CONVERTER_SSL_TRUSTSTORE_PASSWORD

No

KeyConverter truststore location

<no default>

CONNECT_KEY_CONVERTER_SCHEMA_REGISTRY_SSL_KEYSTORE_LOCATION

No

KeyConverter SchemaRegistry keystore location

<no default>

CONNECT_KEY_CONVERTER_SCHEMA_REGISTRY_SSL_KEYSTORE_PASSWORD

No

KeyConverter SchemaRegistry keystore password

<no default>

CONNECT_KEY_CONVERTER_SCHEMA_REGISTRY_SSL_KEY_PASSWORD

No

KeyConverter SchemaRegistry key password

<no default>

CONNECT_KEY_CONVERTER_SCHEMA_REGISTRY_SSL_TRUSTSTORE_LOCATION

No

KeyConverter SchemaRegistry truststore location

<no default>

CONNECT_KEY_CONVERTER_SCHEMA_REGISTRY_SSL_TRUSTSTORE_PASSWORD

No

KeyConverter SchemaRegistry truststore password

<no default>

CONNECT_VALUE_CONVERTER_SECURITY_PROTOCOL

No

KeyConverter security protocol

<no default>

CONNECT_VALUE_CONVERTER_SSL_TRUSTSTORE_LOCATION

No

ValueConverter keystore location

<no default>

CONNECT_VALUE_CONVERTER_SSL_TRUSTSTORE_PASSWORD

No

ValueConverter keystore location

<no default>

CONNECT_VALUE_CONVERTER_SCHEMA_REGISTRY_SSL_KEYSTORE_LOCATION

No

ValueConverter SchemaRegistry keystore location

<no default>

CONNECT_VALUE_CONVERTER_SCHEMA_REGISTRY_SSL_KEYSTORE_PASSWORD

No

ValueConverter SchemaRegistry keystore password

<no default>

CONNECT_VALUE_CONVERTER_SCHEMA_REGISTRY_SSL_KEY_PASSWORD

No

ValueConverter SchemaRegistry key password

<no default>

CONNECT_VALUE_CONVERTER_SCHEMA_REGISTRY_SSL_TRUSTSTORE_LOCATION

No

ValueConverter SchemaRegistry truststore location

<no default>

CONNECT_VALUE_CONVERTER_SCHEMA_REGISTRY_SSL_TRUSTSTORE_PASSWORD

No

ValueConverter SchemaRegistry truststore password

<no default>

CONNECT_KEY_CONVERTER_SECURITY_PROTOCOL

No

ValueConverter security protocol

<no default>

CONNECT_SECURITY_PROTOCOL

No

Protocol used to communicate with brokers

PLAINTEXT

CONNECT_LISTENERS

No

List of REST listeners in the following format: protocol://host:port,protocol2://host2:port2. Currently supported protocols are http and https.

http://localhost:8083

CONNECT_REST_ADVERTISED_LISTENER

No

Sets the advertised listener (HTTP or HTTPS) which will be given to other workers to use

<no default>

CONNECT_REST_ADVERTISED_PORT

No

Abandoned in favor of CONNECT_REST_ADVERTISED_LISTENER

null

CONNECT_LISTENERS_HTTPS_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM

No

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

TLSv1.2,TLSv1.3 in Java 11 else TLSv1.2

CONNECT_LISTENERS_HTTPS_SSL_ENABLED_PROTOCOLS

No

Connect REST interface list of protocols enabled for SSL connections

<no default>

CONNECT_LISTENERS_HTTPS_SSL_KEYSTORE_LOCATION

No

REST listeners keystore location

<no default>

CONNECT_LISTENERS_HTTPS_SSL_KEYSTORE_PASSWORD

No

REST listeners keystore password

<no default>

CONNECT_LISTENERS_HTTPS_SSL_KEY_PASSWORD

No

REST listeners key password

<no default>

CONNECT_LISTENERS_HTTPS_SSL_TRUSTSTORE_LOCATION

No

REST listeners truststore location

<no default>

CONNECT_LISTENERS_HTTPS_SSL_TRUSTSTORE_PASSWORD

No

REST listeners truststore password

<no default>

CONNECT_LISTENERS_HTTPS_SSL_KEYSTORE_TYPE

No

REST listeners keystore type

JKS

CONNECT_LISTENERS_HTTPS_SSL_TRUSTSTORE_TYPE

No

REST listeners truststore type

JKS

CONNECT_LISTENERS_HTTPS_SSL_CIPHER_SUITES

No

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

<no default>

CONNECT_REST_ADVERTISED_HOST_NAME

No

Abandoned in favor of CONNECT_REST_ADVERTISED_LISTENER

<no default>

PROMETHEUS_AGENT_PORT

No

Metrics port

10001

CONNECT_ADMIN_CONFIG_PROVIDERS

No

Configuration provider. One of vault, keyvault, vault,keyvault

<no default>

CONNECT_CONFIG_PROVIDERS

No

Configuration provider. One of vault, keyvault, vault,keyvault

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS

No

Configuration provider. One of vault, keyvault, vault,keyvault

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS

No

Configuration provider. One of vault, keyvault, vault,keyvault

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_CLASS

No

The class implementing the configuration provider

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_PARAM_ADDRESS

No

The URL of the HashiCorp Vault server

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_PARAM_AUTH_METHOD

No

Vault authentication Method

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_PARAM_APPROLE_ROLE_ID

No

The Role ID for your Axual Connect instance

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_PARAM_APPROLE_SECRET_ID

No

The Secret ID for your Axual Connect instance

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_PARAM_SSL_VERIFY

No

Perform an SSL verification of the certificate provided by the Vault server

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_PARAM_NAMESPACE

No

The Vault namespace where connect retrieves secrets from

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_PARAM_SSL_TRUSTSTORE_LOCATION

No

The path to vault truststore

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_PARAM_SSL_TRUSTSTORE_PASSWORD

No

Vault truststore password

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_VAULT_PARAM_TEST_PATH

No

The Vault path to connect during initialisation to verify connectivity

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_CLASS

No

The class implementing the configuration provider

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_PARAM_ADDRESS

No

The URL of the HashiCorp Vault server

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_PARAM_AUTH_METHOD

No

Vault authentication Method

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_PARAM_APPROLE_ROLE_ID

No

The Role ID for your Axual Connect instance

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_PARAM_APPROLE_SECRET_ID

No

The Secret ID for your Axual Connect instance

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_PARAM_SSL_VERIFY

No

Perform an SSL verification of the certificate provided by the Vault server

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_PARAM_NAMESPACE

No

The Vault namespace where connect retrieves secrets from

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_PARAM_SSL_TRUSTSTORE_LOCATION

No

The path to vault truststore

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_PARAM_SSL_TRUSTSTORE_PASSWORD

No

Vault truststore password

<no default>

CONNECT_CONFIG_PROVIDERS_VAULT_PARAM_TEST_PATH

No

The Vault path to connect during initialisation to verify connectivity

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_CLASS

No

The class implementing the configuration provider

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_PARAM_ADDRESS

No

The URL of the HashiCorp Vault server

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_PARAM_AUTH_METHOD

No

Vault authentication Method

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_PARAM_APPROLE_ROLE_ID

No

The Role ID for your Axual Connect instance

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_PARAM_APPROLE_SECRET_ID

No

The Secret ID for your Axual Connect instance

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_PARAM_SSL_VERIFY

No

Perform an SSL verification of the certificate provided by the Vault server

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_PARAM_NAMESPACE

No

The Vault namespace where connect retrieves secrets from

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_PARAM_SSL_TRUSTSTORE_LOCATION

No

The path to vault truststore

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_PARAM_SSL_TRUSTSTORE_PASSWORD

No

Vault truststore password

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_VAULT_PARAM_TEST_PATH

No

The Vault path to connect during initialisation to verify connectivity

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_CLASS

No

The class implementing the configuration provider

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_PARAM_ADDRESS

No

The URL of the HashiCorp Vault server

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_PARAM_AUTH_METHOD

No

Vault authentication Method

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_PARAM_APPROLE_ROLE_ID

No

The Role ID for your Axual Connect instance

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_PARAM_APPROLE_SECRET_ID

No

The Secret ID for your Axual Connect instance

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_PARAM_SSL_VERIFY

No

Perform an SSL verification of the certificate provided by the Vault server

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_PARAM_NAMESPACE

No

The Vault namespace where connect retrieves secrets from

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_PARAM_SSL_TRUSTSTORE_LOCATION

No

The path to vault truststore

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_PARAM_SSL_TRUSTSTORE_PASSWORD

No

Vault truststore password

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_VAULT_PARAM_TEST_PATH

No

The Vault path to connect during initialisation to verify connectivity

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_CLASS

No

The class implementing the configuration provider

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_ADDRESS

No

The URL of the HashiCorp Vault server

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_APPROLE_ROLE_ID

No

The Role ID for your Axual Connect instance

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_APPROLE_SECRET_ID

No

The Secret ID for your Axual Connect instance

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_AUTH_METHOD

No

Vault authentication Method

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_CERTIFICATE_CHAIN_KEYNAME

No

Keystore provider certificate chain key name

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_PRIVATE_KEY_KEYNAME

No

Keystore provider privateKey key name

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_TRUSTSTORE_LOCATION

No

The path to vault truststore

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_TRUSTSTORE_PASSWORD

No

Vault truststore password

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_VERIFY

No

Perform an SSL verification of the certificate provided by the Vault server

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_NAMESPACE

No

The Vault namespace where connect retrieves secrets from

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_TRUSTSTORE_LOCATION

No

The path to Connect client truststore

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_TRUSTSTORE_PASSWORD

No

Connect client truststore password

<no default>

CONNECT_ADMIN_CONFIG_PROVIDERS_KEYVAULT_PARAM_TEST_PATH

No

The Vault path to connect during initialisation to verify connectivity

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_CLASS

No

The class implementing the configuration provider

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_ADDRESS

No

The URL of the HashiCorp Vault server

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_APPROLE_ROLE_ID

No

The Role ID for your Axual Connect instance

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_APPROLE_SECRET_ID

No

The Secret ID for your Axual Connect instance

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_AUTH_METHOD

No

Vault authentication Method

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_CERTIFICATE_CHAIN_KEYNAME

No

Keystore provider certificate chain key name

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_PRIVATE_KEY_KEYNAME

No

Keystore provider privateKey key name

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_TRUSTSTORE_LOCATION

No

The path to vault truststore

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_TRUSTSTORE_PASSWORD

No

Vault truststore password

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_VERIFY

No

Perform an SSL verification of the certificate provided by the Vault server

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_NAMESPACE

No

The Vault namespace where connect retrieves secrets from

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_TRUSTSTORE_LOCATION

No

The path to Connect client truststore

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_TRUSTSTORE_PASSWORD

No

Connect client truststore password

<no default>

CONNECT_CONFIG_PROVIDERS_KEYVAULT_PARAM_TEST_PATH

No

The Vault path to connect during initialisation to verify connectivity

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_CLASS

No

The class implementing the configuration provider

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_ADDRESS

No

The URL of the HashiCorp Vault server

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_APPROLE_ROLE_ID

No

The Role ID for your Axual Connect instance

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_APPROLE_SECRET_ID

No

The Secret ID for your Axual Connect instance

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_AUTH_METHOD

No

Vault authentication Method

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_CERTIFICATE_CHAIN_KEYNAME

No

Keystore provider certificate chain key name

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_PRIVATE_KEY_KEYNAME

No

Keystore provider privateKey key name

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_TRUSTSTORE_LOCATION

No

The path to vault truststore

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_TRUSTSTORE_PASSWORD

No

Connect client truststore password

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_VERIFY

No

Perform an SSL verification of the certificate provided by the Vault server

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_NAMESPACE

No

The Vault namespace where connect retrieves secrets from

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_TRUSTSTORE_LOCATION

No

The path to Connect client truststore

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_TRUSTSTORE_PASSWORD

No

Connect client truststore password

<no default>

CONNECT_PRODUCER_CONFIG_PROVIDERS_KEYVAULT_PARAM_TEST_PATH

No

The Vault path to connect during initialisation to verify connectivity

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_CLASS

No

The class implementing the configuration provider

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_ADDRESS

No

The URL of the HashiCorp Vault server

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_APPROLE_ROLE_ID

No

The Role ID for your Axual Connect instance

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_APPROLE_SECRET_ID

No

The Secret ID for your Axual Connect instance

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_AUTH_METHOD

No

Vault authentication Method

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_CERTIFICATE_CHAIN_KEYNAME

No

Keystore provider certificate chain key name

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_PRIVATE_KEY_KEYNAME

No

Keystore provider privateKey key name

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_TRUSTSTORE_LOCATION

No

The path to vault truststore

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_TRUSTSTORE_PASSWORD

No

Vault truststore password

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_SSL_VERIFY

No

Perform an SSL verification of the certificate provided by the Vault server

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_NAMESPACE

No

The Vault namespace where connect retrieves secrets from

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_TRUSTSTORE_LOCATION

No

The path to Connect client truststore

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_TRUSTSTORE_PASSWORD

No

Connect client truststore password

<no default>

CONNECT_CONSUMER_CONFIG_PROVIDERS_KEYVAULT_PARAM_TEST_PATH

No

The Vault path to connect during initialisation to verify connectivity

<no default>

BASIC_AUTH_ENABLED

No

Basic authentication to access Connect Rest endpoints

<no default>

BASIC_AUTH_USER

No

Basic authentication username to access Connect Rest endpoints

<no default>

BASIC_AUTH_PASS

No

Basic authentication password to access Connect Rest endpoints

<no default>

Running Connect Docker Container

Before running the Connect container, make sure you have the following prerequisites in place:

  • Docker installed on your system.

Docker Run command

The following Docker run command starts the Connect container with minimum essential environment variables.

Example:

docker run --name connect \
-e CONNECT_TENANT="tenant" \
-e CONNECT_APP_ID="app_id" \
-e CONNECT_DISCOVERY_BOOTSTRAP_SERVERS="kafka1:9092,kafka2:9093,kafka3:9094" \
-e CONNECT_KEY_CONVERTER="org.apache.kafka.connect.json.JsonConverter" \
-e CONNECT_VALUE_CONVERTER="org.apache.kafka.connect.json.JsonConverter" \
-e CONNECT_GROUP_ID="groupId" \
-e CONNECT_OFFSET_STORAGE_TOPIC="offsetStorageTopic" \
-e CONNECT_CONFIG_STORAGE_TOPIC="configStorageTopic" \
-e CONNECT_STATUS_STORAGE_TOPIC="statusStorageTopic" \
[IMAGE_REGISTRY]/axual/connect:[IMAGE_TAG]

axual/connect:[IMAGE_TAG]: Specifies the Docker image to run.