From b309557f266416e1bb59034ad6bea08943f46de1 Mon Sep 17 00:00:00 2001 From: Tim Zoellner Date: Tue, 7 Jul 2020 14:44:22 +0200 Subject: [PATCH] update README.md --- CHANGELOG.md | 14 ++++++++------ README.md | 15 +++++++++++++-- metadata.json | 4 ++-- 3 files changed, 23 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d5f94f..d73fcba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,24 +2,26 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). -## [v0.2.4](https://github.com/noris-network/norisnetwork-auditbeat/tree/v0.2.4) (2020-06-07) +## [v0.2.5](https://github.com/noris-network/norisnetwork-auditbeat/tree/v0.2.5) (2020-06-07) -[Full Changelog](https://github.com/noris-network/norisnetwork-auditbeat/compare/v0.2.1...v0.2.4) +[Full Changelog](https://github.com/noris-network/norisnetwork-auditbeat/compare/v0.2.1...v0.2.5) # Added -- added **support for additional configuration keys** -- Puppet version 4 testing removed +- added **update README.md** -## [v0.2.3](https://github.com/noris-network/norisnetwork-auditbeat/tree/v0.2.3) (2020-04-07) +## [v0.2.4](https://github.com/noris-network/norisnetwork-auditbeat/tree/v0.2.4) (2020-06-07) -[Full Changelog](https://github.com/noris-network/norisnetwork-auditbeat/compare/v0.2.1...v0.2.4) +[Full Changelog](https://github.com/noris-network/norisnetwork-auditbeat/compare/v0.2.1...v0.2.5) # Added - added **support for additional configuration keys** - Puppet version 4 testing removed +## [v0.2.3](https://github.com/noris-network/norisnetwork-auditbeat/tree/v0.2.3) (2020-04-07) + +[Full Changelog](https://github.com/noris-network/norisnetwork-auditbeat/compare/v0.2.1...v0.2.3 ## [v0.2.2](https://github.com/noris-network/norisnetwork-auditbeat/tree/v0.2.2) (2020-01-24) diff --git a/README.md b/README.md index be9cc65..f729a0d 100644 --- a/README.md +++ b/README.md @@ -178,6 +178,14 @@ auditbeat::outputs: index: "auditbeat-%%{}{+YYYY.MM.dd}" ``` +## pass additional options to config like "http endpoint metrics" + +``` yaml +auditbeat::additional_config: + http.enabled: true + http.host: 10.0.0.1 +``` + ## Reference * [Public Classes](#public-classes) @@ -215,9 +223,12 @@ Installation and configuration. * `disable_configtest`: [Boolean] whether to check if the configuration file is valid before attempting to run the service (default: true). * `tags`: [Array[Strings]]: the tags to add to each document (default: undef). * `fields`: [Hash] the fields to add to each document (default: undef). -* `xpack`: [Hash] the configuration to export internal metrics to an Elasticsearch monitoring instance (default: undef). +* `xpack`: [Hash] the configuration to export internal metrics to an Elasticsearch monitoring instance (default: undef). +* `monitoring`: [Hash] the configuration to export internal metrics to an Elasticsearch monitoring instance since Version 7.x (default: undef). * `modules`: [Array[Hash]] the required [modules](https://www.elastic.co/guide/en/beats/auditbeat/current/auditbeat-modules.html) to load (default: undef). * `processors`: [Array[Hash]] the optional [processors](https://www.elastic.co/guide/en/beats/auditbeat/current/defining-processors.html) for event enhancement (default: undef). +* `setup`: [Hash] setup the configuration of the setup namespace (kibana, dashboards, template, etc.)(default: undef). +* `additional_config` : [Hash] pass additional options to config like "http endpoint metrics" ### Private Classes @@ -239,7 +250,7 @@ Management of the auditbeat service. ## Limitations -This module does not load the index template in Elasticsearch nor the auditbeat example dashboards in Kibana. These two tasks should be carried out manually. Please follow the documentation to [manually load the index template in Elasticsearch](https://www.elastic.co/guide/en/beats/auditbeat/current/auditbeat-template.html#load-template-manually-alternate) and to [import the auditbeat dashboards in Kibana](https://www.elastic.co/guide/en/beats/devguide/6.2/import-dashboards.html). +This module does not load the index template in Elasticsearch nor the auditbeat example dashboards in Kibana. These two tasks should be carried out manually. Please follow the documentation to [manually load the index template in Elasticsearch](https://www.elastic.co/guide/en/beats/auditbeat/current/auditbeat-template.html#load-template-manually-alternate) and to [import the auditbeat dashboards in Kibana](https://www.elastic.co/guide/en/beats/devguide/7.8/import-dashboards.html). The option `manage_repo` does not remove the repo file, even if set to *false*. Please delete it manually. diff --git a/metadata.json b/metadata.json index af688e6..f72f474 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "norisnetwork-auditbeat", - "version": "0.2.4", + "version": "0.2.5", "author": "norisnetwork", "summary": "Module for installing, managing and configuring the Auditbeat lightweight shipper for audit data by elastic.", "license": "Apache-2.0", @@ -60,7 +60,7 @@ "requirements": [ { "name": "puppet", - "version_requirement": ">= 4.7.0 < 7.0.0" + "version_requirement": ">= 5.0.0 < 7.0.0" } ], "tags": [