70 Commits

Author SHA1 Message Date
corey.hammerton
9334827826 Version bump to 0.1.2 2016-02-09 20:10:28 -05:00
Corey Hammerton
7c44854988 Merge pull request #162 from visibilityspots/master
Examples add to the readme
2016-02-09 19:40:59 -05:00
Corey Hammerton
3844d72bcb Merge pull request #219 from corey-hammerton/issue-218
puppetboard/app: Enabling environment filtering on overview metrics
2016-02-09 19:37:42 -05:00
Corey Hammerton
43ff09fbd4 Merge pull request #217 from corey-hammerton/issue-198
puppetboard/app: Disabling CSRF protection globally.

I still think this is a bad idea but I don't see any other way.
2016-02-09 19:37:18 -05:00
corey.hammerton
0111e52096 puppetboard/app: Enabling environment filtering on overview metrics
This fixes https://github.com/voxpupuli/puppetboard/issues/218

Adding environment filters to only report then number of managed nodes
and resources that are present in the current environment. Still using
the same metrics endpoint information for all environments.
2016-02-08 21:48:49 -05:00
Corey Hammerton
beef893b6a Merge pull request #163 from raphink/colors
Use more standard colors for Puppet run states
2016-02-06 19:02:13 -05:00
Corey Hammerton
7ed551dbe9 Merge pull request #216 from roidelapluie/fix-screenshots
Fix screenshots
2016-02-06 19:00:46 -05:00
corey.hammerton
492e1057e0 puppetboard/app: Disabling CSRF protection globally.
I really did not want to resort to this but I could not find any answers
from previously asked questions on the subject. The template is properly
creating the csrf_token hidden field which is being submitted to the server,
but I could not figure out why it was not using it it.

This fixes https://github.com/voxpupuli/puppetboard/issues/198

This will not be permanent, will have to look into upgrading the flask-wtf
and WTForms packages to the latest versions.
2016-02-06 18:55:45 -05:00
Julien Pivotto
e8bc0ccbb5 Fix screenshots 2016-02-05 16:06:10 +01:00
Corey Hammerton
ddf08b9b75 Merge pull request #215 from nibalizer/rename_vp
"Rename nibalizer to voxpupuli"
2016-02-04 20:05:33 -05:00
Spencer Krum
fbe646f196 Rename nibalizer to voxpupuli 2016-02-03 06:41:37 -08:00
Corey Hammerton
65c6251bac Merge pull request #214 from corey-hammerton/issue-213
templates/index: Directly referencing config.REFRESH_RATE
2016-02-01 20:44:24 -05:00
Corey Hammerton
5874a58965 Merge pull request #212 from corey-hammerton/issue-209
puppetboard/app.py: Don't filter on environments if all are selected
2016-02-01 20:44:16 -05:00
corey.hammerton
f9edda82b4 templates/index: Directly referencing config.REFRESH_RATE
Fixes https://github.com/voxpupuli/puppetboard/issues/213

Also changing the 'if' condition from '!=' to '>' since this application
can only work with unsigned integers
2016-02-01 19:59:24 -05:00
corey.hammerton
8fa0514585 puppetboard/app.py: If all environments are selected do not filter for event counts.
Fixes https://github.com/voxpupuli/puppetboard/issues/209

The event_count queries for the reports in the reports() and reports_node()
functions were always filtering on environments, even if all environments, *,
were selected. This update removes the environment clause from the query
string if 'All Environments' are selected
2016-02-01 19:43:46 -05:00
Corey Hammerton
fd29fe4261 Merge pull request #208 from corey-hammerton/readme
README.rst: Updating documentation with new configuration settings.
2016-02-01 19:25:33 -05:00
corey.hammerton
3ebde245ed requirements.txt: Updating the required version of pypuppetdb
The standard package requirements have a dependency on version 0.2.1
of pypuppetdb, updating the developer requirements list with the same version
2016-02-01 19:23:31 -05:00
Jan Collijs
21fee5b775 Feature: added examples to the readme 2016-01-22 10:11:02 +01:00
Raphaël Pinson
8e4af7c034 Use more standard colors for Puppet run states 2016-01-21 18:20:50 +01:00
Corey Hammerton
370c514745 README.rst: Updating documentation with new configuration settings.
Adding documentation for new configuration settings that have been
added since it was last updated.
2016-01-18 20:56:07 -05:00
Corey Hammerton
de22c61056 Merge pull request #204 from corey-hammerton/pypuppetdb-0.2.1
Using new Node and Catalog fields available in pypuppetdb 0.2.1

With the latest_report_hash field available on the Node object the report_latest can be partially deprecated. Will hopefully be removed in the next major/minor release.
2016-01-18 20:03:55 -05:00
Corey Hammerton
4226fdc368 Merge pull request #203 from corey-hammerton/issue-193
templates/catalog_compare: Switching from basic tables to fixed tables
2016-01-18 20:01:04 -05:00
Corey Hammerton
43e37fdf64 Using new Node and Catalog fields available in pypuppetdb 0.2.1
Showing the Code ID field in the catalogs page. This is currently
unused in PuppetDB as of 3.2.2 but may be useful when it will be used

If available, using the latest_report_hash field of the node object
in the index and nodes templates for the link to the latest report
available for the node.

Updating the report_latest function in app.py to query the nodes
endpoint and redirecting using the latest_report_hash field if available.
If not query the reports endpoint for the node's latest report.
2015-12-28 16:07:43 -05:00
Corey Hammerton
9b8c8332ef templates/catalog_compare: Switching from basic tables to fixed tables
Fixed https://github.com/puppet-community/puppetboard/issues/193

Fixed Semantic UI tables set a fixed position on the applied tables
that do not affect the alignment with narrow browser windows. Downside
of this approach is that users will have to scroll horizontally to view
the entire catalog comparison.
2015-12-28 15:25:59 -05:00
Corey Hammerton
40bd73415d Merge pull request #145 from nibalizer/graphing_facts
"Add clientversion to graphing facts"
2015-12-19 10:12:54 -05:00
Spencer Krum
596e850189 Add clientversion to graphing facts 2015-12-17 10:14:13 -08:00
Corey Hammerton
23b95dc1d2 Merge pull request #189 from corey-hammerton/reload_envs
puppetboard: Reloading the available environments on every page load.
2015-12-14 21:28:03 -05:00
Corey Hammerton
cc9b3de2ec puppetboard/app: Loading the environments in each error_processor function
In the previous commit the environment loading was moving to each request
and that functionality change was not reflected in the error processor
functions (for 4xx and 5xx series errors)
2015-12-14 21:26:09 -05:00
Corey Hammerton
1c7363afa0 Merge pull request #191 from octomike/fix_format_index
fix: wrong index with format()
2015-12-14 21:25:38 -05:00
Spencer Krum
f5ff5b378d Merge pull request #99 from tjayl/auto-refresh
Add auto-refresh on index page
2015-12-05 12:45:25 -08:00
TJayl
177f6c234a Add the auto-refresh to the index page 2015-12-04 13:45:45 +00:00
Michael Krause
8ddec01ca0 fix: wrong index with format() 2015-11-19 14:57:09 +01:00
Corey Hammerton
26d7d43d17 puppetboard: Reloading the available environments on every page load.
Moving the global environment list from a global context to a functional
context because octomike reported that the environment list in his environment
was not being refreshed.

Adding CHANGELOG entries for 0.1.1 and this new change.
2015-11-18 18:34:01 -05:00
Corey Hammerton
f63a0cefcb Merge pull request #185 from raphink/all_envs
Allow to list all nodes again (remove environment filter)

Adding a configurable default environment setting in case some environments to not have a 'production' environment.

Adding a '*' option to remove environment filters.
2015-11-18 18:14:22 -05:00
Corey Hammerton
05f14e3735 Merge pull request #183 from ghakfoort/patch-1
puppetboard/templates/layout: version number updated
2015-11-18 18:13:21 -05:00
Daniele Sluijters
fff45e607a CHANGELOG: dropping PuppetDB 2 support 2015-11-18 17:32:36 +01:00
Daniele Sluijters
2c3ead77d2 README: Add PuppetDB 3 requirement 2015-11-18 17:31:33 +01:00
Raphaël Pinson
b7fdfd8b0d Add All environments to dropdown 2015-11-18 09:25:28 +01:00
Raphaël Pinson
e93db585e1 Add '*' to request all environments 2015-11-18 09:25:25 +01:00
Raphaël Pinson
bfa4d1042e Allow configuration of default environment 2015-11-17 09:32:07 +01:00
ghakfoort
bba5d1dc15 version number updated
the version of puppetboard was updated to 0.1.1 but the version number in this layout file was still 0.1.0.
2015-11-13 11:18:19 +01:00
Corey Hammerton
8b0a797097 puppetboard/setup.py: Version bump 2015-11-12 19:50:28 -05:00
Corey Hammerton
13decf04d5 Merge pull request #182 from corey-hammerton/reports
puppetboard/templates/reports: Passing current_env to the reports_table macro

This fixes https://github.com/puppet-community/puppetboard/issues/181
2015-11-12 19:41:21 -05:00
Corey Hammerton
0fdad9287e puppetboard/templates/reports: Passing the current_env parameter to the reports_table macro
This fixes https://github.com/puppet-community/puppetboard/issues/181
2015-11-11 18:44:12 -05:00
Corey Hammerton
709480a83f Merge pull request #176 from corey-hammerton/0.1.0
puppetboard: Adding PuppetDB 3.x support

Some of the implementations here is:

- Environment Awareness with a dropdown menu to switch environments
- First implementation of pagination in the form of a macro for flexibility
- Use of the PuppetDB 3.x APIs, therefore PuppetDB 2.x compatibility is broken
2015-11-09 20:42:27 -05:00
Corey Hammerton
ba32cdc8a1 Merge pull request #177 from corey-hammerton/footer
puppetboard/templates/layout: Replacing @daenney in the Footer with Puppet Community
2015-11-09 20:37:37 -05:00
Corey Hammerton
cb83144443 Update README.rst
Properly setting the _GoogleGroup macro in the "Getting Help" section
2015-11-09 20:36:17 -05:00
Corey Hammerton
1c72a754d2 puppetboard/templates/layout: Restoring the footer but referencing Puppet Community
@daenney would rather have the footer reference the Puppet Community organization
than completing removing this bar.

Also adding a reference in README.rst about the available Google Group
2015-11-07 20:16:20 -05:00
Corey Hammerton
46439055f8 puppetboard/app: Reducing code redundancy for environment retreival and checking
Moving the envs variable out of the functions scope to the global scope,
this enables each function to reference and use these values.

Adding a new function check_env() to standardize the way to ensure that
the request environment exists, if it doesn't then abort with a 404.

This reduces 16 blocks of code and is in line with @daenney's suggestions
2015-11-07 20:06:48 -05:00
Corey Hammerton
61fc5994fb puppetboard/templates/layout: Removing the footer bar
This bar reduces the available vertical space and other maintainers feel
it better to remove it than to modify it.

Also reducing the specific mention of @daenney from README.rst since he
has steped down as main project maintainer.
2015-11-05 21:37:58 -05:00
Corey Hammerton
b628032c39 Merge branch '0.1.0' of github.com:corey-hammerton/puppetboard into 0.1.0 2015-11-05 21:05:51 -05:00
Corey Hammerton
f2393eabe4 Merge branch 'puppet-community/master' into 0.1.0
Fixing merge conflicts

Conflicts:
	puppetboard/app.py
	puppetboard/forms.py
	puppetboard/templates/catalogs.html
2015-11-05 21:05:31 -05:00
Spencer Krum
6f6bd0585a Merge pull request #161 from corey-hammerton/catalog
puppetboard: Adding a more intuitive catalog view
2015-11-04 17:18:01 -08:00
Corey Hammerton
b04f941e67 Puppetboard/CHANGELOG
Removing the environment switching point in the Known Issues section that has been dealt with.
2015-11-04 20:00:04 -05:00
Corey Hammerton
9486adbd14 puppetboard: Squashed commit of the following:
b4f74e240d
Making catalog tables searchable

7a8ddde6ca
Navbar style/naming simplifications

e8fea997fd
Creating Semantic UI Menu for environment switching instead of select menu
2015-11-03 07:34:30 -05:00
Corey Hammerton
e0866a12ea puppetboard/catalog: Making the catalog tables searchable
Also standardizing the form declarations
2015-10-28 19:54:16 -04:00
Corey Hammerton
7f520af661 Merge pull request #164 from raphink/v4-api
Make Puppetboard work with the PuppetDB V4 api

This PR just enables the basic functionality of PuppetBoard with the new PyPuppetDB version. https://github.com/puppet-community/puppetboard/pull/176 includes this work as well as other work to make better utilization of the new library
2015-10-26 22:11:40 -04:00
Corey Hammerton
af05f67428 puppetboard: Adding PuppetDB 3.x support
Some excerpts from CHANGELOG.rst include:
- Increasing the pypuppetdb requirements from 0.1.x to 0.2.x
- The Reports page now lists reports from the reports endpoint instead of
  a link to a PuppetDB issue with a feature request
- Adding a Catalogs page to view either individual node catalogs or compare
  them against other nodes
- New environment awareness adds a new query parameter to all applicable
  endpoints to filter results based on the current environment. If the
  default environment 'production' is not available, or any other unavailable
  environment, the user is redirected to the first known environment.
- Adding pagination functionality for reports (for now) based on the value of
  the REPORTS_COUNT configuration option (used for the limit and the offset
  calculation). Implementation also makes it possible for other UI enhancements.
- Removing the limit_reports function from puppetboard/utils.py since paging
  parameters are now accepted by the pypuppetdb endpoint functions.
- Bumping the version to 0.1.0
2015-10-26 21:44:33 -04:00
Corey Hammerton
4362f80db6 Merge pull request #170 from rfletcher/skip-color
Make "skips" color consistent
2015-10-26 20:22:24 -04:00
Corey Hammerton
2b5903375e Merge pull request #173 from pyther/master
update query example to use certname

This is just an example text update.
2015-10-26 20:22:00 -04:00
Mickaël Canévet
b539fc9475 Fix dependencies now that pypuppetdb 0.2.0 is released 2015-10-26 13:39:54 +01:00
Raphaël Pinson
6af356a2fd Use pypuppetdb with api version 4 2015-10-26 13:39:54 +01:00
Daniele Sluijters
7e3cf0189b Merge pull request #175 from bastelfreak/update-maintainer
update ArchLinux Package maintainer
2015-10-25 15:37:24 +01:00
Tim Meusel
5142f96b0b update ArchLinux Package maintainer 2015-10-25 12:46:06 +01:00
Matthew Gyurgyik
1aad26a0c8 update query example to use certname 2015-10-23 11:17:02 -04:00
Rick Fletcher
0c5914ff44 Turn down brightness and saturation a bit in the predefined "yellow" 2015-10-13 12:06:08 -04:00
Rick Fletcher
15a9aaaa9f Consistently use yellow for skip stats 2015-10-12 20:20:49 -04:00
Rick Fletcher
f2da1b295a Define a "yellow" 2015-10-12 20:19:00 -04:00
Rick Fletcher
4c13898490 Make "skips" color consistent
"Skips" were highlighted with orange on one page and yellow on another. This change makes them consistent, and switches the color to "black" for accessibility reasons. (The contrast between the shades of orange and red used for skips and errors was *very* low. Indistinguishable on some screens.)
2015-10-12 00:26:16 -04:00
Corey Hammerton
a3473abf61 puppetboard: Adding a more intuitive catalog view
A new endpoint in the header, Catalogs, takes the user to a page with a node
table similar to that in the nodes page. This table shows the node with a
link to the node page, the catalog timestamp with a link to the catalog
page and a small form with a select field to be used to compare the
catalog of this row's node with that of another node.
2015-09-23 11:16:20 -04:00
25 changed files with 1262 additions and 288 deletions

View File

@@ -4,6 +4,69 @@ Changelog
This is the changelog for Puppetboard.
0.1.2
====
* Add configuration option to set the default environment with new
configuration option DEFAULT_ENVIRONMENT, defaults to 'production'.
* Loading all available environments with every page load.
* Adding an "All Environments" item to the Environments dropdown to
remove all environment filters on PuppetDB data.
* Updating README.rst to update links and describe new configuration
options.
* Fixing Query form submission problem by disabling CSRF protection.
Needs to be re-implemented.
* Updating the pypuppetdb requirement to >= 0.2.1, using information
available in PuppetDB 3.2 and higher
** latest_report_hash and latest_report_status fields from the Nodes
endpoint, this effectively deprecates the report_latest() function
** code_id from the Catalogs endpoint (current unused)
* Adding a automatic refresh on the overview page to reload the page
every X number of seconds, defaults to 30. This is configurable
with the configuration option REFRESH_RATE
* Fixing the table alignment in the catalog_compare() page by switching
to fixed tables from basic tables.
* Using colors similar to Puppet Dashboard and Foreman for the status
counts sections
0.1.1
====
* Fix bug where the reports template was not generating the report links
with the right environment
0.1.0
====
* Requires pypuppetdb >= 0.2.0
* Drop support for PuppetDB 2 and earlier
* Full support for PuppetDB 3.x
* The first directory location is now a Puppet environment which is filtered
on all supported queries. Users can browse different environments with a
select field in the top NavBar
* Using limit, order_by and offset parameters adding pagaination on the Reports
page (available in the NavBar). Functionality is available to pages that
accept a page attribute.
* The report page now directly queries pypuppetdb to match the report_id
value with the report hash or configuration_version fields.
* Catching and aborting with a 404 if the report and report_latest function
queries do not return a generator object.
* Adding a Catalogs page (similar to the Nodes page) with a form to compare
one node's catalog information with that of another node.
* Updating the Query Endpoints for the Query page.
* Adding to ``templates/_macros.html`` status_counts that shows node/report
status information, like what is avaiable on the index and nodes pages,
available to the reports pages and tables also.
* Showing report logs and metrics in the report page.
* Removing ``limit_reports`` from ``utils.py`` because this helper function
has been replaced by the limit PuppetDB paging function.
**Known Issues**
* fact_value pages rendered from JSON valued facts return no results. A more
sophisticated API is required to make use of JSON valued facts (through the
factsets, fact-paths and/or fact-contents endpoints for example)
0.0.5
=====

View File

@@ -8,6 +8,8 @@ functionality of `Puppet Dashboard`_.
Puppetboard relies on the `pypuppetdb`_ library to fetch data from PuppetDB
and is built with the help of the `Flask`_ microframework.
As of version 0.1.0 and higher, Puppetboard **requires** PuppetDB 3.
.. _pypuppetdb: https://pypi.python.org/pypi/pypuppetdb
.. _PuppetDB: http://docs.puppetlabs.com/puppetdb/latest/index.html
.. _Puppet Dashboard: http://docs.puppetlabs.com/dashboard/
@@ -17,7 +19,7 @@ At the current time of writing, Puppetboard supports the following Python versio
* Python 2.6
* Python 2.7
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/overview.png
.. image:: screenshots/overview.png
:alt: View of a node
:width: 1024
:height: 700
@@ -51,10 +53,10 @@ There is a `Puppet module`_ by `Spencer Krum`_ that takes care of installing Pup
You can install it with:
puppet module install nibalizer-puppetboard
puppet module install puppet-puppetboard
.. _Spencer Krum: https://github.com/nibalizer
.. _Puppet module: https://forge.puppetlabs.com/nibalizer/puppetboard
.. _Puppet module: https://forge.puppetlabs.com/puppet/puppetboard
Manual
^^^^^^
@@ -69,7 +71,7 @@ This will install Puppetboard and take care of the dependencies. If you
do this Puppetboard will be installed in the so called site-packages or
dist-packages of your Python distribution.
The complete path on Debian and Ubuntu systems would be ``/usr/local/lib/pythonX.Y/lib/dist-packages/puppetboard`` and on Fedora would be ``/usr/lib/pythonX.Y/lib/site-packages/puppetboard``
The complete path on Debian and Ubuntu systems would be ``/usr/local/lib/pythonX.Y/lib/dist-packages/puppetboard`` and on Fedora would be ``/usr/lib/pythonX.Y/site-packages/puppetboard``
where X and Y are replaced by your major and minor python versions.
@@ -99,13 +101,13 @@ Native packages for your operating system will be provided in the near future.
+-------------------+-----------+--------------------------------------------+
| `SuSE LE 11 SP3`_ | available | Maintained on `OpenSuSE Build Service`_ |
+-------------------+-----------+--------------------------------------------+
| `ArchLinux`_ | available | Maintained by `Niels Abspoel`_ |
| `ArchLinux`_ | available | Maintained by `Tim Meusel`_ |
+-------------------+-----------+--------------------------------------------+
| `OpenBSD`_ | available | Maintained by `Jasper Lievisse Adriaanse`_ |
+-------------------+-----------+--------------------------------------------+
.. _ArchLinux: https://aur.archlinux.org/packages/python2-puppetboard/
.. _Niels Abspoel: https://github.com/aboe76
.. _Tim Meusel: https://github.com/bastelfreak
.. _Jasper Lievisse Adriaanse: https://github.com/jasperla
.. _OpenBSD: http://www.openbsd.org/cgi-bin/cvsweb/ports/www/puppetboard/
.. _OpenSuSE Build Service: https://build.opensuse.org/package/show/systemsmanagement:puppet/python-puppetboard
@@ -172,10 +174,11 @@ connect. Therefor you'll also have to supply the following settings:
For information about how to generate the correct keys please refer to the
`pypuppetdb documentation`_.
Other settings that might be interesting:
Other settings that might be interesting in no particular order:
* ``SECRET_KEY``: Refer to `Flask documentation`_, section sessions: How to
generate good secret keys, to set the value.
generate good secret keys, to set the value. Defaults to a random 24-char
string generated by os.random(24)
* ``PUPPETDB_TIMEOUT``: Defaults to 20 seconds but you might need to increase
this value. It depends on how big the results are when querying PuppetDB.
This behaviour will change in a future release when pagination will be
@@ -188,6 +191,25 @@ Other settings that might be interesting:
* ``ENABLE_QUERY``: Defaults to ``True`` causing a Query tab to show up in the
web interface allowing users to write and execute arbitrary queries against
a set of endpoints in PuppetDB. Change this to ``False`` to disable this.
* ``GRAPH_FACTS``: A list of fact names to tell PuppetBoard to generate a
pie-chart on the fact page. With some fact values being unique per node,
like ipaddress, uuid, and serial number, as well as structured facts it was
no longer feasible to generate a graph for everything.
* ``INVENTORY_FACTS``: A list of tuples that serve as the column header and
the fact name to search for to create the inventory page. If a fact is not
found for a node then ``undef`` is printed.
* ``ENABLE_CATALOG``: If set to ``True`` allows the user to view a node's
latest catalog. This includes all managed resources, their file-system
locations and their relationships, if available. Defaults to ``False``.
* ``REFRESH_RATE``: Defaults to ``30`` the number of seconds to wait until
the index page is automatically refreshed.
* ``DEFAULT_ENVIRONMENT``: Defaults to ``'production'``, as the name
suggests, load all information filtered by this environment value.
* ``REPORTS_COUNT``: Defaults to ``10`` the limit of the number of reports
to load on the node or any reports page.
* ``OFFLINE_MODE``: If set to ``True`` load static assets (jquery,
semantic-ui, tablesorter, etc) from the local web server instead of a CDN.
Defaults to ``False``.
.. _pypuppetdb documentation: http://pypuppetdb.readthedocs.org/en/v0.1.0/quickstart.html#ssl
.. _Flask documentation: http://flask.pocoo.org/docs/0.10/quickstart/#sessions
@@ -238,7 +260,7 @@ First we need to create the necessary directories:
.. code-block:: bash
$ mkdir -p /var/www/puppetboard
$ mkdir -p /var/www/html/puppetboard
Copy Puppetboard's ``default_settings.py`` to the newly created puppetboard
directory and name the file ``settings.py``. This file will be available
@@ -260,7 +282,7 @@ puppetboard directory:
import os
# Needed if a settings.py file exists
os.environ['PUPPETBOARD_SETTINGS'] = '/var/www/puppetboard/settings.py'
os.environ['PUPPETBOARD_SETTINGS'] = '/var/www/html/puppetboard/settings.py'
from puppetboard.app import app as application
Make sure this file is readable by the user the webserver runs as.
@@ -274,7 +296,7 @@ Here is a sample configuration for Debian and Ubuntu:
<VirtualHost *:80>
ServerName puppetboard.example.tld
WSGIDaemonProcess puppetboard user=www-data group=www-data threads=5
WSGIScriptAlias / /var/www/puppetboard/wsgi.py
WSGIScriptAlias / /var/www/html/puppetboard/wsgi.py
ErrorLog /var/log/apache2/puppetboard.error.log
CustomLog /var/log/apache2/puppetboard.access.log combined
@@ -299,11 +321,11 @@ Here is a sample configuration for Fedora:
<VirtualHost *:80>
ServerName puppetboard.example.tld
WSGIDaemonProcess puppetboard user=apache group=apache threads=5
WSGIScriptAlias / /var/www/puppetboard/wsgi.py
ErrorLog /var/log/httpd/puppetboard.error.log
CustomLog /var/log/httpd/puppetboard.access.log combined
WSGIScriptAlias / /var/www/html/puppetboard/wsgi.py
ErrorLog logs/puppetboard-error_log
CustomLog logs/puppetboard-access_log combined
Alias /static /usr/local/lib/pythonX.Y/site-packages/puppetboard/static
Alias /static /usr/lib/pythonX.Y/site-packages/puppetboard/static
<Directory /usr/lib/python2.X/site-packages/puppetboard/static>
Satisfy Any
Allow from all
@@ -587,16 +609,19 @@ This project is still very new so it's not inconceivable you'll run into
issues.
For bug reports you can file an `issue`_. If you need help with something
feel free to hit up `@daenney`_ by e-mail or find him on IRC. He can usually
be found on `IRCnet`_ and `Freenode`_ and idles in #puppet.
feel free to hit up the maintainers by e-mail or on IRC. They can usually
be found on `IRCnet`_ and `Freenode`_ and idles in #puppetboard.
There's now also the #puppetboard channel on `Freenode`_ where we hang out
and answer questions related to pypuppetdb and Puppetboard.
.. _issue: https://github.com/nedap/puppetboard/issues
.. _@daenney: https://github.com/daenney
There is also a `GoogleGroup`_ to exchange questions and discussions. Please
note that this group contains discussions of other Puppet Community projects.
.. _issue: https://github.com/puppet-community/puppetboard/issues
.. _IRCnet: http://www.ircnet.org
.. _Freenode: http://freenode.net
.. _GoogleGroup: https://groups.google.com/forum/?hl=en#!forum/puppet-community
Third party
===========
@@ -649,70 +674,79 @@ messages have a look at this post by `Tim Pope`_.
.. _Tim Pope: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
Examples
========
`vagrant-puppetboard`_
.. _vagrant-puppetboard: https://github.com/visibilityspots/vagrant-puppet/tree/puppetboard
A vagrant project to show off the puppetboard functionallity using the puppetboard puppet module on a puppetserver with puppetdb.
Screenshots
===========
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/overview.png
.. image:: screenshots/overview.png
:alt: Overview / Index / Homepage
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/nodes.png
.. image:: screenshots/nodes.png
:alt: Nodes view, all active nodes
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/node.png
.. image:: screenshots/node.png
:alt: Single node page / overview
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/report.png
.. image:: screenshots/report.png
:alt: Report view
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/facts.png
.. image:: screenshots/facts.png
:alt: Facts view
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/fact.png
.. image:: screenshots/fact.png
:alt: Single fact, with graphs
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/fact_value.png
.. image:: screenshots/fact_value.png
:alt: All nodes that have this fact with that value
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/metrics.png
.. image:: screenshots/metrics.png
:alt: Metrics view
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/metric.png
.. image:: screenshots/metric.png
:alt: Single metric
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/query.png
.. image:: screenshots/query.png
:alt: Query view
:width: 1024
:height: 700
:align: center
.. image:: https://raw.github.com/nedap/puppetboard/master/screenshots/broken.png
.. image:: screenshots/broken.png
:alt: Error page
:width: 1024
:height: 700

View File

@@ -8,25 +8,24 @@ try:
except ImportError:
from urllib.parse import unquote
from datetime import datetime
from itertools import tee
from flask import (
Flask, render_template, abort, url_for,
Response, stream_with_context, redirect,
request
)
from flask_wtf.csrf import CsrfProtect
from pypuppetdb import connect
from puppetboard.forms import QueryForm
from puppetboard.forms import (CatalogForm, QueryForm)
from puppetboard.utils import (
get_or_abort, yield_or_stop,
limit_reports, jsonprint
jsonprint, Pagination
)
app = Flask(__name__)
CsrfProtect(app)
app.config.from_object('puppetboard.default_settings')
graph_facts = app.config['GRAPH_FACTS']
@@ -37,7 +36,6 @@ app.secret_key = app.config['SECRET_KEY']
app.jinja_env.filters['jsonprint'] = jsonprint
puppetdb = connect(
api_version=3,
host=app.config['PUPPETDB_HOST'],
port=app.config['PUPPETDB_PORT'],
ssl_verify=app.config['PUPPETDB_SSL_VERIFY'],
@@ -59,6 +57,31 @@ def stream_template(template_name, **context):
rv.enable_buffering(5)
return rv
def url_for_pagination(page):
args = request.view_args.copy()
args['page'] = page
return url_for(request.endpoint, **args)
def url_for_environments(env):
args = request.view_args.copy()
args['env'] = env
return url_for(request.endpoint, **args)
def environments():
envs = get_or_abort(puppetdb.environments)
x = []
for env in envs:
x.append(env['name'])
return x
def check_env(env, envs):
if env != '*' and env not in envs:
abort(404)
app.jinja_env.globals['url_for_pagination'] = url_for_pagination
app.jinja_env.globals['url_for_environments'] = url_for_environments
@app.context_processor
def utility_processor():
@@ -70,39 +93,56 @@ def utility_processor():
@app.errorhandler(400)
def bad_request(e):
return render_template('400.html'), 400
envs = environments()
return render_template('400.html', envs=envs), 400
@app.errorhandler(403)
def forbidden(e):
return render_template('403.html'), 400
envs = environments()
return render_template('403.html', envs=envs), 400
@app.errorhandler(404)
def not_found(e):
return render_template('404.html'), 404
envs = environments()
return render_template('404.html', envs=envs), 404
@app.errorhandler(412)
def precond_failed(e):
"""We're slightly abusing 412 to handle missing features
depending on the API version."""
return render_template('412.html'), 412
envs = environments()
return render_template('412.html', envs=envs), 412
@app.errorhandler(500)
def server_error(e):
return render_template('500.html'), 500
envs = environments()
return render_template('500.html', envs=envs), 500
@app.route('/')
def index():
@app.route('/', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/')
def index(env):
"""This view generates the index page and displays a set of metrics and
latest reports on nodes fetched from PuppetDB.
:param env: Search for nodes in this (Catalog and Fact) environment
:type env: :obj:`string`
"""
# TODO: Would be great if we could parallelize this somehow, doing these
# requests in sequence is rather pointless.
prefix = 'com.puppetlabs.puppetdb.query.population'
envs = environments()
metrics = {
'num_nodes': 0,
'num_resources': 0,
'avg_resources_node': 0}
check_env(env, envs)
if env == '*':
query = None
prefix = 'puppetlabs.puppetdb.query.population'
num_nodes = get_or_abort(
puppetdb.metric,
"{0}{1}".format(prefix, ':type=default,name=num-nodes'))
@@ -112,13 +152,33 @@ def index():
avg_resources_node = get_or_abort(
puppetdb.metric,
"{0}{1}".format(prefix, ':type=default,name=avg-resources-per-node'))
metrics = {
'num_nodes': num_nodes['Value'],
'num_resources': num_resources['Value'],
'avg_resources_node': "{0:10.0f}".format(avg_resources_node['Value']),
}
metrics['num_nodes'] = num_nodes['Value']
metrics['num_resources'] = num_resources['Value']
metrics['avg_resources_node'] = "{0:10.0f}".format(
avg_resources_node['Value'])
else:
query = '["and", {0}]'.format(
", ".join('["=", "{0}", "{1}"]'.format(field, env)
for field in ['catalog_environment', 'facts_environment']))
num_nodes = get_or_abort(
puppetdb._query,
'nodes',
query='["extract", [["function", "count"]],["and", {0}]]'.format(
",".join('["=", "{0}", "{1}"]'.format(field, env)
for field in ['catalog_environment', 'facts_environment'])))
num_resources = get_or_abort(
puppetdb._query,
'resources',
query='["extract", [["function", "count"]],' \
'["=", "environment", "{0}"]]'.format(
env))
metrics['num_nodes'] = num_nodes[0]['count']
metrics['num_resources'] = num_resources[0]['count']
metrics['avg_resources_node'] = "{0:10.0f}".format(
(num_resources[0]['count'] / num_nodes[0]['count']))
nodes = puppetdb.nodes(
nodes = get_or_abort(puppetdb.nodes,
query=query,
unreported=app.config['UNRESPONSIVE_HOURS'],
with_status=True)
@@ -150,12 +210,15 @@ def index():
'index.html',
metrics=metrics,
nodes=nodes_overview,
stats=stats
stats=stats,
envs=envs,
current_env=env
)
@app.route('/nodes')
def nodes():
@app.route('/nodes', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/nodes')
def nodes(env):
"""Fetch all (active) nodes from PuppetDB and stream a table displaying
those nodes.
@@ -164,9 +227,23 @@ def nodes():
we'll end up with an empty table instead because of how yield_or_stop
works. Once pagination is in place we can change this but we'll need to
provide a search feature instead.
:param env: Search for nodes in this (Catalog and Fact) environment
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
if env == '*':
query = None
else:
query = '["and", {0}]'.format(
", ".join('["=", "{0}", "{1}"]'.format(field, env)
for field in ['catalog_environment', 'facts_environment'])),
status_arg = request.args.get('status', '')
nodelist = puppetdb.nodes(
query=query,
unreported=app.config['UNRESPONSIVE_HOURS'],
with_status=True)
nodes = []
@@ -177,11 +254,15 @@ def nodes():
else:
nodes.append(node)
return Response(stream_with_context(
stream_template('nodes.html', nodes=nodes)))
stream_template('nodes.html',
nodes=nodes,
envs=envs,
current_env=env)))
@app.route('/inventory')
def inventory():
@app.route('/inventory', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/inventory')
def inventory(env):
"""Fetch all (active) nodes from PuppetDB and stream a table displaying
those nodes along with a set of facts about them.
@@ -190,7 +271,12 @@ def inventory():
we'll end up with an empty table instead because of how yield_or_stop
works. Once pagination is in place we can change this but we'll need to
provide a search feature instead.
:param env: Search for facts in this environment
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
fact_desc = [] # a list of fact descriptions to go
# in the table header
@@ -217,7 +303,13 @@ def inventory():
fact_desc.append(description)
fact_names.append(name)
query = '["or", {0}]'.format(
if env == '*':
query = '["or", {0}]]'.format(
', '.join('["=", "name", "{0}"]'.format(name)
for name in fact_names))
else:
query = '["and", ["=", "environment", "{0}"], ["or", {1}]]'.format(
env,
', '.join('["=", "name", "{0}"]'.format(name)
for name in fact_names))
@@ -239,92 +331,322 @@ def inventory():
nodedata[node].append("undef")
return Response(stream_with_context(
stream_template('inventory.html', nodedata=nodedata, fact_desc=fact_desc)))
stream_template('inventory.html',
nodedata=nodedata,
fact_desc=fact_desc,
envs=envs,
current_env=env)))
@app.route('/node/<node_name>')
def node(node_name):
@app.route('/node/<node_name>', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/node/<node_name>')
def node(env, node_name):
"""Display a dashboard for a node showing as much data as we have on that
node. This includes facts and reports but not Resources as that is too
heavy to do within a single request.
:param env: Ensure that the node, facts and reports are in this environment
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
if env == '*':
query = '["=", "certname", "{0}"]]'.format(node_name)
else:
query='["and", ["=", "environment", "{0}"],' \
'["=", "certname", "{1}"]]'.format(env, node_name),
node = get_or_abort(puppetdb.node, node_name)
facts = node.facts()
reports = limit_reports(node.reports(), app.config['REPORTS_COUNT'])
reports = get_or_abort(puppetdb.reports,
query=query,
limit=app.config['REPORTS_COUNT'],
order_by='[{"field": "start_time", "order": "desc"}]')
reports, reports_events = tee(reports)
report_event_counts = {}
for report in reports_events:
counts = get_or_abort(puppetdb.event_counts,
query='["and", ["=", "environment", "{0}"],' \
'["=", "certname", "{1}"], ["=", "report", "{2}"]]'.format(
env,
node_name,
report.hash_),
summarize_by="certname")
try:
report_event_counts[report.hash_] = counts[0]
except IndexError:
report_event_counts[report.hash_] = {}
return render_template(
'node.html',
node=node,
facts=yield_or_stop(facts),
reports=yield_or_stop(reports),
reports_count=app.config['REPORTS_COUNT'])
reports_count=app.config['REPORTS_COUNT'],
report_event_counts=report_event_counts,
envs=envs,
current_env=env)
@app.route('/reports')
def reports():
"""Doesn't do much yet but is meant to show something like the reports of
the last half our, something like that."""
return render_template('reports.html')
@app.route('/reports/', defaults={'env': app.config['DEFAULT_ENVIRONMENT'], 'page': 1})
@app.route('/<env>/reports/', defaults={'page': 1})
@app.route('/<env>/reports/page/<int:page>')
def reports(env, page):
"""Displays a list of reports and status from all nodes, retreived using the
reports endpoint, sorted by start_time.
@app.route('/reports/<node_name>')
def reports_node(node_name):
"""Fetches all reports for a node and processes them eventually rendering
a table displaying those reports."""
reports = limit_reports(
yield_or_stop(
puppetdb.reports('["=", "certname", "{0}"]'.format(node_name))),
app.config['REPORTS_COUNT'])
return render_template(
'reports_node.html',
reports=reports,
nodename=node_name,
reports_count=app.config['REPORTS_COUNT'])
@app.route('/report/latest/<node_name>')
def report_latest(node_name):
"""Redirect to the latest report of a given node. This is a workaround
as long as PuppetDB can't filter reports for latest-report? field. This
feature has been requested: https://tickets.puppetlabs.com/browse/PDB-203
:param env: Search for all reports in this environment
:type env: :obj:`string`
:param page: Calculates the offset of the query based on the report count
and this value
:type page: :obj:`int`
"""
reports = get_or_abort(puppetdb._query, 'reports',
query='["=","certname","{0}"]'.format(node_name),
limit=1)
if len(reports) > 0:
report = reports[0]['hash']
return redirect(
url_for('report', node_name=node_name, report_id=report))
envs = environments()
check_env(env, envs)
if env == '*':
reports_query = None
total_query = '["extract", [["function", "count"]], ["~", "certname", ""]]'
else:
reports_query = '["=", "environment", "{0}"]'.format(env)
total_query = '["extract", [["function", "count"]],'\
'["and", ["=", "environment", "{0}"]]]'.format(env)
reports = get_or_abort(puppetdb.reports,
query=reports_query,
limit=app.config['REPORTS_COUNT'],
offset=(page-1) * app.config['REPORTS_COUNT'],
order_by='[{"field": "start_time", "order": "desc"}]')
total = get_or_abort(puppetdb._query,
'reports',
query=total_query)
total = total[0]['count']
reports, reports_events = tee(reports)
report_event_counts = {}
if total == 0 and page != 1:
abort(404)
for report in reports_events:
if env == '*':
event_count_query = '["and",' \
'["=", "certname", "{0}"],' \
'["=", "report", "{1}"]]'.format(
report.node,
report.hash_)
else:
event_count_query = '["and",' \
'["=", "environment", "{0}"],' \
'["=", "certname", "{1}"],' \
'["=", "report", "{2}"]]'.format(
env,
report.node,
report.hash_)
counts = get_or_abort(puppetdb.event_counts,
query=event_count_query,
summarize_by="certname")
try:
report_event_counts[report.hash_] = counts[0]
except IndexError:
report_event_counts[report.hash_] = {}
return Response(stream_with_context(stream_template(
'reports.html',
reports=yield_or_stop(reports),
reports_count=app.config['REPORTS_COUNT'],
report_event_counts=report_event_counts,
pagination=Pagination(page, app.config['REPORTS_COUNT'], total),
envs=envs,
current_env=env)))
@app.route('/report/<node_name>/<report_id>')
def report(node_name, report_id):
@app.route('/reports/<node_name>/', defaults={'env': app.config['DEFAULT_ENVIRONMENT'], 'page': 1})
@app.route('/<env>/reports/<node_name>', defaults={'page': 1})
@app.route('/<env>/reports/<node_name>/page/<int:page>')
def reports_node(env, node_name, page):
"""Fetches all reports for a node and processes them eventually rendering
a table displaying those reports.
:param env: Search for reports in this environment
:type env: :obj:`string`
:param node_name: Find the reports whose certname match this value
:type node_name: :obj:`string`
:param page: Calculates the offset of the query based on the report count
and this value
:type page: :obj:`int`
"""
envs = environments()
check_env(env, envs)
if env == '*':
query = '["=", "certname", "{0}"]]'.format(node_name)
else:
query='["and",' \
'["=", "environment", "{0}"],' \
'["=", "certname", "{1}"]]'.format(env, node_name),
reports = get_or_abort(puppetdb.reports,
query=query,
limit=app.config['REPORTS_COUNT'],
offset=(page-1) * app.config['REPORTS_COUNT'],
order_by='[{"field": "start_time", "order": "desc"}]')
total = get_or_abort(puppetdb._query,
'reports',
query='["extract", [["function", "count"]],' \
'["and", ["=", "environment", "{0}"], ["=", "certname", "{1}"]]]'.format(
env,
node_name))
total = total[0]['count']
reports, reports_events = tee(reports)
report_event_counts = {}
if total == 0 and page != 1:
abort(404)
for report in reports_events:
if env == '*':
event_count_query = '["and",' \
'["=", "certname", "{0}"],' \
'["=", "report", "{1}"]]'.format(
report.node,
report.hash_)
else:
event_count_query = '["and",' \
'["=", "environment", "{0}"],' \
'["=", "certname", "{1}"],' \
'["=", "report", "{2}"]]'.format(
env,
report.node,
report.hash_)
counts = get_or_abort(puppetdb.event_counts,
query=event_count_query,
summarize_by="certname")
try:
report_event_counts[report.hash_] = counts[0]
except IndexError:
report_event_counts[report.hash_] = {}
return render_template(
'reports.html',
reports=reports,
reports_count=app.config['REPORTS_COUNT'],
report_event_counts=report_event_counts,
pagination=Pagination(page, app.config['REPORTS_COUNT'], total),
envs=envs,
current_env=env)
@app.route('/report/latest/<node_name>', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/report/latest/<node_name>')
def report_latest(env, node_name):
"""Redirect to the latest report of a given node.
:param env: Search for reports in this environment
:type env: :obj:`string`
:param node_name: Find the reports whose certname match this value
:type node_name: :obj:`string`
"""
envs = environments()
check_env(env, envs)
if env == '*':
node_query = '["=", "certname", "{0}"]'.format(node_name)
else:
node_query = '["and",' \
'["=", "report_environment", "{0}"],' \
'["=", "certname", "{1}"]]'.format(env, node_name)
try:
node = next(get_or_abort(puppetdb.nodes,
query=node_query,
with_status=True))
except StopIteration:
abort(404)
if node.latest_report_hash is not None:
hash_ = node.latest_report_hash
else:
if env == '*':
query='["and",' \
'["=", "certname", "{0}"],' \
'["=", "latest_report?", true]]'.format(node.name)
else:
query='["and",' \
'["=", "environment", "{0}"],' \
'["=", "certname", "{1}"],' \
'["=", "latest_report?", true]]'.format(
env,
node.name)
reports = get_or_abort(puppetdb.reports, query=query)
try:
report = next(reports)
hash_ = report.hash_
except StopIteration:
abort(404)
return redirect(
url_for('report', env=env, node_name=node_name, report_id=hash_))
@app.route('/report/<node_name>/<report_id>', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/report/<node_name>/<report_id>')
def report(env, node_name, report_id):
"""Displays a single report including all the events associated with that
report and their status.
The report_id may be the puppetdb's report hash or the
configuration_version. This allows for better integration
into puppet-hipchat.
"""
reports = puppetdb.reports('["=", "certname", "{0}"]'.format(node_name))
for report in reports:
if report.hash_ == report_id or report.version == report_id:
events = puppetdb.events('["=", "report", "{0}"]'.format(
report.hash_))
:param env: Search for reports in this environment
:type env: :obj:`string`
:param node_name: Find the reports whose certname match this value
:type node_name: :obj:`string`
:param report_id: The hash or the configuration_version of the desired
report
:type report_id: :obj:`string`
"""
envs = environments()
check_env(env, envs)
if env == '*':
query = '["and", ["=", "certname", "{0}"],' \
'["or", ["=", "hash", "{1}"], ["=", "configuration_version", "{1}"]]]'.format(
node_name, report_id)
else:
query = '["and", ["=", "environment", "{0}"], ["=", "certname", "{1}"],' \
'["or", ["=", "hash", "{2}"], ["=", "configuration_version", "{2}"]]]'.format(
env, node_name, report_id)
reports = puppetdb.reports(query=query)
try:
report = next(reports)
except StopIteration:
abort(404)
return render_template(
'report.html',
report=report,
events=yield_or_stop(events))
else:
abort(404)
events=yield_or_stop(report.events()),
logs=report.logs,
metrics=report.metrics,
envs=envs,
current_env=env)
@app.route('/facts')
def facts():
@app.route('/facts', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/facts')
def facts(env):
"""Displays an alphabetical list of all facts currently known to
PuppetDB."""
PuppetDB.
:param env: Serves no purpose for this function, only for consistency's
sake
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
facts_dict = collections.defaultdict(list)
facts = get_or_abort(puppetdb.fact_names)
for fact in facts:
@@ -334,46 +656,96 @@ def facts():
facts_dict[letter] = letter_list
sorted_facts_dict = sorted(facts_dict.items())
return render_template('facts.html', facts_dict=sorted_facts_dict)
return render_template('facts.html',
facts_dict=sorted_facts_dict,
envs=envs,
current_env=env)
@app.route('/fact/<fact>')
def fact(fact):
@app.route('/fact/<fact>', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/fact/<fact>')
def fact(env, fact):
"""Fetches the specific fact from PuppetDB and displays its value per
node for which this fact is known."""
node for which this fact is known.
:param env: Searches for facts in this environment
:type env: :obj:`string`
:param fact: Find all facts with this name
:type fact: :obj:`string`
"""
envs = environments()
check_env(env, envs)
# we can only consume the generator once, lists can be doubly consumed
# om nom nom
render_graph = False
if fact in graph_facts:
render_graph = True
localfacts = [f for f in yield_or_stop(puppetdb.facts(name=fact))]
if env == '*':
query = None
else:
query = '["=", "environment", "{0}"]'.format(env)
localfacts = [f for f in yield_or_stop(puppetdb.facts(
name=fact, query=query))]
return Response(stream_with_context(stream_template(
'fact.html',
name=fact,
render_graph=render_graph,
facts=localfacts)))
facts=localfacts,
envs=envs,
current_env=env)))
@app.route('/fact/<fact>/<value>')
def fact_value(fact, value):
"""On asking for fact/value get all nodes with that fact."""
facts = get_or_abort(puppetdb.facts, fact, value)
@app.route('/fact/<fact>/<value>', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/fact/<fact>/<value>')
def fact_value(env, fact, value):
"""On asking for fact/value get all nodes with that fact.
:param env: Searches for facts in this environment
:type env: :obj:`string`
:param fact: Find all facts with this name
:type fact: :obj:`string`
:param value: Filter facts whose value is equal to this
:type value: :obj:`string`
"""
envs = environments()
check_env(env, envs)
if env == '*':
query = None
else:
query = '["=", "environment", "{0}"]'.format(env)
facts = get_or_abort(puppetdb.facts,
name=fact,
value=value,
query=query)
localfacts = [f for f in yield_or_stop(facts)]
return render_template(
'fact.html',
name=fact,
value=value,
facts=localfacts)
facts=localfacts,
envs=envs,
current_env=env)
@app.route('/query', methods=('GET', 'POST'))
def query():
@app.route('/query', methods=('GET', 'POST'), defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/query', methods=('GET', 'POST'))
def query(env):
"""Allows to execute raw, user created querries against PuppetDB. This is
currently highly experimental and explodes in interesting ways since none
of the possible exceptions are being handled just yet. This will return
the JSON of the response or a message telling you what whent wrong /
why nothing was returned."""
why nothing was returned.
:param env: Serves no purpose for the query data but is required for the
select field in the environment block
:type env: :obj:`string`
"""
if app.config['ENABLE_QUERY']:
envs = environments()
check_env(env, envs)
form = QueryForm()
if form.validate_on_submit():
if form.query.data[0] == '[':
@@ -384,36 +756,195 @@ def query():
puppetdb._query,
form.endpoints.data,
query=query)
return render_template('query.html', form=form, result=result)
return render_template('query.html', form=form)
return render_template('query.html',
form=form,
result=result,
envs=envs,
current_env=env)
return render_template('query.html',
form=form,
envs=envs,
current_env=env)
else:
log.warn('Access to query interface disabled by administrator..')
abort(403)
@app.route('/metrics')
def metrics():
metrics = get_or_abort(puppetdb._query, 'metrics', path='mbeans')
@app.route('/metrics', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/metrics')
def metrics(env):
"""Lists all available metrics that PuppetDB is aware of.
:param env: While this parameter serves no function purpose it is required
for the environments template block
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
metrics = get_or_abort(puppetdb._query, 'mbean')
for key, value in metrics.items():
metrics[key] = value.split('/')[3]
return render_template('metrics.html', metrics=sorted(metrics.items()))
metrics[key] = value.split('/')[2]
return render_template('metrics.html',
metrics=sorted(metrics.items()),
envs=envs,
current_env=env)
@app.route('/metric/<metric>')
def metric(metric):
@app.route('/metric/<metric>', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/metric/<metric>')
def metric(env, metric):
"""Lists all information about the metric of the given name.
:param env: While this parameter serves no function purpose it is required
for the environments template block
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
name = unquote(metric)
metric = puppetdb.metric(metric)
return render_template(
'metric.html',
name=name,
metric=sorted(metric.items()))
metric=sorted(metric.items()),
envs=envs,
current_env=env)
@app.route('/catalogs', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/catalogs')
def catalogs(env):
"""Lists all nodes with a compiled catalog.
:param env: Find the nodes with this catalog_environment value
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
@app.route('/catalog/<node_name>')
def catalog_node(node_name):
"""Fetches from PuppetDB the compiled catalog of a given node."""
if app.config['ENABLE_CATALOG']:
catalog = puppetdb.catalog(node=node_name)
return render_template('catalog.html', catalog=catalog)
nodenames = []
catalog_list = []
if env == '*':
query = '["null?", "catalog_timestamp", false]]'
else:
query = '["and",' \
'["=", "catalog_environment", "{0}"],' \
'["null?", "catalog_timestamp", false]]'.format(env),
nodes = get_or_abort(puppetdb.nodes,
query=query,
with_status=False,
order_by='[{"field": "certname", "order": "asc"}]')
nodes, temp = tee(nodes)
for node in temp:
nodenames.append(node.name)
for node in nodes:
table_row = {
'name': node.name,
'catalog_timestamp': node.catalog_timestamp
}
if len(nodenames) > 1:
form = CatalogForm()
form.compare.data = node.name
form.against.choices = [(x, x) for x in nodenames
if x != node.name]
table_row['form'] = form
else:
table_row['form'] = None
catalog_list.append(table_row)
return render_template(
'catalogs.html',
nodes=catalog_list,
envs=envs,
current_env=env)
else:
log.warn('Access to catalog interface disabled by administrator')
abort(403)
@app.route('/catalog/<node_name>', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/catalog/<node_name>')
def catalog_node(env, node_name):
"""Fetches from PuppetDB the compiled catalog of a given node.
:param env: Find the catalog with this environment value
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
if app.config['ENABLE_CATALOG']:
catalog = get_or_abort(puppetdb.catalog,
node=node_name)
return render_template('catalog.html',
catalog=catalog,
envs=envs,
current_env=env)
else:
log.warn('Access to catalog interface disabled by administrator')
abort(403)
@app.route('/catalog/submit', methods=['POST'], defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/catalog/submit', methods=['POST'])
def catalog_submit(env):
"""Receives the submitted form data from the catalogs page and directs
the users to the comparison page. Directs users back to the catalogs
page if no form submission data is found.
:param env: This parameter only directs the response page to the right
environment. If this environment does not exist return the use to the
catalogs page with the right environment.
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
if app.config['ENABLE_CATALOG']:
form = CatalogForm(request.form)
form.against.choices = [(form.against.data, form.against.data)]
if form.validate_on_submit():
compare = form.compare.data
against = form.against.data
return redirect(
url_for('catalog_compare',
env=env,
compare=compare,
against=against))
return redirect(url_for('catalogs', env=env))
else:
log.warn('Access to catalog interface disabled by administrator')
abort(403)
@app.route('/catalogs/compare/<compare>...<against>', defaults={'env': app.config['DEFAULT_ENVIRONMENT']})
@app.route('/<env>/catalogs/compare/<compare>...<against>')
def catalog_compare(env, compare, against):
"""Compares the catalog of one node, parameter compare, with that of
with that of another node, parameter against.
:param env: Ensure that the 2 catalogs are in the same environment
:type env: :obj:`string`
"""
envs = environments()
check_env(env, envs)
if app.config['ENABLE_CATALOG']:
compare_cat = get_or_abort(puppetdb.catalog,
node=compare)
against_cat = get_or_abort(puppetdb.catalog,
node=against)
return render_template('catalog_compare.html',
compare=compare_cat,
against=against_cat,
envs=envs,
current_env=env)
else:
log.warn('Access to catalog interface disabled by administrator')
abort(403)

View File

@@ -6,6 +6,7 @@ PUPPETDB_SSL_VERIFY = True
PUPPETDB_KEY = None
PUPPETDB_CERT = None
PUPPETDB_TIMEOUT = 20
DEFAULT_ENVIRONMENT = 'production'
SECRET_KEY = os.urandom(24)
DEV_LISTEN_HOST = '127.0.0.1'
DEV_LISTEN_PORT = 5000
@@ -18,6 +19,7 @@ REPORTS_COUNT = 10
OFFLINE_MODE = False
ENABLE_CATALOG = False
GRAPH_FACTS = ['architecture',
'clientversion',
'domain',
'lsbcodename',
'lsbdistcodename',
@@ -34,3 +36,4 @@ INVENTORY_FACTS = [ ('Hostname', 'fqdn' ),
('Architecture', 'hardwaremodel' ),
('Kernel Version', 'kernelrelease' ),
('Puppet Version', 'puppetversion' ), ]
REFRESH_RATE = 30

View File

@@ -2,7 +2,10 @@ from __future__ import unicode_literals
from __future__ import absolute_import
from flask.ext.wtf import Form
from wtforms import RadioField, TextAreaField, validators
from wtforms import (
HiddenField, RadioField, SelectField,
TextAreaField, validators
)
class QueryForm(Form):
@@ -14,7 +17,17 @@ class QueryForm(Form):
('nodes', 'Nodes'),
('resources', 'Resources'),
('facts', 'Facts'),
('fact-names', 'Fact Names'),
('factsets', 'Fact Sets'),
('fact-paths', 'Fact Paths'),
('fact-contents', 'Fact Contents'),
('reports', 'Reports'),
('events', 'Events'),
('catalogs', 'Catalogs'),
('edges', 'Edges'),
('environments', 'Environments'),
])
class CatalogForm(Form):
"""The form used to compare the catalogs of different nodes."""
compare = HiddenField('compare')
against = SelectField('against')

View File

@@ -31,11 +31,60 @@ th.tablesorter-headerDesc::after {
}
.status {
width: 47.5%;
width: 45%;
text-align: center;
display: block;
}
.ui.label.status {
color: white;
text-shadow: 0 0 1px;
}
.ui.header.failed, .ui.line.failed {
color: #AA4643;
}
.ui.label.failed {
background-color: #AA4643;
}
.ui.header.changed, .ui.line.changed {
color: #4572A7;
}
.ui.label.changed {
background-color: #4572A7;
}
.ui.header.unreported {
color: #3D96AE;
}
.ui.label.unreported {
background-color: #3D96AE;
}
.ui.header.noop {
color: #DB843D;
}
.ui.label.noop {
background-color: #DB843D;
}
.ui.label.unchanged {
background-color: #89A54E;
}
.ui.line.skipped {
color: orange;
}
.ui.label.skipped {
background-color: orange;
}
.count {
width: 14%;
text-align: center;
@@ -75,6 +124,23 @@ th.tablesorter-headerDesc::after {
color: #FFF;
}
.ui.menu.yellow {
background-color: #F0E965;
}
.ui.yellow.header, i.yellow {
color: #F0E965;
}
.ui.labels .yellow.label::before, .ui.yellow.labels .label::before, .ui.yellow.label::before {
background-color: #F0E965;
}
.ui.yellow.labels .label, .ui.yellow.label {
background-color: #F0E965;
border-color: #F0E965;
}
#scroll-btn-top {
position: fixed;
overflow: hidden;

View File

@@ -57,6 +57,10 @@
sortList: [[0, 0]]
})
$('.reports').tablesorter({
sortList: [[0, 0]]
})
$('input.filter-table').parent('div').removeClass('hide');
$("input.filter-table").on("keyup", function(e) {

View File

@@ -1,4 +1,4 @@
{% macro facts_table(facts, autofocus=False, condensed=False, show_node=False, show_value=True, link_facts=False, margin_top=20, margin_bottom=20) -%}
{% macro facts_table(facts, current_env, autofocus=False, condensed=False, show_node=False, show_value=True, link_facts=False, margin_top=20, margin_bottom=20) -%}
<div class="ui fluid icon input hide" style="margin-bottom:20px">
<input {% if autofocus %} autofocus="autofocus" {% endif %} class="filter-table" placeholder="Type here to filter...">
</div>
@@ -19,17 +19,25 @@
{% for fact in facts %}
<tr>
{% if show_node %}
<td><a href="{{url_for('node', node_name=fact.node)}}">{{fact.node}}</a></td>
<td><a href="{{url_for('node', env=current_env, node_name=fact.node)}}">{{fact.node}}</a></td>
{% else %}
<td><a href="{{url_for('fact', fact=fact.name)}}">{{fact.name}}</a></td>
<td><a href="{{url_for('fact', env=current_env, fact=fact.name)}}">{{fact.name}}</a></td>
{% endif %}
{% if show_value %}
<td style="word-wrap:break-word">
{% if link_facts %}
<a href="{{url_for('fact_value', fact=fact.name, value=fact.value)}}">{{fact.value}}</a>
{% if fact.value is mapping %}
<a href="{{url_for('fact_value', env=current_env, fact=fact.name, value=fact.value)}}"><pre>{{fact.value|jsonprint}}</pre></a>
{% else %}
<a href="{{url_for('fact_value', env=current_env, fact=fact.name, value=fact.value)}}">{{fact.value}}</a>
{% endif %}
{% else %}
{% if fact.value is mapping %}
<pre>{{fact.value|jsonprint}}</pre>
{% else %}
{{fact.value}}
{% endif %}
{% endif %}
</td>
{% endif %}
</tr>
@@ -70,30 +78,40 @@
</script>
{%- endmacro %}
{% macro reports_table(reports, nodename, reports_count, condensed=False, hash_truncate=False, show_conf_col=True, show_agent_col=True, show_host_col=True) -%}
{% macro reports_table(reports, reports_count, report_event_counts, current_env, condensed=False, hash_truncate=False, show_conf_col=True, show_agent_col=True, show_host_col=True, show_run_col=False, show_full_col=False, show_search_bar=False, searchable=False) -%}
{% if show_search_bar %}
<div class="ui fluid icon input hide" style="margin-bottom:20px">
<input autofocus="autofocus" class="filter-table" placeholder="Type here to filter...">
</div>
{% endif %}
<div class="ui info message">
Only showing the last {{reports_count}} reports.
Only showing {{reports_count}} reports sorted by Start Time.
</div>
<table class='ui table basic {% if condensed %}compact{% endif %}'>
<table class='ui table basic {% if condensed %}compact{% endif %} report'>
<thead>
<tr>
<th>Start time</th>
<th>Status</th>
{% if show_host_col %}
<th>Hostname</th>
{% endif %}
{% if show_run_col %}
<th>Run time</th>
{% endif %}
{% if show_full_col %}
<th>Full report</th>
{% endif %}
{% if show_conf_col %}
<th>Configuration version</th>
{% endif %}
{% if show_agent_col %}
<th>Agent version</th>
{% endif %}
{% if show_host_col %}
<th>Hostname</th>
{% endif %}
<tr>
</thead>
<tbody>
<tbody {% if searchable %}class="searchable" {% endif %}>
{% for report in reports %}
{% if hash_truncate %}
{% set rep_hash = "%s&hellip;"|format(report.hash_[0:10])|safe %}
@@ -106,20 +124,79 @@
<tr>
{% endif %}
<td rel="utctimestamp">{{report.start}}</td>
<td>
{% call status_counts(status=report.status, node_name=report.node, events=report_event_counts[report.hash_], report_hash=report.hash_, current_env=current_env) %}{% endcall %}
</td>
{% if show_host_col %}
<td><a href="{{url_for('node', env=current_env, node_name=report.node)}}">{{ report.node }}</a></td>
{% endif %}
{% if show_run_col %}
<td>{{report.run_time}}</td>
<td><a href="{{url_for('report', node_name=nodename, report_id=report.hash_)}}">{{rep_hash}}</a></td>
{% endif %}
{% if show_full_col %}
<td><a href="{{url_for('report', env=current_env, node_name=report.node, report_id=report.hash_)}}">{{rep_hash}}</a></td>
{% endif %}
{% if show_conf_col %}
<td>{{report.version}}</td>
{% endif %}
{% if show_agent_col %}
<td>{{report.agent_version}}</td>
{% endif %}
{% if show_host_col %}
<td><a href="{{url_for('node', node_name=report.node)}}">{{ report.node }}</a></td>
{% endif %}
</tr>
{% endfor %}
</tbody>
</table>
{%- endmacro %}
{% macro status_counts(caller, status, node_name, events, current_env, unreported_time=False, report_hash=False) -%}
<a class="ui small status label
{% if status == 'failed' -%}
failed
{% elif status == 'changed' -%}
changed
{% elif status == 'unreported' -%}
unreported
{% elif status == 'noop' -%}
noop
{% elif status == 'unchanged' -%}
unchanged
{% endif -%}
" href="
{% if report_hash -%}
{{url_for('report', env=current_env, node_name=node_name, report_id=report_hash)}}
{% else -%}
{{url_for('report_latest', env=current_env, node_name=node_name)}}
{% endif -%}
">
{{status}}
</a>
{% if status == 'unreported' %}
<span class="ui small label status"> {{ unreported_time }} </span>
{% else %}
{% if events['failures'] %}<span class="ui small count label failed">{{events['failures']}}</span>{% else %}<span class="ui small count label">0</span>{% endif%}
{% if events['successes'] %}<span class="ui small count label changed">{{events['successes']}}</span>{% else %}<span class="ui small count label">0</span>{% endif%}
{% if events['skips'] %}<span class="ui small count label skipped">{{events['skips']}}</span>{% else %}<span class="ui small count label">0</span>{% endif%}
{% endif %}
{%- endmacro %}
{% macro render_pagination(pagination) -%}
<div class="pagination">
{% if pagination.has_prev %}
<a href="{{url_for_pagination(1)}}">&laquo; First</a>
<a href="{{url_for_pagination(pagination.page - 1)}}">Prev</a>
{% endif %}
{% for page in pagination.iter_pages() %}
{% if page %}
{% if page != pagination.page %}
<a href="{{url_for_pagination(page)}}">{{page}}</a>
{% else %}
<span style="font-weight:bold;">{{page}}</span>
{% endif %}
{% else %}
<span class="ellipsis">...</span>
{% endif %}
{% endfor %}
{% if pagination.has_next %}
<a href="{{url_for_pagination(pagination.page + 1)}}">Next</a>
<a href="{{url_for_pagination(pagination.pages)}}">Last &raquo;</a>
{% endif %}
</div>
{% endmacro %}

View File

@@ -10,13 +10,15 @@
<th>Hostname</th>
<th>Version</th>
<th>Transaction UUID</th>
<th>Code ID</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="{{url_for('node', node_name=catalog.node)}}">{{catalog.node}}</a></td>
<td><a href="{{url_for('node', env=current_env, node_name=catalog.node)}}">{{catalog.node}}</a></td>
<td>{{catalog.version}}</td>
<td>{{catalog.transaction_uuid}}</td>
<td>{{catalog.code_id}}</td>
</tr>
</tbody>
</table>
@@ -48,7 +50,7 @@
<th>Target</th>
</tr>
</thead>
<tbody>
<tbody class='searchable'>
{% for edge in catalog.get_edges() %}
<tr>
<td>{{edge.source}}</td>

View File

@@ -0,0 +1,90 @@
{% extends 'layout.html' %}
{% block content %}
<div class="ui fluid icon input hide" style="margin-bottom:20px">
<input autofocus="autofocus" class="filter-table" placeholder="Type here to filter...">
</div>
<table class="ui basic table">
<tbody>
<tr>
<th><h1>Comparing</h1></th>
<th><h1>Against</h1></th>
</tr>
<tr>
<td>{{compare.node}}</td>
<td>{{against.node}}</td>
</tr>
<tr>
<td>
<table class="ui fixed table compact catalog">
<thead>
<tr><th>Resources</th></tr>
</thead>
<tbody class='searchable'>
{% for resource in compare.get_resources() %}
<tr>
<td>{{resource.type_}}[{{resource.name}}]</td>
</tr>
{% endfor %}
</tbody>
</table>
</td>
<td>
<table class="ui fixed table compact catalog">
<thead>
<tr><th>Resources</th></tr>
</thead>
<tbody class='searchable'>
{% for resource in against.get_resources() %}
<tr>
<td>{{resource.type_}}[{{resource.name}}]</td>
</tr>
{% endfor %}
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<table class="ui fixed table compact catalog">
<thead>
<tr>
<th>Edges</th>
<th>-&gt;</th>
<th>Target</th>
</tr>
</thead>
<tbody class='searchable'>
{% for edge in compare.get_edges() %}
<tr>
<td>{{edge.source}}</td>
<td>{{edge.relationship}}</td>
<td>{{edge.target}}</td>
</tr>
{% endfor %}
</tbody>
</table>
</td>
<td>
<table class="ui fixed table compact catalog">
<thead>
<tr>
<th>Edge</th>
<th>-&gt;</th>
<th>Target</th>
</tr>
</thead>
<tbody class='searchable'>
{% for edge in against.get_edges() %}
<tr>
<td>{{edge.source}}</td>
<td>{{edge.relationship}}</td>
<td>{{edge.target}}</td>
</tr>
{% endfor %}
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
{% endblock content %}

View File

@@ -0,0 +1,40 @@
{% extends 'layout.html' %}
{% import '_macros.html' as macros %}
{% block content %}
<div class="ui fluid icon input hide" style="margin-bottom:20px">
<input autofocus="autofocus" class="filter-table" placeholder="Type here to filter...">
</div>
<table class='ui compact basic table nodes'>
<thead>
<tr>
<th></th>
<th>Hostname</th>
<th>Compile Time</th>
<th>Compare With</th>
</tr>
</thead>
<tbody class="searchable">
{% for node in nodes %}
<tr>
<td></td>
<td><a href="{{url_for('node', env=current_env, node_name=node.name)}}">{{node.name}}</a></td>
<td><a rel="utctimestamp" href="{{url_for('catalog_node', env=current_env, node_name=node.name)}}">{{node.catalog_timestamp}}</a></td>
<td>
{% if node.form %}
<div class="ui form">
<form method="POST" action="{{url_for('catalog_submit', env=current_env)}}">
{{node.form.csrf_token}}
<div class="field inline">
{{node.form.compare}}
{{node.form.against}}
<input type="submit" class="ui submit button" style="height:auto;" value="Compare"/>
</div>
</form>
</div>
{% endif %}
</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endblock content %}

View File

@@ -6,8 +6,8 @@
{{macros.facts_graph(facts, autofocus=True, show_node=True, margin_bottom=10)}}
{% endif %}
{% if value %}
{{macros.facts_table(facts, autofocus=True, show_node=True, show_value=False, margin_bottom=10)}}
{{macros.facts_table(facts, current_env=current_env, autofocus=True, show_node=True, show_value=False, margin_bottom=10)}}
{% else %}
{{macros.facts_table(facts, autofocus=True, show_node=True, link_facts=True, margin_bottom=10)}}
{{macros.facts_table(facts, current_env=current_env, autofocus=True, show_node=True, link_facts=True, margin_bottom=10)}}
{% endif %}
{% endblock content %}

View File

@@ -8,7 +8,7 @@
<span class='ui label darkblue'>{{key}}</span>
<ul class="searchable">
{%- for fact in facts_list %}
<li><a href="{{url_for('fact', fact=fact)}}">{{fact}}</a></li>
<li><a href="{{url_for('fact', env=current_env, fact=fact)}}">{{fact}}</a></li>
{%- endfor %}
</ul>
{% endfor %}

View File

@@ -1,10 +1,14 @@
{% extends 'layout.html' %}
{% import '_macros.html' as macros %}
{% block content %}
{% if config.REFRESH_RATE > 0 %}
<meta http-equiv="refresh" content="{{config.REFRESH_RATE}}">
{% endif %}
<div class="ui vertical grid">
<div class="four column row">
<div class="column">
<a href="nodes?status=failed">
<h1 class="ui red header no-margin-bottom">
<a href="{{url_for('nodes', env=current_env, status='failed')}}">
<h1 class="ui failed header no-margin-bottom">
{{stats['failed']}}
<small>{% if stats['failed']== 1 %} node {% else %} nodes {% endif %}</small>
</h1>
@@ -12,8 +16,8 @@
<span>with status failed</span>
</div>
<div class="column">
<a href="nodes?status=noop">
<h1 class="ui header purple no-margin-bottom">
<a href="{{url_for('nodes', env=current_env, status='noop')}}">
<h1 class="ui header noop no-margin-bottom">
{{stats['noop']}}
<small>{% if stats['noop']== 1 %} node {% else %} nodes {% endif %}</small>
</h1>
@@ -21,8 +25,8 @@
<span>with status pending</span>
</div>
<div class="column">
<a href="nodes?status=changed">
<h1 class="ui header green no-margin-bottom">
<a href="{{url_for('nodes', env=current_env, status='changed')}}">
<h1 class="ui header changed no-margin-bottom">
{{stats['changed']}}
<small>{% if stats['changed']== 1 %} node {% else %} nodes {% endif %}</small>
</h1>
@@ -30,8 +34,8 @@
<span>with status changed</span>
</div>
<div class="column">
<a href="nodes?status=unreported">
<h1 class="ui header black no-margin-bottom">
<a href="{{url_for('nodes', env=current_env, status='unreported')}}">
<h1 class="ui header unreported no-margin-bottom">
{{ stats['unreported'] }}
<small>{% if stats['unreported']== 1 %} node {% else %} nodes {% endif %}</small>
</h1>
@@ -75,40 +79,29 @@
{% if node.status != 'unchanged' %}
<tr>
<td>
<a class="ui small status label
{% if node.status == 'failed' %}
red
{% elif node.status == 'changed' %}
green
{% elif node.status == 'unreported' %}
black
{% elif node.status == 'noop' %}
blue
{% endif %}
" href="{{url_for('report_latest', node_name=node.name)}}">
{{node.status}}
</a>
{% if node.status=='unreported'%}
<span class="ui small label status"> {{ node.unreported_time }} </span>
{% if node.latest_report_hash %}
{{macros.status_counts(status=node.status, node_name=node.name, events=node.events, unreported_time=node.unreported_time, current_env=current_env, report_hash=node.latest_report_hash)}}
{% else %}
{% if node.events['failures'] %}<span class="ui small count label red">{{node.events['failures']}}</span>{% else %}<span class="ui small count label">0</span>{% endif%}
{% if node.events['successes'] %}<span class="ui small count label green">{{node.events['successes']}}</span>{% else %}<span class="ui small count label">0</span>{% endif%}
{% if node.events['skips'] %}<span class="ui small count label orange">{{node.events['skips']}}</span>{% else %}<span class="ui small count label">0</span>{% endif%}
{{macros.status_counts(status=node.status, node_name=node.name, events=node.events, unreported_time=node.unreported_time, current_env=current_env)}}
{% endif %}
</td>
<td>
<a href="{{url_for('node', node_name=node.name)}}">{{ node.name }}</a>
<a href="{{url_for('node', env=current_env, node_name=node.name)}}">{{ node.name }}</a>
</td>
<td>
{% if node.report_timestamp %}
<a href="{{url_for('report_latest', node_name=node.name)}}" rel='utctimestamp'>{{ node.report_timestamp }}</a>
{% if node.latest_report_hash %}
<a href="{{url_for('report', env=current_env, node_name=node.name, report_id=node.latest_report_hash)}}" rel='utctimestamp'>{{ node.report_timestamp }}</a>
{% else %}
<a href="{{url_for('report_latest', env=current_env, node_name=node.name)}}" rel='utctimestamp'>{{ node.report_timestamp }}</a>
{% endif %}
{% else %}
<i class="large ban circle icon"></i>
{% endif %}
</td>
<td>
{% if node.report_timestamp %}
<a title='Reports' href="{{url_for('reports_node', node_name=node.name)}}"><i class='large darkblue book icon'></i></a>
<a title='Reports' href="{{url_for('reports_node', env=current_env, node_name=node.name)}}"><i class='large darkblue book icon'></i></a>
{% endif %}
</td>
</tr>

View File

@@ -23,7 +23,7 @@
</head>
<body>
<nav class="ui fixed darkblue inverted menu">
<div class="ui fixed darkblue inverted menu">
<div class="title item">
Puppetboard
</div>
@@ -34,13 +34,24 @@
('reports', 'Reports'),
('metrics', 'Metrics'),
('inventory', 'Inventory'),
('catalogs', 'Catalogs'),
('query', 'Query'),
] %}
<a {% if endpoint == request.endpoint %} class="active item" {% else %} class="item" {% endif %}
href="{{ url_for(endpoint) }}">{{ caption }}</a>
href="{{ url_for(endpoint, env=current_env) }}">{{ caption }}</a>
{%- endfor %}
<div class="item" style="float:right"><a href="https://github.com/puppet-community/puppetboard" target="_blank">v0.0.5</a></div>
</nav>
<div class="ui item dropdown">
Environments
<i class="dropdown icon"></i>
<div class="menu">
<a class="item {% if '*' == current_env %}active{% endif %}" href="{{url_for_environments('*')}}">All environments</a>
{% for env in envs %}
<a class="item {% if env == current_env %}active{% endif %}" href="{{url_for_environments(env)}}">{{env}}</a>
{% endfor %}
</div>
</div>
<div class="item right"><a href="https://github.com/puppet-community/puppetboard" target="_blank">v0.1.2</a></div>
</div>
<div class="ui grid padding-bottom">
<div class="one wide column"></div>
<div class="fourteen wide column">
@@ -55,7 +66,7 @@
<footer class="ui absolute fixed bottom">
<div>
Copyright &copy; 2013-{{ now('%Y') }} <a href="https://github.com/daenney" target="_blank">Daniele Sluijters</a>. <span style="float:right">Live from PuppetDB.</span>
Copyright &copy; 2013-{{ now('%Y') }} <a href="https://github.com/puppet-community" target="_blank">Puppet Community</a>. <span style="float:right">Live from PuppetDB.</span>
</div>
</footer>
@@ -80,6 +91,9 @@
<script src="{{ url_for('static', filename='js/lists.js') }}"></script>
<script src="{{ url_for('static', filename='js/tables.js') }}"></script>
<script src="{{ url_for('static', filename='js/scroll.top.js') }}"></script>
<script type="text/javascript">
$(".ui.dropdown").dropdown();
</script>
{% block script %} {% endblock script %}
</body>

View File

@@ -3,7 +3,7 @@
<h1>Metrics</h1>
<ul>
{% for key,value in metrics %}
<li><a href="{{url_for('metric', metric=value)}}">{{key}}</li>
<li><a href="{{url_for('metric', env=current_env, metric=value)}}">{{key}}</li>
{% endfor %}
</ul>
{% endblock content %}

View File

@@ -28,12 +28,12 @@
</div>
<div class='row'>
<h1>Reports</h1>
{{ macros.reports_table(reports, node.name, reports_count, condensed=True, hash_truncate=True, show_conf_col=False, show_agent_col=False, show_host_col=False)}}
{{ macros.reports_table(reports, reports_count, report_event_counts, condensed=True, hash_truncate=True, show_conf_col=False, show_agent_col=False, show_host_col=False, current_env=current_env)}}
</div>
</div>
<div class='column'>
<h1>Facts</h1>
{{macros.facts_table(facts, link_facts=True, condensed=True)}}
{{macros.facts_table(facts, link_facts=True, condensed=True, current_env=current_env)}}
</div>
</div>
{% endblock content %}

View File

@@ -1,4 +1,5 @@
{% extends 'layout.html' %}
{% import '_macros.html' as macros %}
{% block content %}
<div class="ui fluid icon input hide" style="margin-bottom:20px">
<input autofocus="autofocus" class="filter-table" placeholder="Type here to filter...">
@@ -17,40 +18,28 @@
{% for node in nodes %}
<tr>
<td>
<a class="ui small status label
{% if node.status == 'failed' %}
red
{% elif node.status == 'changed' %}
green
{% elif node.status == 'unreported' %}
black
{% elif node.status == 'noop' %}
blue
{% endif %}
" href="{{url_for('report_latest', node_name=node.name)}}">
{{node.status}}
</a>
{% if node.status=='unreported'%}
<span class="ui small label status"> {{ node.unreported_time }} </label>
{% if node.latest_report_hash %}
{{macros.status_counts(status=node.status, node_name=node.name, events=node.events, unreported_time=node.unreported_time, current_env=current_env, report_hash=node.latest_report_hash)}}
{% else %}
<span>{% if node.events['failures'] %}<span class="ui small count label red">{{node.events['failures']}}</span>{% else %}<span class="ui small count label">0</span>{% endif%}
{% if node.events['successes'] %}<span class="ui small count label green">{{node.events['successes']}}</span>{% else %}<span class="ui small count label">0</span>{% endif%}</span>
{% if node.events['skips'] %}<span class="ui small count label yellow">{{node.events['skips']}}</span>{% else %}<span class="ui small count label">0</span>{% endif%}
{{macros.status_counts(status=node.status, node_name=node.name, events=node.events, unreported_time=node.unreported_time, current_env=current_env)}}
{% endif %}
</td>
<td><a href="{{url_for('node', node_name=node.name)}}">{{node.name}}</a></td>
<td><a rel="utctimestamp" href="{{url_for('catalog_node', node_name=node.name)}}">{{node.catalog_timestamp}}</a></td>
<td><a href="{{url_for('node', env=current_env, node_name=node.name)}}">{{node.name}}</a></td>
<td><a rel="utctimestamp" href="{{url_for('catalog_node', env=current_env, node_name=node.name)}}">{{node.catalog_timestamp}}</a></td>
<td>
{% if node.report_timestamp %}
<a href="{{url_for('report_latest', node_name=node.name)}}" rel='utctimestamp'>{{ node.report_timestamp }}</a>
{% if node.latest_report_hash %}
<a href="{{url_for('report', env=current_env, node_name=node.name, report_id=node.latest_report_hash)}}" rel='utctimestamp'>{{ node.report_timestamp }}</a>
{% else %}
<a href="{{url_for('report_latest', env=current_env, node_name=node.name)}}" rel='utctimestamp'>{{ node.report_timestamp }}</a>
{% endif %}
{% else %}
<i class="large ban circle icon"></i>
{% endif %}
</td>
<td>
{% if node.report_timestamp %}
<a title='Reports' href="{{url_for('reports_node', node_name=node.name)}}"><i class='large darkblue book icon'></i></a>
<i class='large darkblue trash icon'></i>
<a title='Reports' href="{{url_for('reports_node', env=current_env, node_name=node.name, page=1)}}"><i class='large darkblue book icon'></i></a>
{% endif %}
</td>
</tr>

View File

@@ -11,10 +11,10 @@
{% endif %}
{% endwith %}
<div class="ui form">
<form method="POST" action="{{ url_for('query') }}">
<form method="POST" action="{{ url_for('query', env=current_env) }}">
{{ form.csrf_token }}
<div class="field {% if form.query.errors %} error {% endif %}">
{{ form.query(autofocus="autofocus", rows=5, placeholder="Enter your query: [\"=\", \"name\", \"hostname\"]. You may omit the opening and closing bracket.") }}
{{ form.query(autofocus="autofocus", rows=5, placeholder="Enter your query: [\"=\", \"certname\", \"hostname\"]. You may omit the opening and closing bracket.") }}
</div>
<div class="inline fields">
{% for subfield in form.endpoints %}

View File

@@ -12,7 +12,7 @@
</thead>
<tbody>
<tr>
<td><a href="{{url_for('node', node_name=report.node)}}">{{ report.node }}</a></td>
<td><a href="{{url_for('node', env=current_env, node_name=report.node)}}">{{ report.node }}</a></td>
<td>
{{report.version}}
</td>
@@ -39,35 +39,73 @@
<tbody>
{% for event in events %}
{% if not event.failed and event.item['old'] != event.item['new'] %}
<tr id='event-{{loop.index}}' class='positive'>
<tr id='event-{{loop.index}}' class='ui line changed'>
{% elif event.failed %}
<tr id='event-{{loop.index}}' class='error'>
<tr id='event-{{loop.index}}' class='ui line failed'>
{% else %}
<tr id='event-{{loop.index}}' class='ui line {{event.status}}'>
{% endif %}
<td>{{event.item['type']}}[{{event.item['title']}}]</td>
<td>{{event.status}}</td>
<td>{{event.item['old']}}</td>
<td>{{event.item['new']}}</td>
</tr>
{# <tr>
<td class='message' colspan='4'>
<div id='message-event-{{loop.index}}'>
{{event.item['message']}}
</div>
</td>
</tr>#}
{% endfor %}
</tbody>
</table>
<h1>Logs</h1>
<table class="ui basic table compact">
<thead>
<tr>
<th>Timestamp</th>
<th>Source</th>
<th>Tags</th>
<th>Message</th>
<th>Location</th>
<tr>
</thead>
<tbody>
{% for log in logs %}
{% if log.level == 'info' or log.level == 'notice' %}
<tr class='positive'>
{% elif log.level == 'warning' %}
<tr class='warning'>
{% else %}
<tr class='error'>
{% endif %}
<td rel="utctimestamp">{{log.time}}</td>
<td>{{log.source}}</td>
<td>{{log.tags|join(', ')}}</td>
<td>{{log.message}}</td>
{% if log.file != None and log.line != None %}
<td>{{log.file}}:{{log.line}}</td>
{% else %}
<td></td>
{% endif %}
</tr>
{% endfor %}
</tbody>
</table>
<h1>Metrics</h1>
<table class="ui basic table compact">
<thead>
<tr>
<th>Category</th>
<th>Name</th>
<th>Value</th>
</tr>
</thead>
<tbody>
{% for metric in metrics %}
<tr>
<td>{{metric.category}}</td>
<td>{{metric.name}}</td>
<td>{{metric.value|round(2)}}</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endblock content %}
{% block script %}
<script type='text/javascript'>
jQuery(function ($) {
$("[rel=tooltip]").tooltip();
$(".event").click(function() {
$("#message-" + this.id).slideToggle(200);
return false;
});
});
</script>
{% endblock script %}

View File

@@ -1,6 +1,6 @@
{% extends 'layout.html' %}
{% import '_macros.html' as macros %}
{% block content %}
<div class="ui warning message">
Pending <a href="https://tickets.puppetlabs.com/browse/PDB-201">#PDB-201</a>. You can access reports for a node or individual reports through the <a href="{{url_for('nodes')}}">Nodes</a> tab.
</div>
{{ macros.reports_table(reports, reports_count, report_event_counts, condensed=False, hash_truncate=False, show_conf_col=True, show_agent_col=True, show_host_col=True, show_search_bar=True, searchable=True, current_env=current_env)}}
{{ macros.render_pagination(pagination)}}
{% endblock content %}

View File

@@ -1,5 +0,0 @@
{% extends 'layout.html' %}
{% import '_macros.html' as macros %}
{% block content %}
{{ macros.reports_table(reports, nodename, reports_count, condensed=False, hash_truncate=False, show_conf_col=True, show_agent_col=True, show_host_col=True)}}
{% endblock content %}

View File

@@ -3,6 +3,7 @@ from __future__ import unicode_literals
import json
from math import ceil
from requests.exceptions import HTTPError, ConnectionError
from pypuppetdb.errors import EmptyResponseError
@@ -29,17 +30,6 @@ def get_or_abort(func, *args, **kwargs):
abort(204)
def limit_reports(reports, limit):
"""Helper to yield a number of from the reports generator.
This is an ugly solution at best...
"""
for count, report in enumerate(reports):
if count == limit:
raise StopIteration
yield report
def yield_or_stop(generator):
"""Similar in intent to get_or_abort this helper will iterate over our
generators and handle certain errors.
@@ -54,3 +44,35 @@ def yield_or_stop(generator):
raise
except (EmptyResponseError, ConnectionError, HTTPError):
raise StopIteration
class Pagination(object):
def __init__(self, page, per_page, total_count):
self.page = page
self.per_page = per_page
self.total_count = total_count
@property
def pages(self):
return int(ceil(self.total_count / float(self.per_page)))
@property
def has_prev(self):
return self.page > 1
@property
def has_next(self):
return self.page < self.pages
def iter_pages(self, left_edge=2, left_current=2,
right_current=5, right_edge=2):
last = 0
for num in xrange(1, self.pages + 1):
if num <= left_edge or \
(num > self.page - left_current - 1 and \
num < self.page + right_current) or \
num > self.pages - right_edge:
if last + 1 != num:
yield None
yield num
last = num

View File

@@ -5,5 +5,5 @@ MarkupSafe==0.19
WTForms==1.0.5
Werkzeug==0.9.4
itsdangerous==0.23
pypuppetdb==0.1.1
pypuppetdb==0.2.1
requests==2.2.1

View File

@@ -9,7 +9,7 @@ if sys.argv[-1] == 'publish':
os.system('python setup.py sdist upload')
sys.exit()
VERSION = "0.0.5"
VERSION = "0.1.2"
with codecs.open('README.rst', encoding='utf-8') as f:
README = f.read()
@@ -23,7 +23,7 @@ setup(
author='Daniele Sluijters',
author_email='daniele.sluijters+pypi@gmail.com',
packages=find_packages(),
url='https://github.com/nedap/puppetboard',
url='https://github.com/puppet-community/puppetboard',
license='Apache License 2.0',
description='Web frontend for PuppetDB',
include_package_data=True,
@@ -32,7 +32,7 @@ setup(
"Flask >= 0.10.1",
"Flask-WTF >= 0.9.4, <= 0.9.5",
"WTForms < 2.0",
"pypuppetdb >= 0.1.0, < 0.2.0",
"pypuppetdb >= 0.2.1, < 0.3.0",
],
keywords="puppet puppetdb puppetboard",
classifiers=[