-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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
[Docs]7.7 SIEM doc updates #63951
[Docs]7.7 SIEM doc updates #63951
Conversation
@andrew-goldstein can you review the advanced settings update? Thanks |
@@ -217,6 +217,9 @@ might increase the search time. This setting is off by default. Users must opt-i | |||
[horizontal] | |||
`siem:defaultAnomalyScore`:: The threshold above which Machine Learning job anomalies are displayed in the SIEM app. | |||
`siem:defaultIndex`:: A comma-delimited list of Elasticsearch indices from which the SIEM app collects events. | |||
`siem:ipReputationLinks`:: A JSON array containing links for verifying an IP | |||
address’s reputation. The links are displayed on |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IP address's reputation > the reputation of an IP address?
docs/siem/siem-ui.asciidoc
Outdated
@@ -50,6 +50,22 @@ or the Detections API. | |||
[role="screenshot"] | |||
image::siem/images/detections-ui.png[] | |||
|
|||
[float] | |||
[[cases-ui]] | |||
=== Cases (Beta) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggest removing Beta from the title and using this in the first line:
beta:[] Cases are used to open...
That way, you will get a definition of what it means for a feature to be in beta. If you do that, you'll also have to make the change for Detections earlier in the page.
If you keep beta in the title, we use beta (lower case b)
docs/siem/siem-ui.asciidoc
Outdated
[[cases-ui]] | ||
=== Cases (Beta) | ||
|
||
Cases are used to open and track security issues directly in the {siem-app}. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We try to avoid using the word app in the Kibana docs and use the name alone, in this case, SIEM.
docs/siem/siem-ui.asciidoc
Outdated
=== Cases (Beta) | ||
|
||
Cases are used to open and track security issues directly in the {siem-app}. | ||
They list the original reporter and all users who contribute to a case |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They > Cases ?
docs/siem/siem-ui.asciidoc
Outdated
|
||
Cases are used to open and track security issues directly in the {siem-app}. | ||
They list the original reporter and all users who contribute to a case | ||
(`participants`). Case comments support markdown syntax, and allow linking to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
markdown > Markdown
@gchaps |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor nits. Otherwise, LGTM.
docs/siem/siem-ui.asciidoc
Outdated
[[cases-ui]] | ||
=== Cases (beta) | ||
|
||
Cases are used to open and track security issues directly in the SIEM. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the SIEM > SIEM.
docs/siem/siem-ui.asciidoc
Outdated
[[cases-ui]] | ||
=== Cases (beta) | ||
|
||
Cases are used to open and track security issues directly in the SIEM. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the SIEM > SIEM
docs/siem/siem-ui.asciidoc
Outdated
Cases list the original reporter and all users who contribute to a case | ||
(`participants`). Case comments support Markdown syntax, and allow linking to | ||
saved Timelines. Additionally, you can send cases to external systems from | ||
within the {siem-app} (currently ServiceNow). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should also replace {siem-app} here with SIEM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for these additions @benskelker!
LGTM 🚀
* SIEM section doc updates * corrections * more corrections
* SIEM section doc updates * corrections * more corrections
* master: (29 commits) [Dashboard] Deangularize navbar, attempt nr. 2 (elastic#61611) refactor action filter creation utils (elastic#62969) Refresh index pattern list before redirecting (elastic#63329) [APM]fixing custom link unit tests (elastic#64045) [Ingest] EPM & Fleet are enabled when Ingest is enabled (elastic#64103) [Alerting] Fixed bug with no possibility to edit the index name after adding (elastic#64033) [Maps] Map settings: min and max zoom (elastic#63714) [kbn-storybook] Use raw loader for text files (elastic#64108) [EPM] /packages/{package} endpoint to support upgrades (elastic#63629) [SIEM] New Platform Saved Objects Registration (elastic#64029) [Endpoint] Hook to handle events needing navigation via Router (elastic#63863) Fixed small issue in clone functionality (elastic#64085) [Endpoint]EMT-146: use ingest agent for status info (elastic#63921) [SIEM] Server NP Followup (elastic#64010) Register uiSettings on New Platform (elastic#64015) [Reporting] Integration polling config with client code (elastic#63754) [Docs]7.7 SIEM doc updates (elastic#63951) [SIEM] [Cases] Tags suggestions (elastic#63878) Include datasource UUID in agent config yaml, adjust overflow height of yaml view (elastic#64027) [DOCS] Add file size setting for Data Visualizer (elastic#64006) ...
…ana into task-manager/cancel-logging * 'task-manager/cancel-logging' of github.com:gmmorris/kibana: (28 commits) [Dashboard] Deangularize navbar, attempt nr. 2 (elastic#61611) refactor action filter creation utils (elastic#62969) Refresh index pattern list before redirecting (elastic#63329) [APM]fixing custom link unit tests (elastic#64045) [Ingest] EPM & Fleet are enabled when Ingest is enabled (elastic#64103) [Alerting] Fixed bug with no possibility to edit the index name after adding (elastic#64033) [Maps] Map settings: min and max zoom (elastic#63714) [kbn-storybook] Use raw loader for text files (elastic#64108) [EPM] /packages/{package} endpoint to support upgrades (elastic#63629) [SIEM] New Platform Saved Objects Registration (elastic#64029) [Endpoint] Hook to handle events needing navigation via Router (elastic#63863) Fixed small issue in clone functionality (elastic#64085) [Endpoint]EMT-146: use ingest agent for status info (elastic#63921) [SIEM] Server NP Followup (elastic#64010) Register uiSettings on New Platform (elastic#64015) [Reporting] Integration polling config with client code (elastic#63754) [Docs]7.7 SIEM doc updates (elastic#63951) [SIEM] [Cases] Tags suggestions (elastic#63878) Include datasource UUID in agent config yaml, adjust overflow height of yaml view (elastic#64027) [DOCS] Add file size setting for Data Visualizer (elastic#64006) ...
Summary
Updates the SIEM section of the Kibana docs for 7.7.
Checklist
Delete any items that are not applicable to this PR.
[skip-ci]