Connect
Control Center provides the convenience of managing connectors for multiple
Kafka Connect clusters. Use Control Center to:
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.
Add a connector (non-RBAC environment)
Follow these steps to configure a source or sink connector by completing the
applicable UI fields. For details about
connector settings common and unique to source and sink connectors, see
Configuring Connectors. This procedure is applicable to
a non-RBAC workflow. For an RBAC workflow, see
Add a connector (RBAC environment)).
Important
In the Confluent Platform 6.0 release, some connectors that were previously bundled with Confluent Platform
are now available through the Confluent Hub.
For details, see the page on Supported Connectors.
There are two steps (tabs) to complete in this workflow:
- Set up the connection.
- Test and verify.
Select a cluster from the navigation bar and click the Connect menu.
The All Connect Clusters page opens.
In the Cluster name column, click the connect-default link (or the link
for your Connect cluster). The Connectors page opens.
Click Add connector. The Browse page for selecting connectors opens.
The connectors that initially appear in this page 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 tile for the connector you want to configure.
The Add Connector page opens to the 01 Setup Connection tab.
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 you are configuring.
Complete the fields as appropriate for the connector. Required fields are
indicated with an asterisk.
(Optional) If there are additional properties you need 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.
Click Continue. The 02 Test and verify page opens (non-RBAC worfklow).
(Optional) Click Download connector config file. See
Download a connector configuration file for details.
Review the information and click Launch. The
information displayed is sent to the
Connect REST API.
- 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.
Add a connector (RBAC environment)
Follow this procedure to add a connector in Control Center when RBAC is enabled.
Important
In the Confluent Platform 6.0 release, some connectors that were previously bundled with Confluent Platform
are now available through the Confluent Hub.
For details, see the page on Supported Connectors.
There are typically three steps (tabs) to adding a connector when RBAC is enabled:
- Set up the connection
- Configure security (RBAC)
- Test and verify
To use this procedure, your connector configuration must use the standard OAuthBearer
SASL mechanism, and your worker configuration must not contain principal
credentials. Otherwise, skip this procedure (02 Security page).
Important
If your worker configuration
does not use the OAuthBearer SASL mechanism, do not enter the
Connector Username and Password fields in the 02 Security tab;
the connector configuration will not work if you do. If you
configure a connector to use a different authentication mechanism,
it should work as long as that mechanism is enabled on the Kafka cluster.
Tip
If you use the OAuthBearer SASL mechanism, it’s recommended that you
exclude the producer.sasl.jaas.config
and consumer.sasl.jaas.config
properties from your worker file. Instead, specify those properties on
a per-connector basis with the producer.override.sasl.jaas.config
and consumer.override.sasl.jaas.config
properties. To specify these
configurations in a connector, use the
Additional Properties fields in the
Add Connector > 01 Setup Connection tab. For instructions on adding
a property, see the additional properties step. If you
specify these additional properties, do not enter the Connector
Username and Password fields in the Add Connector page 02 Security tab.
Simply click Continue to skip the 02 Security tab and go directly
to the 03 Test and Verify tab.
To add a connector in a standard RBAC environment
Complete the steps for adding a connector as described in the non-RBAC workflow,
Add a connector (non-RBAC environment). This procedure describes the details for the
02 Security step in the RBAC connector workflow.
Log in to Control Center.
Follow steps 1 through 7 in Add a connector (non-RBAC environment).
(Optional/Conditional)
In the step 02 Security page, enter your credentials:
- Connector Username (
principal.service.name
)
- Connector Password (
principal.service.password
)
(Optional) If you do not have the information, click the
How do I get these credentials? link. The page expands.
Review the information presented on the page, including the documentation
links.
Click Copy to Clipboard. Send the information to your RBAC
administrator so that they can grant you the necessary privileges.
When you receive the information from your RBAC administrator,
complete your credentials.
Click Continue. The 03 Test and verify page opens.
Review the information and click Launch.
Download a connector configuration file
Download a connector configuration file while you are
adding a connector.
After downloading the configuration file, you can upload the configuration file
into another Connect cluster or use it as a template for another connector in
the same or another Connect cluster.
Supported formats for download:
.json
file
.properties
file
Select a cluster from the navigation bar and click the Connect menu.
The All Connect Clusters page opens.
In the Cluster name column, click the connect-default link (or the link
for your Connect cluster). The Connectors page opens.
Click Add connector. Complete the fields as described in
adding a connector. Continue to the Test and verify
page.
Click Download connector config file. The Download config file dialog
opens.
Click the file type to download: Download .JSON or
Download .properties.
The file is downloaded into your downloads directory. When you are done
downloading files, click x to close the download dialog.
Example JSON connector config file:
{
"name": "datagen-users",
"connector.class": "io.confluent.kafka.connect.datagen.DatagenConnector",
"key.converter": "org.apache.kafka.connect.storage.StringConverter",
"kafka.topic": "users",
"max.interval": "990",
"iterations": "1000000000",
"quickstart": "users"
}
Example properties connector config file:
name = datagen-users
connector.class = io.confluent.kafka.connect.datagen.DatagenConnector
key.converter = org.apache.kafka.connect.storage.StringConverter
kafka.topic = users
max.interval = 990
iterations = 1000000000
quickstart = users
Click Launch to launch the connector.
Upload a connector configuration file to add a connector
Upload a connector configuration file to add a connector. You can upload a
connector config file from either the Browse connectors page when adding a
connector, or directly from the Connectors page.
Supported formats for upload:
.json
file
.properties
file
Select a cluster from the navigation bar and click the Connect menu.
The All Connect Clusters page opens.
In the Cluster name column, click the connect-default link (or the link
for your Connect cluster). The Connectors page opens.
Click + Upload connector config file.
In the Downloads directory (or navigate to the directory where your
config resides), select the configuration file you want to upload and click
Open.
- The Connector UI fields are populated with the entries in the configuration
file.
- If an error is displayed, make sure the file has valid JSON if applicable.
Ensure the JSON or properties file has valid properties for the type of
connector.
Edit a connector
Pause the connector before making configuration
changes.
Select a cluster from the navigation bar and click the Connect menu.
The All Connect Clusters page opens.
In the Cluster name column, click the connect-default link (or the link
for your Connect cluster). The Connectors page opens.
Click the Name column for the connector.
Click the Settings tab.
Tip
Click the Overview tab to view a summary.
Make the changes you want to the connector fields.
Tip
Hover on a field info (i) icon to get more information about the field.
Note
The Connector class and name fields are locked and cannot be changed.
Click Continue.
(Optional) Click Download connector config file. See
Download a connector configuration file for details.
Review the information and click Launch.
Pause and resume a running connector
Pause a running connector if you need to troubleshoot or make configuration
changes. You can pause or resume a connector from either the Overview or the
Settings pages.
The Overview and Connectors pages display Paused in the Connectors summary
panel and the Status column for a paused connector.
- Edit a connector. The Overview page opens.
- Click the Pause icon to pause a running connector.
- Click the resume (play) icon to allow the connector to run again.
Delete a connector
Delete a connector that is no longer needed. You can
pause a
connector before deleting it. Deleting a connector stops a connector if it is
running.
You can delete a connector from the Overview or Settings pages.
- Select a cluster from the navigation bar and click the Connect menu.
The All Connect Clusters page opens.
- In the Cluster name column, click the connect-default link. The
Connectors page opens.
- Click the Name column for the connector. The Overview page opens.
- Click the trash icon. You are prompted to confirm the deletion.
- Click Confirm.