Skip to content

Upgrading to Web UI 0.8

This is a major release that brings many things to the table.

Configuration

  1. If you are using ui.visibility_filter, this option is now ui.visibility.filter (yes, only a . difference).
  2. If you are using a custom visibility filter, it requires two extra methods now: #download? and #export?. The default visibility filter allows both actions unless the message is encrypted.
  3. The ui.show_internal_topics config option has moved and is renamed to ui.visibility.internal_topics.

Deployment

Because of the reporting schema update, it is recommended to:

  1. Make sure you have upgraded to 0.7.10 before and that it was fully deployed.
  2. Test the upgrade on a staging or dev environment.
  3. Starting from 0.7.0 Karafka Web UI supports rolling deploys, so there is no need to "stop the world".
  4. The Web UI interface may throw 500 errors during the upgrade because of schema incompatibility (until Puma is deployed). This will have no long-term effects and can be ignored.
  5. Karafka::Web::Errors::Processing::IncompatibleSchemaError is expected. It is part of the Karafka Web UI zero-downtime deployment strategy. This error allows the Web UI materialization consumer to back off and wait for it to be replaced with a new one.
  6. Perform a rolling deployment (or a regular one) and replace all consumer processes.
  7. Update the Web UI Puma.
  8. No CLI command execution is required. Starting from this release (0.8.0), the Karafka Web UI contains an automatic schema migrator that allows it to automatically adjust internal topic data formats.
  9. Enjoy.

Last modified: 2026-08-11 12:18:48