Introduction

Conduktor can be configured using either a configuration file platform-config.yaml or environment variables. This is used to setup your organizations environment. Configuration can be used to declare:

• Organization name
• External database (required for production environments)
• User authentication (Basic or SSO)
• Console license

info

The recommended way to configure Kafka Cluster, Schema Registry and Kafka Connect is using Conduktor Console UI.

The Manage Clusters page (/admin/clusters) has several advantages over the YAML configuration:

• Intuitive interface with live update capabilities
• Centralized and secured with RBAC and Audit Logs Events
• Certificate store to help with your Custom certificates needs (no more JKS files and volume mounts)

Need to configure your Kafka Clusters using GitOps processes?
Contact our Customer Success or give us feedback on this feature.

If you absolutely need to configure your clusters using YAML, read the Configuration Properties page.

Security notes

The database as well as the configuration file described in this document may contain sensitive information.

• The configuration file should be protected by file system permissions.
• The database should have at-rest data encryption enabled on the data volume and have limited network connectivity.

Configuration file

platform-config.yaml

organization:
  name: demo

admin:
  email: admin@company.io
  password: admin

database:
  url: postgresql://user:password@host:5432/database
  # OR in a decomposed way
  # host: "host"
  # port: 5432
  # name: "database"
  # username: "user"
  # password: "password"
  # connection_timeout: 30 # in seconds

auth:
  local-users:
    - email: user@conduktor.io
      password: user

license: '<your license key>'

Bind file

The below docker-compose indicates how to bind your platform-config.yaml file. Alternatively, you can use environment variables.

Note that the environment variable CDK_IN_CONF_FILE is used to indicate that a configuration file is being used, and the location to find it.

docker-compose.yaml

version: '3.8'

services:  
  postgresql:
    image: postgres:14
    hostname: postgresql
    volumes:
      - pg_data:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: "conduktor-platform"
      POSTGRES_USER: "conduktor"
      POSTGRES_PASSWORD: "change_me"
      POSTGRES_HOST_AUTH_METHOD: "scram-sha-256"

  conduktor-platform:
    image: conduktor/conduktor-platform:latest
    depends_on:
      - postgresql
    ports:
      - "8080:8080"
    volumes:
      - conduktor_data:/var/conduktor
      - type: bind
        source: "./platform-config.yaml"
        target: /opt/conduktor/platform-config.yaml
        read_only: true
    environment:
      CDK_IN_CONF_FILE: /opt/conduktor/platform-config.yaml
    healthcheck:
      test: curl -f http://localhost:8080/platform/api/modules/health/live || exit 1
      interval: 10s
      start_period: 10s
      timeout: 5s
      retries: 3

volumes:
  pg_data: {}
  conduktor_data: {}

For all configuration properties and environment variables see Configuration Properties and Environment Variables.

Environment override

Since Conduktor 1.2.0, input configuration fields can also be provided using environment variables.

For more information, see Environment Variables.

Below shows an example docker-compose that uses environment variables for configuration.

"docker-compose.yaml

version: '3.8'

services:  
  postgresql:
    image: postgres:14
    hostname: postgresql
    volumes:
      - pg_data:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: "conduktor-platform"
      POSTGRES_USER: "conduktor"
      POSTGRES_PASSWORD: "change_me"
      POSTGRES_HOST_AUTH_METHOD: "scram-sha-256"

  conduktor-platform:
    image: conduktor/conduktor-platform:1.17.0
    depends_on:
      - postgresql
    ports:
      - "8080:8080"
    volumes:
      - conduktor_data:/var/conduktor
    healthcheck:
      test: curl -f http://localhost:8080/platform/api/modules/health/live || exit 1
      interval: 10s
      start_period: 10s
      timeout: 5s
      retries: 3
    environment:
      CDK_DATABASE_URL: "postgresql://conduktor:change_me@postgresql:5432/conduktor-platform"
      CDK_LICENSE: "${LICENSE_TOKEN:-}"
      CDK_ORGANIZATION_NAME: "${ORGANIZATION_NAME}"
      CDK_ADMIN_EMAIL: "${ADMIN_EMAIL}"
      CDK_ADMIN_PASSWORD: "${ADMIN_PSW}"

volumes:
  pg_data: {}
  conduktor_data: {}

Container user and permissions

Before version 1.8.0, Console was running as root user. After 1.8.0, Console is running as a non-root user conduktor-platform with UID 10001 and GID 0.

All files inside the container volume /var/conduktor are owned by conduktor-platform user.