Skip to content

Commit 265be39

Browse files
authored
Updates from 1x to 3.x references (#131)
* Update various links that have aged * UBI now ships, so we have to uninstall it before installing the locally compiled one. * Support gw run
1 parent 90b78db commit 265be39

File tree

3 files changed

+17
-9
lines changed

3 files changed

+17
-9
lines changed

Dockerfile

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
FROM opensearchstaging/opensearch:3.1.0-SNAPSHOT
1+
FROM opensearchstaging/opensearch:3.3.0
22

3-
ARG UBI_VERSION="3.1.0.0-SNAPSHOT"
3+
ARG UBI_VERSION="3.3.0.0-SNAPSHOT"
44

55
COPY ./build/distributions/opensearch-ubi-${UBI_VERSION}.zip /tmp/
66

77
# Required for OTel capabilities.
88
#RUN /usr/share/opensearch/bin/opensearch-plugin install --batch telemetry-otel
99

10-
RUN /usr/share/opensearch/bin/opensearch-plugin install --batch file:/tmp/opensearch-ubi-${UBI_VERSION}.zip
10+
RUN /usr/share/opensearch/bin/opensearch-plugin remove opensearch-ubi
11+
12+
RUN /usr/share/opensearch/bin/opensearch-plugin install --batch file:/tmp/opensearch-ubi-${UBI_VERSION}.zip

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@ UBI and this plugin project was originally proposed in the [OpenSearch UBI RFC](
1111
Please note that this repository is the implementation of the UBI plugin for OpenSearch.
1212

1313
> [!IMPORTANT]
14-
> This release targets to the 1.0.0 version of the UBI Specification.
14+
> This release targets to the 1.3.0 version of the UBI Specification.
1515
1616
For details on the JSON Schema used by UBI to send and receive queries and events please see the [UBI](https://github.com/o19s/ubi) repository and the links below.
17-
* [Query Request Schema](https://o19s.github.io/ubi/docs/html/query.request.schema.html)
18-
* [Query Response Schema](https://o19s.github.io/ubi/docs/html/query.response.schema.html)
19-
* [Event Schema](https://o19s.github.io/ubi/docs/html/event.schema.html)
17+
* [Query Request Schema](https://o19s.github.io/ubi/docs/html/latest/query.request.schema.html)
18+
* [Query Response Schema](https://o19s.github.io/ubi/docs/html/latest/query.response.schema.html)
19+
* [Event Schema](https://o19s.github.io/ubi/docs/html/latest/event.schema.html)
20+
21+
Visit [https://ubisearch.dev](https://ubisearch.dev) to learn more about UBI.
2022

2123
## UBI, Data Prepper, and Open Telemetry
2224

@@ -34,7 +36,7 @@ The UBI plugin can store UBI query data in one of three ways:
3436

3537
## Useful Commands
3638

37-
The `scripts/` directory contains example UBI requests for common use cases.
39+
The `src/test/scripts/` directory contains example UBI requests for common use cases.
3840

3941
## User Quick Start
4042

@@ -43,7 +45,7 @@ The `scripts/` directory contains example UBI requests for common use cases.
4345
To get started, download the plugin zip file from the [releases](https://github.com/opensearch-project/user-behavior-insights/releases). Next, install the plugin into OpenSearch with the following command:
4446

4547
```
46-
bin/opensearch-plugin install file:/opensearch-ubi-2.18.0.0.zip
48+
bin/opensearch-plugin install file:/opensearch-ubi-3.2.0.0.zip
4749
```
4850

4951
You will be prompted while installing the plugin because the plugin defines additional security permissions. These permissions allow the plugin to serialize query requests to JSON for storing and to allow the plugin to send query requests to Data Prepper. You can skip the prompt by adding the `--batch` argument to the above command.

build.gradle

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,10 @@ diffCoverageReport {
305305
}
306306
}
307307

308+
run {
309+
useCluster testClusters.integTest
310+
}
311+
308312
// updateVersion: Task to auto update version to the next development iteration
309313
task updateVersion {
310314
onlyIf { System.getProperty('newVersion') }

0 commit comments

Comments
 (0)