morpheus-cli 4.1.7 → 4.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e55c3726ed7947b5d691c9027193844361880ca143f493aa886ece9423bb45a1
-  data.tar.gz: a6e90dac8b23e38762565259def0bddead03a57d38c9f4f691c39032ed6d6431
+  metadata.gz: 2cd6e1f9ac938239cda4d222bb5f48a1a6567203d030e65a2efa6a5ed4742918
+  data.tar.gz: '09548881659c074b1d2d37219f5d13a3d94d9320672c2cca07803da1311dcac9'
 SHA512:
-  metadata.gz: 910f2ccd9bd70988654f744a47a4633baa8b525a7054b961ee62600691c36d9706303b134c37b01c1584b29d87e7cb958fab237f721467966b12aa355e7d7ad7
-  data.tar.gz: 8c14cf726ac4ca45aa716b590b56d46a1043f5ac2d9d668f5de4234aea48f9955aac2d79ebd43851f0ea9f652192794f329fe9afe4bd77c09e5821e97d69d0dc
+  metadata.gz: 8bd9c56fdeaf03e419cd48780afaea7d645ef07ab0c898b86a2ec3ca33e381fab349d4b79f7f260890be0ef0d9a579d32949c6834419597862ba380a27672762
+  data.tar.gz: 2675aed77287c61387bdb1c3d1484d0a2eaa96d6fafff21ffca64cc0a2a12be3a4e0745906fd90f6f432524b6f87e7d7cb93da58f84e6dcca620662c0e7d99a4

data/Dockerfile

@@ -1,5 +1,5 @@
-FROM ruby:2.3.5
+FROM ruby:2.5.1
 
-RUN gem install morpheus-cli
+RUN gem install morpheus-cli -v 4.1.8
 
 ENTRYPOINT ["morpheus"]

data/README.md

@@ -1,6 +1,13 @@
-# Morpheus::Cli
+# Morpheus CLI
 
-Provides a command line interface for interacting with the Morpheus Cloud Platform. Easily provision servers, containers, and manage deployments.
+- Website: https://www.morpheusdata.com/
+- Guide: [Morpheus CLI Wiki](https://github.com/gomorpheus/morpheus-cli/wiki)
+- Docs: [Morpheus Documentation](https://docs.morpheusdata.com)
+- Support: [Morpheus Support](https://support.morpheusdata.com)
+
+<img src="https://www.morpheusdata.com/wp-content/uploads/2018/06/cropped-morpheus_highres.png" width="600px">
+
+This library is a Ruby gem that provides a command line interface for interacting with the Morpheus Data appliance. The features provided include provisioning clusters, hosts, and containers, deploying and monitoring applications, automating tasks, and much more.
 
 ## Installation
 
@@ -10,7 +17,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -18,12 +25,17 @@ Or install it yourself as:
 
 ## Usage
 
-Please check out the [Wiki](https://github.com/gomorpheus/morpheus-cli/wiki) for usage instructions.
+### morpheus binary
+
+This gem installs the [morpheus](https://github.com/gomorpheus/morpheus-cli/wiki/CLI-Manual) binary for executing commands in your shell environment. 
+
+```sh
+morpheus remote add demo https://demo.mymorpheus.com
+morpheus instances list
+```
+
+### ruby code
 
-## Contributing
+If you want to interface with your Morpheus appliance via ruby directly, you can use [Morpheus::APIClient](https://github.com/gomorpheus/morpheus-cli/wiki/APIClient) or [Morpheus::Terminal](https://github.com/gomorpheus/morpheus-cli/wiki/Terminal).
 
-1. Fork it ( https://github.com/[my-github-username]/morpheus-cli/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+For more detailed usage information, visit the [Morpheus CLI Wiki](https://github.com/gomorpheus/morpheus-cli/wiki).

data/lib/morpheus/api/api_client.rb

@@ -55,7 +55,7 @@ class Morpheus::APIClient
   def inspect
     to_s
   end
-  
+
   def dry_run(val=true)
     @dry_run = !!val
     self
@@ -339,6 +339,14 @@ class Morpheus::APIClient
     Morpheus::InstanceTypesInterface.new(@access_token, @refresh_token, @expires_at, @base_url).setopts(@options)
   end
 
+  def integrations
+    Morpheus::IntegrationsInterface.new(@access_token, @refresh_token, @expires_at, @base_url).setopts(@options)
+  end
+
+  def jobs
+    Morpheus::JobsInterface.new(@access_token, @refresh_token, @expires_at, @base_url).setopts(@options)
+  end
+
   def server_types
     Morpheus::ServerTypesInterface.new(@access_token, @refresh_token, @expires_at, @base_url).setopts(@options)
   end
@@ -399,6 +407,10 @@ class Morpheus::APIClient
     Morpheus::AccountsInterface.new(@access_token, @refresh_token, @expires_at, @base_url).setopts(@options)
   end
 
+  def approvals
+    Morpheus::ApprovalsInterface.new(@access_token, @refresh_token, @expires_at, @base_url).setopts(@options)
+  end
+
   def users
     Morpheus::UsersInterface.new(@access_token, @refresh_token, @expires_at, @base_url).setopts(@options)
   end

data/lib/morpheus/api/approvals_interface.rb

@@ -0,0 +1,35 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::ApprovalsInterface < Morpheus::APIClient
+  def initialize(access_token, refresh_token,expires_at = nil, base_url=nil, api='approvals')
+    @access_token = access_token
+    @refresh_token = refresh_token
+    @base_url = base_url
+    @api_url = "#{base_url}/api/#{api}"
+    @expires_at = expires_at
+  end
+
+  def list(params={})
+    url = @api_url
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def get(id, params={})
+    url = "#{@api_url}/#{id}"
+    headers = { params: {}, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def get_item(id, params={})
+    url = "#{@base_url}/api/approval-items/#{id}"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def update_item(id, action)
+    url = "#{@base_url}/api/approval-items/#{id}/#{action}"
+    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
+    execute(method: :put, url: url, headers: headers)
+  end
+end

data/lib/morpheus/api/integrations_interface.rb

@@ -0,0 +1,29 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::IntegrationsInterface < Morpheus::APIClient
+  def initialize(access_token, refresh_token,expires_at = nil, base_url=nil, api='integrations')
+    @access_token = access_token
+    @refresh_token = refresh_token
+    @base_url = base_url
+    @api_url = "#{base_url}/api/#{api}"
+    @expires_at = expires_at
+  end
+
+  def list(params={})
+    url = @api_url
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def get(id, params={})
+    url = "#{@api_url}/#{id}"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def update(payload, params={})
+    url = @api_url
+    headers = { params: params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
+    execute(method: :put, url: url, headers: headers, payload: payload.to_json)
+  end
+end

data/lib/morpheus/api/jobs_interface.rb

@@ -0,0 +1,86 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::JobsInterface < Morpheus::APIClient
+  def initialize(access_token, refresh_token,expires_at = nil, base_url=nil, api='jobs')
+    @access_token = access_token
+    @refresh_token = refresh_token
+    @base_url = base_url
+    @api_url = "#{base_url}/api/#{api}"
+    @expires_at = expires_at
+  end
+
+  def list(params={})
+    url = @api_url
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def get(id, params={})
+    url = "#{@api_url}/#{id}"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    if params.is_a?(Hash)
+      headers[:params].merge!(params)
+    elsif params.is_a?(Numeric)
+      url = "#{@api_url}/#{params}"
+    elsif params.is_a?(String)
+      headers[:params]['name'] = params
+    end
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def create(payload)
+    url = @api_url
+    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
+    execute(method: :post, url: url, headers: headers, payload: payload.to_json)
+  end
+
+  def update(id, payload, params={})
+    url = "#{@api_url}/#{id}"
+    headers = { params: params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
+    execute(method: :put, url: url, headers: headers, payload: payload.to_json)
+  end
+
+  def destroy(id, params={})
+    url = "#{@api_url}/#{id}"
+    headers = { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
+    execute(method: :delete, url: url, headers: headers)
+  end
+
+  def execute_job(id, params={})
+    url = "#{@api_url}/#{id}/execute"
+    headers = { params: params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
+    execute(method: :put, url: url, headers: headers)
+  end
+
+=begin
+  def list_job_executions(id, params={})
+    url = "#{@api_url}/#{id}/executions"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+=end
+
+  def list_executions(params={})
+    url = "#{@base_url}/api/job-executions"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def get_execution(id, params={})
+    url = "#{@base_url}/api/job-executions/#{id}"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def get_execution_event(id, event_id, params={})
+    url = "#{@base_url}/api/job-executions/#{id}/events/#{event_id}"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def options(jobTypeId, params={})
+    url = "#{@base_url}/api/job-options/#{jobTypeId}"
+    headers = { params: params, authorization: "Bearer #{@access_token}" }
+    execute(method: :get, url: url, headers: headers)
+  end
+end

data/lib/morpheus/cli.rb

@@ -98,6 +98,8 @@ module Morpheus
       load 'morpheus/cli/deploys.rb'
       load 'morpheus/cli/license.rb'
       load 'morpheus/cli/instance_types.rb'
+      load 'morpheus/cli/jobs_command.rb'
+      load 'morpheus/cli/integrations_command.rb'
       load 'morpheus/cli/security_groups.rb'
       load 'morpheus/cli/security_group_rules.rb'
       load 'morpheus/cli/clusters.rb'
@@ -153,6 +155,7 @@ module Morpheus
       load 'morpheus/cli/log_settings_command.rb'
       load 'morpheus/cli/whitelabel_settings_command.rb'
       load 'morpheus/cli/wiki_command.rb'
+      load 'morpheus/cli/approvals_command.rb'
 
       # Your new commands go here...
 

data/lib/morpheus/cli/appliance_settings_command.rb

@@ -3,9 +3,9 @@ require 'morpheus/cli/cli_command'
 class Morpheus::Cli::ApplianceSettingsCommand
   include Morpheus::Cli::CliCommand
   include Morpheus::Cli::AccountsHelper
-  set_command_hidden
-  set_command_name :'appliance-settings'
 
+  set_command_name :'appliance-settings'
+  set_command_hidden
   register_subcommands :get, :update
   
   set_default_subcommand :get
@@ -67,10 +67,10 @@ class Morpheus::Cli::ApplianceSettingsCommand
         "Default User Role" => lambda {|it| it['defaultUserRoleId'] },
         "Docker Privileged Mode" => lambda {|it| format_boolean(it['dockerPrivilegedMode']) },
         # User Management Settings
-        "Expire Password After" => lambda {|it| it['expirePwdDays'] == 0 ? 'Disabled' : it['expirePwdDays'] + ' Days' },
+        "Expire Password After" => lambda {|it| format_days(it['expirePwdDays']) },
         "Disable User After Attempts" => lambda {|it| it['disableAfterAttempts'] == 0 ? 'Disabled' : it['disableAfterAttempts']},
-        "Disable User if Inactive For" => lambda {|it| it['disableAfterDaysInactive'] == 0 ? 'Disabled' : it['disableAfterDaysInactive'] + ' Days' },
-        "Send warning email before deactivating" => lambda {|it| it['warnUserDaysBefore'] == 0 ? 'Disabled' : it['warnUserDaysBefore'] + ' Days' },
+        "Disable User if Inactive For" => lambda {|it| format_days(it['disableAfterDaysInactive']) },
+        "Send warning email before deactivating" => lambda {|it| format_days(it['warnUserDaysBefore']) },
         # Email Settings
         "SMTP From Address" => lambda {|it| it['smtpMailFrom'] },
         "SMTP Server" => lambda {|it| it['smtpServer'] },
@@ -160,10 +160,10 @@ class Morpheus::Cli::ApplianceSettingsCommand
         params['smtpPort'] = val == 'null' ? nil : val.to_i
       end
       opts.on("--smtp-ssl [on|off]", ['on','off'], "Use SSL for SMTP connections") do |val|
-        params['smtpSSL'] = ['true','on'].include?(val.to_s.strip)
+        params['smtpSSL'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == '1' || val.to_s == ''
       end
       opts.on("--smtp-tls [on|off]", ['on','off'], "Use TLS for SMTP connections") do |val|
-        params['smtpTLS'] = ['true','on'].include?(val.to_s.strip)
+        params['smtpTLS'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == '1' || val.to_s == ''
       end
       opts.on("--smtp-user STRING", String, "SMTP user") do |val|
         params['smtpUser'] = val == 'null' ? nil : val
@@ -298,4 +298,10 @@ class Morpheus::Cli::ApplianceSettingsCommand
       exit 1
     end
   end
+
+  private
+
+  def format_days(days)
+    days ? (days == 0 ? 'Disabled' : days + ' Days') : ''
+  end
 end

data/lib/morpheus/cli/approvals_command.rb

@@ -0,0 +1,236 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::ApprovalsCommand
+  include Morpheus::Cli::CliCommand
+  include Morpheus::Cli::AccountsHelper
+
+  set_command_name :'approvals'
+  set_command_hidden
+  register_subcommands :list, :get, :approve, :deny, :cancel
+  set_default_subcommand :list
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @approvals_interface = @api_client.approvals
+  end
+
+  def handle(args)
+    handle_subcommand(args)
+  end
+
+  def list(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage()
+      build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
+      opts.footer = "List approvals."
+    end
+    optparse.parse!(args)
+    connect(options)
+    if args.count != 0
+      raise_command_error "wrong number of arguments, expected 0 and got (#{args.count}) #{args}\n#{optparse}"
+      return 1
+    end
+
+    begin
+      params.merge!(parse_list_options(options))
+      @approvals_interface.setopts(options)
+      if options[:dry_run]
+        print_dry_run @approvals_interface.dry.list(params)
+        return
+      end
+      json_response = @approvals_interface.list(params)
+
+      render_result = render_with_format(json_response, options, 'approvals')
+      return 0 if render_result
+
+      title = "Morpheus Approvals"
+      subtitles = []
+      subtitles += parse_list_subtitles(options)
+      print_h1 title, subtitles
+
+      approvals = json_response['approvals']
+      if approvals.empty?
+        print yellow,"No approvals found.",reset,"\n"
+      else
+        rows = approvals.collect do |it|
+          {
+              id: it['id'],
+              name: it['name'] || (it['accountIntegration'] ? 'Pending' : 'Not Set'),
+              requestType: it['requestType'],
+              externalName: it['accountIntegration'] ? it['externalName'] || 'Pending' : 'N/A',
+              type: it['accountIntegration'] ? it['accountIntegration']['type'] : 'Internal',
+              status: it['status'],
+              dateCreated: format_local_dt(it['dateCreated']),
+              requestedBy: it['requestBy']
+          }
+        end
+        columns = [
+            :id, :name, :requestType, :externalName, :type, :status, :dateCreated, :requestedBy
+        ]
+        print as_pretty_table(rows, columns, options)
+        print_results_pagination(json_response)
+        print reset,"\n"
+      end
+      print reset,"\n"
+      return 0
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
+  def get(args)
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[approval]")
+      build_common_options(opts, options, [:json, :dry_run, :remote])
+      opts.footer = "Get details about a job.\n" +
+          "[approval] is required. Approval ID or name"
+    end
+    optparse.parse!(args)
+    if args.count != 1
+      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args}\n#{optparse}"
+    end
+    connect(options)
+    return _get(args[0], options)
+  end
+
+  def _get(approval_id, options = {})
+    params = {}
+    begin
+      @approvals_interface.setopts(options)
+
+      if !(approval_id.to_s =~ /\A\d{1,}\Z/)
+        approval = find_approval_by_name_or_id('approval', approval_id)
+
+        if !approval
+          print_red_alert "Approval #{approval_id} not found"
+          exit 1
+        end
+        approval_id = approval['id']
+      end
+
+      if options[:dry_run]
+        print_dry_run @approvals_interface.dry.get(approval_id, params)
+        return
+      end
+      json_response = @approvals_interface.get(approval_id, params)
+
+      render_result = render_with_format(json_response, options, 'approval')
+      return 0 if render_result
+
+      title = "Morpheus Approval"
+      subtitles = []
+      subtitles += parse_list_subtitles(options)
+      print_h1 title, subtitles
+
+      approval = json_response['approval']
+      print cyan
+      description_cols = {
+          "ID" => lambda {|it| it['id']},
+          "Name" => lambda {|it| it['name'] || (it['accountIntegration'] ? 'Pending' : 'Not Set')},
+          "Request Type" => lambda {|it| it['requestType']},
+          "External Name" => lambda {|it|it['accountIntegration'] ? it['externalName'] || 'Pending' : 'N/A'},
+          "Type" => lambda {|it| it['accountIntegration'] ? it['accountIntegration']['type'] : 'Internal'},
+          "Date Created" => lambda {|it| format_local_dt(it['dateCreated'])},
+          "Requested By" => lambda {|it| it['requestBy']}
+      }
+      print_description_list(description_cols, approval)
+
+      print_h2 "Requested Items"
+      approval_items = approval['approvalItems']
+
+      if approval_items && !approval_items.empty?
+        rows = approval_items.collect do |it|
+          {
+              id: it['id'],
+              name: it['name'] || 'Not Set',
+              external_name: it['externalName'] || 'N/A',
+              reference: it['reference'] ? it['reference']['displayName'] || it['reference']['name'] : '',
+              status: (it['status'] || '').capitalize,
+              created: format_local_dt(it['dateCreated']),
+              updated: format_local_dt(it['lastUpdated'])
+          }
+        end
+        columns = [
+            :id, :name, :external_name, :reference, :status, :created, :updated
+        ]
+        print as_pretty_table(rows, columns, options)
+      else
+        print yellow,"No requested items.",reset,"\n"
+      end
+
+      print reset,"\n"
+      return 0
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
+  def approve(args)
+    return _update_item(args, 'approve')
+  end
+
+  def deny(args)
+    return _update_item(args, 'deny')
+  end
+
+  def cancel(args)
+    return _update_item(args, 'cancel')
+  end
+
+  def _update_item(args, action)
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage( "[id]")
+      build_common_options(opts, options, [:json, :dry_run, :remote, :quiet])
+      opts.footer = "#{action.capitalize} item.\n[id] is required. Approval item ID"
+    end
+    optparse.parse!(args)
+    connect(options)
+    if args.count != 1
+      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args}\n#{optparse}"
+      return 1
+    end
+
+    begin
+      approval_item = @approvals_interface.get_item(args[0].to_i)['approvalItem']
+
+      if !approval_item
+        print_red_alert "Approval item #{args[0]} not found"
+        exit 1
+      end
+
+      @approvals_interface.setopts(options)
+      if options[:dry_run]
+        print_dry_run @approvals_interface.dry.update_item(approval_item['id'], action)
+        return
+      end
+      json_response = @approvals_interface.update_item(approval_item['id'], action)
+
+      if options[:json]
+        puts as_json(json_response, options)
+      elsif !options[:quiet]
+        if json_response['success']
+          print_green_success  "Approval item #{action} applied"
+          _get(approval_item['approval']['id'])
+        else
+          print_red_alert "Error updating approval item: #{json_response['msg'] || json_response['errors']}"
+        end
+      end
+      return 0
+    rescue RestClient::Exception => e
+      print_rest_exception(e, options)
+      exit 1
+    end
+  end
+
+  private
+
+  def find_approval_by_name_or_id(type, val)
+    (val.to_s =~ /\A\d{1,}\Z/) ? @approvals_interface.get(val.to_i)[typeCamelCase] : @approvals_interface.list({'name' => val})["approvals"].first
+  end
+end