rake-proxmox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e86b0404ad3fcc0965de8693897a4f295ec235da
+  data.tar.gz: 71ce3a0da918ad4f4b5f6c9ebfc64902809f91d5
+SHA512:
+  metadata.gz: b316f59fdbfb1f5765a332cf335ff35f00a893ed6fa11333eb08c104243f5f3818b90e66c1407ca996d693934fe7d32c67ba062a5ec3d954417318b286581af6
+  data.tar.gz: 9f7d69532019380f9c7053bb93b9172de8d50136603eb25693d2b4c2f25d054038042a6f522d1a4712fdc8a239a5c132ff8ff5e60add79fe23b894696cef7554

data/.gitignore

@@ -0,0 +1,10 @@
+/bin/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'files/**/*'
+    - 'vendor/**/*'
+    - 'config/**/*'
+    - Gemfile
+  DefaultFormatter: progress
+  DisplayStyleGuide: true
+  StyleGuideBaseURL: https://github.com/bbatsov/ruby-style-guide
+  ExtraDetails: true
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lehn@etracker.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rake-proxmox.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sebastian Lehn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Rake::Proxmox
+
+Inspired by [nledez/proxmox](https://github.com/nledez/proxmox)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rake-proxmox'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rake-proxmox
+
+Put following block in your `Rakefile`
+
+```ruby
+Rake::Proxmox::RakeTasks.new
+```
+
+## Usage
+
+Export needed environment variables to define which Proxmox cluster will be
+used.
+
+```bash
+export PROXMOX_PVE_CLUSTER=https://pve1.example.com:8006/api2/json/
+export PROXMOX_NODE=pve1
+export PROXMOX_REALM=pve
+export PROXMOX_USERNAME=vagrant
+export PROXMOX_PASSWORD=vagrant
+```
+
+Now, list all available tasks by calling
+
+```bash
+rake -T
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lehn-etracker/rake-proxmox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rake/proxmox"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rake/proxmox/proxmox_api.rb

@@ -0,0 +1,528 @@
+require 'rest_client'
+require 'json'
+
+module Rake
+  module Proxmox
+    # ProxmoxApi adopted from https://github.com/nledez/proxmox
+    # rubocop:disable Metrics/ClassLength
+    class ProxmoxApi
+      # Return connection status
+      # - connected
+      # - error
+      attr_reader :connection_status
+
+      # Create a object to manage a Proxmox server through API
+      #
+      # :call-seq:
+      #   new(pve_cluster, node, username, password, realm, ssl_options)
+      #   -> Proxmox
+      #
+      # Example:
+      #
+      #   Proxmox::Proxmox.new('https://the-proxmox-server:8006/api2/json/',
+      #                        'node', 'root', 'secret', 'pam',
+      #                        {verify_ssl: false})
+      #
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(pve_cluster, node, username, password, realm,
+                     ssl_options = {})
+        @pve_cluster = pve_cluster
+        @node = node
+        @username = username
+        @password = password
+        @realm = realm
+        @ssl_options = ssl_options
+        @connection_status = 'error'
+        @site = RestClient::Resource.new(@pve_cluster, @ssl_options)
+        @auth_params = create_ticket
+      end
+
+      def get(path, args = {})
+        http_action_get(path, args)
+      end
+
+      def post(path, args = {})
+        http_action_post(path, args)
+      end
+
+      def put(path, args = {})
+        http_action_put(path, args)
+      end
+
+      def delete(path)
+        http_action_delete(path)
+      end
+
+      # Get task status
+      #
+      # :call-seq:
+      #   task_status(task-id) -> String
+      #
+      # - taksstatus
+      # - taskstatus:exitstatus
+      #
+      # Example:
+      #
+      #   taskstatus \
+      #     'UPID:localhost:00051DA0:119EAABC:521CCB19:vzcreate:203:root@pam:'
+      #
+      # Examples return:
+      #   - running
+      #   - stopped:OK
+      #
+      def task_status(upid, node = @node)
+        data = http_action_get "nodes/#{node}/tasks/#{URI.encode upid}/status"
+        status = data['status']
+        exitstatus = data['exitstatus']
+        if exitstatus
+          "#{status}:#{exitstatus}"
+        else
+          status.to_s
+        end
+      end
+
+      # get task log
+      def task_log(upid, node = @node, start = 0, limit = 20)
+        data = {
+          start: start,
+          limit: limit
+        }
+        http_action_get("nodes/#{node}/tasks/#{URI.encode upid}/log", data)
+      end
+
+      # Get template list
+      #
+      # :call-seq:
+      #   templates -> Hash
+      #
+      # Return a Hash of all templates
+      #
+      # Example:
+      #
+      #   templates
+      #
+      # Example return:
+      #
+      #   {
+      #     'ubuntu-10.04-standard_10.04-4_i386' => {
+      #         'format' => 'tgz',
+      #         'content' => 'vztmpl',
+      #         'volid' => 'local:vztmpl/ubuntu-10.04-...d_10.04-4_i386.tar.gz',
+      #         'size' => 142126884
+      #     },
+      #     'ubuntu-12.04-standard_12.04-1_i386' => {
+      #         'format' => 'tgz',
+      #         'content' => 'vztmpl',
+      #         'volid' => 'local:vztmpl/ubuntu-12.04-...d_12.04-1_i386.tar.gz',
+      #          'size' => 130040792
+      #     }
+      #  }
+      #
+      def templates
+        data = http_action_get "nodes/#{@node}/storage/local/content"
+        template_list = {}
+        data.each do |ve|
+          name = ve['volid'].gsub(%r{local:vztmpl\/(.*).tar.gz}, '\1')
+          template_list[name] = ve
+        end
+        template_list
+      end
+
+      # Get CT list
+      #
+      # :call-seq:
+      #   lxc_get -> Hash
+      #
+      # Return a Hash of all lxc container
+      #
+      # Example:
+      #
+      #   lxc_get
+      #
+      # Example return:
+      #   {
+      #     '101' => {
+      #           'maxswap' => 536870912,
+      #           'disk' => 405168128,
+      #           'ip' => '192.168.1.5',
+      #           'status' => 'running',
+      #           'netout' => 272,
+      #           'maxdisk' => 4294967296,
+      #           'maxmem' => 536870912,
+      #           'uptime' => 3068073,
+      #           'swap' => 0,
+      #           'vmid' => '101',
+      #           'nproc' => '10',
+      #           'diskread' => 0,
+      #           'cpu' => 0.00031670581100007,
+      #           'netin' => 0,
+      #           'name' => 'test2.domain.com',
+      #           'failcnt' => 0,
+      #           'diskwrite' => 0,
+      #           'mem' => 22487040,
+      #           'type' => 'lxc',
+      #           'cpus' => 1
+      #     },
+      #     [...]
+      #   }
+      def lxc_get(node = @node)
+        data = http_action_get "nodes/#{node}/lxc"
+        ve_list = {}
+        data.each do |ve|
+          ve_list[ve['vmid']] = ve
+        end
+        ve_list
+      end
+
+      # Create CT container
+      #
+      # :call-seq:
+      #   lxc_post(ostemplate, vmid) -> String
+      #   lxc_post(ostemplate, vmid, options) -> String
+      #
+      # Return a String as task ID
+      #
+      # Examples:
+      #
+      #   lxc_post('ubuntu-10.04-standard_10.04-4_i386', 200)
+      #   lxc_post('ubuntu-10.04-standard_10.04-4_i386', 200, \
+      #     {'hostname' => 'test.test.com', 'password' => 'testt' })
+      #
+      # Example return:
+      #
+      #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzcreate:200:root@pam:
+      #
+      def lxc_post(ostemplate, vmid, config = {}, node = @node)
+        config['vmid'] = vmid
+        config['ostemplate'] = ostemplate
+        vm_definition = config.to_a.map { |v| v.join '=' }.join '&'
+
+        http_action_post("nodes/#{node}/lxc", vm_definition)
+      end
+
+      # Delete CT
+      #
+      # :call-seq:
+      #   lxc_delete(vmid) -> String
+      #
+      # Return a string as task ID
+      #
+      # Example:
+      #
+      #   lxc_delete(200)
+      #
+      # Example return:
+      #
+      #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzdelete:200:root@pam:
+      #
+      def lxc_delete(vmid, node = @node)
+        http_action_delete "nodes/#{node}/lxc/#{vmid}"
+      end
+
+      # Get CT status
+      #
+      # :call-seq:
+      #   lxc_delete(vmid) -> String
+      #
+      # Return a string as task ID
+      #
+      # Example:
+      #
+      #   lxc_delete(200)
+      #
+      # Example return:
+      #
+      #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzdelete:200:root@pam:
+      #
+      def lxc_status(vmid, node = @node)
+        http_action_get "nodes/#{node}/lxc/#{vmid}/status/current"
+      end
+
+      # Start CT
+      #
+      # :call-seq:
+      #   lxc_start(vmid) -> String
+      #
+      # Return a string as task ID
+      #
+      # Example:
+      #
+      #   lxc_start(200)
+      #
+      # Example return:
+      #
+      #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzstart:200:root@pam:
+      #
+      def lxc_start(vmid, node = @node)
+        http_action_post "nodes/#{node}/lxc/#{vmid}/status/start"
+      end
+
+      # Stop CT
+      #
+      # :call-seq:
+      #   lxc_stop(vmid) -> String
+      #
+      # Return a string as task ID
+      #
+      # Example:
+      #
+      #   lxc_stop(200)
+      #
+      # Example return:
+      #
+      #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzstop:200:root@pam:
+      #
+      def lxc_stop(vmid, node = @node)
+        http_action_post "nodes/#{node}/lxc/#{vmid}/status/stop"
+      end
+
+      # Shutdown CT
+      #
+      # :call-seq:
+      #   lxc_shutdown(vmid) -> String
+      #
+      # Return a string as task ID
+      #
+      # Example:
+      #
+      #   lxc_shutdown(200)
+      #
+      # Example return:
+      #
+      #   UPID:localhost:000BC66A:1279E395:521EFC4E:vzshutdown:200:root@pam:
+      #
+      def lxc_shutdown(vmid, node = @node)
+        http_action_post "nodes/#{node}/lxc/#{vmid}/status/shutdown"
+      end
+
+      # Get CT config
+      #
+      # :call-seq:
+      #   lxc_config(vmid) -> String
+      #
+      # Return a string as task ID
+      #
+      # Example:
+      #
+      #   lxc_config(200)
+      #
+      # Example return:
+      #
+      #   {
+      #     'quotaugidlimit' => 0,
+      #     'disk' => 0,
+      #     'ostemplate' => 'ubuntu-10.04-standard_10.04-4_i386.tar.gz',
+      #     'hostname' => 'test.test.com',
+      #     'nameserver' => '127.0.0.1 192.168.1.1',
+      #     'memory' => 256,
+      #     'searchdomain' => 'domain.com',
+      #     'onboot' => 0,
+      #     'cpuunits' => 1000,
+      #     'swap' => 256,
+      #     'quotatime' => 0,
+      #     'digest' => 'e7e6e21a215af6b9da87a8ecb934956b8983f960',
+      #     'cpus' => 1,
+      #     'storage' => 'local'
+      #   }
+      #
+      def lxc_config(vmid, node = @node)
+        http_action_get "nodes/#{node}/lxc/#{vmid}/config"
+      end
+
+      # Set CT config
+      #
+      # :call-seq:
+      #   lxc_config_set(vmid, parameters) -> Nil
+      #
+      # Return nil
+      #
+      # Example:
+      #
+      #   lxc_config(200, { 'swap' => 2048 })
+      #
+      # Example return:
+      #
+      #   nil
+      #
+      def lxc_config_set(vmid, data, node = @node)
+        http_action_put("nodes/#{node}/lxc/#{vmid}/config", data)
+      end
+
+      # LXC snapshot
+      def lxc_snapshot(vmid, snapname, desc, node = @node)
+        data = {
+          snapname: snapname,
+          description: desc
+        }
+        http_action_post("nodes/#{node}/lxc/#{vmid}/snapshot", data)
+      end
+
+      # LXC snapshot list
+      def lxc_snapshot_list(vmid, node = @node)
+        http_action_get("nodes/#{node}/lxc/#{vmid}/snapshot")
+      end
+
+      # LXC snapshot delete
+      def lxc_snapshot_delete(vmid, snapname, node = @node)
+        http_action_delete("nodes/#{node}/lxc/#{vmid}/snapshot/#{snapname}")
+      end
+
+      # Get VM list
+      def qemu_get
+        data = http_action_get "nodes/#{@node}/qemu"
+        ve_list = {}
+        data.each do |ve|
+          ve_list[ve['vmid']] = ve
+        end
+        ve_list
+      end
+
+      # Create VM container
+      def qemu_post(template, vmid, config = {})
+        config['vmid'] = vmid
+        config['template'] = "local%3Aisol%2F#{template}.iso"
+        config['kvm'] = 1
+        vm_definition = config.to_a.map { |v| v.join '=' }.join '&'
+
+        http_action_post("nodes/#{@node}/qemu", vm_definition)
+      end
+
+      # Delete VM
+      def qemu_delete(vmid)
+        http_action_delete "nodes/#{@node}/qemu/#{vmid}"
+      end
+
+      # Get VM status
+      def qemu_status(vmid)
+        http_action_get "nodes/#{@node}/qemu/#{vmid}/status/current"
+      end
+
+      # Start VM
+      def qemu_start(vmid)
+        http_action_post "nodes/#{@node}/qemu/#{vmid}/status/start"
+      end
+
+      # Stop VM
+      def qemu_stop(vmid)
+        http_action_post "nodes/#{@node}/qemu/#{vmid}/status/stop"
+      end
+
+      # Shutdown VM
+      def qemu_shutdown(vmid)
+        http_action_post "nodes/#{@node}/qemu/#{vmid}/status/shutdown"
+      end
+
+      # Get VM config
+      def qemu_config(vmid)
+        http_action_get "nodes/#{@node}/qemu/#{vmid}/config"
+      end
+
+      # Set VM config
+      def qemu_config_set(vmid, data)
+        http_action_put("nodes/#{@node}/qemu/#{vmid}/config", data)
+      end
+
+      # cluster Methods
+      def cluster_resources_get(type)
+        http_action_get("cluster/resources?type=#{type}")
+      end
+
+      # Backup VM
+      def vzdump_single(vmid, node = @node, storage = 'local',
+                        mode = 'snapshot', compress = 1, remove = 1, pigz = 1,
+                        lockwait = 5)
+        data = {
+          all: 0,
+          compress: compress,
+          storage: storage,
+          remove: remove,
+          pigz: pigz,
+          mode: mode,
+          lockwait: lockwait,
+          vmid: vmid
+        }
+        http_action_post("nodes/#{node}/vzdump", data)
+      end
+
+      # list storage
+      def list_storage(node = @node, storage = 'local')
+        http_action_get("nodes/#{node}/storage/#{storage}/content")
+      end
+
+      # upload lxc template
+      def upload_template(filename, node = @node, storage = 'local')
+        "Template #{filename} does not exist locally" unless File.file? filename
+        data = {
+          content: 'vztmpl',
+          filename: File.new(filename)
+        }
+        http_action_post("nodes/#{node}/storage/#{storage}/upload", data)
+      end
+
+      private
+
+      # Methods manages auth
+      def create_ticket
+        post_param = { username: @username, realm: @realm, password: @password }
+        @site['access/ticket'].post post_param do |resp, _req, _res, &_block|
+          if resp.code == 200
+            extract_ticket resp
+          else
+            @connection_status = 'error'
+          end
+        end
+      end
+
+      # Method create ticket
+      def extract_ticket(response)
+        data = JSON.parse(response.body)
+        ticket = data['data']['ticket']
+        csrf_prevention_token = data['data']['CSRFPreventionToken']
+        unless ticket.nil?
+          token = 'PVEAuthCookie=' + ticket.gsub!(/:/, '%3A').gsub!(/=/, '%3D')
+        end
+        @connection_status = 'connected'
+        {
+          CSRFPreventionToken: csrf_prevention_token,
+          cookie: token
+        }
+      end
+
+      # Extract data or return error
+      def check_response(response)
+        if response.code == 200
+          JSON.parse(response.body)['data']
+        else
+          'NOK: error code = ' + response.code.to_s \
+          + 'data = ' + response.body + "\n"
+        end
+      end
+
+      # Methods manage http dialogs
+      def http_action_post(url, data = {})
+        # print "POST #{url}\n#{data}\n"
+        @site[url].post data, @auth_params do |resp, _req, _res, &_block|
+          check_response resp
+        end
+      end
+
+      def http_action_put(url, data = {})
+        @site[url].put data, @auth_params do |resp, _req, _res, &_block|
+          check_response resp
+        end
+      end
+
+      def http_action_get(url, data = {})
+        @site[url].get @auth_params.merge(data) do |resp, _req, _res, &_block|
+          check_response resp
+        end
+      end
+
+      def http_action_delete(url)
+        @site[url].delete @auth_params do |resp, _req, _res, &_block|
+          check_response resp
+        end
+      end
+    end
+  end
+end

data/lib/rake/proxmox/version.rb

@@ -0,0 +1,5 @@
+module Rake
+  module Proxmox
+    VERSION = "0.1.0"
+  end
+end

data/lib/rake/proxmox.rb

@@ -0,0 +1,393 @@
+require 'rake/proxmox/version'
+require 'rake/proxmox/proxmox_api'
+require 'rake/tasklib'
+
+module Rake
+  module Proxmox
+    # This class provides rake tasks to control proxmox cluster through api.
+    #
+    # rubocop:disable Metrics/ClassLength
+    class RakeTasks < ::Rake::TaskLib
+      # @yield [self] gives itself to the block
+      # rubocop:disable Metrics/AbcSize
+      def initialize(ssl_options = {})
+        unless ENV.include?('PROXMOX_PVE_CLUSTER')
+          puts ''
+          puts '# Proxmox Tasks are not available without correct environment'
+          puts '#'
+          puts '# Please set following variables to enable that feature:'
+          puts '#'
+          puts '# export PROXMOX_PVE_CLUSTER='\
+            'https://pve1.example.com:8006/api2/json/'
+          puts '# export PROXMOX_NODE=pve1'
+          puts '# export PROXMOX_REALM=pve'
+          puts '# export PROXMOX_USERNAME=vagrant'
+          puts '# export PROXMOX_PASSWORD=vagrant'
+          puts ''
+          return false
+        end
+
+        @proxmox = Rake::Proxmox::ProxmoxApi.new(
+          ENV['PROXMOX_PVE_CLUSTER'],
+          ENV['PROXMOX_NODE'],
+          ENV['PROXMOX_USERNAME'],
+          ENV['PROXMOX_PASSWORD'],
+          ENV['PROXMOX_REALM'],
+          ssl_options
+        )
+
+        # container for current lxc status
+        @lxc_status = {}
+
+        yield self if block_given?
+        define
+      end
+
+      # @return [Proxmox] a Proxmox::Proxmox
+      attr_reader :proxmox
+
+      # @return [Hash] from Proxmox.lxc_get
+      attr_accessor :lxc_status
+
+      private
+
+      def update_lxc_status
+        # self.lxc_status = proxmox.lxc_get
+        proxmox.cluster_resources_get('vm').each do |vm|
+          # print "vm: #{vm}\n"
+          # print "vm: #{vm['name']} on #{vm['node']}\n"
+          next unless vm.include?('type')
+          next unless vm.include?('vmid')
+          next unless vm['type'] <=> 'lxc'
+          lxc_status[vm['vmid']] = vm
+        end
+        # print lxc_status
+      end
+
+      def wait_for_task(upid, node = nil)
+        max_n = 0
+        if upid.include?('NOK: error code')
+          print "Proxmox task failed #{upid}"
+          l = proxmox.task_log(upid, node, max_n)
+          return false unless l.is_a?(Array)
+          l.each do |log_entry|
+            next if log_entry['n'].to_i <= max_n
+            print "[#{log_entry['n']}] #{log_entry['t']}\n"
+            max_n = log_entry['n'].to_i
+          end
+          return false
+        end
+        status = proxmox.task_status(upid, node)
+        until status.include? ':'
+          sleep 1
+          print "waiting for task: '#{upid}' [#{status}]\n"
+          proxmox.task_log(upid, node, max_n).each do |log_entry|
+            next if log_entry['n'].to_i <= max_n
+            print "[#{log_entry['n']}] #{log_entry['t']}\n"
+            max_n = log_entry['n'].to_i
+          end
+          status = proxmox.task_status(upid, node)
+        end
+        (_final_status, exitstatus) = status.split(':')
+        if exitstatus.include?('OK')
+          print "waiting for task: '#{upid}' [#{exitstatus}]\n"
+          return true
+        end
+        proxmox.task_log(upid, node, max_n).each do |log_entry|
+          next if log_entry['n'].to_i <= max_n
+          print "[#{log_entry['n']}] #{log_entry['t']}\n"
+          max_n = log_entry['n'].to_i
+        end
+        print "waiting for task failed: '#{upid}' [#{exitstatus}]\n"
+        false
+      end
+
+      def lxc_stop(vmid)
+        prop = lxc_status[vmid]
+        return false unless prop.include?('status')
+        return false unless prop.include?('node')
+        return true if prop['status'].include?('stopped')
+        print "stopping CT #{vmid} (#{prop['name']})\n"
+        taskid = proxmox.lxc_stop(vmid, prop['node'])
+        wait_for_task(taskid, prop['node'])
+      end
+
+      def lxc_destroy(vmid)
+        prop = lxc_status[vmid]
+        return false unless prop.include?('name')
+        return false unless prop.include?('node')
+        print "destroy CT #{vmid} (#{prop['name']})\n"
+        taskid = proxmox.lxc_delete(vmid, prop['node'])
+        wait_for_task(taskid, prop['node'])
+      end
+
+      def lxc_snapshot(vmid, name, desc)
+        prop = lxc_status[vmid]
+        return false unless prop.include?('status')
+        return false unless prop.include?('node')
+        print "snapshot vmid: #{vmid} (#{prop['name']})\n"
+        taskid = proxmox.lxc_snapshot(vmid, name, desc, prop['node'])
+        wait_for_task(taskid, prop['node'])
+      end
+
+      def lxc_snapshot_list(vmid)
+        prop = lxc_status[vmid]
+        return false unless prop.include?('status')
+        return false unless prop.include?('node')
+        # print "snapshot list vmid: #{vmid} (#{prop['name']})\n"
+        l = proxmox.lxc_snapshot_list(vmid, prop['node'])
+        return false if l.is_a?(String)
+        l
+      end
+
+      def lxc_snapshot_delete(vmid, snapname)
+        prop = lxc_status[vmid]
+        return false unless prop.include?('status')
+        return false unless prop.include?('node')
+        print "snapshot delete #{snapname} vmid: #{vmid} (#{prop['name']})\n"
+        taskid = proxmox.lxc_snapshot_delete(vmid, snapname, prop['node'])
+        wait_for_task(taskid, prop['node'])
+      end
+
+      def lxc_backup(vmid, storage, mode = 'snapshot')
+        prop = lxc_status[vmid]
+        return false unless prop.include?('status')
+        return false unless prop.include?('node')
+        print "vzdump to #{storage} vmid: #{vmid} (#{prop['name']})\n"
+        taskid = proxmox.vzdump_single(vmid, prop['node'], storage, mode)
+        wait_for_task(taskid, prop['node'])
+      end
+
+      def lxc_restore(vmid, storage, backup_storage, backup, node = nil)
+        options = {
+          force: 1,
+          restore: 1,
+          storage: storage
+        }
+        prop = if node
+                 p = {}
+                 p['status'] = 'to-be-recovered'
+                 p['node'] = node.to_s
+                 # return p into prop
+                 p
+               else
+                 lxc_status[vmid]
+               end
+        return false unless prop.include?('status')
+        return false unless prop.include?('node')
+        put "vzrestore of #{storage}:#{file} to vmid: #{vmid} (#{prop['name']})"
+        taskid = proxmox.lxc_post("#{backup_storage}:#{backup}", vmid, options,
+                                  prop['node'])
+        wait_for_task(taskid, prop['node'])
+      end
+
+      # define Rake tasks
+      def define
+        desc 'Proxmox'
+        update_lxc_status
+        namespace 'proxmox' do
+          desc 'upload template to proxmox storage'
+          task 'storage:upload:template', %i[filename node storage] \
+            do |_t, args|
+            args.with_defaults(storage: 'local')
+            args.with_defaults(node: ENV['PROXMOX_NODE'])
+            # get upload filename
+            upload_file_split = File.split(args.filename)
+            upload_filename = upload_file_split[1]
+            # validate file does not already exist
+            should_i_upload = true
+            proxmox.list_storage(args.node, args.storage).each do |c|
+              (_c_storage, c_path) = c['volid'].split(':')
+              (_c_content, c_name) = c_path.split('/')
+              next unless c_name == upload_filename
+              puts "Template #{upload_filename} already on server"
+              should_i_upload = false
+              break
+            end
+            if should_i_upload
+              puts "upload template: #{args.filename} to #{args.storage}@#{args.node}:\n"
+              r = proxmox.upload_template(args.filename, args.node,
+                                          args.storage)
+              puts "upload result: #{r}"
+            end
+          end
+
+          desc 'list proxmox storage'
+          task 'storage:list', %i[node storage] do |_t, args|
+            args.with_defaults(storage: 'local')
+            args.with_defaults(node: ENV['PROXMOX_NODE'])
+            print "list_storage: #{args.storage}@#{args.node}:\n"
+            proxmox.list_storage(args.node, args.storage).each do |c|
+              print " content:#{c['content']} volid:#{c['volid']}\n"
+            end
+          end
+
+          desc 'list proxmox backups'
+          task 'backup:list', %i[vmid node storage] do |_t, args|
+            args.with_defaults(storage: 'local')
+            args.with_defaults(node: ENV['PROXMOX_NODE'])
+            $stderr.puts "backup list vmid:#{args.vmid} #{args.storage}@"\
+                           "#{args.node}:"
+            proxmox.list_storage(args.node, args.storage).each do |c|
+              # print " content:#{c['content']} volid:#{c['volid']}\n"
+              filename_parts = c['volid'].split('/')[1].split('.')[0].split('-')
+              next if filename_parts.count < 4
+              next if filename_parts[1].empty?
+              next unless filename_parts[1] <=> 'lxc' # must be lxc type
+              # get vmid of backup
+              file_vmid = filename_parts[2].to_i
+              next unless file_vmid.to_s == filename_parts[2]
+              next unless file_vmid == args.vmid.to_i
+              print "#{c['volid']}\n"
+            end
+          end
+
+          desc 'restore from vzdump [:vmid, :node'\
+               " :storage => 'local',"\
+               " :backup_storage => 'local',"\
+               ' :file]'
+          task 'backup:restore', %i[vmid
+                                    node
+                                    storage
+                                    backup_storage
+                                    file] do |_t, args|
+            print "restore args: #{args}\n"
+            id = args.vmid.to_i
+            args.with_defaults(storage: 'local')
+            args.with_defaults(backup_storage: 'local')
+            unless lxc_restore(id, args.storage, args.backup_storage,
+                               args.file, args.node)
+              raise "failed to restore #{id} from "\
+                      "#{args.storage}:#{args.file} to #{args.storage}\n"
+            end
+          end
+
+          desc 'destroy all but exclude_ids (defaulting to: 6002) separated by'\
+               ' colon(:)'
+          task 'destroy:all', %i[exclude_ids delete_low_ids] do |t, args|
+            args.with_defaults(exclude_ids: '6002')
+            args.with_defaults(delete_low_ids: 'false')
+            exclude_ids = args.exclude_ids.split(':').map(&:to_i)
+            b = { 'true' => true,
+                  true => true,
+                  'false' => false,
+                  false => false }
+            low_ids = b[args.delete_low_ids.downcase]
+            print "exclude_ids: #{exclude_ids}\n"
+
+            return false unless lxc_status
+
+            lxc_status.each do |id, prop|
+              next if exclude_ids.include?(id.to_i)
+              if !low_ids && id.to_i < 6000
+                raise "not allowed to destroy id: #{id} < low_ids (6000)"\
+                     " enable delete_low_ids deletion by executing \n"\
+                     "# rake #{t}[#{args.exclude_ids},true]"
+              end
+              unless lxc_stop(id)
+                raise "failed to stop #{id} (#{prop['name']})\n"
+              end
+              unless lxc_destroy(id)
+                raise "failed to destroy #{id} (#{prop['name']})\n"
+              end
+            end
+          end
+          # create snapshot of every container
+          desc 'snapshot all but exclude_ids (defaulting to: 6002) separated'\
+               ' by colon(:)'
+          task 'snapshot:create:all', %i[exclude_ids name desc] do |_t, args|
+            args.with_defaults(exclude_ids: '6002')
+            args.with_defaults(name: 'rakesnap1')
+            args.with_defaults(desc: 'snapshot taken by rake task')
+            exclude_ids = args.exclude_ids.split(':').map(&:to_i)
+            print "exclude_ids: #{exclude_ids}\n"
+
+            return false unless lxc_status
+
+            lxc_status.each do |id, prop|
+              next if exclude_ids.include?(id.to_i)
+              unless lxc_snapshot(id, args.name, args.desc)
+                raise "failed to snapshot #{id} (#{prop['name']})\n"
+              end
+            end
+          end
+          # delete all snapshots with specific name
+          desc 'delete all snapshots with :name'
+          task 'snapshot:delete:all', %i[exclude_ids name] do |_t, args|
+            args.with_defaults(exclude_ids: '6002')
+            args.with_defaults(name: 'rakesnap1')
+            exclude_ids = args.exclude_ids.split(':').map(&:to_i)
+            print "exclude_ids: #{exclude_ids}\n"
+
+            return false unless lxc_status
+
+            lxc_status.each do |id, prop|
+              next if exclude_ids.include?(id.to_i)
+              unless lxc_snapshot_delete(id, args.name)
+                raise "failed to delete snapshot #{snap['name']} from #{id} "\
+                     "(#{prop['name']})\n"
+              end
+            end
+          end
+          # add task for each lxc container
+          lxc_status.each do |id, prop|
+            desc "destroy #{prop['name']}"
+            task "destroy:#{prop['name']}" do
+              unless lxc_stop(id)
+                raise "failed to stop #{id} (#{prop['name']})\n"
+              end
+              unless lxc_destroy(id)
+                raise "failed to destroy #{id} (#{prop['name']})\n"
+              end
+            end
+            desc "backup #{prop['name']} [:storage => 'local',"\
+                 " :mode => 'snapshot']"
+            task "backup:create:#{prop['name']}", %i[storage mode] do |_t, args|
+              args.with_defaults(storage: 'local')
+              args.with_defaults(mode: 'snapshot')
+              unless lxc_backup(id, args.storage, args.mode)
+                raise "failed to backup #{id} (#{prop['name']})\n"
+              end
+            end
+            desc "restore #{prop['name']} [:storage => 'local',"\
+                 ' :file]'
+            task "backup:restore:#{prop['name']}", %i[storage
+                                                      backup_storage
+                                                      file] do |_t, args|
+              args.with_defaults(storage: 'local')
+              args.with_defaults(backup_storage: 'local')
+              unless lxc_restore(id, args.storage, args.backup_storage,
+                                 args.file)
+                raise "failed to restore #{id} (#{prop['name']}) from "\
+                        "#{args.storage}:#{args.file} to #{args.storage}\n"
+              end
+            end
+            desc "snapshot #{prop['name']}"
+            task "snapshot:create:#{prop['name']}", %i[name desc] do |_t, args|
+              args.with_defaults(name: 'rakesnap1')
+              args.with_defaults(desc: 'snapshot taken by rake task')
+              unless lxc_snapshot(id, args.name, args.desc)
+                raise "failed to snapshot #{id} (#{prop['name']})\n"
+              end
+            end
+            lxc_snap_list = lxc_snapshot_list(id)
+            next if lxc_snap_list == false
+            lxc_snap_list.each do |snap|
+              next unless snap.include?('name')
+              next if snap['name'] == 'current'
+              desc "snapshot #{snap['name']} from #{prop['name']} "\
+                   "(#{snap['description'].tr("\n", ' ').gsub(/ $/, '')})"
+              task "snapshot:delete:#{prop['name']}:#{snap['name']}"\
+                do |_t, _args|
+                unless lxc_snapshot_delete(id, snap['name'])
+                  raise "failed to delete snapshot #{snap['name']} of #{id}"\
+                       " (#{prop['name']})\n"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rake-proxmox.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake/proxmox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rake-proxmox'
+  spec.version       = Rake::Proxmox::VERSION
+  spec.authors       = ['Sebastian Lehn']
+  spec.email         = ['lehn@etracker.com']
+
+  spec.summary       = 'Provides rake tasks for proxmox api'
+  spec.description   = 'Provides rake tasks to manage proxmox cluster'
+  spec.homepage      = 'https://github.com/lehn-etracker/rake-proxmox'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  
+  spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+  spec.add_runtime_dependency 'json', '~> 2.1'
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: rake-proxmox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian Lehn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Provides rake tasks to manage proxmox cluster
+email:
+- lehn@etracker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rake/proxmox.rb
+- lib/rake/proxmox/proxmox_api.rb
+- lib/rake/proxmox/version.rb
+- rake-proxmox.gemspec
+homepage: https://github.com/lehn-etracker/rake-proxmox
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Provides rake tasks for proxmox api
+test_files: []