From 2da2b8b26bd359413b4fdc40f9cd1ce958a93be3 Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Tue, 6 Jun 2023 14:46:40 -0400 Subject: [PATCH 1/5] Add 2.8 version (#4240) (#4254) (cherry picked from commit 68de20990bf318ac30d17c1c44fc32f7fdae562b) Signed-off-by: Fanit Kolchina Signed-off-by: github-actions[bot] Co-authored-by: github-actions[bot] --- _config.yml | 8 ++++---- _data/versions.json | 7 ++++--- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/_config.yml b/_config.yml index 7bfae748f2..0d6ac85575 100644 --- a/_config.yml +++ b/_config.yml @@ -5,10 +5,10 @@ baseurl: "/docs/latest" # the subpath of your site, e.g. /blog url: "https://opensearch.org" # the base hostname & protocol for your site, e.g. http://example.com permalink: /:path/ -opensearch_version: '2.7.0' -opensearch_dashboards_version: '2.7.0' -opensearch_major_minor_version: '2.7' -lucene_version: '9_5_0' +opensearch_version: '2.8.0' +opensearch_dashboards_version: '2.8.0' +opensearch_major_minor_version: '2.8' +lucene_version: '9_6_0' # Build settings markdown: kramdown diff --git a/_data/versions.json b/_data/versions.json index 0515ac80de..afbcacbcf3 100644 --- a/_data/versions.json +++ b/_data/versions.json @@ -1,10 +1,11 @@ { - "current": "2.7", + "current": "2.8", "all": [ - "2.7", + "2.8", "1.3" ], "archived": [ + "2.7", "2.6", "2.5", "2.4", @@ -16,7 +17,7 @@ "1.1", "1.0" ], - "latest": "2.7" + "latest": "2.8" } From be145d6707f24b9d6435367c352cdc520a6dbd78 Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Tue, 6 Jun 2023 14:49:42 -0400 Subject: [PATCH 2/5] Add 2.8 to version history (#4241) (#4255) (cherry picked from commit 23942a6b64d2413ed587089032ce14bd4cc32c84) Signed-off-by: Fanit Kolchina Signed-off-by: github-actions[bot] Co-authored-by: github-actions[bot] --- version-history.md | 1 + 1 file changed, 1 insertion(+) diff --git a/version-history.md b/version-history.md index a217930db7..0d60a6b9a4 100644 --- a/version-history.md +++ b/version-history.md @@ -10,6 +10,7 @@ permalink: /version-history/ OpenSearch version | Release highlights | Release date :--- | :--- | :--- +[2.8.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.8.0.md) | Adds cross-cluster query with PPL, search pipelines, an option to turn on segment replication as the default replication type, improved searchable snapshot performance, and Amazon OpenSearch Serverless support with SigV4 authentication for multiple data sources. Includes the UI for the flush, refresh, and clear cache operations in OpenSearch Dashboards. For a full list of release highlights, see the Release Notes. | 06 Jun 2023 [2.7.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.7.0.md) | Includes searchable snapshots and segment replication, which are now generally available. Adds multiple data sources, observability features, dynamic tenant management, component templates, and shape-based map filters in OpenSearch Dashboards. Includes the flat object field type, hot shard identification, and a new automatic reloading mechanism for ML models. For a full list of release highlights, see the Release Notes. | 02 May 2023 [2.6.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.6.0.md) | Includes simple schema for observability, index management UI enhancements, Security Analytics enhancements, search backpressure at the coordinator node level, and the ability to add maps to dashboards. Experimental features include a new ML model health dashboard, new text embedding models in ML, and SigV4 authentication in Dashboards. For a full list of release highlights, see the Release Notes. | 28 February 2023 [2.5.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.5.0.md) | Includes index management UI enhancements, multi-layer maps, Jaeger support for observability, Debian distributions, returning cluster health by awareness attribute, cluster manager task throttling, weighted zonal search request routing policy, and query string support in index rollups. Experimental features include request-level durability in remote-backed storage and GPU acceleration for ML nodes. For a full list of release highlights, see the Release Notes. | 24 January 2023 From 28857a2c82079ae4f4cec0a0eac216db0f67e246 Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Tue, 6 Jun 2023 16:17:22 -0400 Subject: [PATCH 3/5] Change GitHub issue to forum link (#4259) (#4260) (cherry picked from commit d0242fd6fae1c2aac68b20e5bd11080bcf4d861e) Signed-off-by: Fanit Kolchina Signed-off-by: github-actions[bot] Co-authored-by: github-actions[bot] --- _search-plugins/search-pipelines/filter-query-processor.md | 2 +- _search-plugins/search-pipelines/index.md | 2 +- _search-plugins/search-pipelines/rename-field-processor.md | 2 +- _search-plugins/search-pipelines/script-processor.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/_search-plugins/search-pipelines/filter-query-processor.md b/_search-plugins/search-pipelines/filter-query-processor.md index 0b691a5bd5..16ec6d7dba 100644 --- a/_search-plugins/search-pipelines/filter-query-processor.md +++ b/_search-plugins/search-pipelines/filter-query-processor.md @@ -9,7 +9,7 @@ grand_parent: Search # Filter query processor -This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://forum.opensearch.org/t/rfc-search-pipelines/12099). +This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, join the discussion in the [OpenSearch forum](https://forum.opensearch.org/t/rfc-search-pipelines/12099). {: .warning} The `filter_query` search request processor intercepts a search request and applies an additional query to the request, filtering the results. This is useful when you don't want to rewrite existing queries in your application but need additional filtering of the results. diff --git a/_search-plugins/search-pipelines/index.md b/_search-plugins/search-pipelines/index.md index c721cf2629..5a557cff8b 100644 --- a/_search-plugins/search-pipelines/index.md +++ b/_search-plugins/search-pipelines/index.md @@ -8,7 +8,7 @@ has_toc: false # Search pipelines -This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://forum.opensearch.org/t/rfc-search-pipelines/12099). +This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, join the discussion in the [OpenSearch forum](https://forum.opensearch.org/t/rfc-search-pipelines/12099). {: .warning} You can use _search pipelines_ to build new or reuse existing result rerankers, query rewriters, and other components that operate on queries or results. Search pipelines make it easier for you to process search queries and search results within OpenSearch. Moving some of your application functionality into an OpenSearch search pipeline reduces the overall complexity of your application. As part of a search pipeline, you specify a list of processors that perform modular tasks. You can then easily add or reorder these processors to customize search results for your application. diff --git a/_search-plugins/search-pipelines/rename-field-processor.md b/_search-plugins/search-pipelines/rename-field-processor.md index a890564f7e..65b8f9fc62 100644 --- a/_search-plugins/search-pipelines/rename-field-processor.md +++ b/_search-plugins/search-pipelines/rename-field-processor.md @@ -9,7 +9,7 @@ grand_parent: Search # Rename field processor -This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://forum.opensearch.org/t/rfc-search-pipelines/12099). +This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, join the discussion in the [OpenSearch forum](https://forum.opensearch.org/t/rfc-search-pipelines/12099). {: .warning} The `rename_field` search response processor intercepts a search response and renames the specified field. This is useful when your index and your application use different names for the same field. For example, if you rename a field in your index, the `rename_field` processor can change the new name to the old one before sending the response to your application. diff --git a/_search-plugins/search-pipelines/script-processor.md b/_search-plugins/search-pipelines/script-processor.md index e5b7a9dfcd..5eba0bce83 100644 --- a/_search-plugins/search-pipelines/script-processor.md +++ b/_search-plugins/search-pipelines/script-processor.md @@ -9,7 +9,7 @@ grand_parent: Search # Script processor -This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://forum.opensearch.org/t/rfc-search-pipelines/12099). +This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, join the discussion in the [OpenSearch forum](https://forum.opensearch.org/t/rfc-search-pipelines/12099). {: .warning} The `script` search request processor intercepts a search request and adds an inline Painless script that is run on incoming requests. The script can only run on the following request fields: From cd657f49f669bcc903740056f9c67ce8a928a6de Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Tue, 6 Jun 2023 15:34:59 -0700 Subject: [PATCH 4/5] Updates the supported operating system section of install guide (#4218) (#4264) * updatedtable * addeddashboards * addspaces * removespaces * changes to RPM file * addedredirects * fixedlink * Update _install-and-configure/install-opensearch/index.md --------- (cherry picked from commit bfdd426ecab42f045dff361e0435a1da267ad6f5) Signed-off-by: Heather Halter Signed-off-by: Heather Halter Signed-off-by: github-actions[bot] Co-authored-by: github-actions[bot] Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _install-and-configure/install-opensearch/debian.md | 2 ++ _install-and-configure/install-opensearch/index.md | 12 +++++++++++- _install-and-configure/install-opensearch/rpm.md | 4 +++- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/_install-and-configure/install-opensearch/debian.md b/_install-and-configure/install-opensearch/debian.md index c218e3fa84..8991c2542d 100644 --- a/_install-and-configure/install-opensearch/debian.md +++ b/_install-and-configure/install-opensearch/debian.md @@ -2,6 +2,8 @@ layout: default title: Debian parent: Installing OpenSearch +redirect_from: +- /opensearch/install/deb/ nav_order: 55 --- diff --git a/_install-and-configure/install-opensearch/index.md b/_install-and-configure/install-opensearch/index.md index 08a597802d..0893bf0f2a 100644 --- a/_install-and-configure/install-opensearch/index.md +++ b/_install-and-configure/install-opensearch/index.md @@ -17,7 +17,17 @@ This section details how to install OpenSearch on your host, including which ope ## Operating system compatibility -We recommend installing OpenSearch on Red Hat Enterprise Linux (RHEL) or Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, or Ubuntu Long-Term Support (LTS). OpenSearch should work on most Linux distributions, but we only test a handful. We recommend RHEL 7 or 8, CentOS 7 or 8, Amazon Linux 2, or Ubuntu 16.04, 18.04, or 20.04 for any version of OpenSearch. OpenSearch also supports Windows Server 2019. +OpenSearch and OpenSearch Dashboards are compatible with Red Hat Enterprise Linux (RHEL) and Debian-based Linux distributions that use [`systemd`](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, and Ubuntu Long-Term Support (LTS). While OpenSearch and OpenSearch Dashboards should work on most Linux distributions, we only test a subset. + +The following table lists the operating system versions that we currently support. + +OS | Version +:---------- | :-------- +RHEL/CentOS | 7/8 +Rocky Linux/AlmaLinux | 8 +Ubuntu | 16.04/18.04/20.04 +Windows Server | 2019 + ## File system recommendations diff --git a/_install-and-configure/install-opensearch/rpm.md b/_install-and-configure/install-opensearch/rpm.md index f77de7ac10..93b2382874 100644 --- a/_install-and-configure/install-opensearch/rpm.md +++ b/_install-and-configure/install-opensearch/rpm.md @@ -2,6 +2,8 @@ layout: default title: RPM parent: Installing OpenSearch +redirect_from: +- /opensearch/install/rpm/ nav_order: 51 --- @@ -25,7 +27,7 @@ Generally speaking, installing OpenSearch from the RPM distribution can be broke 1. **Configure OpenSearch for your environment.** - Apply basic settings to OpenSearch and start using it in your environment. -The RPM distribution provides everything you need to run OpenSearch inside Red Hat or Red Hat–based Linux Distributions, such as supported CentOS and RHEL versions, and Amazon Linux 2. If you have your own Java installation and set `JAVA_HOME` in your terminal application, macOS works, as well. +The RPM distribution provides everything you need to run OpenSearch inside Red Hat or Red Hat–based Linux Distributions. For a list of supported operating systems, see [Operating system compatibility]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/#operating-system-compatibility). This guide assumes that you are comfortable working from the Linux command line interface (CLI). You should understand how to input commands, navigate between directories, and edit text files. Some example commands reference the `vi` text editor, but you may use any text editor available. {:.note} From 10e2bb9333d53c54282424f483d2d437a969b11e Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Tue, 6 Jun 2023 15:50:47 -0700 Subject: [PATCH 5/5] Update version and add link to examples - Javascript client (#4224) * addlinktoguides Signed-off-by: Heather Halter * addslinktohelperfile Signed-off-by: Heather Halter * addedlinktohelper Signed-off-by: Heather Halter * Update _clients/javascript/index.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Heather Halter * Update _clients/javascript/helpers.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Heather Halter --------- Signed-off-by: Heather Halter Signed-off-by: Heather Halter Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> (cherry picked from commit 09aa024b55f9ed59190f26567552eff298a9812f) --- _clients/javascript/helpers.md | 4 ++-- _clients/javascript/index.md | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/_clients/javascript/helpers.md b/_clients/javascript/helpers.md index 9efd74d305..b03af21f94 100644 --- a/_clients/javascript/helpers.md +++ b/_clients/javascript/helpers.md @@ -7,7 +7,7 @@ nav_order: 2 # Helper methods -Helper methods simplify the use of complicated API tasks. +Helper methods simplify the use of complicated API tasks. For the client's complete API documentation and additional examples, see the [JS client API documentation](https://opensearch-project.github.io/opensearch-js/2.2/index.html). ## Bulk helper @@ -68,7 +68,7 @@ When creating a new bulk helper instance, you can use the following configuratio ### Examples -The following examples illustrate the index, create, update, and delete bulk helper operations. +The following examples illustrate the index, create, update, and delete bulk helper operations. For more information and advanced index actions, see the [`opensearch-js` guides](https://github.com/opensearch-project/opensearch-js/tree/main/guides) in GitHub. #### Index diff --git a/_clients/javascript/index.md b/_clients/javascript/index.md index ba58ad04f4..9adcd65be7 100644 --- a/_clients/javascript/index.md +++ b/_clients/javascript/index.md @@ -9,9 +9,11 @@ redirect_from: # JavaScript client -The OpenSearch JavaScript (JS) client provides a safer and easier way to interact with your OpenSearch cluster. Rather than using OpenSearch from the browser and potentially exposing your data to the public, you can build an OpenSearch client that takes care of sending requests to your cluster. For the client's complete API documentation and additional examples, see the [JS client API documentation](https://opensearch-project.github.io/opensearch-js/2.1/index.html). +The OpenSearch JavaScript (JS) client provides a safer and easier way to interact with your OpenSearch cluster. Rather than using OpenSearch from the browser and potentially exposing your data to the public, you can build an OpenSearch client that takes care of sending requests to your cluster. For the client's complete API documentation and additional examples, see the [JS client API documentation](https://opensearch-project.github.io/opensearch-js/2.2/index.html). -The client contains a library of APIs that let you perform different operations on your cluster and return a standard response body. The example here demonstrates some basic operations like creating an index, adding documents, and searching your data. +The client contains a library of APIs that let you perform different operations on your cluster and return a standard response body. The example here demonstrates some basic operations like creating an index, adding documents, and searching your data. + +You can use helper methods to simplify the use of complicated API tasks. For more information, see [Helper methods]({{site.url}}{{site.baseurl}}/clients/javascript/helpers/). For more advanced index actions, see the [`opensearch-js` guides](https://github.com/opensearch-project/opensearch-js/tree/main/guides) in GitHub. ## Setup