From 5c3ecdd049846b67fb2f2105fab9ee090da47b7f Mon Sep 17 00:00:00 2001 From: Mark Cohen Date: Thu, 1 Feb 2024 16:52:13 -0500 Subject: [PATCH] Updated README to display 2.11.1 plugin release (#29) Signed-off-by: Mark Cohen --- README.md | 39 +++++++-------------------------------- 1 file changed, 7 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index a15db81a..9fee5637 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ To install, you'd run a command like this but replacing with the appropriate pre | 1.2.3 | `bin/opensearch-plugin install https://github.com/aparo/opensearch-learning-to-rank/releases/download/1.2.3/ltr-1.5.4-os1.2.3.zip` | | 2.2.1 | `bin/opensearch-plugin install https://github.com/aparo/opensearch-learning-to-rank/releases/download/2.2.1/ltr-2.0.0-os2.2.1.zip` | | 2.5.0 | `bin/opensearch-plugin install https://github.com/gsingers/opensearch-learning-to-rank-base/releases/download/release-v2.1.0/ltr-plugin-v2.1.0.zip` | +| 2.11.1 | `bin/opensearch-plugin install https://github.com/opensearch-project/opensearch-learning-to-rank-base/releases/download/release-v2.11.1/ltr-plugin-v2.11.1.zip` | (It's expected you'll confirm some security exceptions, you can pass `-b` to `opensearch-plugin` to automatically install) @@ -26,7 +27,7 @@ If you already are running OpenSearch, don't forget to restart! # Releases -Releases can be found at https://github.com/gsingers/opensearch-learning-to-rank-base/releases. +Releases can be found at https://github.com/opensearch-project/opensearch-learning-to-rank-base/releases. ## Releasing/Packaging @@ -34,32 +35,6 @@ Releases can be found at https://github.com/gsingers/opensearch-learning-to-rank Releases are done through Github Workflows (see `.github/workflows` in the root directory) on an as needed basis. If you do `./gradlew build` as per above under building, it will build all the artifacts that are in the release. -## About alpha releases - -These releases are alpha because some issues with the tests due to securemock that depends on ElasticSearch security stuff. -And there are 14 failing tests. - -``` -Tests with failures: -- com.o19s.es.ltr.feature.store.StoredFeatureSetParserTests.testExpressionDoubleQueryParameter -- com.o19s.es.ltr.feature.store.StoredFeatureSetParserTests.testExpressionMissingQueryParameter -- com.o19s.es.ltr.feature.store.StoredFeatureSetParserTests.testExpressionIntegerQueryParameter -- com.o19s.es.ltr.feature.store.StoredFeatureSetParserTests.testExpressionShortQueryParameter -- com.o19s.es.ltr.feature.store.StoredFeatureSetParserTests.testExpressionInvalidQueryParameter -- com.o19s.es.termstat.TermStatQueryBuilderTests.testMustRewrite -- com.o19s.es.termstat.TermStatQueryBuilderTests.testToQuery -- com.o19s.es.termstat.TermStatQueryBuilderTests.testCacheability -- com.o19s.es.ltr.feature.store.StoredFeatureParserTests.testExpressionOptimization -- com.o19s.es.termstat.TermStatQueryTests.testEmptyTerms -- com.o19s.es.termstat.TermStatQueryTests.testUniqueCount -- com.o19s.es.termstat.TermStatQueryTests.testBasicFormula -- com.o19s.es.termstat.TermStatQueryTests.testQuery -- com.o19s.es.termstat.TermStatQueryTests.testMatchCount - -228 tests completed, 14 failed -``` - - # Development To build, you need to disable the Java security manager @@ -80,7 +55,7 @@ To build, you need to disable the Java security manager # Docker -A custom image of [OpenSearch](https://hub.docker.com/r/opensearchproject/opensearch) with the [OpenSearch Learning to Rank plugin](https://github.com/gsingers/opensearch-learning-to-rank-base) installed. +A custom image of [OpenSearch](https://hub.docker.com/r/opensearchproject/opensearch) with the [OpenSearch Learning to Rank plugin](https://github.com/opensearch-project/opensearch-learning-to-rank-base) installed. This image was created for the [Search with Machine Learning](https://corise.com/course/search-with-machine-learning?utm_source=daniel) course and [Search Fundamentals](https://corise.com/course/search-fundamentals?utm_source=daniel) taught by Grant Ingersoll and Daniel Tunkelang. @@ -94,22 +69,22 @@ Note, we are use Docker ARGs to pass through variables via the --build-arg. All ### Using local artifacts - docker build -f docker/local.Dockerfile . +docker build -f docker/local.Dockerfile . ### Using official releases, built locally #### Using defaults - docker build -f docker/Dockerfile --tag=YOUR/IMAGE_NAME . +docker build -f docker/Dockerfile --tag=YOUR/IMAGE_NAME . #### From Versions - docker build -f docker/Dockerfile --tag=YOUR/IMAGE_NAME --build-arg opensearch_version=2.2.1 --build-arg ltrversion=2.0.0 . +docker build -f docker/Dockerfile --tag=YOUR/IMAGE_NAME --build-arg opensearch_version=2.2.1 --build-arg ltrversion=2.0.0 . #### From a URL - docker build -f docker/Dockerfile --tag=YOUR/IMAGE_NAME --build-arg plugin="https://github.com/gsingers/opensearch-learning-to-rank-base/releases/download/release-test-release/ltr-plugin-test-release.zip" . +docker build -f docker/Dockerfile --tag=YOUR/IMAGE_NAME --build-arg plugin="https://github.com/opensearch-project/opensearch-learning-to-rank-base/releases/download/release-test-release/ltr-plugin-test-release.zip" . ## Running the docker image