Python library for working with the PuppetDB API
Clone or download
dwoldenberg1 and mterzo QueryBuilder: Added support for FromOperator, arrays and FromOperator…
… with InOperator (#139)

* added support for [in, <array>] and unit tests
Latest commit cedeecf Jul 30, 2018

README.rst

pypuppetdb

https://api.travis-ci.org/voxpupuli/pypuppetdb.png https://coveralls.io/repos/voxpupuli/pypuppetdb/badge.png

pypuppetdtb is a library to work with PuppetDB's REST API. It is implemented using the `requests`_ library. .. _requests: http://docs.python-requests.org/en/latest/

pypuppetdb >= 0.2.0 requires PuppetDB 3.0.0 or later. There is no support for previous versions beyond 0.1.1

pypuppetdb >= 0.2.2 supports PuppetDB 4.0.0. Backwards compatibility with 3.x is available.

This library is a thin wrapper around the REST API providing some convenience functions and objects to request and hold data from PuppetDB.

To use this library you will need:
  • Python 2.6 or 2.7
  • Python 3.3

Installation

You can install this package from source or from PyPi.

$ pip install pypuppetdb
$ git clone https://github.com/voxpupuli/pypuppetdb
$ python setup.py install

If you wish to hack on it clone the repository but after that run:

$ pip install -r requirements.txt

This will install all the runtime requirements of pypuppetdb and the dependencies for the test suite and generation of documentation.

Packages

Native packages for your operating system will be provided in the near future.

OS Status  
Debian 6/Squeeze planned Requires Backports
Debian 7/Wheezy planned  
Ubuntu 13.04 planned  
Ubuntu 13.10 planned  
CentOS/RHEL 5 n/a Python 2.4
CentOS/RHEL 6 planned  
CentOS/RHEL 7 planned  
ArchLinux available Maintained by Tim Meusel
OpenBSD available Maintained by Jasper Lievisse Adriaanse

Usage

Once you have pypuppetdb installed you can configure it to connect to PuppetDB and take it from there.

Connecting

The first thing you need to do is to connect with PuppetDB:

>>> from pypuppetdb import connect
>>> db = connect()

Nodes

The following will return a generator object yielding Node objects for every returned node from PuppetDB.

>>> nodes = db.nodes()
>>> for node in nodes:
>>>   print(node)
host1
host2
...

To query a single node the singular node() can be used:

>>> node = db.node('hostname')
>>> print(node)
hostname

Node scope

The Node objects are a bit more special in that they can query for facts and resources themselves. Using those methods from a node object will automatically add a query to the request scoping the request to the node.

>>> node = db.node('hostname')
>>> print(node.fact('osfamily'))
osfamily/hostname

Facts

>>> facts = db.facts('osfamily')
>>> for fact in facts:
>>>   print(fact)
osfamily/host1
osfamily/host2

That queries PuppetDB for the 'osfamily' fact and will yield Fact objects, one per node this fact is known for.

Resources

>>> resources = db.resources('file')

Will return a generator object containing all file resources you're managing across your infrastructure. This is probably a bad idea if you have a big number of nodes as the response will be huge.

Catalogs

>>> catalog = db.catalog('hostname')
>>> for res in catalog.get_resources():
>>>     print(res)

Will return a Catalog object with the latest Catalog of the definded host. This catalog contains the defined Resources and Edges.

>>> catalog = db.catalog('hostname')
>>> resource = catalog.get_resource('Service','ntp')
>>> for rel in resource.relationships:
>>>     print(rel)
Class[Ntp] - contains - Service[ntp]
File[/etc/ntp.conf] - notifies - Service[ntp]
File[/etc/ntp.conf] - required-by - Service[ntp]

Will return all Relationships of a given Resource defined by type and title. This will list all linked other Resources and the type of relationship.

Query Builder

Starting with version 0.3.0 pypuppetdb comes shipped with a QueryBuilder component that, as the name suggests, allows users to build PuppetDB AST queries in an Object-Oriented fashion. Vastly superior to constructing long strings than adding additional clauses to fulfill new requirements.

The following code will build a query for the Nodes endpoint to find all nodes belonging to the production environment.

>>> from pypuppetdb.QueryBuilder import *
>>> op = AndOperator()
>>> op.add(EqualsOperator('catalog_environment', 'production'))
>>> op.add(EqualsOperator('facts_environment', 'production'))
>>> print(op)
["and",["=", "catalog_environment", "production"],["=", "facts_environment", "production"]]

This functionality is based on the PuppetDB AST query string syntax documented here.

Subqueries are implemented using corresponding operators (like documented).

  • SubqueryOperator
  • InOperator
  • ExtractOperator
>>> from pypuppetdb.QueryBuilder import *
>>> op = InOperator('certname')
>>> ex = ExtractOperator()
>>> ex.add_field(str('certname'))
>>> sub = SubqueryOperator('events')
>>> sub.add_query(EqualsOperator('status', 'noop'))
>>> ex.add_query(sub)
>>> op.add_query(ex)
>>> print(op)
["in","certname",["extract",["certname"],["select_events",["=", "status", "noop"]]]]

Or using [in <array>] querying:

>>> from pypuppetdb.QueryBuilder import *
>>> op = InOperator('certname')
>>> op.add_array(["prod1.server.net", "prod2.server.net"])
>>> print(op)
["in","certname",["array", ['prod1.server.net', 'prod2.server.net']]]

You can also access different entities from a single query on the root endpoint with the FromOperator:

>>> op = InOperator('certname')
>>> ex = ExtractOperator()
>>> ex.add_field('certname')
>>> fr = FromOperator('fact_contents')
>>> nd = AndOperator()
>>> nd.add(EqualsOperator("path", ["networking", "eth0", "macaddresses", 0]))
>>> nd.add(EqualsOperator("value", "aa:bb:cc:dd:ee:00"))
>>> ex.add_query(nd)
>>> fr.add_query(ex)
>>> op.add_query(fr)
>>> print(op)
["in","certname",["from","fact_contents",["extract",["certname"],["and",["=", "path", ['networking', 'eth0', 'macaddresses', 0]],["=", "value", "aa:bb:cc:dd:ee:00"]]]]]

Getting Help

This project is still very new so it's not inconceivable you'll run into issues.

For bug reports you can file an issue. If you need help with something feel free to pop by #voxpupuli on Freenode or the #puppetboard channel.

Documentation

API documentation is automatically generated from the docstrings using Sphinx's autodoc feature.

Documentation will automatically be rebuilt on every push thanks to the Read The Docs webhook. You can find it here.

You can build the documentation manually by doing:

$ cd docs
$ make html

Doing so will only work if you have Sphinx installed, which you can achieve through:

$ pip install -r requirements.txt

Contributing

We welcome contributions to this library. 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.

Copyright (c) 2013-2014 Daniele Sluijters

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.

Tests

Commits are expected to contain tests or updates to tests if they add to or modify the current behavior.

The test suite is powered by pytest and requires pytest, pytest-pep8, httpretty and pytest-httpretty which will be installed for you if you run:

$ pip install -r requirements.txt

To run the unit tests (the ones that don't require a live PuppetDB):

$ py.test -v -m unit

If the tests pass, you're golden. If not we'll have to figure out why and fix that. Feel free to ask for help on this.