morpheus-cli 5.0.0 → 5.2.2

data/lib/morpheus/cli/instances.rb

@@ -19,7 +19,7 @@ class Morpheus::Cli::Instances
                        :history, {:'history-details' => :history_details}, {:'history-event' => :history_event_details}, 
                        :stats, :stop, :start, :restart, :actions, :action, :suspend, :eject, :stop_service, :start_service, :restart_service, 
                        :backup, :backups, :resize, :clone, :envs, :setenv, :delenv, 
-                       :security_groups, :apply_security_groups, :run_workflow, :import_snapshot, 
+                       :security_groups, :apply_security_groups, :run_workflow, :import_snapshot, :snapshot, :snapshots,
                        :console, :status_check, {:containers => :list_containers}, 
                        :scaling, {:'scaling-update' => :scaling_update},
                        :wiki, :update_wiki,
@@ -80,9 +80,6 @@ class Morpheus::Cli::Instances
         options[:owner] = val
       end
       opts.add_hidden_option('--created-by')
-      opts.on('--details', "Display more details: memory and storage usage used / max values." ) do
-        options[:details] = true
-      end
       opts.on('--status STATUS', "Filter by status i.e. provisioning,running,starting,stopping") do |val|
         params['status'] = (params['status'] || []) + val.to_s.split(',').collect {|s| s.strip }.select {|s| s != "" }
       end
@@ -92,6 +89,37 @@ class Morpheus::Cli::Instances
       opts.on('--pending-removal-only', "Only instances pending removal.") do
         options[:deleted] = true
       end
+      opts.on( '--plan NAME', String, "Filter by Plan name(s)" ) do |val|
+        # commas used in names a lot so use --plan one --plan two
+        params['plan'] ||= []
+        params['plan'] << val
+      end
+      opts.on( '--plan-id ID', String, "Filter by Plan id(s)" ) do |val|
+        params['planId'] = parse_id_list(val)
+      end
+      opts.on( '--plan-code CODE', String, "Filter by Plan code(s)" ) do |val|
+        params['planCode'] = parse_id_list(val)
+      end
+      opts.on('--labels label',String, "Filter by labels (keywords).") do |val|
+        val.split(",").each do |k|
+          options[:labels] ||= []
+          options[:labels] << k.strip
+        end
+      end
+      opts.on('--tags Name=Value',String, "Filter by tags (metadata name value pairs).") do |val|
+        val.split(",").each do |value_pair|
+          k,v = value_pair.strip.split("=")
+          options[:tags] ||= {}
+          options[:tags][k] ||= []
+          options[:tags][k] << (v || '')
+        end
+      end
+      opts.on('--stats', "Display values for memory and storage usage used / max values." ) do
+        options[:stats] = true
+      end
+      opts.on('-a', '--details', "Display all details: plan, stats, etc" ) do
+        options[:details] = true
+      end
       build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
       opts.footer = "List instances."
     end
@@ -132,7 +160,13 @@ class Morpheus::Cli::Instances
 
       params['showDeleted'] = true if options[:showDeleted]
       params['deleted'] = true if options[:deleted]
-      
+      params['labels'] = options[:labels] if options[:labels]
+      if options[:tags]
+        options[:tags].each do |k,v|
+          params['tags.' + k] = v
+        end
+      end
+
       @instances_interface.setopts(options)
       if options[:dry_run]
         print_dry_run @instances_interface.dry.list(params)
@@ -196,7 +230,7 @@ class Morpheus::Cli::Instances
             cpu_usage_str = !stats ? "" : generate_usage_bar((stats['usedCpu'] || stats['cpuUsage']).to_f, 100, {max_bars: 10})
             memory_usage_str = !stats ? "" : generate_usage_bar(stats['usedMemory'], stats['maxMemory'], {max_bars: 10})
             storage_usage_str = !stats ? "" : generate_usage_bar(stats['usedStorage'], stats['maxStorage'], {max_bars: 10})
-            if options[:details]
+            if options[:details] || options[:stats]
               if stats['maxMemory'] && stats['maxMemory'].to_i != 0
                 memory_usage_str = memory_usage_str + cyan + format_bytes_short(stats['usedMemory']).strip.rjust(8, ' ')  + " / " + format_bytes_short(stats['maxMemory']).strip
               end
@@ -214,8 +248,9 @@ class Morpheus::Cli::Instances
               nodes: instance['containers'].count,
               status: format_instance_status(instance, cyan),
               type: instance['instanceType']['name'],
-              group: !instance['group'].nil? ? instance['group']['name'] : nil,
-              cloud: !instance['cloud'].nil? ? instance['cloud']['name'] : nil,
+              group: instance['group'] ? instance['group']['name'] : nil,
+              cloud: instance['cloud'] ? instance['cloud']['name'] : nil,
+              plan: instance['plan'] ? instance['plan']['name'] : '',
               version: instance['instanceVersion'] ? instance['instanceVersion'] : '',
               created: format_local_dt(instance['dateCreated']),
               cpu: cpu_usage_str + cyan,
@@ -229,12 +264,13 @@ class Morpheus::Cli::Instances
               {:created => {:display_name => "CREATED"}}, 
               # {:tenant => {:display_name => "TENANT"}}, 
               {:user => {:display_name => "OWNER", :max_width => 20}}, 
+              :plan,
               :nodes, {:connection => {:max_width => 30}}, :status, :cpu, :memory, :storage]
           # custom pretty table columns ... this is handled in as_pretty_table now(), 
           # todo: remove all these.. and try to always pass rows as the json data itself..
-          # if options[:include_fields]
-          #   columns = options[:include_fields]
-          # end
+          if options[:details] != true
+            columns.delete(:plan)
+          end
           print cyan
           print as_pretty_table(rows, columns, options)
           print reset
@@ -347,18 +383,16 @@ class Morpheus::Cli::Instances
       opts.on("--environment ENV", String, "Environment code") do |val|
         options[:environment] = val.to_s
       end
-      opts.on('--metadata LIST', String, "Metadata tags in the format 'name:value, name:value'") do |val|
+      opts.on('--tags LIST', String, "Metadata tags in the format 'ping=pong,flash=bang'") do |val|
         options[:metadata] = val
       end
-      opts.on('--labels LIST', String, "Labels (keywords) in the format 'foo, bar'") do |val|
-        #options[:tags] = val
-        options[:tags] = val.split(',').collect {|it| it.to_s.strip }.compact.uniq.join(',')
+      opts.on('--metadata LIST', String, "Metadata tags in the format 'ping=pong,flash=bang'") do |val|
+        options[:metadata] = val
       end
-      opts.on('--tags LIST', String, "Tags") do |val|
-        #options[:tags] = val
-        options[:tags] = val.split(',').collect {|it| it.to_s.strip }.compact.uniq.join(',')
+      opts.add_hidden_option('--metadata')
+      opts.on('--labels LIST', String, "Labels (keywords) in the format 'foo, bar'") do |val|
+        options[:labels] = val.split(',').collect {|it| it.to_s.strip }.compact.uniq.join(',')
       end
-      opts.add_hidden_option('--tags')
       opts.on("--copies NUMBER", Integer, "Number of copies to provision") do |val|
         options[:copies] = val.to_i
       end
@@ -425,17 +459,58 @@ class Morpheus::Cli::Instances
       options[:instance_name] = args[0]
     end
 
-    # use active group by default
-    options[:group] ||= @active_group_id
-    options[:select_datastore] = true
-    options[:name_required] = true
     begin
       payload = nil
       if options[:payload]
         payload = options[:payload]
         # support -O OPTION switch on top of --payload
         payload.deep_merge!(options[:options].reject {|k,v| k.is_a?(Symbol) }) if options[:options]
+        # obviously should support every option that prompt supports on top of -- payload as well
+        # group, cloud and type for now
+        # todo: also support :layout, service_plan, :resource_pool, etc.
+        group = nil
+        if options[:group]
+          group = find_group_by_name_or_id_for_provisioning(options[:group])
+          if group.nil?
+            return 1, "group not found by #{options[:group]}"
+          end
+          #payload["siteId"] = group["id"]
+          payload.deep_merge!({"instance" => {"site" => {"id" => group["id"]} } })
+        end
+        if options[:cloud]
+          group_id = group ? group["id"] : ((payload["instance"] && payload["instance"]["site"].is_a?(Hash)) ? payload["instance"]["site"]["id"] : nil)
+          cloud = find_cloud_by_name_or_id_for_provisioning(group_id, options[:cloud])
+          if cloud.nil?
+            return 1, "cloud not found by #{options[:cloud]}"
+          end
+          payload["zoneId"] = cloud["id"]
+          payload.deep_merge!({"instance" => {"cloud" => cloud["name"] } })
+        end
+        if options[:cloud]
+          group_id = group ? group["id"] : ((payload["instance"] && payload["instance"]["site"].is_a?(Hash)) ? payload["instance"]["site"]["id"] : nil)
+          cloud = find_cloud_by_name_or_id_for_provisioning(group_id, options[:cloud])
+          if cloud.nil?
+            return 1, "cloud not found by #{options[:cloud]}"
+          end
+          payload["zoneId"] = cloud["id"]
+          payload.deep_merge!({"instance" => {"cloud" => cloud["name"] } })
+        end
+        if options[:instance_type_code]
+          # should just use find_instance_type_by_name_or_id
+          # note that the api actually will match name name or code
+          instance_type = (options[:instance_type_code].to_s =~ /\A\d{1,}\Z/) ? find_instance_type_by_id(options[:instance_type_code]) : find_instance_type_by_code(options[:instance_type_code])
+          if instance_type.nil?
+            return 1, "instance type not found by #{options[:cloud]}"
+          end
+          payload.deep_merge!({"instance" => {"type" => instance_type["code"] } })
+          payload.deep_merge!({"instance" => {"instanceType" => {"code" => instance_type["code"]} } })
+        end
+
       else
+        # use active group by default
+        options[:group] ||= @active_group_id
+        options[:select_datastore] = true
+        options[:name_required] = true
         # prompt for all the instance configuration options
         # this provisioning helper method handles all (most) of the parsing and prompting
         # and it relies on the method to exit non-zero on error, like a bad CLOUD or TYPE value
@@ -528,18 +603,18 @@ class Morpheus::Cli::Instances
       opts.on('--group GROUP', String, "Group Name or ID") do |val|
         options[:group] = val
       end
-      opts.on('--metadata LIST', String, "Metadata tags in the format 'name:value, name:value'") do |val|
-        options[:metadata] = val
-      end
       opts.on('--labels LIST', String, "Labels (keywords) in the format 'foo, bar'") do |val|
-        #params['tags'] = val
-        params['tags'] = val.split(',').collect {|it| it.to_s.strip }.compact.uniq.join(',')
+        params['labels'] = val.split(',').collect {|it| it.to_s.strip }.compact.uniq.join(',')
+      end
+      opts.on('--tags LIST', String, "Tags in the format 'name:value, name:value'. This will add and remove tags.") do |val|
+        options[:tags] = val
       end
-      opts.on('--tags LIST', String, "Tags") do |val|
-        #params['tags'] = val
-        params['tags'] = val.split(',').collect {|it| it.to_s.strip }.compact.uniq.join(',')
+      opts.on('--add-tags TAGS', String, "Add Tags in the format 'name:value, name:value'. This will only add/update tags.") do |val|
+        options[:add_tags] = val
+      end
+      opts.on('--remove-tags TAGS', String, "Remove Tags in the format 'name, name:value'. This removes tags, the :value component is optional and must match if passed.") do |val|
+        options[:remove_tags] = val
       end
-      opts.add_hidden_option('--tags')
       opts.on('--power-schedule-type ID', String, "Power Schedule Type ID") do |val|
         params['powerScheduleType'] = val == "null" ? nil : val
       end
@@ -594,29 +669,17 @@ class Morpheus::Cli::Instances
         payload['instance']['site'] = {'id' => group['id']}
       end
       # metadata tags
-      # if options[:options]['metadata'].is_a?(Array) && !options[:metadata]
-      #   options[:metadata] = options[:options]['metadata']
-      # end
-      if options[:metadata]
-        metadata = []
-        if options[:metadata] == "[]" || options[:metadata] == "null"
-          payload['instance']['metadata'] = []
-        elsif options[:metadata].is_a?(Array)
-          payload['instance']['metadata'] = options[:metadata]
-        else
-          # parse string into format name:value, name:value
-          # merge IDs from current metadata
-          # todo: should allow quoted semicolons..
-          metadata_list = options[:metadata].split(",").select {|it| !it.to_s.empty? }
-          metadata_list = metadata_list.collect do |it|
-            metadata_pair = it.split(":")
-            row = {}
-            row['name'] = metadata_pair[0].to_s.strip
-            row['value'] = metadata_pair[1].to_s.strip
-            row
-          end
-          payload['instance']['metadata'] = metadata_list
-        end
+      if options[:tags]
+        # api version 4.2.5 and later supports tags, older versions expect metadata
+        # todo: use tags instead like everywhere else
+        # payload['instance']['tags'] = parse_metadata(options[:tags])
+        payload['instance']['metadata'] = parse_metadata(options[:tags])
+      end
+      if options[:add_tags]
+        payload['instance']['addTags'] = parse_metadata(options[:add_tags])
+      end
+      if options[:remove_tags]
+        payload['instance']['removeTags'] = parse_metadata(options[:remove_tags])
       end
       if payload['instance'].empty? && params.empty? && options[:owner].nil?
         raise_command_error "Specify at least one option to update.\n#{optparse}"
@@ -1217,7 +1280,18 @@ class Morpheus::Cli::Instances
       instance = json_response['instance']
       stats = instance['stats'] || json_response['stats'] || {}
       # load_balancers = json_response['loadBalancers'] || {}
-
+      # metadata tags used to be returned as metadata and are now returned as tags
+      # the problem is tags is what we used to call Labels (keywords)
+      # the api will change to tags and labels, so handle the old format as long as metadata is returned.
+      labels = nil
+      tags = nil
+      if instance.key?('labels')
+        labels = instance['labels']
+        tags = instance['tags']
+      else
+        labels = instance['tags']
+        tags = instance['metadata']
+      end
       # containers are fetched via separate api call
       containers = nil
       if options[:include_containers]
@@ -1258,8 +1332,8 @@ class Morpheus::Cli::Instances
         # "Cost" => lambda {|it| it['hourlyCost'] ? format_money(it['hourlyCost'], (it['currency'] || 'USD'), {sigdig:15}).to_s + ' per hour' : '' },
         # "Price" => lambda {|it| it['hourlyPrice'] ? format_money(it['hourlyPrice'], (it['currency'] || 'USD'), {sigdig:15}).to_s + ' per hour' : '' },
         "Environment" => 'instanceContext',
-        "Labels" => lambda {|it| it['tags'] ? it['tags'].join(',') : '' },
-        "Metadata" => lambda {|it| it['metadata'] ? it['metadata'].collect {|m| "#{m['name']}: #{m['value']}" }.join(', ') : '' },
+        "Labels" => lambda {|it| labels ? labels.join(',') : '' },
+        "Tags" => lambda {|it| tags ? tags.collect {|m| "#{m['name']}: #{m['value']}" }.join(', ') : '' },
         "Owner" => lambda {|it| 
           if it['owner']
             (it['owner']['username'] || it['owner']['id'])
@@ -1278,11 +1352,14 @@ class Morpheus::Cli::Instances
         "Connection" => lambda {|it| format_instance_connection_string(it) },
         "Status" => lambda {|it| format_instance_status(it) }
       }
+      description_cols.delete("Labels") if labels.nil? || labels.empty?
+      description_cols.delete("Tags") if tags.nil? || tags.empty?
       description_cols.delete("Power Schedule") if instance['powerSchedule'].nil?
       description_cols.delete("Expire Date") if instance['expireDate'].nil?
       description_cols.delete("Shutdown Date") if instance['shutdownDate'].nil?
       description_cols["Removal Date"] = lambda {|it| format_local_dt(it['removalDate'])} if instance['status'] == 'pendingRemoval'
       description_cols.delete("Last Deployment") if instance['lastDeploy'].nil?
+      #description_cols.delete("Environment") if instance['instanceContext'].nil?
       print_description_list(description_cols, instance)
 
       if instance['statusMessage']
@@ -2596,6 +2673,48 @@ class Morpheus::Cli::Instances
     end
   end
 
+  def snapshot(args)
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[instance]")
+      opts.on( '--name VALUE', String, "Snapshot Name. Default is server name + timestamp" ) do |val|
+        options[:options]['name'] = val
+      end
+      opts.on( '--description VALUE', String, "Snapshot Description." ) do |val|
+        options[:options]['description'] = val
+      end
+      build_standard_add_options(opts, options, [:auto_confirm])
+      opts.footer = <<-EOT
+Create a snapshot for an instance.
+[instance] is required. This is the name or id of an instance
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    instance = find_instance_by_name_or_id(args[0])
+    unless options[:yes] || ::Morpheus::Cli::OptionTypes::confirm("Are you sure you would like to snapshot the instance '#{instance['name']}'?", options)
+      exit 1
+    end
+    payload = {}
+    if options[:payload]
+      payload = options[:payload]
+      payload.deep_merge!({'snapshot' => parse_passed_options(options)})
+    else
+      payload.deep_merge!({'snapshot' => parse_passed_options(options)})
+    end
+    @instances_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @instances_interface.dry.snapshot(instance['id'], payload)
+      return
+    end
+    json_response = @instances_interface.snapshot(instance['id'], payload)
+    render_response(json_response, options, 'snapshots') do
+      print_green_success "Snapshot initiated."
+    end
+    return 0, nil
+  end
+
   def remove(args)
     options = {}
     query_params = {}
@@ -2898,6 +3017,57 @@ class Morpheus::Cli::Instances
     end
   end
 
+  def snapshots(args)
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[instance]")
+      # no pagination yet
+      # build_standard_list_options(opts, options)
+      build_standard_get_options(opts, options)
+            opts.footer = <<-EOT
+List snapshots for an instance.
+[instance] is required. This is the name or id of an instance
+EOT
+    end
+    optparse.parse!(args)
+    verify_args!(args:args, optparse:optparse, count:1)
+    connect(options)
+    begin
+      instance = find_instance_by_name_or_id(args[0])
+      params = {}
+      @instances_interface.setopts(options)
+      if options[:dry_run]
+        print_dry_run @instances_interface.dry.snapshots(instance['id'], params)
+        return
+      end
+      json_response = @instances_interface.snapshots(instance['id'], params)
+      snapshots = json_response['snapshots']      
+      render_response(json_response, options, 'snapshots') do
+        print_h1 "Snapshots: #{instance['name']} (#{instance['instanceType']['name']})", [], options
+        if snapshots.empty?
+          print cyan,"No snapshots found",reset,"\n"
+        else
+          snapshot_column_definitions = {
+            "ID" => lambda {|it| it['id'] },
+            "Name" => lambda {|it| it['name'] },
+            "Description" => lambda {|it| it['description'] },
+            # "Type" => lambda {|it| it['snapshotType'] },
+            "Date Created" => lambda {|it| format_local_dt(it['snapshotCreated']) },
+            "Status" => lambda {|it| format_snapshot_status(it) }
+          }
+          print cyan
+          print as_pretty_table(snapshots, snapshot_column_definitions.upcase_keys!, options)
+          print_results_pagination({size: snapshots.size, total: snapshots.size})
+        end
+        print reset, "\n"
+      end
+      return 0
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
   def import_snapshot(args)
     options = {}
     query_params = {}
@@ -3810,51 +3980,6 @@ private
     end
   end
 
-  def format_instance_status(instance, return_color=cyan)
-    out = ""
-    status_string = instance['status'].to_s
-    if status_string == 'running'
-      out << "#{green}#{status_string.upcase}#{return_color}"
-    elsif status_string == 'provisioning'
-      out << "#{cyan}#{status_string.upcase}#{return_color}"
-    elsif status_string == 'stopped' or status_string == 'failed'
-      out << "#{red}#{status_string.upcase}#{return_color}"
-    else
-      out << "#{yellow}#{status_string.upcase}#{return_color}"
-    end
-    out
-  end
-
-  def format_instance_connection_string(instance)
-    if !instance['connectionInfo'].nil? && instance['connectionInfo'].empty? == false
-      connection_string = "#{instance['connectionInfo'][0]['ip']}:#{instance['connectionInfo'][0]['port']}"
-    end
-  end
-
-  def format_container_status(container, return_color=cyan)
-    out = ""
-    status_string = container['status'].to_s
-    if status_string == 'running'
-      out << "#{green}#{status_string.upcase}#{return_color}"
-    elsif status_string == 'provisioning'
-      out << "#{cyan}#{status_string.upcase}#{return_color}"
-    elsif status_string == 'stopped' or status_string == 'failed'
-      out << "#{red}#{status_string.upcase}#{return_color}"
-    else
-      out << "#{yellow}#{status_string.upcase}#{return_color}"
-    end
-    out
-  end
-
-  def format_container_connection_string(container)
-    if !container['ports'].nil? && container['ports'].empty? == false
-      connection_string = "#{container['ip']}:#{container['ports'][0]['external']}"
-    else
-      # eh? more logic needed here i think, see taglib morph:containerLocationMenu
-      connection_string = "#{container['ip']}"
-    end
-  end
-
   def instance_scaling_option_types(instance=nil)
     
     # Group
@@ -3908,17 +4033,6 @@ private
     list
   end
 
-  def format_instance_container_display_name(instance, plural=false)
-    #<span class="info-label">${[null,'docker'].contains(instance.layout?.provisionType?.code) ? 'Containers' : 'Virtual Machines'}:</span> <span class="info-value">${instance.containers?.size()}</span>
-    v = plural ? "Containers" : "Container"
-    if instance && instance['layout'] && instance['layout'].key?("provisionTypeCode")
-      if [nil, 'docker'].include?(instance['layout']["provisionTypeCode"])
-        v = plural ? "Virtual Machines" : "Virtual Machine"
-      end
-    end
-    return v
-  end
-
   def print_instance_threshold_description_list(instance_threshold)
     description_cols = {
       # "Instance" => lambda {|it| "#{instance['id']} - #{instance['name']}" },
@@ -4024,19 +4138,4 @@ private
     }
   end
 
-  def format_app_deploy_status(status, return_color=cyan)
-    out = ""
-    s = status.to_s.downcase
-    if s == 'deployed'
-      out << "#{green}#{s.upcase}#{return_color}"
-    elsif s == 'open' || s == 'archived' || s == 'committed'
-      out << "#{cyan}#{s.upcase}#{return_color}"
-    elsif s == 'failed'
-      out << "#{red}#{s.upcase}#{return_color}"
-    else
-      out << "#{yellow}#{s.upcase}#{return_color}"
-    end
-    out
-  end
-
 end