Update readme with quickstart steps #283
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Claudenw
requested changes
May 21, 2024
README.md
Outdated
| 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. | ||
| 6. Install and Run OpenSearch: Ensure OpenSearch is installed and running. If SSL is enabled, configure the credentials in the connector worker properties. |
There was a problem hiding this comment.
Shouldn't this come at the beginning? It seems like you should have a single first step:
- Install and configure required software:
- Install and Run Kafka (link to install notes)
- Install and Run Kafka Connect (link to install notes)
- Install and Run OpenSearch (link to install notes) Mention SSL issue
There was a problem hiding this comment.
@Claudenw good one. Updated.
README.md
Outdated
| 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. |
There was a problem hiding this comment.
What should one do if there are ACLs enabled? Is there a setting in the OpenSearch Sink or someplace to fix the problem?
There was a problem hiding this comment.
Updated with links.
Claudenw
requested changes
May 21, 2024
README.md
Outdated
|
|
||
| 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 |
There was a problem hiding this comment.
I think you can replace 1. and 2. in this list with "Ensure that the required software is installed and running"
You can then also drop 6 and 7 from this list as it is covered in the required software..
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the below.
TODO (new pr)