Package Health Score

78 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Active

Popularity

Recognized

GitHub Stars: 708
Forks: 238
Contributors: 110

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package puppetboard, we found that it has been starred 708 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Mar 1, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like puppetboard is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 50
Open PR: 16
Last Release: 9 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of puppetboard based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that puppetboard demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 110
Funding: Yes

A good and healthy external contribution signal for puppetboard project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8.0

Age: 11 years
Latest Release: 9 months ago
Dependencies: 21 Direct
Versions: 73
Maintainers: 2
Wheels: OS Independent

Not sure how to use puppetboard?

To help you get started, we've collected the most common ways that puppetboard is being used within popular public projects.

voxpupuli / puppetboard / test / test_utils.py View on Github

def test_get():
    x = "hello world"

    def test_get_or_abort():
        return x

    assert x == utils.get_or_abort(test_get_or_abort)

View more ways to use puppetboard

Puppetboard

Tests Status

Puppetboard is a web interface to PuppetDB aiming to replace the reporting functionality of Puppet Enterprise console (previously: Puppet Dashboard) for the open source Puppet.

Overview

See more screenshots here.

Requirements

PuppetDB v. 5.2-8.*
- (Note: PuppetDB 8.1.0 is not supported because of this bug. Please update to 8.1.1+.)
Python 3.8-3.11 or Docker

Installation

Puppetboard is packaged and available on PyPI.

With Puppet module

There is a Puppet module originally written by Spencer Krum and currently maintained by Voxpupuli that takes care of installing the Puppetboard for you.

To see how to get it working with RedHat/Centos 7 check out these docs.

Using Docker

We provide an official Docker image in the GitHub Container Registry.

You must provide a secret key! Generate one for example by running ruby -e "require 'securerandom'; puts SecureRandom.hex(32)".

You can run the app on your PuppetDB host with this command:

docker run -it \
  -e PUPPETDB_HOST=localhost \
  -e PUPPETDB_PORT=8080 \
  -e SECRET_KEY=XXXXXXXX \
  --net=host \
  ghcr.io/voxpupuli/puppetboard

Optionally you can set PUPPETBOARD_URL_PREFIX env variable to a value like /puppetboard to run the app under a URL prefix.

You can use the following Puppet Code to have Puppetboard managed by Puppet:

include docker

docker::image { 'ghcr.io/voxpupuli/puppetboard': }

docker::run { 'puppetboard':
  image =&gt; 'ghcr.io/voxpupuli/puppetboard',
  env   =&gt; [
    'PUPPETDB_HOST=127.0.0.1',
    'PUPPETDB_PORT=8080',
    'PUPPETBOARD_PORT=8088',
    'SECRET_KEY=XXXXXXXX',
  ],
  net   =&gt; 'host',
}

If you want to have all features enabled, you must use SSL talking to PuppetDB:

file { '/etc/puppetboard':
  ensure =&gt; directory,
}
file { '/etc/puppetboard/key.pem':
  ensure =&gt; file,
  mode   =&gt; '0644',
  source =&gt; "/etc/puppetlabs/puppet/ssl/private_keys/${facts['networking']['fqdn']}.pem",
}
file { '/etc/puppetboard/cert.pem':
  ensure =&gt; file,
  mode   =&gt; '0644',
  source =&gt; "/etc/puppetlabs/puppet/ssl/certs/${facts['networking']['fqdn']}.pem",
}

include docker

docker::image { 'ghcr.io/voxpupuli/puppetboard': }

docker::run { 'puppetboard':
  image   =&gt; 'ghcr.io/voxpupuli/puppetboard',
  volumes =&gt; ['/etc/puppetboard:/etc/puppetboard:ro'],
  env     =&gt; [
    '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     =&gt; 'host',
}

Within an air gapped environment you want to load all content from your local puppetboard web service. Add: 'OFFLINE_MODE=true', to the env parameter list of the docker::run Puppet type.

We also provide the Dockerfile, so you can build the image yourself:

docker build -t puppetboard .

From a package

Actively maintained packages:

FreeBSD maintained by Romain Tartière
OpenBSD maintained by Sebastian Reitenbach

Manually

You 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 -p python3 venv
. venv/bin/activate
pip install puppetboard

Please see an article about more deployment setups here.

Configuration

Puppet agents

The default value of usecacheonfailure = true configuration 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 set usecacheonfailure = false in your nodes' puppet.conf.

PuppetDB

Of 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 the PuppetDB documentation about 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 the PuppetDB documentation here.

App settings

Puppetboard will look for a file pointed at by the PUPPETBOARD_SETTINGS environment variable. The file has to be identical to default_settings.py but 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_HOST
PUPPETDB_PORT

By 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 = True
PUPPETDB_KEY = /path/to/private/keyfile.pem
PUPPETDB_CERT = /path/to/public/keyfile.crt

When 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 the pypuppetdb documentation. Alternatively it is possible to explicitly specify the protocol to be used setting the PUPPETDB_PROTO variable.

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 to Flask 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: friendly or raw. 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 to friendly.
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 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. See ENABLED_QUERY_ENDPOINTS to fine-tune which endpoints are allowed.
ENABLED_QUERY_ENDPOINTS: If ENABLE_QUERY is True, 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 the QUERY_ENDPOINTS constant in the puppetboard.app module 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 documentation
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.
INVENTORY_FACT_TEMPLATES: A mapping between fact name and jinja template to customize display
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, etc) from the local web server instead of a CDN. Defaults to False.
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 to True then timestamps are shown using your browser's timezone. Otherwise UTC is used. Defaults to True.
WITH_EVENT_NUMBERS: If set to True then 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 to False gives performance benefits, especially in big Puppet environments (more than few hundreds of nodes). Defaults to True.
ENABLE_CLASS: If set to True allows 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 when SCHEDULER_ENABLED is set to True. The cache is used for the classes view (ENABLE_CLASS is set to True) 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, the SimpleCache type does not allow sharing the cache between processes, it uses the process memory to store the cache. Defaults to SimpleCache.
CACHE_DEFAULT_TIMEOUT: Cache lifetime in second. Defaults to 3600.
SCHEDULER_ENABLED: If set to True then a scheduler instance is created in order to execute scheduled jobs. Defaults to False.
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 to 49100.

Getting Help

For questions or bug reports you can file an issue.

Contributing

Development

Puppetboard relies on the pypuppetdb library to fetch data from PuppetDB and is built with the help of the Flask microframework.

If you wish to hack on Puppetboard you should fork/clone the Github repository and then install the requirements through:

pip install --upgrade wheel setuptools
python setup.py develop
pip install --upgrade -r requirements-test.txt
mypy --install-types --non-interactive puppetboard/ 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 --mypy puppetboard test
pylint --errors-only puppetboard test

You can run the app it in development mode by simply executing:

flask run

You can specify listening host and port with environment variables or command line otions:

export FLASK_RUN_HOST=0.0.0.0
export FLASK_RUN_PORT=8000

flask run

flask run --host '0.0.0.0' --port '8000'

Use PUPPETBOARD_SETTINGS to change the different settings or patch default_settings.py directly. Take care not to include your local changes on that file when submitting patches for Puppetboard. Place a settings.py file 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.

License

This project is licensed under the Apache v2.0 License. As such, your contributions, once accepted, are automatically covered by this license.

Commit messages

Write 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 at this post by Tim Pope.

Build a release

please see: RELEASE.md

More Screenshots

Overview / Index / Homepage

Overview / Index / Homepage

Nodes view, all active nodes

Nodes view, all active nodes

Single node page / overview

Single node page / overview

Report view

Report view

Facts view

Facts view

Single fact, with graphs

Single fact, with graphs

All nodes that have this fact with that value

All nodes that have this fact with that value

Query view - results as table

Query view

Query view - results as JSON

Query view

Metrics view

Metrics view

Single metric

Single metric

Inventory view

Inventory view

Classes view, group the resource events of the last reports by Puppet class

Classes view

Class view, list the nodes with almost one resource event for a given class

Class view

Legal

The app code is licensed under the Apache License, Version 2.0.

The favicon has been created based on the icon created by Jonathan Coutiño under the Attribution 3.0 Unported (CC BY 3.0) license, downloaded from the Noun Project.

Changelog

All notable changes to this project will be documented in this file.

v5.4.0 (2024-03-01)

Full Changelog

Merged pull requests:

Bump types-setuptools from 69.0.0.20240125 to 69.1.0.20240301 #1048 (dependabot[bot])
Bump pylint from 3.0.3 to 3.1.0 #1043 (dependabot[bot])
Bump coverage from 7.4.1 to 7.4.3 #1042 (dependabot[bot])
Bump pytest from 8.0.0 to 8.0.2 #1041 (dependabot[bot])
Bump typing-extensions from 4.9.0 to 4.10.0 #1040 (dependabot[bot])
Bump types-requests from 2.31.0.20240125 to 2.31.0.20240218 #1036 (dependabot[bot])
Bump urllib3 from 2.2.0 to 2.2.1 #1033 (dependabot[bot])

v5.3.0 (2024-02-07)

Full Changelog

Implemented 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 Changelog

Implemented enhancements:

Update README for SECRET_KEY and SSL Setup #985 (tuxmea)

Fixed bugs:

Facts only showing RedHat #961

Closed issues:

Make it More Apparent that SECRET_KEY cannot be blank #978

Merged 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 that SECRET_KEY can'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 Changelog

Merged 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 setting SECRET_KEY value 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 #899
Fix broken links in Classes view. PR #868, fixes #816.
Fix if fact is None (default for full node view). PR #908, fixes #907.
Dependencies update.

Thanks to the following contributors of this release:

4.3.0

Add new Classes view. This view lists the Puppet classes that have had at least one of their resources changed (event). (#799).

Big thanks to Louis Charreau who contributed the above feature!

4.2.6

Fix auto-resize in the Radiator view in offline mode (#718).

Thanks to René Hernandez 2nd who contributed to this release!

4.2.5

Really fix starting the app when the SECRET_KEY is set to bytes instead of str. (#741).

4.2.4

Fix starting the app when the SECRET_KEY is set to bytes instead of str. (#741).

4.2.3

Sort 'uptime' fact values correctly again - it was fixed in v3.4.0 but got broken in v4.1.0 (#469).

4.2.2

Showing 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 #721 for more info. (PR #726)

Thanks to the contributor of this release, Shawn Toffel!

4.2.1

Fix LOCALISE_TIMESTAMP = False and document how it works. (#461)

4.2.0

Confirm support for Python 3.11 (final), switch the Docker image to use that version of Python.

4.1.2

Fixed incompatibility with Python 3.7 that has occurred at least in the tests (regression introduced in 4.1.1). (#720)

4.1.1

Fixed showing facts with graph (regression introduced in 4.1.0). (#719)

4.1.0

Show 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 to Melchior NOGUES who 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.3

Make facts with integer values which are strings internally findable. (#706)

Thanks to Stephen Ryan who contributed to this release!

4.0.2

Make the app work when installed from the git repo, f.e. using the puppet-puppetboard module. (#704).

4.0.1

Fix 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 to Marcel Deglau who contributed to this release!

4.0.0

This 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.1

Stop modifying the query response for showing as JSON (fixes #695, PR #696).

3.6.0

Show 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.1

Fixed friendly error message toggle (when there is no env in the URL) (#688).

3.5.0

Report view 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.2

Fix auto-resize in radiator view,
Fix Query tab cannot be disabled on Docker
Removed unused import in setup.py,

Thanks to the following contributors of this release: @vilhelmprytz, @ldumont, @allan-reynolds.

3.4.1

Fixed 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.0

Query view 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).
New Failures view 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.0

Show 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.0

Add 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 @smortex and @sebastianrakel for their contributions!

3.1.0

Improve 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.rc1 because we need it for Python 3.9 support

3.0.0

This 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.0

Fix default table sort (#444)
Use a select for endpoint select in query (#575)
Surround multiline messages with
```
 in 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.2

Puppet DB 5.2.13 requires v2 metrics

2.1.1

Added support for new metrics API v2 on PuppetDB >= 5.3.11 and < 6.0.0 (#558)
Added Python 3.5 back into test matrix (#559)
Fixed bug in dailyreport.js that caused it not to render when served under a non-default virtual host (#557)

2.1.0

Fixed Puppetboard's usage for the new metrics v2 API both on the home page for computing the average resources/node and the Metrics listing 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 metric v1 and v2 endpoints depending on the version of the server. Any PuppetDB >= 6.9.1 will be queried with the v2 endpoint automatically (because v1 is disabled from here forward). Any PuppetDB <= 6.9.0 will use v1.
pypuppetdb: raise version requirement >=2.1.0 because changes were needed in this library to support the metrics v2 fixes.
app.py: Added python2 backwards compatability fix for importing urllib.

2.0.0

Dockerfile: Switch to python:3.7-alpine image
pypuppetdb: raise version requirement >=1.2.0 to >=2.0.0
Drop support for python2.7 and python3.5 & Add python3.8 to buildmatrix
Upgrade of tests requirements + resolving current deprecation warnings
Ignore facts environment for compatibility and performance
Adding mypy + Cleanup + CommonMark upgrade to 0.9.1
Update docker and fix coveralls not running.
Cast inventory data toString

1.1.0

Move to Python 3.6 for Docker
Fix problem loading daily chart on node page
fix gunicorn parameter and allow to define workers in docker
Add feature for better performance in big Puppet envs
bundle requirements.txt for tests and docker

1.0.0

CI enhancements
Allow to configure which PuppetDB endpoints are allowed
Update c3 to 4.22
Add basic health check endpoint
Allow to force the PuppetDB connection protocol
Update jquery-tablesort to 0.0.11
Fix bug breaking date/time sort
Fix formatvalue for list of dicts
Modify date sort to handle failed
Include template files for altering Semantic css and Google fonts
Make 320px the max width for columns
If query is None don't perform add on it
Query using producer_timestamp index vs. start_time
Add missing components for building source packages
Add support for URL prefixes to Docker image

0.3.0

Core UI Rework
Update to pypuppetdb 0.3.3
Fix sorty on data for index
Update debian documentation
Offline mode fix
Fix fact attribute error on paths
Enhanced testing
Radiator CSS uses same coloring
Markdown in config version
Update Flask
Cleanup requirements.txt
Update package maintainer for OpenBSD

0.2.1

Daily Charts
Fixed missing javascript files on radiator view.
TravisCI and Coveralls integration.
Fixed app crash in catalog view.
Upgrade pypuppetdb to 0.3.2
Enhanced 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.11
Fix radiator column alignment
Security checks with bandit
Dockerfile 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.2
Fact graph chart now configurable.
Support for Flask 0.12 and Jinja2 2.9
Fix misreporting noops as changes.

0.2.0

Full support for PuppetDB 4.x
Updating Semantic UI to 2.1.8
Updating Flask-WTF requirements to 0.12
Updating WTForms to 2.x
Restored CSRF protection on the Query Tab form
Updating Pypuppetdb requirement to 0.3.x
New configuration option OVERVIEW_FILTER allows users to add custom PuppetDB query clauses to include/exclude nodes displayed on the index page
Adding Radiator view similar to what is available in Puppet Dashboard
Adding a drop-down list in the Reports tab to configure the number of reports displayed
Removing unneeded report_latest() endpoint. This endpoint was deprecated with the addition of the latest_report_hash field in the Nodes PuppetDB endpoint
Enhancing Report pagination
Using the OOP Query Builder available in Pypuppetdb 0.3.x
Allowing PQL queries in the Query Tab
Fixing double url-quoting bug on Metric endpodint calls
Adding a Boolean field to the Query form to prettyprint responses from PuppetDB
Fixing corner-case where empty environments would trigger a ZeroDivisionError due to the Number of Nodes divided by the Number of Resources calculation
Adding additional logging in utils.py

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

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.

* This Changelog was automatically generated by github_changelog_generator

FAQs

What is puppetboard?

Web frontend for PuppetDB. Visit Snyk Advisor to see a full health score report for puppetboard, including popularity, security, maintenance & community analysis.

Is puppetboard popular?

The python package puppetboard receives a total of 1,154 weekly downloads. As such, puppetboard popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is puppetboard well maintained?

We found indications that puppetboard maintenance is sustainable demonstrating some project activity. We saw a total of 110 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is puppetboard safe to use?

The python package puppetboard was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 12 November-2024, at 05:19 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Not sure how to use puppetboard?

Puppetboard

Table of Contents

Requirements

Installation

With Puppet module

Using Docker

From a package

Manually

Configuration

Puppet agents

PuppetDB

App settings

Getting Help

Contributing

Development

License

Commit messages

Build a release

More Screenshots

Legal

Changelog

v5.4.0 (2024-03-01)

v5.3.0 (2024-02-07)

v5.2.0 (2024-01-17)

v5.1.0 (2023-10-08)

v5.0.0 (2023-07-27)

4.3.0

4.2.6

4.2.5

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.2

4.1.1

4.1.0

4.0.5

4.0.3

4.0.2

4.0.1

4.0.0

3.6.1

3.6.0

3.5.1

3.5.0

3.4.2

3.4.1

3.4.0

3.3.0

3.2.0

3.1.0

3.0.0

2.2.0

2.1.2

2.1.1

2.1.0

2.0.0

1.1.0

1.0.0

0.3.0

0.2.1

0.2.0

0.1.2

0.1.1

0.1.0

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1