Type to search.

Grant privileges and roles needed for setup

Serverless

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Important

Setting up Filebeat 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 Filebeat typically need to load mappings, dashboards, and other objects used to index data into Elasticsearch and visualize it in Kibana.

To grant users the required privileges:

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

    Type Privilege Purpose
    Cluster monitor Retrieve cluster details (e.g. version)
    Cluster manage_ilm Set up and manage index lifecycle management (ILM) policy
    Index manage on filebeat-* indices Load data stream

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

    Note

    These instructions assume that you are using the default name for Filebeat indices. If filebeat-* 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 Filebeat:

    Role Purpose
    kibana_admin Load dependencies, such as example dashboards, if available, into Kibana
    ingest_admin Set up index templates and, if available, ingest pipelines

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