foreman_fog_proxmox 0.12.0

data/app/models/foreman_fog_proxmox/proxmox_token_expiration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Copyright 2019 Tristan Robert
+
+# This file is part of ForemanFogProxmox.
+
+# ForemanFogProxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# ForemanFogProxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
+
+module ForemanFogProxmox
+  module ProxmoxTokenExpiration
+    def token_expired?
+      Fog::Proxmox.credentials_has_expired?
+    end
+
+    def token_deadline
+      Fog::Proxmox.credentials[:deadline]
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_version.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2019 Tristan Robert
+
+# This file is part of ForemanFogProxmox.
+
+# ForemanFogProxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# ForemanFogProxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
+
+require 'foreman_fog_proxmox/semver'
+
+module ForemanFogProxmox
+  module ProxmoxVersion
+    def version_suitable?
+      logger.debug(format(_('Proxmox compute resource version is %<version>s'), version: version))
+      raise ::Foreman::Exception, format(_('Proxmox version %<version>s is not semver suitable'), version: version) unless ForemanFogProxmox::Semver.semver?(version)
+
+      ForemanFogProxmox::Semver.to_semver(version) >= ForemanFogProxmox::Semver.to_semver('5.3.0')
+    end
+
+    def version
+      v = identity_client.read_version
+      "#{v['version']}.#{v['release']}"
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_vm_commands.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+# Copyright 2019 Tristan Robert
+
+# This file is part of ForemanFogProxmox.
+
+# ForemanFogProxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# ForemanFogProxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
+
+module ForemanFogProxmox
+  module ProxmoxVmCommands
+    include ProxmoxVolumes
+    include ProxmoxPools
+
+    def start_on_boot(vm, args)
+      startonboot = args[:start_after_create].blank? ? false : Foreman::Cast.to_bool(args[:start_after_create])
+      vm.start if startonboot
+      vm
+    end
+
+    def create_vm(args = {})
+      vmid = args[:vmid].to_i
+      type = args[:type]
+      node = client.nodes.get(args[:node_id])
+      vmid = node.servers.next_id.to_i if vmid < 1
+      raise ::Foreman::Exception, format(N_('invalid vmid=%<vmid>s'), vmid: vmid) unless node.servers.id_valid?(vmid)
+
+      image_id = args[:image_id]
+      if image_id
+        clone_from_image(image_id, args, vmid)
+      else
+        convert_sizes(args)
+        remove_deletes(args)
+        case type
+        when 'qemu'
+          vm = node.servers.create(parse_server_vm(args))
+        when 'lxc'
+          hash = parse_container_vm(args)
+          hash = hash.merge(vmid: vmid)
+          vm = node.containers.create(hash.reject { |key, _value| ['ostemplate_storage', 'ostemplate_file'].include? key })
+        end
+        start_on_boot(vm, args)
+      end
+    rescue StandardError => e
+      logger.warn(format(_('failed to create vm: %<e>s'), e: e))
+      destroy_vm vm.id if vm
+      raise e
+    end
+
+    def destroy_vm(uuid)
+      vm = find_vm_by_uuid(uuid)
+      vm.stop if vm.ready?
+      vm.destroy
+    rescue ActiveRecord::RecordNotFound
+      # if the VM does not exists, we don't really care.
+      true
+    end
+
+    def supports_update?
+      true
+    end
+
+    def update_required?(old_attrs, new_attrs)
+      return true if super(old_attrs, new_attrs)
+
+      new_attrs[:interfaces_attributes]&.each do |key, interface|
+        return true if (interface[:id].blank? || interface[:_delete] == '1') && key != 'new_interfaces' # ignore the template
+      end
+
+      new_attrs[:volumes_attributes]&.each do |key, volume|
+        return true if (volume[:id].blank? || volume[:_delete] == '1') && key != 'new_volumes' # ignore the template
+      end
+
+      false
+    end
+
+    def user_data_supported?
+      true
+    end
+
+    def save_vm(uuid, new_attributes)
+      vm = find_vm_by_uuid(uuid)
+      templated = new_attributes['templated']
+      node_id = new_attributes['node_id']
+      if templated == '1' && !vm.templated?
+        vm.create_template
+      elsif vm.node_id != node_id
+        vm.migrate(node_id)
+      else
+        convert_memory_sizes(new_attributes)
+        volumes_attributes = new_attributes['volumes_attributes']
+        volumes_attributes&.each_value { |volume_attributes| save_volume(vm, volume_attributes) }
+        parsed_attr = vm.container? ? parse_container_vm(new_attributes.merge(type: vm.type)) : parse_server_vm(new_attributes.merge(type: vm.type))
+        logger.debug("parsed_attr=#{parsed_attr}")
+        config_attributes = parsed_attr.reject { |key, _value| [:vmid, :templated, :ostemplate, :ostemplate_file, :ostemplate_storage, :volumes_attributes, :pool].include? key.to_sym }
+        config_attributes = config_attributes.reject { |_key, value| ForemanFogProxmox::Value.empty?(value) }
+        cdrom_attributes = parsed_attr.select { |_key, value| Fog::Proxmox::DiskHelper.cdrom?(value.to_s) }
+        config_attributes = config_attributes.reject { |key, _value| Fog::Proxmox::DiskHelper.disk?(key) }
+        vm.update(config_attributes.merge(cdrom_attributes))
+        poolid = new_attributes['pool'] if new_attributes.key?('pool')
+        update_pool(vm, poolid) if poolid
+      end
+      find_vm_by_uuid(uuid)
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_vm_new.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+# Copyright 2019 Tristan Robert
+
+# This file is part of ForemanFogProxmox.
+
+# ForemanFogProxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# ForemanFogProxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
+
+require 'fog/proxmox'
+require 'fog/proxmox/helpers/nic_helper'
+require 'fog/proxmox/helpers/disk_helper'
+
+module ForemanFogProxmox
+  module ProxmoxVmNew
+    include ProxmoxVmHelper
+
+    def volume_server_defaults(controller = 'scsi', device = 0)
+      id = "#{controller}#{device}"
+      { id: id, storage: storages.first.identity.to_s, size: (8 * GIGA), options: { cache: 'none' } }
+    end
+
+    def volume_container_defaults(id = 'rootfs')
+      { id: id, storage: storages.first.identity.to_s, size: (8 * GIGA), options: {} }
+    end
+
+    def new_volume(attr = {})
+      type = attr['type']
+      type ||= 'qemu'
+      case type
+      when 'lxc'
+        new_volume_server(attr)
+      when 'qemu'
+        new_volume_container(attr)
+      end
+    end
+
+    def new_volume_server(attr = {})
+      opts = volume_server_defaults.merge(attr.to_h).deep_symbolize_keys
+      opts[:size] = opts[:size].to_s
+      Fog::Proxmox::Compute::Disk.new(opts)
+    end
+
+    def new_volume_container(attr = {})
+      opts = volume_container_defaults.merge(attr.to_h).deep_symbolize_keys
+      opts[:size] = opts[:size].to_s
+      Fog::Proxmox::Compute::Disk.new(opts)
+    end
+
+    def interface_defaults(id = 'net0')
+      { id: id, model: 'virtio', name: 'eth0', bridge: bridges.first.identity.to_s }
+    end
+
+    def interface_server_defaults(id = 'net0')
+      { id: id, model: 'virtio', bridge: bridges.first.identity.to_s }
+    end
+
+    def interface_container_defaults(id = 'net0')
+      { id: id, name: 'eth0', bridge: bridges.first.identity.to_s, dhcpv4: 1, dhcpv6: 1 }
+    end
+
+    def new_interface(attr = {})
+      type = attr['type']
+      type ||= 'qemu'
+      case type
+      when 'lxc'
+        new_container_interface(attr)
+      when 'qemu'
+        new_server_interface(attr)
+      end
+    end
+
+    def new_server_interface(attr = {})
+      logger.debug('new_server_interface')
+      opts = interface_server_defaults.merge(attr.to_h).deep_symbolize_keys
+      Fog::Proxmox::Compute::Interface.new(opts)
+    end
+
+    def new_container_interface(attr = {})
+      logger.debug('new_container_interface')
+      opts = interface_container_defaults.merge(attr.to_h).deep_symbolize_keys
+      Fog::Proxmox::Compute::Interface.new(opts)
+    end
+
+    def default_node
+      nodes.first
+    end
+
+    def default_node_id
+      default_node.node
+    end
+
+    def next_vmid
+      default_node.servers.next_id
+    end
+
+    def vm_server_instance_defaults
+      ActiveSupport::HashWithIndifferentAccess.new(
+        name: "foreman_#{Time.now.to_i}",
+        vmid: next_vmid,
+        type: 'qemu',
+        node_id: default_node_id,
+        cores: 1,
+        sockets: 1,
+        kvm: 1,
+        vga: 'std',
+        memory: 512 * MEGA,
+        ostype: 'l26',
+        keyboard: 'en-us',
+        cpu: 'kvm64',
+        scsihw: 'virtio-scsi-pci',
+        ide2: 'none,media=cdrom',
+        templated: 0
+      ).merge(Fog::Proxmox::DiskHelper.flatten(volume_server_defaults)).merge(Fog::Proxmox::DiskHelper.flatten(volume_container_defaults)).merge(Fog::Proxmox::NicHelper.flatten(interface_defaults))
+    end
+
+    def vm_container_instance_defaults
+      ActiveSupport::HashWithIndifferentAccess.new(
+        name: "foreman_#{Time.now.to_i}",
+        vmid: next_vmid,
+        type: 'lxc',
+        node_id: default_node_id,
+        memory: 512 * MEGA,
+        templated: 0
+      ).merge(Fog::Proxmox::DiskHelper.flatten(volume_container_defaults)).merge(Fog::Proxmox::DiskHelper.flatten(volume_server_defaults)).merge(Fog::Proxmox::NicHelper.flatten(interface_defaults))
+    end
+
+    def vm_instance_defaults
+      super.merge(vmid: next_vmid, node_id: default_node_id)
+    end
+
+    def new_vm(new_attr = {})
+      new_attr = ActiveSupport::HashWithIndifferentAccess.new(new_attr)
+      type = new_attr['type']
+      type ||= 'qemu'
+      case type
+      when 'lxc'
+        vm = new_container_vm(new_attr)
+      when 'qemu'
+        vm = new_server_vm(new_attr)
+      end
+      logger.debug(format(_('new_vm() vm.config=%<config>s'), config: vm.config.inspect))
+      vm
+    end
+
+    def new_container_vm(new_attr = {})
+      options = new_attr
+      node_id = new_attr['node_id']
+      node = node_id ? client.nodes.get(node_id) : default_node
+      options = options.merge(type: 'lxc').merge(vmid: next_vmid)
+      options = vm_container_instance_defaults.merge(options) if new_attr.empty?
+      vm = node.containers.new(parse_container_vm(options).deep_symbolize_keys)
+      logger.debug(format(_('new_container_vm() vm.config=%<config>s'), config: vm.config.inspect))
+      vm
+    end
+
+    def new_server_vm(new_attr = {})
+      options = new_attr
+      node_id = new_attr['node_id']
+      node = node_id ? client.nodes.get(node_id) : default_node
+      options = options.merge(type: 'qemu').merge(vmid: next_vmid)
+      options = vm_server_instance_defaults.merge(options) if new_attr.empty?
+      vm = node.servers.new(parse_server_vm(options).deep_symbolize_keys)
+      logger.debug(format(_('new_server_vm() vm.config=%<config>s'), config: vm.config.inspect))
+      vm
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_vm_queries.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright 2019 Tristan Robert
+
+# This file is part of ForemanFogProxmox.
+
+# ForemanFogProxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# ForemanFogProxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
+
+module ForemanFogProxmox
+  module ProxmoxVmQueries
+    include ProxmoxPools
+
+    def nodes
+      nodes = client.nodes.all if client
+      nodes&.sort_by(&:node)
+    end
+
+    def storages(node_id = default_node_id, type = 'images')
+      node = client.nodes.get node_id
+      node ||= default_node
+      storages = node.storages.list_by_content_type type
+      storages.sort_by(&:storage)
+    end
+
+    def bridges(node_id = default_node_id)
+      node = network_client.nodes.get node_id
+      node ||= network_client.nodes.first
+      bridges = node.networks.all(type: 'any_bridge')
+      bridges.sort_by(&:iface)
+    end
+
+    # TODO: Pagination with filters
+    def vms(_opts = {})
+      vms = []
+      nodes.each { |node| vms += node.servers.all + node.containers.all }
+      ForemanFogProxmox::Vms.new(vms)
+    end
+
+    def find_vm_by_uuid(uuid)
+      # look for the uuid on all known nodes
+      vm = nil
+      nodes.each do |node|
+        vm = find_vm_in_servers_by_uuid(node.servers, uuid)
+        vm ||= find_vm_in_servers_by_uuid(node.containers, uuid)
+        unless vm.nil?
+          logger.debug("found vm #{uuid} on node #{node.node}")
+          break
+        end
+      end
+      vm
+    end
+
+    def find_vm_in_servers_by_uuid(servers, uuid)
+      vm = servers.get(uuid) if !uuid.nil? && !uuid.to_s.empty?
+      pool_owner(vm) if vm
+      vm
+    rescue Fog::Errors::NotFound
+      nil
+    rescue StandardError => e
+      Foreman::Logging.exception(format(_('Failed retrieving proxmox server vm by vmid=%<vmid>s'), vmid: uuid), e)
+      raise(ActiveRecord::RecordNotFound, e)
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_volumes.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# Copyright 2019 Tristan Robert
+
+# This file is part of ForemanFogProxmox.
+
+# ForemanFogProxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# ForemanFogProxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
+
+require 'fog/proxmox/helpers/disk_helper'
+
+module ForemanFogProxmox
+  module ProxmoxVolumes
+    include ProxmoxVmHelper
+
+    def delete_volume(vm, id)
+      vm.detach(id)
+      device = Fog::Proxmox::DiskHelper.extract_device(id)
+      vm.detach('unused' + device.to_s)
+    end
+
+    def volume_options(vm, id, volume_attributes)
+      options = {}
+      options.store(:mp, volume_attributes['mp']) if vm.container? && id != 'rootfs'
+      options.store(:cache, volume_attributes['cache']) unless vm.container?
+      options
+    end
+
+    def update_volume(vm, id, volume_attributes)
+      disk = vm.config.disks.get(id)
+      diff_size = volume_attributes['size'].to_i - disk.size
+      raise ::Foreman::Exception, format(_('Unable to shrink %<id>s size. Proxmox allows only increasing size.'), id: id) unless diff_size >= 0
+
+      if diff_size > 0
+        extension = '+' + (diff_size / GIGA).to_s + 'G'
+        vm.extend(id, extension)
+      elsif disk.storage != volume_attributes['storage']
+        vm.move(id, volume_attributes['storage'])
+      else
+        options = volume_options(vm, id, volume_attributes)
+        vm.attach({ :id => disk.id, :volid => disk.volid, :size => disk.size }, options)
+      end
+    end
+
+    def volume_exists?(volume_attributes)
+      volid = volume_attributes.key?('volid') ? volume_attributes['volid'] : ''
+      volid.present?
+    end
+
+    def volume_to_delete?(volume_attributes)
+      volume_attributes['_delete'].blank? ? false : Foreman::Cast.to_bool(volume_attributes['_delete'])
+    end
+
+    def extract_id(vm, volume_attributes)
+      id = ''
+      if volume_exists?(volume_attributes)
+        id = volume_attributes['id']
+      else
+        device = vm.container? ? 'mp' : volume_attributes['controller']
+        id = device + volume_attributes['device']
+      end
+      id
+    end
+
+    def add_volume(vm, id, volume_attributes)
+      options = volume_options(vm, id, volume_attributes)
+      disk_attributes = { id: id, storage: volume_attributes['storage'], size: (volume_attributes['size'].to_i / GIGA).to_s }
+      vm.attach(disk_attributes, options)
+    end
+
+    def save_volume(vm, volume_attributes)
+      id = extract_id(vm, volume_attributes)
+      if volume_exists?(volume_attributes)
+        if volume_to_delete?(volume_attributes)
+          delete_volume(vm, id)
+        else
+          update_volume(vm, id, volume_attributes)
+        end
+      else
+        add_volume(vm, id, volume_attributes)
+      end
+    end
+  end
+end