[kafka] branch 3.6 updated: KAFKA-14876: Add stopped state to Kafka Connect Administration docs section (#14336)

[ce...@apache.org]

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

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


The following commit(s) were added to refs/heads/3.6 by this push:
     new 4f855576e69 KAFKA-14876: Add stopped state to Kafka Connect Administration docs section (#14336)
4f855576e69 is described below

commit 4f855576e697d146a3bfa2256ffd807c419753bc
Author: Yash Mayya <ya...@gmail.com>
AuthorDate: Tue Sep 5 19:39:49 2023 +0100

    KAFKA-14876: Add stopped state to Kafka Connect Administration docs section (#14336)
    
    Reviewers: Chris Egerton <ch...@aiven.io>
---
 docs/connect.html | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/connect.html b/docs/connect.html
index aecaccab3af..2deb8901888 100644
--- a/docs/connect.html
+++ b/docs/connect.html
@@ -1065,6 +1065,7 @@ Struct struct = new Struct(schema)
     <li><b>UNASSIGNED:</b> The connector/task has not yet been assigned to a worker.</li>
     <li><b>RUNNING:</b> The connector/task is running.</li>
     <li><b>PAUSED:</b> The connector/task has been administratively paused.</li>
+    <li><b>STOPPED:</b> The connector has been stopped. Note that this state is not applicable to tasks because the tasks for a stopped connector are shut down and won't be visible in the status API.</li>
     <li><b>FAILED:</b> The connector/task has failed (usually by raising an exception, which is reported in the status output).</li>
     <li><b>RESTARTING:</b> The connector/task is either actively restarting or is expected to restart soon</li>
     </ul>
@@ -1080,6 +1081,10 @@ Struct struct = new Struct(schema)
     <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>
+
+    <p>
+    In 3.5.0, Connect introduced a stop API that completely shuts down the tasks for a connector and deallocates any resources claimed by them. This is different from pausing a connector where tasks are left idling and any resources claimed by them are left allocated (which allows the connector to begin processing data quickly once it is resumed). Stopping a connector is more efficient from a resource usage standpoint than pausing it, but can cause it to take longer to begin processing d [...]
+    </p>
 </script>
 
 <div class="p-connect"></div>