summaryrefslogtreecommitdiffstats
path: root/man/man8/puppetrun.8
blob: b3c27c3a7e98e822ac3a496ead17817674903b81 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "PUPPETRUN" "8" "August 2010" "" ""
Trigger a puppet agent run on a set of hosts\.puppet kick [\-a|\-\-all] [\-c|\-\-class \fIclass\fR] [\-d|\-\-debug] [\-f|\-\-foreground]
.
.IP "" 4
.
.nf

  [\-h|\-\-help] [\-\-host <host>] [\-\-no\-fqdn] [\-\-ignoreschedules]
  [\-t|\-\-tag <tag>] [\-\-test] [\-p|\-\-ping] <host> [<host> [\.\.\.]]
.
.fi
.
.IP "" 0
This script can be used to connect to a set of machines running +puppet agent+ and trigger them to run their configurations\. The most common usage would be to specify a class of hosts and a set of tags, and +puppet kick+ would look up in LDAP all of the hosts matching that class, then connect to each host and trigger a run of all of the objects with the specified tags\.
.
.P
If you are not storing your host configurations in LDAP, you can specify hosts manually\.
.
.P
You will most likely have to run +puppet kick+ as root to get access to the SSL certificates\.
.
.P
+puppet kick+ reads +puppet master+\'s configuration file, so that it can copy things like LDAP settings\.+puppet kick+ is useless unless +puppet agent+ is listening\. See its documentation for more information, but the gist is that you must enable +listen+ on the +puppet agent+ daemon, either using +\-\-listen+ on the command line or adding \'listen: true\' in its config file\. In addition, you need to set the daemons up to specifically allow connections by creating the +namespaceauth+ file, normally at \'/etc/puppet/namespaceauth\.conf\'\. This file specifies who has access to each namespace; if you create the file you must add every namespace you want any Puppet daemon to allow \-\- it is currently global to all Puppet daemons\.
.
.P
An example file looks like this::
.
.IP "" 4
.
.nf

[fileserver]
    allow *\.madstop\.com

[puppetmaster]
    allow *\.madstop\.com

[puppetrunner]
    allow culain\.madstop\.com
.
.fi
.
.IP "" 0
.
.P
This is what you would install on your Puppet master; non\-master hosts could leave off the \'fileserver\' and \'puppetmaster\' namespaces\.Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid configuration parameter, so you can specify \'\-\-ssldir \fIdirectory\fR\' as an argument\.
.
.P
See the configuration file documentation at http://reductivelabs\.com/projects/puppet/reference/configref\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet master with \'\-\-genconfig\'\.
.
.P
all: Connect to all available hosts\. Requires LDAP support
.
.IP "" 4
.
.nf

             at this point\.
.
.fi
.
.IP "" 0
.
.P
class: Specify a class of machines to which to connect\. This
.
.IP "" 4
.
.nf

             only works if you have LDAP configured, at the moment\.
.
.fi
.
.IP "" 0
.
.P
debug: Enable full debugging\.
.
.P
foreground: Run each configuration in the foreground; that is, when
.
.IP "" 4
.
.nf

             connecting to a host, do not return until the host has
             finished its run\. The default is false\.
.
.fi
.
.IP "" 0
.
.P
help: Print this help message
.
.P
host: A specific host to which to connect\. This flag can be
.
.IP "" 4
.
.nf

             specified more than once\.
.
.fi
.
.IP "" 0
.
.P
ignoreschedules: Whether the client should ignore schedules when running
.
.IP "" 4
.
.nf

             its configuration\. This can be used to force the client
             to perform work it would not normally perform so soon\.
             The default is false\.
.
.fi
.
.IP "" 0
.
.P
parallel: How parallel to make the connections\. Parallelization
.
.IP "" 4
.
.nf

             is provided by forking for each client to which to
             connect\. The default is 1, meaning serial execution\.
.
.fi
.
.IP "" 0
.
.P
tag: Specify a tag for selecting the objects to apply\. Does
.
.IP "" 4
.
.nf

             not work with the \-\-test option\.
.
.fi
.
.IP "" 0
.
.P
test: Print the hosts you would connect to but do not
.
.IP "" 4
.
.nf

             actually connect\. This option requires LDAP support at
             this point\.
.
.fi
.
.IP "" 0
.
.P
ping::
.
.P
Do a ICMP echo against the target host\. Skip hosts that don\'t respond to ping\.sudo puppet kick \-p 10 \-t remotefile \-t webserver host1 host2Luke KaniesCopyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public License