module Puppet::Agent::Locker

This module is responsible for encapsulating the logic for “locking” the puppet agent during a catalog run; in other words, keeping track of enough state to answer the question “is there a puppet agent currently applying a catalog?”

The implementation involves writing a lockfile whose contents are simply the PID of the running agent process. This is considered part of the public Puppet API because it used by external tools such as mcollective.

For more information, please see docs on the website.

http://links.puppetlabs.com/agent_lockfiles

Public Instance Methods

lock() { || ... } click to toggle source

Yield if we get a lock, else do nothing. Return true/false depending on whether we get the lock.

# File lib/puppet/agent/locker.rb, line 17
def lock
  if lockfile.lock
    begin
      yield
    ensure
      lockfile.unlock
    end
  end
end

lockfile_path() click to toggle source

# File lib/puppet/agent/locker.rb, line 31
def lockfile_path
  @lockfile_path ||= Puppet[:agent_catalog_run_lockfile]
end

running?() click to toggle source

# File lib/puppet/agent/locker.rb, line 27
def running?
  lockfile.locked?
end