From cc4e8370297408a112be38821983f1bd42524a34 Mon Sep 17 00:00:00 2001 From: Virender Khatri Date: Mon, 4 Sep 2017 08:39:00 +0530 Subject: [PATCH] update cookbook version to 1.0.0 --- CHANGELOG.md | 35 ++++++++++++++++++++++++++++------- README.md | 50 +++++++++++++++++++++++++++----------------------- metadata.rb | 2 +- 3 files changed, 56 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 024a8cf..a3cde0c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,23 +1,44 @@ filebeat CHANGELOG ================== -This file is used to list changes made in each version of the filebeat cookbook. - 1.0.0 ----- -- Virender Khatri - Added prospectors configuration files purge capability, #73 +- Virender Khatri - LWRP `filebeat_prospector` now creates configuration file with a prefix `lwrp-prospector-#{resource name}`, #73 + +- Virender Khatri - Prospectors via node attribute `node['filebeat']['prospectors']` now uses LWRP `filebeat_prospector` instead of creating JSON file with a prefix `node-prospector-#{prospector name}`, #114 + +- Virender Khatri - Added prospectors configuration files purge capability, #73, #103 * Added new attribute `default['filebeat']['delete_prospectors_dir']` (default: `false`). If set to true, cookbook always delete and re-create prospectors configuration directory + * Added new attribute `default['filebeat']['purge_prospectors_dir']` (default: `false`): If set to true, purge files under prospectors configuration directory, except `lwrp-prospector-` (created by LWRP) + + >>> Note: Set attribute `default['filebeat']['delete_prospectors_dir']` or `default['filebeat']['purge_prospectors_dir']` as per your requirement. + +- Virender Khatri - Dropped support for Chef <12.x, #110 + +- Virender Khatri - No longer activelt test/support Filebeat v1.x, #113 + +- Virender Khatri - Updated Kitchen Tests + * Created Chef 12.x and 13.x tests, #108 + * Use Pinned Travis chef-dk version + * Use stable chef-dk version + * Added Amazon, Debian and, Fedora tests + * Added Filebeat preview release support + * Added Filebeat test cookbook + +- Virender Khatri - Added recent Filebeat prospector option to LWRP filebeat_prospector, #100 + +- Virender Khatri - Updated Filebeat version to v5.5.2 - * Added new attribute `default['filebeat']['purge_prospectors_dir']` (default: `false`): If set to true, purge files under prospectors configuration directory, except `node-prospector-*` (created by node attribute) and `lwrp-prospector-` (created by LWRP) +- Virender Khatri - Added Filebeat Preview (alpha/beta) version support, #112 - * Prospectors LWRP now creates configuration file with a prefix `lwrp-prospector-#{prospector lwrp resoruce name}` +- Virender Khatri - Created separate cookbooks for prospectors and service - * Prospectors via node attribute `node['filebeat']['prospectors']` now creates configuration file with a prefix `node-prospector-#{prospector lwrp resoruce name}` +- Virender Khatri - Updated attributes to use new . convention, issue # +- Virender Khatri - Added apt install option --force-yes, #104 -- Virender Khatri - Updated kitchen to run separate tests for Chef latest 12.x and 13.x versions 0.5.0 ----- diff --git a/README.md b/README.md index 121b9c4..b01ee87 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,14 @@ This is a [Chef] cookbook to manage [Filebeat]. ## Most Recent Release ```ruby -cookbook 'filebeat', '~> 0.5.0' +cookbook 'filebeat', '~> 1.0.0' ``` ## From Git ```ruby -cookbook 'filebeat', github: 'vkhatri/chef-filebeat', tag: 'v0.5.0' +cookbook 'filebeat', github: 'vkhatri/chef-filebeat', tag: 'v1.0.0' ``` @@ -39,19 +39,19 @@ https://github.com/vkhatri/chef-filebeat - Ubuntu - Debian -This also works on Solaris zones given a physical Solaris 11.2 server. For that, use the .kitchen.zone.yml file. Check usage at (https://github.com/criticalmass/kitchen-zone). You will need an url to a filebeat package that works on Solaris 11.2. Checkout Building-Filebeat-On-Solaris11.md for instructions to build a filebeat package. +Also works on Solaris zones given a physical Solaris 11.2 server. For that, use the .kitchen.zone.yml file. Check usage at (https://github.com/criticalmass/kitchen-zone). You will need an url to a filebeat package that works on Solaris 11.2. Checkout Building-Filebeat-On-Solaris11.md for instructions to build a filebeat package. ## Supported Chef -- Chef 12 (last tested on 12.21.3) +- Chef 12 (last tested on 12.21.4) -- Chef 13 (last tested on 13.2.20) +- Chef 13 (last tested on 13.3.42) ## Supported Filebeat -- 1.x (to be deprecated in cookbook version v1.0.0) +- 1.x (dropped test support in cookbook version v1.0.0) - 5.x - 6.x @@ -86,6 +86,10 @@ Refer CHANGELOG.md. - `filebeat::install_windows` - install filebeat for windows platform +- `filebeat::prospectors` - configure filebeat prospectors via node attribute `node['filebeat']['prospectors']` + +- `filebeat::service` - configure filebeat service + ## LWRP filebeat_prospector @@ -113,9 +117,9 @@ end - *paths* (optional, String) - filebeat prospector configuration attribute - *recursive_glob_enabled* (optional, TrueClass/FalseClass) - filebeat prospector configuration attribute - *encoding* (optional, String) - filebeat prospector configuration attribute -- *exclude_lines* (optional, Array) - A list of regular expressions to match the lines that you want Filebeat to exclude. Filebeat drops any lines that match a regular expression in the list. By default, no lines are dropped. -- *include_lines* (optional, Array) - A list of regular expressions to match the lines that you want Filebeat to include. Filebeat exports only the lines that match a regular expression in the list. By default, all lines are exported. -- *exclude_files* (optional, Array) - A list of regular expressions to match the files that you want Filebeat prospector instance to exclude. +- *exclude_lines* (optional, Array) - A list of regular expressions to match the lines that you want filebeat to exclude. Filebeat drops any lines that match a regular expression in the list. By default, no lines are dropped. +- *include_lines* (optional, Array) - A list of regular expressions to match the lines that you want filebeat to include. Filebeat exports only the lines that match a regular expression in the list. By default, all lines are exported. +- *exclude_files* (optional, Array) - A list of regular expressions to match the files that you want filebeat prospector instance to exclude. - *tags* (optional, Array) - filebeat prospector configuration attribute - *fields* (optional, Hash) - filebeat prospector configuration attribute - *fields_under_root* (optional, TrueClass/FalseClass) - filebeat prospector configuration attribute @@ -155,7 +159,7 @@ end - *multiline* (optional, Hash) - Multiline configuration hash. Options: `pattern`: , `negate`: [true/false], `match`: [before/after] -## How to Add Filebeat Output via Node Attribute +## How to Add Filebeat Output Configuration via Node Attribute Filebeat output configuration can be added to attribute `node['filebeat']['config']`. @@ -229,7 +233,7 @@ For more prospector options, check out LWRP `filebeat_prospector` ``` -Above configuration will create three different prospector files - `prospector-system_logs.yml, prospector-secure_logs.yml and prospector-apache_logs.yml` under `node['filebeat']['prospectors_dir']`. +Above configuration will create three different prospector files - `lwrp-prospector-system_logs.yml, lwrp-prospector-secure_logs.yml and lwrp-prospector-apache_logs.yml` under `node['filebeat']['prospectors_dir']`. ## Core Attributes @@ -282,30 +286,30 @@ For more attribute info check `attributes/config.rb`. ## Filebeat YUM/APT Repository Attributes -* `default['filebeat']['yum']['description']` (default: ``): beats yum reporitory attribute +* `default['filebeat']['yum']['description']` (default: ``): beats yum repository attribute -* `default['filebeat']['yum']['gpgcheck']` (default: `true`): beats yum reporitory attribute +* `default['filebeat']['yum']['gpgcheck']` (default: `true`): beats yum repository attribute -* `default['filebeat']['yum']['enabled']` (default: `true`): beats yum reporitory attribute +* `default['filebeat']['yum']['enabled']` (default: `true`): beats yum repository attribute -* `default['filebeat']['yum']['baseurl']` (default: `https://packages.elastic.co/beats/yum/el/$basearch`): beatsyum reporitory attribute +* `default['filebeat']['yum']['baseurl']` (default: `https://packages.elastic.co/beats/yum/el/$basearch`): beatsyum repository attribute -* `default['filebeat']['yum']['gpgkey']` (default: `https://packages.elasticsearch.org/GPG-KEY-elasticsearch`): beats yum reporitory attribute +* `default['filebeat']['yum']['gpgkey']` (default: `https://packages.elasticsearch.org/GPG-KEY-elasticsearch`): beats yum repository attribute -* `default['filebeat']['yum']['metadata_expire']` (default: `3h`): beats yum reporitory attribute +* `default['filebeat']['yum']['metadata_expire']` (default: `3h`): beats yum repository attribute -* `default['filebeat']['yum']['action']` (default: `:create`): beats yum reporitory attribute +* `default['filebeat']['yum']['action']` (default: `:create`): beats yum repository attribute -* `default['filebeat']['apt']['description']` (default: `calculated`): beats apt reporitory attribute +* `default['filebeat']['apt']['description']` (default: `calculated`): beats apt repository attribute -* `default['filebeat']['apt']['components']` (default: `['stable', 'main']`): beats apt reporitory attribute +* `default['filebeat']['apt']['components']` (default: `['stable', 'main']`): beats apt repository attribute -* `default['filebeat']['apt']['uri']` (default: `https://packages.elastic.co/beats/apt`): beats apt reporitory attribute +* `default['filebeat']['apt']['uri']` (default: `https://packages.elastic.co/beats/apt`): beats apt repository attribute -* `default['filebeat']['apt']['key']` (default: `http://packages.elasticsearch.org/GPG-KEY-elasticsearch`): beats apt reporitory attribute +* `default['filebeat']['apt']['key']` (default: `http://packages.elasticsearch.org/GPG-KEY-elasticsearch`): beats apt repository attribute -* `default['filebeat']['apt']['action']` (default: `:add`): filebeat apt reporitory attribute +* `default['filebeat']['apt']['action']` (default: `:add`): filebeat apt repository attribute ## Other Attributes diff --git a/metadata.rb b/metadata.rb index 3fce5df..2ce42db 100644 --- a/metadata.rb +++ b/metadata.rb @@ -4,7 +4,7 @@ license 'Apache-2.0' description 'Installs/Configures Elastic Filebeat' long_description IO.read(File.join(File.dirname(__FILE__), 'README.md')) -version '0.5.0' +version '1.0.0' source_url 'https://github.com/vkhatri/chef-filebeat' if respond_to?(:source_url) issues_url 'https://github.com/vkhatri/chef-filebeat/issues' if respond_to?(:issues_url) chef_version '>= 12' if respond_to?(:chef_version)