diff --git a/CHANGELOG.rst b/CHANGELOG.rst index b7997f8..56bf34c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,137 +1,151 @@ ######### Changelog ######### This is the changelog for Puppetboard. +0.1.2 +==== + +* Add configuration option to set the default environment, defaults to + 'production' (https://github.com/puppet-community/puppetboard/pull/185) +* Loading all available environments with every page load. (Issue: + https://github.com/puppet-community/puppetboard/issues/186) + +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 ===== * Now requires WTForms versions less than 2.0 * Adding a Flask development server in ``dev.py``. * Adding CSRF protection VIA the flask_wtf CsrfProtect object. * Allowing users to configure the report limit on pages where reports are listed with the LIMIT_REPORTS configuration option. * Adding an inventory page to users to be able to see all available nodes and a configure lists of facts to display VIA the INVENTORY_FACTS configuration option. * Adding a page to view a node's catalog information if enabled, disabled by default. Can be changed with the ENABLE_CATALOG configuration attribute. * New configuration option GRAPH_FACTS allows the user to choose which graphs will generate pie on the fact pages. * Replacing Chart.js with c3.js and d3.js. * Adding Semantic UI 0.16.1 and removing unused bootstrap styles. * Adding an OFFLINE_MODE configuration option to load local assets or from a CDN service. This is useful in environments without internet access. 0.0.4 ===== * Fix the sorting of the different tables containing facts. * Fix the license in our ``setup.py``. The license shouldn't be longer than 200 characters. We were including the full license tripping up tools like bdist_rpm. 0.0.3 ===== This release introduces a few big changes. The most obvious one is the revamped Overview page which has received significant love. Most of the work was done by Julius Härtl. The Nodes tab has been given a slight face-lift too. Other changes: * This release depends on the new pypuppetdb 0.1.0. Because of this the SSL configuration options have been changed: * ``PUPPETDB_SSL`` is gone and replaced by ``PUPPETDB_SSL_VERIFY`` which now defaults to ``True``. This only affects connections to PuppetDB that happen over SSL. * SSL is automatically enabled if both ``PUPPETDB_CERT`` and ``PUPPETDB_KEY`` are provided. * Display of deeply nested metrics and query results have been fixed. * Average resources per node metric is now displayed as a natural number. * A link back to the node has been added to the reports. * A few issues with reports have been fixed. * A new setting called ``UNRESPONSIVE_HOURS`` has been added which denotes the amount of hours after which Puppetboard will display the node as unreported if it hasn't checked in. We default to ``2`` hours. * The event message can now be viewed by clicking on the event. Puppetboard is now neatly packaged up and available on PyPi. This should significantly help reduce the convoluted installation instructions people had to follow. Updated installation instructions have been added on how to install from PyPi and how to configure your HTTPD. 0.0.2 ===== In this release we've introduced a few new things. First of all we now require pypuppetdb version 0.0.4 or later which includes support for the v3 API introduced with PuppetDB 1.5. Because of changes in PuppetDB 1.5 and therefor in pypuppetdb users of the v2 API, regardless of the PuppetDB version, will no longer be able to view reports or events. In light of this the following settings have been removed: * ``PUPPETDB_EXPERIMENTAL`` Two new settings have been added: * ``PUPPETDB_API``: an integer, defaulting to ``3``, representing the API version we want to use. * ``ENABLE_QUERY``: a boolean, defaulting to ``True``, on wether or not to be able to use the Query tab. We've also added a few new features: * Thanks to some work done during PuppetConf together with Nick Lewis (from Puppet Labs) we now expose all of PuppetDB's metrics in the Metrics tab. The formatting isn't exactly pretty but it's a start. * Spencer Krum added the graphing capabilities to the Facts tab. * Daniel Lawrence added a feature so that facts on the node view are clickable and take you to the complete overview of that fact for your infrastructure and made the nodes in the complete facts list clickable so you can jump to a node. * Klavs Klavsen contributed some documentation on how to run Puppetboard with Passenger. 0.0.1 ===== Initial release. diff --git a/puppetboard/app.py b/puppetboard/app.py index cda415d..9b216d2 100644 --- a/puppetboard/app.py +++ b/puppetboard/app.py @@ -1,879 +1,900 @@ from __future__ import unicode_literals from __future__ import absolute_import import logging import collections try: from urllib import unquote 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 (CatalogForm, QueryForm) from puppetboard.utils import ( get_or_abort, yield_or_stop, jsonprint, Pagination ) app = Flask(__name__) CsrfProtect(app) app.config.from_object('puppetboard.default_settings') graph_facts = app.config['GRAPH_FACTS'] app.config.from_envvar('PUPPETBOARD_SETTINGS', silent=True) graph_facts += app.config['GRAPH_FACTS'] app.secret_key = app.config['SECRET_KEY'] app.jinja_env.filters['jsonprint'] = jsonprint puppetdb = connect( host=app.config['PUPPETDB_HOST'], port=app.config['PUPPETDB_PORT'], ssl_verify=app.config['PUPPETDB_SSL_VERIFY'], ssl_key=app.config['PUPPETDB_KEY'], ssl_cert=app.config['PUPPETDB_CERT'], timeout=app.config['PUPPETDB_TIMEOUT'],) numeric_level = getattr(logging, app.config['LOGLEVEL'].upper(), None) if not isinstance(numeric_level, int): raise ValueError('Invalid log level: %s' % app.config['LOGLEVEL']) logging.basicConfig(level=numeric_level) log = logging.getLogger(__name__) def stream_template(template_name, **context): app.update_template_context(context) t = app.jinja_env.get_template(template_name) rv = t.stream(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): +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 -envs = environments() - @app.context_processor def utility_processor(): def now(format='%m/%d/%Y %H:%M:%S'): """returns the formated datetime""" return datetime.now().strftime(format) return dict(now=now) @app.errorhandler(400) def bad_request(e): + envs = environments() return render_template('400.html', envs=envs), 400 @app.errorhandler(403) def forbidden(e): + envs = environments() return render_template('403.html', envs=envs), 400 @app.errorhandler(404) def not_found(e): + 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.""" + envs = environments() return render_template('412.html', envs=envs), 412 @app.errorhandler(500) def server_error(e): + envs = environments() return render_template('500.html', envs=envs), 500 @app.route('/', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//') 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` """ - check_env(env) + envs = environments() + check_env(env, envs) # TODO: Would be great if we could parallelize this somehow, doing these # requests in sequence is rather pointless. prefix = 'puppetlabs.puppetdb.query.population' refreshrate = app.config['REFRESH_RATE'] num_nodes = get_or_abort( puppetdb.metric, "{0}{1}".format(prefix, ':type=default,name=num-nodes')) num_resources = get_or_abort( puppetdb.metric, "{0}{1}".format(prefix, ':type=default,name=num-resources')) 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']), } if env == '*': query = None else: query = '["and", {0}]'.format( ", ".join('["=", "{0}", "{1}"]'.format(field, env) for field in ['catalog_environment', 'facts_environment'])) nodes = get_or_abort(puppetdb.nodes, query=query, unreported=app.config['UNRESPONSIVE_HOURS'], with_status=True) nodes_overview = [] stats = { 'changed': 0, 'unchanged': 0, 'failed': 0, 'unreported': 0, 'noop': 0 } for node in nodes: if node.status == 'unreported': stats['unreported'] += 1 elif node.status == 'changed': stats['changed'] += 1 elif node.status == 'failed': stats['failed'] += 1 elif node.status == 'noop': stats['noop'] += 1 else: stats['unchanged'] += 1 if node.status != 'unchanged': nodes_overview.append(node) return render_template( 'index.html', metrics=metrics, nodes=nodes_overview, stats=stats, envs=envs, refreshrate=refreshrate, current_env=env ) @app.route('/nodes', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//nodes') def nodes(env): """Fetch all (active) nodes from PuppetDB and stream a table displaying those nodes. Downside of the streaming aproach is that since we've already sent our headers we can't abort the request if we detect an error. Because of this 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` """ - check_env(env) + 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 = [] for node in yield_or_stop(nodelist): if status_arg: if node.status == status_arg: nodes.append(node) else: nodes.append(node) return Response(stream_with_context( stream_template('nodes.html', nodes=nodes, envs=envs, current_env=env))) @app.route('/inventory', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//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. Downside of the streaming aproach is that since we've already sent our headers we can't abort the request if we detect an error. Because of this 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` """ - check_env(env) + envs = environments() + check_env(env, envs) fact_desc = [] # a list of fact descriptions to go # in the table header fact_names = [] # a list of inventory fact names factvalues = {} # values of the facts for all the nodes # indexed by node name and fact name nodedata = {} # a dictionary containing list of inventoried # facts indexed by node name nodelist = set() # a set of node names # load the list of items/facts we want in our inventory try: inv_facts = app.config['INVENTORY_FACTS'] except KeyError: inv_facts = [ ('Hostname' ,'fqdn' ), ('IP Address' ,'ipaddress' ), ('OS' ,'lsbdistdescription'), ('Architecture' ,'hardwaremodel' ), ('Kernel Version','kernelrelease' ) ] # generate a list of descriptions and a list of fact names # from the list of tuples inv_facts. for description,name in inv_facts: fact_desc.append(description) fact_names.append(name) 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)) # get all the facts from PuppetDB facts = puppetdb.facts(query=query) # convert the json in easy to access data structure for fact in facts: factvalues[fact.node,fact.name] = fact.value nodelist.add(fact.node) # generate the per-host data for node in nodelist: nodedata[node] = [] for fact_name in fact_names: try: nodedata[node].append(factvalues[node,fact_name]) except KeyError: nodedata[node].append("undef") return Response(stream_with_context( stream_template('inventory.html', nodedata=nodedata, fact_desc=fact_desc, envs=envs, current_env=env))) @app.route('/node/', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//node/') 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` """ - check_env(env) + 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 = 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'], report_event_counts=report_event_counts, envs=envs, current_env=env) @app.route('/reports/', defaults={'env': app.config['DEFAULT_ENVIRONMENT'], 'page': 1}) @app.route('//reports/', defaults={'page': 1}) @app.route('//reports/page/') def reports(env, page): """Displays a list of reports and status from all nodes, retreived using the reports endpoint, sorted by start_time. :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` """ - check_env(env) + 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: counts = get_or_abort(puppetdb.event_counts, query='["and",' \ '["=", "environment", "{0}"],' \ '["=", "certname", "{1}"],' \ '["=", "report", "{2}"]]'.format( env, report.node, report.hash_), 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('/reports//', defaults={'env': app.config['DEFAULT_ENVIRONMENT'], 'page': 1}) @app.route('//reports/', defaults={'page': 1}) @app.route('//reports//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` """ - check_env(env) + 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: counts = get_or_abort(puppetdb.event_counts, query='["and",' \ '["=", "environment", "{0}"],' \ '["=", "certname", "{1}"],' \ '["=", "report", "{2}"]]'.format(env, report.node, report.hash_), 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/', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//report/latest/') 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` """ - check_env(env) + envs = environments() + check_env(env, envs) 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) except StopIteration: abort(404) return redirect( url_for('report', env=env, node_name=node_name, report_id=report.hash_)) @app.route('/report//', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//report//') 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. :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` """ - check_env(env) + 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(report.events()), logs=report.logs, metrics=report.metrics, envs=envs, current_env=env) @app.route('/facts', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//facts') def facts(env): """Displays an alphabetical list of all facts currently known to PuppetDB. :param env: Serves no purpose for this function, only for consistency's sake :type env: :obj:`string` """ - check_env(env) + envs = environments() + check_env(env, envs) facts_dict = collections.defaultdict(list) facts = get_or_abort(puppetdb.fact_names) for fact in facts: letter = fact[0].upper() letter_list = facts_dict[letter] letter_list.append(fact) facts_dict[letter] = letter_list sorted_facts_dict = sorted(facts_dict.items()) return render_template('facts.html', facts_dict=sorted_facts_dict, envs=envs, current_env=env) @app.route('/fact/', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//fact/') def fact(env, fact): """Fetches the specific fact from PuppetDB and displays its value per 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` """ - check_env(env) + 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 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, envs=envs, current_env=env))) @app.route('/fact//', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//fact//') 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` """ - check_env(env) + 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, envs=envs, current_env=env) @app.route('/query', methods=('GET', 'POST'), defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//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. :param env: Serves no purpose for the query data but is required for the select field in the environment block :type env: :obj:`string` """ - check_env(env) + envs = environments() + check_env(env, envs) if app.config['ENABLE_QUERY']: form = QueryForm() if form.validate_on_submit(): if form.query.data[0] == '[': query = form.query.data else: query = '[{0}]'.format(form.query.data) result = get_or_abort( puppetdb._query, form.endpoints.data, query=query) 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', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//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` """ - check_env(env) + envs = environments() + check_env(env, envs) metrics = get_or_abort(puppetdb._query, 'mbean') for key, value in metrics.items(): metrics[key] = value.split('/')[2] return render_template('metrics.html', metrics=sorted(metrics.items()), envs=envs, current_env=env) @app.route('/metric/', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//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` """ - check_env(env) + envs = environments() + check_env(env, envs) name = unquote(metric) metric = puppetdb.metric(metric) return render_template( 'metric.html', name=name, metric=sorted(metric.items()), envs=envs, current_env=env) @app.route('/catalogs', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//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` """ - check_env(env) + envs = environments() + check_env(env, envs) if app.config['ENABLE_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/', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//catalog/') 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` """ - check_env(env) + 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('//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` """ - check_env(env) + 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/...', defaults={'env': app.config['DEFAULT_ENVIRONMENT']}) @app.route('//catalogs/compare/...') 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` """ - check_env(env) + 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)