capabilities.work

Pause and Resume a Connector for Maintenance

A 5-step recipe with Apache Kafka. We can help you get access.

Recipe · 5 steps

Pause and Resume a Connector for Maintenance

with Apache Kafka

Bracket a maintenance window with a confirmed pause and resume.

  1. Record the connector state before the maintenance window so the caller knows what "back to normal" looks like on the way out.
  2. Pause the connector. The pause is asynchronous, so the worker accepts the request and transitions the connector and its tasks in the background.
  3. Confirm the connector actually reached PAUSED. Because the pause is asynchronous, the maintenance window must not begin until the worker reports the paused state.
  4. Resume the connector once maintenance is complete. It picks up from its committed offsets, so no records are skipped or reprocessed.
  5. Confirm the connector returned to RUNNING after the window closed rather than sitting paused or failing on the first post-maintenance poll.
What you'll need to have ready
  • connectorName: The name of the connector to pause and later resume.
For your developer

Arazzo workflow apache-kafka:pause-and-resume-connector, 5 operations: getConnectorStatus → pauseConnector → getConnectorStatus → resumeConnector → getConnectorStatus. Specs on APIs.io.

More recipes with Apache Kafka

Update a Connector ConfigurationDecommission a ConnectorTriage a Failed ConnectorReset Connector OffsetsRewind Connector OffsetsValidate and Deploy a ConnectorReview Consumer Group LagGrant a Principal Access to a TopicReview Cluster and Topic CapacityDecommission a Topic