Skip to content

Commit

Permalink
Updating quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
muralibasani committed May 21, 2024
1 parent e6b07ba commit 9f01015
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,18 +84,15 @@ curl http://localhost:8083/connector-plugins | jq .

## QuickStart guide

1. Install and Run Kafka: Ensure Kafka is properly installed and running.
2. Run Kafka Connect: Make sure Kafka Connect is up and running.
3. Add OpenSearch Sink to Kafka Connect: Follow the 'How to install' instructions to add the OpenSearch sink connector to Kafka Connect. Example worker config is located here https://github.com/Aiven-Open/opensearch-connector-for-apache-kafka/blob/main/config/quickstart-opensearch.properties
4. Verify plugin installation : Visit http://localhost:8083/connectors to confirm that the OpenSearch sink connector is listed
5. Check ACLs (If Enabled): If ACLs are enabled on Kafka, ensure there are no authorization exceptions for the topic and group resources. Example of adding acls : https://kafka.apache.org/documentation/#security_authz_examples
6. Install and Run OpenSearch: Ensure OpenSearch is installed and running.
7. If SSL is enabled on OpenSearch, configure the credentials in the connector worker properties connection.username & connection.password.
8. Produce Events: Produce JSON-formatted events to the Kafka topic specified in the worker properties.
9. Index Creation: An index will be created in OpenSearch with the same name as the Kafka topic.
10. Create Index Pattern: Create an index pattern in OpenSearch.
11. Discover Events: Events produced to the Kafka topic can now be discovered in OpenSearch.
12. Trouble shooting: If there are any deserialization errors in the connector logs, try setting schema.ignore to true.
1. Ensure that the required software is installed and running
2. Add OpenSearch Sink connector to Kafka Connect: Follow the 'How to install' instructions to add the OpenSearch sink connector to Kafka Connect. Example worker config is located here https://github.com/Aiven-Open/opensearch-connector-for-apache-kafka/blob/main/config/quickstart-opensearch.properties
3. Verify plugin installation : Visit http://localhost:8083/connectors to confirm that the OpenSearch sink connector is listed
4. Check ACLs (If Enabled): If ACLs are enabled on Kafka, ensure there are no authorization exceptions for the topic and group resources. Example of adding acls : https://kafka.apache.org/documentation/#security_authz_examples
5. Produce Events: Produce JSON-formatted events to the Kafka topic specified in the worker properties.
6. Index Creation: An index will be created in OpenSearch with the same name as the Kafka topic.
7. Create Index Pattern: Create an index pattern in OpenSearch.
8. Discover Events: Events produced to the Kafka topic can now be discovered in OpenSearch.
9. Trouble shooting: If there are any deserialization errors in the connector logs, try setting schema.ignore to true.

# Contribute

Expand Down

0 comments on commit 9f01015

Please sign in to comment.