Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compatibility with Wazuh indexer based on OpenSearch 2.3.0 #4160

Closed
11 tasks done
gdiazlo opened this issue May 18, 2022 · 14 comments
Closed
11 tasks done

Compatibility with Wazuh indexer based on OpenSearch 2.3.0 #4160

gdiazlo opened this issue May 18, 2022 · 14 comments
Assignees
Labels
compatibility Issues related to the App compatibility with the platforms

Comments

@gdiazlo
Copy link
Member

gdiazlo commented May 18, 2022

Description

We need to ensure the UI compatibility with the next Wazuh Indexer which might be based on OpenSearch 2.0.0. This update is still being discussed, and we need to know potential issues.

  • Review OpenSearch and OpenSearch Dashboards latest stable changelog
  • Identify improvements and potential impact on the UI
  • Report the findings to @wazuh/cicd to coordinate the upgrade effort.
  • Develop a testing environment to verify our components would work under this new build

Note: we'll move to the latest version of OpenSearch, which is 2.3.0 at this time.

Issues

@gdiazlo gdiazlo changed the title Compatibility with Wazuh indexer based on opensearch 1.3.2 Compatibility with Wazuh indexer based on opensearch 2.0.0 May 27, 2022
@gdiazlo gdiazlo added the 4.4 label May 27, 2022
@gdiazlo gdiazlo moved this to Triage in Release 4.4.0 Jun 6, 2022
@snaow snaow moved this from Triage to Todo in Release 4.4.0 Jun 8, 2022
@snaow snaow moved this from Todo to Triage in Release 4.4.0 Jun 13, 2022
@snaow snaow moved this from Triage to Todo in Release 4.4.0 Jun 27, 2022
@AlexRuiz7 AlexRuiz7 added the compatibility Issues related to the App compatibility with the platforms label Jul 13, 2022
@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Jul 13, 2022

OpenSearch 2.0.0

Breaking changes

  • Deprecate Compatibility override

The override main response setting compatibility.override_main_response_version is deprecated from OpenSearch version 1.x and removed from OpenSearch 2.0.0. This setting is no longer supported for compatibility with legacy clients.

  • Deprecate outdated nomenclature

In order for OpenSearch to include more inclusive naming conventions, we’ve replaced the following terms in our code with more inclusive terms

  • “Whitelist” is now “Allow list”
  • “Blacklist” is now “Deny list”
  • “Master” is now “Cluster Manager”

If you are still using the outdated terms in the context of the security APIs or for node management, your calls and automation will continue to work until the terms are removed later in 2022.

@wazuh/cicd These settings must be removed and updated in the opensearch.yml file.

Development environments

We need to adjust our development environments with the following changes:

  • Comment or remove the previous configuration setting in the opensearch.yml file
  • Re-tag our image on Quay.io from 2.0 to 2.0.0.
  • Fix a typo on our Docker Compose file, as the network is Docker network is created with the name os-dev-{OS_VERSION}. Must be changed to os-dev-${OS_VERSION} in order to name it dynamically.

Found issues

  • Our plugin contains custom styles for Kibana 7.9.0 which are causing troubles with the OSD 2.x styles. We need to review these styles and remove them if they are no longer required.

@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Jul 13, 2022

OpenSearch 2.1.0 is live

OpenSearch 2.1.0 was released the 7th of July. We need to create images for this new version.

OpenSearch and Dashboards 2.1.0 Release Notes

https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.1.0.md

Tasks

  • Create and upload a Docker image for OSD-Dev 2.1.0 to our Quay.io repository.
  • Test our app with this new version.

@AlexRuiz7 AlexRuiz7 moved this from Todo to In Progress in Release 4.4.0 Jul 20, 2022
@AlexRuiz7 AlexRuiz7 moved this from In Progress to Todo in Release 4.4.0 Aug 5, 2022
@AlexRuiz7 AlexRuiz7 self-assigned this Aug 5, 2022
@vikman90 vikman90 added this to the Release 4.4.0 milestone Aug 31, 2022
@AlexRuiz7 AlexRuiz7 changed the title Compatibility with Wazuh indexer based on opensearch 2.0.0 Compatibility with Wazuh indexer based on OpenSearch 2.0.0 Sep 6, 2022
@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Sep 9, 2022

OpenSearch 2.2.0 is live

OpenSearch 2.2.0 was released the 12th of August. We need to create images for this new version, if we decide to provide support for this new version.

OpenSearch and Dashboards 2.2.0 Release Notes

https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.2.0.md

Tasks

  • Review the Release Notes for this version.

This version contains a CVE that is solved in 2.2.1. In case of providing support for OpenSearch 2.2.x we should upgrade directly to v2.2.1.

  • Create and upload a Docker image for OSD-Dev 2.2.0 to our Quay.io repository.
  • Test our app with this new version.

@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Sep 9, 2022

OpenSearch 2.2.1 is live

OpenSearch 2.2.1 was released the 2nd of September. We need to create images for this new version, if we decide to provide support for this new version.

OpenSearch and Dashboards 2.2.1 Release Notes

https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.2.1.md

Tasks

  • Review the Release Notes for this version.
  • Create and upload a Docker image for OSD-Dev 2.2.1 to our Quay.io repository.
  • Test our app with this new version.

Issue:

IMPORTANT

This version solves a CVE in the OpenSearch Reporting plugin. The patched versions are 1.3.5 and 2.2.1, so any other version is vulnerable.

More information about this vulnerability can be found in this link.

@AlexRuiz7 AlexRuiz7 moved this from Todo to In Progress in Release 4.4.0 Sep 9, 2022
@yenienserrano
Copy link
Member

yenienserrano commented Sep 12, 2022

In OpenSearch 2.2.1 a new CSS class is being added to the navbar components, in particular to the breadcrumbs headers, that breaks the visualization of the Wazuh breadcrumbs.

In the images below, we can see this new CSS class, named osdHeaderBreadcrumbs, which uses the filter property, root of these issues.

This problem applies to both, the light and the dark mode.

Image

Disabling this property, considerably improves the situation, although there are rendering problems still.

Image

@samrit-narshing
Copy link

samrit-narshing commented Sep 13, 2022

hi . is there a way to know how to build or get the wazuh plugin package (zip) for opensearch 2.2.1 .. ? as i need to install plugin in existing opensearchv 2.2.1

@yenienserrano
Copy link
Member

Hi @samrit-narshing thank you for your interest in Wazuh, currently the application is not compatible with OSD 2.2.1, this issue is to see if it can be compatible with this version.

@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Sep 14, 2022

Hello @wazuh-cloud-cicd team.

One of the breaking changes of OS 2.x is the deprecation of the setting compatibility.override_main_response_version, however, we still use this setting in the 4.4 branch, with a comment that says that this setting is required for Filebeat 7.10.2 to work. This is worrying.

### Option to allow Filebeat-oss 7.10.2 to work ###
compatibility.override_main_response_version: true

Are you aware of this conflict?

@yenienserrano
Copy link
Member

yenienserrano commented Sep 14, 2022

I was testing the configuration, and it only caused me problems in version 2.0.0, in versions 2.1.0 or 2.2.1 I had no problem.

The deprecation of the setting compatibility.override_main_response_version was reverted in version 2.1.0 and higher in this PR.

@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Sep 16, 2022

OpenSearch 2.3.0 is live

OpenSearch 2.3.0 was released the 14th of September. We need to create images for this new version, if we decide to support it.

OpenSearch and Dashboards 2.3.0 Release Notes

https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.3.0.md

Tasks

  • Review the Release Notes for this version.
  • Create and upload a Docker image for OSD-Dev 2.3.0 to our Quay.io repository.
  • Test our app with this new version.

Notable changes

  • Changes in some visualizations

🚞 Refactor

@yenienserrano
Copy link
Member

From what I was testing I could not find other things to highlight in the 2.2.1 versions and, since version 2.3.0 was released, I was testing that version and so far I found no differences in performance with respect to version 2.2.1.

@yenienserrano
Copy link
Member

yenienserrano commented Sep 19, 2022

A new problem has been found in every version of OpenSearch 2.x, more concretely related to the OpenSearch Dashboards.

We use the flyout component from EUI, which closes automatically when the user clicks outside it. However, in 2.x, these components will also close automatically when clicking inside them. This is not the correct behavior, and it's probably related to OSD updating the EUI library to a newer version, breaking our customized components behavior.

Video
flyoutclose.mp4

We'll need to hunt and fix this bug.

Related release notes

OpenSearch Dashboards uses OUI and its alias onto EUI (opensearch-project/OpenSearch-Dashboards#2080)
https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/release-notes/opensearch-dashboards.release-notes-2.2.0.md

Bumps @elastic/eui to v34.6.0 and @elastic/charts to v31.1.0
https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/release-notes/opensearch-dashboards.release-notes-2.0.0.md

@yenienserrano
Copy link
Member

yenienserrano commented Sep 19, 2022

Comparison table

Changes compared to OpenSearch and OpenSearch Dashboards 1.2.0.

v2.0.0 v2.1.0 v2.2.1 v2.3.0
compatibility.override_main_response_version not supported supported supported supported
Changes in breadcrumb styles No No Yes Yes
Changes in the Elastic/EUI version Yes, 34.6.0 Yes, 34.6.0 Yes, Fork 34.6.0 Yes, Fork 34.6.0
Flyouts issue Yes Yes Yes Yes
fixes CVE-2020-6383? No No Yes Yes
SAML login support* Yes No No Yes
SAML logoff support* No No No No

@AlexRuiz7 AlexRuiz7 moved this from In Progress to On Hold in Release 4.4.0 Sep 26, 2022
@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Sep 27, 2022

The team has decided to move to OpenSearch 2.3.0 on the new minor version of Wazuh (4.4.0).

@AlexRuiz7 AlexRuiz7 moved this from On Hold to In Progress in Release 4.4.0 Sep 29, 2022
@AlexRuiz7 AlexRuiz7 changed the title Compatibility with Wazuh indexer based on OpenSearch 2.0.0 Compatibility with Wazuh indexer based on OpenSearch 2.3.0 Sep 30, 2022
@gdiazlo gdiazlo removed the 4.4 label Oct 20, 2022
@AlexRuiz7 AlexRuiz7 moved this from In Progress to Blocked in Release 4.4.0 Oct 26, 2022
@AlexRuiz7 AlexRuiz7 moved this from Blocked to In Review in Release 4.4.0 Nov 7, 2022
Repository owner moved this from In Review to Done in Release 4.4.0 Nov 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compatibility Issues related to the App compatibility with the platforms
Projects
No open projects
Status: Done
Development

No branches or pull requests

5 participants