nex_client 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 727229b96317d3a2a14803712ad8bc5cc3df368b
-  data.tar.gz: db3eee696bbee741e2dcb307b4217c033b549c09
+  metadata.gz: 08b088941d2119c0e8b7e1e61bdcf74dd622ba60
+  data.tar.gz: acf4d046a21edeb0e95873c7dfbeda06e25df751
 SHA512:
-  metadata.gz: da2bf4d72a045db4bbb98d6b42c890ad6f767530f562c8a4ee3869e852c5b407f38290be1f55f9a8891318e52de63a62bbfc515aa407d4d30eb0ffc120740008
-  data.tar.gz: f6baf5690f4d3c8a6dcaecbc706d0fe757cf190052ca5ff585a87654240ebd86b69b01dfe16ad241bb7d73083a6a37a5af5b80e1efac5c58ecba5bd152f5be6e
+  metadata.gz: e39b32c047894a572757b5b90317ad1d0dfc9f78f27a4ffe3db123266539ae0924ee5632b0a88c223f778fd4b0c8e97efcf6a64abedd40a3f8434f9982cddcf6
+  data.tar.gz: bad64e27e601910f2445c6247f63aa7bddd669bb5409fbc592262e901908dc71030b313c613ad10047d2b1d5e523ddf5f679aee67a9c1c3d22e8300a630aa208

data/lib/nex_client.rb

@@ -13,6 +13,7 @@ module NexClient
   autoload :CubeTemplate, 'nex_client/cube_template'
   autoload :Domain, 'nex_client/domain'
   autoload :Event, 'nex_client/event'
+  autoload :ExecTask, 'nex_client/exec_task'
   autoload :GatewayRack, 'nex_client/gateway_rack'
   autoload :Me, 'nex_client/me'
   autoload :Organization, 'nex_client/organization'

data/lib/nex_client/cli.rb

@@ -24,7 +24,7 @@ module NexClient
         c.example 'list all including terminated addons', 'nex-cli addons --all'
         c.option '--all', 'list all addons (no filtering)'
         c.option '--status <active|terminated>', String, 'list all addons in a given status'
-        c.option '--service <mysql|redis>', String, 'list all addons for a specific service'
+        c.option '--service <mysql|redis|mongo26|kafka|minio>', String, 'list all addons for a specific service'
         c.action do |args, options|
           NexClient::Commands::Addons.list(args,options)
         end
@@ -33,7 +33,7 @@ module NexClient
       command :'addons:create' do |c|
         c.syntax = 'nex-cli addons:create SERVICE APP_NAME'
         c.summary = 'Create addons'
-        c.description = 'Create addons for your apps. Available addons: mysql | redis | mongo26'
+        c.description = 'Create addons for your apps. Available addons: mysql | redis | mongo26 | kafka | minio'
         c.example 'create mysql addon for myapp', 'nex-cli addons:create mysql myapp'
         c.example 'create redis addon for myapp', 'nex-cli addons:create redis myapp'
         c.option '--size SIZE', Integer, 'specify container size (default: 2, min: 1, max: 20). Container will have N shares of CPU and N*128M of memory.'
@@ -332,7 +332,64 @@ module NexClient
       command :'apps:update' do |c|
         c.syntax = 'nex-cli apps:update APP_NAME [options]'
         c.summary = 'Update apps settings'
-        c.description = 'Update application settings'
+        c.description = <<~HEREDOC
+          Update general application settings and behaviour
+
+          Log drain:
+          ----------
+          Use: --http-log-drain DRAIN_URL
+          The log drain is a HTTP(s) URL where application logs will be POSTed.
+
+          Default region:
+          ---------------
+          Use: --region REGION
+          Containers will be deployed in the specified region by default if no region-balancing
+          policies have been specified. This is only relevant when the Nex!™ platform has been deployed in multiple regions.
+
+          Geo-Balancing:
+          ---------------
+          Use: --region-balancing REGIONS
+          Specify how your containers should be distributed across the available Nex!™ regions. This is only relevant when the Nex!™ platform has been deployed
+          in multiple regions.
+
+          Options are the following:
+            - evenly distribute across all regions: --region-balancing=all
+            - eventy distribute across specified regions: --region-balancing="ap-southeast-1,us-west-2"
+            - distribute with relative weights: --region-balancing="ap-southeast-1=1,us-west-2=2"
+
+          Web Application Firewall (WAF)
+          ------------------------------
+          Use: --waf-rules [PATH]
+          Specify a JSON (.json) or YAML (.yml) file describing the security rules to apply/ignore. If no files are specified you will be prompted to
+          paste rules in JSON format in the terminal.
+          The WAF always runs in SIMULATE mode by default - this means security events will be logged but no requests will be blocked.
+
+          The list of base rules applied by default is available here: https://github.com/p0pr0ck5/lua-resty-waf/tree/master/rules
+
+          The base WAF behaviour can be extended by passing a JSON (or YAML) manifest to '--waf-rules' with the following format:
+            {
+              // Whether the WAF should be enabled, disabled or do log-only
+              // 'ACTIVE', 'INACTIVE' or 'SIMULATE'
+              "mode": "SIMULATE",
+
+              // Array of rule IDs to ignore
+              "ignore_rule": [],
+
+              // Array of rulesets to ignore
+              "ignore_ruleset": [],
+
+              // Array of ['rulename','rule'] objects
+              "add_ruleset_string": [],
+
+              // Rules sieves allow you to apply/ignore rules based on a
+              // specific context such as request parameters
+              // Array of ['rule_id', [{ sieve_cond }, { sieve_cond }] ] objects
+              "sieve_rule": []
+            }
+          See this for more info: https://github.com/p0pr0ck5/lua-resty-waf
+          See this for rule sieves: https://github.com/p0pr0ck5/lua-resty-waf/wiki/Rule-Sieves
+
+        HEREDOC
         c.example 'change container size to 4', 'nex-cli apps:update myapp --size 4'
         c.example 'balance containers equally between regions', 'nex-cli apps:update myapp --region-balancing="ap-southeast-1,us-west-2"'
         c.example 'deploy more containers in one region', 'nex-cli apps:update myapp --region-balancing="ap-southeast-1=1,us-west-2=2"'
@@ -344,6 +401,7 @@ module NexClient
         c.option '--tags TAG_LIST', String, 'comma separated list of tags to use to describe the app'
         c.option '--region REGION', String, 'default region to use deploy/scale this application'
         c.option '--region-balancing REGIONS', String, 'specify how the app should be proportionally distributed geographically. E.g. "all" or "ap-southeast-1,us-west-2" or "ap-southeast-1=1,us-west-2=2". [restart required]'
+        c.option '--waf-rules [PATH]', String, 'specify web application firewall rules using JSON or YAML file (prompt will appear otherwise). [restart required]'
         c.action do |args, options|
           NexClient::Commands::Apps.update(args,options)
         end
@@ -594,6 +652,69 @@ module NexClient
         end
       end
 
+      command :'exec-tasks' do |c|
+        c.syntax = 'nex-cli exec-tasks [EXECUTOR_NAME] [options]'
+        c.summary = 'Manage execution tasks'
+        c.description = 'List executions tasks (all or for specific resources)'
+        c.example 'list all execution tasks', 'nex-cli exec-tasks'
+        c.example 'list all execution tasks for cube 111-222-333', 'nex-cli exec-tasks 111-222-333'
+        c.action do |args, options|
+          NexClient::Commands::ExecTasks.list(args,options)
+        end
+      end
+
+      command :'exec-tasks:info' do |c|
+        c.syntax = 'nex-cli exec-tasks:info [TASK_ID] [options]'
+        c.summary = 'Display an execution task'
+        c.description = 'Display an execution task'
+        c.example 'Display execution tasks aaaa-2222', 'nex-cli exec-tasks:info aaaa-2222'
+        c.action do |args, options|
+          NexClient::Commands::ExecTasks.info(args,options)
+        end
+      end
+
+      command :'exec-tasks:create' do |c|
+        c.syntax = 'nex-cli exec-tasks:create [options]'
+        c.summary = 'Create execution task'
+        c.description = <<~HEREDOC
+          Create execution task for a resource such as a cube, app, addon or rack
+
+          Crontab Format:
+          ----------------
+          * * * * *
+          - - - - -
+          | | | | +-------------------> day of week (0 - 6) (Sunday=0)
+          | | | +-----------------> month (1 - 12)
+          | | +---------------> day of month (1 - 31)
+          | +-------------> hour (0 - 23)
+          +-----------> min (0 - 59)
+        HEREDOC
+        c.example 'Create task for cube 111-222', 'nex-cli exec-tasks:create --cube 111-222'
+        c.example 'Create task for app myapp', 'nex-cli exec-tasks:create --app myapp'
+        c.example 'Create task for addon myaddon', 'nex-cli exec-tasks:create --addon myaddon'
+        c.example 'Create task for rack 10.0.1.1', 'nex-cli exec-tasks:create --rack 10.0.1.1'
+        c.option '--app APP_NAME', String, 'name of the app to attach this task to'
+        c.option '--addon ADDON_NAME', String, 'name of the addon to attach this task to'
+        c.option '--crontab CRON_EXPRESSION', String, 'frequency expressed as cron expression'
+        c.option '--cube CUBE_ID', String, 'id of the cube to attach this task to'
+        c.option '--name TASK_NAME', String, 'name of this task'
+        c.option '--rack RACK_IP', String, 'IP of the rack to attach this task to'
+        c.option '--script SCRIPT_PATH', String, 'path to shell script'
+        c.action do |args, options|
+          NexClient::Commands::ExecTasks.create(args,options)
+        end
+      end
+
+      command :'exec-tasks:delete' do |c|
+        c.syntax = 'nex-cli exec-tasks:delete CNAME'
+        c.summary = 'Delete execution task'
+        c.description = 'Permanently delete an execution task'
+        c.example 'Delete task aaaa-2222', 'nex-cli exec-tasks:delete aaaa-2222'
+        c.action do |args, options|
+          NexClient::Commands::ExecTasks.destroy(args,options)
+        end
+      end
+
       command :organizations do |c|
         c.syntax = 'nex-cli organizations [options]'
         c.summary = 'List organizations'

data/lib/nex_client/commands.rb

@@ -8,6 +8,7 @@ module NexClient
     autoload :CubeInstances, 'nex_client/commands/cube_instances'
     autoload :CubeTemplates, 'nex_client/commands/cube_templates'
     autoload :Domains, 'nex_client/commands/domains'
+    autoload :ExecTasks, 'nex_client/commands/exec_tasks'
     autoload :Helpers, 'nex_client/commands/helpers'
     autoload :Organizations, 'nex_client/commands/organizations'
     autoload :Racks, 'nex_client/commands/racks'

data/lib/nex_client/commands/apps.rb

@@ -14,7 +14,7 @@ module NexClient
       OPTS_HEADERS = ['key','value'].map(&:upcase)
 
       SCM_TITLE = "Source Control Management".colorize(:yellow)
-      SCM_HEADERS = ['provider','repo','branch','last commit','webhook'].map(&:upcase)
+      SCM_HEADERS = ['key','value'].map(&:upcase)
 
       def self.list(args,opts)
         filters = {}
@@ -203,6 +203,18 @@ module NexClient
         # Hash#dup is required for the resource to detect changes
         attrs[:opts] = (e.opts || {}).dup.merge(self.extract_config_options(opts))
 
+        if opts.waf_rules
+          waf_rules = begin
+            if opts.waf_rules.is_a?(String)
+              hash_from_file(opts.waf_rules)
+            else
+              val = ask("Copy/paste your WAF configuration below in JSON format:") { |q| q.gather = "" }
+              JSON.parse(val.join(""))
+            end
+          end
+          attrs[:opts]['waf_rules'] = waf_rules
+        end
+
         # Update
         e.update_attributes(attrs)
 
@@ -430,25 +442,26 @@ module NexClient
       end
 
       def self.display_options(list)
-        table = Terminal::Table.new title: OPTS_TITLE, headings: OPTS_HEADERS do |t|
+        table = Terminal::Table.new title: OPTS_TITLE, headings: OPTS_HEADERS, style: { all_separators: true} do |t|
           [list].flatten.compact.each do |e|
-            e.each { |k,v| t.add_row([k,v]) }
+            e.each do |k,v|
+              val = v.is_a?(Hash) ? JSON.pretty_generate(v) : v
+              t.add_row([k,val])
+            end
           end
         end
         puts table
         puts "\n"
       end
-
+      
       def self.display_scm(list)
         table = Terminal::Table.new title: SCM_TITLE, headings: SCM_HEADERS do |t|
           [list].flatten.compact.each do |e|
-            t.add_row([
-              e['provider'],
-              e['repo'],
-              e['branch'],
-              e['last_commit'] || '- nothing pushed yet -',
-              e['webhook_enabled'].to_s == 'true' ? e['webhook_url'] : '- Not enabled -'
-            ])
+            t.add_row(['provider',e['provider']])
+            t.add_row(['repo',e['repo']])
+            t.add_row(['branch',e['branch']])
+            t.add_row(['last_commit',e['last_commit'] || '- nothing pushed yet -'])
+            t.add_row(['webhook',e['webhook_enabled'].to_s == 'true' ? e['webhook_url'] : '- Not enabled -'])
           end
         end
         puts table

data/lib/nex_client/commands/exec_tasks.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+module NexClient
+  module Commands
+    module ExecTasks
+      extend Helpers
+
+      EXEC_TASKS_TITLE = "Execution Tasks".colorize(:magenta)
+      EXEC_TASKS_HEADERS = ['id','name','active','crontab','last_run','next_run','executor'].map(&:upcase)
+      SCRIPT_TITLE = "Script".colorize(:magenta)
+
+      def self.list(args,opts)
+        filters = {}
+        filters[:'executor.name'] = args.first if args.first.present?
+
+        # Create table
+        list = NexClient::ExecTask.includes(:executor).where(filters).order('name')
+        self.display_exec_tasks(list)
+
+        # Loop through results
+        while (list.pages.links||{})['next']
+          return true if ask("Press enter for next page ('q' to quit)") =~ /q/
+          list = list.pages.next
+          self.display_exec_tasks(list)
+        end
+      end
+
+      def self.info(args,opts)
+        id = args.first
+        e = NexClient::ExecTask.includes(:executor).find(id).first
+
+        # Display error
+        unless e
+          error("Error! Could not find exec_task: #{id}")
+          return false
+        end
+
+        # Display task
+        self.display_exec_tasks(e)
+
+        # Display script
+        self.format_script(e)
+      end
+
+      # Create a new execution task
+      def self.create(args,opts)
+        case
+        when opts.cube
+          executor = NexClient::CubeInstance.find(uuid: opts.cube).first
+        when opts.app
+          executor = NexClient::App.find(name: opts.app).first
+        when opts.addon
+          executor ||= NexClient::Addon.find(name: opts.addon).first
+        when opts.rack
+          [
+            NexClient::ComputeRack,
+            NexClient::GatewayRack,
+            NexClient::RoutingRack,
+            NexClient::StorageRack
+          ].each do |server_type|
+            executor ||= server_type.find(private_ip_address: opts.rack).first
+          end
+        else
+          error("You need to specify an executor. For help: nex-cli exec-tasks:create -h")
+          return false
+        end
+
+        # Display error
+        unless executor
+          error("Error! Could not find executor")
+          return false
+        end
+
+        # Ask for additional details
+        script = opts.script.present? ? File.read(opts.script) : ask("Copy/paste your script below:") { |q| q.gather = "" }
+        name = opts.name.present? ? opts.name : ask("Enter the name of this task: ")
+        crontab = opts.crontab.present? ? opts.crontab : ask("Enter a cron expression (m h d M w): ")
+
+        exec_task = NexClient::ExecTask.new(
+          name: name,
+          script: script.join("\n"),
+          crontab: crontab
+        )
+        exec_task.relationships.attributes = { executor: { data: { type: executor.type, id: executor.id } } }
+        exec_task.save
+
+        # Display errors if any
+        if exec_task.errors.any?
+          display_record_errors(exec_task)
+          return false
+        end
+
+        # Display task
+        e = NexClient::ExecTask.includes(:executor).find(exec_task.id).first
+        self.display_exec_tasks(e)
+        self.format_script(e)
+      end
+
+      def self.destroy(args,opts)
+        id = args.first
+        e = NexClient::ExecTask.includes(:executor).find(id).first
+
+        # Display error
+        unless e
+          error("Error! Could not find exec_task: #{id}")
+          return false
+        end
+
+        # Ask confirmation
+        answer = ask("Enter the id of this task to confirm: ")
+        unless answer == e.id
+          error("Aborting deletion...")
+          return false
+        end
+
+        e.destroy
+        success("Successfully destroyed task: #{id}")
+      end
+
+      def self.display_exec_tasks(list)
+        table = Terminal::Table.new title: EXEC_TASKS_TITLE, headings: EXEC_TASKS_HEADERS do |t|
+          [list].flatten.compact.each do |e|
+            t.add_row(self.format_record(e))
+          end
+        end
+        puts table
+        puts "\n"
+      end
+
+      def self.format_record(record)
+        executor = self.format_executor(record)
+        [
+          record.id,
+          record.name,
+          record.active,
+          record.crontab,
+          record.last_run_at,
+          record.next_run_at,
+          executor
+        ]
+      end
+
+      def self.format_script(record)
+        table = Terminal::Table.new title: SCRIPT_TITLE do |t|
+          t.add_row([record.script])
+        end
+        puts table
+        puts "\n"
+      end
+
+      def self.format_executor(record)
+        return '-' unless o = record.executor
+        type = o.type.singularize.gsub('_instance','')
+        "#{type}:#{o.name}"
+      end
+    end
+  end
+end

data/lib/nex_client/commands/helpers.rb

@@ -124,6 +124,14 @@ module NexClient
         end
       end
 
+      def hash_from_file(file)
+        if file =~ /(\.yml|\.yaml)$/
+          YAML.load_file(file)
+        else
+          JSON.parse(File.read(file))
+        end
+      end
+
       # Parse plain or yaml file
       def vars_from_file(file,prefix = nil,&block)
         # YAML file

data/lib/nex_client/compute_rack.rb

@@ -6,5 +6,11 @@ module NexClient
     property :total_pu, type: :int
     property :available_pu, type: :int
     property :used_pu, type: :int
+    property :private_ip_address, type: :string
+
+    # Alias method does not seem to work properly
+    def name
+      private_ip_address
+    end
   end
 end

data/lib/nex_client/exec_task.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module NexClient
+  class ExecTask < BaseResource
+    property :active, type: :boolean
+    property :created_at, type: :time
+    property :updated_at, type: :time
+    property :last_run_at, type: :time
+    property :next_run_at, type: :time
+  end
+end

data/lib/nex_client/gateway_rack.rb

@@ -3,5 +3,11 @@ module NexClient
   class GatewayRack < BaseResource
     property :created_at, type: :time
     property :updated_at, type: :time
+    property :private_ip_address, type: :string
+
+    # Alias method does not seem to work properly
+    def name
+      private_ip_address
+    end
   end
 end

data/lib/nex_client/routing_rack.rb

@@ -3,5 +3,11 @@ module NexClient
   class RoutingRack < BaseResource
     property :created_at, type: :time
     property :updated_at, type: :time
+    property :private_ip_address, type: :string
+
+    # Alias method does not seem to work properly
+    def name
+      private_ip_address
+    end
   end
 end

data/lib/nex_client/storage_rack.rb

@@ -6,5 +6,11 @@ module NexClient
     property :total_su, type: :int
     property :available_su, type: :int
     property :used_su, type: :int
+    property :private_ip_address, type: :string
+
+    # Alias method does not seem to work properly
+    def name
+      private_ip_address
+    end
   end
 end

data/lib/nex_client/version.rb

@@ -1,3 +1,3 @@
 module NexClient
-  VERSION ||= '0.16.0'
+  VERSION ||= '0.17.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nex_client
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Arnaud Lachaume
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-06 00:00:00.000000000 Z
+date: 2017-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -144,6 +144,7 @@ files:
 - lib/nex_client/commands/cube_instances.rb
 - lib/nex_client/commands/cube_templates.rb
 - lib/nex_client/commands/domains.rb
+- lib/nex_client/commands/exec_tasks.rb
 - lib/nex_client/commands/helpers.rb
 - lib/nex_client/commands/organizations.rb
 - lib/nex_client/commands/racks.rb
@@ -154,6 +155,7 @@ files:
 - lib/nex_client/cube_template.rb
 - lib/nex_client/domain.rb
 - lib/nex_client/event.rb
+- lib/nex_client/exec_task.rb
 - lib/nex_client/gateway_rack.rb
 - lib/nex_client/me.rb
 - lib/nex_client/organization.rb