Memory configuration

Conduktor use environment variable RUN_MODE to switch between different memory configuration presets.

RUN_MODE	Target RAM usage	Console Xmx	Governance Xmx	Authenticator Xmx
nano	3GB	1024m	256m	128m
small	4GB	1700m	512m	128m
medium	6GB	3072m	1024m	256m
large	8GB	4096m	2048m	256m
custom	No target	N.A.	N.A.	N.A.

caution

This mean that Conduktor won't start if the container CGroup memory limit is set below target RAM usage.

Modules memory usage

• Console : contain administation, RBAC and kafka resources exploration... Should scale with the number of users and kafka resources.
• Governance : contain data-masking engine, kafka indexer and kafka metrics exporter. Should scale for large kafka cluster to index.
• Authenticator : Authentication module to interface SSO/LDAP and local users. Scale on internal user list size and number of concurrent users connected.

Override specific module memory settings

All modules memory preset can be overridden using following environment variables :

• CONSOLE_MEMORY_OPTS : Used by Console module
• GOVERNANCE_MEMORY_OPTS : Used by governance module
• AUTHENTICATOR_MEMORY_OPTS : Used by authenticator module

The others modules will still use preset from RUN_MODE value.

Example

RUN_MODE=small
GOVERNANCE_MEMORY_OPTS="-Xms1025m -Xmx5000"

In this example we set around 5Go of RAM for Governance and leave other modules like Cosnole and Authenticator with small memory presets.

caution

Be aware that in this example target RAM usage is increased from 4Go to 8-9Go and container CGroup memory limit should be set accordingly.

Using custom RUN_MODE

If existing RUN_MODE presets are too restrictive or don't meet your needs, you can use custom RUN_MODE that remove CGroup memory limit startup check and require that you set manually memory Java options for all internal components using environement variables CONSOLE_MEMORY_OPTS, GOVERNANCE_MEMORY_OPTS and AUTHENTICATOR_MEMORY_OPTS.

Unlike single module override, all environment variables must be set when RUN_MODE=custom.

Example

Conduktor run environment variables with a target of 16Go:

RUN_MODE=custom
CONSOLE_MEMORY_OPTS="-Xms2048m -Xmx8000"
GOVERNANCE_MEMORY_OPTS="-Xms1025m -Xmx5000"
AUTHENTICATOR_MEMORY_OPTS="-Xms128m -Xmx512m"

In this example we set around 8Go for Console, 5Go for Governance and 510Mo for Authenticator leaving a safty marging of 2,5Go for other JVM memory pools and extra internal modules.

caution

In custom mode, Conduktor will not check CGroup memory limits to prevent under provisioning that could lead to unexpected crash.