Version information
Start using this module
Add this module to your Puppetfile:
mod 'dalen-puppetdbquery', '1.3.2'
Learn more about managing modules with a PuppetfileDocumentation
PuppetDB query tools
This module implements command line tools and Puppet functions that can be used to query puppetdb. There's also a hiera backend that can be used to return query results from puppetdb.
Query format
The query format accepts resource references in the form:
Type[Name]{attribute1=foo and attribute2=bar}
Each of the three parts are optional. It will only match non exported resources by default, to match exported resources ad @@ in front.
Facts can be matched using the operators =, !=, >, < and ~ (regexp match). > and < only work on numbers, ~ only works on strings.
Any expression can be combined using "not", "and" or "or", in that precedence order. To change precedence you can use parenthesis.
Alphanumeric strings don't need to be quoted, but can be quoted using double quotes with the same escaping rules as JSON. Numbers are interpreted as numbers and true/false as boolean values, to use them as strings instead simply quote them.
Installation
Ensure that the lib directory is in Ruby's LOADPATH.
$ export RUBYLIB=puppet-puppetdbquery/lib:$RUBYLIB
PuppetDB terminus is required for the Puppet functions, but not the face.
Usage
To get a list of the supported subcommands for the query face, run:
$ puppet help query
You can run puppet help
on the returned subcommands
$ puppet help query nodes
$ puppet help query facts
CLI
Each of the faces uses the following query syntax to return all objects found on a subset of nodes:
# get all nodes that contain the apache package and are in france, or all nodes in the us
$ puppet query nodes (Package[httpd] and country=fr) or country=us)'
Each of the individual faces returns a different data format:
nodes - a list of nodes identified by a name
$ puppet query nodes '(Package["mysql-server"] and architecture=amd64)'
["db_node_1", "db_node2"]
facts - a hash of facts per node
$ puppet query facts '(Package["mysql-server"] and architecture=amd64)'
db_node_1 {"facterversion":"1.6.9","hostname":"controller",...........}
db_node_2 {"facterversion":"1.6.9","hostname":"controller",...........}
events - a list of events on the matched nodes
$ puppet query events '(Package["mysql-server"] and architecture=amd64)' --since='1 hour ago' --until=now --status=success
host.example.com: 2013-06-10T10:58:37.000Z: File[/foo/bar]/content ({md5}5711edf5f5c50bd7845465471d8d39f0 -> {md5}e485e731570b8370f19a2a40489cc24b): content changed '{md5}5711edf5f5c50bd7845465471d8d39f0' to '{md5}e485e731570b8370f19a2a40489cc24b'
Ruby
faces can be called from the ruby in exactly they same way they are called from the command line:
$ irb> require 'puppet/face'
irb> Puppet::Face[:query, :current].nodes(:query => '(Package["mysql-server"] and architecture=amd64)')
Puppet functions
There's corresponding functions to query PuppetDB directly from Puppet manifests.
query_nodes
Accepts two arguments, a query used to discover nodes, and a optional fact that should be returned.
Returns an array of certnames or fact values if a fact is specified.
Examples
$hosts = query_nodes('manufacturer~"Dell.*" and processorcount=24 and Class[Apache]')
$hostips = query_nodes('manufacturer~"Dell.*" and processorcount=24 and Class[Apache]', ipaddress)
query_facts
Similar to query_nodes but takes two arguments, the first is a query used to discover nodes, the second is a list of facts to return for those nodes.
Returns a nested hash where the keys are the certnames of the nodes, each containing a hash with facts and fact values.
Example
query_facts('Class[Apache]{port=443}', ['osfamily', 'ipaddress'])
Example return value in JSON format:
{ "foo.example.com": { "ipaddress": "192.168.0.2", "osfamily": "Redhat" }, "bar.example.com": { "ipaddress": "192.168.0.3", "osfamily": "Debian" } }
Hiera backend
The hiera backend can be used to return an array with results from a puppetdb query. It requires another hiera backend to be active at the same time, and that will be used to define the actual puppetdb query to be used. It does not matter which backend that is, there can even be several of them. To enable add the backend puppetdb
to the backends list in hiera.yaml
.
So instead of writing something like this in for example your hiera-data/common.yaml
:
ntp::servers:
- 'ntp1.example.com'
- 'ntp2.example.com'
You can now instead write:
ntp::servers::_nodequery: 'Class[Ntp::Server]'
It will then find all nodes with the class ntp::server and return an array containing their certname. If you instead want to return the value of a fact, for example the ipaddress
, the nodequery can be a tuple, like:
ntp::servers::_nodequery: ['Class[Ntp::Server]', 'ipaddress']
or a hash:
ntp::servers::_nodequery:
query: 'Class[Ntp::Server]'
fact: 'ipaddress'
When returning facts only nodes that actually have the fact are returned, even if more nodes would in fact match the query itself.
Deprecated PuppetDB query functions
This module also contains some older deprecated functions that use the raw version 1 PuppetDB API. They require the json ruby gem and the puppetdb-terminus.
Only queries over HTTPS are supported atm.
Usage
pdbresourcequery
The first argument is the resource query. Second argument is optional but allows you to specify the item you want from the returned hash.
It automatically excludes deactivated hosts.
Returns an array of hashes or array of strings if second argument is provided.
Examples
# Return an array of hashes describing all files that are owned by root on active hosts.
$ret = pdbresourcequery(
['and',
['=','type','File'],
['=',['parameter','owner'],'root']])
# Return an array of host names having those resources
$ret = pdbresourcequery(
['and',
['=',['node','active'],true],
['=','type','File'],
['=',['parameter','owner'],'root']], 'certname')
pdbresourcequery_all
Works exactly like pdbresourcequery but also returns deactivated hosts.
pdbnodequery
The first argument is the node query. Second argument is optional but allows you to specify a resource query that the nodes returned also have to match.
It automatically excludes deactivated hosts.
Returns a array of strings with the certname of the nodes (fqdn by default).
Examples
# Return an array of active nodes with an uptime more than 30 days
$ret = pdbnodequery(['>',['fact','uptime_days'],30])
# Return an array of active nodes with an uptime more than 30 days and
# having the class 'apache'
$ret = pdbnodequery(
['>',['fact','uptime_days'],30],
['and',
['=','type','Class'],
['=','title','Apache']])
pdbnodequery_all
Works exactly like pdbnodequery but also returns deactivated hosts.
pdbfactquery
The first argument is the node to get facts for. It can be either a single node or an array of nodes. If it is an array the return value of the function will also be an array. Second argument is optional, if specified only return that specific fact.
Examples
# Get hash of facts for foo.example.com
pdbfactquery('foo.example.com')
# Get the uptime fact for foo.example.com
pdbfactquery('foo.example.com', 'uptime')
# Get the uptime fact for foo.example.com and bar.example.com
pdbfactquery(['foo.example.com', 'bar.example.com'], 'uptime')
pdbstatusquery
The first argument is the node to get the status for. Second argument is optional, if specified only return that specific bit of status, one of 'name', 'deactivated', 'catalog_timestamp' and 'facts_timestamp'.
Returns an array of hashes or a array of strings if second argument is supplied.
Examples
# Get status for foo.example.com
pdbstatusquery('foo.example.com')
# Get catalog_timestamp for foo.example.com
pdbstatusquery('foo.example.com', 'catalog_timestamp')
pdbquery
This is the generic query function that the others make use of, you probably don't have to use it and can use one of the specific functions below instead.
The first argument is the URL path that should be queried, for example 'nodes' or 'status/nodes/'. The second argument if supplied if the query parameter, if it is a string it is assumed to be JSON formatted and sent as is, anything else is converted to JSON and then sent.
Examples
# Get list of all active nodes
$ret = pdbquery('nodes', ['=', ['node', 'active'], true ])
# Query status of current node
$ret2 = pdbquery("status/nodes/${settings::certname}")
See http://docs.puppetlabs.com/puppetdb for more info and examples about the PuppetDB API.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.