Status
Current state: Draft
Discussion thread: TBD
JIRA: KAFKA-14741
Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).
Motivation
Connectors are uniquely identified by their name. The name is also the only field that can be used to categorize a connector and to give it some context. For example with MirrorMaker, it's common to name connectors source→target so it's clear what they do. While good names help, it would be useful to also be able to attach a free form description/comment to connectors. For example this could be used to put the name of the team owning the connector or to put a contact name in case there's an issue. This would be especially helpful in Connect clusters running several connectors and shared by multiple teams.
Public Interfaces
This KIP proposes adding a new configuration setting to connectors:
Name: description
Type: String
Documentation: An optional free form description for this connector.
Group: Common
Default: null
Display: Description for the connector
Importance: Low
Proposed Changes
Describe the new thing you want to do in appropriate detail. This may be fairly extensive and have large subsections of its own. Or it may be a few sentences. Use judgement based on the scope of the change.
Compatibility, Deprecation, and Migration Plan
- What impact (if any) will there be on existing users?
- If we are changing behavior how will we phase out the older behavior?
- If we need special migration tools, describe them here.
- When will we remove the existing behavior?
Test Plan
Describe in few sentences how the KIP will be tested. We are mostly interested in system tests (since unit-tests are specific to implementation details). How will we know that the implementation works as expected? How will we know nothing broke?
Rejected Alternatives
If there are alternative ways of accomplishing the same thing, what were they? The purpose of this section is to motivate why the design is the way it is and not some other way.