[RELEASE] Release version 2.17.1

[github-actions]

Release OpenSearch and OpenSearch Dashboards 2.17.1

I noticed that a manifest was automatically created in manifests/2.17.1. Please follow the following checklist to make a release.

How to use this issue

This Release Issue

This issue captures the state of the OpenSearch release, its assignee (Release Manager) is responsible for driving the release. Please contact them or @mention them on this issue for help. There are linked issues on components of the release where individual components can be tracked. For more information check the the Release Process OpenSearch Guide.

Please refer to the following link for the release version dates: Release Schedule and Maintenance Policy.

Entrance Criteria

Criteria	Status	Description	Comments
Each component release issue has an assigned owner	🟢
Documentation draft PRs are up and in tech review for all component changes	🟢
Sanity testing is done for all components	🟢
Code coverage has not decreased (all new code has tests)	🟢
Release notes are ready and available for all components	🟢
Roadmap is up-to-date (information is available to create release highlights)	🟢
Release ticket is cut, and there's a forum post announcing the start of the window	🟢
Any necessary security reviews are complete	🟢

OpenSearch 2.17.1 exit criteria status:

Criteria	Status	Description	Comments
Performance tests are run, results are posted to the release ticket and there no unexpected regressions	🟢
No unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days	🟢
Documentation has been fully reviewed and signed off by the documentation community.	🟢
All integration tests are passing	🟢

OpenSearch-Dashboards 2.17.1 exit criteria status:

Criteria	Status	Description	Comments
Documentation has been fully reviewed and signed off by the documentation community	🟢
No unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days	🟢
All integration tests are passing	🟢

Preparation

• Release manager assigned.
• Update release page on the website with release manager and release issue details. Sample PR
• Existence of label in each component repo. For more information check the release-label section.
• Increase the build frequency.
• Release Issue.

Campaigns

• Component Release Issue.
• Release Campaigns.

Version Increment - _Ends September 24th 2024

• Core Release Branch.
• Core Version Increment.
• Components Release Branch.
• Components Version Increment.

Code Complete - _Ends September 24th 2024

• Mark this as done once the Code Complete is reviewed.
• Create/Verify pull requests to add each component to relase input manifests/2.17.1/opensearch-2.17.1.yml and manifests/2.17.1/opensearch-dashboards-2.17.1.yml.

Release Candidate Creation and Testing - _Ends September 25th 2024

• Generate Release Candidate.
• Integ Test TAR.
• Integ Test RPM.
• Docker Build and Scan.
• Backwards Compatibility Tests.
• Windows Integration Test.
• Broadcast and Communication.
• Release Candidate Lock.
• Stop Release Candidate periodic auto builds

Performance testing validation - _Ends September 25th 2024

• Post the benchmark-tests
• Longevity tests do not show any issues.

Pre Release - _Ends September 30th 2024

• Release Labeled Issues.
• Go or No-Go.
• Release Notes.

Release - _Ends October 1st 2024

• Central Promotion Workflow.
• Collaboration with the Project Management Team.

Release Checklist.

Release Checklist

Pre-Release activities

• Promote Repos.
  • • OS
  • • OSD
• Promote Artifacts.
  • • Windows
  • • Linux Debian
  • • Linux RPM
  • • Linux TAR
• Consolidated Release Notes.

Release activities

• Docker Promotion.
• Release Validation part 1.
  • • OpenSearch and OpenSearch Dashboard Validation.
  • • Validate the native plugin installation.
• Merge consolidated release notes PR.
• Website and Documentation Changes.
  • • Merge staging website PR.
  • • Promote the website changes to prod.
  • • Add website alert.
• Release Validation part 2.
  • • Validate the artifact download URL's and signatures.
• Release Validation part 3.
  • • Trigger the validation build (Search for Completed validation for <> in the logs).
• Maven Promotion.
• Publish blog posts.
• Advertise on Social Media.
• Post on public slack and Github Release issue.

Post Release

• Release Tags.
• Input Manifest Update.
• OpenSearch Build Release notes.
• Decrease the Build Frequency.
• Retrospective Issue.
• Helm and Ansible Playbook release.
• Upcoming Release Preparation.

Components

Replace with links to all component tracking issues.

Component	On track	Release Notes
{COMPONENT_ISSUE_LINK}	{INDICATOR}	{STATUS}

Legend

Symbol	Meaning
🟢	On track with overall release
🟡	Missed last milestone
🔴	Missed multiple milestones

[peterzhuamazon]

We have recently found an issue related to OSD, due to the Chrome browser update:

• [BUG] Google Chrome v129 Discover screen - CSS class eui-xScrollWithShadows placing a big red layer over all the logs details OpenSearch-Dashboards#8250

The issue seems coming from chrome itself, with an issue opened in here:

• https://issues.chromium.org/issues/368562242

A temp workaround in OSD core has been sent as well:

• Temporary fix for a bug with Chrome 129 when handling mask-image OpenSearch-Dashboards#8274

We want to analyze the situation and see if it grants a potential patch release such as 2.17.1.

• How many versions of Chrome browser carry this bug?
• Is there a quick workflow that users can apply, so that we dont need to do a immediate new patch release?1
• What is the impact of this issue?

cc: @Pallavi-AWS @dblock @anirudha @ashwin-pc @AMoo-Miki @getsaurabh02

Thanks.

[getsaurabh02]

Thanks @peterzhuamazon for adding details. @ashwin-pc Can we also add if there is any workaround from the Chrome side, which users can do and we can share in form of documentation?

I experienced the same issue while using regular browsing, but it worked in private browsing. I cleared my cache and cookies, which resolved the problem.

[ashwin-pc]

Thanks for opening the issue @peterzhuamazon @getsaurabh02. To answer your questions:

How many versions of Chrome browser carry this bug?

its started in version 129 and still exists in the latest 130 version

Is there a quick workflow that users can apply, so that we dont need to do a immediate new patch release?1

Users can use an alternate browser Both Edge and Safari dont seem to have this bug. That being said, many of the other browsers are built on top of Chromium, so its very likely that they will also have this bug when they update to use the latest version of Chrome.

What is the impact of this issue?

Discover is unusable since the results table is covered by a red mask

Can we also add if there is any opensearch-project/OpenSearch-Dashboards#8250 (comment) from the Chrome side, which users can do and we can share in form of documentation?

The work arounds suggested here expect the user to change the CSS on their page using the developer tools panel. Using an alternate browser is an easier workaround though and the suggestions in the issue were most for the code fix we needed to make.

[getsaurabh02]

Thanks @ashwin-pc. One last thing since user here mentioned the below workaround irrespective of the CSS update. Is it not working?

I experienced the same issue while using regular browsing, but it worked in private browsing. I cleared my cache and cookies, which resolved the problem.

Adding maintainers for any feedback/concerns @AMoo-Miki @dbbaughe @msfroh

[ashwin-pc]

The user there was calling out that the issue for them was not always reproducible, but their fix/workaround does always work. The issue for me and @AMoo-Miki however was always reproducible.

[getsaurabh02]

Thanks, @ashwin-pc.

I will allow today for any final feedback or concerns from the maintainers. If none are raised, we will start the code freeze tomorrow and proceed to release as soon as the final RC is ready. The release window is typically one week, so we expect to have the final RC ready for release by Tuesday, October 1st.

Please ensure that no other commits (aside from those discussed on this thread) are included in this patch release. Any other changes on the 2.17 branch, apart from those tagged in the patch issue, will be reverted.

Tagging @Divyaasm and @peterzhuamazon for support on this release. We will begin the announcement on the public slack.

[getsaurabh02]

@ashwin-pc. Few more questions, while we prep for the patch release in parallel:

The user there was calling out that the issue for them was not always reproducible, but their fix/workaround does always work. The issue for me and @AMoo-Miki however was always reproducible.

Can we please confirm this, since it will determine the urgency/need of the fix and patch release.

its started in version 129 and still exists in the latest 130 version

Is there any eta on the issue being tracked from the Chrome side? Is it okay to ask user to use other versions of Chrome of other browser, since this issue anyways affects all versions of OSD.