Please note that the original design goal of this role was more concerned with the initial installation and bootstrapping environment, which currently does not involve performing continuous maintenance, and therefore are only suitable for testing and development purposes, should not be used in production environments. The author does not guarantee the accuracy, completeness, reliability, and availability of the role content. Under no circumstances will the author be held responsible or liable in any way for any claims, damages, losses, expenses, costs or liabilities whatsoever, including, without limitation, any direct or indirect damages for loss of profits, business interruption or loss of information.

请注意，此角色的最初设计目标更关注初始安装和引导环境，目前不涉及执行连续维护，因此仅适用于测试和开发目的，不应在生产环境中使用。作者不对角色内容之准确性、完整性、可靠性、可用性做保证。在任何情况下，作者均不对任何索赔，损害，损失，费用，成本或负债承担任何责任，包括但不限于因利润损失，业务中断或信息丢失而造成的任何直接或间接损害。

---

Table of Contents

• Overview
• Requirements
  • Operating systems
  • Beats Versions
• Role variables
  • Main Configuration
  • Other Configuration
• Dependencies
• Example Playbook
  • Hosts inventory file
  • Vars in role configuration
  • Combination of group vars and playbook
• License
• Author Information
• Donations

Overview

The Beats are lightweight data shippers, that you install on your servers to capture all sorts of operational data (think of logs, metrics, or network packet data). The Beats send the operational data to Elasticsearch, either directly or via Logstash, so it can be visualized with Kibana.

Requirements

Operating systems

This Ansible role installs elastic Beats on operating system, including establishing a filesystem structure and server configuration with some common operational features, Will works on the following operating systems:

• CentOS 7

Beats versions

The following list of supported the Beats releases:

• Beats 6.8+, 7.1+

Role variables

Main parameters

There are some variables in defaults/main.yml which can (Or needs to) be overridden:

General parameters

• beats_version: Specify the Beats version.
• beats_dist: Specify the distribution of Beats, oss or basic.
• beats_type: Which kinds of beats are installs.
• beats_dashboard: A boolean to determine whether or not to enable dashboard loading.
• beats_rotate_day: Specify the logs retention days.

Filebeat parameters

• filebeat_configset: Specific configuration set by instances of this.
• filebeat_configver: Specific configuration set versions.

Auditbeat parameters

• auditbeat_audit_rules: Specific audit rules list.

Packetbeat parameters

• packetbeat_flows: Configure flows to monitor network trafficedit.
• packetbeat_ignore_outgoing: Whether ignores all the transactions initiated from the server running Packetbeat.
• packetbeat_protocols: Configure which transaction protocols to monitoredit.

Listen port

• beats_port_arg.http: Port for Beats http.
• beats_port_arg.exporter: Port for prometheus exporter.

Output Variables

• beats_output_type: Configure what output to use when sending the data collected by the Beats.
• beats_output_host: The list of known servers to connect to.
• beats_output_port: Servers communication port.
• beats_output_https: A boolean value, whether Encrypting HTTP client communications.
• beats_output_auth: A boolean value, Enable or Disable authentication.
• beats_output_pass: Authenticated password.
• beats_output_user: Authenticated user.
• beats_kibana_host: The list of kibana endpoints.
• beats_kibana_port: Listening port for Kibana.

Service Mesh

• environments: Define the service environment.
• datacenter: Define the DataCenter.
• domain: Define the Domain.
• customer: Define the customer name.
• tags: Define the service custom label.
• exporter_is_install: Whether to install prometheus exporter.
• consul_public_register: Whether register a exporter service with public consul client.
• consul_public_exporter_token: Public Consul client ACL token.
• consul_public_http_prot: The consul Hypertext Transfer Protocol.
• consul_public_clients: List of public consul clients.
• consul_public_http_port: The consul HTTP API port.

Other parameters

There are some variables in vars/main.yml:

Dependencies

• Ansible versions >= 2.8
• Python >= 2.7.5

Example

Hosts inventory file

See tests/inventory for an example.

node01 ansible_host='192.168.1.10' beats_version='7.10.2'

Vars in role configuration

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

- hosts: all
  roles:
     - role: ansible-role-OS-beats
       beats_version: '7.10.2'

Combination of group vars and playbook

You can also use the group_vars or the host_vars files for setting the variables needed for this role. File you should change: group_vars/all or host_vars/group_name.

beats_version: '7.10.2'
beats_dist: 'basic'
beats_type: 'file'
beats_dashboard: false
beats_rotate_day: '180'
filebeat_configset: 'wazuh'
filebeat_configver: '3'
beats_port_arg:
  http: '5066'
  exporter: '9479'
beats_output_type: 'elasticsearch'
beats_output_host:
  - '127.0.0.1'
beats_output_port: '9200'
beats_output_https: true
beats_output_auth: true
beats_output_pass: 'changeme'
beats_output_user: 'elastic'
beats_kibana_host: '{{ beats_output_host }}'
beats_kibana_port: '5601'
environments: 'prd'
datacenter: 'dc01'
domain: 'local'
customer: 'demo'
tags:
  subscription: 'default'
  owner: 'nobody'
  department: 'Infrastructure'
  organization: 'The Company'
  region: 'IDC01'
exporter_is_install: false
consul_public_register: false
consul_public_exporter_token: '00000000-0000-0000-0000-000000000000'
consul_public_http_port: '8500'
consul_public_http_prot: 'https'
consul_public_clients:
  - '127.0.0.1'

License

Author Information

Please send your suggestions to make this role better.

Donations

Please donate to the following monero address.

46CHVMbb6wQV2PJYEbahb353SYGqXhcdFQVEWdCnHb6JaR5125h3kNQ6bcqLye5G7UF7qz6xL9qHLDSAY3baagfmLZABz75