IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Functionbeat Reference [7.3] ›Securing Functionbeat ›Configure Functionbeat to use X-Pack security
« Configure Functionbeat to use X-Pack security Configure authentication credentials »

Grant users access to secured resourcesedit

You can use role-based access control to grant users access to secured resources. The roles that you set up depend on your organization’s security requirements and the minimum privileges required to use specific features.

Typically you need the create the following separate roles:

  • setup role for setting up index templates and other dependencies
  • monitoring role for sending monitoring information
  • writer role for publishing events collected by Functionbeat
  • reader role for Kibana users who need to view and create visualizations that access Functionbeat data

X-Pack security provides built-in roles that grant a subset of the privileges needed by Functionbeat users. When possible, use the built-in roles to minimize the affect of future changes on your security strategy.

Grant privileges and roles needed for setupedit

Setting up Functionbeat is an admin-level task that requires extra privileges. As a best practice, grant the setup role to administrators only, and use a less restrictive role for event publishing.

Administrators who set up Functionbeat 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 functionbeat_setup, that has the following privileges:

    Privileges Why needed?

    monitor

    Send monitoring data to the cluster

    manage_ilm

    Set up and manage index lifecycle management (ILM) policy

    manage_ml

    Set up machine learning job configurations

    manage on functionbeat-* indices

    Set up aliases used by ILM

    read on functionbeat-* indices

    Read Functionbeat indices in order to set up machine learning jobs

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

    These instructions assume that you are using the default name for Functionbeat indices. If you are using a custom name, 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 Functionbeat:

    Roles Why needed?

    kibana_user

    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.

Grant privileges and roles needed for monitoringedit

X-Pack security provides built-in users and roles for monitoring. The privileges and roles needed depend on the method used to collect monitoring data.

Internal collectionedit

For internal collection, X-Pack security provides the functionbeat_system built-in user and functionbeat_system built-in role for sending monitoring information. You can use the built-in user, or create a user who has the privileges needed to send monitoring information.

If you use the functionbeat_system user, make sure you set the password.

If you don’t use the functionbeat_system user:

  1. Create a monitoring role, called something like functionbeat_monitoring, that has the following privileges:

    Privileges Why needed?

    monitor

    Send monitoring info

    kibana_user

    Use Kibana

  2. Assign the monitoring role, along with the following built-in role, to users who need to monitor Functionbeat:

    Role Why needed?

    monitoring_user

    Use Stack Monitoring in Kibana to monitor Functionbeat

Grant privileges and roles needed for publishingedit

Users who publish events to Elasticsearch need to create and read from Functionbeat indices. To minimize the privileges required by the writer role, you can use the setup role to pre-load dependencies. Then turn off setup options in the Functionbeat config file before running Functionbeat to publish events. For example:

setup.template.enabled: false
setup.ilm.check_exists: false
setup.ilm.overwrite: false

Omit ilm.check_exists and ilm.overwrite if ILM is disabled.

To grant the required privileges:

  1. Create a writer role, called something like functionbeat_writer, that has the following privileges (this list assumes the setup options shown earlier are set to false):

    Privileges Why needed?

    monitor

    Send monitoring info

    read_ilm

    Read the ILM policy when connecting to clusters that support ILM

    view_index_metadata on functionbeat-* indices

    Check for alias when connecting to clusters that support ILM

    index on functionbeat-* indices

    Index events into Elasticsearch

    create_index on functionbeat-* indices

    Create daily indices when connecting to clusters that do not support ILM

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

  2. Assign the writer role to users who will index events into Elasticsearch.

Grant privileges and roles needed to read Functionbeat dataedit

Kibana users typically need to view dashboards and visualizations that contain Functionbeat data. These users might also need to create and edit dashboards and visualizations.

To grant users the required privileges:

  1. Create a reader role, called something like functionbeat_reader, that has the following privilege:

    Privilege Why needed?

    read on functionbeat-* indices

    Read data indexed by Functionbeat

  2. Assign the reader role, along with the following built-in roles, to users who need to read Functionbeat data:

    Roles Why needed?

    kibana_user or kibana_dashboard_only_user

    Use Kibana. kibana_dashboard_only_user grants read-only access to dashboards.

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

Learn more about users and rolesedit

Want to learn more about creating users and roles? See Securing the Elastic Stack. Also see:

« Configure Functionbeat to use X-Pack security Configure authentication credentials »