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

[Security Solution] Add active maintenance window callout to the Rules Management page #155386

Merged
merged 23 commits into from
Apr 24, 2023
Merged

[Security Solution] Add active maintenance window callout to the Rules Management page #155386

merged 23 commits into from
Apr 24, 2023

Conversation

nikitaindik
Copy link
Contributor

@nikitaindik nikitaindik commented Apr 20, 2023 •
edited
Loading

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.

Screenshot 2023-04-21 at 13 24 11

Checklist

For maintainers

@nikitaindik nikitaindik force-pushed the maintenance-windows-rule-management branch from 75680f7 to 0960af3 Compare April 21, 2023 11:20
@nikitaindik nikitaindik changed the title Add active maintenance window callout to the Rules Management page [Security Solution] Add active maintenance window callout to the Rules Management page Apr 21, 2023
@nikitaindik nikitaindik force-pushed the maintenance-windows-rule-management branch from 279a24e to c434c3f Compare April 21, 2023 11:29
@nikitaindik nikitaindik self-assigned this Apr 21, 2023
@nikitaindik nikitaindik added Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. release_note:feature Makes this part of the condensed release notes Feature:Rule Management Security Solution Detection Rule Management Team:Detection Rule Management Security Detection Rule Management Team v8.8.0 labels Apr 21, 2023
@nikitaindik nikitaindik force-pushed the maintenance-windows-rule-management branch from 86b779f to 7a2fb01 Compare April 21, 2023 11:47
@nikitaindik nikitaindik marked this pull request as ready for review April 21, 2023 13:20
@nikitaindik nikitaindik requested review from a team as code owners April 21, 2023 13:20
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@nikitaindik nikitaindik mentioned this pull request Apr 21, 2023
Closed
@nikitaindik nikitaindik force-pushed the maintenance-windows-rule-management branch from b72175a to 3e55fe6 Compare April 21, 2023 14:58
maximpn
maximpn reviewed Apr 24, 2023
View reviewed changes
Copy link
Contributor

@maximpn maximpn left a comment

Choose a reason for hiding this comment

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

@nikitaindik thank you for adding support of maintenance windows on Rules page 🙏 I left some non critical comments.

...ublic/detection_engine/rule_management_ui/components/maintenance_window_callout/constants.ts Outdated Show resolved Hide resolved
...tion/public/detection_engine/rule_management_ui/components/maintenance_window_callout/api.ts Show resolved Hide resolved
...rule_management_ui/components/maintenance_window_callout/maintenance_window_callout.test.tsx Outdated Show resolved Hide resolved
...rule_management_ui/components/maintenance_window_callout/maintenance_window_callout.test.tsx Outdated Show resolved Hide resolved
...rule_management_ui/components/maintenance_window_callout/maintenance_window_callout.test.tsx Show resolved Hide resolved
...rule_management_ui/components/maintenance_window_callout/maintenance_window_callout.test.tsx Outdated Show resolved Hide resolved
x-pack/plugins/security_solution/cypress/e2e/detection_rules/maintenance_window.cy.ts Show resolved Hide resolved
x-pack/plugins/security_solution/cypress/e2e/detection_rules/maintenance_window.cy.ts Show resolved Hide resolved
x-pack/plugins/security_solution/cypress/e2e/detection_rules/maintenance_window.cy.ts Show resolved Hide resolved
...gine/rule_management_ui/components/maintenance_window_callout/maintenance_window_callout.tsx Outdated Show resolved Hide resolved
@nikitaindik nikitaindik requested a review from a team as a code owner April 24, 2023 10:12
@banderror
Copy link
Contributor

Tested the PR locally -- works perfectly! 🎉

nikitaindik and others added 9 commits April 24, 2023 14:27
@nikitaindik
Remove redundant fields in Jest mocks
08b24a4
@nikitaindik @banderror
Accept error wording suggestion
cf12b62 
Co-authored-by: Georgii Gorbachev <banderror@gmail.com>
@nikitaindik @banderror
Accept callout description wording suggestion
afe38bf 
Co-authored-by: Georgii Gorbachev <banderror@gmail.com>
@nikitaindik
Add "as const" to a constant for a better typechecking
23d738e
@nikitaindik
Merge branch 'maintenance-windows-rule-management' of github.com:niki…
be65dae 
…taindik/kibana into maintenance-windows-rule-management
@nikitaindik
Types
bcf49b2
@nikitaindik @banderror
Accept test title wording suggestion
197d88f 
Co-authored-by: Georgii Gorbachev <banderror@gmail.com>
@nikitaindik
Merge branch 'maintenance-windows-rule-management' of github.com:niki…
e26577e 
…taindik/kibana into maintenance-windows-rule-management
@nikitaindik
Jest tests: fix wording, remove network error logging
32089fe
banderror
banderror approved these changes Apr 24, 2023
View reviewed changes
Copy link
Contributor

@banderror banderror left a comment

Choose a reason for hiding this comment

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

Awesome! Great job and a very clean PR @nikitaindik, thank you!

Just a suggestion for your consideration: #155386 (comment)

maximpn
maximpn approved these changes Apr 24, 2023
View reviewed changes
Copy link
Contributor

@maximpn maximpn left a comment

Choose a reason for hiding this comment

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

@nikitaindik thank you for addressing my comments 🙏

vitaliidm
vitaliidm approved these changes Apr 24, 2023
View reviewed changes
Copy link
Contributor

@vitaliidm vitaliidm left a comment

Choose a reason for hiding this comment

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

Alerts area LGTM

@lcawl lcawl added the ui-copy Review of UI copy with docs team is recommended label Apr 24, 2023
@banderror
Copy link
Contributor

Files by Code Owner

elastic/response-ops

  • x-pack/plugins/alerting/common/index.ts
  • x-pack/plugins/alerting/common/maintenance_window.ts
  • x-pack/plugins/alerting/server/routes/maintenance_window/active_maintenance_windows.ts
  • x-pack/plugins/alerting/server/routes/maintenance_window/archive_maintenance_window.ts
  • x-pack/plugins/alerting/server/routes/maintenance_window/create_maintenance_window.ts
  • x-pack/plugins/alerting/server/routes/maintenance_window/delete_maintenance_window.ts
  • x-pack/plugins/alerting/server/routes/maintenance_window/find_maintenance_windows.ts
  • x-pack/plugins/alerting/server/routes/maintenance_window/finish_maintenance_window.ts
  • x-pack/plugins/alerting/server/routes/maintenance_window/get_maintenance_window.ts
  • x-pack/plugins/alerting/server/routes/maintenance_window/update_maintenance_window.ts

elastic/security-detections-response-alerts

  • x-pack/plugins/security_solution/cypress/e2e/detection_rules/maintenance_window.cy.ts

elastic/security-detections-response-rules

  • x-pack/plugins/security_solution/cypress/e2e/detection_rules/maintenance_window.cy.ts
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/api.ts
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/maintenance_window_callout.test.tsx
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/maintenance_window_callout.tsx
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/translations.ts
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/use_fetch_active_maintenance_windows.ts
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/pages/rule_management/index.tsx

elastic/security-solution

  • x-pack/plugins/security_solution/cypress/e2e/detection_rules/maintenance_window.cy.ts
  • x-pack/plugins/security_solution/cypress/tsconfig.json
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/api.ts
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/maintenance_window_callout.test.tsx
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/maintenance_window_callout.tsx
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/translations.ts
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/components/maintenance_window_callout/use_fetch_active_maintenance_windows.ts
  • x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/pages/rule_management/index.tsx

@nikitaindik nikitaindik enabled auto-merge (squash) April 24, 2023 21:28
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
securitySolution 3843 3847 +4

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
alerting 585 588 +3

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
securitySolution 9.1MB 9.1MB +1.4KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
alerting 48.7KB 48.9KB +225.0B
Unknown metric groups

API count

id before after diff
alerting 606 609 +3

ESLint disabled line counts

id before after diff
enterpriseSearch 17 19 +2
securitySolution 395 400 +5
total +7

Total ESLint disabled count

id before after diff
enterpriseSearch 18 20 +2
securitySolution 475 480 +5
total +7

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @nikitaindik

@nikitaindik nikitaindik merged commit 675ed0e into elastic:main Apr 24, 2023
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Apr 24, 2023
@banderror banderror mentioned this pull request Apr 25, 2023
Closed
3 tasks
nikitaindik added a commit to nikitaindik/kibana that referenced this pull request Apr 25, 2023
@nikitaindik @kibanamachine @banderror
[Security Solution] Add active maintenance window callout to the Rule…
63d6028 
…s Management page (elastic#155386)

**Addresses:** elastic#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 nikitaindik mentioned this pull request May 8, 2023
Merged
nikitaindik added a commit that referenced this pull request May 9, 2023
@nikitaindik
[Security Solution] Maintenance Window callout: Improve UI copy after…
352c8d8 
… 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 pull request May 9, 2023
@nikitaindik
[Security Solution] Maintenance Window callout: Improve UI copy after…
45a9996 
… 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 pull request May 20, 2023
@kibanamachine @nikitaindik @banderror
[8.8] [Security Solution] Maintenance Window callout: Improve UI copy…
1f033b4 
… 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
Reviewers

@XavierM XavierM XavierM approved these changes

@maximpn maximpn maximpn approved these changes

@banderror banderror banderror approved these changes

@vitaliidm vitaliidm vitaliidm approved these changes

Assignees

@nikitaindik nikitaindik

Labels
backport:skip This commit does not require backporting Feature:Rule Management Security Solution Detection Rule Management release_note:feature Makes this part of the condensed release notes 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@nikitaindik @elasticmachine @banderror @kibana-ci @XavierM @maximpn @vitaliidm @lcawl @kibanamachine