omnibus-ctl 0.3.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc652bff024b528dbb20225d090ee3b6d89cac3e
-  data.tar.gz: 591824a229726e433072259539bd8d059fb167a3
+  metadata.gz: ba3442fde147f0b637bb2ce3dfe8f61952c00c5d
+  data.tar.gz: 69b92b796d3f0afbbfe13bc429fcc09cb8ad8043
 SHA512:
-  metadata.gz: 8b3890b07473e49d84fc0e44990665c309873529f2ca5feccef948687d44045b930eb6842649c342c67c98d2cb84b96165bea57474867b2c18345e910382f3b2
-  data.tar.gz: 3f875478e87ddf9c6184f84e0bf331753018d8af638f9a141bcc6d3dd55fb43901cadbe290981558e596f0f9011c0d7d75e653c6721ca32805a782ef54b7b3f9
+  metadata.gz: 5d184d6b71831ed278e907ee83d3b73d26876dbcd4d1aae0a0ed5ac6b7e8990629e6a362b31132776878f6cf3ac0964e093c72bc098c385b9a746f100c1c2f34
+  data.tar.gz: e2b700aa51a77c273846a1669ebbbda5c9a5c7bb520e277c1199dbabe66edbe248094b6614bac68a5679d5738e293feb26ea4f1265541b860d1bc782c84d8e46

data/README.md

@@ -1,32 +1,32 @@
-## omnibus-ctl
+# omnibus-ctl
 
 [![Build Status Master](https://travis-ci.org/chef/omnibus-ctl.svg?branch=master)](https://travis-ci.org/chef/omnibus-ctl)
 
 omnibus-ctl provides service control and configuration for omnibus packages.
 
-Not much to see here yet.
+For an introduction, please see this blog post [Omnibus-ctl: What is it and what can it do for you?](https://www.chef.io/blog/2015/05/26/omnibus-ctl-what-is-it-and-what-can-it-do-for-you/).
 
-### Run the Tests!
+## Run the Tests!
 
 There are tests in this repo that should be run before merging to master in the `spec` directory.
 
 To run them, first install rspec via bundler:
 
 ```
-bundle install --binstubs
+bundle install
 ```
 
 Then run the tests:
 
 ```
-./bin/rspec spec/
+bin/rspec
 ```
 
-### Framework API
+## Framework API
 
 There are two main functions you will use in your `*-ctl` project to add commands.
 
-#### add_command_under_category(string, string, string, int, ruby_block)
+### add_command_under_category(string, string, string, int, ruby_block)
 
 This method will add a new command to your ctl under a category, useful for grouping similar commands together logically in help output.
 
@@ -38,13 +38,13 @@ Input arguments:
 4. Arity. TODO: Due to current bug, this must be 2, I believe. We should fix this.
 5. Ruby block. Ruby code to be executed when your command is run (arguments to that command will be passed into the block).
 
-#### add_command(string, string, int, ruby_block)
+### add_command(string, string, int, ruby_block)
 
 This method will add a new command to your ctl without a category. It will be displayed above all categories when the help command is called.
 
 Input arguments are the same as `add_command_under_category` except 2 doesn't exist.
 
-#### Sample Output
+### Sample Output
 
 ```
 # sample-ctl help
@@ -67,11 +67,24 @@ Another Category:
 
 If you only use `add_command_under_category` to add your custom commands, everything will be outputted under a category.
 
-### Licensing
+## Releasing
+
+*NOTE: Versions prior to 0.3.6 do not use a "v" prefix for their tags. Current
+versions do.*
+
+* Update the version in lib/omnibus-ctl/version.rb.
+* Update the [Change log](CHANGELOG.md).
+* Commit those changes.
+* Make sure you are an owner of the
+  [omnibus-ctl gem on RubyGems.org](https://rubygems.org/gems/omnibus-ctl). If
+  you aren't, contact one of the owners to be added.
+* `rake release`. This will tag the version, push it to GitHub and RubyGems.
+
+## License
 
 See the LICENSE file for details.
 
-Copyright: Copyright (c) 2012 Opscode, Inc.
+Copyright: Copyright (c) 2012-2015 Chef Software, Inc.
 License: Apache License, Version 2.0
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/lib/omnibus-ctl/version.rb

@@ -1,5 +1,5 @@
 module Omnibus
   class Ctl
-    VERSION = "0.3.6"
+    VERSION = "0.5.0"
   end
 end

data/lib/omnibus-ctl.rb

@@ -1,5 +1,4 @@
-#
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+#  Copyright (c) 2012-2015 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,6 +18,10 @@ require "omnibus-ctl/version"
 require 'json'
 require 'fileutils'
 
+# For license checks
+require 'io/console'
+require 'io/wait'
+
 module Omnibus
   class Ctl
 
@@ -26,16 +29,19 @@ module Omnibus
 
     SV_COMMAND_NAMES = %w[status up down once pause cont hup alarm interrupt quit
                       term kill start stop restart shutdown force-stop
-                      force-reload force-restart force-shutdown check]
+                      force-reload force-restart force-shutdown check usr1 usr2]
 
     attr_accessor :name, :display_name, :log_exclude, :base_path, :sv_path,
     :service_path, :etc_path, :data_path, :log_path, :command_map, :category_command_map,
     :fh_output, :kill_users, :verbose, :log_path_exclude
 
-    def initialize(name, service_commands=true)
+    attr_reader :backup_dir, :exe_name
+
+
+    def initialize(name, merge_service_commands=true, disp_name = nil)
       @name = name
-      @service_commands = service_commands
-      @display_name = name
+      @service_commands = merge_service_commands
+      @display_name = disp_name || name
       @base_path = "/opt/#{name}"
       @sv_path = File.join(@base_path, "sv")
       @service_path = File.join(@base_path, "service")
@@ -47,6 +53,10 @@ module Omnibus
       @fh_output = STDOUT
       @kill_users = []
       @verbose = false
+      @quiet = false
+      @exe_name = File.basename($0)
+      @force_exit = false
+
       # backwards compat command map that does not have categories
       @command_map = { }
 
@@ -59,7 +69,7 @@ module Omnibus
           },
           "reconfigure" => {
             :desc => "Reconfigure the application.",
-            :arity => 1
+            :arity => 2
           },
           "cleanse" => {
             :desc => "Delete *all* #{display_name} data, and start from scratch.",
@@ -124,19 +134,31 @@ module Omnibus
           "graceful-kill" => {
             :desc => "Attempt a graceful stop, then SIGKILL the entire process group.",
             :arity => 2
+          },
+          "usr1" => {
+            :desc => "Send the services a USR1.",
+            :arity => 2
+          },
+          "usr2" => {
+            :desc => "Send the services a USR2.",
+            :arity => 2
           }
         }
       }
       @category_command_map.merge!(service_command_map) if service_commands?
     end
 
+    def self.to_method_name(name)
+      name.gsub(/-/, '_').to_sym
+    end
+    def to_method_name(name)
+      Ctl.to_method_name(name)
+    end
+
     SV_COMMAND_NAMES.each do |sv_cmd|
-      method_name = sv_cmd.gsub(/-/, "_")
-      Omnibus::Ctl.class_eval <<-EOH
-      def #{method_name}(*args)
+      define_method to_method_name(sv_cmd) do |*args|
         run_sv_command(*args)
       end
-      EOH
     end
 
     # merges category_command_map and command_map,
@@ -160,15 +182,15 @@ module Omnibus
     end
 
     def load_file(filepath)
-      eval(IO.read(filepath))
+      eval(IO.read(filepath), nil, filepath, 1)
     end
 
     def add_command(name, description, arity=1, &block)
       @command_map[name] = { :desc => description, :arity => arity }
       metaclass = class << self; self; end
       # Ruby does not like dashes in method names
-      method_name = name.gsub(/-/, "_")
-      metaclass.send(:define_method, method_name.to_sym) { |*args| block.call(*args) }
+      method_name = to_method_name(name).to_sym
+      metaclass.send(:define_method, method_name) { |*args| block.call(*args) }
     end
 
     def add_command_under_category(name, category, description, arity=1, &block)
@@ -176,13 +198,13 @@ module Omnibus
       @category_command_map[category] = {} unless @category_command_map.has_key?(category)
       @category_command_map[category][name] = { :desc => description, :arity => arity }
       metaclass = class << self; self; end
-      # Ruby does not like dashes in method names
-      method_name = name.gsub(/-/, "_")
-      metaclass.send(:define_method, method_name.to_sym) { |*args| block.call(*args) }
+      method_name = to_method_name(name).to_sym
+      metaclass.send(:define_method, method_name) { |*args| block.call(*args) }
     end
 
-    def exit!(error_code)
-      exit error_code
+    def exit!(code)
+      @force_exit = true
+      code
     end
 
     def log(msg)
@@ -218,27 +240,22 @@ module Omnibus
       exit! 0
     end
 
-    def cleanup_procs_and_nuke(filestr)
-      begin
-        run_sv_command("stop")
-      rescue SystemExit
-      end
+    def cleanup_procs_and_nuke(filestr, calling_method = nil)
+      run_sv_command("stop")
 
       FileUtils.rm_f("/etc/init/#{name}-runsvdir.conf") if File.exists?("/etc/init/#{name}-runsvdir.conf")
       run_command("egrep -v '#{base_path}/embedded/bin/runsvdir-start' /etc/inittab > /etc/inittab.new && mv /etc/inittab.new /etc/inittab") if File.exists?("/etc/inittab")
       run_command("kill -1 1")
 
-      backup_dir = Time.now.strftime("/root/#{name}-cleanse-%FT%R")
+      @backup_dir = Time.now.strftime("/root/#{name}-cleanse-%FT%R")
+
       FileUtils.mkdir_p("/root") unless File.exists?("/root")
       FileUtils.rm_rf(backup_dir)
       FileUtils.cp_r(etc_path, backup_dir) if File.exists?(etc_path)
       run_command("rm -rf #{filestr}")
+      graceful_kill
 
-      begin
-        graceful_kill
-      rescue SystemExit
-      end
-
+      log "Terminating processes running under application users. This will take a few seconds."
       run_command("pkill -HUP -u #{kill_users.join(',')}") if kill_users.length > 0
       run_command("pkill -HUP -f 'runsvdir -P #{service_path}'")
       sleep 3
@@ -251,7 +268,6 @@ module Omnibus
       get_all_services.each do |die_daemon_die|
         run_command("pkill -KILL -f 'runsv #{die_daemon_die}'")
       end
-
       log "Your config files have been backed up to #{backup_dir}."
       exit! 0
     end
@@ -260,14 +276,55 @@ module Omnibus
       cleanup_procs_and_nuke("/tmp/opt")
     end
 
-    def cleanse(*args)
-      log "This will delete *all* configuration, log, and variable data associated with this application.\n\n*** You have 60 seconds to hit CTRL-C ***\n\n"
-      unless args[1] == "yes"
-        sleep 60
+    def scary_cleanse_warning(*args)
+      just_do_it = args.include?("yes")
+      with_external = ARGV.include?("--with-external")
+      log <<EOM
+    *******************************************************************
+    * * * * * * * * * * *       STOP AND READ       * * * * * * * * * *
+    *******************************************************************
+    This command will delete *all* local configuration, log, and
+    variable data associated with #{display_name}.
+EOM
+      if (with_external)
+        log <<EOM
+    This will also delete externally hosted #{display_name} data.
+    This means that any service you have configured as 'external'
+    will have any #{display_name} permanently deleted.
+EOM
+      elsif (not external_services.empty?)
+        log <<EOM
+
+    Important note: If you also wish to delete externally hosted #{display_name}
+    data, please hit CTRL+C now and run '#{exe_name} cleanse --with-external'
+EOM
+      end
+
+      unless just_do_it
+        data = with_external ? "local, and remote data" : "and local data"
+        log <<EOM
+
+    You have 60 seconds to hit CTRL-C before configuration,
+    logs, #{data} for this application are permanently
+    deleted.
+    *******************************************************************
+
+EOM
+        begin
+          sleep 60
+        rescue Interrupt
+          log ""
+          exit 0
+        end
       end
-      cleanup_procs_and_nuke("#{service_path}/* /tmp/opt #{data_path} #{etc_path} #{log_path}")
     end
 
+    def cleanse(*args)
+      scary_cleanse_warning(*args)
+      cleanup_procs_and_nuke("#{service_path}/* /tmp/opt #{data_path} #{etc_path} #{log_path}", "cleanse")
+    end
+
+
     def get_all_services_files
       Dir[File.join(sv_path, '*')]
     end
@@ -282,6 +339,8 @@ module Omnibus
 
     def run_sv_command(sv_cmd, service=nil)
       exit_status = 0
+      sv_cmd = "1" if sv_cmd == "usr1"
+      sv_cmd = "2" if sv_cmd == "usr2"
       if service
         exit_status += run_sv_command_for_service(sv_cmd, service)
       else
@@ -296,10 +355,10 @@ module Omnibus
     def run_sv_command_for_service(sv_cmd, service_name)
       if service_enabled?(service_name)
         status = run_command("#{base_path}/init/#{service_name} #{sv_cmd}")
-        return status.exitstatus
+        status.exitstatus
       else
         log "#{service_name} disabled" if sv_cmd == "status" && verbose
-        return 0
+        0
       end
     end
 
@@ -341,12 +400,7 @@ module Omnibus
       # not exist), we know that this will be a new server, and we don't
       # have to worry about pre-upgrade services hanging around. We can safely
       # return an empty array when running_config is nil
-      if (cfg = running_config)
-        key = package_name.gsub(/-/, '_')
-        cfg[key]["removed_services"] || []
-      else
-        []
-      end
+      running_package_config["removed_services"] || []
     end
 
     # hidden services are configured via the attributes file in
@@ -359,12 +413,7 @@ module Omnibus
       # not exist), we don't want to return nil, just return an empty array.
       # worse result with doing that is services that we don't want to show up in
       # c-s-c status will show up.
-      if (cfg = running_config)
-        key = package_name.gsub(/-/, '_')
-        cfg[key]["hidden_services"] || []
-      else
-        []
-      end
+      running_package_config["hidden_services"] || []
     end
 
     # translate the name from the config to the package name.
@@ -389,41 +438,134 @@ module Omnibus
       end
     end
 
+    # Helper function that returns the hash of config hashes that have the key 'external' : true
+    # in the running config. If none exist it will return an empty hash.
+    def external_services
+      @external_services  ||= running_package_config.select { |k, v| v.class == Hash and v["external"] == true }
+    end
+
+    # Helper function that returns true if an external service entry exists for
+    # the named service
+    def service_external?(service)
+      return false if service.nil?
+      return external_services.has_key? service
+    end
+
+    # Gives package config from the running_config.
+    # If there is no running config or if package_name doens't
+    # reference a valid key, this will return an empty hash
+    def running_package_config
+      if (cfg = running_config)
+        cfg[package_name.gsub(/-/, '_')] || {}
+      else
+        {}
+      end
+    end
+
+    # This returns running_config[package][service].
+    #
+    # If there is no running_config or is no matching key
+    # it will return nil.
+    def running_service_config(service)
+      running_package_config[service]
+    end
+
     def remove_old_node_state
       node_cache_path = "#{base_path}/embedded/nodes/"
       status = run_command("rm -rf #{node_cache_path}")
-      if ! status.success?
+      if !status.success?
         log "Could not remove cached node state!"
-        exit! 1
+        exit 1
       end
     end
 
     def run_chef(attr_location, args='')
+      if @verbose
+        log_level = "-L debug"
+      elsif @quiet
+        # null formatter is awfully quiet, so let them know we're doing something.
+        log "Reconfiguring #{display_name}."
+        log_level = "-L fatal -F null"
+      else
+        log_level = ""
+      end
       remove_old_node_state
-      cmd = "#{base_path}/embedded/bin/chef-client -z -c #{base_path}/embedded/cookbooks/solo.rb -j #{attr_location}"
+      cmd = "#{base_path}/embedded/bin/chef-client #{log_level} -z -c #{base_path}/embedded/cookbooks/solo.rb -j #{attr_location}"
       cmd += " #{args}" unless args.empty?
       run_command(cmd)
     end
 
     def show_config(*args)
-      status = run_chef("#{base_path}/embedded/cookbooks/show-config.json", "-l fatal")
-      if status.success?
-        exit! 0
-      else
-        exit! 1
-      end
+      status = run_chef("#{base_path}/embedded/cookbooks/show-config.json", "-l fatal -F null")
+      exit! status.success? ? 0 : 1
     end
 
-    def reconfigure(exit_on_success=true)
+    def reconfigure(*args)
+      # args being passed to this command does not include the ones that are
+      # starting with "-". See #is_option? method. If it is starting with "-"
+      # then it is treated as a option and we need to look for them in ARGV.
+      check_license_acceptance(ARGV.include?("--accept-license"))
+
       status = run_chef("#{base_path}/embedded/cookbooks/dna.json")
       if status.success?
         log "#{display_name} Reconfigured!"
-        exit! 0 if exit_on_success
+        exit! 0
       else
         exit! 1
       end
     end
 
+    def check_license_acceptance(override_accept = false)
+      license_guard_file_path = File.join(data_path, ".license.accepted")
+
+      # If the project does not have a license we do not have
+      # any license to accept.
+      return unless File.exist?(project_license_path)
+
+      if !File.exist?(license_guard_file_path)
+        if override_accept || ask_license_acceptance
+          FileUtils.mkdir_p(data_path)
+          FileUtils.touch(license_guard_file_path)
+        else
+          log "Please accept the software license agreement to continue."
+          exit(1)
+        end
+      end
+    end
+
+    def ask_license_acceptance
+      log "To use this software, you must agree to the terms of the software license agreement."
+
+      if !STDIN.tty?
+        log "Please view and accept the software license agreement, or pass --accept-license."
+        exit(1)
+      end
+
+      log "Press any key to continue."
+      user_input = STDIN.getch
+      user_input << STDIN.getch while STDIN.ready?
+      # No need to check for user input
+
+      system("less #{project_license_path}")
+
+      loop do
+        log "Type 'yes' to accept the software license agreement, or anything else to cancel."
+
+        user_input = STDIN.gets.chomp.downcase
+        case user_input
+        when "yes"
+          return true
+        else
+          log "You have not accepted the software license agreement."
+          return false
+        end
+      end
+    end
+
+    def project_license_path
+      File.join(base_path, "LICENSE")
+    end
+
     def tail(*args)
       # find /var/log -type f -not -path '*/sasl/*' | grep -E -v '(lock|@|tgz|gzip)' | xargs tail --follow=name --retry
       command = "find #{log_path}"
@@ -468,14 +610,14 @@ module Omnibus
           end
         else
           log "#{service_name} disabled, not stopping"
-          exit_status = 1
+          exit_status =1
         end
       end
       exit! exit_status
     end
 
     def help(*args)
-      log "#{$0}: command (subcommand)\n"
+      log "#{exe_name}: command (subcommand)\n"
       command_map.keys.sort.each do |command|
         log command
         log "  #{command_map[command][:desc]}"
@@ -491,16 +633,22 @@ module Omnibus
           log "    #{commands[command][:desc]}"
         end
       end
-      exit! 1
+      # Help is not an error so exit with 0.  In cases where we display help as a result of an error
+      # the framework will handle setting proper exit code.
+      exit! 0
     end
 
-    # Set options. Silently ignore bad options.
-    # This allows the test subcommand to pass on pedant options
-    def parse_options!(args)
-      args.each do |option|
+    # Set global options and remove them from the args list we pass
+    # into commands.
+    def parse_options(args)
+      args.select do |option|
         case option
+        when "--quiet", "-q"
+          @quiet = true
+          false
         when "--verbose", "-v"
           @verbose = true
+          false
         end
       end
     end
@@ -526,6 +674,10 @@ module Omnibus
       end
     end
 
+    # Previously this would exit immediately with the provided
+    # exit code; however this would prevent post-run hooks from continuing
+    # Instead, we'll just track whether a an exit was requested and use that
+    # to determine how we exit from 'run'
     def run(args)
       # Ensure Omnibus related binaries are in the PATH
       ENV["PATH"] = [File.join(base_path, "bin"),
@@ -549,31 +701,191 @@ module Omnibus
         service = args[1]
       end
 
-      # returns either hash content of comamnd or nil
+      # returns either hash content of command or nil
       command = retrieve_command(command_to_run)
-
       if command.nil?
         log "I don't know that command."
         if args.length == 2
-          log "Did you mean: #{$0} #{service} #{command_to_run}?"
+          log "Did you mean: #{exe_name} #{service} #{command_to_run}?"
         end
         help
+        Kernel.exit 1
       end
 
       if args.length > 1 && command[:arity] != 2
         log "The command #{command_to_run} does not accept any arguments"
-        exit! 2
+        Kernel.exit 2
       end
 
-      parse_options! options
+      parse_options options
+      @force_exit = false
+      exit_code = 0
 
-      method_to_call = command_to_run.gsub(/-/, '_')
       # Filter args to just command and service. If you are loading
       # custom commands and need access to the command line argument,
       # use ARGV directly.
       actual_args = [command_to_run, service].reject(&:nil?)
-      self.send(method_to_call.to_sym, *actual_args)
+      if command_pre_hook(*actual_args)
+        method_to_call = to_method_name(command_to_run)
+        begin
+          ret = send(method_to_call, *actual_args)
+        rescue SystemExit => e
+          @force_exit = true
+          ret = e.status
+        end
+        command_post_hook(*actual_args)
+        exit_code = ret unless ret.nil?
+      else
+        exit_code = 8
+        @force_exit = true
+      end
+
+      if @force_exit
+        Kernel.exit exit_code
+      else
+        exit_code
+      end
+    end
+
+    # Below are some basic command hooks that do the right  thing
+    # when a service is configured as external via [package][service
+
+    # If a command has a pre-hook defined we will run it.
+    # Otherwise, if it is a run-sv command and the service it refers to
+    # is an external service, we will show an error since we
+    # can't control external services from here.
+    #
+    # If any pre-hook returns false, it will prevent execution of the command
+    # and exit the command with exit code 8.
+    def command_pre_hook(*args)
+      command = args.shift
+      method = to_method_name("#{command}_pre_hook")
+      if respond_to?(method)
+        send(method, *args)
+      else
+        return true if args.empty?
+        if SV_COMMAND_NAMES.include? command
+          if service_external? args[0]
+            log error_external_service(command, args[0])
+            return false;
+          end
+        end
+        true
+      end
     end
 
+    # Executes after successful completion of a command
+    # If a post-hook provides a numeric return code, it will
+    # replace the return/exit of the original command
+    def command_post_hook(*args)
+      command = args.shift
+      method = to_method_name("#{command}_post_hook")
+      if respond_to?(method)
+        send(method, *args)
+      end
+    end
+
+    # If we're listing status for all services and have external
+    # services to show, we'll include an output header to show that
+    # we're reporting internal services
+    def status_pre_hook(service = nil)
+      log_internal_service_header if service.nil?
+      true
+    end
+    # Status gets its own hook because each externalized service will
+    # have its own things to do in order to report status.
+    # As above, we may also include an output header to show that we're
+    # reporting on external services.
+    #
+    # Your callback for this function should be in the form
+    # 'external_status_#{service_name}(detail_level)
+    # where detail_level is :sparse|:verbose
+    # :sparse is used when it's a summary service status list, eg
+    # "$appname-ctl status"
+    # :verbose is used when the specific service has been named, eg
+    # "$appname-ctl status postgresql"
+    def status_post_hook(service = nil)
+      if service.nil?
+        log_external_service_header
+        external_services.each_key do |service_name|
+          status = send(to_method_name("external_status_#{service_name}"), :sparse)
+          log status
+        end
+      else
+        # Request verbose status if the service is asked for by name.
+        if service_external?(service)
+          status = send(to_method_name("external_status_#{service}"), :verbose)
+          log status
+        end
+      end
+    end
+
+    # Data cleanup requirements for external services aren't met by the standard
+    # 'nuke /var/opt' behavior - this hook allows each service to perform its own
+    # 'cleanse' operations.
+    #
+    # Your callback for this function should be in the
+    # form 'external_cleanup_#{service_name}(do_clean)
+    # where do_cliean is true if the delete should actually be
+    # performed, and false if it's expected to inform the user how to
+    # perform the data cleanup without doing any cleanup itself.
+    def cleanse_post_hook(*args)
+      external_services.each_key do |service_name|
+        perform_delete = ARGV.include?("--with-external")
+        if perform_delete
+          log "Deleting data from external service: #{service_name}"
+        end
+        send(to_method_name("external_cleanse_#{service_name}"), perform_delete)
+      end
+    end
+
+    # Add some output headers if we have external services enabled
+    def service_list_pre_hook
+      log_internal_service_header
+      return true
+    end
+
+    # Capture external services in the output list as well.
+    def service_list_post_hook
+      log_external_service_header
+      external_services.each  do |name, settings|
+        log " >  #{name} on #{settings['vip']}"
+      end
+    end
+
+    def error_external_service(command, service)
+  <<EOM
+-------------------------------------------------------------------
+The service #{service} is running externally and cannot be managed
+vi chef-server-ctl.  Please log into #{external_services[service]['vip'] }
+to manage it directly.
+-------------------------------------------------------------------
+EOM
+    end
+
+    def format_multiline_message(indent, message)
+      if message.class == String
+        message = message.split("\n")
+      end
+      spaces = " "*indent
+      message.map!{|line| "#{spaces}#{line.strip}"}
+      message.join("\n")
+    end
+
+    def log_internal_service_header
+      # Don't decorate output unless we have
+      # external services to report on.
+      return if external_services.empty?
+      log "-------------------"
+      log " Internal Services "
+      log "-------------------"
+    end
+
+    def log_external_service_header
+      return if external_services.empty?
+      log "-------------------"
+      log " External Services "
+      log "-------------------"
+    end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: omnibus-ctl
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Opscode, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -41,7 +55,7 @@ dependencies:
 description: Provides command line control for omnibus pakcages, rarely used as a
   gem
 email:
-- legal@opscode.com
+- legal@chef.io
 executables:
 - omnibus-ctl
 extensions: []
@@ -51,7 +65,7 @@ files:
 - bin/omnibus-ctl
 - lib/omnibus-ctl.rb
 - lib/omnibus-ctl/version.rb
-homepage: http://github.com/opscode/omnibus-ctl
+homepage: http://github.com/chef/omnibus-ctl
 licenses: []
 metadata: {}
 post_install_message: 
@@ -70,9 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Provides command line control for omnibus packages
 test_files: []
-has_rdoc: