Back to Beats

Grant privileges and roles needed for setup [privileges-to-setup-beats]

docs/reference/heartbeat/privileges-to-setup-beats.md

9.4.01.6 KB
Original Source

Grant privileges and roles needed for setup [privileges-to-setup-beats]

::::{important} Setting up Heartbeat is an admin-level task that requires extra privileges. As a best practice, grant the setup role to administrators only, and use a more restrictive role for event publishing. ::::

Administrators who set up Heartbeat typically need to load mappings, dashboards, and other objects used to index data into {{es}} and visualize it in {{kib}}.

To grant users the required privileges:

  1. Create a setup role, called something like heartbeat_setup, that has the following privileges:

    TypePrivilegePurpose
    ClustermonitorRetrieve cluster details (e.g. version)
    Clustermanage_ilmSet up and manage index lifecycle management (ILM) policy
    Indexmanage on heartbeat-* indicesLoad data stream

    Omit any privileges that aren’t relevant in your environment.

    ::::{note} These instructions assume that you are using the default name for Heartbeat indices. If heartbeat-* is not listed, or you are using a custom name, enter it manually and modify the privileges to match your index naming pattern. ::::

  2. Assign the setup role, along with the following built-in roles, to users who need to set up Heartbeat:

    RolePurpose
    kibana_adminLoad dependencies, such as example dashboards, if available, into {{kib}}
    ingest_adminSet up index templates and, if available, ingest pipelines

    Omit any roles that aren’t relevant in your environment.