puppet 2.7.14 → 2.7.16
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of puppet might be problematic. Click here for more details.
- data/CHANGELOG +85 -0
- data/conf/redhat/puppet.spec +31 -4
- data/lib/puppet.rb +1 -1
- data/lib/puppet/defaults.rb +2 -3
- data/lib/puppet/face/module/install.rb +3 -3
- data/lib/puppet/face/module/search.rb +3 -3
- data/lib/puppet/indirector/face.rb +1 -1
- data/lib/puppet/network/http_pool.rb +17 -8
- data/lib/puppet/node/environment.rb +1 -3
- data/lib/puppet/parser/ast.rb +1 -1
- data/lib/puppet/parser/compiler.rb +2 -10
- data/lib/puppet/parser/functions/template.rb +2 -1
- data/lib/puppet/parser/lexer.rb +2 -2
- data/lib/puppet/parser/scope.rb +3 -2
- data/lib/puppet/provider/package/gem.rb +3 -1
- data/lib/puppet/provider/package/pkg.rb +18 -2
- data/lib/puppet/provider/service/gentoo.rb +5 -0
- data/lib/puppet/provider/service/init.rb +12 -14
- data/lib/puppet/provider/service/redhat.rb +1 -1
- data/lib/puppet/provider/service/upstart.rb +257 -7
- data/lib/puppet/provider/ssh_authorized_key/parsed.rb +6 -9
- data/lib/puppet/reports/http.rb +1 -1
- data/lib/puppet/reports/tagmail.rb +1 -1
- data/lib/puppet/type/cron.rb +5 -0
- data/lib/puppet/type/filebucket.rb +12 -0
- data/lib/puppet/util.rb +15 -9
- data/lib/puppet/util/colors.rb +94 -64
- data/lib/puppet/util/platform.rb +15 -0
- data/man/man5/puppet.conf.5 +73 -27
- data/man/man8/filebucket.8 +1 -1
- data/man/man8/pi.8 +1 -1
- data/man/man8/puppet-agent.8 +17 -17
- data/man/man8/puppet-apply.8 +8 -3
- data/man/man8/puppet-ca.8 +183 -0
- data/man/man8/puppet-catalog.8 +17 -10
- data/man/man8/puppet-cert.8 +1 -1
- data/man/man8/puppet-certificate.8 +27 -11
- data/man/man8/puppet-certificate_request.8 +12 -11
- data/man/man8/puppet-certificate_revocation_list.8 +11 -10
- data/man/man8/puppet-config.8 +1 -1
- data/man/man8/puppet-describe.8 +1 -1
- data/man/man8/puppet-device.8 +2 -2
- data/man/man8/puppet-doc.8 +15 -3
- data/man/man8/puppet-facts.8 +18 -8
- data/man/man8/puppet-file.8 +13 -22
- data/man/man8/puppet-filebucket.8 +1 -1
- data/man/man8/puppet-help.8 +1 -1
- data/man/man8/puppet-inspect.8 +10 -2
- data/man/man8/puppet-instrumentation_data.8 +145 -0
- data/man/man8/puppet-instrumentation_listener.8 +222 -0
- data/man/man8/puppet-instrumentation_probe.8 +207 -0
- data/man/man8/puppet-key.8 +11 -7
- data/man/man8/puppet-kick.8 +35 -3
- data/man/man8/puppet-man.8 +1 -1
- data/man/man8/puppet-master.8 +1 -1
- data/man/man8/puppet-module.8 +451 -0
- data/man/man8/puppet-node.8 +64 -22
- data/man/man8/puppet-parser.8 +1 -1
- data/man/man8/puppet-plugin.8 +1 -1
- data/man/man8/puppet-queue.8 +1 -1
- data/man/man8/puppet-report.8 +12 -8
- data/man/man8/puppet-resource.8 +1 -1
- data/man/man8/puppet-resource_type.8 +11 -7
- data/man/man8/puppet-secret_agent.8 +1 -1
- data/man/man8/puppet-status.8 +11 -7
- data/man/man8/puppet.8 +1 -1
- data/man/man8/puppetca.8 +1 -1
- data/man/man8/puppetd.8 +17 -17
- data/man/man8/puppetdoc.8 +15 -3
- data/man/man8/puppetmasterd.8 +1 -1
- data/man/man8/puppetqd.8 +1 -1
- data/man/man8/puppetrun.8 +35 -3
- data/man/man8/ralsh.8 +1 -1
- data/spec/fixtures/unit/provider/package/gem/line-with-1.8.5-warning +14 -0
- data/spec/fixtures/unit/provider/package/pkg/{dummy → dummy_solaris10} +0 -0
- data/spec/fixtures/unit/provider/package/pkg/dummy_solaris11 +1 -0
- data/spec/fixtures/unit/provider/package/pkg/solaris11 +12 -0
- data/spec/fixtures/unit/provider/package/pkg/unknown_status +12 -0
- data/spec/fixtures/unit/provider/service/gentoo/rc_update_show +30 -0
- data/spec/integration/defaults_spec.rb +2 -7
- data/spec/integration/network/server/mongrel_spec.rb +16 -10
- data/spec/integration/network/server/webrick_spec.rb +16 -9
- data/spec/integration/provider/service/init_spec.rb +20 -4
- data/spec/integration/provider/ssh_authorized_key_spec.rb +119 -107
- data/spec/unit/face/module/install_spec.rb +16 -4
- data/spec/unit/network/http/api/v1_spec.rb +8 -0
- data/spec/unit/network/http_pool_spec.rb +80 -74
- data/spec/unit/node/environment_spec.rb +9 -4
- data/spec/unit/parser/ast/leaf_spec.rb +2 -2
- data/spec/unit/parser/ast_spec.rb +3 -3
- data/spec/unit/parser/compiler_spec.rb +0 -17
- data/spec/unit/parser/lexer_spec.rb +45 -2
- data/spec/unit/parser/scope_spec.rb +181 -14
- data/spec/unit/provider/package/gem_spec.rb +17 -1
- data/spec/unit/provider/package/pkg_spec.rb +70 -22
- data/spec/unit/provider/service/gentoo_spec.rb +237 -0
- data/spec/unit/provider/service/init_spec.rb +2 -2
- data/spec/unit/provider/service/redhat_spec.rb +2 -2
- data/spec/unit/provider/service/upstart_spec.rb +414 -5
- data/spec/unit/provider/ssh_authorized_key/parsed_spec.rb +24 -0
- data/spec/unit/reports/tagmail_spec.rb +50 -0
- data/spec/unit/type/cron_spec.rb +21 -1
- data/spec/unit/type/filebucket_spec.rb +39 -9
- data/spec/unit/util/colors_spec.rb +69 -0
- data/spec/unit/util/log/destinations_spec.rb +17 -9
- data/spec/unit/util/log_spec.rb +2 -1
- data/spec/unit/util_spec.rb +11 -0
- data/tasks/rake/gem.rake +1 -1
- data/tasks/rake/manpages.rake +11 -3
- data/test/network/handler/fileserver.rb +7 -1
- metadata +22 -10
data/man/man8/puppet-file.8
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "PUPPET\-FILE" "8" "June
|
4
|
+
.TH "PUPPET\-FILE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBpuppet\-file\fR \- Retrieve and store files in a filebucket
|
8
8
|
.
|
9
9
|
.SH "SYNOPSIS"
|
10
|
-
puppet file \fIaction\fR [\-\-terminus TERMINUS]
|
10
|
+
puppet file \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
|
11
11
|
.
|
12
12
|
.SH "DESCRIPTION"
|
13
13
|
This subcommand interacts with objects stored in a local or remote filebucket\. File objects are accessed by their MD5 sum; see the examples for the relevant syntax\.
|
@@ -35,6 +35,10 @@ Whether to log verbosely\.
|
|
35
35
|
Whether to log debug information\.
|
36
36
|
.
|
37
37
|
.TP
|
38
|
+
\-\-extra HASH
|
39
|
+
A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\.
|
40
|
+
.
|
41
|
+
.TP
|
38
42
|
\-\-terminus TERMINUS
|
39
43
|
Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
|
40
44
|
.
|
@@ -51,7 +55,7 @@ The terminus for an action is often determined by context, but occasionally need
|
|
51
55
|
\fBSYNOPSIS\fR
|
52
56
|
.
|
53
57
|
.IP
|
54
|
-
puppet file destroy [\-\-terminus TERMINUS] \fIkey\fR
|
58
|
+
puppet file destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
|
55
59
|
.
|
56
60
|
.IP
|
57
61
|
\fBDESCRIPTION\fR
|
@@ -64,7 +68,7 @@ Invalid for this subcommand\.
|
|
64
68
|
\fBSYNOPSIS\fR
|
65
69
|
.
|
66
70
|
.IP
|
67
|
-
puppet file download [\-\-terminus TERMINUS] ( {md5}\fIchecksum\fR | \fIpuppet_url\fR )
|
71
|
+
puppet file download [\-\-terminus TERMINUS] [\-\-extra HASH] ( {md5}\fIchecksum\fR | \fIpuppet_url\fR )
|
68
72
|
.
|
69
73
|
.IP
|
70
74
|
\fBDESCRIPTION\fR
|
@@ -83,7 +87,7 @@ Nothing\.
|
|
83
87
|
\fBSYNOPSIS\fR
|
84
88
|
.
|
85
89
|
.IP
|
86
|
-
puppet file find [\-\-terminus TERMINUS] md5/\fImd5sum\fR
|
90
|
+
puppet file find [\-\-terminus TERMINUS] [\-\-extra HASH] md5/\fImd5sum\fR
|
87
91
|
.
|
88
92
|
.IP
|
89
93
|
\fBDESCRIPTION\fR
|
@@ -105,7 +109,7 @@ RENDERING ISSUES: Rendering as a string returns the contents of the file object;
|
|
105
109
|
\fBSYNOPSIS\fR
|
106
110
|
.
|
107
111
|
.IP
|
108
|
-
puppet file info [\-\-terminus TERMINUS]
|
112
|
+
puppet file info [\-\-terminus TERMINUS] [\-\-extra HASH]
|
109
113
|
.
|
110
114
|
.IP
|
111
115
|
\fBDESCRIPTION\fR
|
@@ -118,7 +122,7 @@ Prints the default terminus class for this subcommand\. Note that different run
|
|
118
122
|
\fBSYNOPSIS\fR
|
119
123
|
.
|
120
124
|
.IP
|
121
|
-
puppet file save [\-\-terminus TERMINUS]
|
125
|
+
puppet file save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
|
122
126
|
.
|
123
127
|
.IP
|
124
128
|
\fBDESCRIPTION\fR
|
@@ -131,7 +135,7 @@ API only: create or overwrite an object\. As the Faces framework does not curren
|
|
131
135
|
\fBSYNOPSIS\fR
|
132
136
|
.
|
133
137
|
.IP
|
134
|
-
puppet file search [\-\-terminus TERMINUS] \fIquery\fR
|
138
|
+
puppet file search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR
|
135
139
|
.
|
136
140
|
.IP
|
137
141
|
\fBDESCRIPTION\fR
|
@@ -144,7 +148,7 @@ Invalid for this subcommand\.
|
|
144
148
|
\fBSYNOPSIS\fR
|
145
149
|
.
|
146
150
|
.IP
|
147
|
-
puppet file store [\-\-terminus TERMINUS] \fIfile\fR
|
151
|
+
puppet file store [\-\-terminus TERMINUS] [\-\-extra HASH] \fIfile\fR
|
148
152
|
.
|
149
153
|
.IP
|
150
154
|
\fBDESCRIPTION\fR
|
@@ -158,19 +162,6 @@ Store a file in the local filebucket\.
|
|
158
162
|
.IP
|
159
163
|
Nothing\.
|
160
164
|
.
|
161
|
-
.TP
|
162
|
-
\fBupload\fR \- Upload a file to the remote filebucket\.
|
163
|
-
\fBSYNOPSIS\fR
|
164
|
-
.
|
165
|
-
.IP
|
166
|
-
puppet file upload [\-\-terminus TERMINUS] \fIfile\fR
|
167
|
-
.
|
168
|
-
.IP
|
169
|
-
\fBDESCRIPTION\fR
|
170
|
-
.
|
171
|
-
.IP
|
172
|
-
Upload a file to the remote filebucket\.
|
173
|
-
.
|
174
165
|
.SH "EXAMPLES"
|
175
166
|
\fBdownload\fR
|
176
167
|
.
|
@@ -1,7 +1,7 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "PUPPET\-FILEBUCKET" "8" "June
|
4
|
+
.TH "PUPPET\-FILEBUCKET" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket
|
data/man/man8/puppet-help.8
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "PUPPET\-HELP" "8" "June
|
4
|
+
.TH "PUPPET\-HELP" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBpuppet\-help\fR \- Display Puppet help\.
|
data/man/man8/puppet-inspect.8
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "PUPPET\-INSPECT" "8" "June
|
4
|
+
.TH "PUPPET\-INSPECT" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBpuppet\-inspect\fR \- Send an inspection report
|
@@ -10,7 +10,7 @@
|
|
10
10
|
Prepares and submits an inspection report to the puppet master\.
|
11
11
|
.
|
12
12
|
.SH "USAGE"
|
13
|
-
puppet inspect
|
13
|
+
puppet inspect [\-\-archive_files] [\-\-archive_file_server]
|
14
14
|
.
|
15
15
|
.SH "DESCRIPTION"
|
16
16
|
This command uses the cached catalog from the previous run of \'puppet agent\' to determine which attributes of which resources have been marked as auditable with the \'audit\' metaparameter\. It then examines the current state of the system, writes the state of the specified resource attributes to a report, and submits the report to the puppet master\.
|
@@ -21,6 +21,14 @@ Puppet inspect does not run as a daemon, and must be run manually or from cron\.
|
|
21
21
|
.SH "OPTIONS"
|
22
22
|
Any configuration setting which is valid in the configuration file is also a valid long argument, e\.g\. \'\-\-server=master\.domain\.com\'\. See the configuration file documentation at http://docs\.puppetlabs\.com/references/latest/configuration\.html for the full list of acceptable settings\.
|
23
23
|
.
|
24
|
+
.TP
|
25
|
+
\-\-archive_files
|
26
|
+
During an inspect run, whether to archive files whose contents are audited to a file bucket\.
|
27
|
+
.
|
28
|
+
.TP
|
29
|
+
\-\-archive_file_server
|
30
|
+
During an inspect run, the file bucket server to archive files to if archive_files is set\. The default value is \'$server\'\.
|
31
|
+
.
|
24
32
|
.SH "AUTHOR"
|
25
33
|
Puppet Labs
|
26
34
|
.
|
@@ -0,0 +1,145 @@
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
|
+
.
|
4
|
+
.TH "PUPPET\-INSTRUMENTATION_DATA" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
|
5
|
+
.
|
6
|
+
.SH "NAME"
|
7
|
+
\fBpuppet\-instrumentation_data\fR \- Manage instrumentation listener accumulated data\.
|
8
|
+
.
|
9
|
+
.SH "SYNOPSIS"
|
10
|
+
puppet instrumentation_data \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
|
11
|
+
.
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
This subcommand allows to retrieve the various listener data\.
|
14
|
+
.
|
15
|
+
.SH "OPTIONS"
|
16
|
+
Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
|
17
|
+
.
|
18
|
+
.P
|
19
|
+
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
|
20
|
+
.
|
21
|
+
.TP
|
22
|
+
\-\-mode MODE
|
23
|
+
The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
|
24
|
+
.
|
25
|
+
.TP
|
26
|
+
\-\-render\-as FORMAT
|
27
|
+
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
|
28
|
+
.
|
29
|
+
.TP
|
30
|
+
\-\-verbose
|
31
|
+
Whether to log verbosely\.
|
32
|
+
.
|
33
|
+
.TP
|
34
|
+
\-\-debug
|
35
|
+
Whether to log debug information\.
|
36
|
+
.
|
37
|
+
.TP
|
38
|
+
\-\-extra HASH
|
39
|
+
A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\.
|
40
|
+
.
|
41
|
+
.TP
|
42
|
+
\-\-terminus TERMINUS
|
43
|
+
Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
|
44
|
+
.
|
45
|
+
.IP
|
46
|
+
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\.
|
47
|
+
.
|
48
|
+
.IP
|
49
|
+
The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\.
|
50
|
+
.
|
51
|
+
.SH "ACTIONS"
|
52
|
+
.
|
53
|
+
.TP
|
54
|
+
\fBdestroy\fR \- Invalid for this subcommand\.
|
55
|
+
\fBSYNOPSIS\fR
|
56
|
+
.
|
57
|
+
.IP
|
58
|
+
puppet instrumentation_data destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
|
59
|
+
.
|
60
|
+
.IP
|
61
|
+
\fBDESCRIPTION\fR
|
62
|
+
.
|
63
|
+
.IP
|
64
|
+
Invalid for this subcommand\.
|
65
|
+
.
|
66
|
+
.TP
|
67
|
+
\fBfind\fR \- Retrieve listener data\.
|
68
|
+
\fBSYNOPSIS\fR
|
69
|
+
.
|
70
|
+
.IP
|
71
|
+
puppet instrumentation_data find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
|
72
|
+
.
|
73
|
+
.IP
|
74
|
+
\fBDESCRIPTION\fR
|
75
|
+
.
|
76
|
+
.IP
|
77
|
+
Retrieve listener data\.
|
78
|
+
.
|
79
|
+
.IP
|
80
|
+
\fBRETURNS\fR
|
81
|
+
.
|
82
|
+
.IP
|
83
|
+
The data of an instrumentation listener
|
84
|
+
.
|
85
|
+
.TP
|
86
|
+
\fBinfo\fR \- Print the default terminus class for this face\.
|
87
|
+
\fBSYNOPSIS\fR
|
88
|
+
.
|
89
|
+
.IP
|
90
|
+
puppet instrumentation_data info [\-\-terminus TERMINUS] [\-\-extra HASH]
|
91
|
+
.
|
92
|
+
.IP
|
93
|
+
\fBDESCRIPTION\fR
|
94
|
+
.
|
95
|
+
.IP
|
96
|
+
Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
|
97
|
+
.
|
98
|
+
.TP
|
99
|
+
\fBsave\fR \- Invalid for this subcommand\.
|
100
|
+
\fBSYNOPSIS\fR
|
101
|
+
.
|
102
|
+
.IP
|
103
|
+
puppet instrumentation_data save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
|
104
|
+
.
|
105
|
+
.IP
|
106
|
+
\fBDESCRIPTION\fR
|
107
|
+
.
|
108
|
+
.IP
|
109
|
+
API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\.
|
110
|
+
.
|
111
|
+
.TP
|
112
|
+
\fBsearch\fR \- Invalid for this subcommand\.
|
113
|
+
\fBSYNOPSIS\fR
|
114
|
+
.
|
115
|
+
.IP
|
116
|
+
puppet instrumentation_data search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR
|
117
|
+
.
|
118
|
+
.IP
|
119
|
+
\fBDESCRIPTION\fR
|
120
|
+
.
|
121
|
+
.IP
|
122
|
+
Invalid for this subcommand\.
|
123
|
+
.
|
124
|
+
.SH "EXAMPLES"
|
125
|
+
\fBfind\fR
|
126
|
+
.
|
127
|
+
.P
|
128
|
+
Retrieve listener data:
|
129
|
+
.
|
130
|
+
.P
|
131
|
+
$ puppet instrumentation_data find performance \-\-terminus rest
|
132
|
+
.
|
133
|
+
.SH "NOTES"
|
134
|
+
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include:
|
135
|
+
.
|
136
|
+
.IP "\(bu" 4
|
137
|
+
\fBlocal\fR
|
138
|
+
.
|
139
|
+
.IP "\(bu" 4
|
140
|
+
\fBrest\fR
|
141
|
+
.
|
142
|
+
.IP "" 0
|
143
|
+
.
|
144
|
+
.SH "COPYRIGHT AND LICENSE"
|
145
|
+
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
|
@@ -0,0 +1,222 @@
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
|
+
.
|
4
|
+
.TH "PUPPET\-INSTRUMENTATION_LISTENER" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
|
5
|
+
.
|
6
|
+
.SH "NAME"
|
7
|
+
\fBpuppet\-instrumentation_listener\fR \- Manage instrumentation listeners\.
|
8
|
+
.
|
9
|
+
.SH "SYNOPSIS"
|
10
|
+
puppet instrumentation_listener \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
|
11
|
+
.
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
This subcommand enables/disables or list instrumentation listeners\.
|
14
|
+
.
|
15
|
+
.SH "OPTIONS"
|
16
|
+
Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
|
17
|
+
.
|
18
|
+
.P
|
19
|
+
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
|
20
|
+
.
|
21
|
+
.TP
|
22
|
+
\-\-mode MODE
|
23
|
+
The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
|
24
|
+
.
|
25
|
+
.TP
|
26
|
+
\-\-render\-as FORMAT
|
27
|
+
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
|
28
|
+
.
|
29
|
+
.TP
|
30
|
+
\-\-verbose
|
31
|
+
Whether to log verbosely\.
|
32
|
+
.
|
33
|
+
.TP
|
34
|
+
\-\-debug
|
35
|
+
Whether to log debug information\.
|
36
|
+
.
|
37
|
+
.TP
|
38
|
+
\-\-extra HASH
|
39
|
+
A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\.
|
40
|
+
.
|
41
|
+
.TP
|
42
|
+
\-\-terminus TERMINUS
|
43
|
+
Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
|
44
|
+
.
|
45
|
+
.IP
|
46
|
+
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\.
|
47
|
+
.
|
48
|
+
.IP
|
49
|
+
The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\.
|
50
|
+
.
|
51
|
+
.SH "ACTIONS"
|
52
|
+
.
|
53
|
+
.TP
|
54
|
+
\fBdestroy\fR \- Invalid for this subcommand\.
|
55
|
+
\fBSYNOPSIS\fR
|
56
|
+
.
|
57
|
+
.IP
|
58
|
+
puppet instrumentation_listener destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
|
59
|
+
.
|
60
|
+
.IP
|
61
|
+
\fBDESCRIPTION\fR
|
62
|
+
.
|
63
|
+
.IP
|
64
|
+
Invalid for this subcommand\.
|
65
|
+
.
|
66
|
+
.TP
|
67
|
+
\fBdisable\fR \- Disable a given instrumentation listener\.
|
68
|
+
\fBSYNOPSIS\fR
|
69
|
+
.
|
70
|
+
.IP
|
71
|
+
puppet instrumentation_listener disable [\-\-terminus TERMINUS] [\-\-extra HASH] \fIlistener\fR
|
72
|
+
.
|
73
|
+
.IP
|
74
|
+
\fBDESCRIPTION\fR
|
75
|
+
.
|
76
|
+
.IP
|
77
|
+
Disable a given instrumentation listener\. After being disabled the listener will stop receiving instrumentation notifications from the probes\.
|
78
|
+
.
|
79
|
+
.IP
|
80
|
+
\fBRETURNS\fR
|
81
|
+
.
|
82
|
+
.IP
|
83
|
+
Nothing\.
|
84
|
+
.
|
85
|
+
.TP
|
86
|
+
\fBenable\fR \- Enable a given instrumentation listener\.
|
87
|
+
\fBSYNOPSIS\fR
|
88
|
+
.
|
89
|
+
.IP
|
90
|
+
puppet instrumentation_listener enable [\-\-terminus TERMINUS] [\-\-extra HASH] \fIlistener\fR
|
91
|
+
.
|
92
|
+
.IP
|
93
|
+
\fBDESCRIPTION\fR
|
94
|
+
.
|
95
|
+
.IP
|
96
|
+
Enable a given instrumentation listener\. After being enabled the listener will start receiving instrumentation notifications from the probes if those are enabled\.
|
97
|
+
.
|
98
|
+
.IP
|
99
|
+
\fBRETURNS\fR
|
100
|
+
.
|
101
|
+
.IP
|
102
|
+
Nothing\.
|
103
|
+
.
|
104
|
+
.TP
|
105
|
+
\fBfind\fR \- Retrieve a single listener\.
|
106
|
+
\fBSYNOPSIS\fR
|
107
|
+
.
|
108
|
+
.IP
|
109
|
+
puppet instrumentation_listener find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
|
110
|
+
.
|
111
|
+
.IP
|
112
|
+
\fBDESCRIPTION\fR
|
113
|
+
.
|
114
|
+
.IP
|
115
|
+
Retrieve a single listener\.
|
116
|
+
.
|
117
|
+
.IP
|
118
|
+
\fBRETURNS\fR
|
119
|
+
.
|
120
|
+
.IP
|
121
|
+
The status of an instrumentation listener
|
122
|
+
.
|
123
|
+
.TP
|
124
|
+
\fBinfo\fR \- Print the default terminus class for this face\.
|
125
|
+
\fBSYNOPSIS\fR
|
126
|
+
.
|
127
|
+
.IP
|
128
|
+
puppet instrumentation_listener info [\-\-terminus TERMINUS] [\-\-extra HASH]
|
129
|
+
.
|
130
|
+
.IP
|
131
|
+
\fBDESCRIPTION\fR
|
132
|
+
.
|
133
|
+
.IP
|
134
|
+
Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
|
135
|
+
.
|
136
|
+
.TP
|
137
|
+
\fBsave\fR \- API only: modify an instrumentation listener status\.
|
138
|
+
\fBSYNOPSIS\fR
|
139
|
+
.
|
140
|
+
.IP
|
141
|
+
puppet instrumentation_listener save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIlistener\fR
|
142
|
+
.
|
143
|
+
.IP
|
144
|
+
\fBDESCRIPTION\fR
|
145
|
+
.
|
146
|
+
.IP
|
147
|
+
API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\.
|
148
|
+
.
|
149
|
+
.TP
|
150
|
+
\fBsearch\fR \- Retrieve all instrumentation listeners statuses\.
|
151
|
+
\fBSYNOPSIS\fR
|
152
|
+
.
|
153
|
+
.IP
|
154
|
+
puppet instrumentation_listener search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR
|
155
|
+
.
|
156
|
+
.IP
|
157
|
+
\fBDESCRIPTION\fR
|
158
|
+
.
|
159
|
+
.IP
|
160
|
+
Retrieve all instrumentation listeners statuses\.
|
161
|
+
.
|
162
|
+
.IP
|
163
|
+
\fBRETURNS\fR
|
164
|
+
.
|
165
|
+
.IP
|
166
|
+
The statuses of all instrumentation listeners
|
167
|
+
.
|
168
|
+
.IP
|
169
|
+
\fBNOTES\fR
|
170
|
+
.
|
171
|
+
.IP
|
172
|
+
Although this action always returns all instrumentation listeners, it requires a dummy search key; this is a known bug\.
|
173
|
+
.
|
174
|
+
.SH "EXAMPLES"
|
175
|
+
\fBdisable\fR
|
176
|
+
.
|
177
|
+
.P
|
178
|
+
Disable the "performance" listener in the running master:
|
179
|
+
.
|
180
|
+
.P
|
181
|
+
$ puppet instrumentation_listener disable performance \-\-terminus rest
|
182
|
+
.
|
183
|
+
.P
|
184
|
+
\fBenable\fR
|
185
|
+
.
|
186
|
+
.P
|
187
|
+
Enable the "performance" listener in the running master:
|
188
|
+
.
|
189
|
+
.P
|
190
|
+
$ puppet instrumentation_listener enable performance \-\-terminus rest
|
191
|
+
.
|
192
|
+
.P
|
193
|
+
\fBfind\fR
|
194
|
+
.
|
195
|
+
.P
|
196
|
+
Retrieve a given listener:
|
197
|
+
.
|
198
|
+
.P
|
199
|
+
$ puppet instrumentation_listener find performance \-\-terminus rest
|
200
|
+
.
|
201
|
+
.P
|
202
|
+
\fBsearch\fR
|
203
|
+
.
|
204
|
+
.P
|
205
|
+
Retrieve the state of the listeners running in the remote puppet master:
|
206
|
+
.
|
207
|
+
.P
|
208
|
+
$ puppet instrumentation_listener search x \-\-terminus rest
|
209
|
+
.
|
210
|
+
.SH "NOTES"
|
211
|
+
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include:
|
212
|
+
.
|
213
|
+
.IP "\(bu" 4
|
214
|
+
\fBlocal\fR
|
215
|
+
.
|
216
|
+
.IP "\(bu" 4
|
217
|
+
\fBrest\fR
|
218
|
+
.
|
219
|
+
.IP "" 0
|
220
|
+
.
|
221
|
+
.SH "COPYRIGHT AND LICENSE"
|
222
|
+
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
|