hieracles 0.1.3 → 0.1.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -0
- data/hc.1 +158 -0
- data/hieracles.gemspec +1 -0
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a9408641017def345036eb056db2f779c97775f0
|
|
4
|
+
data.tar.gz: b385041d4e5a05e1f427695e3eaea00ae2f529de
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bdad42ab493fda2652e02ff5a34847a7f1ab2aacdb1ef27907f6c3e5f15fc5ed47f8059e8a709c56f9fffee4b6acee2f0ff63cc1ea4ac67b8674c60ad71019a5
|
|
7
|
+
data.tar.gz: 345e4e5f501fc673b5b8fd9586a120f5455593a9b805fe3dbce0c2eceb6661062e7af884e21c0032d4ec058184c4936921a8d377a4ea7021180c229637085a7e
|
data/CHANGELOG.md
CHANGED
data/hc.1
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
.TH hc 1 "2015-11-08" "version 0.1.0" "Hieracles command manual"
|
|
2
|
+
|
|
3
|
+
.SH NAME
|
|
4
|
+
hc \- Command tool for Hieracles
|
|
5
|
+
.SH SYNOPSIS
|
|
6
|
+
.B hc
|
|
7
|
+
.I fqdn
|
|
8
|
+
.I action
|
|
9
|
+
.B [
|
|
10
|
+
.I options
|
|
11
|
+
.B ]
|
|
12
|
+
|
|
13
|
+
.SH DESCRIPTION
|
|
14
|
+
.PP
|
|
15
|
+
Hieracles is a command-line tool for analysis and deep examination
|
|
16
|
+
of [Hiera][hiera] paramaters in a [Puppet][puppet] setup. It's used
|
|
17
|
+
internally at Gandi and its first incarnation is strongly
|
|
18
|
+
tied to Gandi puppet architecture. But Hieracles tends to become, in
|
|
19
|
+
time, a generic Hiera overlay visualisation tool.
|
|
20
|
+
.PP
|
|
21
|
+
hc command takes at minimum 2 arguments:
|
|
22
|
+
.RS 4
|
|
23
|
+
.IP fqdn 10
|
|
24
|
+
the fqdn under which the node is known in the ENC dir
|
|
25
|
+
.IP action
|
|
26
|
+
the action needs to be one of the following
|
|
27
|
+
.RS
|
|
28
|
+
.IP info 10
|
|
29
|
+
provides the farm, datacenter, country associated to the given fqdn.
|
|
30
|
+
.IP files
|
|
31
|
+
list all files containing params affecting this fqdn
|
|
32
|
+
(in more than commons).
|
|
33
|
+
.IP paths
|
|
34
|
+
list all file paths for files with params.
|
|
35
|
+
.IP modules
|
|
36
|
+
list modules included in the farm where the node is.
|
|
37
|
+
.IP params
|
|
38
|
+
list params for the node matching the fqdn.
|
|
39
|
+
An extra filter string can be added to limit the list
|
|
40
|
+
use ruby regexp without the enclosing slashes
|
|
41
|
+
.RS
|
|
42
|
+
eg. hc <fqdn> params postfix.*version
|
|
43
|
+
.RE
|
|
44
|
+
.RS
|
|
45
|
+
eg. hc <fqdn> params '^postfix'
|
|
46
|
+
.RE
|
|
47
|
+
.RS
|
|
48
|
+
eg. hc <fqdn> params 'version$'
|
|
49
|
+
.RE
|
|
50
|
+
.IP all
|
|
51
|
+
same as params but including the common.yaml params (huge)
|
|
52
|
+
Also accepts a search string
|
|
53
|
+
.RE
|
|
54
|
+
.RE
|
|
55
|
+
|
|
56
|
+
.SH OPTIONS
|
|
57
|
+
|
|
58
|
+
.TP
|
|
59
|
+
.PD 0
|
|
60
|
+
.B \-v
|
|
61
|
+
.TP
|
|
62
|
+
.PD
|
|
63
|
+
.B \-\-version
|
|
64
|
+
outputs version.
|
|
65
|
+
|
|
66
|
+
.TP
|
|
67
|
+
.PD 0
|
|
68
|
+
.B \-f \fRformat
|
|
69
|
+
.TP
|
|
70
|
+
.PD
|
|
71
|
+
.B \-\-format \fRformat
|
|
72
|
+
outputs in the selected format. Available formats are
|
|
73
|
+
csv, json, console, plain, yaml and rawyaml
|
|
74
|
+
.IP
|
|
75
|
+
Note that the difference betrween yaml and rawyaml
|
|
76
|
+
is that rawyaml don't include comments with the
|
|
77
|
+
provenance of each params.
|
|
78
|
+
|
|
79
|
+
.TP
|
|
80
|
+
.PD 0
|
|
81
|
+
.B \-p \fRextraparam=what;anotherparam=this
|
|
82
|
+
.TP
|
|
83
|
+
.PD
|
|
84
|
+
.B \-\-params \fRextraparam=what;anotherparam=this
|
|
85
|
+
makes possible to add additional params.
|
|
86
|
+
Those params will be merged with the ones provided in the hierafile.
|
|
87
|
+
|
|
88
|
+
.TP
|
|
89
|
+
.PD 0
|
|
90
|
+
.B \-c \fRfile
|
|
91
|
+
.TP
|
|
92
|
+
.PD
|
|
93
|
+
.B \-\-config \fRfile
|
|
94
|
+
specify an alternative config file instead of
|
|
95
|
+
~/.config/hieracles/config.yaml
|
|
96
|
+
|
|
97
|
+
.TP
|
|
98
|
+
.PD 0
|
|
99
|
+
.B \-h \fRfile
|
|
100
|
+
.TP
|
|
101
|
+
.PD
|
|
102
|
+
.B \-\-hierafile \fRfile
|
|
103
|
+
specify an alternative hierafile instead of the one
|
|
104
|
+
stated in the configfile.
|
|
105
|
+
|
|
106
|
+
.TP
|
|
107
|
+
.PD 0
|
|
108
|
+
.B \-b \fRpath
|
|
109
|
+
.TP
|
|
110
|
+
.PD
|
|
111
|
+
.B \-\-basepath \fRpath
|
|
112
|
+
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.
|
|
113
|
+
|
|
114
|
+
.TP
|
|
115
|
+
.PD 0
|
|
116
|
+
.B \-e \fRpath
|
|
117
|
+
.TP
|
|
118
|
+
.PD
|
|
119
|
+
.B \-\-encdir \fRpath
|
|
120
|
+
encdir is where we can find the ENC definitions. It's stated in the configfile but can be overriden by the -e option.
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
.SH FILES
|
|
124
|
+
.I ~/.config/hieracles/config.yaml
|
|
125
|
+
.RS
|
|
126
|
+
Where sits the main hieracles configuration
|
|
127
|
+
|
|
128
|
+
.SH EXAMPLES
|
|
129
|
+
A typical config file would look like:
|
|
130
|
+
.PP
|
|
131
|
+
.RS
|
|
132
|
+
---
|
|
133
|
+
.RE
|
|
134
|
+
.RS
|
|
135
|
+
colors: true
|
|
136
|
+
.RE
|
|
137
|
+
.RS
|
|
138
|
+
classpath: farm_modules/%s/manifests/init.pp
|
|
139
|
+
.RE
|
|
140
|
+
.RS
|
|
141
|
+
hierafile: dev/hiera-local.yaml
|
|
142
|
+
.RE
|
|
143
|
+
.RS
|
|
144
|
+
encpath: enc
|
|
145
|
+
.RE
|
|
146
|
+
|
|
147
|
+
.SH SEE ALSO
|
|
148
|
+
hiera(1), puppet(8)
|
|
149
|
+
|
|
150
|
+
.SH BUGS
|
|
151
|
+
Please report any bug to https://github.com/Gandi/hieracles/issues
|
|
152
|
+
|
|
153
|
+
.SH AUTHORS
|
|
154
|
+
Copyright (c) 2015 gandi.net https://gandi.net
|
|
155
|
+
.LP
|
|
156
|
+
Hieracles is written by mose@gandi.net
|
|
157
|
+
.LP
|
|
158
|
+
https://github.com/Gandi/hieracles
|
data/hieracles.gemspec
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: hieracles
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.4
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- mose
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2015-11-
|
|
11
|
+
date: 2015-11-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -108,6 +108,7 @@ files:
|
|
|
108
108
|
- README.md
|
|
109
109
|
- Rakefile
|
|
110
110
|
- bin/hc
|
|
111
|
+
- hc.1
|
|
111
112
|
- hieracles.gemspec
|
|
112
113
|
- lib/hieracles.rb
|
|
113
114
|
- lib/hieracles/config.rb
|