Skip to content

Commit a0de0e5

Browse files
authored
Merge pull request #216 from coreymbe/MAINT-readme_updates
(MAINT) README Updates
2 parents 3cb9c1a + 3a9e02f commit a0de0e5

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This module provides three services to Puppet and Splunk users.
3131

3232
2. A fact terminus to submit node facts to Splunk. See [Fact Terminus Support](https://github.com/puppetlabs/puppetlabs-splunk_hec/blob/main/docs/fact_terminus_support.md) for details.
3333

34-
3. A PE Event Forwarding processor for sending data received from the [PE Event Forwarding](https://forge.puppet.com/modules/puppetlabs/pe_event_forwarding) module to Splunk. This data can include the details of Task and Plan executions that were initiated by the Puppet Orchestrator (clicking execute task|plan from the console or puppet command line), or it can be events from rbac, the node classifier, the console, or code-manager. To enable this feature, after the PE Event Forwarding module has been installed, set the `events_reporting_enabled` parameter on the `splunk` class to `true`.
34+
3. A PE Event Forwarding processor for sending data received from the [PE Event Forwarding](https://forge.puppet.com/modules/puppetlabs/pe_event_forwarding) module to Splunk. This data can include the details of Task and Plan executions that were initiated by the Puppet Orchestrator (clicking execute task|plan from the console or puppet command line), or it can be events from rbac, the node classifier, the console, or code-manager. To enable this feature, after the PE Event Forwarding module has been configured, set the `events_reporting_enabled` parameter on the `splunk_hec` class to **true**.
3535

3636
**Note**: This is a PE only feature and depends on the [PE Event Forwarding](https://forge.puppet.com/modules/puppetlabs/pe_event_forwarding) module being installed and classified on the Puppet Server nodes in your environment. Please see the documentation in that module for details on how to install and configure that module.
3737

@@ -46,7 +46,7 @@ There are two Tasks included in this module, `splunk_hec:bolt_apply` and `splunk
4646
* Puppet Enterprise (PE) or Open Source Puppet
4747
* Splunk
4848

49-
This was tested on the Puppet Enterprise LTS release, Puppet 6 and Puppet 7, using stock gems of `yaml`, `json`, and `net::https`.
49+
This was tested on the Puppet Enterprise LTS release, Puppet 7 and Puppet 8, using stock gems of `yaml`, `json`, and `net::https`.
5050

5151
* While most of this module is PE and Open Source, using the PE Event Forwarding processor is PE only because it gathers data from API's that exist only in Puppet Enterprise.
5252

@@ -81,7 +81,6 @@ Instructions assume you are using Puppet Enterprise. For Open Source Puppet inst
8181
```
8282
enable_reports = true
8383
manage_routes = true
84-
events_reporting_enabled = true
8584
token = <TOKEN GENERATED IN STEP 2>
8685
url = something like https://splunk-8.splunk.internal:8088/services/collector
8786
```
@@ -273,10 +272,7 @@ This feature can be configured to send these events from non server nodes if nee
273272
274273
### Supported Puppet Versions For Event Forwarding
275274
276-
The puppetlabs-pe_event_forwarding module that this feature depends on is compatible with PE versions in the 2019 range starting at **2019.8.7** and above, and then 2021 versions from **2021.2** and above.
277-
278-
Versions in the PE 2019 series below 2019.8.7 and in the 2021 series in versions below 2021.2 did not recieve an update to some of the API methods in PE that are required for the puppetlabs-pe_event_forwarding module to function properly.
279-
275+
The `puppetlabs-pe_event_forwarding` module that this feature depends on requires PE versions **2021.2** and above to access the API methods for the module to function properly.
280276
281277
## Customized Reporting
282278

0 commit comments

Comments
 (0)