right_infrastructure_agent 1.1.2

data/lib/right_infrastructure_agent/rainbows_agent_controller.rb

@@ -0,0 +1,192 @@
+# Copyright (c) 2009-2014 RightScale, Inc, All Rights Reserved Worldwide.
+#
+# THIS PROGRAM IS CONFIDENTIAL AND PROPRIETARY TO RIGHTSCALE
+# AND CONSTITUTES A VALUABLE TRADE SECRET.  Any unauthorized use,
+# reproduction, modification, or disclosure of this program is
+# strictly prohibited.  Any use of this program by an authorized
+# licensee is strictly subject to the terms and conditions,
+# including confidentiality obligations, set forth in the applicable
+# License Agreement between RightScale.com, Inc. and the licensee.
+
+require 'monitor'
+
+module RightScale
+
+  # Controller for running an agent in a Rainbows Rails environment
+  # Dependent upon existing base configuration file for agents of the given type
+  module RainbowsAgentController
+
+    class NoConfigurationData < StandardError; end
+
+    FORCED_OPTIONS = {
+      :format    => :secure,
+      :daemonize => false
+    }
+
+    @worker_index = nil
+
+    # Rainbows worker index
+    #
+    # @return [Integer] 0-based worker index
+    def self.worker_index
+      @worker_index
+    end
+
+    # Start agent and create error tracker for its use
+    # Choose agent type from candidate types based on contents of configuration directory
+    # Assign agent name by using worker index to suffix agent type
+    #
+    # @param [Array] agent_types for candidate agents
+    # @param [Integer] worker_index for this rainbows worker process; 0-based
+    # @param [Object] logger to use
+    #
+    # @option options [String] :cfg_dir containing configuration for all agents
+    # @option options [String] :prefix to build agent identity
+    # @option options [String, Integer] :base_id to build agent identity, defaults to worker_index + 1
+    #
+    # @yield [] Invoked immediately prior to storing configuration receiving one parameter containing
+    # the configuration hash and returning the updated configuration hash, optional
+    #
+    # @return [TrueClass] always true
+    def self.start(agent_types, worker_index, logger, options = {}, &block)
+      RightSupport::Log::Mixin.default_logger = logger
+      Log.force_logger(logger) if logger
+      @worker_index = worker_index
+      agent_name = nil
+
+      # Need next_tick here to wait for rainbows worker to start EventMachine
+      EM.next_tick do
+        begin
+          AgentConfig.cfg_dir = options[:cfg_dir]
+          agent_type = pick_agent_type(agent_types)
+          raise NoConfigurationData, "Deployment is missing configuration file for any agents of type " +
+                                     "#{agent_types.inspect} in #{AgentConfig.cfg_dir}; need to run rad!" unless agent_type
+
+          # Configure agent
+          agent_name = form_agent_name(agent_type, worker_index)
+          cfg = configure_agent(agent_type, agent_name, worker_index, options, &block)
+          cfg.merge!(options.merge(FORCED_OPTIONS))
+          cfg[:agent_name] = agent_name
+
+          require File.expand_path(File.join(AgentConfig.lib_dir, 'router_agent')) if agent_type == "router"
+
+          # Initialize error tracking
+          agent_class = (agent_type == "router") ? RouterAgent : InfrastructureAgent
+          trace_level = defined?(agent_class::TRACE_LEVEL) ? agent_class::TRACE_LEVEL : {}
+          filter_params = defined?(agent_class::FILTER_PARAMS) ? agent_class::FILTER_PARAMS : {}
+          tracker_options = {:shard_id => cfg[:shard_id], :trace_level => trace_level, :filter_params => filter_params}
+          if (endpoint = cfg[:airbrake_endpoint]) && (api_key = cfg[:airbrake_api_key])
+            tracker_options[:airbrake_endpoint] = endpoint
+            tracker_options[:airbrake_api_key] = api_key
+          elsif defined?(Skeletor) && Skeletor::Deployer.config["error_handling"].respond_to?(:[]) &&
+              (endpoint = Skeletor::Deployer.config["error_handling"]["airbrake_endpoint"]) &&
+              (api_key = Skeletor::Deployer.config["error_handling"]["airbrake_api_key"])
+            tracker_options[:airbrake_endpoint] = endpoint
+            tracker_options[:airbrake_api_key] = api_key
+          end
+          ErrorTracker.init(self, agent_name, tracker_options)
+
+          # Start the agent
+          Log.info("Starting #{agent_name} agent with the following options:")
+          cfg.inject([]) do |t, (k, v)|
+            t << "-  #{k}: #{k.to_s =~ /pass|auth/ ? "<hidden>" : (v.respond_to?(:each) ? v.inspect : v)}"
+          end.sort.each { |l| Log.info(l) }
+          @agent = agent_class.start(cfg)
+
+        rescue PidFile::AlreadyRunning
+          Log.error("#{agent_name} already running") rescue nil
+          EM.stop
+        rescue NoConfigurationData => e
+          Log.error(e.message) rescue nil
+          ErrorTracker.notify(e, nil, self, self)
+          EM.stop
+        rescue Exception => e
+          Log.error("Failed to start #{agent_name} agent", e, :trace) rescue nil
+          ErrorTracker.notify(e, nil, self, self)
+          EM.stop
+        end
+      end
+      true
+    end
+
+    # Stop agent by telling it to terminate
+    # Do not allow the agent termination to call EM.stop;
+    # instead defer that to rainbows to do after all connections are closed
+    #
+    # @return [TrueClass] always true
+    def self.stop
+      @agent.terminate {} if @agent
+      true
+    end 
+
+    protected
+
+    # Pick agent type from first in list that has a configuration file
+    #
+    # @param [Array] agent_types for candidate agents
+    #
+    # @return [String, NilClass] agent type, or nil if none configured
+    def self.pick_agent_type(types)
+      (types & AgentConfig.cfg_agents).first
+    end
+
+    # Form agent name form type and index
+    #
+    # @param [String] type of agent
+    # @param [Integer] index for worker
+    #
+    # @return [String] agent name
+    def self.form_agent_name(type, index)
+      "#{type}_#{index + 1}"
+    end
+
+    # Determine configuration settings for this agent and persist them
+    # Reuse existing agent identities when possible
+    #
+    # @param [String] agent_type
+    # @param [String] agent_name
+    # @param [Integer] worker_index for this rainbows worker process; 0-based
+    #
+    # @option options [String] :prefix to build agent identity
+    # @option options [String, Integer] :base_id to build agent identity, defaults to worker_index + 1
+    #
+    # @yield [configuration] optionally prior to storing configuration
+    # @yieldparam [Hash] configuration for agent
+    # @yieldreturn [Hash] updated configuration
+    #
+    # @return [Hash] persisted configuration options
+    #
+    # @raise [NoConfigurationData] no configuration data found for the agent
+    def self.configure_agent(agent_type, agent_name, worker_index, options)
+      cfg = AgentConfig.agent_options(agent_type)
+      raise NoConfigurationData, "No configuration data found for agents of type #{agent_type} " +
+                                 "in #{AgentConfig.cfg_file(agent_type)}" if cfg.empty?
+      base_id = (options[:base_id] || (worker_index + 1)).to_i
+      unless (identity = AgentConfig.agent_options(agent_name)[:identity]) &&
+             AgentIdentity.parse(identity).base_id == base_id
+        identity = AgentIdentity.new(options[:prefix] || "rs", agent_type, base_id).to_s
+      end
+      cfg.merge!(:identity => identity)
+      if cfg[:host]
+        # Randomize broker order
+        host = []
+        port = []
+        addresses = RightAMQP::HABrokerClient.addresses(cfg[:host], cfg[:port])
+        indices = (0..addresses.size - 1).to_a
+        indices.shuffle.each do |i|
+          a = addresses[i]
+          host << "#{a[:host]}:#{a[:index]}"
+          port << "#{a[:port]}:#{a[:index]}"
+        end
+        cfg[:host] = host.join(",")
+        cfg[:port] = port.join(",") if cfg[:port]
+      end
+      cfg = yield(cfg) if block_given?
+      cfg_file = AgentConfig.store_cfg(agent_name, cfg)
+      Log.info("Generated configuration file for #{agent_name} agent: #{cfg_file}")
+      cfg
+    end
+
+  end # RainbowsAgentController
+
+end # RightScale

data/lib/right_infrastructure_agent/scripts/infrastructure_agent_deployer.rb

@@ -0,0 +1,278 @@
+# === Synopsis:
+#   RightScale Infrastructure Agent Deployer (rad) - (c) 2009-2013 RightScale Inc
+#
+#   rad is a command line tool for building the configuration file for a RightInfrastructureAgent
+#
+#   The configuration file is generated in:
+#     <agent name>/config.yml
+#   in platform-specific RightAgent configuration directory
+#
+#   Note that a router is also a RightInfrastructureAgent but its configuration options are
+#   slightly different, .e.g., broker configuration is governed by home-island option instead
+#   of host and port
+#
+# === Examples:
+#   Build configuration for agent named AGENT with default options:
+#     rad AGENT
+#
+#   Build configuration for agent named AGENT so it uses given AMQP settings:
+#     rad AGENT --user USER --pass PASSWORD --vhost VHOST --port PORT --host HOST
+#     rad AGENT -u USER -p PASSWORD -v VHOST -P PORT -h HOST
+#
+#   Build configuration for island router named ROUTER:
+#     rad ROUTER --user USER --pass PASSWORD --vhost VHOST --home-island 1 --rnds-urls URL1,URL2
+#                --tags-urls URL1,URL2 --tags-auth-key KEY
+#
+#   Build configuration for two core agents that are sharing a request queue named 'core'
+#     rad core --shared-queue core
+#     rad core_2 --shared-queue core
+#
+# === Usage:
+#    rad AGENT [options]
+#
+#    --root-dir, -r DIR       Set agent root directory (containing init, actors, and certs subdirectories)
+#    --cfg-dir, -c DIR        Set directory where generated configuration files for all agents are stored
+#    --pid-dir, -z DIR        Set directory containing process id file
+#    --identity, -i ID        Use base id ID to build agent's identity
+#    --token, -t TOKEN        Use token TOKEN to build agent's identity
+#    --prefix, -x PREFIX      Use prefix PREFIX to build agent's identity
+#    --type TYPE              Use agent type TYPE to build agent's' identity,
+#                             defaults to AGENT with any trailing '_[0-9]+' removed
+#    --url                    Set agent AMQP connection URL (host, port, user, pass, vhost)
+#    --user, -u USER          Set agent AMQP username
+#    --password, -p PASS      Set agent AMQP password
+#    --vhost, -v VHOST        Set agent AMQP virtual host
+#    --host, -h HOST          Set AMQP server host for agent
+#    --port, -P PORT          Set AMQP server port for agent
+#    --heartbeat, -b SEC      Set number of seconds between AMQP broker connection heartbeats, 0 means disable
+#    --prefetch COUNT         Set maximum requests AMQP broker is to prefetch before current is ack'd
+#    --time-to-live SEC       Set maximum age in seconds before a request expires and is ignored
+#    --adjust-for-skew        When routing requests adjust expiration time for clock skew of target
+#    --retry-timeout SEC      Set maximum number of seconds to retry request before give up
+#    --retry-interval SEC     Set number of seconds before initial request retry, increases exponentially
+#    --check-interval SEC     Set number of seconds between failed connection checks, increases exponentially
+#    --ping-interval SEC      Set minimum number of seconds since last message receipt for the agent
+#                             to ping the router to check connectivity, 0 means disable ping
+#    --reconnect-interval SEC Set number of seconds between HTTP or AMQP reconnect attempts
+#    --advertise-interval SEC Set number of seconds between agent advertising its services
+#    --grace-timeout SEC      Set number of seconds before graceful termination times out
+#    --[no-]dup-check         Set whether to check for and reject duplicate requests, .e.g., due to retries
+#    --instance-queue-ttl     Set time-to-live in seconds for messages published to instance queues
+#    --notify, -n EMAIL       Set email address EMAIL for exception notifications
+#    --defer-notify [LIMIT]   Defer event notifications associated with audits and optionally limit workers
+#                             assigned to service them
+#    --shard, -s ID           Set identifier for shard in which this agent is operating
+#    --fiber-pool-size N      Set size of fiber pool to be used for asynchronous message processing,
+#                             0 means do not use fibers and instead execute synchronously
+#    --airbrake-endpoint URL  Set URL for Airbrake endpoint for reporting exceptions to Errbit
+#    --airbrake-api-key KEY   Set Airbrake API key for use in reporting exceptions to Errbit
+#    --shared-queue, -q Q     Use Q as input for agent in addition to identity queue
+#    --proxied-queues QS      Set comma-separated list of queues to be proxied by router, each in the form
+#                             <name>@<url> with <name> being the name of the queue and <url> being the HTTP URL
+#                             of the server ready to process messages from the given queue
+#    --rnds-urls URLS         Set comma-separated list of URLs for accessing RightNetDataService
+#    --tags-urls URLS         Set comma-separated list of URLs for accessing TagService
+#    --tags-auth-token TOKEN  Set authentication token for accessing TagService
+#    --max-cache-size         Set maximum number of entries in LRU cache for storing instance agents
+#    --cache-reload-age       Set age in seconds of cached instance before automatically reload
+#    --home-island ID         Set comma-separated list of identifiers of RightNet islands which router is servicing
+#    --auto-restart N         Set number of requests before auto-terminate followed by monit auto-restart
+#    --options, -o KEY=VAL    Pass-through options
+#    --monit, -m              Generate monit configuration file
+#    --test                   Build test deployment using default test settings
+#    --quiet, -Q              Do not produce output
+#    --help                   Display help
+#
+# Note that the applicability of these various options varies depending on the type of infrastructure agent
+
+require 'rubygems'
+require 'right_agent/scripts/agent_deployer'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'right_infrastructure_agent'))
+
+module RightScale
+
+  class InfrastructureAgentDeployer < AgentDeployer
+
+    # Create and run deployer
+    #
+    # === Return
+    # true:: Always return true
+    def self.run
+      d = InfrastructureAgentDeployer.new
+      d.deploy(d.parse_args)
+    end
+
+    protected
+
+    # Parse other arguments used only by infrastructure agents
+    #
+    # === Parameters
+    # opts(OptionParser):: Options parser with options to be parsed
+    # options(Hash):: Storage for options that are parsed
+    #
+    # === Return
+    # true:: Always return true
+    def parse_other_args(opts, options)
+      opts.on('-q', '--shared-queue Q') do |q|
+        options[:shared_queue] = q
+      end
+
+      opts.on('-q', '--proxied-queues QS') do |qs|
+        options[:proxied_queues] = qs
+      end
+
+      opts.on('-n', '--notify EMAIL') do |email|
+        options[:notify] = email
+      end
+
+      opts.on('--rnds-urls URLS') do |urls|
+        options[:rnds_urls] = urls
+      end
+
+      opts.on('--tags-urls URLS') do |urls|
+        options[:tags_urls] = urls
+      end
+
+      opts.on('--tags-auth-token TOKEN') do |token|
+        options[:tags_auth_token] = token
+      end
+
+      opts.on('--max-cache-size SIZE') do |size|
+        options[:max_cache_size] = size.to_i
+      end
+
+      opts.on('--cache-reload-age SEC') do |sec|
+        options[:cache_reload_age] = sec.to_i
+      end
+
+      opts.on('--home-island ID') do |id|
+        ids = id.split(/,\s*/).map { |id| id.to_i }
+        options[:home_island] = ids.size > 1 ? ids : ids[0]
+      end
+
+      opts.on('--auto-restart N') do |n|
+        options[:auto_restart] = n.to_i
+      end
+
+      opts.on('--fiber-pool-size N') do |n|
+        options[:fiber_pool_size] = n.to_i
+      end
+
+      opts.on('--instance-queue-ttl SEC') do |sec|
+        options[:instance_queue_ttl] = sec.to_i
+      end
+
+      opts.on('--advertise-interval SEC') do |sec|
+        options[:advertise_interval] = sec.to_i
+      end
+
+      opts.on('--defer-notify [LIMIT]') do |limit|
+        options[:defer_notify] = limit ? limit.to_i : true
+      end
+
+      opts.on('--adjust-for-skew') do
+        options[:adjust_for_skew] = true
+      end
+
+      opts.on('--help') do
+        puts Usage.scan(__FILE__)
+        exit
+      end
+    end
+
+    # Determine configuration settings to be persisted
+    #
+    # === Parameters
+    # options(Hash):: Command line options
+    # cfg(Hash):: Initial configuration settings
+    #
+    # === Return
+    # cfg(Hash):: Configuration settings
+    def configure(options, cfg)
+      if options[:agent_type] != 'instance'
+        options[:retry_interval] ||= 4
+        options[:retry_timeout] ||= 25
+      end
+      cfg = super(options, cfg)
+      if options[:agent_type] != 'instance'
+        cfg[:reconnect_interval] ||= 5
+        cfg[:grace_timeout] ||= 75
+        cfg[:dup_check] = !!options[:dup_check]
+        cfg[:advertise_interval] = options[:advertise_interval] || 60 * 60
+        cfg[:instance_queue_ttl] = options[:instance_queue_ttl] || 24 * 60 * 60
+        cfg[:secure] = options[:options][:secure] = false
+        cfg[:notify] = options[:notify] if options[:notify]
+        cfg[:defer_notify] = options[:defer_notify] if options[:defer_notify]
+        cfg[:fiber_pool_size] = options[:fiber_pool_size] if options[:fiber_pool_size]
+        cfg[:shared_queue] = options[:shared_queue] if options[:shared_queue]
+        cfg[:proxied_queues] = options[:proxied_queues] if options[:proxied_queues]
+        if options[:test]
+          cfg[:rnds_urls] = '127.0.0.1:9010'
+          cfg[:tags_urls] = '127.0.0.1:9030'
+          cfg[:log_to_file_only] = true
+        end
+        cfg[:rnds_urls] = options[:rnds_urls] if options[:rnds_urls]
+        cfg[:tags_urls] = options[:tags_urls] if options[:tags_urls]
+        cfg[:tags_auth_token] = options[:tags_auth_token] if options[:tags_auth_token]
+        cfg[:max_cache_size] = options[:max_cache_size] || 1000
+        cfg[:cache_reload_age] = options[:cache_reload_age] || 30
+        cfg[:home_island] = options[:home_island] if options[:home_island]
+        cfg[:auto_restart] = options[:auto_restart] if options[:auto_restart]
+        cfg[:adjust_for_skew] = options[:adjust_for_skew] if options[:adjust_for_skew]
+        if options[:host]
+          # Randomize broker order
+          host = []
+          port = []
+          addresses = RightAMQP::HABrokerClient.addresses(options[:host], options[:port])
+          indices = (0..addresses.size - 1).to_a
+          indices.shuffle.each do |i|
+            a = addresses[i]
+            host << "#{a[:host]}:#{a[:index]}"
+            port << "#{a[:port]}:#{a[:index]}"
+          end
+          cfg[:host] = host.join(",")
+          cfg[:port] = port.join(",") if options[:port]
+        end
+      end
+      cfg
+    end
+
+    # Setup agent monitoring
+    #
+    # === Parameters
+    # options(Hash):: Command line options
+    #
+    # === Return
+    # true:: Always return true
+    def monitor(options)
+      agent_name = options[:agent_name]
+      identity = options[:identity]
+      pid_file = PidFile.new(identity)
+      cfg = <<-EOF
+check process #{agent_name}
+  with pidfile \"#{pid_file}\"
+  start program \"/etc/init.d/#{agent_name} start\"
+  stop program \"/etc/init.d/#{agent_name} stop\"
+  mode manual
+      EOF
+      cfg_file = File.join(AgentConfig.cfg_dir, agent_name, "#{identity}.conf")
+      File.open(cfg_file, 'w') { |f| f.puts(cfg) }
+      File.chmod(0600, cfg_file) # monit requires strict perms on this file
+      puts "  - agent monit config: #{cfg_file}" unless options[:quiet]
+      true
+    end
+
+  end # InfrastructureAgentDeployer
+
+end # RightScale
+
+# Copyright (c) 2009-2013 RightScale, Inc, All Rights Reserved Worldwide.
+#
+# THIS PROGRAM IS CONFIDENTIAL AND PROPRIETARY TO RIGHTSCALE
+# AND CONSTITUTES A VALUABLE TRADE SECRET.  Any unauthorized use,
+# reproduction, modification, or disclosure of this program is
+# strictly prohibited.  Any use of this program by an authorized
+# licensee is strictly subject to the terms and conditions,
+# including confidentiality obligations, set forth in the applicable
+# License Agreement between RightScale.com, Inc. and
+# the licensee.