morpheus-cli 5.4.0 → 5.4.1

data/lib/morpheus/cli/mixins/storage_volumes_helper.rb

@@ -0,0 +1,119 @@
+require 'morpheus/cli/mixins/print_helper'
+require 'morpheus/cli/option_types'
+require 'morpheus/rest_client'
+# Mixin for Morpheus::Cli command classes
+# Provides common methods for storage volume management
+# including storage volumes and storage volume types
+module Morpheus::Cli::StorageVolumesHelper
+
+  def self.included(klass)
+    klass.send :include, Morpheus::Cli::PrintHelper
+  end
+
+  def storage_volumes_interface
+    # @api_client.storage_volumes
+    raise "#{self.class} has not defined @storage_volumes_interface" if @storage_volumes_interface.nil?
+    @storage_volumes_interface
+  end
+
+  def storage_volume_types_interface
+    # @api_client.storage_volume_types
+    raise "#{self.class} has not defined @storage_volume_types_interface" if @storage_volume_types_interface.nil?
+    @storage_volume_types_interface
+  end
+
+  def storage_volume_object_key
+    'storageVolume'
+  end
+
+  def storage_volume_list_key
+    'storageVolumes'
+  end
+
+  def storage_volume_label
+    'Storage Volume'
+  end
+
+  def storage_volume_label_plural
+    'Storage Volume'
+  end
+
+  def storage_volume_type_object_key
+    'storageVolumeType'
+  end
+
+  def storage_volume_type_list_key
+    'storageVolumeTypes'
+  end
+
+  def storage_volume_type_label
+    'Storage Volume Type'
+  end
+
+  def storage_volume_type_label_plural
+    'Storage Volume Types'
+  end
+
+  def get_available_storage_volume_types(refresh=false)
+    if !@available_storage_volume_types || refresh
+      @available_storage_volume_types = storage_volume_types_interface.list({max:1000})[storage_volume_type_list_key]
+    end
+    return @available_storage_volume_types
+  end
+
+  def storage_volume_type_for_name_or_id(val)
+    if val.to_s =~ /\A\d{1,}\Z/
+      return storage_volume_type_for_id(val)
+    else
+      return storage_volume_type_for_name(val)
+    end
+  end
+
+  def storage_volume_type_for_id(val)
+    record = get_available_storage_volume_types().find { |z| z['id'].to_i == val.to_i}
+    label = "Storage Volume Type"
+    if record.nil?
+      print_red_alert "#{label} not found by id #{val}"
+      return nil
+    end
+    return record
+  end
+
+  def storage_volume_type_for_name(val)
+    records = get_available_storage_volume_types().select { |z| z['name'].downcase == val.downcase || z['code'].downcase == val.downcase}
+    label = "Storage Volume Type"
+    if records.empty?
+      print_red_alert "#{label} not found by name '#{val}'"
+      return nil
+    elsif records.size > 1
+      print_red_alert "More than one #{label.downcase} found by name '#{val}'"
+      print_error "\n"
+      puts_error as_pretty_table(records, [:id, :name], {color:red})
+      print_red_alert "Try using ID instead"
+      print_error reset,"\n"
+      return nil
+    else
+      return records[0]
+    end
+  end
+
+  def format_storage_volume_status(record, return_color=cyan)
+    out = ""
+    status_string = record['status']
+    if status_string.nil? || status_string.empty? || status_string == "unknown"
+      out << "#{white}UNKNOWN#{return_color}"
+    elsif status_string == 'provisioned' || status_string == 'unattached'
+      out << "#{cyan}#{status_string.capitalize}#{return_color}"
+    elsif status_string == 'syncing'
+      out << "#{yellow}#{status_string.capitalize}#{return_color}"
+    else
+      out << "#{red}#{status_string ? status_string.capitalize : 'N/A'}#{record['statusMessage'] ? "#{return_color} - #{record['statusMessage']}" : ''}#{return_color}"
+    end
+    out
+  end
+
+  def format_storage_volume_source(storage_volume)
+    storage_volume['source']
+  end
+
+end

data/lib/morpheus/cli/option_types.rb

@@ -128,7 +128,11 @@ module Morpheus
                             get_object_value(options, depends_on_field_key) ||
                             get_object_value(api_params, depends_on_field_key)
 
-              if !field_value.nil? && (depends_on_value.nil? || depends_on_value.empty? || field_value.match?(depends_on_value))
+              if field_value.nil? && !options['_object_key'].nil?
+                field_value = get_object_value({options['_object_key'] => results}, depends_on_field_key)
+              end
+
+              if !field_value.nil? && (depends_on_value.nil? || depends_on_value.empty? || field_value.to_s.match?(depends_on_value))
                 found_dep_value = true if match_type != 'all'
               else
                 found_dep_value = false if match_type == 'all'
@@ -151,6 +155,10 @@ module Morpheus
             context_map = context_map[ns.to_s]
           end
 
+          # build parameters for option source api request
+          option_params = (option_type['noParams'] ? {} : (api_params || {}).merge(results))
+          option_params.merge!(option_type['optionParams']) if option_type['optionParams']
+
           # use the value passed in the options map
           if cur_namespace.respond_to?('key?') && cur_namespace.key?(field_name)
             value = cur_namespace[field_name]
@@ -161,25 +169,25 @@ module Morpheus
               end
             # these select prompts should just fall down through below, with the extra params no_prompt, use_value
             elsif option_type['type'] == 'select'
-              value = select_prompt(option_type.merge({'defaultValue' => value, 'defaultInputValue' => input_value}), api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), true)
+              value = select_prompt(option_type.merge({'defaultValue' => value, 'defaultInputValue' => input_value}), api_client, option_params, true)
             elsif option_type['type'] == 'multiSelect'
               # support value as csv like "thing1, thing2"
               value_list = value.is_a?(String) ? value.parse_csv.collect {|v| v ? v.to_s.strip : v } : [value].flatten
               input_value_list = input_value.is_a?(String) ? input_value.parse_csv.collect {|v| v ? v.to_s.strip : v } : [input_value].flatten
               select_value_list = []
               value_list.each_with_index do |v, i|
-                select_value_list << select_prompt(option_type.merge({'defaultValue' => v, 'defaultInputValue' => input_value_list[i]}), api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), true)
+                select_value_list << select_prompt(option_type.merge({'defaultValue' => v, 'defaultInputValue' => input_value_list[i]}), api_client, option_params, true)
               end
               value = select_value_list
             elsif option_type['type'] == 'typeahead'
-              value = typeahead_prompt(option_type.merge({'defaultValue' => value, 'defaultInputValue' => input_value}), api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), true)
+              value = typeahead_prompt(option_type.merge({'defaultValue' => value, 'defaultInputValue' => input_value}), api_client, option_params, true)
             elsif option_type['type'] == 'multiTypeahead'
               # support value as csv like "thing1, thing2"
               value_list = value.is_a?(String) ? value.parse_csv.collect {|v| v ? v.to_s.strip : v } : [value].flatten
               input_value_list = input_value.is_a?(String) ? input_value.parse_csv.collect {|v| v ? v.to_s.strip : v } : [input_value].flatten
               select_value_list = []
               value_list.each_with_index do |v, i|
-                select_value_list << typeahead_prompt(option_type.merge({'defaultValue' => v, 'defaultInputValue' => input_value_list[i]}), api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), true)
+                select_value_list << typeahead_prompt(option_type.merge({'defaultValue' => v, 'defaultInputValue' => input_value_list[i]}), api_client, option_params, true)
               end
               value = select_value_list
             end
@@ -205,11 +213,11 @@ module Morpheus
                 # select type is special because it supports skipSingleOption
                 # and prints the available options on error
                 if ['select', 'multiSelect'].include?(option_type['type'])
-                  value = select_prompt(option_type, api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), true)
+                  value = select_prompt(option_type, api_client, option_params, true)
                   value_found = !!value
                 end
                 if ['typeahead', 'multiTypeahead'].include?(option_type['type'])
-                  value = typeahead_prompt(option_type, api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), true)
+                  value = typeahead_prompt(option_type, api_client, option_params, true)
                   value_found = !!value
                 end
                 if !value_found
@@ -246,11 +254,11 @@ module Morpheus
               # I suppose the entered value should take precedence
               # api_params = api_params.merge(options) # this might be good enough
               # dup it
-              value = select_prompt(option_type, api_client, (option_type['noParams'] ? {} : (api_params || {}).deep_merge(results)), options[:no_prompt], nil, paging_enabled)
+              value = select_prompt(option_type, api_client, option_params, options[:no_prompt], nil, paging_enabled)
               if value && option_type['type'] == 'multiSelect'
                 value = [value]
                 while self.confirm("Add another #{option_type['fieldLabel']}?", {:default => false}) do
-                  if addn_value = select_prompt(option_type, api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), options[:no_prompt], nil, paging_enabled)
+                  if addn_value = select_prompt(option_type, api_client, option_params, options[:no_prompt], nil, paging_enabled)
                     value << addn_value
                   else
                     break
@@ -258,11 +266,11 @@ module Morpheus
                 end
               end
             elsif ['typeahead', 'multiTypeahead'].include?(option_type['type'])
-              value = typeahead_prompt(option_type, api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), options[:no_prompt], nil, paging_enabled)
+              value = typeahead_prompt(option_type, api_client, option_params, options[:no_prompt], nil, paging_enabled)
               if value && option_type['type'] == 'multiTypeahead'
                 value = [value]
                 while self.confirm("Add another #{option_type['fieldLabel']}?", {:default => false}) do
-                  if addn_value = typeahead_prompt(option_type, api_client, (option_type['noParams'] ? {} : (api_params || {}).merge(results)), options[:no_prompt], nil, paging_enabled)
+                  if addn_value = typeahead_prompt(option_type, api_client, option_params, options[:no_prompt], nil, paging_enabled)
                     value << addn_value
                   else
                     break
@@ -273,7 +281,7 @@ module Morpheus
               if option_type['optionSource'].nil?
                 value = option_type['defaultValue']
               else
-                value = load_source_options(option_type['optionSource'], option_type['optionSourceType'], api_client, api_params || {})
+                value = load_source_options(option_type['optionSource'], option_params, api_client, api_params || {})
               end
             elsif option_type['type'] == 'file'
               value = file_prompt(option_type)
@@ -287,6 +295,11 @@ module Morpheus
           if option_type['type'] == 'multiSelect'
             value = [value] if !value.nil? && !value.is_a?(Array)
             # parent_context_map[parent_ns] = value
+          elsif option_type['type'] == 'multiText'
+            # multiText expects csv value
+            if value && value.is_a?(String)
+              value = value.split(",").collect {|it| it.strip }
+            end
           end
           context_map[field_name] = value if !(value.nil? || (value.is_a?(Hash) && value.empty?))
           parent_context_map.reject! {|k,v| k == parent_ns && (v.nil? || (v.is_a?(Hash) && v.empty?))}
@@ -305,7 +318,7 @@ module Morpheus
         end
         optionString = options.collect{ |b| b[:checked] ? "(#{b[:key]})" : b[:key]}.join(', ')
         while !value_found do
-          print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }[#{optionString}]: "
+          print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? (' (' + option_type['fieldAddOn'] + ') ') : '' }[#{optionString}]: "
           input = $stdin.gets.chomp!
           if input == '?'
             help_prompt(option_type)
@@ -332,7 +345,7 @@ module Morpheus
         value_found = false
         value = nil
         while !value_found do
-          print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{!option_type['defaultValue'].to_s.empty? ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
+          print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? (' (' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{!option_type['defaultValue'].to_s.empty? ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
           input = $stdin.gets.chomp!
           value = input.empty? ? option_type['defaultValue'] : input
           if !value.to_s.empty?
@@ -356,7 +369,7 @@ module Morpheus
         Thread.current[:_last_select]
       end
 
-      def self.select_prompt(option_type,api_client, api_params={}, no_prompt=false, use_value=nil, paging_enabled=false)
+      def self.select_prompt(option_type, api_client, api_params={}, no_prompt=false, use_value=nil, paging_enabled=false)
         paging_enabled = false if Morpheus::Cli.windows?
         field_key = [option_type['fieldContext'], option_type['fieldName']].select {|it| it && it != '' }.join('.')
         help_field_key = option_type[:help_field_prefix] ? "#{option_type[:help_field_prefix]}.#{field_key}" : field_key
@@ -365,7 +378,12 @@ module Morpheus
         value_field = (option_type['config'] ? option_type['config']['valueField'] : nil) || 'value'
         default_value = option_type['defaultValue']
         default_value = default_value['id'] if default_value && default_value.is_a?(Hash) && !default_value['id'].nil?
-        api_params ||= {}
+
+        if !option_type['params'].nil?
+          api_params = (api_params || {}).select {|k,v| option_type['params'].key?(k) || option_type['params'].key?(k.to_s)}
+          option_type['params'].select {|k,v| !v.empty?}.each {|k,v| api_params[k] = v}
+        end
+
         # local array of options
         if option_type['selectOptions']
           # calculate from inline lambda
@@ -424,7 +442,8 @@ module Morpheus
               default_value = found_default_option['name'] # name is prettier than value
             end
           else
-            found_default_option  = select_options.find {|opt| opt[value_field].to_s == default_value.to_s}
+            found_default_option = select_options.find {|opt| opt[value_field].to_s == default_value.to_s || opt['name'] == default_value.to_s}
+            found_default_option = select_options.find {|opt| opt[value_field].to_s.start_with?(default_value.to_s) || opt['name'].to_s.start_with?(default_value.to_s)} if !found_default_option
             if found_default_option
               default_value = found_default_option['name'] # name is prettier than value
             end
@@ -483,7 +502,7 @@ module Morpheus
           }
 
           has_more_pages = paging && (paging[:cur_page] * paging[:page_size]) < paging[:total]
-          input = Readline.readline("#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{!default_value.to_s.empty? ? ' ['+default_value.to_s+']' : ''} ['?' for#{has_more_pages && paging[:cur_page] > 0 ? ' more ' : ' '}options]: ", false).to_s
+          input = Readline.readline("#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? (' (' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{!default_value.to_s.empty? ? ' ['+default_value.to_s+']' : ''} ['?' for#{has_more_pages && paging[:cur_page] > 0 ? ' more ' : ' '}options]: ", false).to_s
           input = input.chomp.strip
           if input.empty? && default_value
             input = default_value.to_s
@@ -554,7 +573,7 @@ module Morpheus
             }
             # prompt for typeahead input value
             has_more_pages = paging && ((paging[:cur_page] + 1) * paging[:page_size]) < paging[:total]
-            input = Readline.readline("#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{!default_value.to_s.empty? ? ' ['+default_value.to_s+']' : ''} ['?' for#{has_more_pages ? ' more ' : ' '}options]: ", false).to_s
+            input = Readline.readline("#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? (' (' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{!default_value.to_s.empty? ? ' ['+default_value.to_s+']' : ''} ['?' for#{has_more_pages ? ' more ' : ' '}options]: ", false).to_s
             input = input.chomp.strip
           end
 
@@ -743,7 +762,7 @@ module Morpheus
         value_found = false
         value = nil
         while !value_found do
-          print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{!option_type['defaultValue'].to_s.empty? ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
+          print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? (' (' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{!option_type['defaultValue'].to_s.empty? ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
           input = $stdin.gets.chomp!
           value = input.empty? ? option_type['defaultValue'] : input
           if input == '?'
@@ -760,7 +779,7 @@ module Morpheus
         value = nil
         while !value_found do
           if value.nil?
-            print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{optional_label(option_type)} [Type 'EOF' to stop input]: \n"
+            print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? (' (' + option_type['fieldAddOn'] + ') ') : '' }#{optional_label(option_type)} [Type 'EOF' to stop input]: \n"
           end
           input = $stdin.gets.chomp!
           # value = input.empty? ? option_type['defaultValue'] : input
@@ -784,7 +803,7 @@ module Morpheus
       def self.password_prompt(option_type)
         value_found = false
         while !value_found do
-          print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{optional_label(option_type)}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
+          print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? (' (' + option_type['fieldAddOn'] + ') ') : '' }#{optional_label(option_type)}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
           input = $stdin.noecho(&:gets).chomp!
           value = input
           print "\n"
@@ -804,11 +823,11 @@ module Morpheus
         value_found = false
         value = nil
         while !value_found do
-          #print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{optional_label(option_type)}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
+          #print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? (' (' + option_type['fieldAddOn'] + ') ') : '' }#{optional_label(option_type)}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
           Readline.completion_append_character = ""
           Readline.basic_word_break_characters = ''
           Readline.completion_proc = proc {|s| Readline::FILENAME_COMPLETION_PROC.call(s) }
-          input = Readline.readline("#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{optional_label(option_type)}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''}: ", false).to_s
+          input = Readline.readline("#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? (' (' + option_type['fieldAddOn'] + ') ') : '' }#{optional_label(option_type)}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''}: ", false).to_s
           input = input.chomp.strip
           #input = $stdin.gets.chomp!
           value = input.empty? ? option_type['defaultValue'] : input.to_s
@@ -926,6 +945,8 @@ module Morpheus
             select_options = filtered_options
           end
         elsif option_type['optionSource']
+          api_params = api_params.select {|k,v| option_type['params'].include(k)} if option_type['params'].nil? && api_params
+
           # calculate from inline lambda
           if option_type['optionSource'].is_a?(Proc)
             select_options = option_type['optionSource'].call(api_client, api_params || {})

data/lib/morpheus/cli/version.rb

@@ -1,6 +1,6 @@
 
 module Morpheus
   module Cli
-    VERSION = "5.4.0"
+    VERSION = "5.4.1"
   end
 end

data/lib/morpheus/cli.rb

@@ -4,6 +4,7 @@ require 'morpheus/rest_client'
 require 'morpheus/formatters'
 require 'morpheus/logging'
 require 'morpheus/util'
+require 'morpheus/routes'
 require 'term/ansicolor'
 
 Dir[File.dirname(__FILE__)  + "/ext/*.rb"].each {|file| require file }

data/lib/morpheus/ext/string.rb

@@ -1,7 +1,7 @@
 class String
   
   def pluralize
-    value = self
+    value = self.dup
     if value == ""
       value
     elsif value[-1].chr == "y"
@@ -18,7 +18,7 @@ class String
   end
 
   def singularize
-    value = self
+    value = self.dup
     if value == ""
       value
     elsif value.size > 3 && value[-3..-1] == "ies"
@@ -27,15 +27,38 @@ class String
       value[0..-3]
     elsif value[-1] == "s"
       value[0..-2]
+    else
+      value
     end
   end
 
-  def dasherize
-    self.gsub(" ", "-").gsub("_", "-")
+  def underscore
+    value = self.dup
+    value.gsub!(/::/, '/')
+    value.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    value.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    value.tr!("-", "_")
+    value.tr!(" ", "_")
+    value.downcase!
+    value
+  end
+
+  def camelcase
+    value = self.underscore.gsub(/\_([a-z])/) do $1.upcase end
+    value = value[0, 1].downcase + value[1..-1]
+    value
   end
 
-  def underscoreize
-    self.gsub(" ", "_").gsub("-", "_")
+  def upcamelcase
+    self.camelcase.capitalize
+  end
+
+  def titleize
+    self.underscore.split("_").map(&:capitalize).join(" ")
+  end
+
+  def dasherize
+    self.underscore.gsub("_", "-")
   end
 
 end

data/lib/morpheus/routes.rb

@@ -0,0 +1,238 @@
+# Routes is a module to provide a way to look up routes in the Morpheus UI.
+# Examples:
+#   Routes.lookup("users") == "/admin/users"
+#   Routes.lookup("instances") == "/provisioning/instances"
+#
+#   puts "All routes", Morpheus::Routes.routes
+#
+module Morpheus::Routes
+
+  # A static site map for the Morpheus UI.
+  # todo: move to YAML or load from api
+  SITE_MAP = {
+    operations: {
+      dashboard: {},
+      reports: {},
+      analytics: {},
+      guidance: {},
+      wiki: {},
+      costing: {
+        budgets: {},
+        invoices: {},
+        usage: {},
+      },
+      approvals: {},
+      activity: {},
+      alarms: {},
+    },
+    provisioning: {
+      instances: {},
+      apps: {},
+      catalog: {},
+      jobs: {},
+      executions: {},
+      code: {
+        respositories: {},
+        deployments: {},
+        # integrations: {}, # Integrations
+      },
+    },
+    library: {
+      automation: [
+        "#!tasks",
+        "#!workflows",
+        "#!thresholds",
+        "#!power-schedules",
+        "#!execute-schedules",
+      ],
+      blueprints: [
+        "#instance-types",
+        "#!instance-type-layouts",
+        "#!container-types",
+        "#!app-templates", # App Blueprints (blueprints)
+        "#!catalog-items",
+        "#!compute-type-layouts", # Cluster Layouts
+      ],
+      :'virtual-images' => {},
+      options: [
+        "#!option-type-lists", # Option Lists
+      ],
+      templates: [
+        "#!specs",
+        "#!files",
+        "#!scripts",
+        "#!security-specs",
+      ],
+      services: {}, # Integrations
+
+    },
+    infrastructure: {
+      groups: {},
+      clouds: {},
+      clusters: {},
+      servers: {}, # Hosts (still used for loading by id)
+      inventory: [ # Compute
+        "#!hosts",
+        "#!virtual-machines",
+        "#!containers",
+        "#!resources",
+        "#!bare-metal",
+      ],
+      networks: {},
+      :'load-balancers' => {},
+      storage: {
+        buckets: {},  
+        shares: {},  # File Shares
+        volumes: {},  
+        :'data-stores' => {}, # ugh, should be datastores
+        servers: {}, # Storage Servers
+      },
+      # :'keys-and-certs' => {},
+      :'key-pairs' => {},
+      certificates: {},
+    },
+    backups: {
+
+    },
+    monitoring: {
+      status: {},
+      logs: {},
+      apps: {},
+      checks: {},
+      groups: {},
+      incidents: {},
+      contacts: {},
+      :'alert-rules' => {}, 
+    },
+    tools: {
+      cypher: {},
+      archives: {
+        buckets: {},
+      },
+      :'image-builder' => {},
+      :vdi => {}
+    },
+    admin: {
+      accounts: {}, # Tenants
+      :'service-plans' => [
+        "#prices",
+        "#pricesets"
+      ],
+      roles: {},
+      users: {},
+      :'user-groups' => {},
+      integrations: {},
+      policies: {},
+      health: ["logs"],
+      settings: {},
+    },
+    :'user-settings' => {}, # User Settings (Profile)
+  } unless defined?(SITE_MAP)
+
+  # A list of routes generated from the site map and cached
+  @@routes = nil
+  
+  # @return an array of well known Morpheus UI routes.
+  def self.routes
+    if !@@routes
+      @@routes = build_routes(SITE_MAP)
+    end
+    return @@routes
+  end
+
+  # lookup a route in the morpheus UI
+  # @param path [String] The input to lookup a route for eg. "dashboard"
+  # @return full path like "/operations/dashboard"
+  def self.lookup(input)
+    path = input.to_s
+    if path.start_with?("/")
+      # absolute path is being looked up
+      return path
+    else
+      # todo: make this smarter, regex, case insensitive, etc
+      # find the one with smallest match index
+
+      # map well known aliases
+      case(path.underscore.singularize)
+      when "server","host","vm","virtual-machine"
+        # actually should be "/infrastructure/inventory" unless id is passed, show route uses /servers though
+        path = "/infrastructure/servers"
+      when "compute"
+        path = "/infrastructure/inventory"
+      when "tenant"
+        path = "/admin/accounts"
+      end
+      # dasherize path and attempt to match the plural first
+      plural_path = path.pluralize
+      paths = [path.dasherize]
+      if plural_path != path
+        paths.unshift(plural_path.dasherize)
+      end
+
+      best_route = nil
+      best_index = nil
+      best_prefix_words = nil
+      paths.each do |p|
+        if best_route.nil?
+          self.routes.each do |it|
+            match_index = it.index(p)
+            if match_index
+              prefix_route = match_index == 0 ? "" : it[0..(match_index-1)]
+              prefix_words = prefix_route.split("/")
+              #if best_index.nil? || match_index < best_index
+              if best_prefix_words.nil? || prefix_words.size < best_prefix_words.size
+                best_route = it
+                best_index = match_index
+                best_prefix_words = prefix_words
+              end
+            end
+          end
+        end
+      end
+      if best_route
+        return best_route
+      else
+        # no match found
+        return nil
+      end
+    end
+    
+  end
+
+  protected 
+
+  # build_routes constructs an array of routes (paths) 
+  # This traversing the route map recursively and appends paths to output
+  # @params route_map [Hash] map of routes
+  # @params context [String] the current content
+  # @params output [Array] the list of route paths being constructed for return
+  # @return array like ["/operations", "/operations/dashboard", "/admin", "/etc"]
+  def self.build_routes(route_map, context="", output = nil)
+    if output.nil?
+      output = []
+    end
+    route_map.each do |k,v|
+      leaf_path = "#{context}/#{k}"
+      output << leaf_path
+      if v.is_a?(Hash)
+        build_routes(v, leaf_path, output)
+      elsif v.is_a?(Array)
+        v.each do |obj|
+          if obj.is_a?(Hash)
+            build_routes(obj, leaf_path, output)
+          elsif obj.is_a?(Symbol) || obj.is_a?(String)
+            # route leaf type not handled
+            output << "#{leaf_path}/#{obj}"
+          else
+            # route leaf type not handled
+          end
+        end
+      else
+        # route leaf type not handled
+      end
+    end
+    return output
+  end
+
+  
+end