Environment Variables

Configuring the environment using environment variables is the recommended way of configuring the Enterprise Conduktor Gateway.

For the open source Conduktor Gateway, use the yaml configuration file.

Environment Variables

Jump to:

• Kafka Environment Variables
• Override Environment Variables

Kafka Environment Variables

Conduktor Gateway 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

Gateway Environment Variables

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

Host/Port Configurations

Environment Variable	Default Value	Description	Enterprise Only
PROXY_BIND_HOST	0.0.0.0	The host on which to bind the gateway (Use GATEWAY_BIND_HOST with the open source gateway)	No
PROXY_HOST	localhost	The gateway hostname that should be presented to clients (Use GATEWAY_HOST with the open source gateway)	No
PROXY_PORT_RANGE	6969:6975	A 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. (Use GATEWAY_PORT_RANGE with the open source gateway)	No

Schema Registry Configurations

Environment Variable	Default Value	Description	Enterprise Only
SCHEMA_REGISTRY_HOST	None	A HTTP endpoint for interacting with a Schema Registry (e.g. http://localhost:8081)	Yes

Authentication Configurations

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

Environment Variable	Default Value	Description	Enterprise Only
AUTHENTICATION_AUTHENTICATOR_TYPE	NONE	The type of authentication clients should use to connect to the gateway, valid values are NONE, SSL, SASL_PLAIN and SASL_SSL	No
SSL_KEY_STORE_PATH	None	Path to a keystore for SSL connections	No
SSL_KEY_STORE_PASSWORD	None	Password for the keystore defined above	No
SSL_KEY_PASSWORD	None	Password for the key contained in the store above	No
SSL_KEY_TYPE	jks	The type of keystore used for SSL connections	No

HTTP Configurations

Environment Variable	Default Value	Description	Enterprise Only
HTTP_PORT	8888	The port on which the gateway will present a HTTP management API	Yes

Thread Configurations

Environment Variable	Default Value	Description	Enterprise Only
DOWNSTREAM_THREAD	2	The number of threads dedicated to handling IO between clients and Conduktor Gateway	No
UPSTREAM_THREAD	4	The number of threads dedicated to handling IO between Kafka and Conduktor Gateway	No

Upstream Connection Configurations

Environment Variable	Default Value	Description	Enterprise Only
UPSTREAM_NUM_CONNECTION	10	The number of connections between Conduktor Gateway and Kafka	No

Topic Store Configurations

Environment Variable	Default Value	Description	Enterprise Only
TOPIC_STORE_MAPPING_BACKING_TOPIC	_topicMappings	The name of an internal topic used to store topic mapping configuration for multi tenancy	Yes
TOPIC_STORE_REGISTRY_BACKING_TOPIC	_topicRegistry	The name of an internal topic used to store topic metadata	Yes

Interceptor Configurations

Environment Variable	Default Value	Description	Enterprise Only
INTERCEPTOR_STORE_BACKING_TOPIC	_interceptorConfigs	The name of an internal topic used to store interceptor configurations	Yes
RESOURCE_NAME_BACKING_TOPIC	_resourceNames	The name of an internal topic used to store named resource metadata	Yes

Tenant Store Configurations

Environment Variable	Default Value	Description	Enterprise Only
TENANT_STORES_BACKING_TOPIC	_tenantConfigMappings	The name of an internal topic used to store tenant metadata	Yes

Offset Store Configurations

Environment Variable	Default Value	Description	Enterprise Only
OFFSET_STORE_COMMITTED_OFFSET_BACKING_TOPIC	_offsetStore	The name of an internal topic used to store offset metadata	Yes
OFFSET_STORE_CONSUMER_GROUP_SUBSCRIPTION_BACKING_TOPIC	_consumerGroupSubscriptionBackingTopic	The name of an internal topic used to store consumer group metadata	Yes

Feature Flags Configurations

Environment Variable	Default Value	Description	Enterprise Only
FEATURE_FLAGS_RBAC	false	Whether or not to enable the RBAC feature	Yes
FEATURE_FLAGS_SINGLE_TENANT	false	Whether or not to enable single tenant mode, in this mode topic names etc are not prefixed.	Yes
FEATURE_FLAGS_NO_INTERNAL_TOPICS	false	Whether or not to enable no internal topics mode, in this mode gateway internal topics are not created. Note only one gateway instance is supported in this mode.	Yes
FEATURE_FLAGS_JWT_TOKEN_ENDPOINT	false	Whether or not to enable a REST endpoint for generating auth JWT tokens	Yes

Metrics Configurations

Environment Variable	Default Value	Description	Enterprise only
PROMETHEUS_METRICS_PORT	9089	The port on which Prometheus metrics will be exposed	Yes

Conduktor Platform Configurations

Environment Variable	Default Value	Description	Enterprise Only
PLATFORM_M2M_SECRET	changeit	A shared secret used to authenticate requests between Conduktor Gateway and Conduktor Platform. This can usually be found as the sharedSecret property in /etc/conduktor/devtools.yml in the Conduktor Platform container	Yes
PLATFORM_M2M_ISSUER	http://localhost/auth	The issuer used to authenticate requests between Conduktor Gateway and Conduktor Platform this should be in the form http://[platform host name]/auth	Yes

RBAC configurations

Environment Variable	Default Value	Description	Enterprise Only
RBAC_PLATFORM_ENDPOINT	http://localhost:8080/admin/api/p	The Conduktor Platform persmissions API endpoint	Yes

Licensing configurations

Environment Variable	Default Value	Description	Enterprise Only
LICENSE_BACKING_TOPIC	_license	The namme of an internal topic used to store license data	Yes
LICENSE_PUBLIC_KEY	None	The public key used to decode license keys	Yes
LICENSE_KEY	None	License key	Yes

Security configuration

Environment Variable	Default Value	Description	Enterprise Only
JWT_AUTH_MASTER_USERNAME	conduktor	Master credentials for use with admin APIs	Yes
JWT_AUTH_MASTER_PASSWORD	conduktor	Master credentials for use with admin APIs	Yes

Logging configuration

Environment Variable	Default Value	Description	Enterprise Only
LOG4J2_APPENDER_LAYOUT	pattern	The format to output console logging. Use json for json layout or pattern for pattern layout	Yes