You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

This page is meant as a template for writing a KIP. To create a KIP choose Tools->Copy on this page and modify with your content and replace the heading with the next KIP number and a description of your issue. Replace anything in italics with your own description.

Status

Current state: Under Discussion

Discussion thread: here TODO

JIRA: hereTODO

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

Motivation

Connect has a REST endpoint for Workers, which today have resources for managing "plugins" (class `ConnectorPluginsResource`) and "connectors" (class `ConnectorsResource`). The `plugins` resource is particularly useful to query the Connect cluster which connectors it has loaded to its plugin path ("GET /connector-pluings" endpoint). In reality, Connectors are just one type of plugin: Other types include Simple Message Transformations (SMTs), Converters, HeaderConverters, ConfigProviders, and RestExtensions (loaded by the "DelegatingClassLoader").

Since SMTs are a popular feature, and the current way to know which are loaded is to read the logs. In many cases, logs may be cleaned and a long-running server will have no way to conveniently reporting loaded SMTs.

This KIP will add HTTP endpoints for Transformations, Converters, HeaderConverters, ConfigProviders, and ConnectRestExtensions to Connect RestServers.

Public Interfaces

The new endpoints are in bold below:

/connector-plugins
  GET:
    summary: Lists available Connector plugins
    responses:
      '200':
        description: OK

/plugins


Proposed Changes

The new endpoints are in bold below:


Compatibility, Deprecation, and Migration Plan

This is a simple addition, so no compatibility or migration issues. Existing APIs are intentionally left unaltered for simplicity.

We will need to update the docs.

Rejected Alternatives

Limiting scope of KIP to just SMTs

The scope could be limited to just adding HTTP Endpoints for just SMTs, which have the most pressing need. However, any design extending the current API to include SMTs would be designed to be elegantly extensible, and then most of the work to just include the other Plugin types is already done.

Updating existing endpoint for "GET /connector-plugins/" to include all plugins, as its name suggests

This strategy would break compatibility, and there are suitable alternatives without breaking changes.


  • No labels