Skip to main content
Quick navigation

Environment Variables

Jump to:

Kafka Environment Variables

Conduktor Proxy connections to Kafka are configured by prefixed and translated environment variables. Any variable prefixed with KAFKA_ will be treated as a connection parameter. The remainder of the environmnt variable will be lower cased and have _ replaced with . so that a variable

KAFKA_BOOTSTRAP_SERVERS

is equivalent to the Kafka property

bootstrap.servers

Proxy Environment Variables

Default configurations for Conduktor Proxy can be overridden by environment variables:

Host/Port Configurations

Environment VariableDefault ValueDescription
PROXY_BIND_HOST0.0.0.0The host on which to bind the proxy
PROXY_HOSTlocalhostThe proxy hostname that should be presented to clients
PROXY_PORT_RANGE6969:6975A range of ports to be opened on the Conduktor Proxy host, each port in this range will correspond to a broker in the Kafka cluster so it must be at least as large as the broker count of the KAfka cluster. We recommend it is double the size of the Kafka cluster to allow for expansion and reassignment

Schema Registry Configurations

Environment VariableDefault ValueDescription
SCHEMA_REGISTRY_HOSTNoneA HTTP endpoint for interacting with a Schema Registry (e.g. http://localhost:8081)

Authentication Configurations

Note: These configurations apply to authentication between clients and Conduktor Proxy. For authentication between Conduktor Proxy and Kafka see Kafka Environment Variables

Environment VariableDefault ValueDescription
AUTHENTICATION_AUTHENTICATOR_TYPENONEThe type of authentication clients should use to connect to the Proxy, valid values are NONE, SSL, SASL_PLAIN and SASL_SSL
SSL_KEY_STORE_PATHNonePath to a keystore for SSL connections
SSL_KEY_STORE_PASSWORDNonePassword for the keystore defined above
SSL_KEY_PASSWORDNonePassword for the key contained in the store above
SSL_KEY_TYPEjksThe type of keystore used for SSL connections

HTTP Configurations

Environment VariableDefault ValueDescription
HTTP_PORT8888The port on which the Proxy will present a HTTP management API

Thread Configurations

Environment VariableDefault ValueDescription
DOWNSTREAM_THREAD2The number of threads dedicated to handling IO between clients and Conduktor Proxy
UPSTREAM_THREAD4The number of threads dedicated to handling IO between Kafka and Conduktor Proxy

Upstream Connection Configurations

Environment VariableDefault ValueDescription
UPSTREAM_NUM_CONNECTION10The number of connections between Conduktor Proxy and Kafka

Topic Store Configurations

Environment VariableDefault ValueDescription
TOPIC_STORE_MAPPING_BACKING_TOPIC_topicMappingsThe name of an internal topic used to store topic mapping configuration for multi tenancy
TOPIC_STORE_REGISTRY_BACKING_TOPIC_topicRegistryThe name of an internal topic used to store topic metadata

Interceptor Configurations

Environment VariableDefault ValueDescription
INTERCEPTOR_STORE_BACKING_TOPIC_interceptorConfigsThe name of an internal topic used to store interceptor configurations
RESOURCE_NAME_BACKING_TOPIC_resourceNamesThe name of an internal topic used to store named resource metadata

Tenant Store Configurations

Environment VariableDefault ValueDescription
TENANT_STORES_BACKING_TOPIC_tenantConfigMappingsThe name of an internal topic used to store tenant metadata

Offset Store Configurations

Environment VariableDefault ValueDescription
OFFSET_STORE_COMMITTED_OFFSET_BACKING_TOPIC_offsetStoreThe name of an internal topic used to store offset metadata
OFFSET_STORE_CONSUMER_GROUP_SUBSCRIPTION_BACKING_TOPIC_consumerGroupSubscriptionBackingTopicThe name of an internal topic used to store consumer group metadata

Feature Flags Configurations

Environment VariableDefault ValueDescription
FEATURE_FLAGS_RBACfalseWhether or not to enable the RBAC feature
FEATURE_FLAGS_SINGLE_TENANTfalseWhether or not to enable single tenant mode, in this mode topic names etc are not prefixed.
FEATURE_FLAGS_NO_INTERNAL_TOPICSfalseWhether or not to enable no internal topics mode, in this mode proxy internal topics are not created. Note only one proxy instance is supported in this mode.
FEATURE_FLAGS_JWT_TOKEN_ENDPOINTfalseWhether or not to enable a REST endpoint for generating auth JWT tokens

Metrics Configurations

Environment VariableDefault ValueDescription
PROMETHEUS_METRICS_PORT9089The port on which Prometheus metrics will be exposed

Conduktor Platform Configurations

Environment VariableDefault ValueDescription
PLATFORM_M2M_SECRETchangeitA shared secret used to authenticate requests between Conduktor Proxy and Conduktor Platform. This can usually be found as the sharedSecret property in /etc/conduktor/devtools.yml in the Conduktor Platform container
PLATFORM_M2M_ISSUERhttp://localhost/authThe issuer used to authenticate requests between Conduktor Proxy and Conduktor Platform this should be in the form http://[platform host name]/auth

RBAC configurations

Environment VariableDefault ValueDescription
RBAC_PLATFORM_ENDPOINThttp://localhost:8080/admin/api/pThe Conduktor Platform persmissions API endpoint

Licensing configurations

Environment VariableDefault ValueDescription
LICENSE_BACKING_TOPIC_licenseThe namme of an internal topic used to store license data
LICENSE_PUBLIC_KEYNoneThe public key used to decode license keys
LICENSE_KEYNoneLicense key

Security configuration

Environment VariableDefault ValueDescription
JWT_AUTH_MASTER_USERNAMEconduktorMaster credentials for use with admin APIs
JWT_AUTH_MASTER_PASSWORDconduktorMaster credentials for use with admin APIs

Logging configuration

Environment VariableDefault ValueDescription
LOG4J2_APPENDER_LAYOUTpatternThe format to output console logging. Use json for json layout or pattern for pattern layout