diff --git a/README.md b/README.md index a44f2a06b3..c9c52b0d6f 100644 --- a/README.md +++ b/README.md @@ -9,23 +9,10 @@ Please view this template for guidance on creating issues: https://github.com/el ## Contributing to Elastic Security docs If you are an Elastic employee and would like to contribute to Elastic Security documentation: - 1. Please clone and fork the `security-docs` repo. 2. Open an issue using the appropriate [template](https://github.com/elastic/security-docs/tree/master/.github/ISSUE_TEMPLATE). 3. Check out the `main` branch and fetch the latest changes. 4. Check out a new branch and make your changes. 5. Save your changes and open a pull request. -6. Add the `[@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs)` team and any other appropriate members as reviewers. -7. Add the appropriate release version label, backport version label if appropriate, and team label to the PR. -8. Once the docs team approves all changes, you can merge it. If a backport version label was added to a PR for stack versions 7.14.0 and newer, mergify will automatically open a backport PR. -9. Merge the backport PR once it passes all CI checks. - -### Preview documentation changes - -Once the PR is opened, and the build complete, the changes can be previewed via this URL (replace `` with the PR number): - -``` -https://security-docs_.docs-preview.app.elstc.co/guide/en/security/master -``` - +6. Tag the the `@security-docs` team and any other appropriate reviewers. We'll take care of merging and backporting. diff --git a/docs/cases/cases-ui-integrations.asciidoc b/docs/cases/cases-ui-integrations.asciidoc index 50fd3ed455..aa5340713c 100644 --- a/docs/cases/cases-ui-integrations.asciidoc +++ b/docs/cases/cases-ui-integrations.asciidoc @@ -4,10 +4,10 @@ You can push {es-sec} cases to these third-party systems: -* {sn-itsm} -* {sn-sir} * {jira} (including Jira Service Desk) * {ibm-r} +* {sn-itsm} +* {sn-sir} * {swimlane} * {webhook-cm} @@ -25,14 +25,90 @@ https://www.elastic.co/subscriptions[appropriate license], and your role needs * [role="screenshot"] image::images/cases-ui-connector.png[Shows the page for creating connectors] . From the *Incident management system* list, select *Add new connector*. -. Select the system to send cases to: *{sn}*, *{jira}*, *{ibm-r}*, *{swimlane}*, or *{webhook-cm}*. -. Enter your required settings. For connector configuration details, refer to: -- {kibana-ref}/servicenow-action-type.html[{sn-itsm} connector] -- {kibana-ref}/servicenow-sir-action-type.html[{sn-sir} connector] -- {kibana-ref}/jira-action-type.html[{jira} connector] -- {kibana-ref}/resilient-action-type.html[{ibm-r} connector] -- {kibana-ref}/swimlane-action-type.html[{swimlane} connector] -- {kibana-ref}/cases-webhook-action-type.html[{webhook-cm} connector] +. Select the system to send cases to *{sn}*, *{jira}*, *{ibm-r}*, or *{swimlane}*. + +. Enter a name for the connector, provide the required settings, and then save it. ++ +** For {jira} connectors: + +* *URL*: The URL of the external system to which you want to send cases. +* *Project key*: The key of the {jira} project to which you are sending cases. +* *Email address*: The {jira} account username or email. +* *API token*: The API token or password is used to authenticate {jira} updates. + +** For {ibm-r} connectors: + +* *URL*: The URL of the external system to which you want to send cases. +* *Organization ID*: Your organization’s {ibm-r} ID number. +* *API key ID*: The API key used to authenticate {ibm-r} updates. +* *API key secret*: The API key secret used to authenticate {ibm-r} updates. + +** For {sn} connectors: ++ +IMPORTANT: If you've upgraded from {stack} version 7.15.0 or earlier to 7.16.0 or later, you must complete several prerequisites before creating a new {sn-itsm} or {sn-sir} connector. For more information, refer to prerequisites for {kibana-ref}/servicenow-action-type.html#servicenow-itsm-connector-prerequisites[{sn-itsm}] and {kibana-ref}/servicenow-sir-action-type.html#servicenow-sir-connector-prerequisites[{sn-sir}]. ++ + +* *{sn} instance URL*: The URL of the {sn} instance to which you want to send cases. +* *Use OAuth authentication*: Enable this to use open authorization (OAuth) to authenticate a connection between Elastic and {sn}. ++ +NOTE: To use open authorization (OAuth), you must {kibana-ref}/servicenow-action-type.html#servicenow-itsm-connector-prerequisites-rsa-key[create an RSA keypair and add an X.509 Certificate] and also {kibana-ref}/servicenow-action-type.html#servicenow-itsm-connector-prerequisites-endpoint[create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map.] ++ + +* *Username*: (Displays if *Use OAuth authentication* is turned _off_.) The username of the {sn} account used to access the {sn} instance. +* *Password*: (Displays if *Use OAuth authentication* is turned _off_.) The password of the {sn} account used to access the {sn} instance. +* *Client ID*: (Displays if *Use OAuth authentication* is turned _on_.) The client ID assigned to your OAuth application. +* *User Identifier*: (Displays if *Use OAuth authentication* is turned _on_.) Identifier to use for OAuth type authentication. Use the value you entered into the *User field* when you created an OAuth JWT API endpoint for external clients. +* *JWT Verifier Key ID*: (Displays if *Use OAuth authentication* is turned _on_.) +The key ID assigned to the JWT Verifier Map of your OAuth application. +* *Client Secret*: (Displays if *Use OAuth authentication* is turned _on_.) The client secret assigned to your OAuth application. +* *Private Key*: (Displays if *Use OAuth authentication* is turned _on_.) +The RSA private key generated when you created an RSA keypair. +* *Private Key Password*: (Displays if *Use OAuth authentication* is turned _on_.) The password for the RSA private key generated during setup, if set. + +** For {swimlane} connectors: + +* *API URL*: The URL of the {swimlane} instance to which you want to send cases. +* *Application ID*: The application ID of your {swimlane} application. From {swimlane}, you can find the application +ID by checking your application’s settings or at the end of your application’s URL after you’ve opened it. +* *API token*: The {swimlane} API authentication token used for HTTP Basic authentication. +This is the personal access token for your user role. +* *Connector Type*: Select a connector type: +*** *All*: You can choose to set all or no field mappings when creating your new {swimlane} connector. However, note that if you don’t set field mappings now, you’ll be prompted to do so if you want to use the connector for a case or a rule. +*** *Alerts*: Provide an alert ID and rule name. +*** *Cases*: Provide a case ID, a case name, comments, and a description. + + +[float] +[[mapped-case-fields]] +=== Mapped case fields + +To represent an {es-sec} case in an external system, {es-sec} case fields are mapped to existing fields in {sn}, {jira}, {ibm-r}, and {swimlane}. Once fields are mapped, you can push updates to external systems and mapped fields are overwritten or appended. Retrieving data from external systems is not supported. + +|=== + +| *Case field* | *Mapped field* + +| Title + +a| The case `Title` field is mapped to corresponding fields in external systems. Mapped field values are overwritten when you push updates. + +* *{sn}*: Mapped to the `Short description` field. +* *{jira}*: Mapped to the `Summary` field. +* *{ibm-r}*: Mapped to the `Name` field. +* *{swimlane}*: Mapped to the `Description` field. + +| Description +| The case `Description` field is mapped to the `Description` field in {sn}, {jira}, {ibm-r}, and {swimlane}. Mapped field values are overwritten when you push updates. + +| Comments + +a| For {sn} connctors, the case `Comments` field is mapped to the `Work Notes` field in {sn}. + +For {jira}, {ibm-r}, and {swimlane} connectors, the case `Comments` field is mapped to the `Comments` field in {jira}, {ibm-r}, and {swimlane}. + +New and edited comments are added to incident records when pushed to {sn}, {jira}, or {ibm-r}. Comments pushed to {swimlane} are appended to the `Comment` field in {swimlane} and posted individually. + +|=== [[close-connector]] [float] diff --git a/docs/detections/alerts-ui-manage.asciidoc b/docs/detections/alerts-ui-manage.asciidoc index da30814d0c..9c82b63157 100644 --- a/docs/detections/alerts-ui-manage.asciidoc +++ b/docs/detections/alerts-ui-manage.asciidoc @@ -39,7 +39,7 @@ NOTE: When updating alert results to include building block alerts, the Security [role="screenshot"] image::images/additional-filters.png[Alerts table with Additional filters menu highlighted] -* View detection alerts generated by a specific rule. Go to *Manage* -> *Rules*, then select a rule name in the table. The rule details page displays a comprehensive view of the rule's settings, and the Alerts table under the Trend histogram displays the alerts associated with the rule, including alerts from any previous or deleted revision of that rule. +* View detection alerts generated by a specific rule. Go to *Detect* -> *Rules*, then select a rule name in the table. The rule details page displays a comprehensive view of the rule's settings, and the Alerts table under the Trend histogram displays the alerts associated with the rule, including alerts from any previous or deleted revision of that rule. [float] [[customize-the-alerts-table]] diff --git a/docs/detections/api/rules/rules-api-create.asciidoc b/docs/detections/api/rules/rules-api-create.asciidoc index 2213a79abb..55ba07b896 100644 --- a/docs/detections/api/rules/rules-api-create.asciidoc +++ b/docs/detections/api/rules/rules-api-create.asciidoc @@ -394,7 +394,7 @@ a value from the source event: |rule_name_override |String |Sets which field in the source event is used to populate the alert's `signal.rule.name` value (in the UI, this value is -displayed on the *Rules* page in the *Rule* column). When unspecified, the +displayed in the *Rule* column on the Detections page). When unspecified, the rule's `name` value is used. The source field must be a string data type. |severity_mapping |Object[] a|Overrides generated alerts' `severity` with @@ -550,7 +550,8 @@ All fields are required: |============================================== NOTE: Only threats described using the MITRE ATT&CK^TM^ framework are displayed -in the UI (*Manage* -> *Rules* -> *_Rule name_*). +in the UI (*Detections* -> *Manage detection rules* -> ). ===== Example requests diff --git a/docs/detections/api/rules/rules-api-export.asciidoc b/docs/detections/api/rules/rules-api-export.asciidoc index 3c1370f219..c6c53cc21b 100644 --- a/docs/detections/api/rules/rules-api-export.asciidoc +++ b/docs/detections/api/rules/rules-api-export.asciidoc @@ -12,7 +12,7 @@ You cannot export prebuilt rules, but they are available at https://github.com/e ================= Although detection rule actions are included in the exported file, the connectors used by the actions are not included. Use the {kibana-ref}/managing-saved-objects.html#managing-saved-objects-export-objects[Saved Objects] UI in Kibana (*Stack Management* -> *Kibana* -> *Saved Objects*) or the Saved Objects APIs (experimental) to {kibana-ref}/saved-objects-api-export.html[export] and {kibana-ref}/saved-objects-api-import.html[import] any necessary connectors _before_ you export and import the detection rules. -Similarly, any value lists used for rule exceptions are not included in rule exports or imports. Use the <> UI (*Manage* -> *Rules* -> *Upload value lists*) to export and import value lists separately. +Similarly, any value lists used for rule exceptions are not included in rule exports or imports. Use the <> UI (*Detect* -> *Rules* -> *Upload value lists*) to export and import value lists separately. ================= ==== Request URL diff --git a/docs/detections/api/rules/rules-api-import.asciidoc b/docs/detections/api/rules/rules-api-import.asciidoc index de11902f14..ef1428e223 100644 --- a/docs/detections/api/rules/rules-api-import.asciidoc +++ b/docs/detections/api/rules/rules-api-import.asciidoc @@ -14,7 +14,7 @@ NOTE: You need at least `Read` privileges for the `Action and Connectors` featur ================= Although detection rule actions are included in the exported file, the connectors used by the actions are not included. Use the {kibana-ref}/managing-saved-objects.html#managing-saved-objects-export-objects[Saved Objects] UI in Kibana (*Stack Management* -> *Kibana* -> *Saved Objects*) or the Saved Objects APIs (experimental) to {kibana-ref}/saved-objects-api-export.html[export] and {kibana-ref}/saved-objects-api-import.html[import] any necessary connectors _before_ you export and import the detection rules. -Similarly, any value lists used for rule exceptions are not included in rule exports or imports. Use the <> UI (*Manage* -> *Rules* -> *Upload value lists*) to export and import value lists separately. +Similarly, any value lists used for rule exceptions are not included in rule exports or imports. Use the <> UI (*Detect* -> *Rules* -> *Upload value lists*) to export and import value lists separately. ================= ==== Request URL diff --git a/docs/detections/api/rules/rules-api-update.asciidoc b/docs/detections/api/rules/rules-api-update.asciidoc index fe4dced8fd..ee05e91a18 100644 --- a/docs/detections/api/rules/rules-api-update.asciidoc +++ b/docs/detections/api/rules/rules-api-update.asciidoc @@ -310,7 +310,7 @@ a value from the source event: |rule_name_override |String |Sets which field in the source event is used to populate the alert's `signal.rule.name` value (in the UI, this value is -displayed on the *Rules* page in the *Rule* column). When unspecified, the +displayed in the *Rule* column on the Detections page). When unspecified, the rule's `name` value is used. The source field must be a string data type. |severity_mapping |Object[] a|Overrides generated alerts' `severity` with @@ -427,7 +427,8 @@ technique: |============================================== NOTE: Only threats described using the MITRE ATT&CK^TM^ framework are displayed -in the UI (*Manage* -> *Rules* -> *_Rule name_*). +in the UI (*Security* -> *Detections* -> *Manage detection rules* -> ). ===== Example request diff --git a/docs/detections/building-block-rule.asciidoc b/docs/detections/building-block-rule.asciidoc index c4afa52d90..4a3af7527d 100644 --- a/docs/detections/building-block-rule.asciidoc +++ b/docs/detections/building-block-rule.asciidoc @@ -26,7 +26,7 @@ image::images/alert-indices-ui.png[] By default, building block alerts are excluded from the Overview and Alerts pages. You can choose to include building block alerts on the Alerts page, which expands the number of alerts. -. Go to *Alerts*. +. Go to *Detect* -> *Alerts*. . In the Alerts table, select *Additional filters* -> *Include building block alerts*, located on the far-right. diff --git a/docs/detections/detection-engine-intro.asciidoc b/docs/detections/detection-engine-intro.asciidoc index 8c3972c85c..046cc87884 100644 --- a/docs/detections/detection-engine-intro.asciidoc +++ b/docs/detections/detection-engine-intro.asciidoc @@ -3,15 +3,15 @@ = Detections and alerts -Use the detection engine to create and manage rules and view the alerts -these rules create. Rules periodically search indices (such as `logs-*` and -`filebeat-*`) for suspicious source events and create alerts when a rule's +Use the Detections feature to create and manage rules, and view the alerts +these rules create. Rules periodically search indices (such as `endgame-*` and +`filebeat-*`) for suspicious source events, and create alerts when a rule's conditions are met. When an alert is created, its status is `Open`. To help -track investigations, an alert's <> can be set as -`Open`, `Acknowledged`, or `Closed`. +track investigations, an alert's status can be set as `Open`, `Acknowledged`, or +`Closed` (see <>). [role="screenshot"] -image::images/alert-page.png[Alerts page] +image::images/alert-page.png[Shows the Alerts page] In addition to creating <>, enable <> to immediately start detecting @@ -195,26 +195,26 @@ NOTE: Ransomware prevention is a paid feature and is enabled by default if you h === Resolve UI error messages Depending on your privileges and whether detection system indices have already -been created for the {kib} space, you might get one of these error messages when you -open the *Alerts* or *Rules* page: +been created for the {kib} space, you might see an error message when you try +to open the *Detections* page. + +*`Let’s set up your detection engine`* + +If you see this message, a user with specific privileges must visit the +*Detections* page before you can view detection rules and alerts. +See <> for a list of all the requirements. -* *`Let’s set up your detection engine`* -+ -If you get this message, a user with specific privileges must visit the -*Alerts* or *Rules* page before you can view detection alerts and rules. -Refer to <> for a list of all the requirements. -+ NOTE: For *self-managed* {stack} deployments only, this message may be displayed when the <> -setting has not been added to the `kibana.yml` file. For more information, refer to <>. +setting has not been added to the `kibana.yml` file. For more information, see <>. -* *`Detection engine permissions required`* -+ -If you get this message, you do not have the +*`Detection engine permissions required`* + +If you see this message, you do not have the <> to view the *Detections* feature, and you should contact your {kib} administrator. -+ + NOTE: For *self-managed* {stack} deployments only, this message may be displayed when the <> -setting is not enabled in the `elasticsearch.yml` file. For more information, refer to <>. +setting is not enabled in the `elasticsearch.yml` file. For more information, see <>. diff --git a/docs/detections/detections-ui-exceptions.asciidoc b/docs/detections/detections-ui-exceptions.asciidoc index 4eea9c36aa..c7ad1ba762 100644 --- a/docs/detections/detections-ui-exceptions.asciidoc +++ b/docs/detections/detections-ui-exceptions.asciidoc @@ -41,7 +41,7 @@ act as value delimiters. * Wildcards are not supported in rule exceptions or value lists. Values must be literal values. ========================= -. Go to *Manage* -> *Rules*. +. Go to *Detect* -> *Rules*. . Click *Upload value lists*. The *Upload value lists* window opens. + [role="screenshot"] @@ -60,7 +60,7 @@ the new file are appended to the previously uploaded values. To view, delete, or export existing value lists: -. Go to *Manage* -> *Rules*. +. Go to *Detect* -> *Rules*. . Click *Upload value lists*. The *Upload value lists* window opens. . In the *Value lists* table, click the required action button. @@ -101,7 +101,7 @@ specific event in the sequence, update the rule's EQL statement. For example: -- * To add an exception from the rule details page: .. Go to the rule details page of the rule to which you want to add an -exception (*Manage* -> *Rules* -> *__*). +exception (*Detect* -> *Rules* -> *__*). .. Scroll down below the rule details and select the *Exceptions* tab. + [role="screenshot"] @@ -109,7 +109,7 @@ image::images/exception-histogram.png[Detail of Exceptions tab, 75%] .. Click *Add new exception* -> *Add rule exception*. * To add an exception from the Alerts table: -.. Go to *Alerts*. +.. Go to *Detect* -> *Alerts*. .. Scroll down to the Alerts table, go to the alert you want to create an exception for, click the *More Actions* menu (*...*), then select *Add rule exception*. The *Add Rule Exception* flyout opens (the example below was opened from the Alerts table): @@ -189,11 +189,11 @@ Additionally, to add an Endpoint exception to the Elastic Endpoint Security rule + -- * To add an Endpoint exception from the rule details page: -.. Go to the rule details page (*Manage* -> *Rules*), and then search for and select the Elastic *Endpoint Security* rule. +.. Go to the rule details page (*Detect* -> *Rules*), and then search for and select the Elastic *Endpoint Security* rule. .. Scroll down to the *Trend* histogram and select the *Exceptions* tab. .. Click *Add new exception* -> *Add Endpoint exception*. * To add an Endpoint exception from the Alerts table: -.. Go to *Alerts*. +.. Go to *Detect* -> *Alerts*. .. Scroll down to the Alerts table, and from an {elastic-endpoint} alert, click the *More actions* menu (*...*), then select *Add Endpoint exception*. -- @@ -282,7 +282,7 @@ image::images/nested-exp.png[] [[manage-exceptions]] === View and manage exception lists -The Exception lists table enables you to view and manage all exceptions that have been assigned to rules. To view the Exception lists table, go to *Manage* -> *Exception lists*. +The Exception lists table enables you to view and manage all exceptions that have been assigned to rules. To view the Exception lists table, go to *Detect* -> *Exception lists*. [role="screenshot"] image::images/exceptions-page.png[] diff --git a/docs/detections/machine-learning/machine-learning.asciidoc b/docs/detections/machine-learning/machine-learning.asciidoc index 93eb30cab0..79a9447be9 100644 --- a/docs/detections/machine-learning/machine-learning.asciidoc +++ b/docs/detections/machine-learning/machine-learning.asciidoc @@ -3,8 +3,8 @@ = Anomaly Detection with Machine Learning {ml-docs}/ml-ad-overview.html[{ml-cap}] functionality is available when -you have the appropriate subscription, are using a *{ess-trial}[cloud deployment]*, -or are testing out a *Free Trial*. Refer to <>. +you have the *{subscriptions}[appropriate license]*, are +using a *{ess-trial}[cloud deployment]*, or are testing out a *Free Trial*. You can view the details of detected anomalies within the `Anomalies` table widget shown on the Hosts, Network, and associated details pages, or even narrow diff --git a/docs/detections/prebuilt-rules/tune-rule-signals.asciidoc b/docs/detections/prebuilt-rules/tune-rule-signals.asciidoc index 6be59eee6c..56ba0ba87d 100644 --- a/docs/detections/prebuilt-rules/tune-rule-signals.asciidoc +++ b/docs/detections/prebuilt-rules/tune-rule-signals.asciidoc @@ -33,7 +33,7 @@ add an exception for the required application. For example, to prevent the https://www.elastic.co/guide/en/security/8.3/unusual-process-execution-temp.html[unusual-process-execution-temp] rule from producing alerts for an in-house application named `myautomatedbuild`: -. Go to *Manage* -> *Rules*. +. Go to *Detect* -> *Rules*. . Search for and then click on the *Unusual Process Execution - Temp* rule. + The *Unusual Process Execution - Temp* rule details page is displayed. diff --git a/docs/detections/rules-ui-create.asciidoc b/docs/detections/rules-ui-create.asciidoc index 16c4e1ac35..8986bd2df9 100644 --- a/docs/detections/rules-ui-create.asciidoc +++ b/docs/detections/rules-ui-create.asciidoc @@ -81,7 +81,7 @@ If a rule requires certain privileges to run, such as index privileges, keep in [[create-rule-ui]] === Select rule type and scope -. Go to *Manage* -> *Rules* -> *Create new rule*. The *Create new rule* page displays. +. Go to *Detect* -> *Rules* -> *Create new rule*. The *Create new rule* page displays. + [role="screenshot"] image::images/create-new-rule.png[] @@ -558,7 +558,7 @@ You uploaded a value list of known ransomware domains, and you want to be notifi * *Field*: Enter the field from the Elastic Security event indices to be used for comparing values. * *Indicator index field*: Enter the type of value list you created (i.e., `keyword`, `text`, or `IP`). + -TIP: If you don't remember this information, go to *Manage* -> *Rules* -> *Upload value lists*. Locate the appropriate value list and note the field in the corresponding `Type` column. (Examples include keyword, text, and IP.) +TIP: If you don't remember this information, go to *Detect* -> *Rules > Upload value lists*. Locate the appropriate value list and note the field in the corresponding `Type` column. (Examples include keyword, text, and IP.) [role="screenshot"] image::images/indicator_value_list.png[] diff --git a/docs/detections/rules-ui-manage.asciidoc b/docs/detections/rules-ui-manage.asciidoc index 346c2ca5ff..13251a89d1 100644 --- a/docs/detections/rules-ui-manage.asciidoc +++ b/docs/detections/rules-ui-manage.asciidoc @@ -38,7 +38,7 @@ NOTE: Searches for index patterns and MITRE ATT&CK tactics and techniques must m [[load-prebuilt-rules]] === Load and activate prebuilt Elastic rules -To load the {es-sec-app}'s <>, go to *Manage* -> *Rules* -> *Load Elastic prebuilt rules and Timeline templates*. +To load the {es-sec-app}'s <>, go to *Detect -> Rules -> Load Elastic prebuilt rules and Timeline templates*). You can then activate whichever rules you want. If you delete any prebuilt rules, a button appears that enables you to reload all of the deleted ones. @@ -54,7 +54,7 @@ To learn how to enable detection rules in Elastic Security, watch the < *Rules*. +. Go to *Detect -> Rules*. . Click *Select all _x_ rules* above the rules table. . Click *Bulk actions* -> *Duplicate*. . Select the *Custom rules* tab. @@ -90,7 +90,7 @@ You can edit an existing rule's settings, and can bulk edit index patterns, tags NOTE: For prebuilt Elastic rules, you can't modify most settings. You can only edit <> and <>. -. Go to *Manage* -> *Rules*. +. Go to *Detect* -> *Rules*. . Do one of the following: * Edit a single rule: Select the *All actions* menu (*...*) on a rule, then select *Edit rule settings*. The *Edit rule settings* view opens, where you can modify the <>. * Bulk edit multiple rules: Select the rules you want to edit, then select an action from the *Bulk actions* menu: @@ -107,7 +107,7 @@ NOTE: For prebuilt Elastic rules, you can't modify most settings. You can only e You can duplicate, enable, disable, and delete rules: -. Go to *Manage* -> *Rules*. +. Go to *Detect* -> *Rules*. . Do one of the following: * Select the *All actions* menu (*...*) on a rule, then select an action. * Select all the rules you want to modify, then select an action from the *Bulk actions* menu. @@ -131,7 +131,7 @@ Similarly, any value lists used for rule exceptions are not included in rule exp To export and import detection rules: -. Go to *Manage* -> *Rules*. +. Go to *Detect* -> *Rules*. . To export rules: .. In the rules table, select the rules you want to export. .. Select *Bulk actions* -> *Export*, then save the exported file. diff --git a/docs/detections/rules-ui-monitor.asciidoc b/docs/detections/rules-ui-monitor.asciidoc index d44cf319eb..587982e0e4 100644 --- a/docs/detections/rules-ui-monitor.asciidoc +++ b/docs/detections/rules-ui-monitor.asciidoc @@ -15,7 +15,7 @@ Refer to the <> section below for strategies on using thes === Rule Monitoring tab To view a summary of all rule executions, including the most recent failures and execution -times, select the *Rule Monitoring* tab on the *Rules* page (*Manage* -> +times, select the *Rule Monitoring* tab on the *Rules* page (*Detect* -> *Rules* -> *Rule Monitoring*). [role="screenshot"] @@ -33,7 +33,7 @@ For detailed information on a rule, the alerts it generated, and associated erro Each detection rule execution is logged, including its success or failure, any warning or error messages, and how long it took to search for data, create alerts, and complete. This can help you troubleshoot a particular rule if it isn't behaving as expected (for example, if it isn't creating alerts or takes a long time to run). -To access a rule's execution log, go to *Manage* -> *Rules*, click the rule's name to open its details, then scroll down and select the *Rule execution logs* tab. +To access a rule's execution log, go to *Detect* -> *Rules*, click the rule's name to open its details, then scroll down and select the *Rule execution logs* tab. [role="screenshot"] image::images/rule-execution-logs.png[Rule execution logs table] @@ -75,7 +75,7 @@ You can also use Task Manager in {kib} to troubleshoot background tasks and proc If you see values in the Gaps column in the Rule Monitoring table or on the Rule details page for a small number of rules, you can increase those rules' -Additional look-back time (*Manage* -> *Rules* -> the rule's *All actions* menu (*...*) -> *Edit rule settings* -> *Schedule* -> *Additional look-back time*). +Additional look-back time (*Detect* -> *Rules* -> the rule's *All actions* menu (*...*) -> *Edit rule settings* -> *Schedule* -> *Additional look-back time*). It's recommended to set the `Additional look-back time` to at least 1 minute. This ensures there are no missing alerts when a rule doesn't diff --git a/docs/detections/session-view.asciidoc b/docs/detections/session-view.asciidoc index 00f5c2c9e7..e4f6465b5f 100644 --- a/docs/detections/session-view.asciidoc +++ b/docs/detections/session-view.asciidoc @@ -35,7 +35,7 @@ Session View is accessible from the **Hosts**, **Alerts**, and **Timelines** pag Events and sessions that you can investigate in Session View have a rectangular *Open Session View* button in the *Actions* column. For example: -* On the Alerts page, scroll down to view the Alerts table. +* On the Alerts page (*Detect* -> *Alerts*), scroll down to view the Alerts table. Look for alerts that have the **Open Session View** button in the **Actions** column: [role="screenshot"] image::images/session-view-action-icon-detail.png[Detail of the Open Session View icon,width=75%] diff --git a/docs/detections/visual-event-analyzer.asciidoc b/docs/detections/visual-event-analyzer.asciidoc index c9ed998d59..0f9bf856f1 100644 --- a/docs/detections/visual-event-analyzer.asciidoc +++ b/docs/detections/visual-event-analyzer.asciidoc @@ -19,7 +19,7 @@ To find events that can be visually analyzed: . First, view a list of events by doing one of the following: * Go to *Explore* -> *Hosts*, then select the *Events* tab. A list of all your hosts' events appears at the bottom of the page. -* Go to *Alerts*, then scroll down to view the Alerts table. +* Go to *Detect* -> *Alerts*, then scroll down to view the Alerts table. . Filter events that can be visually analyzed by entering either of the following queries in the KQL search bar, then selecting *Enter*: ** `agent.type:"endpoint" and process.entity_id :*` + diff --git a/docs/getting-started/install-endpoint.asciidoc b/docs/getting-started/install-endpoint.asciidoc index 3272709ffc..9f8bff3098 100644 --- a/docs/getting-started/install-endpoint.asciidoc +++ b/docs/getting-started/install-endpoint.asciidoc @@ -16,7 +16,7 @@ If you're using macOS, some versions may require you to grant Full Disk Access t [[add-security-integration]] == Add the {endpoint-cloud-sec} integration -. In {kib}, select **Security** -> **Manage** -> **Endpoints**. If this is not your first time using {es-sec}, select **Management** -> **Integrations**, then search for and select **{endpoint-cloud-sec}**. +. In {kib}, select **Security** -> **Endpoints**. If this is not your first time using {es-sec}, select **Management** -> **Integrations**, then search for and select **{endpoint-cloud-sec}**. + [role="screenshot"] image::images/install-endpoint/endpoint-cloud-sec-integrations-page.png[Search result for "Endpoint and Cloud Security" on the Integrations page.] diff --git a/docs/getting-started/ml-req.asciidoc b/docs/getting-started/ml-req.asciidoc index f42f61e513..337c00b747 100644 --- a/docs/getting-started/ml-req.asciidoc +++ b/docs/getting-started/ml-req.asciidoc @@ -3,20 +3,7 @@ To run and create {ml} jobs and rules, you need all of these: -* The {subscriptions}[appropriate license] -* There must be at least one {ml} node in your cluster -* The `machine_learning_admin` user role - -For more information, go to {ml-docs}/setup.html[Set up {ml-features}]. - -[IMPORTANT] -==== -The `machine_learning_admin` and `machine_learning_user` built-in roles give -access to the results of _all_ {anomaly-jobs}, irrespective of whether the user -has access to the source indices. Likewise, a user who has full or read-only -access to {ml-features} within a given {kib} space can view the results of _all_ -{anomaly-jobs} that are visible in that space. You must carefully consider who -is given these roles and feature privileges; {anomaly-job} results may propagate -field values that contain sensitive information from the source indices to the -results. -==== \ No newline at end of file +* The *https://www.elastic.co/subscriptions[appropriate license]* +* There must be at least one {ml} node in your cluster (see {ml-docs}/setup.html[Set up {ml} features]) +* The `machine_learning_admin` user role (see +{ref}/built-in-roles.html[Built-in roles]) diff --git a/docs/management/admin/host-isolation-ov.asciidoc b/docs/management/admin/host-isolation-ov.asciidoc index 4fa72555f7..74cda0e1e6 100644 --- a/docs/management/admin/host-isolation-ov.asciidoc +++ b/docs/management/admin/host-isolation-ov.asciidoc @@ -35,7 +35,7 @@ All actions executed on a host are tracked in the host’s activity log, which y To isolate a host from a case alert: -. Go to *Cases*, then select the appropriate case to view the case activity. Ensure you are viewing a case with at least one alert attached to it. +. Go to *Investigate -> Cases*, then select the appropriate case to view the case activity. Ensure you are viewing a case with at least one alert attached to it. . Find the appropriate alert, then click the *Show alert details* button (*>*). The alert details flyout opens. . Click *Take action -> Isolate host*. . Enter a comment describing why you’re isolating the host (optional). @@ -60,7 +60,7 @@ image::images/host-isolated-notif.png[Host isolated notification message,350] To release a host from a case alert: -. Go to *Cases*, then click on the appropriate case to view the case activity its details. +. Go to *Investigate -> Cases*, then click on the appropriate case to view the case activity its details. . Find the appropriate alert, then click the *Show alert details* button (*>*). The alert details flyout opens. . From the alert details flyout, click *Take action -> Release host*. . Enter a comment describing why you're releasing the host (optional).