Package: puppetboard
PuppetboardPuppetboard is a web interface toPuppetDBaiming to replace
the reporting functionality ofPuppet Enterprise console (previously: Puppet Dashboard)for the open source Puppet.Seemore screenshots here.Table of ContentsRequirementsInstallationConfigurationGetting HelpContributingLegalRequirementsPuppetDB v. 5.2-8.*(Note: PuppetDB 8.1.0 is not supported because ofthis bug. Please update to 8.1.1+.)Python 3.8-3.11 or DockerInstallationPuppetboard is packaged and available on PyPI.With Puppet moduleThere is aPuppet moduleoriginally written bySpencer Krumand currently maintained byVoxpupulithat takes care of installing the Puppetboard for you.To see how to get it working with RedHat/Centos 7 check out thesedocs.Using DockerWe providean official Docker image in the GitHub Container Registry.You must provide a secret key! Generate one for example by runningruby -e "require 'securerandom'; puts SecureRandom.hex(32)".You can run the app on your PuppetDB host with this command:dockerrun-it\-ePUPPETDB_HOST=localhost\-ePUPPETDB_PORT=8080\-eSECRET_KEY=XXXXXXXX\--net=host\ghcr.io/voxpupuli/puppetboardOptionally you can setPUPPETBOARD_URL_PREFIXenv variable to a value like/puppetboardto run the app under a URL prefix.You can use the following Puppet Code to have Puppetboard managed by Puppet:includedockerdocker::image{'ghcr.io/voxpupuli/puppetboard':}docker::run{'puppetboard':image=>'ghcr.io/voxpupuli/puppetboard',env=>['PUPPETDB_HOST=127.0.0.1','PUPPETDB_PORT=8080','PUPPETBOARD_PORT=8088','SECRET_KEY=XXXXXXXX',],net=>'host',}If you want to have all features enabled, you must use SSL talking to PuppetDB:file{'/etc/puppetboard':ensure=>directory,}file{'/etc/puppetboard/key.pem':ensure=>file,mode=>'0644',source=>"/etc/puppetlabs/puppet/ssl/private_keys/${facts['networking']['fqdn']}.pem",}file{'/etc/puppetboard/cert.pem':ensure=>file,mode=>'0644',source=>"/etc/puppetlabs/puppet/ssl/certs/${facts['networking']['fqdn']}.pem",}includedockerdocker::image{'ghcr.io/voxpupuli/puppetboard':}docker::run{'puppetboard':image=>'ghcr.io/voxpupuli/puppetboard',volumes=>['/etc/puppetboard:/etc/puppetboard:ro'],env=>['PUPPETDB_HOST=puppet',# this must be the certname or DNS_ALT_NAME of the PuppetDB host'PUPPETDB_PORT=8081','PUPPETBOARD_PORT=8080','ENABLE_CATALOG=true','PUPPETDB_SSL_VERIFY=false','PUPPETDB_KEY=/etc/puppetboard/key.pem','PUPPETDB_CERT=/etc/puppetboard/cert.pem','SECRET_KEY=XXXXXXXX','DEFAULT_ENVIRONMENT=*',],net=>'host',}Within an air gapped environment you want to load all content from your local puppetboard web service.
Add:'OFFLINE_MODE=true',to theenvparameter list of thedocker::runPuppet type.We also provide the Dockerfile, so you can build the image yourself:dockerbuild-tpuppetboard.From a packageActively maintained packages:FreeBSDmaintained byRomain TartièreOpenBSDmaintained bySebastian ReitenbachManuallyYou can also install the package from PyPI and configure a WSGI-capable application server to serve it.We recommend using virtualenv to provide a separate environment for the app.virtualenv-ppython3venv
.venv/bin/activate
pipinstallpuppetboardPlease seean article about more deployment setups here.ConfigurationPuppet agentsThe default value ofusecacheonfailure = trueconfiguration setting for Puppet agents causes Puppet runs to always succeed,
event if there are catalog compilation failures f.e. because of a syntax error in your code. This is because in such
cases with this setting Puppet will just use a cached working catalog and report the run to PuppetDB as successful.
(Although with an error visible in the Puppet run log.)Therefore, to show the nodes with a catalog compilation as failed in Puppetboard you need to setusecacheonfailure = falsein your nodes'puppet.conf.PuppetDBOf course you need to configure your Puppet Server to store the Puppet run reports in PuppetDB.
If you haven't done that already please follow thePuppetDB documentationabout this.If you run Puppetboard on a different host than PuppetDB then you may want to configure the certificate
allow-list for which certificates are allowed to access data from PuppetDB.
Please read more about this feature in thePuppetDB documentation here.App settingsPuppetboard will look for a file pointed at by thePUPPETBOARD_SETTINGSenvironment variable.
The file has to be identical todefault_settings.pybut should only override the settings you need changed.If you run PuppetDB and Puppetboard on the same machine the default settings provided will be enough to get you started
and you won't need a custom settings file.Assuming your webserver and PuppetDB machine are not identical you will at least have to change the following settings:PUPPETDB_HOSTPUPPETDB_PORTBy default PuppetDB requires SSL to be used when a non-local client wants to connect. Therefore you'll also have to
supply the following settings:PUPPETDB_SSL_VERIFY = TruePUPPETDB_KEY = /path/to/private/keyfile.pemPUPPETDB_CERT = /path/to/public/keyfile.crtWhen using the Puppetboard Docker image, you may also pass Puppetboard it's certificate contents via these environment
variables, either as a multiline string or pre-base64 encoded. This can be useful where the certificate is stored in a
secrets store i.e. AWS SSM Parameter Store.PUPPETDB_CERT="-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----"PUPPETDB_CERT=LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQouLi4KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQ==For information about how to generate the correct keys please refer to thepypuppetdb documentation. Alternatively it is possible
to explicitly specify the protocol to be used setting thePUPPETDB_PROTOvariable.Other settings that might be interesting, in no particular order:SECRET_KEY: set this to a long string,the same for each application replica, and keep it secret. Refer toFlask documentation, section
"How to generate good secret keys" for more info. Cannot be an empty string, which is the default.FAVORITE_ENVS: an ordered list of Puppet environment names that will be shown immediately after "All Environments"
and before other environments (which are sorted by name) in the dropdown for choosing the environment shown
in the top-right of the UI. Environments listed here that do not really exist in your deployment are silently ignored.SHOW_ERROR_AS:friendlyorraw. The former makes Puppet run errors in Report and Failures views shown
in a modified, (arguably) more user-friendly form. The latter shows them as they are.
Defaults tofriendly.CODE_PREFIX_TO_REMOVE: what code path that should be shortened in "Friendly errors" to "…" for readability.
A regexp. Defaults to/etc/puppetlabs/code/environments(/.*?/modules)?.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 introduced.UNRESPONSIVE_HOURS: The amount of hours since the last check-in after which a node is considered unresponsive.LOGLEVEL: A string representing the loglevel. It defaults to'info'but can be changed to'warning'or'critical'for less verbose logging or'debug'for more information.ENABLE_QUERY: Defaults toTruecausing 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 toFalseto disable this.
SeeENABLED_QUERY_ENDPOINTSto fine-tune which endpoints are allowed.ENABLED_QUERY_ENDPOINTS: IfENABLE_QUERYisTrue, allow to fine tune the endpoints of PuppetDB APIs that
can be queried. It must be a list of strings of PuppetDB endpoints for which the query is enabled.
See theQUERY_ENDPOINTSconstant in thepuppetboard.appmodule for a list of the available endpoints.GRAPH_TYPE: Specify the type of graph to display.   Default is
pie, other good option is donut.   Other choices can be found here:C3.js documentationGRAPH_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 thenundefis printed.INVENTORY_FACT_TEMPLATES: A mapping between fact name and jinja template to customize displayENABLE_CATALOG: If set toTrueallows the user to view a node's latest catalog. This includes all managed
resources, their file-system locations and their relationships, if available. Defaults toFalse.REFRESH_RATE: Defaults to30the 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 to10the limit of the number of reports to load on the node or any reports page.OFFLINE_MODE: If set toTrueload static assets (jquery, semantic-ui, etc) from the local web server instead
of a CDN. Defaults toFalse.DAILY_REPORTS_CHART_ENABLED: Enable the use of daily chart graphs when looking at dashboard and node view.DAILY_REPORTS_CHART_DAYS: Number of days to show history for on the daily report graphs.DISPLAYED_METRICS: Metrics to show when displaying node summary. Example:'resources.total','events.noop'.TABLE_COUNT_SELECTOR: Configure the dropdown to limit number of hosts to show per page.LITTLE_TABLE_COUNT: Default number of reports to show when when looking at a node.NORMAL_TABLE_COUNT: Default number of nodes to show when displaying reports and catalog nodes.LOCALISE_TIMESTAMP: If set toTruethen timestamps are shown using your browser's timezone. Otherwise UTC is used. Defaults toTrue.WITH_EVENT_NUMBERS: If set toTruethen Overview and Nodes list shows exact number of changed resources
in the last report. Otherwise shows only 'some' string if there are resources with given status. Setting this
toFalsegives performance benefits, especially in big Puppet environments (more than few hundreds of nodes).
Defaults toTrue.ENABLE_CLASS: If set toTrueallows the user to view the number of resource events (number of changed resources in the last report) grouped by class.
The resource events are grouped by their status ('failure', 'success', 'noop').CLASS_EVENTS_STATUS_COLUMNS: A mapping between the status of the resource events and the name of the columns of the table to display.CACHE_TYPE: Specifies which type of caching object to use whenSCHEDULER_ENABLEDis set toTrue.
The cache is used for the classes view (ENABLE_CLASSis set toTrue) which requires parsing the events of all the latest reports to group them by Puppet class.
If the last report is present in the cache, we do not parse the events, which avoids unnecessary processing.
If you configure more than one worker, you must use a shared backend (e.g.MemcachedCache) to allow the sharing of the cache between the processes.
Indeed, theSimpleCachetype does not allow sharing the cache between processes, it uses the process memory to store the cache.
Defaults toSimpleCache.CACHE_DEFAULT_TIMEOUT: Cache lifetime in second. Defaults to3600.SCHEDULER_ENABLED: If set toTruethen a scheduler instance is created in order to execute scheduled jobs. Defaults toFalse.SCHEDULER_JOBS: List of the scheduled jobs to trigger within a worker.
A job can for example be used to compute a result to be cached. This is the case for the classes view which uses a job to pre-compute at regular intervals the results to be displayed.
Each scheduled job must contain the following fields:id,func,trigger,seconds.SCHEDULER_LOCK_BIND_PORT: Specifies an available port that allows a single worker to listen on it.
This allows to configure scheduled jobs in a single worker. Defaults to49100.Getting HelpFor questions or bug reports you can file anissue.ContributingDevelopmentPuppetboard relies on thepypuppetdblibrary to fetch data from PuppetDB
and is built with the help of theFlaskmicroframework.If you wish to hack on Puppetboard you should fork/clone the Github repository and then install the requirements through:pipinstall--upgradewheelsetuptools
pythonsetup.pydevelop
pipinstall--upgrade-rrequirements-test.txt
mypy--install-types--non-interactivepuppetboard/test/You're advised to do this inside a virtualenv specifically created to work on Puppetboard as to not pollute your global Python installation.You can run the tests with:pytest--cov=.--cov-report=xml--strict-markers--mypypuppetboardtestpylint--errors-onlypuppetboardtestYou can run the app it in development mode by simply executing:flaskrunYou can specify listening host and port with environment variables or command line otions:exportFLASK_RUN_HOST=0.0.0.0exportFLASK_RUN_PORT=8000flaskrunorflaskrun--host'0.0.0.0'--port'8000'UsePUPPETBOARD_SETTINGSto change the different settings or patchdefault_settings.pydirectly.
Take care not to include your local changes on that file when submitting patches for Puppetboard.
Place asettings.pyfile inside the base directory of the git repository that will be used, if the environment
variable is not set.We welcome contributions to this project. However, there are a few ground rules contributors should be aware of.LicenseThis project is licensed under the Apache v2.0 License. As such, your contributions, once accepted, are automatically
covered by this license.Commit messagesWrite decent commit messages. Don't use swear words and refrain from uninformative commit messages as 'fixed typo'.The preferred format of a commit message:docs/quickstart: Fixed a typo in the Nodes section.

If needed, elaborate further on this commit. Feel free to write a
complete blog post here if that helps us understand what this is
all about.

Fixes #4 and resolves #2.If you'd like a more elaborate guide on how to write and format your commit messages have a look atthis post
by Tim Pope.Build a releaseplease see:RELEASE.mdMore ScreenshotsOverview / Index / HomepageNodes view, all active nodesSingle node page / overviewReport viewFacts viewSingle fact, with graphsAll nodes that have this fact with that valueQuery view - results as tableQuery view - results as JSONMetrics viewSingle metricInventory viewClasses view, group the resource events of the last reports by Puppet classClass view, list the nodes with almost one resource event for a given classLegalThe app code is licensed under theApache License, Version 2.0.The favicon has been created based on the icon created byJonathan Coutiñounder theAttribution 3.0 Unported (CC BY 3.0) license,
downloaded from theNoun Project.ChangelogAll notable changes to this project will be documented in this file.v5.3.0(2024-02-07)Full ChangelogImplemented enhancements:Add favicon to radiator#1023(surdaft)Merged pull requests:Bump markupsafe from 2.1.3 to 2.1.5#1022(dependabot[bot])Bump flask from 2.3.3 to 3.0.2#1021(dependabot[bot])Bump certifi from 2023.11.17 to 2024.2.2#1019(dependabot[bot])Bump urllib3 from 2.1.0 to 2.2.0#1016(dependabot[bot])Bump pytest from 7.4.4 to 8.0.0#1015(dependabot[bot])Bump coverage from 7.4.0 to 7.4.1#1014(dependabot[bot])Bump types-setuptools from 69.0.0.20240115 to 69.0.0.20240125#1012(dependabot[bot])Bump types-requests from 2.31.0.20240106 to 2.31.0.20240125#1011(dependabot[bot])Bump bandit from 1.7.6 to 1.7.7#1009(dependabot[bot])Bump beautifulsoup4 from 4.12.2 to 4.12.3#1006(dependabot[bot])Bump types-setuptools from 69.0.0.0 to 69.0.0.20240115#1003(dependabot[bot])Bump jinja2 from 3.1.2 to 3.1.3#1002(dependabot[bot])Bump wtforms from 3.1.1 to 3.1.2#1000(dependabot[bot])Bump types-requests from 2.31.0.8 to 2.31.0.20240106#999(dependabot[bot])Bump pytest from 7.4.3 to 7.4.4#997(dependabot[bot])Bump coverage from 7.3.3 to 7.4.0#996(dependabot[bot])Bump mypy from 1.7.1 to 1.8.0#995(dependabot[bot])v5.2.0(2024-01-17)Full ChangelogImplemented enhancements:Update README for SECRET_KEY and SSL Setup#985(tuxmea)Fixed bugs:Facts only showing RedHat#961Closed issues:Make it More Apparent that SECRET_KEY cannot be blank#978Merged pull requests:also push to hub.docker.com#1004(rwaffen)Bump coverage from 7.3.2 to 7.3.3#993(dependabot[bot])Bump pylint from 3.0.2 to 3.0.3#992(dependabot[bot])Bump bandit from 1.7.5 to 1.7.6#991(dependabot[bot])Bump typing-extensions from 4.8.0 to 4.9.0#990(dependabot[bot])Bump idna from 3.4 to 3.6#987(dependabot[bot])Bump certifi from 2023.7.22 to 2023.11.17#986(dependabot[bot])Bump types-setuptools from 68.2.0.0 to 69.0.0.0#984(dependabot[bot])Bump mypy from 1.6.1 to 1.7.1#981(dependabot[bot])README: note thatSECRET_KEYcan't be empty#979(kenyon)Bump urllib3 from 2.0.7 to 2.1.0#977(dependabot[bot])Bump flask-apscheduler from 1.13.0 to 1.13.1#974(dependabot[bot])Bump wtforms from 3.1.0 to 3.1.1#973(dependabot[bot])Bump charset-normalizer from 3.3.1 to 3.3.2#972(dependabot[bot])Bump pytest from 7.4.2 to 7.4.3#971(dependabot[bot])Bump werkzeug from 3.0.0 to 3.0.1#970(dependabot[bot])Bump pylint from 3.0.1 to 3.0.2#968(dependabot[bot])Bump charset-normalizer from 3.3.0 to 3.3.1#967(dependabot[bot])Bump pytest-mock from 3.11.1 to 3.12.0#966(dependabot[bot])Add link to C3.js documentation#965(mpesari)Bump mypy from 1.6.0 to 1.6.1#964(dependabot[bot])Bump urllib3 from 2.0.6 to 2.0.7#962(dependabot[bot])Bump mypy from 1.5.1 to 1.6.0#958(dependabot[bot])Bump wtforms from 3.0.1 to 3.1.0#957(dependabot[bot])v5.1.0(2023-10-08)Full ChangelogMerged pull requests:pypuppetdb: Update 3.1.0->3.2.0#954(bastelfreak)Bump python from 3.11-alpine to 3.12-alpine#953(dependabot[bot])Bump flask-caching from 2.0.2 to 2.1.0#952(dependabot[bot])CI: Run on PRs and merges; Add dependabot for Dockerfile#951(bastelfreak)Bump pytest-pylint from 0.19.0 to 0.21.0#950(dependabot[bot])Bump pylint from 2.17.7 to 3.0.1#949(dependabot[bot])Bump types-requests from 2.31.0.7 to 2.31.0.8#948(dependabot[bot])Bump coverage from 7.3.1 to 7.3.2#947(dependabot[bot])Bump urllib3 from 2.0.4 to 2.0.6#945(dependabot[bot])Bump werkzeug from 2.3.7 to 3.0.0#944(dependabot[bot])Bump charset-normalizer from 3.2.0 to 3.3.0#943(dependabot[bot])Bump packaging from 23.1 to 23.2#941(dependabot[bot])Bump pylint from 2.17.5 to 2.17.7#940(dependabot[bot])Bump flask-wtf from 1.1.1 to 1.2.1#939(dependabot[bot])Bump types-requests from 2.31.0.2 to 2.31.0.7#938(dependabot[bot])Bump zipp from 3.16.2 to 3.17.0#932(dependabot[bot])Bump flask-apscheduler from 1.12.4 to 1.13.0#931(dependabot[bot])Bump typing-extensions from 4.7.1 to 4.8.0#930(dependabot[bot])Bump pytest from 7.4.1 to 7.4.2#928(dependabot[bot])Bump types-setuptools from 68.1.0.1 to 68.2.0.0#927(dependabot[bot])Bump coverage from 7.3.0 to 7.3.1#926(dependabot[bot])Bump pytest from 7.4.0 to 7.4.1#924(dependabot[bot])update gha#923(rwaffen)Bump types-setuptools from 68.1.0.0 to 68.1.0.1#922(dependabot[bot])Bump flask from 2.2.5 to 2.3.3#920(dependabot[bot])Bump click from 8.1.6 to 8.1.7#919(dependabot[bot])Bump mypy from 1.5.0 to 1.5.1#918(dependabot[bot])Bump pytest-randomly from 3.14.0 to 3.15.0#917(dependabot[bot])Bump types-setuptools from 68.0.0.3 to 68.1.0.0#916(dependabot[bot])Bump pytest-randomly from 3.13.0 to 3.14.0#915(dependabot[bot])Bump werkzeug from 2.3.6 to 2.3.7#914(dependabot[bot])Bump coverage from 7.2.7 to 7.3.0#913(dependabot[bot])Bump mypy from 1.4.1 to 1.5.0#911(dependabot[bot])Bump pyparsing from 3.1.0 to 3.1.1#910(dependabot[bot])v5.0.0(2023-07-27)Stop settingSECRET_KEYvalue to a random string by default. This has caused issues in deployments with more than one app replica or when the app was restarted. Please set this to your own long, random string,the same for each application replica. Implements#721.Drop support for Python 3.7 (end-of-life in June 2023). PR#899Fix broken links in Classes view. PR#868, fixes#816.Fix if fact isNone(default for full node view). PR#908, fixes#907.Dependencies update.Thanks to the following contributors of this release:Louis CharreauYehuda Katz4.3.0Add newClassesview. This view lists the Puppet classes that have had at least one of their resources changed (event). (#799).Big thanks toLouis Charreauwho contributed the above feature!4.2.6Fix auto-resize in the Radiator view in offline mode  (#718).Thanks toRené Hernandez 2ndwho contributed to this release!4.2.5Reallyfix starting the app when the SECRET_KEY is set tobytesinstead ofstr. (#741).4.2.4Fix starting the app when the SECRET_KEY is set tobytesinstead ofstr. (#741).4.2.3Sort 'uptime' fact values correctly again - it was fixed in v3.4.0 but got broken in v4.1.0 (#469).4.2.2Showing debug messages using a different color than the error messages in the Logs of the Report view. (PR#725)Start warning that the default SECRET_KET will not be provided starting with Puppetboard 5.x - see issue#721for more info. (PR#726)Thanks to the contributor of this release,Shawn Toffel!4.2.1FixLOCALISE_TIMESTAMP = Falseand document how it works. (#461)4.2.0Confirm support for Python 3.11 (final), switch the Docker image to use that version of Python.4.1.2Fixed incompatibility with Python 3.7 that has occurred at least in the tests (regression introduced in 4.1.1). (#720)4.1.1Fixed showing facts with graph (regression introduced in 4.1.0). (#719)4.1.0Show configurable favorite environments immediately after the "All Environments" in the dropdown. (#705)Automatic OS values for Linux, macOS and Windows nodes in the Inventory view. Customizable Inventory fact values using Jinja templates. PR#712, fixes#485.Big upgrade of the frontend dependencies, including migration to their maintained forks in a few cases (Semantic UI → Fomantic UI, c3.js → billboard.js). (#708)Very big thanks toMelchior NOGUESwho did most of the development for this release!4.0.5(4.0.4 was a partially incorrect release. Please use 4.0.5 instead.)Fix Puppetboard not starting on PE PuppetDB. (#711)4.0.3Make facts with integer values which are strings internally findable. (#706)Thanks toStephen Ryanwho contributed to this release!4.0.2Make the app work when installed from the git repo, f.e. using thepuppet-puppetboard module. (#704).4.0.1Fix the Docker image - make the app start again. (#701).Remove border-radius from the top menu to make it appear more clearly anchored to the page. (#699)Thanks toMarcel Deglauwho contributed to this release!4.0.0This is mostly a maintenance release.The major version is bumped because of:dropped support for PuppetDBs < 5.2.0 (Puppet 4 has reached its end-of-life in October 2018),dropped support for Python 3.6 (end-of-life in December 2021).There might be some performance improvements thanks to the upgrade of the core dependencies - Flask, Jinja2, Werkzeug etc.Additional improvements:Set custom user-agent header that will make troubleshooting easier.3.6.1Stop modifying the query response for showing as JSON (fixes#695, PR#696).3.6.0Show user-friendly error message when there's a problem with connecting to the PuppetDB and just zeros instead of HTTP 404 when the PuppetDB is just yet empty (PR #692,Add a healthcheck to the Docker image (PR #690),Fix Failures view when there are no logs (PR #693).Thanks to the following contributors of this release:@ArthurWuTW,@jcpunk,@carlosduelo.3.5.1Fixed friendly error message toggle (when there is no env in the URL) (#688).3.5.0Reportview improvements:show Logs before Events as they are more useful,show different, arguably more useful columns in Logs by default,allow showing messages in a "friendly" mode (like in Failures view),make Logs and Events filterable,don't force column sizes for a better, automatic content layout,use fixed-width font where it makes more sense,Fix mixed up normal and OFFLINE_MODE for Query view.3.4.2Fix auto-resize in radiator view,Fix Query tab cannot be disabled on DockerRemoved unused import in setup.py,Thanks to the following contributors of this release:@vilhelmprytz,@ldumont,@allan-reynolds.3.4.1Fixed broken PyPI package (#677).Made the ToC links work when the README is displayed as the description in PyPI.Thanks to the following contributors of this release:@Rewerson,@vchepkov.3.4.0Queryview improvements:Make the result clickable if a certname is in it (#652).UX improvements: show the number of results, show a user-friendly error in case of a PQL syntax error, show a warning on empty result, use fixed-width font for matching the query with the possible error message, remove useless 'Cancel' button. (#653).Add 'Download as CSV' and 'Download as XLSX' to the results (#654).Make the result shareable using URL (#657).NewFailuresview for showing the first error/failed resource for all nodes with a failed puppet run. It can show both "friendly" and raw error messages (#662).Sort 'uptime' fact values correctly (#591).Visual tweaks (#667).Improvements for running with Docker:Configurable binding host in Dockerfile (#660).Allow passing PuppetDB certificates via environment variables when using Docker, in base64 encoding or not (#671).Add Puppet code for running Puppetboard using Docker into the README (#672).Add missing fonts and icons to the PyPI package (#666).Refactoring: split views into separate files (#665).Update many dependencies.✨ Thanks to the following contributors of this release:@djluo,@GermanG,@jgrammen-agilitypr,@SeanHood,@tuxmea,@qhess34! 🌟3.3.0Show structured facts as pretty-formatted, syntax-highlighted JSON.Works on Node view and Facts view. Colors meaning are as follows: orange - number, blue - boolean, green - dict's key name. Implements#83.Fix getting nodes with non-string fact values (#612).Fix missing trailing 'u' character in facts with hashes (#567).Add favicon (#650)3.2.0Add from/till filter for reports (issue#625, PR#625)Remove tabs for disabled features (issue#627, PR#636)Add support for FreeBSD (#628)Add support for Python 3.10 (#637)Thanks to@smortexand@sebastianrakelfor their contributions!3.1.0Improve facts columns balancing (#618)Allow to toggle checkboxes by clicking their label (#617)Add support for Python 3.9 (#619)pypuppetdb: raise version requirement>=2.4.0.rc1because
we need it for Python 3.9 support3.0.0This is a bugfix and maintenance release. The major version is bumped
because of the Python 3.5 support drop.Features:Change the default sort order of facts table to a-z,
instead of z-a (#572)Revamp the README (#601)Bugfixes:Fix noop class in _macros.html (#588)Fix listing nodes with boolean fact values (#583)Fix auto-resize in radiator view (#605)Fix issue with no render when facts are empty (#607)Other:Drop Python 3.5 support (#593)Update jQuery to 3.5.1 (#592)Manage any other exception for get_or_abort (#606)Improve getting resources from CDN (#609)Migrate from Travis to GitHub Actions (#604)2.2.0Fix default table sort (#444)Use a select for endpoint select in query (#575)Surround multiline messages within reports (#576)Fix CI builds by requiring pytest >= 4.6 (#577)Add noop column in overview and nodes (#584)Add title to events labels in overview and nodes (#585)2.1.2Puppet DB 5.2.13 requires v2 metrics2.1.1Added support for new metrics APIv2on PuppetDB >=5.3.11and <6.0.0(#558)Added Python 3.5 back into test matrix (#559)Fixed bug indailyreport.jsthat caused it not to render when served under a non-default virtual host (#557)2.1.0Fixed Puppetboard's usage for the new metrics v2 API both on the home page for computing the average resources/node and theMetricslisting page. This change now supports the changes in PuppetDB >= 6.9.1 (https://puppet.com/security/cve/CVE-2020-7943/)Added backwards compatability support for both the metricv1andv2endpoints
depending on the version of the server. Any PuppetDB >=6.9.1will be queried with
thev2endpoint automatically (becausev1is disabled from here forward). Any
PuppetDB <=6.9.0will usev1.pypuppetdb: raise version requirement>=2.1.0because changes were needed in this library to support the metrics v2 fixes.app.py: Added python2 backwards compatability fix for importingurllib.2.0.0Dockerfile: Switch to python:3.7-alpine imagepypuppetdb: raise version requirement>=1.2.0to>=2.0.0Drop support for python2.7 and python3.5 & Add python3.8 to buildmatrixUpgrade of tests requirements + resolving current deprecation warningsIgnore facts environment for compatibility and performanceAdding mypy + Cleanup + CommonMark upgrade to 0.9.1Update docker and fix coveralls not running.Cast inventory data toString1.1.0Move to Python 3.6 for DockerFix problem loading daily chart on node pagefix gunicorn parameter and allow to define workers in dockerAdd feature for better performance in big Puppet envsbundle requirements.txt for tests and docker1.0.0CI enhancementsAllow to configure which PuppetDB endpoints are allowedUpdate c3 to 4.22Add basic health check endpointAllow to force the PuppetDB connection protocolUpdate jquery-tablesort to 0.0.11Fix bug breaking date/time sortFix formatvalue for list of dictsModify date sort to handle failedInclude template files for altering Semantic css and Google fontsMake 320px the max width for columnsIf query is None don't perform add on itQuery using producer_timestamp index vs. start_timeAdd missing components for building source packagesAdd support for URL prefixes to Docker image0.3.0Core UI ReworkUpdate to pypuppetdb 0.3.3Fix sorty on data for indexUpdate debian documentationOffline mode fixFix fact attribute error on pathsEnhanced testingRadiator CSS uses same coloringMarkdown in config versionUpdate FlaskCleanup requirements.txtUpdate package maintainer for OpenBSD0.2.1Daily ChartsFixed missing javascript files on radiator view.TravisCI and Coveralls integration.Fixed app crash in catalog view.Upgrade pypuppetdb to 0.3.2Enhanced queries for Node and Report (#271)Optimize Inventory Code.Use certname instead of hostname to identify nodes when applicable.Add environment filter for facts.Update cs.js to 0.4.11Fix radiator column alignmentSecurity checks with banditDockerfile now uses gunicorn and environment variables for configuration.Handle division by zero errors.Implement new Jquery Datatables.JSON output for radiator. * Move javascript to head tag.Optimize reports and node page queries.Fix all environments for PuppetDB 3.2Fact graph chart now configurable.Support for Flask 0.12 and Jinja2 2.9Fix misreporting noops as changes.0.2.0Full support for PuppetDB 4.xUpdating Semantic UI to 2.1.8Updating Flask-WTF requirements to 0.12Updating WTForms to 2.xRestored CSRF protection on the Query Tab formUpdating Pypuppetdb requirement to 0.3.xNew configuration option OVERVIEW_FILTER allows users to add custom PuppetDB query clauses to include/exclude nodes displayed on the index pageAdding Radiator view similar to what is available in Puppet DashboardAdding a drop-down list in the Reports tab to configure the number of reports displayedRemoving unneeded report_latest() endpoint. This endpoint was deprecated with the addition of the latest_report_hash field in the Nodes PuppetDB endpointEnhancing Report paginationUsing the OOP Query Builder available in Pypuppetdb 0.3.xAllowing PQL queries in the Query TabFixing double url-quoting bug on Metric endpodint callsAdding a Boolean field to the Query form to prettyprint responses from PuppetDBFixing corner-case where empty environments would trigger a ZeroDivisionError due to the Number of Nodes divided by the Number of Resources calculationAdding additional logging in utils.py0.1.2Add 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 informationavailable 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 sections0.1.1Fix bug where the reports template was not generating the report links with the right environment0.1.0Requires pypuppetdb >= 0.2.0Drop support for PuppetDB 2 and earlierFull support for PuppetDB 3.xThe 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 NavBarUsing 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 totemplates/_macros.htmlstatus_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.Removinglimit_reportsfromutils.pybecause this helper function has been replaced by the limit PuppetDB paging function.Known Issuesfact_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.5Now requires WTForms versions less than 2.0Adding a Flask development server indev.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.4Fix the sorting of the different tables containing facts.Fix the license in oursetup.py. The license shouldn't be longer than 200 characters. We were including the full license tripping up tools like bdist_rpm.0.0.3This 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_SSLis gone and replaced byPUPPETDB_SSL_VERIFYwhich now defaults toTrue. This only affects connections to PuppetDB that happen over SSL.SSL is automatically enabled if bothPUPPETDB_CERTandPUPPETDB_KEYare 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 calledUNRESPONSIVE_HOURShas 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 to2hours.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.2In 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_EXPERIMENTALTwo new settings have been added:PUPPETDB_API: an integer, defaulting to3, representing the API version we want to use.ENABLE_QUERY: a boolean, defaulting toTrue, 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.1Initial release.*This Changelog was automatically generated bygithub_changelog_generator