hc.1 in hieracles-0.2.0 vs hc.1 in hieracles-0.2.1
- old
+ new
@@ -1,9 +1,9 @@
-.TH hc 1 "2015-11-08" "version 0.1.5" "Hieracles command manual"
+.TH hc 1 "2015-12-05" "version 0.2.1" "Hieracles command manual"
.SH NAME
-hc \- Command tool for Hieracles
+hc \- Command line tool for Hieracles
.SH SYNOPSIS
.B hc
.I fqdn
.I action
.B [
@@ -21,38 +21,62 @@
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 string can be added to limit the list
-use ruby regexp without the enclosing slashes
+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 all
+
+.IP allparams
same as params but including the common.yaml params (huge)
Also accepts a search string
.RE
.RE
@@ -120,11 +144,10 @@
.TP
.PD
.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
.PD 0
.B \-y \fRfile
.TP
.PD
@@ -134,11 +157,10 @@
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
.PD 0
.B \-j \fRfile
.TP
.PD
@@ -148,11 +170,10 @@
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
.PD 0
.B \-i
.TP
.PD
@@ -164,19 +185,40 @@
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
+.PD 0
+.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
+.PD 0
+.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.
+
+
.SH FILES
.I ~/.config/hieracles/config.yaml
.RS
Where sits the main hieracles configuration
.SH EXAMPLES
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