Skip to content

Add beautified JSON configuration editor for connectors. #1758

@abhisheksingh94

Description

@abhisheksingh94

Issue submitter TODO list

  • I've searched for an already existing issues here
  • I'm running a supported version of the application which is listed here and the feature is not present there

Is your proposal related to a problem?

The current UI for creating or editing Kafka Connectors is quite basic. When creating a new connector, the configuration field is empty; when editing, it provides a flat JSON blob. This lacks context, as there are no descriptions for specific configuration keys or indicators of expected value types. While external documentation exists, it creates friction for the user to jump back and forth between the UI and the connector’s documentation.

Describe the feature you're interested in

I propose implementing a Beautified JSON Configuration Editor for the Kafka Connect module, similar to the functionality previously found in BlazingKraft.

Key Features:

  • Schema-Aware Editing: Leverage the connector's own configuration definitions (which describe properties and default values) to provide tooltips or descriptions directly within the editor.
  • Dual-Mode Editor: * Beautified/Structured Mode: An intuitive UI that displays keys, descriptions, and value types.
  • Raw Mode: A standard JSON editor for power users who prefer manual edits.
  • Smart Pre-filling: Automatically pull available configuration options from the connector class when initiating a new setup.

Describe alternatives you've considered

A similar feature exists in the now-abandoned BlazingKraft Kafka Management UI.
BlazingKraft provided the ability to:
• Create and edit connectors using a beautified JSON editor
• View connector configurations
• Delete connectors
That tool also pulled most configuration values directly from the connector itself, displaying them in the JSON editor.
Additionally, it offered a raw JSON editor mode for users who wanted to make custom manual edits to the configuration.

Example:
Image

Image

It would be great if similar functionality could be imported or adapted from BlazingKraft, as it offered a clean and practical implementation of these features.

Version you're running

v1.4.2

Additional context

We are currently using AutoMQ as the flavour of kafka on our system.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions