diff --git a/bin/filebucket b/bin/filebucket index 1c5daa4e3..aa0a1d9d0 100755 --- a/bin/filebucket +++ b/bin/filebucket @@ -1,101 +1,101 @@ #!/usr/bin/env ruby # # = Synopsis # # A stand-alone Puppet filebucket client. # # = Usage # -# filebucket [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] +# puppet filebucket [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] # [-l|--local] [-r|--remote] # [-s|--server ] [-b|--bucket ] ... # # = Description # # This is a stand-alone filebucket client for sending files to a local # or central filebucket. # # = Usage # # This client can operate in three modes, with only one mode per call: # # backup:: # Send one or more files to the specified file bucket. Each sent file # is printed with its resulting md5 sum. # # get:: # Return the text associated with an md5 sum. The text is printed to # stdout, and only one file can be retrieved at a time. # # restore:: # Given a file path and an md5 sum, store the content associated with the # sum into the specified file path. You can specify an entirely new path # to this argument; you are not restricted to restoring the content to its # original location. # # Note that +filebucket+ defaults to using a network-based filebucket available on # the server named +puppet+. To use this, you'll have to be running as a user # with valid Puppet certificates. Alternatively, you can use your local file bucket # by specifying +--local+. # # = Example # -# $ filebucket backup /etc/passwd +# $ puppet filebucket backup /etc/passwd # /etc/passwd: 429b225650b912a2ee067b0a4cf1e949 -# $ filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 +# $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 # $ # # = Options # # 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 ' as an argument. # # See the configuration file documentation at # http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference for # the full list of acceptable parameters. A commented list of all # configuration options can also be generated by running puppet with # '--genconfig'. # # debug:: # Enable full debugging. # # help:: # Print this help message # # local:: # Use the local filebucket. This will use the default configuration # information. # # remote:: # Use a remote filebucket. This will use the default configuration # information. # # server:: # The server to send the file to, instead of locally. # # verbose:: # Print extra information. # # version:: # Print version information. # # = Example # -# filebucket -b /tmp/filebucket /my/file +# puppet filebucket -b /tmp/filebucket /my/file # # = Author # # Luke Kanies # # = Copyright # # Copyright (c) 2005 Reductive Labs, LLC # Licensed under the GNU Public License require 'puppet/application' require 'puppet/application/filebucket' # launch the filebucket Puppet::Application[:filebucket].run diff --git a/bin/pi b/bin/pi index 68e756a35..fe847d1c1 100755 --- a/bin/pi +++ b/bin/pi @@ -1,50 +1,50 @@ #!/usr/bin/env ruby # # = Synopsis # # Print help about puppet types on the console. Run with '-h' to get detailed # help. # = Usage # -# pi [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta] +# puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta] # # = Description # # Prints details of Puppet types, providers and metaparameters on the console. # # = Options # # help:: # Print this help text # # providers:: # Describe providers in detail for each type # # list:: # List all types # # meta:: # List all metaparameters # # short:: # List only parameters without detail # # = Example # -# pi --list -# pi file --providers -# pi user -s -m +# puppet describe --list +# puppet describe file --providers +# puppet describe user -s -m # # = Author # # David Lutterkort # # = Copyright # # Copyright (c) 2005 Reductive Labs, LLC # Licensed under the GNU Public License require 'puppet/application/describe' Puppet::Application[:describe].run diff --git a/bin/puppetdoc b/bin/puppetdoc index e17b014b3..849b5338b 100755 --- a/bin/puppetdoc +++ b/bin/puppetdoc @@ -1,65 +1,65 @@ #!/usr/bin/env ruby # # = Synopsis # # Generate a reference for all Puppet types. Largely meant for internal Reductive # Labs use. # # = Usage # -# puppetdoc [-a|--all] [-h|--help] [-o|--outputdir ] [-m|--mode ] -# [-r|--reference <[type]|configuration|..>] [manifest-file] +# puppet doc [-a|--all] [-h|--help] [-o|--outputdir ] [-m|--mode ] +# [-r|--reference <[type]|configuration|..>] [manifest-file] # # = Description # # If mode is not 'rdoc', then this command generates a restructured-text document describing all installed # Puppet types or all allowable arguments to puppet executables. It is largely # meant for internal use and is used to generate the reference document # available on the Reductive Labs web site. # # In 'rdoc' mode, this command generates an html RDoc hierarchy describing the manifests that # are in 'manifestdir' and 'modulepath' configuration directives. # The generated documentation directory is doc by default but can be changed with the 'outputdir' option. # -# If the command is started with 'manifest-file' command-line arguments, puppetdoc generate a single +# If the command is started with 'manifest-file' command-line arguments, puppet doc generate a single # manifest documentation that is output on stdout. # # = Options # # all:: # Output the docs for all of the reference types. In 'rdoc' modes, this also outputs documentation for all resources # # help:: # Print this help message # # outputdir:: # Specifies the directory where to output the rdoc documentation in 'rdoc' mode. # # mode:: # Determine the output mode. Valid modes are 'text', 'trac', 'pdf', 'markdown' and 'rdoc'. The 'pdf' and 'markdown' modes create PDF or Markdown formatted files in the /tmp directory. Note that 'trac' mode only works on Reductive Labs servers. The default mode is 'text'. In 'rdoc' mode you must provide 'manifests-path' # # reference:: -# Build a particular reference. Get a list of references by running +puppetdoc --list+. +# Build a particular reference. Get a list of references by running +puppet doc --list+. # # = Example # -# $ puppetdoc -r type > /tmp/type_reference.rst +# $ puppet doc -r type > /tmp/type_reference.rst # or -# $ puppetdoc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests +# $ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests # or -# $ puppetdoc /etc/puppet/manifests/site.pp +# $ puppet doc /etc/puppet/manifests/site.pp # or -# $ puppetdoc -m markdown -r configuration +# $ puppet doc -m markdown -r configuration # # = Author # # Luke Kanies # # = Copyright # # Copyright (c) 2005-2007 Reductive Labs, LLC # Licensed under the GNU Public License require 'puppet/application/doc' Puppet::Application[:doc].run diff --git a/bin/ralsh b/bin/ralsh index c99672ae4..00a6925a1 100755 --- a/bin/ralsh +++ b/bin/ralsh @@ -1,89 +1,90 @@ #!/usr/bin/env ruby # vim: softtabstop=4 shiftwidth=4 expandtab # # = Synopsis # # Use the Puppet RAL to directly interact with the system. # # = Usage # -# ralsh [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit] [-H|--host ] -# [-p|--param ] [-t|--types] type +# puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit] +# [-H|--host ] [-p|--param ] [-t|--types] +# type # # = Description # # This command provides simple facilities for converting current system state # into Puppet code, along with some ability to use Puppet to affect the current # state. # -# By default, you must at least provide a type to list, which case ralsh +# By default, you must at least provide a type to list, which case puppet resource # will tell you everything it knows about all instances of that type. You can -# optionally specify an instance name, and ralsh will only describe that single +# optionally specify an instance name, and puppet resource will only describe that single # instance. # -# You can also add +--edit+ as an argument, and ralsh will write its output +# You can also add +--edit+ as an argument, and puppet resource will write its output # to a file, open that file in an editor, and then apply the file as a Puppet # transaction. You can easily use this to use Puppet to make simple changes to # a system. # # = Options # # 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 ' as an argument. # # See the configuration file documentation at # http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference for # the full list of acceptable parameters. A commented list of all # configuration options can also be generated by running puppet with # '--genconfig'. # # debug:: # Enable full debugging. # # edit: # Write the results of the query to a file, open the file in an editor, # and read the file back in as an executable Puppet manifest. # # host: # When specified, connect to the resource server on the named host # and retrieve the list of resouces of the type specified. # # help: # Print this help message. # # param: # Add more parameters to be outputted from queries. # # types: # List all available types. # # verbose:: # Print extra information. # # = Example # -# This example uses ``ralsh`` to return Puppet configuration for the user ``luke``:: +# This example uses ``puppet resource`` to return Puppet configuration for the user ``luke``:: # -# $ ralsh user luke +# $ puppet resource user luke # user { 'luke': # home => '/home/luke', # uid => '100', # ensure => 'present', # comment => 'Luke Kanies,,,', # gid => '1000', # shell => '/bin/bash', # groups => ['sysadmin','audio','video','puppet'] # } # # = Author # # Luke Kanies # # = Copyright # # Copyright (c) 2005-2007 Reductive Labs, LLC # Licensed under the GNU Public License -require 'puppet/application/ralsh' +require 'puppet/application/resource' Puppet::Application[:resource].run diff --git a/sbin/puppetca b/sbin/puppetca index ce2e315a7..15bc3c64f 100755 --- a/sbin/puppetca +++ b/sbin/puppetca @@ -1,111 +1,111 @@ #!/usr/bin/env ruby # # = Synopsis # # Stand-alone certificate authority. Capable of generating certificates # but mostly meant for signing certificate requests from puppet clients. # # = Usage # -# puppetca [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] +# puppet cert [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] # [-g|--generate] [-l|--list] [-s|--sign] [-r|--revoke] # [-p|--print] [-c|--clean] [--verify] [--digest DIGEST] # [--fingerprint] [host] # # = Description # # Because the puppetmasterd daemon defaults to not signing client certificate # requests, this script is available for signing outstanding requests. It # can be used to list outstanding requests and then either sign them individually # or sign all of them. # # = Options # # 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 ' as an argument. # # 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 puppetca with +# configuration options can also be generated by running puppet cert with # '--genconfig'. # # all:: # Operate on all items. Currently only makes sense with '--sign', # '--clean', or '--list'. # # digest:: # Set the digest for fingerprinting (defaults to md5). Valid values depends # on your openssl and openssl ruby extension version, but should contain at # least md5, sha1, md2, sha256. # # clean:: -# Remove all files related to a host from puppetca's storage. This is +# Remove all files related to a host from puppet cert's storage. This is # useful when rebuilding hosts, since new certificate signing requests -# will only be honored if puppetca does not have a copy of a signed +# will only be honored if puppet cert does not have a copy of a signed # certificate for that host. The certificate of the host remains valid. # If '--all' is specified then all host certificates, both signed and # unsigned, will be removed. # # debug:: # Enable full debugging. # # generate:: # Generate a certificate for a named client. A certificate/keypair will be # generated for each client named on the command line. # # help:: # Print this help message # # list:: # List outstanding certificate requests. If '--all' is specified, # signed certificates are also listed, prefixed by '+', and revoked # or invalid certificates are prefixed by '-' (the verification outcome # is printed in parenthesis). # # print:: # Print the full-text version of a host's certificate. # # fingerprint:: # Print the DIGEST (defaults to md5) fingerprint of a host's certificate. # # revoke:: # Revoke the certificate of a client. The certificate can be specified # either by its serial number, given as a decimal number or a hexadecimal # number prefixed by '0x', or by its hostname. The certificate is revoked # by adding it to the Certificate Revocation List given by the 'cacrl' # config parameter. Note that the puppetmasterd needs to be restarted # after revoking certificates. # # sign:: # Sign an outstanding certificate request. Unless '--all' is specified, # hosts must be listed after all flags. # # verbose:: # Enable verbosity. # # version:: # Print the puppet version number and exit. # # verify:: # Verify the named certificate against the local CA certificate. # # = Example # -# $ puppetca -l +# $ puppet cert -l # culain.madstop.com -# $ puppetca -s culain.madstop.com +# $ puppet cert -s culain.madstop.com # # = Author # # Luke Kanies # # = Copyright # # Copyright (c) 2005 Reductive Labs, LLC # Licensed under the GNU Public License require 'puppet/application/cert' Puppet::Application[:cert].run diff --git a/sbin/puppetd b/sbin/puppetd index f88e0fefe..d54834ab7 100755 --- a/sbin/puppetd +++ b/sbin/puppetd @@ -1,186 +1,186 @@ #!/usr/bin/env ruby # == Synopsis # -# Retrieve the client configuration from the central puppet server and apply +# Retrieve the client configuration from the puppet master and apply # it to the local host. # # Currently must be run out periodically, using cron or something similar. # # = Usage # -# puppetd [-D|--daemonize|--no-daemonize] [-d|--debug] +# puppet agent [-D|--daemonize|--no-daemonize] [-d|--debug] # [--detailed-exitcodes] [--disable] [--enable] # [-h|--help] [--fqdn ] [-l|--logdest syslog||console] # [-o|--onetime] [--serve ] [-t|--test] [--noop] # [--digest ] [--fingerprint] [-V|--version] # [-v|--verbose] [-w|--waitforcert ] # # = Description # # This is the main puppet client. Its job is to retrieve the local machine's # configuration from a remote server and apply it. In order to successfully # communicate with the remote server, the client must have a certificate signed # by a certificate authority that the server trusts; the recommended method # for this, at the moment, is to run a certificate authority as part of the # puppet server (which is the default). The client will connect and request # a signed certificate, and will continue connecting until it receives one. # # Once the client has a signed certificate, it will retrieve its configuration # and apply it. # # = Usage Notes # -# +puppetd+ does its best to find a compromise between interactive use and +# +puppet agent+ does its best to find a compromise between interactive use and # daemon use. Run with no arguments and no configuration, it will go into the # backgroun, attempt to get a signed certificate, and retrieve and apply its # configuration every 30 minutes. # # Some flags are meant specifically for interactive use -- in particular, # +test+, +tags+ or +fingerprint+ are useful. +test+ enables verbose logging, causes # the daemon to stay in the foreground, exits if the server's configuration is # invalid (this happens if, for instance, you've left a syntax error on the # server), and exits after running the configuration once (rather than hanging # around as a long-running process). # # +tags+ allows you to specify what portions of a configuration you want to apply. # Puppet elements are tagged with all of the class or definition names that # contain them, and you can use the +tags+ flag to specify one of these names, # causing only configuration elements contained within that class or definition # to be applied. This is very useful when you are testing new configurations -- # for instance, if you are just starting to manage +ntpd+, you would put all of # the new elements into an +ntpd+ class, and call puppet with +--tags ntpd+, # which would only apply that small portion of the configuration during your # testing, rather than applying the whole thing. # -# +fingerprint+ is a one-time flag. In this mode +puppetd+ will run once and +# +fingerprint+ is a one-time flag. In this mode +puppet agent+ will run once and # display on the console (and in the log) the current certificate (or certificate # request) fingerprint. Providing the +--digest+ option allows to use a different # digest algorithm to generate the fingerprint. The main use is to verify that # before signing a certificate request on the master, the certificate request the # master received is the same as the one the client sent (to prevent against # man-in-the-middle attacks when signing certificates). # # # = Options # # Note that any configuration parameter that's valid in the configuration file # is also a valid long argument. For example, 'server' is a valid configuration # parameter, so you can specify '--server ' as an argument. # # See the configuration file documentation at # http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference for # the full list of acceptable parameters. A commented list of all -# configuration options can also be generated by running puppetd with +# configuration options can also be generated by running puppet agent with # '--genconfig'. # # daemonize:: # Send the process into the background. This is the default. # # no-daemonize:: # Do not send the process into the background. # # debug:: # Enable full debugging. # # digest:: # Change the certificate fingerprinting digest algorithm. The default is MD5. # Valid values depends on the version of OpenSSL installed, but should always # at least contain MD5, MD2, SHA1 and SHA256. # # detailed-exitcodes:: # Provide transaction information via exit codes. If this is enabled, an # exit code of '2' means there were changes, and an exit code of '4' means # that there were failures during the transaction. This option only makes # sense in conjunction with --onetime. # # disable:: # Disable working on the local system. This puts a lock file in place, -# causing +puppetd+ not to work on the system until the lock file is removed. +# causing +puppet agent+ not to work on the system until the lock file is removed. # This is useful if you are testing a configuration and do not want the central # configuration to override the local state until everything is tested and # committed. # -# +puppetd+ uses the same lock file while it is running, so no more than one -# +puppetd+ process is working at a time. +# +puppet agent+ uses the same lock file while it is running, so no more than one +# +puppet agent+ process is working at a time. # -# +puppetd+ exits after executing this. +# +puppet agent+ exits after executing this. # # enable:: # Enable working on the local system. This removes any lock file, causing -# +puppetd+ to start managing the local system again (although it will continue +# +puppet agent+ to start managing the local system again (although it will continue # to use its normal scheduling, so it might not start for another half hour). # -# +puppetd+ exits after executing this. +# +puppet agent+ exits after executing this. # # fqdn:: # Set the fully-qualified domain name of the client. This is only used for # certificate purposes, but can be used to override the discovered hostname. # If you need to use this flag, it is generally an indication of a setup problem. # # help:: # Print this help message # # logdest:: # Where to send messages. Choose between syslog, the console, and a log file. # Defaults to sending messages to syslog, or the console if debugging or # verbosity is enabled. # # no-client:: # Do not create a config client. This will cause the daemon to run # without ever checking for its configuration automatically, and only # makes sense when used in conjunction with --listen. # # onetime:: -# Run the configuration once. Runs a single daemonized Puppet run. Useful for -# interactively running puppetd and hence used in conjunction with the --no-daemonize -# option. +# Run the configuration once. Runs a single (normally daemonized) Puppet run. +# Useful for interactively running puppet agent when used in conjunction with +# the --no-daemonize option. # # fingerprint:: # Display the current certificate or certificate signing request fingerprint # and then exit. Use the +--digest+ option to change the digest algorithm used. # # serve:: -# Start another type of server. By default, +puppetd+ will start +# Start another type of server. By default, +puppet agent+ will start # a service handler that allows authenticated and authorized remote nodes to # trigger the configuration to be pulled down and applied. You can specify # any handler here that does not require configuration, e.g., filebucket, ca, # or resource. The handlers are in +lib/puppet/network/handler+, and the names # must match exactly, both in the call to +serve+ and in +namespaceauth.conf+. # # test:: # Enable the most common options used for testing. These are +onetime+, # +verbose+, +ignorecache, +no-daemonize+, and +no-usecacheonfailure+. # # noop:: # Use +noop+ mode where the daemon runs in a no-op or dry-run mode. This is useful # for seeing what changes Puppet will make without actually executing the changes. # # verbose:: # Turn on verbose reporting. # # version:: # Print the puppet version number and exit. # # waitforcert:: # This option only matters for daemons that do not yet have certificates # and it is enabled by default, with a value of 120 (seconds). This causes -# +puppetd+ to connect to the server every 2 minutes and ask it to sign a +# +puppet agent+ to connect to the server every 2 minutes and ask it to sign a # certificate request. This is useful for the initial setup of a puppet # client. You can turn off waiting for certificates by specifying a time # of 0. # # = Example # -# puppetd --server puppet.domain.com +# puppet agent --server puppet.domain.com # # = Author # # Luke Kanies # # = Copyright # # Copyright (c) 2005, 2006 Reductive Labs, LLC # Licensed under the GNU Public License require 'puppet/application/agent' Puppet::Application[:agent].run diff --git a/sbin/puppetmasterd b/sbin/puppetmasterd index 454703bc7..53b9242ab 100755 --- a/sbin/puppetmasterd +++ b/sbin/puppetmasterd @@ -1,66 +1,66 @@ #!/usr/bin/env ruby # # = Synopsis # # The central puppet server. Functions as a certificate authority by default. # # = Usage # -# puppetmasterd [-D|--daemonize|--no-daemonize] [-d|--debug] [-h|--help] +# puppet master [-D|--daemonize|--no-daemonize] [-d|--debug] [-h|--help] # [-l|--logdest |console|syslog] [-v|--verbose] [-V|--version] # # = Description # # This is the puppet central daemon. # # = Options # # 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 ' as an argument. # # See the configuration file documentation at # http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference for # the full list of acceptable parameters. A commented list of all # configuration options can also be generated by running puppetmasterdd with # '--genconfig'. # # daemonize:: # Send the process into the background. This is the default. # # no-daemonize:: # Do not send the process into the background. # # debug:: # Enable full debugging. # # help:: # Print this help message. # # logdest:: # Where to send messages. Choose between syslog, the console, and a log file. # Defaults to sending messages to syslog, or the console # if debugging or verbosity is enabled. # # verbose:: # Enable verbosity. # # version:: # Print the puppet version number and exit. # # = Example # -# puppetmasterd +# puppet master # # = Author # # Luke Kanies # # = Copyright # # Copyright (c) 2005 Reductive Labs, LLC # Licensed under the GNU Public License require 'puppet/application/master' Puppet::Application[:master].run diff --git a/sbin/puppetqd b/sbin/puppetqd index 4cf8d4f02..56c82ca46 100755 --- a/sbin/puppetqd +++ b/sbin/puppetqd @@ -1,53 +1,53 @@ #!/usr/bin/env ruby # == Synopsis # # Retrieve serialized records from a queue and process them in order. # # = Usage # -# puppetqd [-d|--debug] [-v|--verbose] +# puppet queue [-d|--debug] [-v|--verbose] # # = Description # # This is a simple application that just processes entities in a queue as they # are recieved. # # = Options # # Note that any configuration parameter that's valid in the configuration file # is also a valid long argument. For example, 'server' is a valid configuration # parameter, so you can specify '--server ' as an argument. # # See the configuration file documentation at # http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference for # the full list of acceptable parameters. A commented list of all # configuration options can also be generated by running puppetd with # '--genconfig'. # # debug:: # Enable full debugging. # # help:: # Print this help message # # verbose:: # Turn on verbose reporting. # # version:: # Print the puppet version number and exit. # # = Example # -# puppetqd +# puppet queue # # = Author # # Luke Kanies # # = Copyright # # Copyright (c) 2009 Reductive Labs, LLC # Licensed under the GNU Public License require 'puppet/application/queue' Puppet::Application[:queue].run diff --git a/sbin/puppetrun b/sbin/puppetrun index 641c1bb78..d2a1284c9 100755 --- a/sbin/puppetrun +++ b/sbin/puppetrun @@ -1,130 +1,130 @@ #!/usr/bin/env ruby # # = Synopsis # -# Trigger a puppetd run on a set of hosts. +# Trigger a puppet agent run on a set of hosts. # # = Usage # -# puppetrun [-a|--all] [-c|--class ] [-d|--debug] [-f|--foreground] +# puppet kick [-a|--all] [-c|--class ] [-d|--debug] [-f|--foreground] # [-h|--help] [--host ] [--no-fqdn] [--ignoreschedules] # [-t|--tag ] [--test] [-p|--ping] # # = Description # -# This script can be used to connect to a set of machines running +puppetd+ +# 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 +puppetrun+ 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. # # If you are not storing your host configurations in LDAP, you can specify # hosts manually. # -# You will most likely have to run +puppetrun+ as root to get access to +# You will most likely have to run +puppet kick+ as root to get access to # the SSL certificates. # -# +puppetrun+ reads +puppetmaster+'s configuration file, so that it can copy +# +puppet kick+ reads +puppet master+'s configuration file, so that it can copy # things like LDAP settings. # # = Usage Notes # -# +puppetrun+ is useless unless +puppetd+ is listening. See its documentation +# +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 -# +puppetd+ daemon, either using +--listen+ on the command line or adding +# +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. # # An example file looks like this:: # # [fileserver] # allow *.madstop.com # # [puppetmaster] # allow *.madstop.com # # [puppetrunner] # allow culain.madstop.com # # This is what you would install on your Puppet master; non-master hosts could # leave off the 'fileserver' and 'puppetmaster' namespaces. # # Expect more documentation on this eventually. # # = Options # # 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 ' as an argument. # # 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 puppetmasterdd with +# configuration options can also be generated by running puppet master with # '--genconfig'. # # # all:: # Connect to all available hosts. Requires LDAP support at this point. # # class:: # Specify a class of machines to which to connect. This only works if you # have LDAP configured, at the moment. # # debug:: # Enable full debugging. # # 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. # # help:: # Print this help message # # host:: # A specific host to which to connect. This flag can be specified more # than once. # # 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. # # 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. # # tag:: # Specify a tag for selecting the objects to apply. Does not work with the # --test option. # # # test:: # Print the hosts you would connect to but do not actually connect. This # option requires LDAP support at this point. # # ping:: # # Do a ICMP echo against the target host. Skip hosts that don't respond to ping. # # = Example # -# sudo puppetrun -p 10 --host host1 --host host2 -t remotefile -t webserver +# sudo puppet kick -p 10 --host host1 --host host2 -t remotefile -t webserver # # = Author # # Luke Kanies # # = Copyright # # Copyright (c) 2005 Reductive Labs, LLC # Licensed under the GNU Public License require 'puppet/application/kick' Puppet::Application[:kick].run