right_link 5.9.0

data/scripts/agent_controller.rb

@@ -0,0 +1,247 @@
+# === Synopsis:
+#   RightScale Agent Controller (rnac) - (c) 2009-2011 RightScale Inc
+#
+#   rnac is a command line tool for managing a RightLink agent
+#
+# === Examples:
+#   Start new agent named AGENT:
+#     rnac --start AGENT
+#     rnac -s AGENT
+#
+#   Stop running agent named AGENT:
+#     rnac --stop AGENT
+#     rnac -p AGENT
+#
+#   Stop agent with given serialized ID:
+#     rnac --stop-agent ID
+#
+#   Terminate all agents on local machine:
+#     rnac --killall
+#     rnac -K
+#
+#   List agents configured on local machine:
+#     rnac --list
+#     rnac -l
+#
+#   List status of agents configured on local machine:
+#     rnac --status
+#     rnac -U
+#
+#   Start new agent named AGENT in foreground:
+#     rnac --start AGENT --foreground
+#     rnac -s AGENT -f
+#
+#   Start new agent named AGENT of type TYPE:
+#     rnac --start AGENT --type TYPE
+#     rnac -s AGENT -t TYPE
+#
+#   Note: To start multiple agents of the same type generate one
+#         config.yml file with rad and then start each agent with rnac:
+#         rad my_agent
+#         rnac -s my_agent_1 -t my_agent
+#         rnac -s my_agent_2 -t my_agent
+#
+# === Usage:
+#    rnac [options]
+#
+#    options:
+#      --start, -s AGENT          Start agent named AGENT
+#      --stop, -p AGENT           Stop agent named AGENT
+#      --stop-agent ID            Stop agent with serialized identity ID
+#      --kill, -k PIDFILE         Kill process with given process id file
+#      --killall, -K              Stop all running agents
+#      --decommission, -d [AGENT] Send decommission signal to instance agent named AGENT,
+#                                 defaults to 'instance'
+#      --shutdown, -S [AGENT]     Send a terminate request to agent named AGENT,
+#                                 defaults to 'instance'
+#      --status, -U               List running agents on local machine
+#      --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,98589
+#                                 defaults to AGENT with any trailing '_[0-9]+' removed
+#      --list, -l                 List all configured agents
+#      --user, -u USER            Set AMQP user
+#      --pass, -p PASS            Set AMQP password
+#      --vhost, -v VHOST          Set AMQP vhost
+#      --host, -h HOST            Set AMQP server hostname
+#      --port, -P PORT            Set AMQP server port
+#      --cfg-dir, -c DIR          Set directory containing configuration for all agents
+#      --pid-dir, -z DIR          Set directory containing agent process id files
+#      --log-dir DIR              Set log directory
+#      --log-level LVL            Log level (debug, info, warning, error or fatal)
+#      --foreground, -f           Run agent in foreground
+#      --interactive, -I          Spawn an irb console after starting agent
+#      --test                     Use test settings
+#      --help                     Display help
+
+require 'rubygems'
+require 'right_agent/scripts/agent_controller'
+
+require File.normalize_path(File.join(File.dirname(__FILE__), '..', 'lib', 'instance', 'agent_watcher'))
+
+module RightScale
+
+  class RightLinkAgentController < AgentController
+
+    # Create and run controller
+    #
+    # === Return
+    # true:: Always return true
+    def self.run
+      c = RightLinkAgentController.new
+      c.control(c.parse_args)
+    rescue Errno::EACCES => e
+      STDERR.puts e.message
+      STDERR.puts "Try elevating privilege (sudo/runas) before invoking this command."
+      exit(2)
+    end
+
+    protected
+
+    # Parse other arguments used 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("-d", "--decommission [AGENT]") do |a|
+        options[:action] = 'decommission'
+        options[:agent_name] = a || 'instance'
+        options[:thin_command_client] = true
+      end
+
+      opts.on("-S", "--shutdown [AGENT]") do |a|
+        options[:action] = 'shutdown'
+        options[:agent_name] = a || 'instance'
+        options[:thin_command_client] = true
+      end
+
+      opts.on('--help') do
+        puts Usage.scan(__FILE__)
+        exit
+      end
+    end
+
+    # Decommission instance agent
+    #
+    # === Parameters
+    # agent_name(String):: Agent name
+    #
+    # === Return
+    # (Boolean):: true if process was decommissioned, otherwise false
+    def decommission_agent(agent_name)
+      run_command('Decommissioning...', 'decommission')
+    end
+
+    # Shutdown instance agent
+    #
+    # === Parameters
+    # agent_name(String):: Agent name
+    #
+    # === Return
+    # (Boolean):: true if process was shutdown, otherwise false
+    def shutdown_agent(agent_name)
+      run_command('Shutting down...', 'terminate')
+    end
+
+    # Trigger execution of given command in instance agent and wait for it to be done
+    #
+    # === Parameters
+    # message(String):: Console display message
+    # command(String):: Command name
+    #
+    # === Return
+    # (Boolean):: true if command executed successfully, otherwise false
+    def run_command(message, command)
+      options = AgentConfig.agent_options(@options[:agent_name])
+      listen_port = options[:listen_port]
+      unless listen_port
+        $stderr.puts "Could not retrieve listen port for agent #{@options[:identity]}"
+        return false
+      end
+      puts message
+      begin
+        @client = CommandClient.new(listen_port, options[:cookie])
+        @client.send_command({ :name => command }, verbose = false, timeout = 100) { |r| puts r }
+      rescue SystemExit => e
+        raise e
+      rescue Exception => e
+        $stderr.puts Log.format("Failed or else time limit was exceeded, confirm that local instance is still running", e, :trace)
+        return false
+      end
+      true
+    end
+
+    # Start agent
+    #
+    # === Parameters
+    # agent_name(String):: Agent name
+    # agent_class(Agent):: Agent class
+    #
+    # === Return
+    # true:: Always return true
+    def start_agent(agent_name, agent_class = Agent)
+      # note that our Windows service monitors rnac and rchk processes
+      # externally and restarts them if they die, so no need to roll our
+      # own cross-monitoring on that platform.
+      use_agent_watcher = !RightScale::Platform.windows?
+      agent_watcher     = nil
+      if use_agent_watcher
+        agent_watcher = AgentWatcher.new( lambda { |s| Log.info(s) }, @options[:pid_dir] )
+        agent_watcher.watch_agent("#{@options[:identity]}-rchk", '/opt/rightscale/bin/rchk', '--start', '--stop')
+        @options[:ready_callback] = Proc.new { agent_watcher.start_watching() }
+      end
+      super
+      agent_watcher.stop_watching if use_agent_watcher
+    end
+
+    # Determine syslog program name based on options
+    #
+    # === Parameters
+    # options(Hash):: Command line options
+    #
+    # === Return
+    # (String):: Program name
+    def syslog_program_name(options)
+      'RightLink'
+    end
+
+    # Determine syslog facility based on options
+    #
+    # === Parameters
+    # options(Hash):: Command line options
+    #
+    # === Return
+    # (String):: 'user'
+    def syslog_facility(options)
+      'user'
+    end
+  end # RightLinkAgentController
+
+end # RightScale
+
+#
+# Copyright (c) 2009-2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/scripts/agent_deployer.rb

@@ -0,0 +1,148 @@
+# === Synopsis:
+#   RightScale Agent Deployer (rad) - (c) 2009-2011 RightScale Inc
+#
+#   rad is a command line tool for building the configuration file for a RightLink agent
+#
+#   The configuration file is generated in:
+#     <agent name>/config.yml
+#   in platform-specific RightAgent configuration directory
+#
+# === 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
+#
+# === Usage:
+#    rad AGENT [options]
+#
+#    options:
+#      --root-dir, -r DIR       Set agent root directory (containing init, actors, and/or 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
+#      --secure-identity, -S    Derive actual token from given TOKEN and ID
+#      --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 broker host
+#      --port, -P PORT          Set AMQP broker port
+#      --prefetch COUNT         Set maximum requests AMQP broker is to prefetch before current is ack'd
+#      --http-proxy PROXY       Use a proxy for all agent-originated HTTP traffic
+#      --http-no-proxy NOPROXY  Comma-separated list of proxy exceptions (e.g. metadata server)
+#      --time-to-live SEC       Set maximum age in seconds before a request times out and is rejected
+#      --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 mapper to check connectivity, 0 means disable ping
+#      --reconnect-interval SEC Set number of seconds between broker reconnect attempts
+#      --offline-queueing, -q   Enable queuing of requests when lose broker connectivity
+#      --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
+#      --options, -o KEY=VAL    Set options that act as final override for any persisted configuration settings
+#      --test                   Build test deployment using default test settings
+#      --quiet, -Q              Do not produce output
+#      --help                   Display help
+
+require 'rubygems'
+require 'right_agent/scripts/agent_deployer'
+
+module RightScale
+
+  class RightLinkAgentDeployer < AgentDeployer
+
+    # Create and run deployer
+    #
+    # === Return
+    # true:: Always return true
+    def self.run
+      d = RightLinkAgentDeployer.new
+      d.deploy(d.parse_args)
+    rescue Errno::EACCES => e
+      STDERR.puts e.message
+      STDERR.puts "Try elevating privilege (sudo/runas) before invoking this command."
+      exit(2)
+    end
+
+    protected
+
+    # Parse other arguments used 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', '--offline-queueing') do
+        options[:offline_queueing] = 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)
+      cfg = super(options, cfg)
+      cfg[:offline_queueing] = options[:offline_queueing]
+      cfg
+    end
+
+    # Setup agent monitoring
+    # NOTE: Defunct, keep here to overwrite AgentDeployer's
+    # version of this method just in case someone still passes
+    # in the --monit flag.
+    #
+    # === Parameters
+    # options(Hash):: Command line options
+    #
+    # === Return
+    # true:: Always return true
+    def monitor(options)
+      true
+    end
+
+  end # RightLinkAgentDeployer
+
+end # RightScale
+
+#
+# Copyright (c) 2009-2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.