pve 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2f41d6fba5690429b625a55d147bf468834c1e705d6e73fdcd879566037dd47
+  data.tar.gz: 5237da733be939f52f26818f6c12a20d2389c5a26e8ba7343cbce62bcb280001
+SHA512:
+  metadata.gz: adfe44900fc74f93932b12ffed27abced7d33e04c910fad519b406755d8d9f9de140347341da45a3a35d4e315f4c5e7b5286af2ec4fbdf6ec2f9116a94221224
+  data.tar.gz: 3b55ec2a97b1973ae66d08e17cb50c70ec765305292748fe306bb99e3dd30bf33a46c5bc824570a8786e832c767f422e4da814ad14dd0497ab83ec707d46e0e9

data/.gitignore

@@ -0,0 +1,2 @@
+*.sw[pomnqrst]
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    pve (0.1.1)
+      activesupport (>= 2)
+      dencli (~> 0.3.1)
+      ipaddress (~> 0.8.3)
+      pmap (~> 1.1)
+      rest-client (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.8)
+    dencli (0.3.1)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    ipaddress (0.8.3)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
+    netrc (0.11.0)
+    pmap (1.1.1)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  pve!
+  rspec (~> 3.2)
+
+BUNDLED WITH
+   2.2.15

data/README.adoc

@@ -0,0 +1,22 @@
+Proxmox Virtual Environment High Level API for Ruby
+===================================================
+
+This is a limited, but easier to use library for ruby.
+It provides additional a command line interface for administration named `pvecli`.
+The Rest-API will be used for controlling your server.
+
+You need to provide a config-file `/etc/pve/pvecli.yml`:
+
+	auth:
+		username: USERNAME
+		password: PASSWORD
+		realm:    pve or something like that
+	connect:
+		verify_tls: no if you do not use known CA-signed X509-Certificates
+
+pvecli
+======
+
+This tool should usable like PVE-WebGUI, instead of low-level-tools like `pct`
+or user-unfriendlier tools like `pvesh`.
+So `pvecli` provides a global control over your cluster on command line.

data/bin/pvecli

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'pathname'
+$:.unshift Pathname.new(__FILE__).dirname.dirname.join('lib').to_s
+require 'pve/cli'
+PVE::Cli.new.call *ARGV

data/lib/pve.rb

@@ -0,0 +1,4 @@
+module PVE
+end
+
+require_relative 'pve/proxmox'

data/lib/pve/cli.rb

@@ -0,0 +1,159 @@
+require 'dencli'
+require 'yaml'
+
+require 'pve'
+require_relative 'helper'
+require_relative 'cli/base'
+require_relative 'cli/ct'
+require_relative 'cli/ha'
+require_relative 'cli/task'
+require_relative 'cli/qm'
+require_relative 'cli/node'
+
+class UsageError <RuntimeError
+end
+
+class PVE::Cli
+  attr_reader :cfg, :cli
+
+  def connect
+    @conn ||=
+      Proxmox.connect cfg[:auth][:username], cfg[:auth][:password],
+        realm: cfg[:auth][:realm], **cfg[:connect]
+    #RestClient.log = STDERR
+    @conn
+  end
+
+  def initialize config_file = nil
+    config_file ||= '/etc/pve/pvecli.yml'
+    @cfg =
+      YAML.safe_load File.read( config_file), [], [], false,
+        config_file, symbolize_names: true
+    @cli = DenCli.new File.basename($0), "PVE CLI"
+    @interactive = false
+    prepare
+  end
+
+  def interactive?
+    @interactive
+  end
+
+  def enter host, *args
+    r = host.enter *args
+    STDERR.puts "! #{$?.exitstatus}"  unless r
+  end
+
+  def wait_state host, state, timeout: nil, lock: nil
+    spinners = %w[- / | \\]
+    spin = 0
+    r =
+      host.wait state, lock: lock, timeout: timeout, secs: 0.2 do |state, lock|
+        lock = " (locked: #{lock})"  if lock
+        STDERR.printf "\r[%s] %s Still %s%s...\e[J\n", host.name, spinners[spin = (spin + 1) % 4], state, lock
+      end
+    STDERR.printf "\r\e[J"
+    exit 1  unless interactive?  and  r
+  end
+
+  def wait task, secs: nil, text: nil
+    secs ||= 0.1
+    spinners, spin, logn = "▖▘▝▗", 0, 0
+    STDERR.puts task.upid
+    loop do
+      s = task.status
+      if s[:exitstatus]
+        STDERR.printf "\r[%s] %s %s\e[J\n",
+          task.host ? task.host.name : s[:id],
+          case s[:exitstatus]
+          when "OK" then "\e[32;1m✓\e[0m"
+          else "\e[31;1m✗\e[0m"
+          end,
+          s[:status]
+        return task
+      end
+      log = task.log start: logn
+      log = []  if [{n: 1, t: 'no content'}] == log
+      unless log.empty?
+        STDERR.printf "\r\e[J"
+        log.each {|l| puts l[:t] }
+        logn = log.last[:n]
+      end
+      STDERR.printf "\r[%s] \e[33;1m%s\e[0m %s...\e[J", task.host ? task.host.name : s[:id], spinners[spin = (spin + 1) % 4], text || "Working"
+      sleep secs
+    end
+  end
+
+  def start host, node: nil, timeout: nil, fire: nil, secs: nil
+    timeout ||= 30
+    if node
+      task = host.migrate Proxmox::Node.find_by_name!( node)
+      wait task, text: "Migrating"
+    end
+    if host.running?
+      STDERR.puts "Already running."
+      return
+    end
+    task = host.start
+    unless fire
+      wait task, text: "Starting"
+    end
+  end
+
+  def stop host, timeout: nil, fire: nil, secs: nil
+    timeout ||= 30
+    if host.stopped?
+      STDERR.puts "Already stopped."
+      return
+    end
+    task = host.stop
+    unless fire
+      wait task, text: "Stopping"
+    end
+  end
+
+  def create klass, template, timeout: nil, fire: nil, secs: nil, start: nil, **options
+    options[:start] = true  if fire and start
+    task = klass.create template, **options
+    return  if fire
+    wait task, text: "Creating"
+    host = task.host.refresh!
+    start host, timeout: timeout, secs: secs
+  end
+
+  def destroy ct, timeout: nil, fire: nil, secs: nil
+    task = ct.destroy
+    unless fire
+      wait task, text: "Destroying"
+    end
+  end
+
+  def help cl, *args
+    STDERR.puts cl.help( *args)
+    exit 1  unless interactive?
+  end
+
+  def opts_wait cl
+    cl.
+      opt( :timeout, "-t", "--timeout=TIMEOUT", "Wait for max TIMEOUT seconds (default: endless)", default: nil).
+      opt( :secs, "-s", "--seconds=SECONDS", "Check every SECONDS for state (default: 0.2)", default: 0.2).
+      opt( :fire, "-f", "--[no-]fire", "Do not wait till running", default: false)
+  end
+
+  def prepare
+    cli_node
+    cli_ct
+    cli_qm
+    cli_task
+    cli_ha
+    cli_base
+  end
+
+  def call *argv
+    cli.call *argv
+  rescue RestClient::ExceptionWithResponse
+    STDERR.puts "#$! - #{$!.response} (#{$!.class})", $!.backtrace.map {|b|"  #{b}"}
+  rescue UsageError, DenCli::UsageError
+    STDERR.puts $!
+    exit 1
+  end
+end

data/lib/pve/cli/base.rb

@@ -0,0 +1,187 @@
+require 'pmap'
+
+class PVE::Cli
+
+def cli_base
+  cli.cmd :list, "List CT/VM-IDs", aliases: ['ls'], &lambda {|target=nil|
+    connect
+    nodes = Proxmox::Node.all
+    nodes.
+      flat_map {|n| [ n.method(:lxc), n.method(:qemu) ] }.
+      flat_pmap {|m| m.call.map {|c| c.vmid.to_i } }.
+      sort.
+      each {|c| puts c }
+  }
+
+  cli.cmd( :status, "Lists Nodes/VMs/CTs with status", &lambda {|target=nil, sort: 'n', node: nil|
+    connect
+    node &&= /\A#{node}\z/
+    to = TablizedOutput.new %w[Status HA ID Name Host Uptime CPU/% Mem/MiB Mem/% Disk/MiB Disk/%]
+    push =
+      if target
+        target = /\A#{target}\z/
+        lambda {|n| to.virt n  if n === target }
+      else
+        lambda {|n| to.virt n }
+      end
+    nodes = Proxmox::Node.all
+    nodes.
+      select {|n| not node or n === node }.
+      flat_map {|n| [ n.method(:lxc), n.method(:qemu) ] }.
+      each {|m| m.call.each &push }
+    to.print order: sort.each_char.map {|c| (2*c.ord[5]-1) * (' sainhucmd'.index( c.downcase)) }
+  }).
+    opt( :sort, '-s', '--sort=COLUMNS', "Sort by COLUMNs eg hn for host and name ([s]tatus, h[a], [i]d, [n]ame (default), [h]ost, [u]ptime, [c]pu, [m]em, [d]isk)").
+    opt( :node, '-n', '--node=NODE', "List only hosted by this NODE")
+
+  def prepare_show_config cnf
+    r = {}
+    cnf.each do |k,v|
+      case k
+      when :network
+        v.each do |net|
+          s =
+            net.
+              reject {|k, v| :card == k }.
+              sort_by {|k, v| :name == k ? :AAAAAAAAA : k }.
+              map {|k, v| case v when true then [k,1] when false then [k,0] else [k,v] end }.
+              map {|k, v| "#{k}=#{v}" }
+          r[net[:card].to_sym] = s.join(",")
+        end
+      when :sshkeys
+        r[k] = CGI.unescape(v).gsub( /^/, " "*14).gsub /\A {14}|\n\z/, ''
+      else
+        case v
+        when true then v = 1
+        when false then v = 0
+        end
+        r[k] = v.to_s.gsub( /$^/, " "*14).gsub /\n\z/, ''
+      end
+    end
+    r
+  end
+
+  def show_config cnf, old = nil
+    cnf = prepare_show_config cnf
+    if old
+      old = prepare_show_config old
+      (cnf.keys+old.keys).uniq.sort.each do |k|
+        v, o = cnf[k], old[k]
+        if v == o
+          puts "#{k}:#{' ' * (12-k.length)} #{v}"
+        else
+          puts "\e[31m#{k}:#{' ' * (12-k.length)} #{o}\e[0m"  unless o.nil?
+          puts "\e[32m#{k}:#{' ' * (12-k.length)} #{v}\e[0m"  unless v.nil?
+        end
+      end
+    else
+      cnf.sort_by{|k,v|k}.each do |k,v|
+        puts "#{k}:#{' ' * (12-k.length)} #{v}"
+      end
+    end
+  end
+
+  cli.sub :config, "CT/VM Configuration", min: 2, aliases: %w[cnf] do |ccli|
+    ccli.cmd 'help', '', aliases: [nil, '-h', '--help'], &lambda {|*args| help ccli, *args }
+
+    ccli.cmd :show, "Show Config of CT/VM", &lambda {|name_or_id|
+      connect
+      th = Proxmox::LXC.find( name_or_id) || Proxmox::Qemu.find_by_name( name_or_id)
+      show_config th.config
+    }
+
+    ccli.cmd :set, "Set Configs for CT/VM", &lambda {|name_or_id, *args|
+      if %w[-h --help].include? name_or_id
+        STDERR.puts "Usage: set -h|--help # Show help"
+        STDERR.puts "       set ct|vm --CNF1=VAL1 --CNF2=VAL2 ... # Set config-value.  Empty value clears field."
+        exit 1
+      end
+      opts = {}
+      until args.empty?
+        case arg = args.shift
+        when /\A--(\w+)=(.*)\z/
+          opts[$1.to_sym] = $2
+        when /\A--(\w+)\z/
+          opts[$1.to_sym] = args.shift
+        else
+          raise UsageError, "Expection option to set. What do you mean with: #{arg}"
+        end
+      end
+      opts.each do |k, v|
+        opts[k] =
+          case v = opts[k]
+          when '' then nil
+          else v
+          end
+      end
+      %i[migrate_downtime].each do |k|
+        next  unless opts.has_key? k
+        opts[k] =
+          case v = opts[k]
+          when nil, '', 'nil' then nil
+          else v.to_f
+          end
+      end
+      %i[memory background_delay balloon cores cpulimit cpuunits migrate_speed shares smp sockets vcpus swap tty].each do |k|
+        next  unless opts.has_key? k
+        opts[k] =
+          case v = opts[k]
+          when nil, '', 'nil' then nil
+          else v.to_i
+          end
+      end
+      %i[unprivileged debug onboot protection template].each do |k|
+        next  unless opts.has_key? k
+        opts[k] =
+          case v = opts[k]
+          when *%w[1 T TRUE t true True Y YES y yes Yes] then true
+          when *%w[0 F FALSE f false False N NO n no No] then false
+          when '', 'nil', nil then nil
+          else raise UsageError, "Boolean expected, given: #{v.inspect}"
+          end
+      end
+      connect
+      th = Proxmox::LXC.find( name_or_id) || Proxmox::Qemu.find_by_name( name_or_id)
+      old = th.config
+      opts[:digest] ||= old[:digest]
+      th.cnfset opts
+      show_config th.config, old
+    }
+  end
+
+  cli.cmd :enter, "Enter Console of CT/Node", &lambda {|name_or_id|
+    connect
+    th = Proxmox::LXC.find( name_or_id) || Proxmox::Node.find_by_name( name_or_id)
+    raise UsageError, "Container or Node not found: #{name_or_id}"  unless th
+    STDERR.puts "! #{$?.exitstatus}"  unless th.enter
+  }
+
+  cli.cmd :run, "Starts CT/VM", aliases: %w[start star], &lambda {|name_or_id|
+    connect
+    th = Proxmox::LXC.find( name_or_id) || Proxmox::Qemu.find_by_name( name_or_id)
+    raise UsageError, "Container or Node not found: #{name_or_id}"  unless th
+    start th
+  }
+
+  #cli.cmd :reboot, "Reboot CT/VM (not implemented, yet)", min: 6, &lambda {|name_or_id|
+  #  connect
+  #  th = Proxmox::LXC.find( name_or_id) || Proxmox::Qemu.find_by_name( name_or_id)
+  #  raise UsageError, "Container or Node not found: #{name_or_id}"  unless th
+  #  reboot th
+  #}
+
+  cli.cmd :stop, "Stops CT/VM", min: 4, &lambda {|name_or_id|
+    connect
+    th = Proxmox::LXC.find( name_or_id) || Proxmox::Qemu.find_by_name( name_or_id)
+    raise UsageError, "Container or Node not found: #{name_or_id}"  unless th
+    stop th
+  }
+
+  cli.cmd 'help', '', aliases: ['-h', '--help'], &lambda {|*args| help cli, *args }
+
+  cli.cmd 'cli', 'Opens interactive console', min: 3, aliases: [nil], &lambda {
+    @interactive = true
+    cli.interactive( File.basename($0,'.rb')).run
+  }
+end
+end