topbeat Cookbook

This is a Chef cookbook to manage Topbeat.

For Production environment, always prefer the most recent release.

Most Recent Release

cookbook 'topbeat', '~> 0.1.2'

From Git

cookbook 'topbeat', github: 'vkhatri/chef-topbeat'

Repository

https://github.com/vkhatri/chef-topbeat

Supported OS

This cookbook was tested on Amazon & Ubuntu Linux and expected to work on other RHEL platforms and Windows.

Recipes

• topbeat::default - default recipe (use it for run_list)

• topbeat::install - install topbeat for rhel, debian, ubuntu based OS

• topbeat::config - configure topbeat

• topbeat::install_windows - configure topbeat for windows based OS

Core Attributes

• default['topbeat']['version'] (default: 1.2.1): topbeat version

• default['topbeat']['packages'] (default: []): package dependencies

• default['topbeat']['conf_dir'] (default: /etc/topbeat or C:/opt/topbeat/topbeat-1.2.1-windows/): topbeat yaml configuration file directory

• default['topbeat']['conf_file'] (default: /etc/topbeat/topbeat.yml or C:/opt/topbeat/topbeat-1.2.1-windows/topbeat.yml): topbeat configuration file

• default['topbeat']['notify_restart'] (default: true): whether to restart topbeat service on configuration file change

• default['topbeat']['disable_service'] (default: false): whether to stop and disable topbeat service, useful for maintenance mode

Configuration File topbeat.yml Attributes

• default['topbeat']['config']['input']['period'] (default: 10): topbeat statistics collection interval

• default['topbeat']['config']['input']['period'] (default: 10): topbeat procs to collect statistics

• default['topbeat']['config']['output'] (default: {}): topbeat output configuration, e.g. elasticsearch, logstash, file etc.

For more attribute info, visit below link:

https://github.com/elastic/topbeat/blob/master/etc/topbeat.yml

Topbeat YUM/APT Repository Attributes

• default['topbeat']['yum']['description'] (default: ``): beats yum reporitory attribute

• default['topbeat']['yum']['gpgcheck'] (default: true): beats yum reporitory attribute

• default['topbeat']['yum']['enabled'] (default: true): beats yum reporitory attribute

• default['topbeat']['yum']['baseurl'] (default: https://packages.elastic.co/beats/yum/el/$basearch): beatsyum reporitory attribute

• default['topbeat']['yum']['gpgkey'] (default: https://packages.elasticsearch.org/GPG-KEY-elasticsearch): beats yum reporitory attribute

• default['topbeat']['yum']['action'] (default: :create): beats yum reporitory attribute

• default['topbeat']['apt']['description'] (default: calculated): beats apt reporitory attribute

• default['topbeat']['apt']['components'] (default: ['stable', 'main']): beats apt reporitory attribute

• default['topbeat']['apt']['uri'] (default: https://packages.elastic.co/beats/apt): beats apt reporitory attribute

• default['topbeat']['apt']['key'] (default: http://packages.elasticsearch.org/GPG-KEY-elasticsearch): beats apt reporitory attribute

• default['topbeat']['apt']['action'] (default: :add): filebeat apt reporitory attribute

Contributing

1. Fork the repository on Github
2. Create a named feature branch (like add_component_x)
3. Write your change
4. Write tests for your change (if applicable)
5. Run the tests (rake & rake knife), ensuring they all pass
6. Write new resource/attribute description to README.md
7. Write description about changes to PR
8. Submit a Pull Request using Github

Copyright & License

Authors:: Virender Khatri and Contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.