add support for features config section (#334)

* add support for features config section * add support for features config section --------- Co-authored-by: Guillaume Nobiron <[email protected]>
pcfens · Sep 11, 2023 · 363adaa · 363adaa
1 parent 4cc5297
commit 363adaa
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -248,19 +248,42 @@ filebeat::setup:
 ```
 
 ## Reference
- - [**Public Classes**](#public-classes)
-    - [Class: filebeat](#class-filebeat)
- - [**Private Classes**](#private-classes)
-    - [Class: filebeat::config](#class-filebeatconfig)
-    - [Class: filebeat::install](#class-filebeatinstall)
-    - [Class: filebeat::params](#class-filebeatparams)
-    - [Class: filebeat::repo](#class-filebeatrepo)
-    - [Class: filebeat::service](#class-filebeatservice)
-    - [Class: filebeat::install::linux](#class-filebeatinstalllinux)
-    - [Class: filebeat::install::windows](#class-filebeatinstallwindows)
- - [**Public Defines**](#public-defines)
-    - [Define: filebeat::input](#define-filebeatinput)
-    - [Define: filebeat::processors](#define-filebeatprocessor)
+- [puppet-filebeat](#puppet-filebeat)
+      - [Table of Contents](#table-of-contents)
+  - [Description](#description)
+  - [Setup](#setup)
+    - [What filebeat affects](#what-filebeat-affects)
+    - [Upgrading to Filebeat 7.x](#upgrading-to-filebeat-7x)
+    - [Setup Requirements](#setup-requirements)
+    - [Beginning with filebeat](#beginning-with-filebeat)
+  - [Usage](#usage)
+    - [Adding an Input](#adding-an-input)
+      - [Multiline Logs](#multiline-logs)
+      - [JSON Logs](#json-logs)
+    - [Inputs in Hiera](#inputs-in-hiera)
+    - [Usage on Windows](#usage-on-windows)
+    - [Processors](#processors)
+      - [Processors in Hiera](#processors-in-hiera)
+    - [Index Lifecycle Management](#index-lifecycle-management)
+  - [Reference](#reference)
+    - [Public Classes](#public-classes)
+      - [Class: `filebeat`](#class-filebeat)
+    - [Private Classes](#private-classes)
+      - [Class: `filebeat::config`](#class-filebeatconfig)
+      - [Class: `filebeat::install`](#class-filebeatinstall)
+      - [Class: `filebeat::params`](#class-filebeatparams)
+      - [Class: `filebeat::repo`](#class-filebeatrepo)
+      - [Class: `filebeat::service`](#class-filebeatservice)
+      - [Class: `filebeat::install::linux`](#class-filebeatinstalllinux)
+      - [Class: `filebeat::install::windows`](#class-filebeatinstallwindows)
+    - [Public Defines](#public-defines)
+      - [Define: `filebeat::input`](#define-filebeatinput)
+  - [Limitations](#limitations)
+    - [Generic template](#generic-template)
+    - [Debian Systems](#debian-systems)
+    - [Using config\_file](#using-config_file)
+    - [Logging on systems with Systemd and with version filebeat 7.0+ installed](#logging-on-systems-with-systemd-and-with-version-filebeat-70-installed)
+  - [Development](#development)
 
 ### Public Classes
 
@@ -297,6 +320,7 @@ Installs and configures filebeat.
 - `enable_conf_modules`: [Boolean] Should filebeat.config.modules be enabled
 - `modules_dir`: [String] The directory where module configurations should be defined (default: /etc/filebeat/modules.d)
 - `cloud`: [Hash] Will be converted to YAML for the optional cloud.id and cloud.auth of the configuration (see documentation, and above)
+- `features`: [Hash] Will be converted to YAML for the optional features section of the configuration (see documentation, and above)
 - `queue`: [Hash] Will be converted to YAML for the optional queue.mem and queue.disk of the configuration (see documentation, and above)
 - `outputs`: [Hash] Will be converted to YAML for the required outputs section of the configuration (see documentation, and above)
 - `shipper`: [Hash] Will be converted to YAML to create the optional shipper section of the filebeat config (see documentation)

diff --git a/manifests/config.pp b/manifests/config.pp
@@ -56,11 +56,19 @@
     })
     # Add the 'xpack' section if supported (version >= 6.1.0) and not undef
     if $filebeat::xpack and versioncmp($filebeat::package_ensure, '6.1.0') >= 0 {
-      $filebeat_config = deep_merge($filebeat_config_temp, { 'xpack' => $filebeat::xpack })
+      $filebeat_config_xpack = deep_merge($filebeat_config_temp, { 'xpack' => $filebeat::xpack })
     }
     else {
-      $filebeat_config = $filebeat_config_temp
+      $filebeat_config_xpack = $filebeat_config_temp
+    }
+    # Add the 'features' section if supported (version >= 8.7.0) and not undef
+    if $filebeat::features and versioncmp($filebeat::package_ensure, '8.7.0') >= 0 {
+      $filebeat_config = deep_merge($filebeat_config_xpack, { 'features' => $filebeat::features })
     }
+    else {
+      $filebeat_config = $filebeat_config_xpack
+    }
+
   } else {
     $filebeat_config_temp = delete_undef_values({
         'shutdown_timeout'  => $filebeat::shutdown_timeout,

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -39,6 +39,7 @@
 # @param modules_dir [String] The directory where module configurations should be defined (default: /etc/filebeat/modules.d)
 # @param http [Hash] A hash of the http section of configuration
 # @param cloud [Hash] Will be converted to YAML for the optional cloud of the configuration (see documentation, and above)
+# @param features [Hash] Will be converted to YAML to create the optional features section of the filebeat config (see documentation)
 # @param queue [Hash] Will be converted to YAML for the optional queue of the configuration (see documentation, and above)
 # @param outputs [Hash] Will be converted to YAML for the required outputs section of the configuration (see documentation, and above)
 # @param shipper [Hash] Will be converted to YAML to create the optional shipper section of the filebeat config (see documentation)
@@ -91,6 +92,7 @@
   Boolean $enable_conf_modules                                        = $filebeat::params::enable_conf_modules,
   Hash    $http                                                       = $filebeat::params::http,
   Hash    $cloud                                                      = $filebeat::params::cloud,
+  Hash    $features                                                   = $filebeat::params::features,
   Hash    $queue                                                      = $filebeat::params::queue,
   Hash    $outputs                                                    = $filebeat::params::outputs,
   Hash    $shipper                                                    = $filebeat::params::shipper,

diff --git a/manifests/params.pp b/manifests/params.pp
@@ -23,6 +23,7 @@
   $ssl                            = {}
   $http                           = {}
   $cloud                          = {}
+  $features                       = {}
   $queue                          = {}
   $outputs                        = {}
   $shipper                        = {}