knife-rhn 0.1.0 → 0.2.0

data/README.md

@@ -1,13 +1,14 @@
 # Knife RHN
 
-A knife plugin for managing RHN.
+A knife plugin for managing Red Hat Network.
 
 ## Installation
 
-Uses `rhn_satellite` rubygem.
+Uses [rhn_satellite rubygem](https://github.com/duritong/ruby-rhn_satellite) for the backend.
 
-* `gem install knife-rhn` (once a gem is cut)
-* or... clone repo to ~/.chef/plugins/knife or path/to/cheforg/.chef/plugins/knife
+* `gem install knife-rhn` (if using omnibus install, `/opt/chef/embedded/bin/gem install knife-rhn`)
+* or... copy `lib/chef/knife/*` files to `~/.chef/plugins/knife`
+* or... copy `lib/chef/knife/*` files to `path/to/cheforg/.chef/plugins/knife`
 
 ## Usage
 
@@ -35,6 +36,30 @@ Deletes the system profile for SYSTEM.
 
 Displays system details for SYSTEM.
 
+Example output:
+
+    ID: 1000023160
+    Profile Name: bflad-test2
+    Hostname: bflad-test2
+    Release: 6Server
+    Auto Update: Disabled
+    Locked: Disabled
+    RHN URL: https://example.com/rhn/systems/details/Overview.do?sid=1000023160
+    Description:
+    Initial Registration Parameters:
+    OS: redhat-release-server
+    Release: 6Server
+    CPU Arch: x86_64
+    Subscribed Channels:
+    Red Hat Enterprise Linux Server (v. 6 for 64-bit x86_64)
+     |_ Shibboleth RHEL 6 x86_64
+     |_ RHEL Server Optional (v. 6 64-bit x86_64)
+     |_ RHEL Server Supplementary (v. 6 64-bit x86_64)
+     |_ EPEL 6 Server x86_64
+    Critical Errata: 1
+    Non-Critical Errata: 2
+    Upgradable Packages: 4
+
 ### `knife rhn system move SYSTEM GROUP`
 
 * Removes system SYSTEM from all current systemgroups.
@@ -44,9 +69,20 @@ Displays system details for SYSTEM.
 
 Displays systemgroups for SYSTEM.
 
+Example output:
+
+    Core Systems
+    Research Computing
+
 ### `knife rhn systemgroup active GROUP`
 
-Lists active systems in system group GROUP.
+Lists active systems (systems that have checked into RHN in the last 24 hours) in systemgroup GROUP.
+
+Example output:
+
+    1000010619,server1.example.com
+    1000018560,server2.example.com
+    1000010446,server3.example.com
 
 ### `knife rhn systemgroup add GROUP SYSTEM`
 
@@ -62,18 +98,34 @@ Deletes systemgroup GROUP.
 
 ### `knife rhn systemgroup inactive GROUP`
 
-Lists inactive systems in system group GROUP.
+Lists inactive systems (systems that have not checked into RHN in 24 hours) in systemgroup GROUP.
+
+* `--days DAYS` - optionally set number of inactive days
+
+Example output:
 
-* `--days` - Number of inactive days
+    1000010004,server4.example.com
+    1000017215,server5.example.com
 
 ### `knife rhn systemgroup list`
 
 Lists all systemgroups.
 
+Example output:
+
+    Accounting
+    Core Systems
+    Research Computing
+
 ### `knife rhn systemgroup outdated GROUP`
 
 Lists outdated systems in system group GROUP.
 
+Example output:
+
+    1000018560,server2.example.com
+    1000017215,server5.example.com
+
 ### `knife rhn systemgroup remove GROUP SYSTEM`
 
 Removes system SYSTEM from systemgroup GROUP.
@@ -82,15 +134,23 @@ Removes system SYSTEM from systemgroup GROUP.
 
 Lists all systems in system group GROUP.
 
+Example output:
+
+    1000010619,server1.example.com
+    1000018560,server2.example.com
+    1000010446,server3.example.com
+    1000010004,server4.example.com
+    1000017215,server5.example.com
+
 ## Contributing
 
 Please use standard Github issues and pull requests.
 
 ## License and Author
-      
+
 Author:: Brian Flad (<bflad@wharton.upenn.edu>)
 
-Copyright:: 2012
+Copyright:: 2012-2013
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/chef/knife/rhn_base.rb

@@ -0,0 +1,98 @@
+#
+# Author:: Brian Flad (<bflad417@gmail.com>)
+# License:: Apache License, Version 2.0
+#
+
+require 'chef/knife'
+require 'rhn_satellite'
+
+class Chef
+  class Knife
+    module RhnBase
+
+      def self.included(includer)
+        includer.class_eval do
+
+          deps do
+            require 'readline'
+            require 'chef/json_compat'
+          end
+
+          unless defined? $default
+            $default = Hash.new
+          end
+
+          option :rhn_debug,
+            :long => "--rhn-debug",
+            :description => "Enable debugging for RHN connection",
+            :boolean => false
+
+          option :rhn_hostname,
+            :short => "-h HOSTNAME",
+            :long => "--rhn-hostname HOSTNAME",
+            :description => "The hostname for RHN"
+
+          option :rhn_no_https,
+            :long => "--rhn-no-https",
+            :description => "Disable HTTPS for RHN connection",
+            :boolean => false
+
+          option :rhn_password,
+            :short => "-p PASSWORD",
+            :long => "--rhn-password PASSWORD",
+            :description => "The password for RHN"
+
+          option :rhn_timeout,
+            :long => "--rhn-timeout SECONDS",
+            :description => "The timeout in seconds for RHN"
+          $default[:rhn_timeout] = 30
+
+          option :rhn_username,
+            :short => "-u USERNAME",
+            :long => "--rhn-username USERNAME",
+            :description => "The username for RHN"
+        end
+      end
+
+      def get_config(key)
+        key = key.to_sym
+        rval = config[key] || Chef::Config[:knife][key] || $default[key]
+        Chef::Log.debug("value for config item #{key}: #{rval}")
+        rval
+      end
+
+      def get_satellite_system(system)
+        satellite_system = RhnSatellite::System.get(system)
+
+        if satellite_system.nil?
+          ui.fatal "Could not find system in RHN!"
+          exit 1
+        end
+
+        satellite_system
+      end
+
+      def set_rhn_connection_options
+        RhnSatellite::Connection::Handler.debug_enabled = true if get_config(:rhn_debug)
+        RhnSatellite::Connection::Handler.default_hostname = get_config(:rhn_hostname)
+        RhnSatellite::Connection::Handler.default_https = false if get_config(:rhn_no_https)
+        # See: https://github.com/duritong/ruby-rhn_satellite/issues/3
+        RhnSatellite::ActivationKey.https = false if get_config(:rhn_no_https)
+        RhnSatellite::Api.https = false if get_config(:rhn_no_https)
+        RhnSatellite::Channel.https = false if get_config(:rhn_no_https)
+        RhnSatellite::ChannelAccess.https = false if get_config(:rhn_no_https)
+        RhnSatellite::ChannelSoftware.https = false if get_config(:rhn_no_https)
+        RhnSatellite::Packages.https = false if get_config(:rhn_no_https)
+        RhnSatellite::System.https = false if get_config(:rhn_no_https)
+        RhnSatellite::Systemgroup.https = false if get_config(:rhn_no_https)
+        # End of issue 3 workaround
+        RhnSatellite::Connection::Handler.default_timeout = get_config(:rhn_timeout)
+        RhnSatellite::Connection::Handler.default_username = get_config(:rhn_username)
+        password = get_config(:rhn_password)
+        password ||= ask("RHN Password for #{get_config(:rhn_username)}: ") { |q| q.echo = "*" }
+        RhnSatellite::Connection::Handler.default_password = password
+      end
+
+    end
+  end
+end

data/lib/chef/knife/rhn_system_delete.rb

@@ -3,42 +3,44 @@
 # License:: Apache License, Version 2.0
 #
 
-module RhnKnifePlugin
+require 'chef/knife/rhn_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class RhnSystemDelete < Knife
 
-  # Until merged: https://github.com/duritong/ruby-rhn_satellite/pull/5
-  module System
-    def delete(system_id)
-      base.default_call('system.deleteSystems',[system_id.to_i])
-    end
-  end
+      include Knife::RhnBase
 
-  class RhnSystemDelete < BaseRhnCommand
+      banner "knife rhn system delete SYSTEM (options)"
+      category "rhn"
 
-    banner "knife rhn system delete SYSTEM (options)"
-    category "rhn"
+      # Until released: https://github.com/duritong/ruby-rhn_satellite/pull/5
+      module System
+        def delete(system_id)
+          base.default_call('system.deleteSystems',[system_id.to_i])
+        end
+      end
 
-    get_common_options
+      def run
+        $stdout.sync = true
+        
+        system = name_args.first
 
-    def run
-      
-      system = name_args.first
+        if system.nil?
+          ui.fatal "You need a system name!"
+          show_usage
+          exit 1
+        end
 
-      if system.nil?
-        ui.fatal "You need a system name!"
-        show_usage
-        exit 1
-      end
+        set_rhn_connection_options
 
-      set_rhn_connection_options
+        satellite_system = get_satellite_system(system)
 
-      satellite_system = get_satellite_system(system)
+        RhnSatellite::System.extend(System)
+        RhnSatellite::System.delete(satellite_system['id'])
+        ui.info "Deleted RHN System: #{satellite_system['name']} (ID: #{satellite_system['id']})"
+      end
 
-      RhnSatellite::System.extend(System)
-      RhnSatellite::System.delete(satellite_system['id'])
-      ui.info "Deleted RHN System: #{satellite_system['name']} (ID: #{satellite_system['id']})"
     end
-
   end
-end
+end

data/lib/chef/knife/rhn_system_details.rb

@@ -3,58 +3,60 @@
 # License:: Apache License, Version 2.0
 #
 
-module RhnKnifePlugin
-
-  require 'chef/knife'
-
-  class RhnSystemDetails < BaseRhnCommand
-
-    banner "knife rhn system details SYSTEM (options)"
-    category "rhn"
-
-    get_common_options
-
-    def run
-      
-      system = name_args.first
-
-      if system.nil?
-        ui.fatal "You need a system name!"
-        show_usage
-        exit 1
-      end
-
-      set_rhn_connection_options
-
-      satellite_system = get_satellite_system(system)
-
-      details = RhnSatellite::System.details(satellite_system['id'])
-      ui.info "#{ui.color "ID", :cyan}: #{details['id']}"
-      ui.info "#{ui.color "Profile Name", :cyan}: #{details['profile_name']}"
-      ui.info "#{ui.color "Hostname", :cyan}: #{details['hostname']}"
-      ui.info "#{ui.color "Release", :cyan}: #{details['release']}"
-      ui.info "#{ui.color "Auto Update", :cyan}: #{details['auto_update'] ? "Enabled" : "Disabled"}"
-      ui.info "#{ui.color "Locked", :cyan}: #{details['lock_status'] ? "Enabled" : "Disabled"}"
-      ui.info "#{ui.color "RHN URL", :cyan}: https://#{get_config(:rhn_hostname)}/rhn/systems/details/Overview.do?sid=#{details['id']}"
-      ui.info "#{ui.color "Description", :cyan}:"
-      ui.info "#{details['description']}"
-
-      base_channel = RhnSatellite::System.subscribed_base_channel(satellite_system['id'])
-      child_channels = RhnSatellite::System.subscribed_child_channels(satellite_system['id'])
-      ui.info "#{ui.color "Subscribed Channels", :cyan}:"
-      ui.info "#{ui.color base_channel['name'], :bold}"
-      child_channels.each do |child_channel|
-        ui.info " |_ #{child_channel['name']}"
+require 'chef/knife/rhn_base'
+
+class Chef
+  class Knife
+    class RhnSystemDelete < Knife
+
+      include Knife::RhnBase
+
+      banner "knife rhn system details SYSTEM (options)"
+      category "rhn"
+
+      def run
+        $stdout.sync = true
+        
+        system = name_args.first
+
+        if system.nil?
+          ui.fatal "You need a system name!"
+          show_usage
+          exit 1
+        end
+
+        set_rhn_connection_options
+
+        satellite_system = get_satellite_system(system)
+
+        details = RhnSatellite::System.details(satellite_system['id'])
+        ui.info "#{ui.color "ID", :cyan}: #{details['id']}"
+        ui.info "#{ui.color "Profile Name", :cyan}: #{details['profile_name']}"
+        ui.info "#{ui.color "Hostname", :cyan}: #{details['hostname']}"
+        ui.info "#{ui.color "Release", :cyan}: #{details['release']}"
+        ui.info "#{ui.color "Auto Update", :cyan}: #{details['auto_update'] ? "Enabled" : "Disabled"}"
+        ui.info "#{ui.color "Locked", :cyan}: #{details['lock_status'] ? "Enabled" : "Disabled"}"
+        ui.info "#{ui.color "RHN URL", :cyan}: https://#{get_config(:rhn_hostname)}/rhn/systems/details/Overview.do?sid=#{details['id']}"
+        ui.info "#{ui.color "Description", :cyan}:"
+        ui.info "#{details['description']}"
+
+        base_channel = RhnSatellite::System.subscribed_base_channel(satellite_system['id'])
+        child_channels = RhnSatellite::System.subscribed_child_channels(satellite_system['id'])
+        ui.info "#{ui.color "Subscribed Channels", :cyan}:"
+        ui.info "#{ui.color base_channel['name'], :bold}"
+        child_channels.each do |child_channel|
+          ui.info " |_ #{child_channel['name']}"
+        end
+
+        relevant_erratas = RhnSatellite::System.relevant_erratas(satellite_system['id'])
+        critical_errata = relevant_erratas.select{|e| e["advisory_type"] == "Security Advisory"}.length
+        ui.info "#{ui.color "Critical Errata", :cyan}: #{critical_errata}"
+        ui.info "#{ui.color "Non-Critical Errata", :cyan}: #{relevant_erratas.length - critical_errata}"
+
+        upgradable_packages = RhnSatellite::System.latest_upgradable_packages(satellite_system['id'])
+        ui.info "#{ui.color "Upgradable Packages", :cyan}: #{upgradable_packages.length}"
       end
 
-      relevant_erratas = RhnSatellite::System.relevant_erratas(satellite_system['id'])
-      critical_errata = relevant_erratas.select{|e| e["advisory_type"] == "Security Advisory"}.length
-      ui.info "#{ui.color "Critical Errata", :cyan}: #{critical_errata}"
-      ui.info "#{ui.color "Non-Critical Errata", :cyan}: #{relevant_erratas.length - critical_errata}"
-
-      upgradable_packages = RhnSatellite::System.latest_upgradable_packages(satellite_system['id'])
-      ui.info "#{ui.color "Upgradable Packages", :cyan}: #{upgradable_packages.length}"
     end
-
   end
 end

data/lib/chef/knife/rhn_system_move.rb

@@ -3,49 +3,51 @@
 # License:: Apache License, Version 2.0
 #
 
-module RhnKnifePlugin
+require 'chef/knife/rhn_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class RhnSystemMove < Knife
 
-  class RhnSystemMove < BaseRhnCommand
+      include Knife::RhnBase
 
-    banner "knife rhn system move SYSTEM GROUP (options)"
-    category "rhn"
+      banner "knife rhn system move SYSTEM GROUP (options)"
+      category "rhn"
 
-    get_common_options
+      def run
+        $stdout.sync = true
+        
+        system = name_args.first
 
-    def run
-      
-      system = name_args.first
-
-      if system.nil?
-        ui.fatal "You need a system name!"
-        show_usage
-        exit 1
-      end
+        if system.nil?
+          ui.fatal "You need a system name!"
+          show_usage
+          exit 1
+        end
 
-      group = name_args[1]
+        group = name_args[1]
 
-      if group.nil?
-        ui.fatal "You need a systemgroup name!"
-        show_usage
-        exit 1
-      end
+        if group.nil?
+          ui.fatal "You need a systemgroup name!"
+          show_usage
+          exit 1
+        end
 
-      set_rhn_connection_options
+        set_rhn_connection_options
 
-      satellite_system = get_satellite_system(system)
-      system_groups = RhnSatellite::Systemgroup.all
-      system_groups.sort! {|a,b| a['name'] <=> b['name']}
-      system_groups.each do |system_group|
-        if RhnSatellite::Systemgroup.systems(system_group['name']).find{|s| s['id'] == satellite_system['id']}
-          RhnSatellite::Systemgroup.remove_systems(system_group['name'],[satellite_system['id']])
-          ui.info "Removed system #{system} from RHN systemgroup: #{system_group['name']}"
+        satellite_system = get_satellite_system(system)
+        system_groups = RhnSatellite::Systemgroup.all
+        system_groups.sort! {|a,b| a['name'] <=> b['name']}
+        system_groups.each do |system_group|
+          if RhnSatellite::Systemgroup.systems(system_group['name']).find{|s| s['id'] == satellite_system['id']}
+            RhnSatellite::Systemgroup.remove_systems(system_group['name'],[satellite_system['id']])
+            ui.info "Removed system #{system} from RHN systemgroup: #{system_group['name']}"
+          end
         end
+        RhnSatellite::Systemgroup.add_systems(group,[satellite_system['id']])
+        ui.info "Added system #{system} to RHN systemgroup: #{group}"
       end
-      RhnSatellite::Systemgroup.add_systems(group,[satellite_system['id']])
-      ui.info "Added system #{system} to RHN systemgroup: #{group}"
-    end
 
+    end
   end
 end