Skip to content
This repository was archived by the owner on Sep 24, 2019. It is now read-only.

Commit dc909f9

Browse files
mrzarquonmrzarquon
authored
Merge pull request #4 from jdwelch/refactor-readme
Refactor readme
2 parents 820702b + 46de611 commit dc909f9

File tree

3 files changed

+24
-146
lines changed

3 files changed

+24
-146
lines changed

‎.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
*.pyc
2-
tmpdir/
2+
tmpdir/

‎README.md

Lines changed: 22 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -1,162 +1,40 @@
1-
# Splunk App for Puppet Enterprise - Docs
2-
----
3-
- Splunk Add-on Community Supported (Puppet & Splunk Customers)
4-
### - Requirements to Run App
1+
# Splunk App for Puppet Enterprise
2+
3+
The Splunk App for Puppet Enterprise visualizes data from Puppet Enterprise.
4+
5+
## Requirements to run this app
6+
57
- Splunk Enterprise 7.0+
68
- Puppet Enterprise 2018.1.1+
9+
- Splunk Add-on for Puppet Enterprise (Obtain from [Splunkbase](https://splunkbase.splunk.com/app/3610/) or [Github](https://github.com/puppetlabs/SplunkTAforPuppetEnterprise/)) — _This component collects data from Puppet Enterprise and stores it in Splunk._
710

8-
### - Installation Steps
9-
----
10-
- First generate a token from Puppet Enterprise in the shell. Make sure to take into account how long you have the token generated. We recommend to at least set it too 12 Months. We will be putting this in the Add-on Menu to help you alert when it about to expire.
11-
```
12-
curl -k -X POST -H 'Content-Type: application/json' -d '{"login": "", "password": "","lifetime": "9y" }' https://$:4433/rbac-api/v1/auth/token
13-
```
14-
- Custom Factor Pull Setup (Option Step) - Make PR if you want to add a default to the pull.
15-
```
16-
for key, value in temp_one_dict1.iteritems():
17-
temp_one_dict2[key] = value
18-
temp_one_dict2['hostname'] = one_dict['facts']['hostname']
19-
temp_one_dict2['aio_agent_build'] = one_dict['facts']['aio_agent_build]'
20-
```
21-
- Setup Dictonary Key and then Reference back to API to see how you can browse for specific custom field. Reference Link to API: https://puppet.com/docs/puppetdb/5.2/api/query/v4/resources.html
11+
### Installation steps
2212

23-
### - Output of Factors in Json
24-
----
25-
```
26-
aio_agent_build: 5.5.6
27-
aio_agent_version: 5.5.6
28-
architecture: x86_64
29-
authenticated: remote
30-
bios_release_date: 11/29/2017
31-
bios_vendor: Xen
32-
certname: testing1234
33-
clientversion: 5.5.6
34-
domain: null
35-
expiration: 09/11/2018
36-
extensions: { [-]
37-
}
38-
facterversion: 3.11.4
39-
filesystems: xfs
40-
fqdn: testing1234
41-
hostname: testing1234
42-
ipaddress: 10.1.2,0
43-
ipaddress6: fe80::f48a:3947:7787:7775
44-
is_virtual: true
45-
kernel: Linux
46-
kernelmajversion: 3.10
47-
kernelrelease: 3.10.0-693.21.1.el7.x86_64
48-
macaddress: f2:64:33:78:12:24
49-
operatingsystem: CentOS
50-
operatingsystemmajrelease: 7
51-
operatingsystemrelease: 7.4.1708
52-
osfamily: RedHat
53-
pe_server_url_: automate01
54-
platform: x86_64-linux
55-
processorcount: 8
56-
processors: { [-]
57-
count: 8
58-
isa: x86_64
59-
models: [ [-]
60-
Intel(R) Xeon(R) Gold 5115 CPU @ 2.40GHz
61-
Intel(R) Xeon(R) Gold 5115 CPU @ 2.40GHz
62-
Intel(R) Xeon(R) Gold 5115 CPU @ 2.40GHz
63-
Intel(R) Xeon(R) Gold 5115 CPU @ 2.40GHz
64-
Intel(R) Xeon(R) Gold 5115 CPU @ 2.40GHz
65-
Intel(R) Xeon(R) Gold 5115 CPU @ 2.40GHz
66-
Intel(R) Xeon(R) Gold 5115 CPU @ 2.40GHz
67-
Intel(R) Xeon(R) Gold 5115 CPU @ 2.40GHz
68-
]
69-
physicalcount: 4
70-
}
71-
puppetversion: 5.5.6
72-
selinux: true
73-
serialnumber: bc383f9f-c537-9c11-78f1-2274faf798ec
74-
sitedir: /opt/puppetlabs/puppet/lib/ruby/site_ruby/2.4.0
75-
uptime: 116 days
76-
uptime_days: 116
77-
uptime_hours: 2784
78-
uptime_seconds: 10022871
79-
uuid: BC383F9F-C537-9C11-78F1-2274FAF798EC
80-
version: 2.4.4
81-
virtual: xenhvm
82-
```
13+
1. Install and set up the [Add-on](https://github.com/puppetlabs/SplunkTAforPuppetEnterprise/)
14+
1. Install this App into Splunk
8315

84-
### Extended Details Pull Feature Explanation
85-
----
86-
```
87-
certname: testing1234
88-
configuration_version: 1537159231
89-
containing_class: Motd
90-
containment_path: [ [+]
91-
]
92-
corrective_change: false
93-
environment: production
94-
file: /etc/puppetlabs/code/environments/production/modules/motd/manifests/init.pp
95-
line: 84
96-
message: content changed '{md5}91e9830c08a9c585a061401389e48e38' to '{md5}c89ef7290d4031def9b9a4b419ad33a1'
97-
new_value: {md5}c89ef7290d4031def9b9a4b419ad33a1
98-
old_value: {md5}91e9830c08a9c585a061401389e48e38
99-
property: content
100-
report: 6e6b17efc5043981131145fc5593a3dc6602d2cb
101-
report_receive_time: 2018-09-17T04:41:02.934Z
102-
resource_title: /etc/motd
103-
resource_type: File
104-
run_end_time: 2018-09-17T04:41:02.364Z
105-
run_start_time: 2018-09-17T04:40:27.861Z
106-
status: success
107-
timestamp: 2018-09-17T04:40:38.709Z
108-
```
16+
## Version history
10917

110-
- Configuration state in Pull and reference fields are pulled from the following API. Reference Link to API: https://docs.puppet.com/puppetdb/4.0/api/query/v4/reports.html
18+
### Version 2.0
11119

112-
### Todos
113-
----
114-
- Adding Test for TravisCI for Splunk App-Inspect
20+
- Support for Multiple Versions of Puppet Enterprise
21+
- Rewrite of the Factor Pull, Customer Merge Dict Feature to Only Pull certain facts.
22+
- Added PE Metrics for MQ
23+
- Added Compiliation Timing
24+
- Filter for Multiple Version of Puppet Enterprise
25+
- Integration of VictorOps for Notification and Alerting
26+
27+
### Version 1.0
11528

116-
### Version History
117-
----
118-
**Version 1.0**
11929
- Includes Support for Self Signed (8081) + HTTP (8080) for PuppetDB Calls
12030
- Rewrite of all Extraction Fields + Cleanup of Resources, Classes, and CertName
12131
- Fixed API Key Storage
12232
- Fixed Title to Match Pulls
12333
- Fixed Help Text to Match Fields
12434
- Fixed Issue with Memoryleak on Timeout API Calls
12535

126-
**Version 2.0**
127-
- Support for Multiple Version of Puppet Enterprise
128-
- Rewrite of the Factor Pull, Customer Merge Dict Feature to Only Pull certain facts.
129-
- Added PE Metrics for MQ
130-
- Added Compiliation Timing
131-
- Filter for Multiple Version of Puppet Enterprise
132-
- Integration of VictorOps for Notification and Alerting
133-
134-
### License
135-
----
136-
[Splunk Third Party](http://docs.splunk.com/Documentation/AddonBuilder/2.2.0/UserGuide/Validate#Credit_third-party_libraries)
137-
138-
##### MIT License
139-
Copyright (c) [2017] [Splunk]
140-
Permission is hereby granted, free of charge, to any person obtaining a copy
141-
of this software and associated documentation files (the "Software"), to deal
142-
in the Software without restriction, including without limitation the rights
143-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
144-
copies of the Software, and to permit persons to whom the Software is
145-
furnished to do so, subject to the following conditions:
146-
147-
The above copyright notice and this permission notice shall be included in all
148-
copies or substantial portions of the Software.
149-
150-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
151-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
152-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
153-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
154-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
155-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
156-
SOFTWARE.
157-
15836
## Support
159-
----
160-
Are you a Splunk + Puppet customer who enjoys sharing knowledge and want to put some great feature into an opensource project. We encourage you to submit issues and pull request so that we can make this Technical Addon better and help the community as a whole get better insight to their Puppet Enterprise deployments.
37+
38+
Are you a Splunk + Puppet customer who enjoys sharing knowledge and want to put some great features into an open-source project? We encourage you to [submit issues](https://github.com/puppetlabs/SplunkTAforPuppetEnterprise/issues/new) and pull requests so that we can make this app better and help the community as a whole get better insight to their Puppet Enterprise deployments.
16139

16240
Feel free to leave comments or questions. We are here to make this community project more adaptive to all types of use cases.

‎default/app.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ state = enabled
66
build = 3
77

88
[launcher]
9-
author = Domnick Eger
9+
author = Puppet, Inc.
1010
version = 2.0.0
1111

1212
[ui]

0 commit comments

Comments
 (0)