# class Puppet::Application::Agent

### Attributes

agent[RW]
args[RW]
daemon[RW]
host[RW]

### Public Instance Methods

app_defaults() click to toggle source
Calls superclass method Puppet::Application#app_defaults

    # File lib/puppet/application/agent.rb, line 10
    def app_defaults
      super.merge({
        :catalog_terminus => :rest,
        :catalog_cache_terminus => :json,
        :node_terminus => :rest,
        :facts_terminus => :facter,
      })
    end

enable_disable_client(agent) click to toggle source

    # File lib/puppet/application/agent.rb, line 372
    def enable_disable_client(agent)
      if options[:enable]
        agent.enable
      elsif options[:disable]
        agent.disable(options[:disable_message] || 'reason not specified')
      end
      exit(0)
    end

fingerprint() click to toggle source

    # File lib/puppet/application/agent.rb, line 316
    def fingerprint
      unless cert = host.certificate || host.certificate_request
        $stderr.puts "Fingerprint asked but no certificate nor certificate request have yet been issued"
        exit(1)
        return
      end
      unless digest = cert.digest(options[:digest].to_s)
        raise ArgumentError, "Could not get fingerprint for digest '#{options[:digest]}'"
      end
      puts digest.to_s
    end

help() click to toggle source

    # File lib/puppet/application/agent.rb, line 92
      def help
        <<-'HELP'

    puppet-agent(8) -- The puppet agent daemon
    ========

    SYNOPSIS
    --------
    Retrieves the client configuration from the puppet master and applies it to
    the local host.

    This service may be run as a daemon, run periodically using cron (or something
    similar), or run interactively for testing purposes.

    USAGE
    -----
    puppet agent [--certname <name>] [-D|--daemonize|--no-daemonize]
      [-d|--debug] [--detailed-exitcodes] [--digest <digest>] [--disable [message]] [--enable]
      [--fingerprint] [-h|--help] [-l|--logdest syslog|<file>|console]
      [--no-client] [--noop] [-o|--onetime] [-t|--test]
      [-v|--verbose] [-V|--version] [-w|--waitforcert <seconds>]

    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
    -----------
    '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 background, 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 '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 <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 puppet agent with
    '--genconfig'.

    * --certname:
      Set the certname (unique ID) of the client. The master reads this
      unique identifying string, which is usually set to the node's
      fully-qualified domain name, to determine which configurations the
      node will receive. Use this option to debug setup problems or
      implement unusual node identification schemes.

    * --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.

    * --detailed-exitcodes:
      Provide transaction information via exit codes. If this is enabled, an exit
      code of '2' means there were changes, an exit code of '4' means there were
      failures during the transaction, and an exit code of '6' means there were both
      changes and failures.

    * --digest:
      Change the certificate fingerprinting digest algorithm. The default is
      SHA256. Valid values depends on the version of OpenSSL installed, but
      will likely contain MD5, MD2, SHA1 and SHA256.

    * --disable:
      Disable working on the local system. This puts a lock file in place,
      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.

      Disable can also take an optional message that will be reported by the
      'puppet agent' at the next disabled run.

      'puppet agent' uses the same lock file while it is running, so no more
      than one 'puppet agent' process is working at a time.

      'puppet agent' exits after executing this.

    * --enable:
      Enable working on the local system. This removes any lock file,
      causing '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).

      'puppet agent' exits after executing this.

    * --fingerprint:
      Display the current certificate or certificate signing request
      fingerprint and then exit. Use the '--digest' option to change the
      digest algorithm used.

    * --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 start
      but not check configuration unless it is triggered with `puppet
      kick`. This only makes sense when puppet agent is being run with
      listen = true in puppet.conf or was started with the `--listen` option.

    * --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.

    * --onetime:
      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.

    * --test:
      Enable the most common options used for testing. These are 'onetime',
      'verbose', 'ignorecache', 'no-daemonize', 'no-usecacheonfailure',
      'detailed-exit-codes', 'no-splay', and 'show_diff'.

    * --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 '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
    -------
        $ puppet agent --server puppet.domain.com

    DIAGNOSTICS
    -----------

    Puppet agent accepts the following signals:

    * SIGHUP:
      Restart the puppet agent daemon.
    * SIGINT and SIGTERM:
      Shut down the puppet agent daemon.
    * SIGUSR1:
      Immediately retrieve and apply configurations from the puppet master.
    * SIGUSR2:
      Close file descriptors for log files and reopen them. Used with logrotate.

    AUTHOR
    ------
    Luke Kanies

    COPYRIGHT
    ---------
    Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License

        HELP
      end

main() click to toggle source

    # File lib/puppet/application/agent.rb, line 354
    def main
      Puppet.notice "Starting Puppet client version #{Puppet.version}"

      @daemon.start
    end

onetime() click to toggle source

    # File lib/puppet/application/agent.rb, line 328
    def onetime
      unless options[:client]
        $stderr.puts "onetime is specified but there is no client"
        exit(43)
        return
      end

      @daemon.set_signal_traps

      begin
        exitstatus = @agent.run
      rescue => detail
        Puppet.log_exception(detail)
      end

      @daemon.stop(:exit => false)

      if not exitstatus
        exit(1)
      elsif options[:detailed_exitcodes] then
        exit(exitstatus)
      else
        exit(0)
      end
    end

preinit() click to toggle source

    # File lib/puppet/application/agent.rb, line 19
    def preinit
      # Do an initial trap, so that cancels don't get a stack trace.
      Signal.trap(:INT) do
        $stderr.puts "Cancelling startup"
        exit(0)
      end

      {
        :waitforcert => nil,
        :detailed_exitcodes => false,
        :verbose => false,
        :debug => false,
        :centrallogs => false,
        :setdest => false,
        :enable => false,
        :disable => false,
        :client => true,
        :fqdn => nil,
        :serve => [],
        :digest => 'SHA256',
        :graph => true,
        :fingerprint => false,
      }.each do |opt,val|
        options[opt] = val
      end

      @args = {}
      require 'puppet/daemon'
      @daemon = Puppet::Daemon.new
      @daemon.argv = ARGV.dup
    end

run_command() click to toggle source

    # File lib/puppet/application/agent.rb, line 310
    def run_command
      return fingerprint if options[:fingerprint]
      return onetime if Puppet[:onetime]
      main
    end

setup() click to toggle source

    # File lib/puppet/application/agent.rb, line 430
    def setup
      setup_test if options[:test]

      setup_logs

      exit(Puppet.settings.print_configs ? 0 : 1) if Puppet.settings.print_configs?

      args[:Server] = Puppet[:server]
      if options[:fqdn]
        args[:FQDN] = options[:fqdn]
        Puppet[:certname] = options[:fqdn]
      end

      if options[:centrallogs]
        logdest = args[:Server]

        logdest += ":" + args[:Port] if args.include?(:Port)
        Puppet::Util::Log.newdestination(logdest)
      end

      Puppet.settings.use :main, :agent, :ssl

      # Always ignoreimport for agent. It really shouldn't even try to import,
      # but this is just a temporary band-aid.
      Puppet[:ignoreimport] = true

      # We need to specify a ca location for all of the SSL-related i
      # indirected classes to work; in fingerprint mode we just need
      # access to the local files and we don't need a ca.
      Puppet::SSL::Host.ca_location = options[:fingerprint] ? :none : :remote

      Puppet::Transaction::Report.indirection.terminus_class = :rest
      # we want the last report to be persisted locally
      Puppet::Transaction::Report.indirection.cache_class = :yaml

      if Puppet[:catalog_cache_terminus]
        Puppet::Resource::Catalog.indirection.cache_class = Puppet[:catalog_cache_terminus]
      end

      unless options[:fingerprint]
        setup_agent
      else
        setup_host
      end
    end

setup_agent() click to toggle source

    # File lib/puppet/application/agent.rb, line 401
    def setup_agent
      # We need tomake the client either way, we just don't start it
      # if --no-client is set.
      require 'puppet/agent'
      require 'puppet/configurer'
      @agent = Puppet::Agent.new(Puppet::Configurer, (not(Puppet[:onetime])))

      enable_disable_client(@agent) if options[:enable] or options[:disable]

      @daemon.agent = agent if options[:client]

      # It'd be nice to daemonize later, but we have to daemonize before the
      # waitforcert happens.
      @daemon.daemonize if Puppet[:daemonize]

      setup_host

      @objects = []

      # This has to go after the certs are dealt with.
      if Puppet[:listen]
        unless Puppet[:onetime]
          setup_listen
        else
          Puppet.notice "Ignoring --listen on onetime run"
        end
      end
    end

setup_host() click to toggle source

    # File lib/puppet/application/agent.rb, line 395
    def setup_host
      @host = Puppet::SSL::Host.new
      waitforcert = options[:waitforcert] || (Puppet[:onetime] ? 0 : Puppet[:waitforcert])
      cert = @host.wait_for_cert(waitforcert) unless options[:fingerprint]
    end

setup_listen() click to toggle source

    # File lib/puppet/application/agent.rb, line 381
    def setup_listen
      Puppet.warning "Puppet --listen / kick is deprecated. See http://links.puppetlabs.com/puppet-kick-deprecation"
      unless FileTest.exists?(Puppet[:rest_authconfig])
        Puppet.err "Will not start without authorization file #{Puppet[:rest_authconfig]}"
        exit(14)
      end

      require 'puppet/network/server'
      # No REST handlers yet.
      server = Puppet::Network::Server.new(Puppet[:bindaddress], Puppet[:puppetport])

      @daemon.server = server
    end

setup_test() click to toggle source

Enable all of the most common test options.

    # File lib/puppet/application/agent.rb, line 361
    def setup_test
      Puppet.settings.handlearg("--ignorecache")
      Puppet.settings.handlearg("--no-usecacheonfailure")
      Puppet.settings.handlearg("--no-splay")
      Puppet.settings.handlearg("--show_diff")
      Puppet.settings.handlearg("--no-daemonize")
      options[:verbose] = true
      Puppet[:onetime] = true
      options[:detailed_exitcodes] = true
    end