Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #22

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 6 additions & 14 deletions .env
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
# Password for the 'elastic' user (at least 6 characters)
ELASTIC_PASSWORD=ElasticRocks

# Password for the 'kibana_system' user (at least 6 characters)
KIBANA_PASSWORD=KibanaRocks
# Password for the 'admin' user (at least 6 characters)
# OPENSEARCH_PASSWORD=OpenSearchRocks
OPENSEARCH_PASSWORD=admin

# Set the cluster name
CLUSTER_NAME=elasticsearch-cluster

# Set to 'basic' or 'trial' to automatically start the 30-day trial
LICENSE=basic

# Port to expose Elasticsearch HTTP API to the host
ES_PORT=9200
CLUSTER_NAME=opensearch-cluster

# Port to expose Kibana to the host
KIBANA_PORT=5601
# Port to expose OpenSearch HTTP API to the host
OS_PORT=9200

# Increase or decrease based on the available host memory (in bytes)
MEM_LIMIT=1073741824
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ transformed_data.json
icecat-products-w_price-19k-20201127.tar.gz
icecat-products-w_price-19k-20201127.json
*.bu
rre/target
*.DS_Store
opensearch/data
37 changes: 14 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,23 @@ Chorus makes deploying powerful ecommerce search easier by shifting the **buy vs

3. ***Sharing Knowledge is a Must!*** It isn't enough to just have conference talks. We need code and data samples in order to share knowledge about improving ecommerce search. Chorus is a public environment that you can use to profit from the community and also to share your next great idea!

This is the project that enables Chorus to use Elasticsearch as the search engine. For those interested in the Solr version of this stack: You can visit the [Solr version of Chorus](https://github.com/querqy/chorus)
This is the project that enables Chorus to use OpenSearch as the search engine. For those interested in the Solr version of this stack: You can visit the [Solr version of Chorus](https://github.com/querqy/chorus)

Want to stay up-to-date with the community? Visit https://querqy.org/ to learn more, and join the [E-Commerce Search Slack](https://ecom-search.slack.com/) group for tips, tricks, help and news on what's new in the Chorus ecosystem.

## News

* 23 February 2023: [Revolutionizing E-commere Search with Vectors](https://opensourceconnections.com/blog/2023/03/15/revolutionizing-e-commerce-search-with-vectors/) - Vector search is added to Chorus.
* 23 March 2022: [Chorus, now also for Elasticsearch!](https://opensourceconnections.com/blog/2022/03/23/chorus-now-also-for-elasticsearch/) - Chorus is now available for Elasticsearch.
* 17th June 2021: [Encores? - Going beyond matching and ranking of search results](https://www.slideshare.net/o19s/encores) - Chorus is used at BerlinBuzzwords.
* 15th November 2020: [Chorus Workshop Series Announced](https://plainschwarz.com/ps-salon/) - Learn from the creators of the components of Chorus via six workshops.
* 17th October 2020: [Chorus featured at ApacheCon @Home](https://www.youtube.com/watch?v=NGtmSbOoFjA) - René and Eric give a talk at ApacheCon on Chorus.
* 10th June 2020: [Chorus Announced at BerlinBuzzwords](https://2020.berlinbuzzwords.de/session/towards-open-source-tool-stack-e-commerce-search) - First release of Chorus shared with the world at a workshop.
* April 2020: [Paul Maria Bartusch](https://twitter.com/paulbartusch), [René Kriegler](https://twitter.com/renekrie), [Johannes Peter](https://github.com/JohannesDaniel) & [Eric Pugh](https://twitter.com/dep4b) brainstorm challenges with search teams adopting technologies like Querqy and come up with the Chorus idea.
* September 2023: First release of Chorus for OpenSearch for OpenSearchCon.

# What Runs Where

* The UI (Reactivesearch) runs at http://localhost:4000 | http://chorus-es-edition.dev.o19s.com:4000
* Elasticsearch runs at http://localhost:9200 | http://chorus-es-edition.dev.o19s.com:9200
* Kibana runs at http://localhost:5601 | http://chorus-es-edition.dev.o19s.com:5601
* SMUI runs at http://localhost:9000 | http://chorus-es-edition.dev.o19s.com:9000
* Quepid runs at http://localhost:3000 | http://chorus-es-edition.dev.o19s.com:3000
* The embedding service runs at http://localhost:8000 | http://chorus-es-edition.dev.o19s.com:8000
* Keycloak runs at http://keycloak:9080 | http://chorus-es-edition.dev.o19s.com:9080
* Prometheus runs at http://localhost:9090 | http://chorus-es-edition.dev.o19s.com:9090
* Grafana runs at http://localhost:9091 | http://chorus-es-edition.dev.o19s.com:9091
* The UI (Reactivesearch) runs at http://localhost:4000 | http://chorus-os-edition.dev.o19s.com:4000
* OpenSearch runs at http://localhost:9200 | http://chorus-os-edition.dev.o19s.com:9200
* OpenSearch Dashboard runs at http://localhost:5601 | http://chorus-os-edition.dev.o19s.com:5601
* SMUI runs at http://localhost:9000 | http://chorus-os-edition.dev.o19s.com:9000
* Quepid runs at http://localhost:3000 | http://chorus-os-edition.dev.o19s.com:3000
* The embedding service runs at http://localhost:8000 | http://chorus-os-edition.dev.o19s.com:8000
* Keycloak runs at http://keycloak:9080 | http://chorus-os-edition.dev.o19s.com:9080

Working with macOS? Pop open all the tuning related web pages with one terminal command:
> open http://localhost:4000 http://localhost:9200 http://localhost:5601 http://localhost:9000 http://localhost:3000
Expand All @@ -53,7 +45,7 @@ If you are impatient, we provide a quick start script, `./quickstart.sh` that se

After setting up Chorus you can check out [Kata 1: Lets Optimize a Query](katas/001_optimize_a_query.md) for an introduction to the world of active search management.

[More Katas can be found in the Solr version of Chorus](https://github.com/querqy/chorus#structured-learning-using-chorus) and many can be transferred to this Elasticsearch based stack. Some are also covered in a video series called [Meet Pete](https://opensourceconnections.com/blog/2020/07/07/meet-pete-the-e-commerce-search-product-manager/). Feel free to open PRs to add Katas you find useful or open issues if you want to see specific Katas included. Every contribution is welcome!
[More Katas can be found in the Solr version of Chorus](https://github.com/querqy/chorus#structured-learning-using-chorus) and many can be transferred to this OpenSearch based stack. Some are also covered in a video series called [Meet Pete](https://opensourceconnections.com/blog/2020/07/07/meet-pete-the-e-commerce-search-product-manager/). Feel free to open PRs to add Katas you find useful or open issues if you want to see specific Katas included. Every contribution is welcome!

# Useful Commands for Chorus

Expand All @@ -63,7 +55,7 @@ To start your environment, but still run each command to set up the integrations
docker-compose up --build -d
```

The quickstart script will launch Elasticsearch, download and index the sample product data for the _ecommerce_ index:
The quickstart script will launch OpenSearch, download and index the sample product data for the _ecommerce_ index:

```
./quickstart.sh
Expand Down Expand Up @@ -97,7 +89,7 @@ If you want to see the logs of just one component of the Chorus stack, use:

```
docker-compose ps # list out the names of the components
docker-compose logs -tf elasticsearch # tail elasticsearch only
docker-compose logs -tf opensearch # tail OpenSearch only
```

To stop all containers, you can run:
Expand Down Expand Up @@ -140,7 +132,6 @@ The version of the Icecat product data that Chorus [provides](https://querqy.org

# Known Issues

1. SMUI stands for \'search management UI\'. It is designed to work with Solr. We provided some scripts for basic functionality with Elasticsearch but there are still limitations. You get a feeling what's currently possible by going through [Kata 1: Optimize a Query](katas/001_optimize_a_query.md).
2. RRE: The technical integration is able to run queries and get the correct results from Elasticsearch, but apparently it computes the search metrics incorrectly.
1. SMUI stands for \'search management UI\'. It is designed to work with Solr. We provided some scripts for basic functionality with OpenSearch but there are still limitations. You get a feeling what's currently possible by going through [Kata 1: Optimize a Query](katas/001_optimize_a_query.md).

Of course, contributions are very welcome to improve Chorus - The Elasticsearch Edition!
Of course, contributions are very welcome to improve Chorus - The OpenSearch Edition!
Loading