Class: Puppet::Application::Queue

Inherits:
Puppet::Application show all
Defined in:
lib/vendor/puppet/application/queue.rb

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows

Instance Attribute Summary collapse

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary collapse

Methods inherited from Puppet::Application

[], banner, clear!, clear?, #configure_indirector_routes, controlled_run, exit, find, #handlearg, #initialize, interrupted?, #name, option, option_parser_commands, #parse_options, restart!, restart_requested?, #run, #run_command, run_mode, #set_run_mode, #setup_logs, should_not_parse_config, should_parse_config, #should_parse_config?, should_parse_config?, stop!, stop_requested?

Methods included from Util

absolute_path?, activerecord_version, benchmark, binread, chuser, classproxy, #execfail, #execpipe, execute, execute_posix, execute_windows, logmethods, memory, path_to_uri, proxy, replace_file, safe_posix_fork, symbolize, symbolizehash, symbolizehash!, synchronize_on, thinmark, #threadlock, uri_to_path, wait_for_output, which, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Attribute Details

#daemon ⇒ Object

Returns the value of attribute daemon.



7
8
9
 
# File 'lib/vendor/puppet/application/queue.rb', line 7

def daemon
  @daemon
end

Instance Method Details

#help ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/vendor/puppet/application/queue.rb', line 39

def help
  <<-HELP

puppet-queue(8) -- Queuing daemon for asynchronous storeconfigs
========

SYNOPSIS
--------
Retrieves serialized storeconfigs records from a queue and processes
them in order.


USAGE
-----
puppet queue [-d|--debug] [-v|--verbose]


DESCRIPTION
-----------
This application runs as a daemon and processes storeconfigs data,
retrieving the data from a stomp server message queue and writing it to
a database.

For more information, including instructions for properly setting up
your puppet master and message queue, see the documentation on setting
up asynchronous storeconfigs at:
http://projects.puppetlabs.com/projects/1/wiki/Using_Stored_Configuration


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 queue 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) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License

  HELP
end

#main ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/vendor/puppet/application/queue.rb', line 121

def main
  require 'puppet/indirector/catalog/queue' # provides Puppet::Indirector::Queue.subscribe
  Puppet.notice "Starting puppetqd #{Puppet.version}"
  Puppet::Resource::Catalog::Queue.subscribe do |catalog|
    # Once you have a Puppet::Resource::Catalog instance, passing it to save should suffice
    # to put it through to the database via its active_record indirector (which is determined
    # by the terminus_class = :active_record setting above)
    Puppet::Util.benchmark(:notice, "Processing queued catalog for #{catalog.name}") do
      begin
        Puppet::Resource::Catalog.indirection.save(catalog)
      rescue => detail
        puts detail.backtrace if Puppet[:trace]
        Puppet.err "Could not save queued catalog for #{catalog.name}: #{detail}"
      end
    end
  end

  Thread.list.each { |thread| thread.join }
end

#preinit ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/vendor/puppet/application/queue.rb', line 9

def preinit
  require 'puppet/daemon'
  @daemon = Puppet::Daemon.new
  @daemon.argv = ARGV.dup

  # Do an initial trap, so that cancels don't get a stack trace.

  # This exits with exit code 1
  Signal.trap(:INT) do
    $stderr.puts "Caught SIGINT; shutting down"
    exit(1)
  end

  # This is a normal shutdown, so code 0
  Signal.trap(:TERM) do
    $stderr.puts "Caught SIGTERM; shutting down"
    exit(0)
  end

  {
    :verbose => false,
    :debug => false
  }.each do |opt,val|
    options[opt] = val
  end
end

#setup ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/vendor/puppet/application/queue.rb', line 141

def setup
  unless Puppet.features.stomp?
    raise ArgumentError, "Could not load the 'stomp' library, which must be present for queueing to work.  You must install the required library."
  end

  setup_logs

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

  require 'puppet/resource/catalog'
  Puppet::Resource::Catalog.indirection.terminus_class = :store_configs

  daemon.daemonize if Puppet[:daemonize]

  # We want to make sure that we don't have a cache
  # class set up, because if storeconfigs is enabled,
  # we'll get a loop of continually caching the catalog
  # for storage again.
  Puppet::Resource::Catalog.indirection.cache_class = nil
end