cookbook 'topbeat', '~> 0.1.7'
topbeat (6) Versions 0.1.7 Follow4
Installs/Configures Elastic Topbeat
cookbook 'topbeat', '~> 0.1.7', :supermarket
knife supermarket install topbeat
knife supermarket download topbeat
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.7'
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 OStopbeat::config
- configure topbeattopbeat::install_windows
- configure topbeat for windows based OS
Core Attributes
default['topbeat']['version']
(default:1.3.1
): topbeat versiondefault['topbeat']['release']
(default:1
): topbeat release for yum packagedefault['topbeat']['packages']
(default:[]
): package dependenciesdefault['topbeat']['conf_dir']
(default:/etc/topbeat
orC:/opt/topbeat/topbeat-1.2.1-windows/
): topbeat yaml configuration file directorydefault['topbeat']['conf_file']
(default:/etc/topbeat/topbeat.yml
orC:/opt/topbeat/topbeat-1.2.1-windows/topbeat.yml
): topbeat configuration filedefault['topbeat']['notify_restart']
(default:true
): whether to restart topbeat service on configuration file changedefault['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 intervaldefault['topbeat']['config']['input']['period']
(default:10
): topbeat procs to collect statisticsdefault['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 attributedefault['topbeat']['yum']['gpgcheck']
(default:true
): beats yum reporitory attributedefault['topbeat']['yum']['enabled']
(default:true
): beats yum reporitory attributedefault['topbeat']['yum']['baseurl']
(default:https://packages.elastic.co/beats/yum/el/$basearch
): beatsyum reporitory attributedefault['topbeat']['yum']['gpgkey']
(default:https://packages.elasticsearch.org/GPG-KEY-elasticsearch
): beats yum reporitory attributedefault['topbeat']['yum']['action']
(default::create
): beats yum reporitory attributedefault['topbeat']['apt']['description']
(default:calculated
): beats apt reporitory attributedefault['topbeat']['apt']['components']
(default:['stable', 'main']
): beats apt reporitory attributedefault['topbeat']['apt']['uri']
(default:https://packages.elastic.co/beats/apt
): beats apt reporitory attributedefault['topbeat']['apt']['key']
(default:http://packages.elasticsearch.org/GPG-KEY-elasticsearch
): beats apt reporitory attributedefault['topbeat']['apt']['action']
(default::add
): filebeat apt reporitory attribute
Contributing
- Fork the repository on Github
- Create a named feature branch (like
add_component_x
) - Write your change
- Write tests for your change (if applicable)
- Run the tests (
rake & rake knife
), ensuring they all pass - Write new resource/attribute description to
README.md
- Write description about changes to PR
- Submit a Pull Request using Github
Copyright & License
Authors:: Virender Khatri and Contributors
<pre>
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.
</pre>
Dependent cookbooks
yum >= 0.0.0 |
apt >= 0.0.0 |
windows >= 0.0.0 |
yum-plugin-versionlock >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
topbeat CHANGELOG
This file is used to list changes made in each version of the topbeat cookbook.
0.1.7
Virender Khatri - #19, include yum-plugin-versionlock only for rhel
Virender Khatri - updated kitchen spec
Virender Khatri - updated beats version to 1.3.1
Virender Khatri - restart topbeat service on package upgrade
0.1.6
- Virender Khatri - fix for #18, failed to install pinned version on version change
0.1.5
Paul Morton - support version pinning in deb and yum repos
Virender Khatri - updated travis to use ruby v2.2.2
Virender Khatri - remove powershell cookbook dependency
Virender Khatri - updated topbeat version to v1.3.0
Virender Khatri - use cookbook yum-plugin-versionlock instead
0.1.3
Bob - adding support for windows
Bob - add serverpec integration tests for all platforms
Virender Khatri - bump beats version to v1.2.3
0.1.2
- Virender Khatri - Fixed README typo
0.1.1
Jose Alberto - bump version to 1.0.0-rc2 adn new defult config
Virender Khatri - #3, added travis ci
Virender Khatri - #5, update package download url to auto
Virender Khatri - #8, fix kitchen test
Virender Khatri - #4, added specs
Virender Khatri - #9, added source url. issue url, platforms metadata
Virender Khatri - #7, added repository package install
0.1.0
- Virender Khatri - Initial release of topbeat
Check the Markdown Syntax Guide for help with Markdown.
The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.
Collaborator Number Metric
0.1.7 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.1.7 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.1.7 failed this metric
FC066: Ensure chef_version is set in metadata: topbeat/metadata.rb:1
FC069: Ensure standardized license defined in metadata: topbeat/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.1.7 passed this metric
Testing File Metric
0.1.7 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.1.7 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.1.7 failed this metric
0.1.7 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.1.7 failed this metric
FC066: Ensure chef_version is set in metadata: topbeat/metadata.rb:1
FC069: Ensure standardized license defined in metadata: topbeat/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.1.7 passed this metric
Testing File Metric
0.1.7 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.1.7 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.1.7 failed this metric
FC069: Ensure standardized license defined in metadata: topbeat/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
0.1.7 passed this metric
Testing File Metric
0.1.7 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.1.7 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.1.7 failed this metric
0.1.7 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number