Configuring Authentication Credentials for Filebeat

When sending data to a secured cluster through the elasticsearch output, Filebeat must either provide basic authentication credentials or present a client certificate.

To configure authentication credentials for Filebeat:

  1. Create a role that has the manage_index_templates and monitor cluster privileges, and read, write, and create_index privileges for the indices that Filebeat creates. You can create roles from the Management / Roles UI in Kibana or through the role API. For example, the following request creates a filebeat_writer role:

    POST _xpack/security/role/filebeat_writer
    {
      "cluster": ["manage_index_templates", "monitor"],
      "indices": [
        {
          "names": [ "filebeat-*" ], 
          "privileges": ["write","create_index"]
        }
      ]
    }

    If you use a custom Filebeat index pattern, specify that pattern instead of the default filebeat-* pattern.

  2. Assign the writer role to the user that Filebeat will use to connect to Elasticsearch:

    1. To authenticate as a native user, create a user for the Filebeat to use internally and assign it the writer role. You can create users from the Management / Users UI in Kibana or through the user API. For example, the following request creates a filebeat_internal user that has the filebeat_writer role:

      POST /_xpack/security/user/filebeat_internal
      {
        "password" : "x-pack-test-password",
        "roles" : [ "filebeat_writer"],
        "full_name" : "Internal Filebeat User"
      }
    2. To authenticate using PKI authentication, assign the writer role to the internal Filebeat user in the role_mapping.yml configuration file. Specify the user by the distinguished name that appears in its certificate.

      filebeat_writer:
        - "cn=Internal Filebeat User,ou=example,o=com"

      For more information, see Using Role Mapping Files.

  3. Configure authentication credentials for the elasticsearch output in the Filebeat configuration file:

    1. To use basic authentication, configure the username and password settings. For example, the following Filebeat output configuration uses the native filebeat_internal user to connect to Elasticsearch:

      output.elasticsearch:
          hosts: ["localhost:9200"]
          index: "filebeat"
          username: "filebeat_internal"
          password: "x-pack-test-password"
    2. To use PKI authentication, configure the certificate and key settings:

      output.elasticsearch:
          hosts: ["localhost:9200"]
          index: "filebeat"
          ssl.certificate: "/etc/pki/client/cert.pem" 
          ssl.key: "/etc/pki/client/cert.key"

      The distinguished name (DN) in the certificate must be mapped to the writer role in the role_mapping.yml configuration file on each node in the Elasticsearch cluster.