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

[Security Solution] Rule Management page should indicate the presence of an active Maintenance Window #155099

Closed
3 tasks done
peluja1012 opened this issue Apr 17, 2023 · 3 comments
Assignees
Labels
8.8 candidate Feature:Rule Management Security Solution Detection Rule Management area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. ui-copy Review of UI copy with docs team is recommended v8.8.0

Comments

@peluja1012
Copy link
Contributor

peluja1012 commented Apr 17, 2023

Summary

Description
Maintenance Windows suppress rule notifications (slack, email, etc) during a maintenance period defined by the user. More information about this feature can be found here (internal link). The request is for Security Solution users, specifically rule authors or admins, to be made aware in the Rule Management page that a Maintenance Window might be active. The purpose is to inform users why they might not be receiving notifications for rules that are actively executing. The proposed UI could look something similar to the image below (from Stack Management).
image

Design

Related Issues

Acceptance Criteria

  • If there's any number of currently running maintenance windows, user should see a callout telling about that.
  • If there are no currently running maintenance windows, user should not see this callout.
  • If there's an error fetching maintenance windows, user should see a toast with an error.

Definition of Done

@peluja1012 peluja1012 added Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Feature:Rule Management Security Solution Detection Rule Management area Team:Detection Rule Management Security Detection Rule Management Team labels Apr 17, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@gchaps gchaps added the ui-copy Review of UI copy with docs team is recommended label Apr 19, 2023
nikitaindik added a commit that referenced this issue Apr 24, 2023
…s Management page (#155386)

**Addresses:** #155099
**Documentation issue:**
elastic/security-docs#3181

## Summary

Adds a Maintenance Window callout to the Rules Management page. This
callout is only displayed when a maintenance window is running.

<img width="1260" alt="Screenshot 2023-04-21 at 13 24 11"
src="https://user-images.githubusercontent.com/15949146/233624339-9c9b6e3e-9e5e-424d-9d19-9cd7d4e92259.png">


### Checklist

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
issue created: elastic/security-docs#3181
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [x] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [x] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Georgii Gorbachev <banderror@gmail.com>
nikitaindik added a commit that referenced this issue May 4, 2023
… the test plan (#156532)

## Summary

This PR updates Maintenance Window callout tests to match the test plan.

Maintenance Window callout is shown on the Rules Management page when
there's a Maintenance Window running.

<img width="1260" alt="233624339-9c9b6e3e-9e5e-424d-9d19-9cd7d4e92259"
src="https://user-images.githubusercontent.com/15949146/235923634-53113720-d58a-4a15-b66b-b2008f80f035.png">

[**Test plan**
(internal)](https://docs.google.com/document/d/1NTTbV7FemZR8LVwWBbDW3Jji58Wy2-n-YGycD698RR8/edit?usp=sharing
)

[**Maintenance Window Callout
issue**](#155099) with more info
about the feature
nikitaindik added a commit to nikitaindik/kibana that referenced this issue May 4, 2023
… the test plan (elastic#156532)

## Summary

This PR updates Maintenance Window callout tests to match the test plan.

Maintenance Window callout is shown on the Rules Management page when
there's a Maintenance Window running.

<img width="1260" alt="233624339-9c9b6e3e-9e5e-424d-9d19-9cd7d4e92259"
src="https://user-images.githubusercontent.com/15949146/235923634-53113720-d58a-4a15-b66b-b2008f80f035.png">

[**Test plan**
(internal)](https://docs.google.com/document/d/1NTTbV7FemZR8LVwWBbDW3Jji58Wy2-n-YGycD698RR8/edit?usp=sharing
)

[**Maintenance Window Callout
issue**](elastic#155099) with more info
about the feature

(cherry picked from commit 508ab65)
nikitaindik added a commit that referenced this issue May 4, 2023
… match the test plan (#156532) (#156727)

# Backport

This will backport the following commits from `main` to `8.8`:
- [[Security Solution] Maintenance Window callout: Update tests to match
the test plan (#156532)](#156532)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Nikita
Indik","email":"nikita.indik@elastic.co"},"sourceCommit":{"committedDate":"2023-05-04T08:07:42Z","message":"[Security
Solution] Maintenance Window callout: Update tests to match the test
plan (#156532)\n\n## Summary\r\n\r\nThis PR updates Maintenance Window
callout tests to match the test plan.\r\n\r\nMaintenance Window callout
is shown on the Rules Management page when\r\nthere's a Maintenance
Window running.\r\n\r\n<img width=\"1260\"
alt=\"233624339-9c9b6e3e-9e5e-424d-9d19-9cd7d4e92259\"\r\nsrc=\"https://user-images.githubusercontent.com/15949146/235923634-53113720-d58a-4a15-b66b-b2008f80f035.png\">\r\n\r\n[**Test
plan**\r\n(internal)](https://docs.google.com/document/d/1NTTbV7FemZR8LVwWBbDW3Jji58Wy2-n-YGycD698RR8/edit?usp=sharing\r\n)\r\n\r\n[**Maintenance
Window
Callout\r\nissue**](#155099)
with more info\r\nabout the
feature","sha":"508ab6521995eb044b16f6be15839d64de8c39e5","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["test","release_note:skip","test-coverage","Team:Detections
and Resp","Team: SecuritySolution","Feature:Rule
Management","Team:Detection
Rules","v8.8.0","v8.9.0"],"number":156532,"url":"https://github.com/elastic/kibana/pull/156532","mergeCommit":{"message":"[Security
Solution] Maintenance Window callout: Update tests to match the test
plan (#156532)\n\n## Summary\r\n\r\nThis PR updates Maintenance Window
callout tests to match the test plan.\r\n\r\nMaintenance Window callout
is shown on the Rules Management page when\r\nthere's a Maintenance
Window running.\r\n\r\n<img width=\"1260\"
alt=\"233624339-9c9b6e3e-9e5e-424d-9d19-9cd7d4e92259\"\r\nsrc=\"https://user-images.githubusercontent.com/15949146/235923634-53113720-d58a-4a15-b66b-b2008f80f035.png\">\r\n\r\n[**Test
plan**\r\n(internal)](https://docs.google.com/document/d/1NTTbV7FemZR8LVwWBbDW3Jji58Wy2-n-YGycD698RR8/edit?usp=sharing\r\n)\r\n\r\n[**Maintenance
Window
Callout\r\nissue**](#155099)
with more info\r\nabout the
feature","sha":"508ab6521995eb044b16f6be15839d64de8c39e5"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/156532","number":156532,"mergeCommit":{"message":"[Security
Solution] Maintenance Window callout: Update tests to match the test
plan (#156532)\n\n## Summary\r\n\r\nThis PR updates Maintenance Window
callout tests to match the test plan.\r\n\r\nMaintenance Window callout
is shown on the Rules Management page when\r\nthere's a Maintenance
Window running.\r\n\r\n<img width=\"1260\"
alt=\"233624339-9c9b6e3e-9e5e-424d-9d19-9cd7d4e92259\"\r\nsrc=\"https://user-images.githubusercontent.com/15949146/235923634-53113720-d58a-4a15-b66b-b2008f80f035.png\">\r\n\r\n[**Test
plan**\r\n(internal)](https://docs.google.com/document/d/1NTTbV7FemZR8LVwWBbDW3Jji58Wy2-n-YGycD698RR8/edit?usp=sharing\r\n)\r\n\r\n[**Maintenance
Window
Callout\r\nissue**](#155099)
with more info\r\nabout the
feature","sha":"508ab6521995eb044b16f6be15839d64de8c39e5"}}]}]
BACKPORT-->
@banderror
Copy link
Contributor

Awesome! Everything is done, the links to the PRs are in the description.

nikitaindik added a commit that referenced this issue May 9, 2023
… tech writer review (#157076)

## Summary

Tweaked UI wording after consulting with a tech writer  

<img width="1329" alt="Screenshot 2023-05-08 at 22 51 39"
src="https://user-images.githubusercontent.com/15949146/236932465-43e6181e-c2dc-453a-b109-0ab22bbae695.png">

**Addresses:** #155099
**Main PR:** #155386
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue May 9, 2023
… tech writer review (elastic#157076)

## Summary

Tweaked UI wording after consulting with a tech writer

<img width="1329" alt="Screenshot 2023-05-08 at 22 51 39"
src="https://user-images.githubusercontent.com/15949146/236932465-43e6181e-c2dc-453a-b109-0ab22bbae695.png">

**Addresses:** elastic#155099
**Main PR:** elastic#155386

(cherry picked from commit 352c8d8)
kibanamachine referenced this issue May 20, 2023
… after tech writer review (#157076) (#157158)

# Backport

This will backport the following commits from `main` to `8.8`:
- [[Security Solution] Maintenance Window callout: Improve UI copy after
tech writer review
(#157076)](#157076)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Nikita
Indik","email":"nikita.indik@elastic.co"},"sourceCommit":{"committedDate":"2023-05-09T12:34:29Z","message":"[Security
Solution] Maintenance Window callout: Improve UI copy after tech writer
review (#157076)\n\n## Summary\r\n\r\nTweaked UI wording after
consulting with a tech writer \r\n\r\n<img width=\"1329\"
alt=\"Screenshot 2023-05-08 at 22 51
39\"\r\nsrc=\"https://user-images.githubusercontent.com/15949146/236932465-43e6181e-c2dc-453a-b109-0ab22bbae695.png\">\r\n\r\n**Addresses:**
https://github.com/elastic/kibana/issues/155099\r\n**Main PR:**
https://github.com/elastic/kibana/pull/155386","sha":"352c8d8b1f7dbdadb8d2dbf1d5192e78a43a67af","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Detections
and Resp","Team: SecuritySolution","Feature:Rule
Management","Team:Detection
Rules","ui-copy","v8.8.0","v8.9.0"],"number":157076,"url":"https://github.com/elastic/kibana/pull/157076","mergeCommit":{"message":"[Security
Solution] Maintenance Window callout: Improve UI copy after tech writer
review (#157076)\n\n## Summary\r\n\r\nTweaked UI wording after
consulting with a tech writer \r\n\r\n<img width=\"1329\"
alt=\"Screenshot 2023-05-08 at 22 51
39\"\r\nsrc=\"https://user-images.githubusercontent.com/15949146/236932465-43e6181e-c2dc-453a-b109-0ab22bbae695.png\">\r\n\r\n**Addresses:**
https://github.com/elastic/kibana/issues/155099\r\n**Main PR:**
https://github.com/elastic/kibana/pull/155386","sha":"352c8d8b1f7dbdadb8d2dbf1d5192e78a43a67af"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/157076","number":157076,"mergeCommit":{"message":"[Security
Solution] Maintenance Window callout: Improve UI copy after tech writer
review (#157076)\n\n## Summary\r\n\r\nTweaked UI wording after
consulting with a tech writer \r\n\r\n<img width=\"1329\"
alt=\"Screenshot 2023-05-08 at 22 51
39\"\r\nsrc=\"https://user-images.githubusercontent.com/15949146/236932465-43e6181e-c2dc-453a-b109-0ab22bbae695.png\">\r\n\r\n**Addresses:**
https://github.com/elastic/kibana/issues/155099\r\n**Main PR:**
https://github.com/elastic/kibana/pull/155386","sha":"352c8d8b1f7dbdadb8d2dbf1d5192e78a43a67af"}}]}]
BACKPORT-->

Co-authored-by: Nikita Indik <nikita.indik@elastic.co>
Co-authored-by: Georgii Gorbachev <georgii.gorbachev@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.8 candidate Feature:Rule Management Security Solution Detection Rule Management area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. ui-copy Review of UI copy with docs team is recommended v8.8.0
Projects
None yet
Development

No branches or pull requests

5 participants