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.

Sign up for GitHub

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

Jump to bottom

Enable notifications plugins in reporting #2

Merged
merged 19 commits into from
Oct 17, 2024
Merged

Enable notifications plugins in reporting #2

merged 19 commits into from
Oct 17, 2024

Conversation

yenienserrano
Copy link
Member

@yenienserrano yenienserrano commented Sep 30, 2024 •
edited
Loading

Description

This pull request enables the notification plugin services.

Screenshot

Table

image

Details

image

Edit

image

Create

image

Issues Resolved

Test

Preconditions

Remove the opensearch-reports-scheduler plugin and install the plugin from the wazuh-indexer-reporting repository.

Steps

  1. Configuring an SMTP channel in the notification plugin https://opensearch.org/docs/latest/observing-your-data/notifications/index/#email-as-a-channel-type
  2. Create a scheduled report definition
  3. Try editing the text of the message and containing {{urlDefinition}} to see the url to generate the report.
  4. In the table you should see that the notification is activated.
  5. In the detail you should see the name of the channel in the title of the mail and the body of the mail.
  6. Wait for the mail to be sent

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

@yenienserrano yenienserrano linked an issue Sep 30, 2024 that may be closed by this pull request
MVP scheduled reports use case wazuh/wazuh-dashboard#288
Closed
7 tasks
This was referenced Sep 30, 2024
Closed
Closed
@yenienserrano yenienserrano self-assigned this Sep 30, 2024
@yenienserrano yenienserrano marked this pull request as draft October 1, 2024 12:20
@asteriscos asteriscos marked this pull request as ready for review October 2, 2024 12:26
@guidomodarelli
Copy link

guidomodarelli commented Oct 3, 2024 •
edited
Loading

Test 🟢

Peek 2024-10-03 14-03

Screenshot_3-10-2024_14620_0 0 0 0

image

image

image

image

image

asteriscos
asteriscos approved these changes Oct 17, 2024
View reviewed changes
Copy link
Member

@asteriscos asteriscos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CR: 🟢
Test 🟢

Initial setup:

image

Initialize Vulnerabilities Dashboard saved object and create report definition based on it

image

image

image

screencapture-localhost-5601-app-reports-dashboards-2024-10-17-17_58_07

Email sent

image

@asteriscos asteriscos merged commit b7764ab into master Oct 17, 2024
6 of 11 checks passed
yenienserrano added a commit that referenced this pull request Oct 28, 2024
@yenienserrano @asteriscos
Enable notifications plugins in reporting (#2)
d5b6ad0 
* Add docker

* Enable notifications plugins

* Add notifications settings create report

* Add edit notifications settings

* Add details notifications settings

* Add information in the table

* Fix notebooks selector

* Update actions/upload-artifact version

* Fix tests

* Fix lint

* Remove build windows and macos

* Bump OPENSEARCH_PLUGIN_VERSION on action

* Updates actions

* Add workflow_dispatch, workflow_call on action

* Add wazuh version and revision package.json

* Change action build

* Add manual-build action

* Remove console.log

* Fix edit notification

---------

Co-authored-by: Federico Rodriguez <[email protected]>
@yenienserrano yenienserrano deleted the enhancement/288-enable-notification-plugin-in-reporting branch November 6, 2024 18:40
asteriscos added a commit that referenced this pull request Nov 7, 2024
@yenienserrano @asteriscos
Compatibility with Opensearch 2.17.1 (#5)
09cb691 
* Enable notifications plugins in reporting (#2)

* Add docker

* Enable notifications plugins

* Add notifications settings create report

* Add edit notifications settings

* Add details notifications settings

* Add information in the table

* Fix notebooks selector

* Update actions/upload-artifact version

* Fix tests

* Fix lint

* Remove build windows and macos

* Bump OPENSEARCH_PLUGIN_VERSION on action

* Updates actions

* Add workflow_dispatch, workflow_call on action

* Add wazuh version and revision package.json

* Change action build

* Add manual-build action

* Remove console.log

* Fix edit notification

---------

Co-authored-by: Federico Rodriguez <[email protected]>

* Fix build workflow (#4)

* Bump Opensearch dashboard version

* remove entrypoint dev.yml osd

* Change dev.yml volume path

* fix snapshot

---------

Co-authored-by: Federico Rodriguez <[email protected]>
yenienserrano added a commit that referenced this pull request Nov 15, 2024
@yenienserrano @asteriscos
Compatibility with Opensearch 2.17.1 (#5)
24c77e3 
* Enable notifications plugins in reporting (#2)

* Add docker

* Enable notifications plugins

* Add notifications settings create report

* Add edit notifications settings

* Add details notifications settings

* Add information in the table

* Fix notebooks selector

* Update actions/upload-artifact version

* Fix tests

* Fix lint

* Remove build windows and macos

* Bump OPENSEARCH_PLUGIN_VERSION on action

* Updates actions

* Add workflow_dispatch, workflow_call on action

* Add wazuh version and revision package.json

* Change action build

* Add manual-build action

* Remove console.log

* Fix edit notification

---------

Co-authored-by: Federico Rodriguez <[email protected]>

* Fix build workflow (#4)

* Bump Opensearch dashboard version

* remove entrypoint dev.yml osd

* Change dev.yml volume path

* fix snapshot

---------

Co-authored-by: Federico Rodriguez <[email protected]>
Desvelao pushed a commit that referenced this pull request Nov 19, 2024
@yenienserrano @asteriscos
Compatibility with Opensearch 2.18.0 (#8)
75616d2 
* Compatibility with Opensearch 2.17.1 (#5)

* Enable notifications plugins in reporting (#2)

* Add docker

* Enable notifications plugins

* Add notifications settings create report

* Add edit notifications settings

* Add details notifications settings

* Add information in the table

* Fix notebooks selector

* Update actions/upload-artifact version

* Fix tests

* Fix lint

* Remove build windows and macos

* Bump OPENSEARCH_PLUGIN_VERSION on action

* Updates actions

* Add workflow_dispatch, workflow_call on action

* Add wazuh version and revision package.json

* Change action build

* Add manual-build action

* Remove console.log

* Fix edit notification

---------

Co-authored-by: Federico Rodriguez <[email protected]>

* Fix build workflow (#4)

* Bump Opensearch dashboard version

* remove entrypoint dev.yml osd

* Change dev.yml volume path

* fix snapshot

---------

Co-authored-by: Federico Rodriguez <[email protected]>

* Bump Opensearch dashboard version: 2.17.1 to 2.18.0

---------

Co-authored-by: Federico Rodriguez <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@guidomodarelli guidomodarelli guidomodarelli approved these changes

@asteriscos asteriscos asteriscos approved these changes

Assignees

@yenienserrano yenienserrano

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

MVP scheduled reports use case
3 participants
@yenienserrano @guidomodarelli @asteriscos