right_link 5.9.1 → 5.9.2

data/RELEASES.rdoc

@@ -1,3 +1,36 @@
+= 5.9.2 (RightLink 5.9 beta 3)
+
+Released 2013-09-06.
+
+== New Features
+
+* RightLink's log level can now be controlled by a tag, "rs_agent_dev:log_level". The rs_log_level
+  command is now an interface for getting or setting this tag.
+* The log-level tag and command no longer apply to the RightLink agent, only to Chef and RightScript
+  execution. To set the RightLink agent's log level explicitly, use the "--agent" option of
+  rs_log_level.
+* When running on a RedHat-derived distro, RightLink installs public keys for EPEL signed packages
+  at boot.
+
+== Changes to Existing Functionality
+
+* When installing RightLink, the recommended technique is to install _only_ the appropriate
+  cloud-support package for the cloud in which RightLink will run. The other RightLink packages
+  will be installed as dependencies. For instance, to install RightLink on an EC2 instance:
+     apt-get install rightlink-cloud-ec2
+* The cloud-support packages for Rackspace clouds have been renamed to avoid confusion. The
+  package for Rackspace Classic is suffixed with "rackspace-first-gen". The support package for
+  Rackspace OpenCloud is suffixed with "rackspace-open-cloud".
+
+== Bug Fixes
+
+* RightLink now looks in the proper directory (/var/spool/rackspace) for cloud-injected
+  userdata when running on Rackspace OpenCloud.
+* RightLink now requires a modern version of sudo (we rely on the #includedir directive)
+* Included SUSE vendor-support tags in our rpmspec to prevent warnings from zypper
+* RightLink DEBs are now signed
+* Init scripts have more accurate LSB metadata, preventing warnings from init-updaters
+
 = 5.9.1 (RightLink 5.9 beta 2)
 
 Released 2013-08-07.
@@ -27,11 +60,13 @@ Released 2013-07-13.
 
 == New Features
 
-* The RS_DECOM_REASON environment variable is set during decommission script/recipe execution to indicate the reason why decommission
-  is running. This variable will have one of the following values: 'reboot', 'stop', 'terminate' or 'unknown'
-  The value will be 'reboot', 'stop' or 'terminate' when decommissioning through the RightScale dashboard or when using the
-  rs_shutdown command. The 'unknown' value may be seen when the rightlink service is decommissioned (not stopped) from the console or
-  else the instance is shutdown or rebooted without using the rs_shutdown command.
+* The RS_DECOM_REASON environment variable is set during decommission script/recipe execution to
+  indicate the reason why decommission is running. This variable will have one of the following
+  values: 'reboot', 'stop', 'terminate' or 'unknown'. The value will be 'reboot', 'stop' or
+  'terminate' when decommissioning through the RightScale dashboard or when using the rs_shutdown
+  command. The 'unknown' value may be seen when the rightlink service is decommissioned (not
+  stopped) from the console or else the instance is shutdown or rebooted without using the
+  rs_shutdown command.
 * RightLink is distributed as a modular "tree" of packages, making it easy to install just what you need
 * Improved package hygiene, e.g. clean uninstall and minimal post-install filesystem tampering
 * Ability to distinguish between sudo (server_login + server_superuser) and normal (server_login) users

data/actors/instance_setup.rb

@@ -169,7 +169,7 @@ class InstanceSetup
         # we are no longer freezing log level for v5.8+
         tagged_log_level = ::RightScale::CookState.dev_log_level
         RightScale::Log.level = tagged_log_level if tagged_log_level
-        RightScale::Log.info("Tags discovered at initial startup: #{tags.inspect} (dev mode = #{::RightScale::CookState.dev_mode_enabled?})")
+        RightScale::Log.info("Tags discovered at initial startup: #{tags.inspect}")
       end
 
       # Setup suicide timer which will cause instance to shutdown if the rs_launch:type=auto tag

data/bin/cook_runner

@@ -15,6 +15,7 @@ require 'right_scraper'
 
 BASE_DIR = File.join(File.dirname(__FILE__), '..')
 
+require File.normalize_path(File.join(BASE_DIR, 'lib', 'right_link', 'version'))
 require File.normalize_path(File.join(BASE_DIR, 'lib', 'instance'))
 require File.normalize_path(File.join(BASE_DIR, 'lib', 'instance', 'cook'))
 

data/lib/instance/cook/audit_logger.rb

@@ -102,9 +102,7 @@ module RightScale
       return true if is_filtered?(severity, message)
       msg = format_message(format_severity(severity), Time.now, progname, message)
       case severity
-      when Logger::DEBUG
-        Log.debug(message)
-      when Logger::INFO, Logger::WARN, Logger::UNKNOWN
+      when Logger::INFO, Logger::WARN, Logger::UNKNOWN, Logger::DEBUG
         AuditStub.instance.append_output(msg)
       when Logger::ERROR
         AuditStub.instance.append_error(msg)

data/lib/instance/cook/cook.rb

@@ -94,6 +94,7 @@ module RightScale
       EM.run do
         begin
           AuditStub.instance.init(options)
+          check_for_missing_inputs(bundle)
           gatherer.callback { EM.defer { sequence.run } }
           gatherer.errback { success = false; report_failure(gatherer) }
           sequence.callback { success = true; send_inputs_patch(sequence) }
@@ -113,6 +114,17 @@ module RightScale
       exit(1) unless success
     end
 
+    def check_for_missing_inputs(bundle)
+      pending_executables = bundle.executables.select { |e| !e.ready }
+      unless pending_executables.empty?
+        pending_executables.each do |e|
+          missing_input_names = e.input_flags.collect {|k,v| k if v.member?("unready")}.compact
+          AuditStub.instance.append_info("Following inputs used by '#{e.nickname} are missing': #{missing_input_names.join(", ")}")
+        end
+        fail("Execution failed", "Missing inputs")
+      end
+    end
+
     # Determines if the current cook process has the default thread for purposes
     # of concurrency with non-defaulted cooks.
     def has_default_thread?

data/lib/instance/cook/cook_state.rb

@@ -112,18 +112,6 @@ module RightScale
       !!@reboot
     end
 
-    # Is the instance running in dev mode?
-    # dev mode tweaks the behavior of the RightLink agent to help
-    # the development of Chef recipes.
-    # In dev mode, the log level is always debug.
-    #
-    # === Return
-    # true:: If dev tags are defined on this instance
-    # false:: Otherwise
-    def dev_mode_enabled?
-      !!tag_value(DEV_TAG_NAMESPACE)
-    end
-
     # Determines the developer log level, if any, which forces and supercedes
     # all other log level configurations.
     #
@@ -202,7 +190,12 @@ module RightScale
     # === Return
     # level(Integer):: one of Logger::INFO ... Logger::FATAL
     def log_level
-      @log_level
+      case @log_level
+      when Symbol, String
+        Log.level_from_sym(@log_level.to_sym)
+      else
+        @log_level
+      end
     end
 
     # Re-initialize then merge given state

data/lib/instance/cook/executable_sequence.rb

@@ -557,6 +557,14 @@ module RightScale
           @audit.create_new_section('Preparing execution')
         end
 
+        log_desc = "Log level is #{Log.level_to_sym(CookState.log_level)}"
+        if CookState.dev_log_level
+          log_desc << " (overridden by #{CookState::LOG_LEVEL_TAG}=#{CookState.dev_log_level})"
+        end
+        log_desc << '.'
+        @audit.append_info(log_desc)
+        @audit.append_info('The download once flag is set.') if CookState.download_once?
+
         @audit.append_info("Run list for thread #{@thread_name.inspect} contains #{@run_list.size} items.")
         @audit.append_info(@run_list.join(', '))
 

data/lib/instance/cook/repose_downloader.rb

@@ -109,12 +109,12 @@ module RightScale
             attempts += 1
             t0 = Time.now
 
-            # Previously we accessed RestClient directly and used it's wrapper method to instantiate 
+            # Previously we accessed RestClient directly and used it's wrapper method to instantiate
             # a RestClient::Request object.  This wrapper was not passing all options down the stack
             # so now we invoke the RestClient::Request object directly, passing it our desired options
-            client.execute(:method => :get, :url => "https://#{endpoint}:443#{resource}", :timeout => calculate_timeout(attempts), :verify_ssl => OpenSSL::SSL::VERIFY_PEER, :ssl_ca_file => get_ca_file, :headers => {:user_agent => "RightLink v#{AgentConfig.protocol_version}"}) do |response, request, result|
+            client.execute(:method => :get, :url => "https://#{endpoint}:443#{resource}", :timeout => calculate_timeout(attempts), :verify_ssl => OpenSSL::SSL::VERIFY_PEER, :ssl_ca_file => get_ca_file, :headers => {:user_agent => "RightLink v#{AgentConfig.protocol_version}", 'X-RightLink-Version' => RightLink::VERSION }) do |response, request, result|
               if result.kind_of?(Net::HTTPSuccess)
-                @size = result.content_length
+                @size = result.content_length || response.size || 0
                 @speed = @size / (Time.now - t0)
                 yield response
               else
@@ -223,7 +223,7 @@ module RightScale
 
     # Orders ips by hostnames
     #
-    # The purpose of this method is to sort ips of hostnames so it tries all IPs of hostname 1, 
+    # The purpose of this method is to sort ips of hostnames so it tries all IPs of hostname 1,
     # then all IPs of hostname 2, etc
     #
     # == Return
@@ -264,7 +264,7 @@ module RightScale
       )
     end
 
-    # Exponential incremental timeout algorithm.  Returns the amount of 
+    # Exponential incremental timeout algorithm.  Returns the amount of
     # of time to wait for the next iteration
     #
     # === Parameters

data/lib/right_link/version.rb

@@ -0,0 +1,4 @@
+module RightLink
+  VERSION = "5.9.2"
+end
+

data/scripts/agent_checker.rb

@@ -1,5 +1,5 @@
 # === Synopsis:
-#   RightScale Agent Checker (rchk) - (c) 2010-2011 RightScale Inc
+#   RightScale Agent Checker (rchk) - (c) 2010-2013 RightScale Inc
 #
 #   Checks the agent to see if it is actively communicating with RightNet and if not
 #   triggers it to re-enroll and exits.
@@ -37,6 +37,7 @@ require 'right_agent/scripts/common_parser'
 
 require File.normalize_path(File.join(File.dirname(__FILE__), '..', 'lib', 'instance', 'agent_watcher'))
 require File.normalize_path(File.join(File.dirname(__FILE__), '..', 'lib', 'instance', 'agent_config'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'command_helper'))
 
 module RightScale
 
@@ -81,7 +82,7 @@ module RightScale
   end # AgentCheckerCommands
 
   class AgentChecker
-
+    include CommandHelper
     include DaemonizeHelper
 
     VERSION = [0, 1]
@@ -163,7 +164,6 @@ module RightScale
     def start(options)
       begin
         setup_traps
-        @command_serializer = Serializer.new
         @state_serializer = Serializer.new(:json)
 
         # Retrieve instance agent configuration options
@@ -248,7 +248,7 @@ module RightScale
         version ""
       end
       
-      begin 
+      parse do
         options = parser.parse
         options.delete(:max_attempts) unless options[:max_attempts] > 0
         if options[:delete]
@@ -256,17 +256,10 @@ module RightScale
         end
         options.delete(:retry_interval) unless options[:retry_interval] > 0
         options
-      rescue Trollop::HelpNeeded
-        puts Usage.scan(__FILE__)
-        exit
-      rescue Trollop::CommandlineError => e
-        error("#{e}\nUse --help for additional information", nil, abort = true)
-      rescue Trollop::VersionNeeded
-        puts version
-        exit
       end
     end
 
+
 protected
 
     # Perform required checks
@@ -285,8 +278,7 @@ protected
             info("Stopping checker daemon")
             if RightScale::Platform.windows?
               begin
-                client = CommandClient.new(pid_data[:listen_port], pid_data[:cookie])
-                client.send_command({:name => :terminate}, verbose = @options[:verbose], timeout = 30) do |r|
+                send_command({:name => :terminate}, verbose = @options[:verbose], timeout = 30) do |r|
                   info(r)
                   terminate
                 end
@@ -391,11 +383,9 @@ protected
     # true:: Always return true
     def try_communicating(attempt)
       begin
-        listen_port = @agent[:listen_port]
-        client = CommandClient.new(listen_port, @agent[:cookie])
-        client.send_command({:name => "check_connectivity"}, @options[:verbose], COMMAND_IO_TIMEOUT) do |r|
+        send_command({:name => "check_connectivity"}, @options[:verbose], COMMAND_IO_TIMEOUT) do |r|
           @command_io_failures = 0
-          res = OperationResult.from_results(@command_serializer.load(r)) rescue nil
+          res = serialize_operation_result(r) rescue nil
           if res && res.success?
             info("Successful agent communication" + (attempt > 1 ? " on attempt #{attempt}" : ""))
             @retry_timer.cancel if @retry_timer
@@ -542,7 +532,11 @@ protected
     # === Return
     # ver(String):: Version information
     def version
-      ver = "rchk #{VERSION.join('.')} - RightScale Agent Checker (c) 2010 RightScale"
+      ver = "rchk #{VERSION.join('.')} - RightScale Agent Checker (c) 2013 RightScale"
+    end
+
+    def usage
+      Usage.scan(__FILE__)
     end
 
   end # AgentChecker

data/scripts/agent_controller.rb

@@ -1,5 +1,5 @@
 # === Synopsis:
-#   RightScale Agent Controller (rnac) - (c) 2009-2011 RightScale Inc
+#   RightScale Agent Controller (rnac) - (c) 2009-2013 RightScale Inc
 #
 #   rnac is a command line tool for managing a RightLink agent
 #
@@ -79,10 +79,12 @@ require 'rubygems'
 require 'right_agent/scripts/agent_controller'
 
 require File.normalize_path(File.join(File.dirname(__FILE__), '..', 'lib', 'instance', 'agent_watcher'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'command_helper'))
 
 module RightScale
 
   class RightLinkAgentController < AgentController
+    include CommandHelper
 
     # Create and run controller
     #
@@ -157,16 +159,9 @@ module RightScale
     # === 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 }
+        send_command({ :name => command }, verbose = false, timeout = 100) { |r| puts r }
       rescue SystemExit => e
         raise e
       rescue Exception => e

data/scripts/agent_deployer.rb

@@ -1,5 +1,5 @@
 # === Synopsis:
-#   RightScale Agent Deployer (rad) - (c) 2009-2011 RightScale Inc
+#   RightScale Agent Deployer (rad) - (c) 2009-2013 RightScale Inc
 #
 #   rad is a command line tool for building the configuration file for a RightLink agent
 #

data/scripts/bundle_runner.rb

@@ -1,5 +1,5 @@
 # === Synopsis:
-#   RightScale Bundle Runner (rs_run_right_script/rs_run_recipe) - (c) 2009-2011 RightScale Inc
+#   RightScale Bundle Runner (rs_run_right_script/rs_run_recipe) - (c) 2009-2013 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
@@ -68,10 +68,12 @@ require 'right_agent'
 require 'right_agent/scripts/usage'
 require 'right_agent/scripts/common_parser'
 require 'right_agent/core_payload_types'
+require File.expand_path(File.join(File.dirname(__FILE__), 'command_helper'))
 
 module RightScale
 
   class BundleRunner
+    include CommandHelper
 
     # Default number of seconds to wait for command response
     DEFAULT_TIMEOUT = 20
@@ -97,15 +99,10 @@ module RightScale
       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
+        response = serialize_operation_result(r) rescue nil
         if r == 'OK'
           puts "Request sent successfully"
         elsif response.respond_to?(:success?) && response.success?
@@ -117,8 +114,9 @@ module RightScale
       end
 
       begin
+        check_privileges
         timeout = options[:timeout] || DEFAULT_TIMEOUT
-        client.send_command(cmd, options[:verbose], timeout) { |r| callback.call(r) }
+        send_command(cmd, options[:verbose], timeout) { |r| callback.call(r) }
       rescue Exception => e
         fail(e.message)
       end
@@ -187,7 +185,7 @@ module RightScale
         version ""
       end
 
-      begin 
+      parse do
         options.merge!(parser.parse(arguments))
         options.delete(:name) if options[:id]
         if options[:parameter]
@@ -222,46 +220,10 @@ module RightScale
           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
@@ -301,12 +263,11 @@ protected
     # === 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"
+      "rs_run_right_script & rs_run_recipe #{right_link_version} - RightLink's bundle runner (c) 2013 RightScale"
     end
 
-    def succeed
-      exit(0)
+    def usage
+      Usage.scan(__FILE__)
     end
 
   end # BundleRunner

data/scripts/cloud_controller.rb

@@ -1,5 +1,5 @@
 # === Synopsis:
-#   RightScale Cloud Controller (cloud) - Copyright (c) 2011 by RightScale Inc
+#   RightScale Cloud Controller (cloud) - Copyright (c) 2013 by RightScale Inc
 #
 #   cloud is a command line tool which invokes cloud-specific actions
 #
@@ -37,10 +37,12 @@ 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'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'command_helper'))
 
 module RightScale
 
   class CloudController
+    include CommandHelper
 
     # Convenience wrapper
     def self.run
@@ -121,7 +123,7 @@ module RightScale
         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
+      parse do
         options = parser.parse
         if options[:parameters_given]
           if options[:parameters].start_with?("[")
@@ -131,12 +133,13 @@ module RightScale
           end
         end
         options
-      rescue Trollop::HelpNeeded
-        puts Usage.scan(__FILE__)
-        exit 0
       end
     end
 
+    def usage
+      Usage.scan(__FILE__)
+    end
+
     # Default logger for printing to console
     def default_logger(verbose)
       if verbose

data/scripts/command_helper.rb

@@ -0,0 +1,101 @@
+module RightScale
+  module CommandHelper
+    def check_privileges
+      config_options = ::RightScale::AgentConfig.agent_options('instance')
+      pid_dir = config_options[:pid_dir]
+      identity = config_options[:identity]
+      raise ::ArgumentError.new('Could not get cookie file path') if (pid_dir.nil? & identity.nil?)
+      cookie_file = File.join(pid_dir, "#{identity}.cookie")
+      File.open(cookie_file, "r") { |f| f.close }
+      true
+    rescue Errno::EACCES => e
+      fail(e)
+    end
+    # Creates a command client and sends the given payload.
+    #
+    # === Parameters
+    # @param [Hash] cmd as a payload hash
+    # @param [TrueClass, FalseClass] verbose flag
+    # @param [TrueClass, FalseClass] timeout or nil
+    #
+    # === Block
+    # @yield [response] callback for response
+    # @yieldparam response [Object] response of any type
+    def send_command(cmd, verbose, timeout=20)
+      config_options = ::RightScale::AgentConfig.agent_options('instance')
+      listen_port = config_options[:listen_port]
+      raise ::ArgumentError.new('Could not retrieve agent listen port') unless listen_port
+      client = ::RightScale::CommandClient.new(listen_port, config_options[:cookie])
+      result = nil
+      block = Proc.new do |res|
+        result = res
+        yield res if block_given?
+      end
+      client.send_command(cmd, verbose, timeout, &block)
+      result
+    end
+
+    def serialize_operation_result(res)
+      command_serializer = ::RightScale::Serializer.new
+      ::RightScale::OperationResult.from_results(command_serializer.load(res))
+    end
+
+    # Exit with success.
+    #
+    # === Return
+    # R.I.P. does not return
+    def succeed
+      exit(0)
+    end
+
+    # Print error on console and exit abnormally
+    #
+    # === Parameter
+    # reason(Exception|String|Integer):: Exception, error message or numeric failure code
+    #
+    # === Return
+    # R.I.P. does not return
+    def fail(reason=nil)
+      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 = reason.respond_to(:code) ? reason.code : 50
+      when String
+        STDERR.puts reason
+        code = 50
+      when Integer
+        code = reason
+      else
+        code = 1
+      end
+
+      exit(code)
+    end
+
+    def parse
+      begin
+        yield
+      rescue Trollop::VersionNeeded
+        STDOUT.puts(version)
+        succeed
+      rescue Trollop::HelpNeeded
+        STDOUT.puts(usage)
+        succeed
+      rescue Trollop::CommandlineError => e
+        puts e.message + "\nUse --help for additional information"
+        fail
+      rescue SystemExit => e
+        raise e
+      end
+    end
+
+    def right_link_version
+      gemspec = eval(File.read(File.join(File.dirname(__FILE__), '..', 'right_link.gemspec')))
+      gemspec.version
+    end
+  end
+end