- Included in:
- Defined in:
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.
Instance Method Summary collapse
#lock ⇒ Object
Yield if we get a lock, else raise Puppet::LockError.
- #lockfile_path ⇒ Object
- #running? ⇒ Boolean
Instance Method Details
Yield if we get a lock, else raise Puppet::LockError. Return value of block yielded.
18 19 20 21 22 23 24 25 26 27 28
# File 'lib/puppet/agent/locker.rb', line 18 def lock if lockfile.lock begin yield ensure lockfile.unlock end else fail ::, ('Failed to acquire lock') end end
34 35 36
# File 'lib/puppet/agent/locker.rb', line 34 def lockfile_path @lockfile_path ||= [:agent_catalog_run_lockfile] end
#running? ⇒ Boolean
30 31 32
# File 'lib/puppet/agent/locker.rb', line 30 def running? lockfile.locked? end