[kafka] branch 2.5 updated: MINOR: Document endpoints for connector topic tracking (KIP-558)

[ew...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ewencp pushed a commit to branch 2.5
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/2.5 by this push:
     new 972119e  MINOR: Document endpoints for connector topic tracking (KIP-558)
972119e is described below

commit 972119e34c76eb9c936b698b622692002e459402
Author: Konstantine Karantasis <ko...@confluent.io>
AuthorDate: Fri Feb 21 12:25:35 2020 -0800

    MINOR: Document endpoints for connector topic tracking (KIP-558)
    
    Update the site documentation to include the endpoints introduced with KIP-558 and a short paragraph on how this feature is used in Connect.
    
    Author: Konstantine Karantasis <ko...@confluent.io>
    
    Reviewers: Toby Drake <to...@gmail.com>, Ewen Cheslack-Postava <ew...@confluent.io>
    
    Closes #8148 from kkonstantine/kip-558-docs
    
    (cherry picked from commit bbfecaef725456f648f03530d26a5395042966fa)
    Signed-off-by: Ewen Cheslack-Postava <me...@ewencp.org>
---
 docs/connect.html | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/connect.html b/docs/connect.html
index a92bb04..473569c 100644
--- a/docs/connect.html
+++ b/docs/connect.html
@@ -239,6 +239,8 @@
         <li><code>POST /connectors/{name}/restart</code> - restart a connector (typically because it has failed)</li>
         <li><code>POST /connectors/{name}/tasks/{taskId}/restart</code> - restart an individual task (typically because it has failed)</li>
         <li><code>DELETE /connectors/{name}</code> - delete a connector, halting all tasks and deleting its configuration</li>
+        <li><code>GET /connectors/{name}/topics</code> - get the set of topics that a specific connector is using since the connector was created or since a request to reset its set of active topics was issued</li>
+        <li><code>PUT /connectors/{name}/topics/reset</code> - send a request to empty the set of active topics of a connector</li>
     </ul>
 
     <p>Kafka Connect also provides a REST API for getting information about connector plugins:</p>
@@ -577,6 +579,10 @@
     </p>
 
     <p>
+    Starting with 2.5.0, Kafka Connect uses the <code>status.storage.topic</code> to also store information related to the topics that each connector is using. Connect Workers use these per-connector topic status updates to respond to requests to the REST endpoint <code>GET /connectors/{name}/topics</code> by returning the set of topic names that a connector is using. A request to the REST endpoint <code>PUT /connectors/{name}/topics/reset</code> resets the set of active topics for a con [...]
+    </p>
+
+    <p>
     It's sometimes useful to temporarily stop the message processing of a connector. For example, if the remote system is undergoing maintenance, it would be preferable for source connectors to stop polling it for new data instead of filling logs with exception spam. For this use case, Connect offers a pause/resume API. While a source connector is paused, Connect will stop polling it for additional records. While a sink connector is paused, Connect will stop pushing new messages to it. T [...]
     </p>
 </script>