Add consolidated release notes for 2.7.0 #3452
Conversation
Signed-off-by: Zelin Hao <[email protected]>
zelinh
requested review from
dblock,
peterzhuamazon,
bbarani,
gaiksaya,
rishabh6788,
jordarlu,
prudhvigodithi,
Divyaasm and
tianleh
as code owners
Codecov Report
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more @@ Coverage Diff @@
## main #3452 +/- ##
==========================================
- Coverage 91.74% 91.44% -0.31%
==========================================
Files 172 172
Lines 4991 4991
==========================================
- Hits 4579 4564 -15
- Misses 412 427 +15 |
|
|
||
| ## Release Highlights | ||
| OpenSearch 2.7.0 includes a number of new and enhanced features for your search, observability, and analytics workloads. This release delivers production-ready functionality for segment replication, searchable snapshots, and the ability to add multiple data sources to a single dashboard—features that were previously released as experimental. Also included are new flat object fields for more efficient indexing, integrated observability features within OpenSearch Dashboards, new geospatial functionality, and updates designed to simplify administration of indexes and clusters. | ||
|
|
There was a problem hiding this comment.
@zelinh could we add highlight here?
OpenSearch Dashboards version 2.7 has introduced an improvement where administrators can now override the NodeJs version used to run the software. This modification has the potential to affect the launch logic and may require changes to existing infrastructure in order to properly launch OpenSearch Dashboards. Further information about this change can be found at the following link: opensearch-project/OpenSearch-Dashboards#3508
There was a problem hiding this comment.
@seraphjiang Just to clarify, by default there is no impact to normal OpenSearch users but adds additional capability for administrators to override NodeJs version used to run the software (when needed?). I see that there is a caveat stating that it has potential to affect the launch logic and may require changes to existing infrastructure in order to properly launch OpenSearch Dashboards when overriding it. Can we elaborate more on that rather than pointing to a PR?
There was a problem hiding this comment.
Basically, point to a documentation / readme file with the information needed for launch logic when overriding the NodeJs version used to run the software.
There was a problem hiding this comment.
The change is to allow user to choose NodeJS, the implementing has issue which is addressed in opensearch-project/OpenSearch-Dashboards#3955
For impacted customer, they has two options, modify their infrastructure code to adapt to the change, or apply above fix as workaround before we bring to release offically.
There was a problem hiding this comment.
@bbarani if we could not put in highlight, i would suggest to add 3508 to break changes.
This break change is not breaking functionality or api interface, but impact the launch behavior, although it was for another enhancement purpose.
I'll leave this to team to make decision is better for the best of interest for community. We found this issue in early adoption and test of 2.7.
There was a problem hiding this comment.
@seraphjiang can you point me to where the workaround is documented and how the admin would apply it? I'm looking at 3508 and it's not entirely clear (at least to me).
There was a problem hiding this comment.
The workaround is at opensearch-project/OpenSearch-Dashboards#3955 not opensearch-project/OpenSearch-Dashboards#3508
The instruction is to apply the same fix in 3955, and rebuild the OpenSearch Dashboards for the artifacts. For how to build , refer to https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md#building-artifacts
There was a problem hiding this comment.
@seraphjiang @bbarani taking a stab at writing this up. Is this accurate, and sufficiently comprehensive?
Known Issues
Version 2.7.0 of OpenSearch Dashboards offers administrators the ability to manually override the version of Node.js used to run the software. If an administrator chooses this option, the change has the potential to affect the launch logic for OpenSearch Dashboards, in which case the administrator may need to modify their infrastructure code or apply a workaround to enable Dashboards to launch properly. The workaround involves making a change to the CLI shell scripts as described in this issue opensearch-project/OpenSearch-Dashboards#3955 and rebuilding the artifacts for Dashboards as described here https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md#building-artifacts. If the administrator does not choose to override the version of Node.js used to run the software, this will not be an issue.
There was a problem hiding this comment.
Overall LGTM, except If the administrator does not choose to override the version of Node.js used to run the software, this will not be an issue. we might remove this as it will also impact cx not override the nodejs.
thanks @jhmcintyre
There was a problem hiding this comment.
Thanks @seraphjiang and I'm fine removing that last line. @bbarani, does this work for you?
| # OpenSearch and OpenSearch Dashboards 2.7.0 Release Notes | ||
|
|
||
| ## Release Highlights | ||
| OpenSearch 2.7.0 includes a number of new and enhanced features for your search, observability, and analytics workloads. This release delivers production-ready functionality for segment replication, searchable snapshots, and the ability to add multiple data sources to a single dashboard—features that were previously released as experimental. Also included are new flat object fields for more efficient indexing, integrated observability features within OpenSearch Dashboards, new geospatial functionality, and updates designed to simplify administration of indexes and clusters. |
There was a problem hiding this comment.
| OpenSearch 2.7.0 includes a number of new and enhanced features for your search, observability, and analytics workloads. This release delivers production-ready functionality for segment replication, searchable snapshots, and the ability to add multiple data sources to a single dashboard—features that were previously released as experimental. Also included are new flat object fields for more efficient indexing, integrated observability features within OpenSearch Dashboards, new geospatial functionality, and updates designed to simplify administration of indexes and clusters. | |
| OpenSearch 2.7.0 includes a number of new and enhanced features for your search, observability, and analytics workloads. This release delivers production-ready functionality for segment replication, searchable snapshots, and the ability to add multiple data sources to a single dashboard — features that were previously released as experimental. Also included are new flat object fields for more efficient indexing, integrated observability features within OpenSearch Dashboards, new geospatial functionality, and updates designed to simplify administration of indexes and clusters. |
| OpenSearch [Release Notes](https://github.com/opensearch-project/OpenSearch/blob/main/release-notes/opensearch.release-notes-2.7.0.md). | ||
|
|
||
| OpenSearch Dashboards [Release Notes](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/release-notes/opensearch-dashboards.release-notes-2.7.0.md). | ||
|
|
There was a problem hiding this comment.
Can we add a link to the documentation release notes? https://github.com/opensearch-project/documentation-website/blob/main/release-notes/opensearch-documentation-release-notes-2.7.0.md
There was a problem hiding this comment.
I'm good with this. @zelinh ?
There was a problem hiding this comment.
@hdhalter @jhmcintyre Thanks for reviewing. I have added documentation release notes link below; and also updated based on reviews.
| ## BREAKING CHANGES | ||
|
|
||
| ### OpenSearch Ml Commons Dashboards | ||
| * Ml-commons introduced a API breaking change in 2.7 which changed the API response data, FE is updated accordingly. With this change, FE will no longer compatible with OpenSearch version < 2.7 ([#154](https://github.com/opensearch-project/ml-commons-dashboards/pull/154)) |
There was a problem hiding this comment.
| * Ml-commons introduced a API breaking change in 2.7 which changed the API response data, FE is updated accordingly. With this change, FE will no longer compatible with OpenSearch version < 2.7 ([#154](https://github.com/opensearch-project/ml-commons-dashboards/pull/154)) | |
| * Ml-commons introduced an API breaking change in 2.7 which changes the API response data. FE is updated accordingly. With this change, FE will no longer be compatible with OpenSearch version < 2.7 ([#154](https://github.com/opensearch-project/ml-commons-dashboards/pull/154)) |
There was a problem hiding this comment.
Please change "Ml" to "ML" in the subhead and copy, and spell out "ML Commons" (instead of Ml-commons) in the body copy.
| ## FEATURES | ||
|
|
||
| ### OpenSearch Alerting Dashboards | ||
| * Implemented support for configuring up to 10 data filters for query and bucket level monitors using the visual editor. ([#504](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/504)) |
There was a problem hiding this comment.
| * Implemented support for configuring up to 10 data filters for query and bucket level monitors using the visual editor. ([#504](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/504)) | |
| * Implemented support for configuring up to 10 data filters for query and bucket-level monitors using the visual editor. ([#504](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/504)) |
|
|
||
| ### OpenSearch Alerting Dashboards | ||
| * Implemented support for configuring up to 10 data filters for query and bucket level monitors using the visual editor. ([#504](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/504)) | ||
| * Implemented support for >, >=, <, and <= query operators for the doc level monitor visual editor. ([#508](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/508)) |
There was a problem hiding this comment.
| * Implemented support for >, >=, <, and <= query operators for the doc level monitor visual editor. ([#508](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/508)) | |
| * Implemented support for >, >=, <, and <= query operators for the doc-level monitor visual editor. ([#508](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/508)) |
| ### OpenSearch Index Management | ||
| * Error Prevention: Add close action. ([#728](https://github.com/opensearch-project/index-management/pull/728)) | ||
| * Error Prevention: Add index priority action. ([#729](https://github.com/opensearch-project/index-management/pull/729)) | ||
| * Error Prevention: Add notification, shrink, allocation and rollup. ([#732](https://github.com/opensearch-project/index-management/pull/732)) |
There was a problem hiding this comment.
| * Error Prevention: Add notification, shrink, allocation and rollup. ([#732](https://github.com/opensearch-project/index-management/pull/732)) | |
| * Error Prevention: Add notification, shrink, allocation, and rollup. ([#732](https://github.com/opensearch-project/index-management/pull/732)) |
|
|
||
| ### OpenSearch SQL | ||
| * Create datasource API (#1458) ([#1479](https://github.com/opensearch-project/sql/pull/1479)) | ||
| * REST API for GET,PUT and DELETE ([#1502](https://github.com/opensearch-project/sql/pull/1502)) |
There was a problem hiding this comment.
| * REST API for GET,PUT and DELETE ([#1502](https://github.com/opensearch-project/sql/pull/1502)) | |
| * REST API for GET, PUT and DELETE ([#1502](https://github.com/opensearch-project/sql/pull/1502)) |
| * Add memory consumption estimation for models in profile API ([#853](https://github.com/opensearch-project/ml-commons/pull/853)) | ||
| * Add text docs ML input ([#830](https://github.com/opensearch-project/ml-commons/pull/830)) | ||
| * Add allow custom deployment plan setting; add deploy to all nodes field in model index ([#818](https://github.com/opensearch-project/ml-commons/pull/818)) | ||
| * Add exclude nodes setting. ([#813](https://github.com/opensearch-project/ml-commons/pull/813)) |
There was a problem hiding this comment.
| * Add exclude nodes setting. ([#813](https://github.com/opensearch-project/ml-commons/pull/813)) | |
| * Add exclude nodes setting ([#813](https://github.com/opensearch-project/ml-commons/pull/813)) |
| * Add text docs ML input ([#830](https://github.com/opensearch-project/ml-commons/pull/830)) | ||
| * Add allow custom deployment plan setting; add deploy to all nodes field in model index ([#818](https://github.com/opensearch-project/ml-commons/pull/818)) | ||
| * Add exclude nodes setting. ([#813](https://github.com/opensearch-project/ml-commons/pull/813)) | ||
| * set model state as partially loaded if unload model from partial nodes ([#806](https://github.com/opensearch-project/ml-commons/pull/806)) |
There was a problem hiding this comment.
| * set model state as partially loaded if unload model from partial nodes ([#806](https://github.com/opensearch-project/ml-commons/pull/806)) | |
| * Set model state as partially loaded if unload model from partial nodes ([#806](https://github.com/opensearch-project/ml-commons/pull/806)) |
|
|
||
| ### OpenSearch Alerting Dashboards | ||
| * Anomaly detection UI bug fixes. ([#502](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/502)) | ||
| * Fixed a bug with doc level trigger creation. ([#513](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/513)) |
There was a problem hiding this comment.
| * Fixed a bug with doc level trigger creation. ([#513](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/513)) | |
| * Fixed a bug with doc-level trigger creation. ([#513](https://github.com/opensearch-project/alerting-dashboards-plugin/pull/513)) |
| * You can now access observability features from OpenSearch Dashboards, create your own observability dashboards, add event analytics visualizations, and more without leaving the Dashboards environment. | ||
| * Geospatial functionality receives upgrades as new shape-based filters let you filter your geospatial data by drawing a rectangle or polygon over a selected area of the map. This release also enables OpenSearch to display maps in local languages. | ||
| * OpenSearch makes managing multiple indexes simpler with the addition of component templates. These templates can help you abstract common index settings, mappings, and aliases into reusable building blocks. | ||
| * Another time-saving upgrade for OpenSearch administrators comes with the availability of dynamic tenants management in OpenSearch Dashboards. Admins can view, configure, and enable or disable tenancy within Dashboards and effect those changes without a restart. |
There was a problem hiding this comment.
change to "dynamic tenant management"
| OpenSearch [Release Notes](https://github.com/opensearch-project/OpenSearch/blob/main/release-notes/opensearch.release-notes-2.7.0.md). | ||
|
|
||
| OpenSearch Dashboards [Release Notes](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/release-notes/opensearch-dashboards.release-notes-2.7.0.md). | ||
|
|
There was a problem hiding this comment.
I'm good with this. @zelinh ?
Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: Zelin Hao <[email protected]>
| * A new correlation engine is added to the Security Analytics toolkit, enabling a knowledge graph that can be used to identify, store, and recall connected events data to help you identify patterns and investigate relationships. | ||
| * The experimental ML Framework gains a new automatic reloading mechanism for ML models, allowing you to auto-reload deployed models when a cluster restarts or when a node rejoins the cluster. | ||
|
|
||
| ### OpenSearch Ml Commons Dashboards |
There was a problem hiding this comment.
should be "ML Commons" (with a capital L). And I think the section header can say "Change to ML Commons Dashboards" or "ML Commons Dashboards Update"
| * The experimental ML Framework gains a new automatic reloading mechanism for ML models, allowing you to auto-reload deployed models when a cluster restarts or when a node rejoins the cluster. | ||
|
|
||
| ### OpenSearch Ml Commons Dashboards | ||
| * Ml-commons introduced an API breaking change in 2.7 which changes the API response data. FE is updated accordingly. With this change, FE will no longer be compatible with OpenSearch version < 2.7 ([#154](https://github.com/opensearch-project/ml-commons-dashboards/pull/154)) |
There was a problem hiding this comment.
Change "Ml-commons" to ML Commons. Also, what is FE? Should we spell it out each time it's used here?
| * The experimental ML Framework gains a new automatic reloading mechanism for ML models, allowing you to auto-reload deployed models when a cluster restarts or when a node rejoins the cluster. | ||
|
|
||
| ### OpenSearch Ml Commons Dashboards | ||
| * Ml-commons introduced an API breaking change in 2.7 which changes the API response data. FE is updated accordingly. With this change, FE will no longer be compatible with OpenSearch version < 2.7 ([#154](https://github.com/opensearch-project/ml-commons-dashboards/pull/154)) |
|
|
||
|
|
||
| ### OpenSearch Dashboards Search Relevance | ||
| * [Feature] Exposing Metrics for Search Comparison Tool ([#162](https://github.com/opensearch-project/dashboards-search-relevance/pull/162)) |
| * Add `TIMESTAMPADD` Function To OpenSearch SQL Plugin ([#1453](https://github.com/opensearch-project/sql/pull/1453)) | ||
| * Add `Timestampdiff` Function To OpenSearch SQL ([#1472](https://github.com/opensearch-project/sql/pull/1472)) | ||
| * Add Nested Support in Select Clause (#1490) ([#1518](https://github.com/opensearch-project/sql/pull/1518)) | ||
| * Fix null response from pow/power and added missing integration testing ([#1459](https://github.com/opensearch-project/sql/pull/1459)) |
Signed-off-by: Zelin Hao <[email protected]>
Signed-off-by: Zelin Hao <[email protected]>
Description
Adding consolidated release notes for 2.7.0
Issues Resolved
Part of #3230
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.