Kafka UI

Kafka UI provides a web-based interface to observe and manage Apache Kafka clusters. Key capabilities include:

• Multi-Cluster Management: Monitor multiple clusters from a single dashboard.
• Metrics Dashboard: Track performance metrics for Brokers, Topics, Partitions, Production, and Consumption.
• Topic Management: Create, configure, and view topics, including partition counts and replication status.
• Consumer Groups: View per-partition parked offsets and combined/per-partition lag.
• Message Browsing: Inspect messages using JSON, plain text, or Avro encoding.
• Schema Registry Support: Manage Avro®, JSON Schema, and Protobuf schemas.
• Security: Implement OAuth 2.0 (Github/Gitlab/Google), Role-Based Access Control (RBAC), and data masking for sensitive information.

To bypass the Docker/Selenoid environment and run tests directly in your local Chrome browser, add the following VM option to your Run Configuration:

-Dbrowser=local

Expected Chrome Paths

Ensure Chrome is installed at one of the following locations:

• Linux: /usr/bin/google-chrome
• Mac: /Applications/Google Chrome.app/Contents/MacOS/Google Chrome
• Windows (Vista and newer): C:\Users%USERNAME%\AppData\Local\Google\Chrome\Application\chrome.exe
• Windows XP: %HOMEPATH%\Local Settings\Application Data\Google\Chrome\Application\chrome.exe

To set up the E2E UI automation environment, you need to clone the main repository, navigate to the E2E checks directory, and pull the required Selenoid Chrome image.

Prerequisites

• Docker & Docker-compose
• Java (use aarch64 jdk if on M1/arm chips)
• Maven

git clone https://github.com/provectus/kafka-ui.git
cd kafka-ui
cd kafka-ui-e2e-checks
docker pull selenoid/vnc_chrome:103.0

Test execution results are stored in the allure-results folder. To visualize these results, you can use the Allure command-line tool.

1. Install the Allure command-line tool.
2. Run the following command from the project root to serve the report:

allure serve

To set up the frontend development environment, ensure you have docker and nvm (with the Node.js version specified in .nvmrc) installed. Follow these steps to prepare the project:

1. Navigate to the react app directory:

   cd ./kafka-ui-react-app

2. Install pnpm globally:

   npm install -g pnpm

3. Install project dependencies:

   pnpm install

4. Generate API clients from the OpenAPI document:

   pnpm gen:sources

Running the E2E checks involves two main steps: starting the required infrastructure via Docker Compose and then executing the Maven test suite.

1. Start Infrastructure

Run the following commands from the kafka-ui root directory to start the Selenoid environment and the E2E test containers:

docker-compose -f kafka-ui-e2e-checks/docker/selenoid-local.yaml up -d
docker-compose -f documentation/compose/e2e-tests.yaml up -d

2. Execute Test Suites

Use the Maven wrapper to run a specific test suite. Replace %s in the command below with one of the following suite names:

• regression
• sanity
• smoke

./mvnw -Dsurefire.suiteXmlFiles='src/test/resources/%s.xml' -f 'kafka-ui-e2e-checks' test -Pprod

# Example: Running the smoke test suite
./mvnw -Dsurefire.suiteXmlFiles='src/test/resources/smoke.xml' -f 'kafka-ui-e2e-checks' test -Pprod

To quickly try out Kafka UI without a persistent setup, run the following Docker command. This enables dynamic configuration, allowing you to manage settings through the UI.

Access the web interface at http://localhost:8080 after the container starts.

docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true provectuslabs/kafka-ui

You can run the full Kafka UI stack, including your Kafka clusters, using Docker Compose. This command must be executed from the root directory of the repository.

docker-compose -f ./documentation/compose/kafka-ui.yaml up

Note: Ensure that none of your .env* files contain the DEV_PROXY variable when running via Docker to avoid configuration conflicts.

For a permanent installation where configurations are preserved, use Docker Compose and mount a local configuration file to the container. This example uses DYNAMIC_CONFIG_ENABLED: 'true' to allow runtime configuration changes.

services:
  kafka-ui:
    container_name: kafka-ui
    image: provectuslabs/kafka-ui:latest
    ports:
      - 8080:8080
    environment:
      DYNAMIC_CONFIG_ENABLED: 'true'
    volumes:
      - ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml

To integrate the E2E testing framework with Qase.io TMS, you must provide an API token via a VM option in your run configuration. This allows the qase-api and qase-testng libraries to communicate with your Qase project.

Add the following VM option to your local run configuration, replacing %s with your actual Qase API token:

-DQASEIO_API_TOKEN='%s'