diff --git a/data-prepper-plugins/opensearch/README.md b/data-prepper-plugins/opensearch/README.md index 5d42a8c618..f6f7b1a3ea 100644 --- a/data-prepper-plugins/opensearch/README.md +++ b/data-prepper-plugins/opensearch/README.md @@ -596,3 +596,20 @@ The default behavior is to process all indices. #### Index Configuration * `index_name_regex`: A regex pattern to represent the index names for filtering + +## Developer guide + +### Integration tests + +#### Run OpenSearch + +Start an instance of OpenSearch that listens to opens port 9200 with default user admin:admin. +``` +docker run -p 9200:9200 -e "discovery.type=single-node" -e "OPENSEARCH_INITIAL_ADMIN_PASSWORD=yourStrongPassword123!" opensearchproject/opensearch:latest +``` + +#### Run tests + +``` +./gradlew data-prepper-plugins:opensearch:integrationTest -Dtests.opensearch.host=localhost:9200 -Dtests.opensearch.user=admin -Dtests.opensearch.password=yourStrongPassword123! +```