pve 0.1.2

data/lib/pve/qm.rb

@@ -0,0 +1,32 @@
+class PVE::Cli
+def cli_qm
+  cli.sub :qm, "Virtual Machines", aliases: %w[v vm qemu], &lambda {|qm|
+    qm.cmd :list, "List VM-IDs", aliases: ['ls'], &lambda {|node=nil|
+      connect
+      nodes = Proxmox::Node.all
+      nodes = nodes.select {|n| node == n.name }  if node
+      nodes.flat_map do |n|
+        n.qemu.map {|c| c.vmid.to_i }
+      end.sort.each {|c| puts c }
+    }
+
+    qm.cmd :status, "List VMs with status", aliases: [nil], &lambda {|node=nil|
+      connect
+      to = TablizedOutput.new %w[Status HA ID Name Host Uptime CPU Mem/MiB Disk/MiB]
+      nodes = Proxmox::Node.all
+      nodes = nodes.select {|n| node == n.name }  if node
+      nodes.each do |n|
+        n.qemu.each &to.method( :virt)
+      end
+      to.print order: [3]
+    }
+
+    qm.cmd :exec, "Executes Command in VM via qemu-guest-agent", min: 4, &lambda {|name_or_id, *command|
+      connect
+      STDERR.puts "! #{$?.exitstatus}"  unless Proxmox::Qemu.find!( name_or_id).exec *command
+    }
+
+    qm.cmd 'help', '', aliases: ['-h', '--help'], &lambda {|*args| help qm, *args }
+  }
+end
+end

data/lib/pve/templates.rb

@@ -0,0 +1,154 @@
+require 'ostruct'
+
+module PVE::CTTemplate
+  class Base
+    attr_reader :options
+
+    def initialize **opts
+      @options = OpenStruct.new opts
+      @virts = Proxmox::LXC.all + Proxmox::Qemu.all
+    end
+
+    def name() options.name end
+    def node() options.node end
+    def arch() options.arch || 'amd64' end
+    def vmid() options.vmid end
+    def ostype() options.ostype end
+    def cmode() options.cmode || 'shell' end
+    def cores() options.cores || 1 end
+    def description() options.description || '' end
+    def hostname() options.hostname || name end
+    def memory() options.memory || 1024 end
+    def swap() options.swap || 0 end
+    def unprivileged() options.unprivileged() || 1 end
+
+    def ssh_public_keys
+      options[:'ssh-public-keys'] ||
+        File.read( options[:'ssh-public-keys-file'] || '/root/.ssh/authorized_keys')
+    end
+
+    def net0()
+      if options.ipv4 || options.ipv6
+        ipv4 = IPAddress::IPv4.new options.ipv4
+        {
+          name: 'eth0',
+          bridge: 'vmbr1',
+          ip: ipv4.to_string,
+          gw: options.gateway || ipv4.hosts.last.to_s
+        }
+      end
+    end
+    def net1() nil end
+    def net2() nil end
+    def net3() nil end
+  end
+
+  class Default < Base
+    def self.requirements
+      {
+        node:                      [:string,  false, "Create CT on this node."],
+        name:                      [:string,  true,  "Set (uniq) name"],
+        arch:                      [:enum,    false, "Architecture", %w[amd64 i386 arm64 armhf]],
+        vmid:                      [:numeric, true,  "VM-ID.  Proxmox internal number (100...)"],
+        ostype:                    [:string,  true,  "OS-Type (OS or distribution)"],
+        cmode:                     [:enum,    false, "Console-mode", %w[shell console tty]],
+        cores:                     [:numeric, false, "Count of cores"],
+        description:               [:string,  false, "Description.  Eg. What should this CT do?"],
+        hostname:                  [:string,  false, "Hostname"],
+        memory:                    [:numeric, false, "How much memory CT could use?"],
+        swap:                      [:numeric, false, "How much CT can swap?"],
+        unprivileged:              [:boolean, false, "Unprivileged are restricted to own UID/GID-space."],
+        :'ssh-public-keys' =>      [:string,  false, "SSH-Public-Keys, which should be added to root-user in CT."],
+        :'ssh-public-keys-file' => [:string,  false, "Read SSH-Public-Keys from file."],
+        ipv4:                      [:string,  false, "IPv4-Address with net-size."],
+        gateway4:                  [:string,  false, "IPv4-Address of gateway."],
+        ipv6:                      [:string,  false, "IPv6-Address with net-size."],
+        gateway6:                  [:string,  false, "IPv6-Address of gateway."],
+        storage:                   [:string,  false, "Device will be create on this Storage (default: local"],
+      }
+    end
+  end
+
+  class Datacenter < Base
+    def self.requirements
+      {
+        node:                      [:string,  false, "Create CT on this node."],
+        name:                      [:string,  true,  "Set (uniq) name"],
+        arch:                      [:enum,    false, "Architecture", %w[amd64 i386 arm64 armhf]],
+        vmid:                      [:numeric, true,  "VM-ID.  Proxmox internal number (100...)"],
+        ostype:                    [:string,  true,  "OS-Type (OS or distribution)"],
+        cmode:                     [:enum,    false, "Console-mode", %w[shell console tty]],
+        cores:                     [:numeric, false, "Count of cores"],
+        description:               [:string,  false, "Description.  Eg. What should this CT do?"],
+        hostname:                  [:string,  false, "Hostname"],
+        memory:                    [:numeric, false, "How much memory CT could use?"],
+        swap:                      [:numeric, false, "How much CT can swap?"],
+        unprivileged:              [:boolean, false, "Unprivileged are restricted to own UID/GID-space."],
+        :'ssh-public-keys' =>      [:string,  false, "SSH-Public-Keys, which should be added to root-user in CT."],
+        :'ssh-public-keys-file' => [:string,  false, "Read SSH-Public-Keys from file."],
+        :'network-id' =>           [:numeric, true,  "Put Container to this VLAN and use a random IPv4-Address for this CT."],
+        ipv4:                      [:string,  false, "IPv4-Address with net-size."],
+        gateway4:                  [:string,  false, "IPv4-Address of gateway."],
+        ipv6:                      [:string,  false, "IPv6-Address with net-size."],
+        gateway6:                  [:string,  false, "IPv6-Address of gateway."],
+        storage:                   [:string,  false, "Device will be create on this Storage (default: root)"],
+      }
+    end
+
+    def node() options.node || 'svc1' end
+    def ostype() options.ostype || 'debian' end
+    def memory() options.memory || 2048 end
+    def storage() options.storage || 'root' end
+
+    def network_id
+      return @network_id  if @network_id
+      expect = 0..12
+      nid = options[:'network-id']
+      unless nid == nid.to_i.to_s && expect.include?( nid.to_i)
+        raise ArgumentError, "Network ID must be #{expect.inspect}.  Given: #{nid.inspect}"
+      end
+      @network_id = nid.to_i
+    end
+
+    def net0
+      {
+        name: 'eth0',
+        bridge: 'vmbr1',
+        tag: 2000+network_id,
+        mtu: 9166,
+        firewall: 1,
+        ip: ipv4.to_string,
+        gw: ipv4.hosts.last.to_s,
+      }
+    end
+
+    def vmid
+      super || ((0...100).map {|i| "#{100*network_id+i}" } - @virts.map( &:vmid)).first
+    end
+
+    def network
+      IPAddress::IPv4.new "10.#{network_id}.255.0/24"
+    end
+
+    def ipv4
+      return options.ipv4  if options.ipv4
+      return @ipv4  if @ipv4
+      ipv4s = network.hosts
+      @virts.each do |v|
+        v.config[:network].each {|n| ipv4s.delete n[:ip]  if n[:ip] }
+      end
+      @ipv4 = ipv4s.first
+    end
+
+    def ostemplate
+      @ostemplate ||=
+        options.ostemplate ||
+          case ostype
+          when 'debian'
+            'local:vztmpl/debian-10-standard_10.5-1_amd64.tar.gz'
+          else
+            raise ArgumentError, "OS-Template for ostype #{ostype} not found or ostemplate not provided."
+          end
+    end
+  end
+end

data/lib/pve/version.rb

@@ -0,0 +1,3 @@
+module PVE
+  VERSION = '0.1.2'
+end

data/pve.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/pve/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pve"
+  spec.version       = PVE::VERSION
+  spec.authors       = ["Denis Knauf"]
+  spec.email         = ["git+pve@denkn.at"]
+  spec.licenses      = ["LGPL-3.0"]
+
+  spec.summary       = %q{Proxmox Virtual Environment higher level API }
+  spec.description   = %q{Provides a higher level API with objects for controlling PVE}
+  spec.homepage      = "https://git.denkn.at/deac/pve"
+  # Ruby3 interpret **opts in another way than before.
+  # 2.7.0 should work with both(?) behaviours.
+  # PVE based on debian, so ruby 2.5 is default.
+  spec.required_ruby_version = Gem::Requirement.new "~> 2.5.0"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = spec.homepage
+
+  spec.add_dependency 'dencli', '~> 0.3.1'
+  spec.add_dependency 'rest-client', '~> 2.1'
+  spec.add_dependency 'ipaddress', '~> 0.8.3'
+  spec.add_dependency 'activesupport', '>= 2'
+  spec.add_dependency 'pmap', '~> 1.1'
+  spec.add_development_dependency "rspec", "~> 3.2"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: pve
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Denis Knauf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dencli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pmap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Provides a higher level API with objects for controlling PVE
+email:
+- git+pve@denkn.at
+executables:
+- pvecli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.adoc
+- bin/pvecli
+- lib/pve.rb
+- lib/pve/cli.rb
+- lib/pve/cli/base.rb
+- lib/pve/cli/ct.rb
+- lib/pve/cli/ha.rb
+- lib/pve/cli/node.rb
+- lib/pve/cli/qm.rb
+- lib/pve/cli/task.rb
+- lib/pve/helper.rb
+- lib/pve/proxmox.rb
+- lib/pve/qm.rb
+- lib/pve/templates.rb
+- lib/pve/version.rb
+- pve.gemspec
+homepage: https://git.denkn.at/deac/pve
+licenses:
+- LGPL-3.0
+metadata:
+  homepage_uri: https://git.denkn.at/deac/pve
+  source_code_uri: https://git.denkn.at/deac/pve
+  changelog_uri: https://git.denkn.at/deac/pve
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Proxmox Virtual Environment higher level API
+test_files: []