puppet 2.6.18 → 2.7.1

data/lib/puppet/application/apply.rb

@@ -26,11 +26,110 @@ class Puppet::Application::Apply < 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-apply(8) -- Apply Puppet manifests locally
+========
+
+SYNOPSIS
+--------
+Applies a standalone Puppet manifest to the local system.
+
+
+USAGE
+-----
+puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
+  [-e|--execute] [--detailed-exitcodes] [-l|--logdest <file>]
+  [--apply <catalog>] <file>
+
+
+DESCRIPTION
+-----------
+This is the standalone puppet execution tool; use it to apply
+individual manifests.
+
+When provided with a modulepath, via command line or config file, puppet
+apply can effectively mimic the catalog that would be served by puppet
+master with access to the same modules, although there are some subtle
+differences. When combined with scheduling and an automated system for
+pushing manifests, this can be used to implement a serverless Puppet
+site.
+
+Most users should use 'puppet agent' and 'puppet master' for site-wide
+manifests.
+
+
+OPTIONS
+-------
+Note that any configuration parameter that's valid in the configuration
+file is also a valid long argument. For example, 'modulepath' is a
+valid configuration parameter, so you can specify '--tags <class>,<tag>'
+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.
+
+* --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.
+
+* --help:
+  Print this help message
+
+* --loadclasses:
+  Load any stored classes. 'puppet agent' caches configured classes
+  (usually at /etc/puppet/classes.txt), and setting this option causes
+  all of those classes to be set in your puppet manifest.
+
+* --logdest:
+  Where to send messages. Choose between syslog, the console, and a log
+  file. Defaults to sending messages to the console.
+
+* --execute:
+  Execute a specific piece of Puppet code
+
+* --verbose:
+  Print extra information.
+
+* --apply:
+  Apply a JSON catalog (such as one generated with 'puppet master --compile'). You can
+  either specify a JSON file or pipe in JSON from standard input.
+
+
+EXAMPLE
+-------
+    $ puppet apply -l /tmp/manifest.log manifest.pp
+    $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"
+
+
+AUTHOR
+------
+Luke Kanies
+
+
+COPYRIGHT
+---------
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+
+    HELP
+  end
+
   def run_command
     if options[:catalog]
       apply
-    elsif Puppet[:parseonly]
-      parseonly
     else
       main
     end
@@ -57,22 +156,6 @@ class Puppet::Application::Apply < Puppet::Application
     configurer.run :catalog => catalog
   end
 
-  def parseonly
-    # Set our code or file to use.
-    if options[:code] or command_line.args.length == 0
-      Puppet[:code] = options[:code] || STDIN.read
-    else
-      Puppet[:manifest] = command_line.args.shift
-    end
-    begin
-      Puppet::Node::Environment.new(Puppet[:environment]).known_resource_types
-    rescue => detail
-      Puppet.err detail
-      exit 1
-    end
-    exit 0
-  end
-
   def main
     # Set our code or file to use.
     if options[:code] or command_line.args.length == 0
@@ -85,18 +168,13 @@ class Puppet::Application::Apply < Puppet::Application
     end
 
     # Collect our facts.
-    unless facts = Puppet::Node::Facts.find(Puppet[:node_name_value])
-      raise "Could not find facts for #{Puppet[:node_name_value]}"
-    end
-
-    unless Puppet[:node_name_fact].empty?
-      Puppet[:node_name_value] = facts.values[Puppet[:node_name_fact]]
-      facts.name = Puppet[:node_name_value]
+    unless facts = Puppet::Node::Facts.indirection.find(Puppet[:certname])
+      raise "Could not find facts for #{Puppet[:certname]}"
     end
 
     # Find our Node
-    unless node = Puppet::Node.find(Puppet[:node_name_value])
-      raise "Could not find node #{Puppet[:node_name_value]}"
+    unless node = Puppet::Node.indirection.find(Puppet[:certname])
+      raise "Could not find node #{Puppet[:certname]}"
     end
 
     # Merge in the facts.
@@ -117,7 +195,7 @@ class Puppet::Application::Apply < Puppet::Application
     begin
       # Compile our catalog
       starttime = Time.now
-      catalog = Puppet::Resource::Catalog.find(node.name, :use_node => node)
+      catalog = Puppet::Resource::Catalog.indirection.find(node.name, :use_node => node)
 
       # Translate it to a RAL catalog
       catalog = catalog.to_ral
@@ -130,13 +208,7 @@ class Puppet::Application::Apply < Puppet::Application
       configurer = Puppet::Configurer.new
       report = configurer.run(:skip_plugin_download => true, :catalog => catalog)
 
-      if not report
-        exit(1)
-      elsif options[:detailed_exitcodes] then
-        exit(report.exit_status)
-      else
-        exit(0)
-      end
+      exit( options[:detailed_exitcodes] ? report.exit_status : 0 )
     rescue => detail
       puts detail.backtrace if Puppet[:trace]
       $stderr.puts detail.message
@@ -160,7 +232,7 @@ class Puppet::Application::Apply < Puppet::Application
     end
 
     # we want the last report to be persisted locally
-    Puppet::Transaction::Report.cache_class = :yaml
+    Puppet::Transaction::Report.indirection.cache_class = :yaml
 
     if options[:debug]
       Puppet::Util::Log.level = :debug

data/lib/puppet/application/catalog.rb

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

data/lib/puppet/application/cert.rb

@@ -10,7 +10,6 @@ class Puppet::Application::Cert < Puppet::Application
   def subcommand
     @subcommand
   end
-
   def subcommand=(name)
     # Handle the nasty, legacy mapping of "clean" to "destroy".
     sub = name.to_sym
@@ -39,19 +38,140 @@ class Puppet::Application::Cert < Puppet::Application
 
   require 'puppet/ssl/certificate_authority/interface'
   Puppet::SSL::CertificateAuthority::Interface::INTERFACE_METHODS.reject {|m| m == :destroy }.each do |method|
-    option("--#{method.to_s.gsub('_','-')}", "-#{method.to_s[0,1]}") do
+    option("--#{method}", "-#{method.to_s[0,1]}") do
       self.subcommand = method
     end
   end
 
-  option("--[no-]allow-dns-alt-names") do |value|
-    options[:allow_dns_alt_names] = value
-  end
-
   option("--verbose", "-v") do
     Puppet::Util::Log.level = :info
   end
 
+  def help
+    <<-HELP
+
+puppet-cert(8) -- Manage certificates and requests
+========
+
+SYNOPSIS
+--------
+Standalone certificate authority. Capable of generating certificates,
+but mostly used for signing certificate requests from puppet clients.
+
+
+USAGE
+-----
+puppet cert <action> [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
+  [--digest <digest>] [<host>]
+
+
+DESCRIPTION
+-----------
+Because the puppet master service 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.
+
+ACTIONS
+-------
+
+Every action except 'list' and 'generate' requires a hostname to act on,
+unless the '--all' option is set.
+
+* clean:
+  Revoke a host's certificate (if applicable) and remove all files
+  related to that host from puppet cert's storage. This is useful when
+  rebuilding hosts, since new certificate signing requests will only be
+  honored if puppet cert does not have a copy of a signed certificate
+  for that host. If '--all' is specified then all host certificates,
+  both signed and unsigned, will be removed.
+
+* fingerprint:
+  Print the DIGEST (defaults to md5) fingerprint of a host's
+  certificate.
+
+* generate:
+  Generate a certificate for a named client. A certificate/keypair will
+  be generated for each client named on the command line.
+
+* 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.
+
+* 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' configuration option. Note that the puppet master
+  needs to be restarted after revoking certificates.
+
+* sign:
+  Sign an outstanding certificate request.
+
+* verify:
+  Verify the named certificate against the local CA certificate.
+
+
+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 cert with
+'--genconfig'.
+
+* --all:
+  Operate on all items. Currently only makes sense with the 'sign',
+  'clean', 'list', and 'fingerprint' actions.
+
+* --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.
+
+* --debug:
+  Enable full debugging.
+
+* --help:
+  Print this help message
+
+* --verbose:
+  Enable verbosity.
+
+* --version:
+  Print the puppet version number and exit.
+
+
+EXAMPLE
+-------
+    $ puppet cert list
+    culain.madstop.com
+    $ puppet cert sign culain.madstop.com
+
+
+AUTHOR
+------
+Luke Kanies
+
+
+COPYRIGHT
+---------
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+
+    HELP
+  end
+
   def main
     if @all
       hosts = :all
@@ -61,8 +181,8 @@ class Puppet::Application::Cert < Puppet::Application
       hosts = command_line.args.collect { |h| h.downcase }
     end
     begin
-      @ca.apply(:revoke, options.merge(:to => hosts)) if subcommand == :destroy
-      @ca.apply(subcommand, options.merge(:to => hosts, :digest => @digest))
+      @ca.apply(:revoke, :to => hosts) if subcommand == :destroy
+      @ca.apply(subcommand, :to => hosts, :digest => @digest)
     rescue => detail
       puts detail.backtrace if Puppet[:trace]
       puts detail.to_s
@@ -82,15 +202,6 @@ class Puppet::Application::Cert < Puppet::Application
       Puppet::SSL::Host.ca_location = :only
     end
 
-    # If we are generating, and the option came from the CLI, it gets added to
-    # the data.  This will do the right thing for non-local certificates, in
-    # that the command line but *NOT* the config file option will apply.
-    if subcommand == :generate
-      if Puppet.settings.setting(:dns_alt_names).setbycli
-        options[:dns_alt_names] = Puppet[:dns_alt_names]
-      end
-    end
-
     begin
       @ca = Puppet::SSL::CertificateAuthority.new
     rescue => detail

data/lib/puppet/application/certificate.rb

@@ -0,0 +1,18 @@
+require 'puppet/application/indirection_base'
+
+class Puppet::Application::Certificate < Puppet::Application::IndirectionBase
+  def setup
+    unless options[:ca_location]
+      raise ArgumentError, "You must have a CA location specified;\n" +
+        "use --ca-location to specify the location (remote, local, only)"
+    end
+
+    location = Puppet::SSL::Host.ca_location
+    if location == :local && !Puppet::SSL::CertificateAuthority.ca?
+      self.class.run_mode("master")
+      self.set_run_mode self.class.run_mode
+    end
+
+    super
+  end
+end

data/lib/puppet/application/certificate_request.rb

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

data/lib/puppet/application/certificate_revocation_list.rb

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

data/lib/puppet/application/config.rb

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

data/lib/puppet/application/describe.rb

@@ -180,6 +180,59 @@ class Puppet::Application::Describe < Puppet::Application
   option("--list", "-l")
   option("--meta","-m")
 
+  def help
+    <<-HELP
+
+puppet-describe(8) -- Display help about resource types
+========
+
+SYNOPSIS
+--------
+Prints help about Puppet resource types, providers, and metaparameters.
+
+
+USAGE
+-----
+puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta]
+
+
+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
+-------
+    $ puppet describe --list
+    $ puppet describe file --providers
+    $ puppet describe user -s -m
+
+
+AUTHOR
+------
+David Lutterkort
+
+
+COPYRIGHT
+---------
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+
+    HELP
+  end
+
   def preinit
     options[:parameters] = true
   end