vmfloaty 0.11.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 248dd5c9a8890b8990a7dad8dd7a21f52c8a8c2b65112c55449a5b5d3ac818af
-  data.tar.gz: 22cf2070b571a0feded3967308e6b11d42b5ea296d94be7c434a73454611f6df
+  metadata.gz: 3250656d33ed86eadaeded7da8f91b1c320f38ee9e8637d657273b43dab897f4
+  data.tar.gz: 1b78092a62379ee36ce7c78dc52a0f7920366dc15e3795edc4c2be3a33a53f15
 SHA512:
-  metadata.gz: 8cd836baeb4a37720024616f1ce113046fc6291cc73694edbaf74ee727648c1339ada9e004ba0d630822a315948d69bb9e6c67da1ec04df3ae079bf207a432c7
-  data.tar.gz: 46e15ff3d3d1cecd68cb92ed3fcd5d8240f68f45f704dff9fbf1e87007cae7b95b2d6f9d4b08753979b2c82fa6f412534a93e3bb17b96fb052003e821b31cf94
+  metadata.gz: 3f0bab1c9aeda1ecc76b0246faac85267528ae2cc9708bf9ca430134e1535af701d565be9a1a4f32566d4d07d21d6a02e73d4d9f3188183206a6bbcb1274796d
+  data.tar.gz: 020e1ffbc61da0d7784e453229e82c737939ff864d0c9a7a36d4ed563827a01a2328681d5832a808f0dd0613e26fd4f07b81f9769df3be72a5dd85111cd4505f

data/README.md

@@ -14,9 +14,8 @@ A CLI helper tool for [Puppet's vmpooler](https://github.com/puppetlabs/vmpooler
   - [Example workflow](#example-workflow)
   - [vmfloaty dotfile](#vmfloaty-dotfile)
     - [Basic configuration](#basic-configuration)
-    - [Default to Puppet's ABS instead of vmpooler](#default-to-puppets-abs-instead-of-vmpooler)
-    - [Configuring multiple services](#configuring-multiple-services)
-    - [Using a Nonstandard Pooler service](#using-a-nonstandard-pooler-service)
+    - [Using multiple services](#using-multiple-services)
+    - [Using backends besides VMPooler](#using-backends-besides-vmpooler)
     - [Valid config keys](#valid-config-keys)
   - [Tab Completion](#tab-completion)
 - [vmpooler API](#vmpooler-api)
@@ -54,6 +53,7 @@ $ floaty --help
     modify     Modify a VM's tags, time to live, disk space, or reservation reason
     query      Get information about a given vm
     revert     Reverts a vm to a specified snapshot
+    service    Display information about floaty services and their configuration
     snapshot   Takes a snapshot of a given vm
     ssh        Grabs a single vm and sshs into it
     status     Prints the status of pools in the pooler service
@@ -90,95 +90,32 @@ floaty get centos-7-x86_64=2 debian-7-x86_64 windows-10=3 --token mytokenstring
 
 ### vmfloaty dotfile
 
-If you do not wish to continually specify various config options with the cli, you can have a dotfile in your home directory for some defaults. For example:
+If you do not wish to continually specify various config options with the cli, you can `~/.vmfloaty.yml` for some defaults. You can get a list of valid service types and example configuration files via `floaty service types` and `floaty service examples`, respectively.
 
 #### Basic configuration
 
-```yaml
-# file at ~/.vmfloaty.yml
-url: 'https://vmpooler.example.net/api/v1'
-user: 'brian'
-token: 'tokenstring'
-```
-
-Now vmfloaty will use those config files if no flag was specified.
-
-#### Default to Puppet's ABS instead of vmpooler
+This is the simplest type of configuration where you only need a single service:
 
 ```yaml
 # file at ~/.vmfloaty.yml
-url: 'https://abs.example.net'
+url: 'https://vmpooler.example.net/api/v1'
 user: 'brian'
 token: 'tokenstring'
-type: 'abs'
 ```
 
-#### Configuring multiple services
+Run `floaty service examples` to see additional configuration options
 
-Most commands allow you to specify a `--service <servicename>` option to allow the use of multiple vmpooler instances. This can be useful when you'd rather not specify a `--url` or `--token` by hand for alternate services.
+#### Using multiple services
 
-To configure multiple services, you can set up your `~/.vmfloaty.yml` config file like this:
-
-```yaml
-# file at /Users/me/.vmfloaty.yml
-user: 'brian'
-services:
-  main:
-    url: 'https://vmpooler.example.net/api/v1'
-    token: 'tokenstring'
-  alternate:
-    url: 'https://vmpooler.example.com/api/v1'
-    token: 'alternate-tokenstring'
-```
+Most commands allow you to specify a `--service <servicename>` option to allow the use of multiple pooler instances. This can be useful when you'd rather not specify a `--url` or `--token` by hand for alternate services.
 
 - If you run `floaty` without a `--service <name>` option, vmfloaty will use the first configured service by default.
-  With the config file above, the default would be to use the 'main' vmpooler instance.
 - If keys are missing for a configured service, vmfloaty will attempt to fall back to the top-level values.
-  With the config file above, 'brian' will be used as the username for both configured services, since neither specifies a username.
-
-Examples using the above configuration:
-
-List available vm types from our main vmpooler instance:
-
-```bash
-floaty list --service main
-# or, since the first configured service is used by default:
-floaty list
-```
-
-List available vm types from our alternate vmpooler instance:
-
-```bash
-floaty list --service alternate
-```
+  This makes it so you can specify things like `user` once at the top of your `~/.vmfloaty.yml`.
 
-#### Using a Nonstandard Pooler service
+#### Using backends besides VMPooler
 
-vmfloaty is capable of working with Puppet's [nonstandard pooler](https://github.com/puppetlabs/nspooler) in addition to the default vmpooler API. To add a nonstandard pooler service, specify an API `type` value in your service configuration, like this:
-
-```yaml
-# file at /Users/me/.vmfloaty.yml
-user: 'brian'
-services:
-  vm:
-    url: 'https://vmpooler.example.net/api/v1'
-    token: 'tokenstring'
-  ns:
-    url: 'https://nspooler.example.net/api/v1'
-    token: 'nspooler-tokenstring'
-    type: 'nonstandard'  # <-- 'type' is necessary for any non-vmpooler service
-  abs:
-    url: 'https://abs.example.net/'
-    token: 'abs-tokenstring'
-    type: 'abs'  # <-- 'type' is necessary for any non-vmpooler service
-
-```
-
-With this configuration, you could list available OS types from nspooler like this:
-
-```bash
-floaty list --service ns
-```
+vmfloaty supports additional backends besides VMPooler. To see a complete list, run `floaty service types`. The output of `floaty service examples` will show you how to configure each of the supported backends.
 
 #### Valid config keys
 
@@ -190,6 +127,7 @@ Here are the keys that vmfloaty currently supports:
 - url (String)
 - services (String)
 - type (String)
+- vmpooler_fallback (String)
 
 ### Tab Completion
 
@@ -207,6 +145,12 @@ If you are running on macOS and use Homebrew's `bash-completion` formula, you ca
 ln -s $(floaty completion --shell bash) /usr/local/etc/bash_completion.d/floaty
 ```
 
+There is also tab completion for zsh:
+
+```zsh
+source $(floaty completion --shell zsh)
+```
+
 ## vmpooler API
 
 This cli tool uses the [vmpooler API](https://github.com/puppetlabs/vmpooler/blob/master/API.md).

data/extras/completions/floaty.bash

@@ -2,29 +2,37 @@
 
 _vmfloaty()
 {
-  local cur prev subcommands template_subcommands hostname_subcommands
+  local cur prev commands template_arg_commands hostname_arg_commands service_subcommands
+
   COMPREPLY=()
   cur="${COMP_WORDS[COMP_CWORD]}"
   prev="${COMP_WORDS[COMP_CWORD-1]}"
 
-  subcommands="delete get help list modify query revert snapshot ssh status summary token"
-  template_subcommands="get ssh"
-  hostname_subcommands="delete modify query revert snapshot"
+  commands="delete get help list modify query revert service snapshot ssh status summary token"
+  template_arg_commands="get ssh"
+  hostname_arg_commands="delete modify query revert snapshot"
+  service_subcommands="types examples"
 
   if [[ $cur == -* ]] ; then
     # TODO: option completion
     COMPREPLY=()
-  elif [[ $template_subcommands =~ (^| )$prev($| ) ]] ; then
+  elif [[ $template_arg_commands =~ (^| )$prev($| ) ]] ; then
     if [[ -z "$_vmfloaty_avail_templates" ]] ; then
+      # TODO: need a --hostnameonly equivalent here because the section headers of
+      # `floaty list` are adding some spurious entries (including files in current
+      # directory because part of the headers is `**` which is getting expanded)
       _vmfloaty_avail_templates=$(floaty list 2>/dev/null)
     fi
 
     COMPREPLY=( $(compgen -W "${_vmfloaty_avail_templates}" -- "${cur}") )
-  elif [[ $hostname_subcommands =~ (^| )$prev($| ) ]] ; then
-    _vmfloaty_active_hostnames=$(floaty list --active 2>/dev/null | grep '^-' | cut -d' ' -f2)
+  elif [[ $hostname_arg_commands =~ (^| )$prev($| ) ]] ; then
+    _vmfloaty_active_hostnames=$(floaty list --active --hostnameonly 2>/dev/null)
     COMPREPLY=( $(compgen -W "${_vmfloaty_active_hostnames}" -- "${cur}") )
-  else
-    COMPREPLY=( $(compgen -W "${subcommands}" -- "${cur}") )
+  elif [[ "service" == $prev ]] ; then
+    COMPREPLY=( $(compgen -W "${service_subcommands}" -- "${cur}") )
+  elif [[ $1 == $prev ]] ; then
+    # only show top level commands we are at root
+    COMPREPLY=( $(compgen -W "${commands}" -- "${cur}") )
   fi
 }
 complete -F _vmfloaty floaty

data/extras/completions/floaty.zsh

@@ -0,0 +1,43 @@
+_floaty()
+{
+  local line commands template_arg_commands hostname_arg_commands service_subcommands
+
+  commands="delete get help list modify query revert service snapshot ssh status summary token"
+
+  template_arg_commands=("get" "ssh")
+  hostname_arg_commands=("delete" "modify" "query" "revert" "snapshot")
+  service_subcommands=("types" "examples")
+
+  _arguments -C \
+    "1: :(${commands})" \
+    "*::arg:->args"
+
+  if ((template_arg_commands[(Ie)$line[1]])); then
+    _floaty_template_sub
+  elif ((hostname_arg_commands[(Ie)$line[1]])); then
+    _floaty_hostname_sub
+  elif [[ "service" == $line[1] ]]; then
+    _arguments "1: :(${service_subcommands})"
+  fi
+}
+
+_floaty_template_sub()
+{
+  if [[ -z "$_vmfloaty_avail_templates" ]] ; then
+    # TODO: need a --hostnameonly equivalent here because the section headers of
+    # `floaty list` are adding some spurious entries (including files in current
+    # directory because part of the headers is `**` which is getting expanded)
+    _vmfloaty_avail_templates=$(floaty list 2>/dev/null)
+  fi
+
+  _arguments "1: :(${_vmfloaty_avail_templates})"
+}
+
+_floaty_hostname_sub()
+{
+  _vmfloaty_active_hostnames=$(floaty list --active --hostnameonly 2>/dev/null)
+
+  _arguments "1: :(${_vmfloaty_active_hostnames})"
+}
+
+compdef _floaty floaty

data/lib/vmfloaty.rb

@@ -20,7 +20,7 @@ class Vmfloaty
 
   def run # rubocop:disable Metrics/AbcSize
     program :version, Vmfloaty::VERSION
-    program :description, "A CLI helper tool for Puppet's vmpooler to help you stay afloat"
+    program :description, "A CLI helper tool for Puppet's vmpooler to help you stay afloat.\n\nConfiguration may be placed in a ~/.vmfloaty.yml file."
 
     config = Conf.read_config
 
@@ -39,8 +39,13 @@ class Vmfloaty
       c.option '--force', 'Forces vmfloaty to get requested vms'
       c.option '--json', 'Prints retrieved vms in JSON format'
       c.option '--ondemand', 'Requested vms are provisioned upon receival of the request, tracked by a request ID'
+      c.option '--continue STRING', String, 'resume polling ABS for job_id, for use when the cli was interrupted'
+      c.option '--loglevel STRING', String, 'the log level to use (debug, info, error)'
       c.action do |args, options|
         verbose = options.verbose || config['verbose']
+        if options.loglevel
+          FloatyLogger.setlevel = options.loglevel
+        end
         service = Service.new(options, config)
         use_token = !options.notoken
         force = options.force
@@ -52,6 +57,11 @@ class Vmfloaty
 
         os_types = Utils.generate_os_hash(args)
 
+        if os_types.empty?
+          FloatyLogger.error 'No operating systems provided to obtain. See `floaty get --help` for more information on how to get VMs.'
+          exit 1
+        end
+
         max_pool_request = 5
         large_pool_requests = os_types.select { |_, v| v > max_pool_request }
         if !large_pool_requests.empty? && !force
@@ -60,12 +70,7 @@ class Vmfloaty
           exit 1
         end
 
-        if os_types.empty?
-          FloatyLogger.error 'No operating systems provided to obtain. See `floaty get --help` for more information on how to get VMs.'
-          exit 1
-        end
-
-        response = service.retrieve(verbose, os_types, use_token, options.ondemand)
+        response = service.retrieve(verbose, os_types, use_token, options.ondemand, options.continue)
         request_id = response['request_id'] if options.ondemand
         response = service.wait_for_request(verbose, request_id) if options.ondemand
 
@@ -87,23 +92,47 @@ class Vmfloaty
       c.option '--verbose', 'Enables verbose output'
       c.option '--service STRING', String, 'Configured pooler service name'
       c.option '--active', 'Prints information about active vms for a given token'
+      c.option '--json', 'Prints information as JSON'
+      c.option '--hostnameonly', 'When listing active vms, prints only hostnames, one per line'
       c.option '--token STRING', String, 'Token for pooler service'
       c.option '--url STRING', String, 'URL of pooler service'
+      c.option '--user STRING', String, 'User to authenticate with'
+      c.option '--loglevel STRING', String, 'the log level to use (debug, info, error)'
       c.action do |args, options|
         verbose = options.verbose || config['verbose']
+        if options.loglevel
+          FloatyLogger.setlevel = options.loglevel
+        end
 
         service = Service.new(options, config)
         filter = args[0]
 
         if options.active
           # list active vms
-          running_vms = service.list_active(verbose)
+          if service.type == "ABS"
+            # this is actually job_ids
+            running_vms = service.list_active_job_ids(verbose, service.url, service.user)
+          else
+            running_vms = service.list_active(verbose)
+          end
           host = URI.parse(service.url).host
           if running_vms.empty?
-            puts "You have no running VMs on #{host}"
+            if options.json
+              puts {}.to_json
+            else
+              FloatyLogger.info "You have no running VMs on #{host}"
+            end
           else
-            puts "Your VMs on #{host}:"
-            Utils.pretty_print_hosts(verbose, service, running_vms)
+            if options.json
+              puts Utils.get_host_data(verbose, service, running_vms).to_json
+            elsif options.hostnameonly
+              Utils.get_host_data(verbose, service, running_vms).each do |hostname, host_data|
+                Utils.print_fqdn_for_host(service, hostname, host_data)
+              end
+            else
+              puts "Your VMs on #{host}:"
+              Utils.pretty_print_hosts(verbose, service, running_vms)
+            end
           end
         else
           # list available vms from pooler
@@ -116,7 +145,7 @@ class Vmfloaty
     command :query do |c|
       c.syntax = 'floaty query hostname [options]'
       c.summary = 'Get information about a given vm'
-      c.description = 'Given a hostname from the pooler service, vmfloaty with query the service to get various details about the vm.'
+      c.description = 'Given a hostname from the pooler service, vmfloaty with query the service to get various details about the vm. If using ABS, you can query a job_id'
       c.example 'Get information about a sample host', 'floaty query hostname --url http://vmpooler.example.com'
       c.option '--verbose', 'Enables verbose output'
       c.option '--service STRING', String, 'Configured pooler service name'
@@ -155,7 +184,12 @@ class Vmfloaty
           FloatyLogger.error 'ERROR: Provide a hostname or specify --all.'
           exit 1
         end
-        running_vms = modify_all ? service.list_active(verbose) : hostname.split(',')
+        running_vms =
+            if modify_all
+              service.list_active(verbose)
+            else
+              hostname.split(',')
+            end
 
         tags = options.tags ? JSON.parse(options.tags) : nil
         modify_hash = {
@@ -179,7 +213,7 @@ class Vmfloaty
           end
           if ok
             if modify_all
-              puts 'Successfully modified all VMs.'
+              puts "Successfully modified all #{running_vms.count} VMs."
             else
               puts "Successfully modified VM #{hostname}."
             end
@@ -200,10 +234,17 @@ class Vmfloaty
       c.option '--service STRING', String, 'Configured pooler service name'
       c.option '--all', 'Deletes all vms acquired by a token'
       c.option '-f', 'Does not prompt user when deleting all vms'
+      c.option '--json', 'Outputs hosts scheduled for deletion as JSON'
       c.option '--token STRING', String, 'Token for pooler service'
       c.option '--url STRING', String, 'URL of pooler service'
+      c.option '--user STRING', String, 'User to authenticate with'
+      c.option '--loglevel STRING', String, 'the log level to use (debug, info, error)'
       c.action do |args, options|
         verbose = options.verbose || config['verbose']
+        if options.loglevel
+          FloatyLogger.setlevel = options.loglevel
+        end
+
         service = Service.new(options, config)
         hostnames = args[0]
         delete_all = options.all
@@ -213,14 +254,25 @@ class Vmfloaty
         successes = []
 
         if delete_all
-          running_vms = service.list_active(verbose)
+          if service.type == "ABS"
+            # this is actually job_ids
+            running_vms = service.list_active_job_ids(verbose, service.url, service.user)
+          else
+            running_vms = service.list_active(verbose)
+          end
           if running_vms.empty?
-            puts 'You have no running VMs.'
+            if options.json
+              puts {}.to_json
+            else
+              FloatyLogger.info "You have no running VMs."
+            end
           else
-            Utils.pretty_print_hosts(verbose, service, running_vms, true)
-            # Confirm deletion
             confirmed = true
-            confirmed = agree('Delete all these VMs? [y/N]') unless force
+            unless force
+              Utils.pretty_print_hosts(verbose, service, running_vms, true)
+              # Confirm deletion
+              confirmed = agree('Delete all these VMs? [y/N]')
+            end
             if confirmed
               response = service.delete(verbose, running_vms)
               response.each do |hostname, result|
@@ -256,10 +308,15 @@ class Vmfloaty
         end
 
         unless successes.empty?
-          FloatyLogger.info unless failures.empty?
-          puts 'Scheduled the following VMs for deletion:'
-          successes.each do |hostname|
-            puts "- #{hostname}"
+          if options.json
+            puts successes.to_json
+          else
+            puts 'Scheduled the following VMs for deletion:'
+            output = ''
+            successes.each do |hostname|
+              output += "- #{hostname}\n"
+            end
+            puts output
           end
         end
 
@@ -331,8 +388,12 @@ class Vmfloaty
       c.option '--service STRING', String, 'Configured pooler service name'
       c.option '--url STRING', String, 'URL of pooler service'
       c.option '--json', 'Prints status in JSON format'
+      c.option '--loglevel STRING', String, 'the log level to use (debug, info, error)'
       c.action do |_, options|
         verbose = options.verbose || config['verbose']
+        if options.loglevel
+          FloatyLogger.setlevel = options.loglevel
+        end
         service = Service.new(options, config)
         if options.json
           pp service.status(verbose)
@@ -459,6 +520,70 @@ class Vmfloaty
       end
     end
 
+    command :service do |c|
+      c.syntax = 'floaty service <types examples>'
+      c.summary = 'Display information about floaty services and their configuration'
+      c.description = 'Display information about floaty services to aid in setting up a configuration file.'
+      c.example 'Print a list of the valid service types', 'floaty service types'
+      c.example 'Print a sample config file with multiple services', 'floaty service examples'
+      c.example 'list vms from the service named "nspooler-prod"', 'floaty list --service nspooler-prod'
+      c.action do |args, options|
+        action = args.first
+
+        example_config = Utils.strip_heredoc(<<-CONFIG)
+          # Sample ~/.vmfloaty.yml with just vmpooler
+          user: 'jdoe'
+          url: 'https://vmpooler.example.net'
+          token: '456def789'
+
+          # Sample ~/.vmfloaty.yml with multiple services
+          # Note: when the --service is not specified on the command line,
+          # the first service listed here is selected automatically
+          user: 'jdoe'
+          services:
+            abs-prod:
+              type: 'abs'
+              url: 'https://abs.example.net/api/v2'
+              token: '123abc456'
+              vmpooler_fallback: 'vmpooler-prod'
+            nspooler-prod:
+              type: 'nspooler'
+              url: 'https://nspooler.example.net'
+              token:  '789ghi012'
+            vmpooler-dev:
+              type: 'vmpooler'
+              url: 'https://vmpooler-dev.example.net'
+              token: '987dsa654'
+            vmpooler-prod:
+              type: 'vmpooler'
+              url: 'https://vmpooler.example.net'
+              token: '456def789'
+
+        CONFIG
+
+        types_output = Utils.strip_heredoc(<<-TYPES)
+          The values on the left below can be used in ~/.vmfloaty.yml as the value of type:
+
+          abs:       Puppet's Always Be Scheduling
+          nspooler:  Puppet's Non-standard Pooler, aka NSPooler
+          vmpooler:  Puppet's VMPooler
+        TYPES
+
+        case action
+        when 'examples'
+          FloatyLogger.info example_config
+        when 'types'
+          FloatyLogger.info types_output
+        when nil
+          FloatyLogger.error 'No action provided'
+          exit 1
+        else
+          FloatyLogger.error "Unknown action: #{action}"
+          exit 1
+        end
+      end
+    end
+
     run!
   end
 end