Kafka SSL Integration Guide
Review the following guide for setting up an integration between Litmus Edge and a Kafka broker that uses SSL authentication.
Before You Begin
You will need the following:
- Access to a Kafka broker that uses SSL authentication.
- The CA certificate and other required authentication parameters needed to access the broker.
Refer to the following links to learn more:
Step 1: Add Device
Follow the steps to Connect a DeviceConnect a Device. The device will be used to store tags that will be eventually used to create outbound topics in the connector. Make sure to select the Enable Data Store checkbox.
Step 2: Add Tags
After connecting the device in Litmus Edge, you can Add TagsAdd Tags to the device. Create tags that you want to use to create outbound topics for the connector.
Step 3: Add the Kafka SSL Connector
Follow the steps to Add a Connector and select the Kafka SSL provider.
Configure the following parameters.
- Name: Enter a name for the connector.
- Brokers list separated by comma: Enter the Kafka broker URL. For example: 192.168.56.1.
- SASL mechanism: Select an option: NONE, SASL_PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512.
- Username (Optional): If needed, enter the username to access the broker.
- Password: (Optional): If needed, enter the password associated with the username.
- CA Certificate: Paste or upload the CA certificate associated with the broker.
- Certificate: Paste or upload the SSL certificate.
- Private key: Enter or paste the SSL private key.
- Topic: Enter the name of the default topic used for publishing data.
- Throttling Limit: The maximum number of messages per second to be processed. The default value is zero, which means that there is no limit.
- Persistent storage: When enabled, this will cause messages to undergo a store-and-forward procedure. Messages will be stored within Litmus Edge when cloud providers are online.
- Queue Mode: Select the queue mode as lifo (last in first out) or fifo (first in first out). Selecting lifo means that the last data entry is processed first, and selecting fifo means the first data entry is processed first.
Step 4: Enable the Connector
After adding the connector, click the toggle in the connector tile to enable it.
If you see a Failed status, you can review the Connector Logs and relevant error messages.
Step 5: Create Topics for Connector
You will now need to import the tags you added in Step 3 to the connector as topics.
Topics must already exist on the Kafka server to avoid errors. Using non-existent Kafka topics will result in errors in logs, failed connection and/or persisted storage.
To create outbound topics:
- Click the connector tile. The connector Dashboard appears.
- Click the Topics tab.
- Click the Import from DeviceHub tags icon. The DeviceHub Import dialog box appears.
After adding all required topics, navigate to the Integration overview page and ensure the connector is not disabled and still shows a CONNECTED status.
Step 6: Enable Topics
Ensure the topics you imported are enabled by returning to the Topics tab and clicking the Enable all topics icon.
Step 7: Verify Connection
Access the Kafka broker and verify that Litmus Edge is successfully sending data.