hc.1 in hieracles-0.1.4 vs hc.1 in hieracles-0.1.5

- old
+ new

@@ -1,6 +1,6 @@ -.TH hc 1 "2015-11-08" "version 0.1.0" "Hieracles command manual" +.TH hc 1 "2015-11-08" "version 0.1.5" "Hieracles command manual" .SH NAME hc \- Command tool for Hieracles .SH SYNOPSIS .B hc @@ -11,14 +11,14 @@ .B ] .SH DESCRIPTION .PP Hieracles is a command-line tool for analysis and deep examination -of [Hiera][hiera] paramaters in a [Puppet][puppet] setup. It's used +of [Hiera][hiera] parameters in a [Puppet][puppet] setup. 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 visualisation tool. +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 @@ -70,11 +70,11 @@ .PD .B \-\-format \fRformat outputs in the selected format. Available formats are csv, json, console, plain, yaml and rawyaml .IP -Note that the difference betrween yaml and rawyaml +Note that the difference between yaml and rawyaml is that rawyaml don't include comments with the provenance of each params. .TP .PD 0 @@ -107,21 +107,64 @@ .PD 0 .B \-b \fRpath .TP .PD .B \-\-basepath \fRpath -the basepath is prepended to the paths found in the configfile and the hierafile. Default is ./ but you can change thise using the -b option. +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 .PD 0 .B \-e \fRpath .TP .PD .B \-\-encdir \fRpath -encdir is where we can find the ENC definitions. It's stated in the configfile but can be overriden by the -e option. +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 +.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 +.PD 0 +.B \-j \fRfile +.TP +.PD +.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 +.PD 0 +.B \-i +.TP +.PD +.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 + .SH FILES .I ~/.config/hieracles/config.yaml .RS Where sits the main hieracles configuration @@ -130,19 +173,19 @@ .PP .RS --- .RE .RS -colors: true -.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 .SH SEE ALSO hiera(1), puppet(8)