Configuration reference

The KCM API is configured with environment variables. The names are the same everywhere: in the environment section of the Docker Compose file, and under api.env in the Helm values (passwords under api.secret).

KCM 1.5.0 Defaults are the application defaults unless stated
Where to set them
  • Docker Compose: 00_kcm_with_docker_compose/docker-compose.yml, service kcm-api, then docker compose up -d.
  • Helm: api.env.NAME in your values file, then helm upgrade. Run helm show values oci://registry-1.docker.io/kafkaetech/kcm --version 1.5.1 to see them all with their default.

A new variable is always added to both the Compose repository and the chart in the release that introduces it. Variables of the license files are set by the Compose file and the chart: keep their defaults.

Application and sign in

VariableDefaultDescription
KCM_APP_PORT9090 (Compose and Helm: 8080)HTTP port of the API inside the container.
KCM_DEFAULT_USER_ENABLEDtrueCreates the built-in admin user at the first start.
KCM_DEFAULT_PASSWORDemptyPassword of the admin user, used only when KCM creates it. When empty, a random password is generated and printed once in the API log (the Helm chart stores it in its Secret). The Compose file uses admin unless you set it: change it at once.
KCM_REDIRECT_ALLOWLISThttp://localhost:4200Comma-separated origins (scheme://host[:port], no trailing slash) allowed as redirect targets after sign in and sign out, and as browser origins of the live message consumer. Set by the chart from the Ingress host.
KCM_DEFAULT_REDIRECThttp://localhost:4200Default redirect after sign in and sign out. Set by the chart.
KCM_APP_FILES_PATH/data (Compose and Helm: /app/files)Folder for uploaded files: truststores, keystores, keytabs, exports.
KCM_ADMIN_CLIENT_IDkc-admin-clientKafka client.id of the administration connections opened by KCM.

Sessions, cookies and sign in locks

VariableDefaultDescription
KCM_COOKIE_NAMEKCM_ATName of the session cookie.
KCM_COOKIE_DOMAINemptyCookie domain, for example .example.com when the console and the API run on sub-domains.
KCM_COOKIE_MAX_AGE_SECONDS86400Lifetime of the session cookie.
KCM_COOKIE_SAME_SITELaxSameSite attribute of the cookie. Use None only when the console runs on another site than the API, over HTTPS.
KCM_SESSION_CHECK_CACHE_SECONDS30How long each API instance caches the session state of a user. A revoked session (account disabled, role or password changed, sign out everywhere) is refused by every instance within this delay.
KCM_LOGIN_MAX_FAILURES5Failed sign ins of one username from one address before a lock. Four times more failures from any address lock the username.
KCM_LOGIN_LOCK_MINUTES15Duration of that lock.
KCM_JWT_ISSUERkcmIssuer of the session tokens. Keep the default.
KCM_JWT_TOKEN_VALIDITY86400Validity of a session token, in seconds.
KCM_JWT_PERSISTENCE_MODEJDBCWhere session data is kept. Keep the default.

Key pairs

KCM uses two RSA key pairs (PEM: private key in PKCS#8, public key in X.509): one signs the sessions, the other encrypts the secrets stored in the database.

VariableDefault (Compose)Description
KCM_JWT_PRIVATE_KEY/app/keys/jwt/private.pemPrivate key signing the session tokens.
KCM_JWT_PUBLIC_KEY/app/keys/jwt/public.pemPublic key checking them.
KCM_ENCRYPT_PRIVATE_KEY/app/keys/encryption/private.pemPrivate key decrypting the stored secrets.
KCM_ENCRYPT_PUBLIC_KEY/app/keys/encryption/public.pemPublic key encrypting them.
KCM_ENCRYPT_PREVIOUS_PRIVATE_KEYemptyPrivate key of the previous encryption pair, during a change of pair: secrets it encrypted are re-encrypted with the current pair at startup. Ignored when the file does not exist.
KCM_KEYS_GENERATE_IF_MISSINGfalse (Compose: true, Helm: false)Generates a missing key pair at startup. An existing file is never replaced.

With Helm, the pairs come from Kubernetes Secrets, see Install and Upgrades and backups.

PostgreSQL

VariableDefaultDescription
KCM_DB_URLjdbc:postgresql://db:5432/kcm_dbJDBC URL of the database.
KCM_DB_USERkcm_userDatabase user.
KCM_DB_PWDkcm_password (Helm: required)Database password. With Helm, set it under api.secret.
KCM_DB_HIKARI_MAX_POOL_SIZE20Maximum connections of the connection pool.
KCM_DB_HIKARI_MIN_IDLE5Minimum idle connections.
KCM_DB_HIKARI_IDLE_TIMEOUT600000Milliseconds before an idle connection is closed.
KCM_DB_HIKARI_CONNECTION_TIMEOUT30000Milliseconds to wait for a connection.
KCM_DB_HIKARI_MAX_LIFETIME1800000Maximum lifetime of a connection, in milliseconds.
KCM_DB_HIKARI_POOL_NAMEKCMHikariCPName of the pool in the logs.

Redis

VariableDefaultDescription
KCM_REDIS_HOSTredisRedis host name.
KCM_REDIS_PORT6379Redis port.
KCM_REDIS_DB0Database index.
KCM_REDIS_TIMEOUT2000Connection timeout, in milliseconds.
KCM_REDIS_CLUSTER_NODESemptyRedis cluster nodes (host:port, comma-separated). Empty: the single Redis above.

Service account tokens

VariableDefaultDescription
KCM_SA_TOKEN_DEFAULT_VALIDITY_DAYS90Validity of a new token when none is given.
KCM_SA_TOKEN_MAX_VALIDITY_DAYS365Longest validity a token can have.
KCM_SA_LEGACY_JWT_ACCEPTEDtrueService account tokens issued before 1.4.0 stay valid until they expire. Set false to refuse them at once.

Audit event stream Enterprise

VariableDefaultDescription
KCM_AUDIT_LOG_ENABLEDfalseWrites every audit event as one JSON line on the standard output of the API, for a log collector feeding a SIEM. Requires an Enterprise license; otherwise the stream stays off and a warning at startup says why. See Audit trail.

Kafka Connect status history

VariableDefaultDescription
KCM_CONNECT_STATUS_HISTORY_ENABLEDtrueSamples the state of every connector and task.
KCM_CONNECT_STATUS_HISTORY_CRON0 2/5 * * * *Sampling schedule, a cron expression with 6 fields (seconds first).
KCM_CONNECT_STATUS_HISTORY_INTERVAL_SECONDS300Sampling period. Keep it equal to the period of the cron expression.
KCM_CONNECT_STATUS_HISTORY_RETENTION_DAYS30Days of history kept.

AI assistant (beta)

Plain English analysis of a consumer group, with a model served by a local Ollama. Off by default.

VariableDefaultDescription
KCM_ASSISTANT_ENABLEDfalseTurns the assistant on.
KCM_ASSISTANT_OLLAMA_URLhttp://localhost:11434Ollama URL, reachable from the API container.
KCM_ASSISTANT_MODELgemma3:4bModel used, already pulled in Ollama.
KCM_ASSISTANT_TIMEOUT_SECONDS120Longest duration of one call to the model.

Console runtime settings

The console reads runtime-config.json at startup to find the API. With Helm, set ui.runtimeConfig.apiUrl (for example https://kcm.example.com) and ui.runtimeConfig.wsUrl (for example wss://kcm.example.com). With Docker Compose, edit 00_kcm_with_docker_compose/runtime-config.json.

Advanced

The endpoints of Confluent Cloud (KCM_CONFLUENT_CLOUD_API_URL, KCM_CONFLUENT_CLOUD_TELEMETRY_URL, KCM_CONFLUENT_CLOUD_FLINK_URL) have working defaults. Change them only when asked by support.