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
|
.TH "" "" ""
.SH NAME
\-
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
Trigger a puppet agent run on a set of hosts.
.SH USAGE
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B puppet kick [\-a|\-\-all] [\-c|\-\-class <class>] [\-d|\-\-debug] [\-f|\-\-foreground]
.
[\-h|\-\-help] [\-\-host <host>] [\-\-no\-fqdn] [\-\-ignoreschedules]
[\-t|\-\-tag <tag>] [\-\-test] [\-p|\-\-ping] <host> [<host> [...]]
.UNINDENT
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
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.
.sp
If you are not storing your host configurations in LDAP, you can specify
hosts manually.
.sp
You will most likely have to run +puppet kick+ as root to get access to
the SSL certificates.
.sp
+puppet kick+ reads +puppet master+\(aqs configuration file, so that it can
copy things like LDAP settings.
.SH USAGE NOTES
.sp
+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 \(aqlisten: true\(aq in its config file. In addition,
you need to set the daemons up to specifically allow connections by
creating the +namespaceauth+ file, normally at
\(aq/etc/puppet/namespaceauth.conf\(aq. 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.
.sp
An example file looks like this:
.sp
.nf
.ft C
[fileserver]
allow *.madstop.com
[puppetmaster]
allow *.madstop.com
[puppetrunner]
allow culain.madstop.com
.ft P
.fi
.sp
This is what you would install on your Puppet master; non\-master hosts
could leave off the \(aqfileserver\(aq and \(aqpuppetmaster\(aq namespaces.
.sp
Expect more documentation on this eventually.
.SH OPTIONS
.sp
Note that any configuration parameter that\(aqs valid in the configuration
file is also a valid long argument. For example, \(aqssldir\(aq is a valid
configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an
argument.
.sp
See the configuration file documentation at
\fI\%http://reductivelabs.com/projects/puppet/reference/configref.html\fP for
the full list of acceptable parameters. A commented list of all
configuration options can also be generated by running puppet master
with \(aq\-\-genconfig\(aq.
.INDENT 0.0
.TP
.B all: Connect to all available hosts. Requires LDAP support
.
at this point.
.TP
.B class: Specify a class of machines to which to connect. This
.
only works if you have LDAP configured, at the moment.
.UNINDENT
.sp
debug: Enable full debugging.
.INDENT 0.0
.TP
.B foreground: Run each configuration in the foreground; that is, when
.
connecting to a host, do not return until the host has
finished its run. The default is false.
.UNINDENT
.sp
help: Print this help message
.INDENT 0.0
.TP
.B host: A specific host to which to connect. This flag can be
.
specified more than once.
.TP
.B ignoreschedules: Whether the client should ignore schedules when running
.
its configuration. This can be used to force the client
to perform work it would not normally perform so soon.
The default is false.
.TP
.B parallel: How parallel to make the connections. Parallelization
.
is provided by forking for each client to which to
connect. The default is 1, meaning serial execution.
.TP
.B tag: Specify a tag for selecting the objects to apply. Does
.
not work with the \-\-test option.
.TP
.B test: Print the hosts you would connect to but do not
.
actually connect. This option requires LDAP support at
this point.
.UNINDENT
.sp
ping:
.sp
.nf
.ft C
Do a ICMP echo against the target host. Skip hosts that don\(aqt respond to ping.
.ft P
.fi
.SH EXAMPLE
.INDENT 0.0
.INDENT 3.5
.sp
sudo puppet kick \-p 10 \-t remotefile \-t webserver host1 host2
.UNINDENT
.UNINDENT
.SH AUTHOR
.sp
Luke Kanies
.SH COPYRIGHT
.sp
Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
License
.\" Generated by docutils manpage writer.
.\"
.
|
