puppet 2.6.18 → 2.7.1

data/lib/puppet/application/facts.rb

@@ -0,0 +1,4 @@
+require 'puppet/application/indirection_base'
+
+class Puppet::Application::Facts < Puppet::Application::IndirectionBase
+end

data/lib/puppet/application/file.rb

@@ -0,0 +1,4 @@
+require 'puppet/application/indirection_base'
+
+class Puppet::Application::File < Puppet::Application::IndirectionBase
+end

data/lib/puppet/application/filebucket.rb

@@ -12,6 +12,108 @@ class Puppet::Application::Filebucket < Puppet::Application
 
   attr :args
 
+  def help
+    <<-HELP
+
+puppet-filebucket(8) -- Store and retrieve files in a filebucket
+========
+
+SYNOPSIS
+--------
+A stand-alone Puppet filebucket client.
+
+
+USAGE
+-----
+puppet filebucket <mode> [-h|--help] [-V|--version] [-d|--debug]
+  [-v|--verbose] [-l|--local] [-r|--remote] [-s|--server <server>]
+  [-b|--bucket <directory>] <file> <file> ...
+
+Puppet filebucket 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.
+
+
+DESCRIPTION
+-----------
+This is a stand-alone filebucket client for sending files to a local or
+central filebucket.
+
+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'.
+
+
+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 <directory>' as an
+argument.
+
+See the configuration file documentation at
+http://docs.puppetlabs.com/references/stable/configuration.html 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
+-------
+    $ puppet filebucket backup /etc/passwd
+    /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
+    $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
+
+
+AUTHOR
+------
+Luke Kanies
+
+
+COPYRIGHT
+---------
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+
+    HELP
+  end
+
+
   def run_command
     @args = command_line.args
     command = args.shift

data/lib/puppet/application/help.rb

@@ -0,0 +1,4 @@
+require 'puppet/application/face_base'
+
+class Puppet::Application::Help < Puppet::Application::FaceBase
+end

data/lib/puppet/application/indirection_base.rb

@@ -0,0 +1,4 @@
+require 'puppet/application/face_base'
+
+class Puppet::Application::IndirectionBase < Puppet::Application::FaceBase
+end

data/lib/puppet/application/inspect.rb

@@ -1,4 +1,6 @@
+require 'puppet'
 require 'puppet/application'
+require 'puppet/file_bucket/dipper'
 
 class Puppet::Application::Inspect < Puppet::Application
 
@@ -18,22 +20,24 @@ class Puppet::Application::Inspect < Puppet::Application
   end
 
   def help
-    puts <<-HELP ; exit # XXX
+    <<-HELP
 
-SYNOPSIS
+puppet-inspect(8) -- Send an inspection report
 ========
 
-Prepare and submit an inspection report to the puppet master.
+SYNOPSIS
+--------
+
+Prepares and submits an inspection report to the puppet master.
 
 
 USAGE
-=====
-
-  puppet inspect
+-----
+puppet inspect
 
 
 DESCRIPTION
-===========
+-----------
 
 This command uses the cached catalog from the previous run of 'puppet
 agent' to determine which attributes of which resources have been
@@ -42,11 +46,12 @@ 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.
 
-Puppet inspect does not run as a daemon, and must be run manually or from cron.
+Puppet inspect does not run as a daemon, and must be run manually or
+from cron.
 
 
 OPTIONS
-=======
+-------
 
 Any configuration setting which is valid in the configuration file is
 also a valid long argument, e.g. '--server=master.domain.com'. See the
@@ -56,16 +61,14 @@ the full list of acceptable settings.
 
 
 AUTHOR
-======
+------
 
 Puppet Labs
 
 
 COPYRIGHT
-=========
-
-Copyright (c) 2011 Puppet Labs, LLC
-Licensed under the GNU General Public License version 2
+---------
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
 
     HELP
   end
@@ -91,20 +94,15 @@ Licensed under the GNU General Public License version 2
       Puppet::Util::Log.level = :info
     end
 
-    Puppet::Transaction::Report.terminus_class = :rest
-    Puppet::Resource::Catalog.terminus_class = :yaml
-  end
-
-  def preinit
-    require 'puppet'
-    require 'puppet/file_bucket/dipper'
+    Puppet::Transaction::Report.indirection.terminus_class = :rest
+    Puppet::Resource::Catalog.indirection.terminus_class = :yaml
   end
 
   def run_command
     benchmark(:notice, "Finished inspection") do
       retrieval_starttime = Time.now
 
-      unless catalog = Puppet::Resource::Catalog.find(Puppet[:certname])
+      unless catalog = Puppet::Resource::Catalog.indirection.find(Puppet[:certname])
         raise "Could not find catalog for #{Puppet[:certname]}"
       end
 
@@ -171,7 +169,7 @@ Licensed under the GNU General Public License version 2
       @report.finalize_report
 
       begin
-        @report.save
+        Puppet::Transaction::Report.indirection.save(@report)
       rescue => detail
         puts detail.backtrace if Puppet[:trace]
         Puppet.err "Could not send report: #{detail}"

data/lib/puppet/application/key.rb

@@ -0,0 +1,4 @@
+require 'puppet/application/indirection_base'
+
+class Puppet::Application::Key < Puppet::Application::IndirectionBase
+end

data/lib/puppet/application/kick.rb

@@ -37,6 +37,131 @@ class Puppet::Application::Kick < Puppet::Application
     end
   end
 
+  def help
+    <<-HELP
+
+puppet-kick(8) -- Remotely control puppet agent
+========
+
+SYNOPSIS
+--------
+Trigger a puppet agent run on a set of hosts.
+
+
+USAGE
+-----
+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> [...]]
+
+
+DESCRIPTION
+-----------
+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.
+
+If you are not storing your host configurations in LDAP, you can specify
+hosts manually.
+
+You will most likely have to run 'puppet kick' as root to get access to
+the SSL certificates.
+
+'puppet kick' reads 'puppet master''s configuration file, so that it can
+copy things like LDAP settings.
+
+
+USAGE NOTES
+-----------
+Puppet kick is useless unless puppet agent is listening for incoming
+connections and allowing access to the `run` endpoint. This entails
+starting the agent with `listen = true` in its puppet.conf file, and
+allowing access to the `/run` path in its auth.conf file; see
+`http://docs.puppetlabs.com/guides/rest_auth_conf.html` for more
+details.
+
+Additionally, due to a known bug, you must make sure a
+namespaceauth.conf file exists in puppet agent's $confdir. This file
+will not be consulted, and may be left empty.  
+
+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 <directory>' as an
+argument.
+
+See the configuration file documentation at
+http://docs.puppetlabs.com/references/latest/configuration.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'.
+
+* --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 puppet kick -p 10 -t remotefile -t webserver host1 host2
+
+
+AUTHOR
+------
+Luke Kanies
+
+
+COPYRIGHT
+---------
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+
+    HELP
+  end
+
   def run_command
     @hosts += command_line.args
     options[:test] ? test : main
@@ -48,6 +173,8 @@ class Puppet::Application::Kick < Puppet::Application
   end
 
   def main
+    require 'puppet/network/client'
+
     Puppet.warning "Failed to load ruby LDAP library. LDAP functionality will not be available" unless Puppet.features.ldap?
     require 'puppet/util/ldap/connection'
 
@@ -102,7 +229,7 @@ class Puppet::Application::Kick < Puppet::Application
       out = %x{ping -c 1 #{host}}
       unless $CHILD_STATUS == 0
         $stderr.print "Could not contact #{host}\n"
-        next
+        exit($CHILD_STATUS)
       end
     end
 
@@ -118,7 +245,7 @@ class Puppet::Application::Kick < Puppet::Application
         :background => ! options[:foreground],
         :ignoreschedules => options[:ignoreschedules]
       }
-      run = Puppet::Run.new( run_options ).save( url )
+      run = Puppet::Run.indirection.save(Puppet::Run.new( run_options ), url)
       puts "Getting status"
       result = run.status
       puts "status is #{result}"
@@ -173,12 +300,12 @@ class Puppet::Application::Kick < Puppet::Application
 
     if Puppet[:node_terminus] == "ldap" and (options[:all] or @classes)
       if options[:all]
-        @hosts = Puppet::Node.search("whatever", :fqdn => options[:fqdn]).collect { |node| node.name }
+        @hosts = Puppet::Node.indirection.search("whatever", :fqdn => options[:fqdn]).collect { |node| node.name }
         puts "all: #{@hosts.join(", ")}"
       else
         @hosts = []
         @classes.each do |klass|
-          list = Puppet::Node.search("whatever", :fqdn => options[:fqdn], :class => klass).collect { |node| node.name }
+          list = Puppet::Node.indirection.search("whatever", :fqdn => options[:fqdn], :class => klass).collect { |node| node.name }
           puts "#{klass}: #{list.join(", ")}"
 
           @hosts += list

data/lib/puppet/application/man.rb

@@ -0,0 +1,4 @@
+require 'puppet/application/face_base'
+
+class Puppet::Application::Man < Puppet::Application::FaceBase
+end

data/lib/puppet/application/master.rb

@@ -25,6 +25,106 @@ class Puppet::Application::Master < Puppet::Application
     end
   end
 
+  option("--parseonly") do
+    puts "--parseonly has been removed. Please use 'puppet parser validate <manifest>'"
+    exit 1
+  end
+
+  def help
+    <<-HELP
+
+puppet-master(8) -- The puppet master daemon
+========
+
+SYNOPSIS
+--------
+The central puppet server. Functions as a certificate authority by
+default.
+
+
+USAGE
+-----
+puppet master [-D|--daemonize|--no-daemonize] [-d|--debug] [-h|--help]
+  [-l|--logdest <file>|console|syslog] [-v|--verbose] [-V|--version]
+  [--compile <node-name>]
+
+
+DESCRIPTION
+-----------
+This command starts an instance of puppet master, running as a daemon
+and using Ruby's built-in Webrick webserver. Puppet master can also be
+managed by other application servers; when this is the case, this
+executable is not used.
+
+
+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 <directory>' as an
+argument.
+
+See the configuration file documentation at
+http://docs.puppetlabs.com/references/stable/configuration.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'.
+
+* --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.
+
+* --compile:
+  Compile a catalogue and output it in JSON from the puppet master. Uses
+  facts contained in the $vardir/yaml/ directory to compile the catalog.
+
+
+EXAMPLE
+-------
+  puppet master
+
+DIAGNOSTICS
+-----------
+
+When running as a standalone daemon, puppet master accepts the
+following signals:
+
+* SIGHUP:
+  Restart the puppet master server.
+* SIGINT and SIGTERM:
+  Shut down the puppet master server.
+
+AUTHOR
+------
+Luke Kanies
+
+
+COPYRIGHT
+---------
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+
+    HELP
+  end
+
   def preinit
     Signal.trap(:INT) do
       $stderr.puts "Cancelling startup"
@@ -40,8 +140,6 @@ class Puppet::Application::Master < Puppet::Application
   def run_command
     if options[:node]
       compile
-    elsif Puppet[:parseonly]
-      parseonly
     else
       main
     end
@@ -51,7 +149,7 @@ class Puppet::Application::Master < Puppet::Application
     Puppet::Util::Log.newdestination :console
     raise ArgumentError, "Cannot render compiled catalogs without pson support" unless Puppet.features.pson?
     begin
-      unless catalog = Puppet::Resource::Catalog.find(options[:node])
+      unless catalog = Puppet::Resource::Catalog.indirection.find(options[:node])
         raise "Could not compile catalog for #{options[:node]}"
       end
 
@@ -63,18 +161,10 @@ class Puppet::Application::Master < Puppet::Application
     exit(0)
   end
 
-  def parseonly
-    begin
-      Puppet::Node::Environment.new(Puppet[:environment]).known_resource_types
-    rescue => detail
-      Puppet.err detail
-      exit 1
-    end
-    exit(0)
-  end
-
   def main
     require 'etc'
+    require 'puppet/file_serving/content'
+    require 'puppet/file_serving/metadata'
 
     xmlrpc_handlers = [:Status, :FileServer, :Master, :Report, :Filebucket]
 
@@ -115,7 +205,7 @@ class Puppet::Application::Master < Puppet::Application
     end
   end
 
-  def setup_logs
+  def setup
     # Handle the logging settings.
     if options[:debug] or options[:verbose]
       if options[:debug]
@@ -131,22 +221,14 @@ class Puppet::Application::Master < Puppet::Application
     end
 
     Puppet::Util::Log.newdestination(:syslog) unless options[:setdest]
-  end
 
-  def setup_terminuses
-    require 'puppet/file_serving/content'
-    require 'puppet/file_serving/metadata'
-
-    # Cache our nodes in yaml.  Currently not configurable.
-    Puppet::Node.cache_class = :yaml
+    exit(Puppet.settings.print_configs ? 0 : 1) if Puppet.settings.print_configs?
 
-    Puppet::FileServing::Content.indirection.terminus_class = :file_server
-    Puppet::FileServing::Metadata.indirection.terminus_class = :file_server
+    Puppet.settings.use :main, :master, :ssl, :metrics
 
-    Puppet::FileBucket::File.indirection.terminus_class = :file
-  end
+    # Cache our nodes in yaml.  Currently not configurable.
+    Puppet::Node.indirection.cache_class = :yaml
 
-  def setup_ssl
     # Configure all of the SSL stuff.
     if Puppet::SSL::CertificateAuthority.ca?
       Puppet::SSL::Host.ca_location = :local
@@ -156,18 +238,4 @@ class Puppet::Application::Master < Puppet::Application
       Puppet::SSL::Host.ca_location = :none
     end
   end
-
-  def setup
-    raise Puppet::Error.new("Puppet master is not supported on Microsoft Windows") if Puppet.features.microsoft_windows?
-
-    setup_logs
-
-    exit(Puppet.settings.print_configs ? 0 : 1) if Puppet.settings.print_configs?
-
-    Puppet.settings.use :main, :master, :ssl, :metrics
-
-    setup_terminuses
-
-    setup_ssl
-  end
 end