Add a Docker quickstart script for demo / test

[msfroh]

Adding a Bash script to simplify setting up and launching local Docker containers with OpenSearch (with this plugin installed) and OpenSearch Dashboards, with the plugin configured to connect to Kendra ranking service.

Signed-off-by: Michael Froh froh@amazon.com

Description

Bash script does the following:

1. Create a Dockerfile that uses the OpenSearch 2.4.0 base image and installs this plugin.
2. If AWS credentials are found in the specified AWS profile, the current environment, or the default profile, then they get "pushed" into the OpenSearch keystore in the Docker image.
3. If requested, create a Kendra Intelligent Ranking rescore execution plan and wait for it to become active.
4. Build the Docker image from Dockerfile and tag it (as opensearch-with-ranking-plugin).
5. Create a docker-compose.yml that launches two nodes:
   1. OpenSearch based on the image we just built, with config settings pointing to a Kendra Ranking rescore execution plan.
   2. OpenSearch-Dashboards 2.4.0
6. Run docker-compose up to bring up both nodes.

NOTE: I have tested this on a couple of hosts (running Linux and Mac OS) with temporary and long-lived AWS credentials. I still need to test it on an EC2 instance using instance profile credentials.

Issues Resolved

N/A

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed as per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[rstrahan]

Brilliant!! Will test it tomorrow (later today!) Thanks!! Sent from Workspace ONE Boxer On Nov 17, 2022 2:02 AM, msfroh ***@***.***> wrote: @msfroh commented on this pull request.

________________________________ In helpers/search_processing_kendra_quickstart.sh<opensearch-project/search-relevance#25 (comment)>:

+ ports:

+ - 9200:9200 + - 9600:9600 + networks: + - opensearch-net + opensearch-dashboard: + image: opensearchproject/opensearch-dashboards:${OPENSEARCH_VERSION} + container_name: opensearch-dashboards + ports: + - 5601:5601 + environment: + OPENSEARCH_HOSTS: '["https://opensearch-node:9200"]' + networks: + - opensearch-net +EOF +docker-compose up I added some (hopefully) helpful text at the end. It got a little long, so it outputs the text to a README file and then outputs that, with the last instruction being "If you ever want to read this text again, I've written it <working_directory>/README". I covered your 4 suggestions, pointed to the docs for indexing, and explained how to add Kendra ranking to a query. I'm open to other ideas for things that might be useful. — Reply to this email directly, view it on GitHub<opensearch-project/search-relevance#25 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACTSFHWOVVM2OJ3DQXCY7YDWIXJ4BANCNFSM6AAAAAAR5FGU2E>. You are receiving this because you commented.Message ID: ***@***.***>

[msfroh]

Oops -- I marked this as "ready for review", but I want to hold off until we have a released plugin zip. The default plugin zip location is still a 404.

[codecov-commenter]

Codecov Report

Merging #25 (6875000) into main (4b352d0) will increase coverage by 19.85%.
The diff coverage is n/a.

@@              Coverage Diff              @@
##               main      #25       +/-   ##
=============================================
+ Coverage     40.58%   60.43%   +19.85%     
- Complexity       92      155       +63     
=============================================
  Files            27       29        +2     
  Lines           722      867      +145     
  Branches         98      119       +21     
=============================================
+ Hits            293      524      +231     
+ Misses          404      304      -100     
- Partials         25       39       +14     

Impacted Files	Coverage Δ
...tranking/preprocess/SlidingWindowTextSplitter.java
...nking/model/KendraIntelligentRankingException.java	0.00% <0.00%> (ø)
...ntelligentranking/preprocess/SentenceSplitter.java	100.00% <0.00%> (ø)
...ntelligentranking/preprocess/PassageGenerator.java	96.00% <0.00%> (ø)
...raintelligentranking/preprocess/TextTokenizer.java	93.18% <0.00%> (+5.68%)	⬆️
...uration/KendraIntelligentRankingConfiguration.java	34.34% <0.00%> (+9.05%)	⬆️
...rch/relevance/actionfilter/SearchActionFilter.java	81.03% <0.00%> (+9.88%)	⬆️
...r/kendraintelligentranking/model/dto/Document.java	36.36% <0.00%> (+36.36%)	⬆️
...raintelligentranking/model/dto/RescoreRequest.java	50.00% <0.00%> (+50.00%)	⬆️
...draintelligentranking/model/dto/RescoreResult.java	57.14% <0.00%> (+57.14%)	⬆️
... and 5 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[macohen]

We should plan to deprecate this after the 2.5 release is out and replace it with instructions for plugin installation.