IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elastic Security system requirements Cases prerequisites »
Elastic Docs ›Elastic Security Solution [7.11] ›Get started with Elastic Security ›Elastic Security system requirements

Detections prerequisites and requirements

edit

Detections prerequisites and requirements

edit

To use the Detections feature, you need to configure a few things.

There are a number of step that are only required for self-managed Elastic Stack deployments. If you are using an Elastic Cloud deployment, you only need to configure Enable Detections and Access and use Detections.

Additionally, there are some advanced settings used to configure Kibana value list upload limits.

You need the appropriate license to send notifications when detection alerts are generated.

Configure self-managed Elastic Stack deployments

edit

These steps are only required for self-managed deployments:

  • HTTPS must be configured for communication between Elasticsearch and Kibana.
  • In the elasticsearch.yml configuration file, set the xpack.security.enabled setting to true. For more information, see Configuring Elasticsearch and Security settings in Elasticsearch.

  • In the kibana.yml configuration file, add the xpack.encryptedSavedObjects.encryptionKey setting with any alphanumeric value of at least 32 characters. For example:

    xpack.encryptedSavedObjects.encryptionKey: 'fhjskloppd678ehkdfdlliverpoolfcr'

After changing the xpack.encryptedSavedObjects.encryptionKey value and restarting Kibana, you must restart all detection rules.

Enable Detections

edit

To enable the Detections feature, a user with these privileges must visit (click on) the Detections page:

  • The manage cluster privilege.
  • Kibana space All privileges for the Security feature (see Feature access based on user privileges).

  • The manage, write,read, and view_index_metadata index privileges for all of these system indices:

    • .siem-signals-<kib-space>
    • .lists-<kib-space>

    • .items-<kib-space>

      Where <kib-space> is the Kibana space name.

  • If you want to allow the user to create rules as well as enable the Detections feature, Kibana space All privileges for the Saved Objects Management.

For more information on cluster and index privileges, see Elasticsearch security privileges.

To create a user who can enable Detections in all Kibana spaces, use glob patterns. For example, .siem-signals-*, .lists-*, and .items-*.

Here’s a screenshot of a user role that can enable Detections in all Kibana spaces:

sec admin user

Access and use Detections

edit

After enabling Detections, only users with these permissions can view and use rules and alerts on the Detections page:

All

These permissions are required for both rule and alert management:

  • Kibana space with All privileges enabled for Security.

  • The read, write, view_index_metadata, and maintenance index privileges for all of these system indices:

    • .siem-signals-<kib-space>
    • .lists-<kib-space>

    • .items-<kib-space>

      Where <kib-space> is the Kibana space name.

sec user

Rule

For rule management, make sure Kibana space with All privileges is enabled for both Security and Saved Objects Management features.

Alert

If you only want a user to update the status of alerts but not rule, only Kibana space with All privileges enabled for Security is required.

Configure list upload limits

edit

You can set limits to the number of bytes and the buffer size used to upload values lists to Kibana.

To set the value:

  1. Open kibana.yml configuration file or edit your Kibana cloud instance.

  2. Add any of these settings and their required values:

    • xpack.lists.maxImportPayloadBytes: Sets the number of bytes allowed for uploading Security Solution value lists (default 9000000, maximum 100000000). For every 10 megabytes, it is recommended to have an additional 1 gigabyte of RAM reserved for Kibana.

      For example, on a Kibana instance with 2 gigabytes of RAM, you can set this value up to 20000000 (20 megabytes).

    • xpack.lists.importBufferSize: Sets the buffer size used for uploading Security Solution value lists (default 1000). Change the value if you are experiencing slow upload speeds or larger than wanted memory usage when uploading value lists. Set to a higher value to increase throughput at the expense of using more Kibana memory, or a lower value to decrease throughput and reduce memory usage.

For information on how to configure Elastic Cloud deployments, see Add Kibana user settings.

« Elastic Security system requirements Cases prerequisites »