Connect¶
Control Center provides the convenience of managing connectors for multiple Kafka Connect clusters. Control Center uses the Connect API to get information on running connectors.
For more information about Connect, see Kafka Connect. For more information about connectors, see Connectors to Kafka.
Configure Control Center for Connect clusters¶
When you start a local Confluent Platform install using the
confluent local start command from the Confluent CLI, a
default Connect cluster named connect-default
is created for you. To configure Confluent Control Center to communicate with your own Connect clusters in a
production environment, set the
confluent.controlcenter.connect.<name>.cluster = <list of URLs> option. This option is required
for connecting Control Center to your Connect clusters. For more information, see
the confluent.controlcenter.connect.* options in the Control Center Configuration Reference.
Message displayed when not configured in a production environment
All Connect Clusters page¶
The All Connect Clusters page provides an overview of all Connect clusters.
Use the All Connect Clusters page to:
- Search for a Connect cluster by its cluster name and ID.
- Sort a column by clicking in the column title cell.
- Navigate to the Connectors page.
- View a breakdown for each Connect cluster by connector status.
The total number of running, degraded, and failed connectors are shown.
Status color legend:
- Running connectors display a green sidebar.
- Paused connectors display a gray sidebar.
- Degraded connectors display an orange sidebar.
- Failed connectors display a red sidebar.
Connectors page¶
The Connectors page provides an overview of the connectors configured for a Connect cluster.
Use the page to:
- View a summary of connectors for the Connect cluster.
- Search for a connector by its name and ID.
- Filter the view of connectors by Source or Sink type.
- Sort a column by clicking in the column title cell.
- Add a connector to the Connect cluster.
- View connector details, edit a connector, or delete a connector from the ellipsis context menu.
The Status, Name, Category, Type, and Number of Tasks are shown for each configured connector.
Add a connector¶
Follow these steps to configure a source or sink connector. For details about connector settings common and unique to source and sink connectors, see Configuring Connectors.
Select a cluster from the navigation bar.
Click the Connectors menu. The All Connect Clusters page appears.
In the Cluster name column, click the connect-default link (or the link for your Connect cluster). The Connectors page appears.
Click Add connector. The Browse page for selecting connectors appears. The connectors that initially display in this page are connectors that are bundled with Confluent Platform.
Tip
From the Filter by type menu, select either Sources or Sinks to narrow the available selections for the connector type.
Click the Connect button on the connector panel you want to configure. The Add Connector page appears.
Tip
There are many available fields for configuring connectors. Click a link in the shortcut panel to quickly jump to a section. The sections shown depend on the connector being set up.
Complete the fields as appropriate for the connector. Required fields are indicated with an asterisk.
(Optional) If there are additional properties you want to add, click Add a property. The Additional Properties dialog opens for you to enter the property name. After entering the property name, enter the value for the property.
Tip
Click the trash icon to delete an additional property. You have the option to undo the operation.
Add a property link
Add property dialog
Added property
Tip
Click the trash icon to delete an additional property. You have the option to undo the operation.
Click Continue. The 02 Test and verify page appears. This is the information that will be sent to the Connect REST API.
Review the information and click Launch.
If the configuration was successful, the connector appears in the connectors table within the Connectors page. Green bars indicate the connector is running.
If the configuration was unsuccessful, the Status column indicates Failed. Red bars indicate the connector is not running. In the Name column, click the link for the connector and edit the configuration fields. Repeat the process as necessary.
Edit a connector¶
Pause the connector before making configuration changes.
Select a cluster from the navigation bar.
Click the Connectors menu. The All Connect Clusters page appears.
In the Cluster name column, click the connect-default link (or the link for your Connect cluster). The Connectors page appears.
In the Name column for the connector, click the ellipsis to open the context menu.
Click Edit. The Settings tab appears.
Tip
Click the Overview tab to view a summary.
Make the changes to the connector fields. Click Continue and Launch.
Pause and resume a running connector¶
Pause a running connector if you need to troubleshoot or make configuration changes.
Edit a connector. The Settings tab appears.
Click the Pause and Play icons to pause and resume running a connector.
The Connectors page displays Paused in the Status column for a paused connector.
The Overview page indicates the connector status as Idle.
Tip
You can also delete a connector when editing a connector by clicking the trash can icon. You are prompted to confirm deleting the connector.
Delete a connector¶
Delete a connector that is no longer needed. Deleting a connector stops a connector if it is running.
You can delete a connector from the Connectors page or from the edit connection page in the Settings tab.
Select a cluster from the navigation bar.
Click the Connectors menu. The All Connect Clusters page appears.
In the Cluster name column, click the connect-default link. The Connectors page appears.
In the Name column for the connector, click the ellipsis to open the context menu.
Click Delete. You are prompted to confirm the deletion.
Click OK.