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

[DOCS] Document the new Maintenance Windows feature #3181

Closed
nikitaindik opened this issue Apr 21, 2023 · 2 comments · Fixed by #3253
Closed

[DOCS] Document the new Maintenance Windows feature #3181

nikitaindik opened this issue Apr 21, 2023 · 2 comments · Fixed by #3253
Assignees
@nastasha-solomon
Labels
Feature: Rules Team: Detections/Response Detections and Response Team: Docs v8.8.0

Comments

@nikitaindik
Copy link
Contributor

Related issue: elastic/kibana#155099
Related PR: elastic/kibana#155386

Summary

Explain what Maintenance Windows feature is to Security Solution users. It is a new feature that is going to be released in v8.8. It allows a user to set up time periods during which rule notification actions won't get triggered (rules would still run and generate alerts though). Also user would see a callout on the Rule Management page while a maintenance window is running.

Screenshot 2023-04-21 at 13 24 11

You can view and create maintenance windows on the Stack Management page -> Maintenance Windows (under Alerts and Insights).

Screenshot 2023-04-21 at 16 04 51

Maintenance windows can be set up to run once or repeated based on a schedule.

Screenshot 2023-04-21 at 16 05 29
@nikitaindik nikitaindik mentioned this issue Apr 21, 2023
Merged
7 tasks
@banderror banderror mentioned this issue Apr 24, 2023
Closed
nikitaindik added a commit to elastic/kibana that referenced this issue Apr 24, 2023
@nikitaindik @kibanamachine @banderror
[Security Solution] Add active maintenance window callout to the Rule…
675ed0e 
…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 to nikitaindik/kibana that referenced this issue 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>
@nastasha-solomon nastasha-solomon self-assigned this Apr 25, 2023
@nastasha-solomon
Copy link
Contributor

nastasha-solomon commented May 10, 2023 •
edited
Loading

As per elastic/kibana#152032, the Kibana docs will likely be added to the Manage rules section. I'll link to that section in the Security docs. Might just add a new section to the security docs that describes what users can expect to see if a maintenance window is running.

This was referenced May 10, 2023
Merged
Closed
@nastasha-solomon
Copy link
Contributor

Note to self to link to kibana docs once they're merged: elastic/kibana#157806

@lcawl lcawl mentioned this issue May 23, 2023
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nastasha-solomon nastasha-solomon

Labels
Feature: Rules Team: Detections/Response Detections and Response Team: Docs v8.8.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document the new Maintenance Windows feature elastic/security-docs
3 participants
@banderror @nikitaindik @nastasha-solomon