right_link 5.9.0

data/scripts/reenroller.rb

@@ -0,0 +1,193 @@
+# === Synopsis:
+#   RightScale Re-enroller (rs_reenroll) - (c) 2010-2011 RightScale Inc
+#
+#   Re-enroller causes the instance to re-enroll
+#   CAUTION: This process may take a while to take place, during that time
+#            the agent will be un-responsive. Only use when the instance is in
+#            a bad state and you understand the consequences.
+#
+# === Usage
+#    rs_reenroll
+#
+#    Options:
+#      --verbose, -v     Display debug information
+#      --help:           Display help
+#      --version:        Display version information
+#
+
+require 'rubygems'
+require 'trollop'
+require 'fileutils'
+require 'right_agent'
+require 'right_agent/scripts/usage'
+require 'right_agent/scripts/common_parser'
+
+require File.normalize_path(File.join(File.dirname(__FILE__), '..', 'lib', 'instance', 'agent_config'))
+
+module RightScale
+
+  class Reenroller
+
+    if RightScale::Platform.windows?
+      # Note we currently only need a reenroller state file under windows.
+      STATE_DIR  = AgentConfig.agent_state_dir
+      STATE_FILE = File.join(STATE_DIR, 'reenroller_state.js')
+    end
+
+    # Trigger re-enrollment
+    #
+    # === Return
+    # true:: Always return true
+    def run(options)
+      AgentConfig.root_dir = AgentConfig.right_link_root_dirs
+
+      if RightScale::Platform.windows?
+        cleanup_certificates(options)
+        # Write state file to indicate to RightScaleService that it should not
+        # enter the rebooting state (which is the default behavior when the
+        # RightScaleService starts).
+        reenroller_state = {:reenroll => true}
+        File.open(STATE_FILE, "w") { |f| f.write reenroller_state.to_json }
+        print 'Restarting RightScale service...' if options[:verbose]
+        res = system('net start RightScale')
+        puts to_ok(res) if options[:verbose]
+      else
+        print 'Stopping RightLink daemon...' if options[:verbose]
+        pid_file = AgentConfig.pid_file('instance')
+        pid = pid_file ? pid_file.read_pid[:pid] : nil
+        system('/opt/rightscale/bin/rchk --stop')
+        # Wait for agent process to terminate
+        retries = 0
+        while process_running?(pid) && retries < 40
+          sleep(0.5)
+          retries += 1
+          print '.' if options[:verbose]
+        end
+        puts to_ok(!process_running?(pid)) if options[:verbose]
+        # Kill it if it's still alive after ~ 20 sec
+        if process_running?(pid)
+          print 'Forcing RightLink daemon to exit...' if options[:verbose]
+          res = Process.kill('KILL', pid) rescue nil
+          puts to_ok(res) if options[:verbose]
+        end
+        cleanup_certificates(options)
+
+        # Resume option bypasses cloud state initialization so that we can
+        # override the user data
+        puts((options[:resume] ? 'Resuming' : 'Restarting') + ' RightLink daemon...') if options[:verbose]
+        action = (options[:resume] ? 'resume' : 'start')
+        res = system("/etc/init.d/rightlink #{action} > /dev/null")
+      end
+      true
+    rescue Errno::EACCES => e
+      STDERR.puts e.message
+      STDERR.puts "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
+      parser = Trollop::Parser.new do
+        opt :resume
+        opt :verbose
+        version ""
+      end
+
+      begin
+        parser.parse
+      rescue Trollop::HelpNeeded
+        puts Usage.scan(__FILE__)
+        exit
+      rescue Trollop::VersionNeeded
+        puts version
+        exit(0)
+      rescue Trollop::CommandlineError => e
+        puts e.message + "\nUse --help for additional information"
+        exit(1)
+      end
+    end
+
+    protected
+
+    # Map given value to [OK] or [ERROR]
+    # By default return [OK] unless value is false or nil
+    # Override default behavior by using 'ok_values' and/or 'error_values'
+    #
+    # === Parameters
+    # val(Object):: Value to be tested
+    # default_ok(Boolean):: Whether default value is '[OK]' (true) or '[ERROR]' (false), '[OK]' by default
+    # ok_values(Array):: Array of values that will cause +to_ok+ to return '[OK]' if defined, nil by default
+    # error_values(Array):: Array of values that will cause +to_ok+ to return '[ERROR]' if defined, [nil, false] by default
+    #
+    # === Return
+    # status(String):: [OK] or [ERROR]
+    def to_ok(val, default_value='[OK]', ok_values=nil, error_values=[nil, false])
+      return '[OK]' if ok_values && ok_values.include?(val)
+      return '[ERROR]' if error_values && error_values.include?(val)
+      return default_value
+    end
+
+    # Cleanup certificates
+    #
+    # === Parameters
+    # options(Hash):: Options hash
+    #
+    # === Return
+    # true:: Always return true
+    def cleanup_certificates(options)
+      puts 'Cleaning up certificates...' if options[:verbose]
+      AgentConfig.certs_files("*.{cert,key}").each { |f| FileUtils.rm_f(f) } # requires that root_dir already known in AgentConfig
+    end
+
+    # Checks whether process with given pid is running
+    #
+    # === Parameters
+    # pid(Fixnum):: Process id to be checked
+    #
+    # === Return
+    # true:: If process is running
+    # false:: Otherwise
+    def process_running?(pid)
+      return false unless pid
+      Process.getpgid(pid) != -1
+    rescue Errno::ESRCH
+      false
+    end
+    
+    # Version information
+    #
+    # === Return
+    # (String):: Version information
+    def version
+      gemspec = eval(File.read(File.join(File.dirname(__FILE__), '..', 'right_link.gemspec')))
+      "rs_reenroll #{gemspec.version} - RightLink's reenroller (c) 2011 RightScale"
+    end
+
+  end # Reenroller
+
+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/server_importer.rb

@@ -0,0 +1,293 @@
+# === Synopsis:
+#   RightScale Server Import Utility (rs_connect) - (c) 2011 RightScale Inc
+#
+#   This utility allows an arbitrary virtual or physical machine to be
+#   managed by the RightScale dashboard.
+#
+# === Usage
+#    rs_connect --attach <url> [options]
+#
+#    Options:
+#      --attach, -a       Attach this machine to a server
+#      --force, -f        Force attachment even if server appears already connected.
+#      --cloud, -c        Name of cloud in which instance is running or 'none'
+#                         to indicate instance is not running in any cloud. If a
+#                         cloud has already been selected during installation of
+#                         RightLink then this option will override that choice.
+#                         If no choice has been made then the default is 'none'.
+#      --help:            Display help
+#      --version:         Display version information
+#
+#    No options prints usage information.
+#
+
+require 'rubygems'
+require 'trollop'
+require 'uri'
+require 'logger'
+require 'net/http'
+require 'fileutils'
+require 'right_agent'
+require 'right_agent/scripts/usage'
+require 'right_agent/scripts/common_parser'
+require 'right_http_connection'
+require File.normalize_path(File.join(File.dirname(__FILE__), '..', 'lib', 'instance'))
+
+module RightScale
+
+  class ServerImporter
+    # Exception class to use as a token that something went wrong with an HTTP query
+    class QueryFailed < Exception; end
+
+    # Exception class to use when the user data doesn't look right
+    class MalformedResponse < Exception; end
+
+    # Unsupported architecture or operating system
+    class UnsupportedPlatform < Exception; end
+
+    # Run
+    #
+    # === Parameters
+    # options(Hash):: Hash of options as defined in +parse_args+
+    #
+    # === Return
+    # true:: Always return true
+    def run(options)
+      configure_logging
+
+      case options[:action]
+        when :attach
+          # resolve cloud name.
+          cloud_file = RightScale::AgentConfig.cloud_file_path
+          cloud_name = options[:cloud]
+          if cloud_name.nil? && File.file?(cloud_file)
+            cloud_name = File.read(cloud_file).strip
+          end
+          cloud_name = 'none' if cloud_name.to_s.empty?
+
+          cloud_dir   = File.dirname(cloud_file)
+          output_file = File.join(RightScale::Platform.filesystem.spool_dir, cloud_name, 'user-data.txt')
+          output_dir  = File.dirname(output_file)
+
+          if File.exist?(InstanceState::STATE_FILE) && !options[:force]
+            puts "It appears this system is already managed by RightScale; cannot continue"
+            puts
+            puts "To override this decision, use the --force option. Please make sure you"
+            puts "know what you are doing! Connecting this system to a server when it is"
+            puts "already connected to another server could cause unexpected behavior in"
+            puts "the RightScale dashboard, and in certain cases, data loss!"
+            exit(-1)
+          end
+
+          puts "Fetching launch settings from RightScale"
+          url  = options[:url]
+          data = http_get(url, false)
+
+          unless data =~ /RS_rn_id/i
+            Log.error("Malformed launch settings: #{data}")
+            raise MalformedResponse, "Launch settings do not look well-formed; did you specify the right URL?"
+          end
+
+          puts "Creating cloud-family hint file (#{cloud_file})"
+          FileUtils.mkdir_p(cloud_dir)
+          File.open(cloud_file, 'w') do |f|
+            f.puts cloud_name
+          end
+
+          puts "Writing launch settings to file"
+          FileUtils.mkdir_p(output_dir)
+          File.open(output_file, 'w') do |f|
+            f.puts data
+          end
+
+          puts "Done connecting server to RightScale. Will now attempt to start the RightLink services."
+          puts "If starting of services fails, you can attempt to start them by rebooting."
+          if RightScale::Platform.windows?
+            puts `net start rightscale`
+            exit $?.exitstatus unless $?.success?
+          elsif RightScale::Platform.linux? || RightScale::Platform.darwin?
+            puts `/etc/init.d/rightscale start && /etc/init.d/rightlink start`
+            exit $?.exitstatus unless $?.success?
+          else
+            raise UnsupportedPlatform, "Starting services is not supported for this platform."
+          end
+          exit
+        else
+          puts Usage.scan(__FILE__)
+          exit
+      end
+    rescue SystemExit => e
+      raise e
+    rescue Exception => e
+      fail(e)
+    end
+
+    # Create options hash from command line arguments
+    #
+    # === Return
+    # options(Hash):: Hash of options as defined by the command line
+    def parse_args
+      options = { :verbose => false, :status => false, :immediately => false, :action => :attach}
+
+      parser = Trollop::Parser.new do 
+        opt :url, "", :long => "--attach", :short => "-a", :type => String, :required => true
+        opt :force
+        opt :cloud, "", :type => String
+        version ""
+      end
+
+      begin
+        options.merge(parser.parse)
+      rescue Trollop::HelpNeeded
+        puts Usage.scan(__FILE__)
+        exit
+      rescue Trollop::CommandlineError => e
+        puts e.message + "\nUse --help for additional information"
+        exit(1)
+      rescue Trollop::VersionNeeded
+        puts version
+        succeed
+      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
+    
+    # Version information
+    #
+    # === Return
+    # (String):: Version information
+    def version
+      gemspec = eval(File.read(File.join(File.dirname(__FILE__), '..', 'right_link.gemspec')))
+      "rs_connect #{gemspec.version} - RightLink's server importer (c) 2011 RightScale"
+    end
+
+    private
+
+    def configure_logging
+      Log.program_name = 'RightLink'
+      Log.facility = 'user'
+      Log.log_to_file_only(false)
+      Log.level = Logger::INFO
+      FileUtils.mkdir_p(File.dirname(InstanceState::BOOT_LOG_FILE))
+      Log.add_logger(Logger.new(File.open(InstanceState::BOOT_LOG_FILE, 'a')))
+    end
+
+    # Performs an HTTP get request with built-in retries and redirection based
+    # on HTTP responses.
+    #
+    # === Parameters
+    # attempts(int):: number of attempts
+    #
+    # === Return
+    # result(String):: body of response or nil
+    def http_get(path, keep_alive = true)
+      uri = safe_parse_http_uri(path)
+      history = []
+      loop do
+        Log.debug("http_get(#{uri})")
+
+        # keep history of live connections for more efficient redirection.
+        host = uri.host
+        connection = Rightscale::HttpConnection.new(:logger => Log, :exception => QueryFailed)
+
+        # prepare request. ensure path not empty due to Net::HTTP limitation.
+        #
+        # note that the default for Net::HTTP is to close the connection after
+        # each request (contrary to expected conventions). we must be explicit
+        # about keep-alive if we want that behavior.
+        request = Net::HTTP::Get.new(uri.path)
+        request['Connection'] = keep_alive ? 'keep-alive' : 'close'
+
+        # get.
+        response = connection.request(:protocol => uri.scheme, :server => uri.host, :port => uri.port, :request => request)
+        return response.body if response.kind_of?(Net::HTTPSuccess)
+        if response.kind_of?(Net::HTTPServerError) || response.kind_of?(Net::HTTPNotFound)
+          Log.debug("Request failed but can retry; #{response.class.name}")
+          return nil
+        elsif response.kind_of?(Net::HTTPRedirection)
+          # keep history of redirects.
+          location = response['Location']
+          uri = safe_parse_http_uri(location)
+        else
+          # not retryable.
+          #
+          # note that the EC2 metadata server is known to give malformed
+          # responses on rare occasions, but the right_http_connection will
+          # consider these to be 'bananas' and retry automatically (up to a
+          # pre-defined limit).
+          Log.error("HTTP request failed: #{response.class.name}")
+          raise QueryFailed, "HTTP request failed: #{response.class.name}"
+        end
+      end
+    end
+
+    # Handles some cases which raise exceptions in the URI class.
+    #
+    # === Parameters
+    # path(String):: URI to parse
+    #
+    # === Return
+    # uri(URI):: parsed URI
+    #
+    # === Raise
+    # URI::InvalidURIError:: on invalid URI
+    def safe_parse_http_uri(path)
+      raise ArgumentError.new("URI path cannot be empty") if path.to_s.empty?
+      begin
+        uri = URI.parse(path)
+      rescue URI::InvalidURIError => e
+        # URI raises an exception for paths like "<IP>:<port>"
+        # (e.g. "127.0.0.1:123") unless they also have scheme (e.g. http)
+        # prefix.
+        raise e if path.start_with?("http://") || path.start_with?("https://")
+        uri = URI.parse("http://" + path)
+        uri = URI.parse("https://" + path) if uri.port == 443
+        path = uri.to_s
+      end
+
+      # supply any missing default values to make URI as complete as possible.
+      if uri.scheme.nil? || uri.host.nil?
+        scheme = (uri.port == 443) ? 'https' : 'http'
+        uri = URI.parse("#{scheme}://#{path}")
+        path = uri.to_s
+      end
+      if uri.path.to_s.empty?
+        uri = URI.parse("#{path}/")
+        path = uri.to_s
+      end
+
+      return uri
+    end
+
+    def succeed
+      exit(0)
+    end
+  end
+
+end

data/scripts/shutdown_client.rb

@@ -0,0 +1,183 @@
+# === Synopsis:
+#   RightScale System Shutdown Utility (rs_shutdown) - (c) 2011 RightScale Inc
+#
+#   This utility allows the given system to be shutdown or rebooted.
+#
+# === Examples:
+#   Shutdown:
+#     rs_shutdown --reboot --immediately
+#     rs_shutdown -r -i
+#     rs_shutdown --stop --deferred
+#     rs_shutdown -s -d
+#     rs_shutdown --terminate
+#     rs_shutdown -t
+#
+# === Usage
+#    rs_shutdown [options]
+#
+#    Options:
+#      --reboot, -r       Request reboot.
+#      --stop, -s         Request stop (boot volume is preserved).
+#      --terminate, -t    Request termination (boot volume is discarded).
+#      --immediately, -i  Request immediate shutdown (reboot, stop or terminate) bypassing any pending scripts and preserving instance state.
+#      --deferred, -d     Request deferred shutdown (reboot, stop or terminate) pending finish of any remaining scripts (default).
+#      --verbose, -v      Display debug information
+#      --help:            Display help
+#      --version:         Display version information
+#
+#    No options prints the current RightLink agent log level
+#
+
+require 'rubygems'
+require 'trollop'
+require 'right_agent'
+require 'right_agent/scripts/usage'
+require 'right_agent/scripts/common_parser'
+
+require File.normalize_path(File.join(File.dirname(__FILE__), '..', 'lib', 'instance', 'shutdown_request'))
+
+module RightScale
+
+  class ShutdownClient
+
+    # Run
+    #
+    # === Parameters
+    # options(Hash):: Hash of options as defined in +parse_args+
+    #
+    # === Return
+    # true:: Always return true
+    def run(options)
+      fail("Missing required shutdown argument") unless options[:level]
+      cmd = {}
+      cmd[:name] = :set_shutdown_request
+      cmd[:level] = options[:level]
+      cmd[:immediately] = options[:immediately]
+      config_options = AgentConfig.agent_options('instance')
+      listen_port = config_options[:listen_port]
+      fail('Could not retrieve agent listen port') unless listen_port
+      client = CommandClient.new(listen_port, config_options[:cookie])
+      begin
+        client.send_command(cmd, options[:verbose]) do |response|
+          if response[:error]
+            fail("Failed #{cmd.inspect} with #{response[:error]}")
+          else
+            message = response[:level]
+            message += " immediately" if response[:immediately]
+            puts message
+          end
+        end
+      rescue Exception => e
+        fail(e.message)
+      end
+      true
+    rescue SystemExit => e
+      raise e
+    rescue Exception => e
+      fail(e)
+    end
+
+    # Create options hash from command line arguments
+    #
+    # === Return
+    # options(Hash):: Hash of options as defined by the command line
+    def parse_args
+      options = { :verbose => false, :status => false, :immediately => false }
+      parser = Trollop::Parser.new do
+        opt :reboot
+        opt :stop
+        opt :terminate
+        opt :immediately
+        opt :deferred
+        opt :verbose
+        version ""
+        conflicts :deferred, :immediately
+      end
+
+      begin
+        options.merge!(parser.parse)
+        options[:level] = ::RightScale::ShutdownRequest::REBOOT if options[:reboot]
+        options[:level] = ::RightScale::ShutdownRequest::STOP if options[:stop]
+        options[:level] = ::RightScale::ShutdownRequest::TERMINATE if options[:terminate]
+        options[:immediately] = false if options[:deferred]
+      rescue Trollop::VersionNeeded
+        puts version
+        succeed
+      rescue Trollop::HelpNeeded
+        puts Usage.scan(__FILE__)
+        exit
+      rescue SystemExit => e
+        raise e
+      rescue Exception => e
+        puts e.message + "\nUse --help for additional information"
+        exit(1)
+      end
+      options
+    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
+    
+    # Version information
+    #
+    # === Return
+    # (String):: Version information
+    def version
+      gemspec = eval(File.read(File.join(File.dirname(__FILE__), '..', 'right_link.gemspec')))
+      "rs_shutdown #{gemspec.version} - RightLink's shutdown client (c) 2011 RightScale"
+    end
+
+    def succeed
+      exit(0)
+    end
+
+  end # ShutdownClient
+
+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.