puppet 0.25.5 → 2.6.0

data/lib/puppet/util/command_line/puppetdoc

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+#
+# = Synopsis
+#
+# Generate a reference for all Puppet types.  Largely meant for internal Reductive
+# Labs use.
+#
+# = Usage
+#
+#   puppet doc [-a|--all] [-h|--help] [-o|--outputdir <rdoc outputdir>] [-m|--mode <text|pdf|markdown|trac|rdoc>]
+#              [-r|--reference <[type]|configuration|..>] [--charset CHARSET] [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, 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 +puppet doc --list+.
+#
+# charset::
+#   Used only in 'rdoc' mode. It sets the charset used in the html files produced.
+#
+# = Example
+#
+#   $ puppet doc -r type > /tmp/type_reference.rst
+# or
+#   $ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests
+# or
+#   $ puppet doc /etc/puppet/manifests/site.pp
+# or
+#   $ puppet doc -m markdown -r configuration
+#
+# = Author
+#
+# Luke Kanies
+#
+# = Copyright
+#
+# Copyright (c) 2005-2007 Reductive Labs, LLC
+# Licensed under the GNU Public License
+
+#Puppet::Application[:doc].run

data/lib/puppet/util/command_line/puppetmasterd

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+#
+# = 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]
+#
+# = 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 <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 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
+#
+#   puppet master
+#
+# = Author
+#
+# Luke Kanies
+#
+# = Copyright
+#
+# Copyright (c) 2005 Reductive Labs, LLC
+# Licensed under the GNU Public License
+
+#Puppet::Application[:master].run

data/lib/puppet/util/command_line/puppetqd

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+# == Synopsis
+#
+# Retrieve serialized records from a queue and process them in order.
+#
+# = Usage
+#
+#   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 <servername>' 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 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
+#
+#   puppet queue
+#
+# = Author
+#
+# Luke Kanies
+#
+# = Copyright
+#
+# Copyright (c) 2009 Reductive Labs, LLC
+# Licensed under the GNU Public License
+
+#Puppet::Application[:queue].run

data/lib/puppet/util/command_line/puppetrun

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+
+#
+# = 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.  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.
+#
+# 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 <directory>' 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 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) 2005 Reductive Labs, LLC
+# Licensed under the GNU Public License
+
+#Puppet::Application[:kick].run

data/lib/puppet/util/command_line/ralsh

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+#
+# = Synopsis
+#
+# Use the Puppet RAL to directly interact with the system.
+#
+# = Usage
+#
+#   puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit]
+#                   [-H|--host <host>] [-p|--param <param>] [-t|--types]
+#                   type <name>
+#
+# = 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 puppet resource
+# will tell you everything it knows about all instances of that type.  You can
+# optionally specify an instance name, and puppet resource will only describe that single
+# instance.
+#
+# 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 <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.
+#
+# 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 ``puppet resource`` to return Puppet configuration for the 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
+
+#Puppet::Application[:resource].run

data/lib/puppet/util/constant_inflector.rb

@@ -4,12 +4,12 @@
 # A common module for converting between constants and
 # file names.
 module Puppet::Util::ConstantInflector
-    def file2constant(file)
-        # LAK:NOTE See http://snurl.com/21zf8  [groups_google_com]
-        x = file.split("/").collect { |name| name.capitalize }.join("::").gsub(/_+(.)/) { |term| $1.capitalize }
-    end
+  def file2constant(file)
+    # LAK:NOTE See http://snurl.com/21zf8  [groups_google_com]
+    x = file.split("/").collect { |name| name.capitalize }.join("::").gsub(/_+(.)/) { |term| $1.capitalize }
+  end
 
-    def constant2file(constant)
-        constant.to_s.gsub(/([a-z])([A-Z])/) { |term| $1 + "_" + $2 }.gsub("::", "/").downcase
-    end
+  def constant2file(constant)
+    constant.to_s.gsub(/([a-z])([A-Z])/) { |term| $1 + "_#{$2}" }.gsub("::", "/").downcase
+  end
 end

data/lib/puppet/util/diff.rb

@@ -1,71 +1,74 @@
 # Provide a diff between two strings.
 module Puppet::Util::Diff
-    include Puppet::Util
-    require 'tempfile'
+  include Puppet::Util
+  require 'tempfile'
 
-    def diff(old, new)
-        command = [Puppet[:diff]]
-        if args = Puppet[:diff_args] and args != ""
-            command << args
-        end
-        command << old << new
-        execute(command, :failonfail => false)
+  def diff(old, new)
+    command = [Puppet[:diff]]
+    if args = Puppet[:diff_args] and args != ""
+      command << args
     end
+    command << old << new
+    execute(command, :failonfail => false)
+  end
 
-    module_function :diff
+  module_function :diff
 
-    # return diff string of two input strings
-    # format defaults to unified
-    # context defaults to 3 lines
-    def lcs_diff(data_old, data_new, format=:unified, context_lines=3)
-        unless Puppet.features.diff?
-            Puppet.warning "Cannot provide diff without the diff/lcs Ruby library"
-            return ""
-        end
-        data_old = data_old.split(/\n/).map! { |e| e.chomp }
-        data_new = data_new.split(/\n/).map! { |e| e.chomp }
+  # return diff string of two input strings
+  # format defaults to unified
+  # context defaults to 3 lines
+  def lcs_diff(data_old, data_new, format=:unified, context_lines=3)
+    unless Puppet.features.diff?
+      Puppet.warning "Cannot provide diff without the diff/lcs Ruby library"
+      return ""
+    end
+    data_old = data_old.split(/\n/).map! { |e| e.chomp }
+    data_new = data_new.split(/\n/).map! { |e| e.chomp }
 
-        output = ""
+    output = ""
 
-        diffs = ::Diff::LCS.diff(data_old, data_new)
-        return output if diffs.empty?
+    diffs = ::Diff::LCS.diff(data_old, data_new)
+    return output if diffs.empty?
 
-        oldhunk = hunk = nil
-        file_length_difference = 0
+    oldhunk = hunk = nil
+    file_length_difference = 0
 
-        diffs.each do |piece|
-            begin
-                hunk = ::Diff::LCS::Hunk.new(data_old, data_new, piece,
-                                           context_lines,
-                                           file_length_difference)
-                file_length_difference = hunk.file_length_difference
-            next unless oldhunk
-            # Hunks may overlap, which is why we need to be careful when our
-            # diff includes lines of context. Otherwise, we might print
-            # redundant lines.
-            if (context_lines > 0) and hunk.overlaps?(oldhunk)
-                hunk.unshift(oldhunk)
-            else
-                output << oldhunk.diff(format)
-            end
-            ensure
-                oldhunk = hunk
-                output << "\n"
-            end
-        end
+    diffs.each do |piece|
+      begin
 
-        # Handle the last remaining hunk
-        output << oldhunk.diff(format) << "\n"
-    end
+        hunk = ::Diff::LCS::Hunk.new(
+          data_old, data_new, piece,
+            context_lines,
 
-    def string_file_diff(path, string)
-        require 'tempfile'
-        tempfile = Tempfile.new("puppet-diffing")
-        tempfile.open
-        tempfile.print string
-        tempfile.close
-        print diff(path, tempfile.path)
-        tempfile.delete
+            file_length_difference)
+        file_length_difference = hunk.file_length_difference
+      next unless oldhunk
+      # Hunks may overlap, which is why we need to be careful when our
+      # diff includes lines of context. Otherwise, we might print
+      # redundant lines.
+      if (context_lines > 0) and hunk.overlaps?(oldhunk)
+        hunk.unshift(oldhunk)
+      else
+        output << oldhunk.diff(format)
+      end
+      ensure
+        oldhunk = hunk
+        output << "\n"
+      end
     end
+
+    # Handle the last remaining hunk
+    output << oldhunk.diff(format) << "\n"
+  end
+
+  def string_file_diff(path, string)
+    require 'tempfile'
+    tempfile = Tempfile.new("puppet-diffing")
+    tempfile.open
+    tempfile.print string
+    tempfile.close
+    print diff(path, tempfile.path)
+    tempfile.delete
+  end
 end