right_link 5.9.0

data/scripts/bundle_runner.rb

@@ -0,0 +1,336 @@
+# === Synopsis:
+#   RightScale Bundle Runner (rs_run_right_script/rs_run_recipe) - (c) 2009-2011 RightScale Inc
+#
+#   rs_run_right_script and rs_run_recipe are command line tools that allow
+#   running RightScripts and recipes respectively from within an instance
+#
+# === Examples:
+#   Run recipe with id 12:
+#     rs_run_recipe -i 12
+#     rs_run_recipe --identity 12
+#
+#   Run recipe 'nginx' using given JSON attributes file:
+#     rs_run_recipe -n nginx -j attribs.js
+#     rs_run_recipe --name nginx --json attribs.js
+#
+#   Run RightScript with id 14 and override input 'APPLICATION' with value
+#   'Mephisto':
+#     rs_run_right_script -i 14 -p APPLICATION=text:Mephisto
+#     rs_run_right_script --identity 14 --parameter APPLICATION=text:Mephisto
+#
+# === Usage:
+#    rs_run_recipe --identity, -i ID [--json, -j JSON_FILE] [--verbose, -v]
+#    rs_run_recipe --name, -n NAME [--json, -j JSON_FILE]
+#                  [--recipient_tags, -r TAG_LIST]
+#                  [--scope, -s SCOPE] [--verbose, -v]
+#    rs_run_right_script --identity, -i ID [--parameter, -p NAME=type:VALUE]*
+#                  [--verbose, -v]
+#    rs_run_right_script --name, -n NAME [--parameter, -p NAME=type:VALUE]*
+#                  [--recipient_tags, -r TAG_LIST]
+#                  [--scope, -s SCOPE] [--verbose, -v]
+#
+#      * Can appear multiple times
+#
+#    Options:
+#      --identity, -i ID     RightScript or ServerTemplateChefRecipe id
+#      --name, -n NAME       RightScript or Chef recipe name (overridden by id)
+#      --json, -j JSON_FILE  JSON file name for JSON to be merged into
+#                              attributes before running recipe
+#      --parameter,
+#        -p NAME=TYPE:VALUE  Define or override RightScript input
+#                              Note: Only applies to run_right_script
+#      --thread,             Schedule the operation on a specific thread name
+#        -t THREAD             for concurrent execution. Thread names must begin
+#                              with a letter and can consist only of lower-case
+#                              alphabetic characters, digits, and the underscore
+#                              character.
+#      --policy,              Audits for the executable to be run will be grouped under
+#        -P POLICY             the given policy name.  All detail will be logged on the instance,
+#                              but limited detail will be audited.
+#      --audit_period        Specifies the period of time that should pass between audits
+#        -a PERIOD_IN_SECONDS
+#      --recipient_tags,     Tags for selecting which instances are to receive
+#                              request with the TAG_LIST being quoted if it
+#        -r TAG_LIST           contains spaces
+#      --scope, -s SCOPE     Scope for selecting tagged recipients: single or
+#                              all (default all)
+#      --cfg-dir, -c DIR     Set directory containing configuration for all
+#                              agents
+#      --verbose, -v         Display progress information
+#      --help:               Display help
+#      --version:            Display version information
+#
+#    Note: Partially specified option names are accepted if not ambiguous.
+
+require 'rubygems'
+require 'trollop'
+require 'right_agent'
+require 'right_agent/scripts/usage'
+require 'right_agent/scripts/common_parser'
+require 'right_agent/core_payload_types'
+
+module RightScale
+
+  class BundleRunner
+
+    # Default number of seconds to wait for command response
+    DEFAULT_TIMEOUT = 20
+
+    # Run recipe or RightScript (that is, schedule it)
+    #
+    # === Parameters
+    # options(Hash):: Hash of options as defined in +parse_args+
+    #
+    # === Block
+    # If a block is given, it should take one argument corresponding to the
+    # reply sent back by the agent
+    #
+    # === Return
+    # true:: If everything went smoothly
+    # false:: If something terrible happened
+    def run(options, &callback)
+      fail('Missing identity or name argument', true) unless options[:id] || options[:name]
+      if options[:thread] && (options[:thread] !~ RightScale::AgentConfig.valid_thread_name)
+        fail("Invalid thread name #{options[:thread]}", true)
+      end
+      echo(options)
+      cmd = { :options => to_forwarder_options(options) }
+      cmd[:name] = options[:bundle_type] == :right_script ? 'run_right_script' : 'run_recipe'
+      AgentConfig.cfg_dir = options[:cfg_dir]
+      config_options = AgentConfig.agent_options('instance')
+      listen_port = config_options[:listen_port]
+      fail('Could not retrieve listen port', false) unless listen_port
+      command_serializer = Serializer.new
+      client = CommandClient.new(listen_port, config_options[:cookie])
+
+      exit_code = true 
+      callback ||= lambda do |r|
+        response = OperationResult.from_results(command_serializer.load(r)) rescue nil
+        if r == 'OK'
+          puts "Request sent successfully"
+        elsif response.respond_to?(:success?) && response.success?
+          puts "Request processed successfully"
+        else
+          puts "Failed to process request: #{(response.respond_to?(:content) && response.content) || '<unknown error>'}"
+          exit_code = false
+        end
+      end
+
+      begin
+        timeout = options[:timeout] || DEFAULT_TIMEOUT
+        client.send_command(cmd, options[:verbose], timeout) { |r| callback.call(r) }
+      rescue Exception => e
+        fail(e.message)
+      end
+      exit_code 
+    rescue SystemExit => e
+      raise e
+    rescue Exception => e
+      fail(e)
+    end
+
+    # Echo what is being requested
+    #
+    # === Parameters
+    # options(Hash):: Options specified
+    #
+    # === Return
+    # true:: Always return true
+    def echo(options)
+      type = options[:bundle_type] == :right_script ? "RightScript" : "recipe"
+      which = options[:id] ? "with ID #{options[:id].inspect}" : "named #{options[:name].inspect}"
+      scope = options[:scope] == :all ? "'all' servers" : "a 'single' server"
+      where = options[:tags] ? "on #{scope} with tags #{options[:tags].inspect}" : "locally on this server"
+      using = ""
+      if options[:parameters] && !options[:parameters].empty?
+        using = " using parameters #{options[:parameters].inspect}"
+      end
+      if options[:json]
+        using += !using.empty? && options[:json_file] ? " and " : " using "
+        using += "options from JSON file #{options[:json_file].inspect}"
+      end
+
+      if options[:thread]
+        thread = " on thread #{options[:thread]}"
+      else
+        thread = ""
+      end
+
+      if options[:policy]
+        policy = " auditing on policy #{options[:policy]}"
+      else
+        policy = ""
+      end
+      puts "Requesting to execute the #{type} #{which} #{where}#{using}#{thread}#{policy}"
+      true
+    end
+
+    # Create options hash from command line arguments
+    #
+    # === Return
+    # options(Hash):: Hash of options as defined by the command line
+    def parse_args(arguments=ARGV)
+      options = { :attributes => {}, :parameters => {}, :verbose => false }
+
+      parser = Trollop::Parser.new do
+        opt :id, "", :type => String, :long => "--identity", :short => "-i"
+        opt :name, "", :type => String
+        opt :parameter, "", :type => :string, :multi => true, :short => "-p"
+        opt :thread, "", :type => String
+        opt :json_file, "", :type => String, :short => "-j", :long => "--json"
+        opt :tags, "", :type => String, :short => "-r", :long => "--recipient_tags"
+        opt :scope, "", :type => String, :default => "all"
+        opt :cfg_dir, "", :type => String
+        opt :policy, "", :type => String, :short => "-P"
+        opt :audit_period, "", :type => :int, :long => "--audit_period"
+        opt :verbose
+        version ""
+      end
+
+      begin 
+        options.merge!(parser.parse(arguments))
+        options.delete(:name) if options[:id]
+        if options[:parameter]
+          options.delete(:parameter).each do |p|
+            name, value = p.split('=', 2)
+            if name && value && value.include?(':')
+              options[:parameters][name] = value
+            else
+              fail("Invalid parameter definition '#{p}', should be of the form 'name=type:value'")
+            end
+          end
+        end
+
+        if options[:json_file]
+          fail("Invalid JSON filename '#{options[:json_file]}'") unless File.file?(options[:json_file])
+          begin
+            options[:json] = IO.read(options[:json_file])
+          rescue Exception => e
+            fail("Invalid JSON content: #{e}")
+          end
+        end
+
+        options[:tags] = options[:tags].split if options[:tags]
+
+        if options[:scope]
+          if options[:scope] == 'single'
+            options[:scope] = :any
+          elsif options[:scope] == 'all'
+            options[:scope] = :all
+          else
+            fail("Invalid scope definition '#{options[:scope]}', should be either 'single' or 'all'")
+          end
+        end
+        options
+      rescue Trollop::HelpNeeded
+        puts Usage.scan(__FILE__)
+        exit
+      rescue Trollop::VersionNeeded
+        puts version
+        succeed
+      rescue Exception => e
+        puts e.message + "\nUse --help for additional information"
+        exit(1)
+      end
+    end
+
+protected
+
+    # Print error on console and exit abnormally
+    #
+    # === Parameter
+    # reason(String|Exception):: Error message or exception, default to nil (no message printed)
+    # print_usage(Boolean):: Whether script usage should be printed, default to false
+    #
+    # === Return
+    # R.I.P. does not return
+    def fail(reason=nil, print_usage=false)
+      case reason
+      when Errno::EACCES
+        STDERR.puts "** #{reason.message}"
+        STDERR.puts "** Try elevating privilege (sudo/runas) before invoking this command."
+        code = 2
+      when Exception
+        STDERR.puts "** #{reason.message}"
+        code = 1
+      else
+        STDERR.puts "** #{reason}" if reason
+        code = 1
+      end
+
+      puts Usage.scan(__FILE__) if print_usage
+      exit(code)
+    end
+
+    # Map arguments options into forwarder actor compatible options
+    #
+    # === Parameters
+    # options(Hash):: Arguments options
+    #
+    # === Return
+    # result(Hash):: Forwarder actor compatible options hash
+    def to_forwarder_options(options)
+      result = {}
+      if options[:tags]
+        result[:tags] = options[:tags]
+        result[:selector] = options[:scope]
+      end
+      if options[:thread]
+        result[:thread] = options[:thread]
+      end
+      if options[:policy]
+        result[:policy] = options[:policy]
+      end
+      if options[:audit_period]
+        result[:audit_period] = options[:audit_period]
+      end
+      if options[:bundle_type] == :right_script
+        result[:right_script_id] = options[:id] if options[:id]
+        result[:right_script]    = options[:name] if options[:name] && !options[:id]
+        result[:arguments]       = options[:parameters] unless options[:parameters].empty?
+      else
+        result[:recipe_id] = options[:id] if options[:id]
+        result[:recipe]    = options[:name] if options[:name] && !options[:id]
+        result[:json]      = options[:json]
+      end
+      result
+    end
+    
+    # Version information
+    #
+    # === Return
+    # (String):: Version information
+    def version
+      gemspec = eval(File.read(File.join(File.dirname(__FILE__), '..', 'right_link.gemspec')))
+      "rs_run_right_script & rs_run_recipe #{gemspec.version} - RightLink's bundle runner (c) 2011 RightScale"
+    end
+
+    def succeed
+      exit(0)
+    end
+
+  end # BundleRunner
+
+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/cloud_controller.rb

@@ -0,0 +1,176 @@
+# === Synopsis:
+#   RightScale Cloud Controller (cloud) - Copyright (c) 2011 by RightScale Inc
+#
+#   cloud is a command line tool which invokes cloud-specific actions
+#
+# === Examples:
+#   Write cloud and user metadata to cache directory using default cloud:
+#     cloud --action=write_metadata
+#
+#   Write user metadata only to cache directory using named ec2 cloud:
+#     cloud --name=ec2 --action=write_user_metadata
+#
+#   Read default cloud user metadata in dictionary format (metadata is output):
+#     cloud --action=read_user_metadata
+#                      --parameters=dictionary_metadata_writer
+#
+# === Usage:
+#    cloud [options]
+#
+#    options:
+#      --action, -a       Action to perform (required, see below for details).
+#      --name, -n         Cloud to use instead of attempting to determine a
+#                         default cloud.
+#      --parameters, -p   Parameters passed to cloud action as either a single
+#                         string argument or as a square-bracketed array in
+#                         JSON format for multiple arguments.
+#      --only-if, -o      Ignores unknown cloud actions instead of printing an
+#                         error.
+
+require 'rubygems'
+require 'json'
+require 'logger'
+require 'trollop'
+require 'fileutils'
+require 'right_agent'
+require 'right_agent/scripts/usage'
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'instance', 'agent_config'))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'clouds', 'register_clouds'))
+
+module RightScale
+
+  class CloudController
+
+    # Convenience wrapper
+    def self.run
+      controller = CloudController.new
+      controller.control(controller.parse_args)
+    rescue Errno::EACCES => e
+      STDERR.puts e.message
+      STDERR.puts "Try elevating privilege (sudo/runas) before invoking this command."
+      exit(2)
+    rescue SystemExit => e
+      raise e
+    rescue Exception => e
+      $stderr.puts "ERROR: #{e.message}"
+      exit 1
+    end
+
+    # Undecorated formatter to support legacy console output
+    class PlainLoggerFormatter < Logger::Formatter
+      def call(severity, time, program_name, message)
+        return message + "\n"
+      end
+    end
+
+    # Parse arguments and run
+    def control(options)
+      fail("No action specified on the command line.") unless options[:action]
+      name = options[:name]
+      parameters = options[:parameters] || []
+      only_if = options[:only_if]
+      verbose = options[:verbose]
+
+      # support either single or a comma-delimited list of actions to execute
+      # sequentially (e.g. "--action clear_state,wait_for_instance_ready,write_user_metadata")
+      # (because we need to split bootstrap actions up in Windows case).
+      actions = options[:action].to_s.split(',').inject([]) do |result, action|
+        unless (action = action.strip).empty?
+          action = action.to_sym
+          case action
+            when :bootstrap
+              # bootstrap is shorthand for all standard actions performed on boot
+              result += [:clear_state, :wait_for_instance_ready, :write_cloud_metadata, :write_user_metadata, :wait_for_eip]
+              only_if = true
+            else
+              result << action
+          end
+        end
+        result
+      end
+
+      cloud = CloudFactory.instance.create(name, :logger => default_logger(verbose))
+
+      actions.each do |action|
+        if cloud.respond_to?(action)
+          # Expect most methods to return ActionResult, but a cloud can expose any
+          # custom method so we can't assume return type
+          result = cloud.send(action, *parameters)
+          $stderr.puts result.error if result.respond_to?(:error) && result.error
+          $stdout.puts result.output if verbose && result.respond_to?(:output) && result.output
+
+          if result.respond_to?(:exitstatus) && (result.exitstatus != 0)
+            raise StandardError, "Action #{action} failed with status #{result.exitstatus}"
+          end
+        elsif only_if
+          next
+        else
+          raise ArgumentError, "ERROR: Unknown cloud action: #{action}"
+        end
+      end
+    end
+
+    # Parse arguments
+    def parse_args
+      parser = Trollop::Parser.new do
+        opt :name, "", :default => CloudFactory::UNKNOWN_CLOUD_NAME.to_s
+        opt :action, "",  :type => :string
+        opt :only_if
+        opt :parameters, "",:type => :string
+        opt :quiet # note that :quiet is deprecated (use -v instead) because Trollop cannot easily support inverse flags that default to true
+        opt :verbose
+      end
+      begin
+        options = parser.parse
+        if options[:parameters_given]
+          if options[:parameters].start_with?("[")
+            options[:parameters] = JSON.parse(options[:parameters])
+          else
+            options[:parameters] = [options[:parameters]]
+          end
+        end
+        options
+      rescue Trollop::HelpNeeded
+        puts Usage.scan(__FILE__)
+        exit 0
+      end
+    end
+
+    # Default logger for printing to console
+    def default_logger(verbose)
+      if verbose
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::INFO
+        logger.formatter = PlainLoggerFormatter.new
+      else
+        logger = RightScale::Log
+      end
+      return logger
+    end
+
+  end # CloudController
+
+end # RightScale
+
+#
+# Copyright (c) 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/log_level_manager.rb

@@ -0,0 +1,142 @@
+# === Synopsis:
+#   RightScale Log Level Manager (rs_log_level) - (c) 2009-2011 RightScale Inc
+#
+#   Log level manager allows setting and retrieving the RightLink agent
+#   log level.
+#
+# === Examples:
+#   Retrieve log level:
+#     rs_log_level
+#
+#   Set log level to debug:
+#     rs_log_level --log-level debug
+#     rs_log_level -l debug
+#
+# === Usage
+#    rs_set_log_level [--log-level, -l debug|info|warn|error|fatal]
+#
+#    Options:
+#      --log-level, -l LVL  Set log level of RightLink agent
+#      --verbose, -v        Display debug information
+#      --help:              Display help
+#      --version:           Display version information
+#
+#    No options prints the current RightLink agent log level
+#
+
+require 'right_agent/scripts/log_level_manager'
+require 'trollop'
+
+module RightScale
+
+  class RightLinkLogLevelManager < LogLevelManager
+
+    # Convenience wrapper for creating and running log level manager
+    #
+    # === Return
+    # true:: Always return true
+    def self.run
+      m = RightLinkLogLevelManager.new
+
+      options = m.parse_args
+      m.manage(options)
+
+      if options[:level] =~ /debug/i && !RightScale::Platform.windows?
+        puts
+        puts "NOTE: RightLink is now logging with syslog severity 'debug', but your system"
+        puts "      log daemon may discard these messages. If debug messages do not appear,"
+        puts "      review your syslog configuration and restart the daemon."
+      end
+    rescue Errno::EACCES => e
+      write_error(e.message)
+      write_error("Try elevating privilege (sudo/runas) before invoking this command.")
+      exit(2)
+    end
+
+    # Create options hash from command line arguments
+    #
+    # === Return
+    # options(Hash):: Hash of options as defined by the command line
+    def parse_args
+      options = { :agent_name => 'instance', :verbose => false }
+
+      parser = Trollop::Parser.new do
+        opt :level, "", :type => String, :long => "--log-level", :short => "-l"
+        opt :verbose
+        version ""
+      end
+
+      begin
+        options.merge!(parser.parse)
+        if options[:level]
+          fail("Invalig log level '#{options[:level]}'") unless AgentManager::LEVELS.include?(options[:level].to_sym)
+        end
+        options
+      rescue Trollop::HelpNeeded
+        write_output(Usage.scan(__FILE__))
+        exit
+      rescue Trollop::VersionNeeded
+        write_output(version)
+        succeed
+      rescue SystemExit => e
+        raise e
+      rescue Exception => e
+        write_output(e.message + "\nUse --help for additional information")
+        exit(1)
+      end
+    end
+    
+protected
+    # Writes to STDOUT (and a placeholder for spec mocking).
+    #
+    # === Parameters
+    # @param [String] message to write
+    def write_output(message)
+      STDOUT.puts(message)
+    end
+
+    # Writes to STDERR (and a placeholder for spec mocking).
+    #
+    # === Parameters
+    # @param [String] message to write
+    def write_error(message)
+      STDERR.puts(message)
+    end
+
+    # Version information
+    #
+    # === Return
+    # (String):: Version information
+    def version
+      gemspec = eval(File.read(File.join(File.dirname(__FILE__), '..', 'right_link.gemspec')))
+      "rs_log_level #{gemspec.version} - RightLink's log level (c) 2011 RightScale"
+    end
+
+    def succeed
+      exit(0)
+    end
+
+  end
+end
+
+#
+# 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/ohai_runner.rb

@@ -0,0 +1,33 @@
+# === Synopsis:
+#   RightScale Ohai Runner - Copyright (c) 2012 by RightScale Inc
+#
+#   runs Ohai in the RightScale environment
+#
+# === Examples:
+#
+# === Usage:
+#    rs_ohai [ohai node name]
+#
+
+require 'rubygems'
+require 'right_agent'
+require 'right_agent/scripts/usage'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'chef', 'ohai_setup')
+require 'ohai/application'
+if RightScale::Platform.windows?
+  require 'ruby-wmi'
+end
+
+module RightScale
+  class OhaiRunner
+    # Activates RightScale environment before running ohai
+    #
+    # === Return
+    # true:: Always return true
+    def run
+      RightScale::OhaiSetup.configure_ohai
+      Ohai::Application.new.run
+      true
+    end
+  end
+end