right_link 5.9.0

data/lib/chef/providers/executable_schedule_resource.rb

@@ -0,0 +1,144 @@
+#
+# 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.
+
+# To install the chef gem:
+# sudo gem sources -a http://gems.opscode.com
+# sudo gem install chef ohai
+
+require 'fileutils'
+
+class Chef
+
+  class Resource
+
+    # ExecutableSchedule chef resource.
+    # Allows defining the schedule(cron) for a right script or a recipe
+    class ExecutableSchedule < Chef::Resource
+
+      # Initialize ExecutableSchedule resource with default values
+      #
+      # === Parameters
+      # name(String):: Name of the schedule
+      def initialize(name, run_context=nil)
+        super(name, run_context)
+        @cron_resource = Chef::Resource::Cron.new(name)
+        @cron_resource.user('rightscale')
+        @resource_name = :executable_schedule
+        recipe nil
+        recipe_id nil
+        right_script nil
+        right_script_id nil
+        @action = :create
+        @allowed_actions.push(:create, :delete)
+      end
+
+      # (Chef::Resource::Cron) Underlying cron resource
+      attr_accessor :cron_resource
+      
+      # (String) Schedule name
+      def name(arg=nil)
+        @cron_resource.name(arg)
+      end
+
+      # (String) Schedule minute
+      def minute(arg=nil)
+        @cron_resource.minute(arg)
+      end
+
+      # (String) Schedule hour
+      def hour(arg=nil)
+        @cron_resource.hour(arg)
+      end
+
+      # (String) Schedule day
+      def day(arg=nil)
+        @cron_resource.day(arg)
+      end
+
+      # (String) Schedule month
+      def month(arg=nil)
+        @cron_resource.month(arg)
+      end
+
+      # (String) Schedule weekday
+      def weekday(arg=nil)
+        @cron_resource.weekday(arg)
+      end
+
+      # (String) recipe name for the schedule
+      def recipe(arg=nil)
+        set_or_return(
+          :recipe,
+          arg,
+          :kind_of => [ String ]
+        )
+
+        @cron_resource.command "rs_run_recipe -n #{arg}" if arg
+      end
+
+      # (String) recipe id for the schedule
+      def recipe_id(arg=nil)
+        if Integer(arg) < 0 then raise RangeError end
+        if arg.is_a?(Integer)
+          converted_arg = arg.to_s
+        else
+          converted_arg = arg
+        end
+        set_or_return(
+          :recipe_id,
+          converted_arg,
+          :kind_of => [ String ]
+        )
+
+        @cron_resource.command "rs_run_recipe -i #{converted_arg}" if arg
+      end
+
+      # (String) RightScript's name for the schedule
+      def right_script(arg=nil)
+        set_or_return(
+          :right_script,
+          arg,
+          :kind_of => [ String ]
+        )
+
+        @cron_resource.command "rs_run_right_script -n #{arg}" if arg
+      end
+
+      # (String) RightScript's id for the schedule
+      def right_script_id(arg=nil)
+        if Integer(arg) < 0 then raise RangeError end
+        if arg.is_a?(Integer)
+          converted_arg = arg.to_s
+        else
+          converted_arg = arg
+        end
+        set_or_return(
+          :right_script_id,
+          converted_arg,
+          :kind_of => [ String ]
+        )
+
+        @cron_resource.command "rs_run_right_script -i #{converted_arg}" if arg
+      end
+    end
+  end
+end

data/lib/chef/providers/remote_recipe_provider.rb

@@ -0,0 +1,86 @@
+#
+# 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.
+
+class Chef
+
+  class Provider
+
+    # RemoteRecipe chef provider.
+    class RemoteRecipe < Chef::Provider
+
+      # No concept of a 'current' resource for RemoteRecipe execution, this is a no-op
+      #
+      # === Return
+      # true:: Always return true
+      def load_current_resource
+        true
+      end
+
+      # Actually run RemoteRecipe
+      #
+      # === Return
+      # true:: Always return true
+      def action_run
+        tags          = @new_resource.recipients_tags
+        recipients    = @new_resource.recipients
+        agent_options = RightScale::OptionsBag.load
+        attributes    = { :remote_recipe => { :tags => tags,
+                                              :from => agent_options[:identity] } }
+        attributes.merge!(@new_resource.attributes) if @new_resource.attributes
+        payload = { :recipe => @new_resource.recipe, :json => attributes.to_json }
+        if recipients && !recipients.empty?
+          target = if (s = recipients.size) == 1
+                     'one remote instance'
+                   else
+                     "#{s} remote instances"
+                   end
+          Chef::Log.info("Scheduling execution of #{@new_resource.recipe.inspect} on #{target}")
+          recipients.each do |recipient|
+            RightScale::Cook.instance.send_push('/instance_scheduler/execute', payload, recipient)
+          end
+        end
+        if tags && !tags.empty?
+          selector = (@new_resource.scope == :single ? :any : :all)
+          target_tag = if tags.size == 1
+                         "tag #{tags.first.inspect}"
+                       else
+                         "tags #{tags.map { |t| t.inspect }.join(', ') }"
+                       end
+          target = if selector == :all
+                     "all instances with #{target_tag}"
+                   else
+                     "one instance with #{target_tag}"
+                   end
+          Chef::Log.info("Scheduling execution of #{@new_resource.recipe.inspect} on #{target}")
+          RightScale::Cook.instance.send_push('/instance_scheduler/execute', payload, {:tags => tags, :selector => selector})
+        end
+        true
+      end
+ 
+    end
+
+  end
+ 
+end
+
+# self-register
+Chef::Platform.platforms[:default].merge!(:remote_recipe => Chef::Provider::RemoteRecipe)

data/lib/chef/providers/remote_recipe_resource.rb

@@ -0,0 +1,101 @@
+#
+# 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.
+
+class Chef
+  class Resource
+
+    # Recipe that should be run on a remote RightLink agent
+    #
+    class RemoteRecipe < Chef::Resource
+
+      # Initialize log resource with a name as the string to log
+      #
+      # === Parameters
+      # name(String):: Message to log
+      # collection(Array):: Collection of included recipes
+      # node(Chef::Node):: Node where resource will be used
+      def initialize(name, run_context=nil)
+        super(name, run_context)
+        @resource_name = :remote_recipe
+        @scope = :all
+        @action = :run
+        @allowed_actions.push(:run)
+      end
+
+      # Name of recipe that should be run remotely
+      def recipe(arg=nil)
+        set_or_return(
+          :recipe,
+          arg,
+          :kind_of => [ String ]
+        )
+      end
+
+      # Override attributes that should be used to run the remote recipe
+      def attributes(arg=nil)
+        set_or_return(
+          :attributes,
+          arg,
+          :kind_of => [ Hash ]
+        )
+      end
+
+      # List of ids of agents that should run the recipe
+      # These ids should have been retrieved using the :from attribute
+      # of a remote recipe previously run on this agent
+      def recipients(arg=nil)
+        converted_arg = arg.is_a?(String) ? [ arg ] : arg
+        set_or_return(
+          :recipients,
+          converted_arg,
+          :kind_of => [ Array ]
+        )
+      end
+
+      # List of tags used to route the request
+      # Only instances that expose *all* of the tags in this list
+      # will run the recipe
+      def recipients_tags(arg=nil)
+        converted_arg = arg.is_a?(String) ? [ arg ] : arg
+        set_or_return(
+          :recipient_tags,
+          converted_arg,
+          :kind_of => [ Array ]
+        )
+      end
+
+      # Scope of remote recipe: whether a single or all potential recipients
+      # should run the recipe.
+      # Only applies when used in conjunction with +recipients_tags+
+      # Defaults to :all
+      def scope(arg=nil)
+        set_or_return(
+          :scope,
+          arg,
+          :equal_to => [ :single, :all ]
+        )
+      end
+    end
+  end
+end
+
+

data/lib/chef/providers/right_link_tag_provider.rb

@@ -0,0 +1,73 @@
+#
+# Copyright (c) 2009-2012 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.
+
+class Chef
+
+  class Provider
+
+    # RightLinkTag chef provider.
+    class RightLinkTag < Chef::Provider
+
+      # Load current
+      #
+      # === Return
+      # true:: Always return true
+      def load_current_resource
+        true
+      end
+
+      # Publish tag
+      #
+      # === Return
+      # true:: Always return true
+      def action_publish
+        RightScale::Cook.instance.add_tag(@new_resource.name, @new_resource.timeout)
+        true
+      end
+
+      # Remove tag
+      #
+      # === Return
+      # true:: Always return true
+      def action_remove
+        RightScale::Cook.instance.remove_tag(@new_resource.name, @new_resource.timeout)
+        true
+      end
+
+      # Load current tags
+      #
+      # === Return
+      # true:: Always return true
+      def action_load
+        tags = RightScale::Cook.instance.load_tags(@new_resource.timeout)
+        node[:right_link_tags] = tags
+        true
+      end
+
+    end
+
+  end
+
+end
+
+# self-register
+Chef::Platform.platforms[:default].merge!(:right_link_tag => Chef::Provider::RightLinkTag)

data/lib/chef/providers/right_link_tag_resource.rb

@@ -0,0 +1,59 @@
+#
+# Copyright (c) 2009-2012 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.
+
+class Chef
+  class Resource
+
+    # Tag exposed by RightLink agent
+    #
+    class RightLinkTag < Chef::Resource
+
+      # Initialize tag resource
+      #
+      # === Parameters
+      # name(String):: Tag name
+      # collection(Array):: Collection of included recipes
+      # node(Chef::Node):: Node where resource will be used
+      def initialize(name, run_context=nil)
+        super(name, run_context)
+        @resource_name = :right_link_tag
+        @action = :publish
+        @timeout = 120
+        @allowed_actions.push(:publish, :remove, :load)
+      end
+
+      # (Fixnum) Common timeout parameter for command line tools
+      def timeout(arg=nil)
+        set_or_return(
+          :timeout,
+          arg,
+          :kind_of => [ Fixnum ]
+        )
+      end
+
+    end
+
+  end
+
+end
+
+

data/lib/chef/providers/right_script_provider.rb

@@ -0,0 +1,190 @@
+#
+# Copyright (c) 2009-2012 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.
+
+require 'fileutils'
+require 'right_popen'
+require 'chef/mixin/command'
+
+class Chef
+
+  class Provider
+
+    # RightScript chef provider.
+    class RightScript < Chef::Provider
+
+      include Chef::Mixin::Command
+
+      # No concept of a 'current' resource for RightScript execution, this is a no-op
+      #
+      # === Return
+      # true:: Always return true
+      def load_current_resource
+        true
+      end
+
+      # runs the RightScript in a child process.
+      #
+      # === Return
+      # true:: Always return true
+      #
+      # === Raise
+      # RightScale::Exceptions::Exec:: Invalid process exit status
+      def action_run
+        nickname        = @new_resource.name
+        display_version = @new_resource.display_version || ''
+        run_started_at  = Time.now
+        platform        = RightScale::Platform
+        current_state   = all_state
+
+        # 1. Setup audit and environment
+        begin
+          meta_data = ::File.join(RightScale::AgentConfig.cloud_state_dir, 'meta-data-cache.rb')
+          #metadata does not exist on all clouds, hence the conditional
+          load(meta_data) if ::File.exists?(meta_data)
+        rescue Exception => e
+          ::Chef::Log.info("Could not load cloud metadata; script will execute without metadata in environment!")
+          RightScale::Log.error("Failed loading cloud metadata", e)
+        end
+        begin
+          user_data = ::File.join(RightScale::AgentConfig.cloud_state_dir, 'user-data.rb')
+          #user-data should always exist
+          load(user_data)
+        rescue Exception => e
+          ::Chef::Log.info("Could not load user data; script will execute without user data in environment!")
+          RightScale::Log.error("Failed loading user data", e)
+        end
+        @new_resource.parameters.each { |key, val| ENV[key] = val }
+
+        # Provide the customary RightScript environment metadata
+        ENV['ATTACH_DIR'] = ENV['RS_ATTACH_DIR'] = @new_resource.cache_dir
+        ENV['RS_ALREADY_RUN']                    = current_state[:chef_state].past_scripts.include?(nickname) ? 'true' : nil
+        ENV['RS_REBOOT']                         = current_state[:cook_state].reboot? ? 'true' : nil
+
+        # RightScripts expect to find RS_DISTRO, RS_DIST and RS_ARCH in the environment.
+        # Massage the distro name into the format they expect (all lower case, one word, no release info).
+        if platform.linux?
+          distro = platform.flavor.downcase
+          ENV['RS_DISTRO'] = distro
+          ENV['RS_DIST']   = distro
+          arch_info=`uname -i`.downcase + `uname -m`.downcase
+          if arch_info =~ /i386/ || arch_info =~ /i686/
+              ENV['RS_ARCH'] = "i386"
+          elsif arch_info =~ /64/
+              ENV['RS_ARCH'] = "x86_64"
+          else
+              ENV['RS_ARCH'] = "unknown"
+          end
+        end
+
+        # Add Cloud-Independent Attributes
+        if node[:cloud]
+          ENV['RS_CLOUD_PROVIDER'] = node[:cloud][:provider]
+          instance_public_ip = node[:cloud][:public_ipv4] || (node[:cloud][:public_ips].is_a?(Array) && node[:cloud][:public_ips].first)
+          if instance_public_ip
+            ENV['RS_PUBLIC_IP'] = instance_public_ip
+          else
+            ::Chef::Log.info("Could not retrieve instance public IP")
+          end
+          instance_private_ip = node[:cloud][:local_ipv4] || (node[:cloud][:private_ips].is_a?(Array) && node[:cloud][:private_ips].first)
+          if instance_private_ip
+            ENV['RS_PRIVATE_IP'] = instance_private_ip
+          else
+            ::Chef::Log.info("Could not retrieve instance private IP")
+          end
+        else
+          ::Chef::Log.info("Could not retrieve cloud information")
+        end
+
+        # 2. Fork and wait
+        # Bit of a hack here just so we can create a new audit section each time a RightScript is run
+        name_and_version = display_version.empty? ?
+          "'#{nickname}'" :
+          "'#{nickname}' #{display_version}"
+
+        Chef::Log.logger.create_new_section("RightScript: #{name_and_version}")
+
+        status = run_script_file(@new_resource.source_file)
+        duration = Time.now - run_started_at
+        # Security paranoia: wipe inputs from env so next script can't see them
+        @new_resource.parameters.each { |key, _| ENV[key] = nil }
+
+        # 3. Handle process exit status
+        if status
+          ::Chef::Log.info("Script exit status: #{status.exitstatus}")
+        else
+          ::Chef::Log.info("Script exit status: UNKNOWN; presumed success")
+        end
+        ::Chef::Log.info("Script duration: #{duration}")
+
+        if !status || status.success?
+          current_state[:chef_state].record_script_execution(nickname)
+          @new_resource.updated_by_last_action(true)
+
+          # a script may have requested reboot via rs_shutdown command line
+          # tool. if the script requested immediate shutdown then we must call
+          # exit here to interrupt the Chef converge (assuming any subsequent
+          # boot recipes are pending). otherwise, defer shutdown until scripts/
+          # recipes finish or another script escalates to an immediate shutdown.
+          exit 0 if RightScale::ShutdownRequestProxy.instance.immediately?
+        else
+          raise RightScale::Exceptions::Exec,
+                "RightScript < #{name_and_version} > #{RightScale::SubprocessFormatting.reason(status)}"
+        end
+
+        true
+      end
+
+      protected
+
+      # Provides a view of the current state objects (instance, chef, ...)
+      #
+      # == Returns
+      # result(Hash):: States:
+      #    :cook_state(RightScale::CookState):: current cook state
+      #    :chef_state(RightScale::ChefState):: current chef state
+      def all_state
+        result = {:cook_state => RightScale::CookState, :chef_state => RightScale::ChefState}
+      end
+
+      # Runs the given RightScript.
+      #
+      # === Parameters
+      # script_file_path(String):: script file path
+      #
+      # == Returns
+      # result(Status):: result of running script
+      def run_script_file(script_file_path)
+        platform = RightScale::Platform
+        shell    = platform.shell
+        command  = shell.format_shell_command(script_file_path)
+
+        return exec_right_popen(command)
+      end
+
+    end
+
+  end
+
+end
+
+# self-register
+Chef::Platform.platforms[:default].merge!(:right_script => Chef::Provider::RightScript)