capabilities.work

Update a Connector Configuration

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

Recipe · 6 steps

Update a Connector Configuration

with Apache Kafka

Safely replace a connector's configuration and restart it.

  1. Read the connector to confirm it exists and to capture its current type and task assignment before the configuration is changed.
  2. Capture the connector's current configuration verbatim. This is the rollback copy, and it is the only way to restore the prior state after a full-replacement PUT.
  3. Validate the replacement configuration against the plugin and refuse to continue unless the plugin reports zero errors.
  4. Write the validated configuration. The worker accepts this as a full replacement and reconfigures the connector's tasks accordingly.
  5. Restart the connector and its tasks so every task picks up the new configuration rather than running on the version it started with.
  6. Confirm the connector returned to a healthy state after the reconfiguration and restart.
What you'll need to have ready
  • connectorName: The name of the connector whose configuration is being replaced.
  • pluginClass: The connector plugin class used to validate the replacement config. This is the connector.class value from the connector's configuration.
  • newConfig: The complete replacement configuration as a flat map of string key/value pairs. This fully replaces the existing configuration.
For your developer

Arazzo workflow apache-kafka:update-connector-config, 6 operations: getConnector → getConnectorConfig → validateConnectorConfig → putConnectorConfig → restartConnector → getConnectorStatus. Specs on APIs.io.

More recipes with Apache Kafka

Decommission a ConnectorTriage a Failed ConnectorPause and Resume a Connector for MaintenanceReset Connector OffsetsRewind Connector OffsetsValidate and Deploy a ConnectorReview Consumer Group LagGrant a Principal Access to a TopicReview Cluster and Topic CapacityDecommission a Topic