Skip to content

Commit 7770e5e

Browse files
author
Chris Barker
authored
prep for rebase (#11)
1 parent 92eaa7e commit 7770e5e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ The steps to get this addon working are:
1313

1414
Once configured, the overview page will start showing Puppet run report status, and information about changes over various windows of time. The views can be customized, updated, modified to suit your needs.
1515

16-
![Reports Overview](fa6b2c9c-404b-11e9-80ab-0add74b97ee4.png)
16+
![Reports Overview](https://raw.githubusercontent.com/puppetlabs/TA-puppet-report-viewer/master/README/img/overview.png)
1717

1818
For detailed report generation, a feature for Puppet Enterprise Users, there are additional steps one can perform, that first require configuration the AddOn with the appropriate credentials to talk to PuppetDB and to submit events to Splunk:
1919

2020
1. Create puppet:detailed HEC input
21-
2. Create a Splunk [user and role](https://puppet.com/docs/pe/2019.0/rbac_user_roles_intro.html#create-a-new-user-role) in the Puppet Enterprise console, with the permission to "View node data from PuppetDB" under the Nodes Type
22-
3. Configure Puppet Enterprise to support long life [authentication tokens](https://puppet.com/docs/pe/2019.0/rbac_token_auth_intro.html#change-the-token-s-default-lifetime)
23-
4. Generate an authenication token (example command) : `curl -k -X POST -H 'Content-Type: application/json'
21+
2. Create a Splunk [user and role](https://puppet.com/docs/pe/latest/rbac_user_roles_intro.html#create-a-new-user-role) in the Puppet Enterprise console, with the permission to "View node data from PuppetDB" under the Nodes Type
22+
3. Configure Puppet Enterprise to support long life [authentication tokens](https://puppet.com/docs/pe/latest/rbac_token_auth_intro.html#change-the-token-s-default-lifetime)
23+
4. Generate an authentication token (example command) : `curl -k -X POST -H 'Content-Type: application/json'
2424
-d '{"login": "splunk", "password": "password", "lifetime": "1y"}' https://localhost:4433/rbac-api/v1/auth/token`
2525
5. On the configuration page of the addon provide the hostname of the PuppetDB server & auth token, along with the hostname of the Splunk instace running the HEC along with the puppet:detailed HEC token (this is important to use the puppet:detailed token and sourcetype, otherwise it is possible to create an alert action that continually calls itself)
2626
6. With the addon configured, perform a search for a specific event (such as a puppet run with a failed or changed status) `sourcetype="puppet:summary"| spath status | search status=failed` save it as an alert, and assign the action "Generate detailed report" from the action menu. No configuration of the action is needed.
2727

28-
![Addon Configuration Screen](56091b40-404c-11e9-96d2-02083b28dc94.png)
28+
![Addon Configuration Screen](https://raw.githubusercontent.com/puppetlabs/TA-puppet-report-viewer/master/README/img/configuration.png)
2929

30-
![Detailed Reports View](5c8b6a36-404c-11e9-9e9a-02083b28dc94.png)
30+
![Report Builder](https://raw.githubusercontent.com/puppetlabs/TA-puppet-report-viewer/master/README/img/report_builder.png)
3131

3232
More information
3333
----------------

0 commit comments

Comments
 (0)