hc \- Command line tool for Hieracles

.B hc

.I fqdn

.I action

.B [

.I options

.B ]

.PP

Hieracles is a command-line tool for analysis and deep examination

of Hiera parameters in a Puppet setup. It can be used to quickly

visualize, from a local puppet (typically on a developers

environment), all the Hiera params related to a specific node.

.PP

It's used internally at Gandi and its first incarnation is strongly

tied to Gandi puppet architecture. But Hieracles tends to become, in

time, a generic Hiera overlay visualization tool.

.PP

hc command takes at minimum 2 arguments:

.RS 4

.IP fqdn 10

the fqdn under which the node is known in the ENC dir

.IP action

the action needs to be one of the following

.RS

.IP info 10

provides the farm, datacenter, country associated to the given fqdn.

An extra filter can be added to limit the list.

Use ruby regexp without the enclosing slashes.

.RS

eg. hc <fqdn> info timestamps

.RE

.IP facts 10

lists facts for a given fqdn, from puppetdb or local facts (see configuration).

An extra filter can be added to limit the list.

use ruby regexp without the enclosing slashes.

.RS

eg. hc <fqdn> facts architecture

.RE

.RS

eg. hc <fqdn> facts 'memory.*mb'

.RE

.IP files

list all files containing params affecting this fqdn

(in more than commons).

.IP paths

list all file paths for files with params.

.IP modules

list modules included in the farm where the node is.

.IP params

list params for the node matching the fqdn.

An extra filter can be added to limit the list.

Use ruby regexp without the enclosing slashes.

.RS

eg. hc <fqdn> params postfix.*version

.RE

.RS

eg. hc <fqdn> params '^postfix'

.RE

.RS

eg. hc <fqdn> params 'version$'

.RE

.IP allparams

same as params but including the common.yaml params (huge)

Also accepts a search string

.RE

.RE

.TP

.B \-v

.TP

.B \-\-version

outputs version.

.TP

.B \-f \fRformat

.TP

.B \-\-format \fRformat

outputs in the selected format. Available formats are

csv, json, console, plain, yaml and rawyaml

.IP

Note that the difference between yaml and rawyaml

is that rawyaml don't include comments with the

provenance of each params.

.TP

.B \-p \fRextraparam=what,anotherparam=this

.TP

.B \-\-params \fRextraparam=what,anotherparam=this

makes possible to add additional params.

Those params will be merged with the ones provided in the hierafile.

.TP

.B \-c \fRfile

.TP

.B \-\-config \fRfile

specify an alternative config file instead of

~/.config/hieracles/config.yaml

.TP

.B \-h \fRfile

.TP

.B \-\-hierafile \fRfile

specify an alternative hierafile instead of the one

stated in the configfile.

.TP

.B \-b \fRpath

.TP

.B \-\-basepath \fRpath

the basepath is prepended to the paths found in the configfile and the hierafile. Default is ./ but you can change this using the -b option.

.TP

.B \-e \fRpath

.TP

.B \-\-encdir \fRpath

encdir is where we can find the ENC definitions. It's stated in the configfile but can be overridden by the -e option.

.TP

.B \-y \fRfile

.TP

.B \-\-yaml \fRfile

use an arbitrary facts file that can be obtained with

.B "facter -y"

on the given node. This is useful for having a set of default fact

and test locally what would be the consequences of switching from

one environment to another. It's also good for anticipation

of how new node, that don't have facts yet, will behave.

.TP

.B \-j \fRfile

.TP

.B \-\-json \fRfile

same as the

.B "-y"

flag but in json format, which can be obtained on the node with

.B "facter -j"

and this behave the same way. Note that the \-y has precedence on

the \-j in this context.

.TP

.B \-i

.TP

.B \-\-interactive

if a scope var is not defined or if the file declared in hiera config is not found, this entry is silently ignored.

.RS

This option enables the

.B "interactive mode"

in which you are prompted to fill up for undefined scope variables encountered in the hiera config file. This behavior can be made systematic by enabling

.I "interactive: true"

in hieracles configuration file.

.RE

.TP

.B \-db

if

.I "usedb: false"

is specified in the hieracles configuration file, it cancels the calls to puppetdb

and only display information according to local data.

.TP

.B \-nodb

if

.I "usedb: true"

is specified in the hieracles configuration file, it forces the calls to puppetdb

for gathering facts and node information.

.I ~/.config/hieracles/config.yaml

.RS

Where sits the main hieracles configuration

A typical config file would look like:

.PP

.RS

---

.RE

.RS

basepath: /home/mose/git/puppet

.RE

.RS

classpath: farm_modules/%s/manifests/init.pp

.RE

.RS

hierafile: dev/hiera-local.yaml

.RE

.RS

encpath: enc

.RE

.RS

interactive: false

.RE

hiera(1), puppet(8), ppdb(1)

Please report any bug to https://github.com/Gandi/hieracles/issues

Copyright (c) 2015 gandi.net https://gandi.net

.LP

Hieracles is written by [email protected]

.LP

https://github.com/Gandi/hieracles