foreman_fog_proxmox 0.8.0 → 0.8.2

data/app/models/foreman_fog_proxmox/proxmox_compute_attributes.rb

@@ -0,0 +1,54 @@
+# 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 ProxmoxComputeAttributes
+    def host_compute_attrs(host)
+      super.tap do |_attrs|
+        ostype = host.compute_attributes['config_attributes']['ostype']
+        type = host.compute_attributes['type']
+        case type
+        when 'lxc'
+          host.compute_attributes['config_attributes'].store('hostname', host.name)
+        when 'qemu'
+          unless compute_os_types(host).include?(ostype)
+            raise ::Foreman::Exception, format(_('Operating system family %<type>s is not consistent with %<ostype>s'), type: host.operatingsystem.type, ostype: ostype)
+          end
+        end
+      end
+    end
+
+    def not_config_key?(vm, key)
+      [:disks, :interfaces, :vmid, :node_id, :node, :type].include?(key) || !vm.config.respond_to?(key)
+    end
+
+    def vm_compute_attributes(vm)
+      vm_attrs = {}
+      if vm.respond_to?(:config)
+        vm_attrs = vm_attrs.merge(vmid: vm.identity, node_id: vm.node_id, type: vm.type)
+        vm_attrs[:volumes_attributes] = Hash[vm.config.disks.each_with_index.map { |disk, idx| [idx.to_s, disk.attributes] }] if vm.config.respond_to?(:disks)
+        vm_attrs[:interfaces_attributes] = Hash[vm.config.interfaces.each_with_index.map { |interface, idx| [idx.to_s, interface.attributes] }] if vm.config.respond_to?(:interfaces)
+        vm_attrs[:config_attributes] = vm.config.attributes.reject do |key, value|
+          not_config_key?(vm, key) || ForemanFogProxmox::Value.empty?(value.to_s) || Fog::Proxmox::DiskHelper.disk?(key.to_s) || Fog::Proxmox::NicHelper.nic?(key.to_s)
+        end
+      end
+      vm_attrs
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_connection.rb

@@ -0,0 +1,67 @@
+# 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'
+
+module ForemanFogProxmox
+  module ProxmoxConnection
+    def connection_options
+      opts = http_proxy ? { proxy: http_proxy.full_url } : { disable_proxy: 1 }
+      opts.store(:ssl_verify_peer, ssl_verify_peer)
+      opts.store(:ssl_cert_store, certs_to_store) if Foreman::Cast.to_bool(ssl_verify_peer)
+      opts
+    end
+
+    def fog_credentials
+      credentials = { pve_url: url,
+                      pve_username: user,
+                      pve_password: password,
+                      connection_options: connection_options }
+      ticket = Fog::Proxmox.credentials[:ticket]
+      credentials.store(:pve_ticket, ticket) if renew
+      credentials
+    end
+
+    def credentials_valid?
+      errors[:url].empty? && errors[:user].empty? && errors[:user].include?('@') && errors[:password].empty? && errors[:node_id].empty?
+    end
+
+    def test_connection(options = {})
+      super
+      credentials_valid?
+      version_suitable?
+    rescue StandardError => e
+      errors[:base] << e.message
+      if e.message.include?('SSL')
+        errors[:ssl_certs] << e.message
+      else
+        errors[:url] << e.message
+      end
+    end
+
+    def disconnect
+      client.terminate if @client
+      @client = nil
+      identity_client.terminate if @identity_client
+      @identity_client = nil
+      network_client.terminate if @network_client
+      @network_client = nil
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_console.rb

@@ -0,0 +1,41 @@
+# 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 ProxmoxConsole
+    def console(uuid)
+      vm = find_vm_by_uuid(uuid)
+      options = {}
+      if vm.container?
+        type_console = 'vnc'
+        options.store(:console, type_console)
+      else
+        type_console = vm.config.type_console
+      end
+      options.store(:websocket, 1) if type_console == 'vnc'
+      begin
+        vnc_console = vm.start_console(options)
+        WsProxy.start(:host => host, :host_port => vnc_console['port'], :password => vnc_console['ticket']).merge(:name => vm.name, :type => type_console)
+      rescue StandardError => e
+        logger.error(e)
+        raise ::Foreman::Exception, _('%<s>s console is not supported at this time') % type_console
+      end
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_images.rb

@@ -0,0 +1,53 @@
+# 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 ProxmoxImages
+    def image_exists?(image)
+      !find_vm_by_uuid(image).nil?
+    end
+
+    def images_by_storage(storage_id, type = 'iso')
+      storage = node.storages.get storage_id if storage_id
+      storage.volumes.list_by_content_type(type).sort_by(&:volid) if storage
+    end
+
+    def available_images
+      templates.collect { |template| OpenStruct.new(id: template.vmid) }
+    end
+
+    def templates
+      storage = storages.first
+      images = storage.volumes.list_by_content_type('images')
+      images.select(&:templated?)
+    end
+
+    def template(vmid)
+      find_vm_by_uuid(vmid)
+    end
+
+    def clone_from_image(image_id, args, vmid)
+      logger.debug(format(_('create_vm(): clone %<image_id>s in %<vmid>s'), image_id: image_id, vmid: vmid))
+      image = node.servers.get image_id
+      image.clone(vmid)
+      clone = node.servers.get vmid
+      clone.update(name: args[:name])
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_interfaces.rb

@@ -0,0 +1,60 @@
+# 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 ProxmoxInterfaces
+    def editable_network_interfaces?
+      true
+    end
+
+    def set_nic_identifier(nic, index)
+      nic.identifier = format('net%<index>s', index: index) if nic.identifier.empty?
+      raise ::Foreman::Exception, _(format('Invalid identifier interface[%<index>s]. Must be net[n] with n integer >= 0', index: index)) unless Fog::Proxmox::NicHelper.nic?(nic.identifier)
+    end
+
+    def container?(host)
+      host.compute_attributes['type'] == 'lxc'
+    end
+
+    def container_nic_name_valid?(nic)
+      /^(eth)(\d+)$/.match?(nic.compute_attributes['name'])
+    end
+
+    def set_container_interface_name(_host, nic, index)
+      nic.compute_attributes['name'] = format('eth%<index>s', index: index) if nic.compute_attributes['name'].empty?
+      raise ::Foreman::Exception, _(format('Invalid name interface[%<index>s]. Must be eth[n] with n integer >= 0', index: index)) unless container_nic_name_valid?(nic)
+    end
+
+    def host_interfaces_attrs(host)
+      host.interfaces.select(&:physical?).each.with_index.reduce({}) do |hash, (nic, index)|
+        set_nic_identifier(nic, index)
+        set_container_interface_name(host, nic, index) if container?(host)
+        nic_compute_attributes = nic.compute_attributes.merge(id: nic.identifier)
+        mac = nic.mac
+        mac ||= nic.attributes['mac']
+        nic_compute_attributes.store(:macaddr, mac) if mac.present?
+        interface_compute_attributes = host.compute_attributes['interfaces_attributes'] ? host.compute_attributes['interfaces_attributes'].select { |_k, v| v['id'] == nic.identifier } : {}
+        nic_compute_attributes.store(:_delete, interface_compute_attributes[interface_compute_attributes.keys[0]]['_delete']) unless interface_compute_attributes.empty?
+        nic_compute_attributes.store(:ip, nic.ip) if nic.ip.present?
+        nic_compute_attributes.store(:ip6, nic.ip6) if nic.ip6.present?
+        hash.merge(index.to_s => nic_compute_attributes)
+      end
+    end
+  end
+end

data/app/models/foreman_fog_proxmox/proxmox_operating_systems.rb

@@ -0,0 +1,49 @@
+# 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 ProxmoxOperatingSystems
+    def compute_os_types(host)
+      os_linux_types_mapping(host).empty? ? os_windows_types_mapping(host) : os_linux_types_mapping(host)
+    end
+
+    def available_operating_systems
+      operating_systems = ['other', 'solaris']
+      operating_systems += available_linux_operating_systems
+      operating_systems += available_windows_operating_systems
+      operating_systems
+    end
+
+    def available_linux_operating_systems
+      ['l24', 'l26', 'debian', 'ubuntu', 'centos', 'fedora', 'opensuse', 'archlinux', 'gentoo', 'alpine']
+    end
+
+    def available_windows_operating_systems
+      ['wxp', 'w2k', 'w2k3', 'w2k8', 'wvista', 'win7', 'win8', 'win10']
+    end
+
+    def os_linux_types_mapping(host)
+      ['Debian', 'Redhat', 'Suse', 'Altlinux', 'Archlinux', 'CoreOs', 'Gentoo'].include?(host.operatingsystem.type) ? available_linux_operating_systems : []
+    end
+
+    def os_windows_types_mapping(host)
+      ['Windows'].include?(host.operatingsystem.type) ? available_windows_operating_systems : []
+    end
+  end
+end

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') && ForemanFogProxmox::Semver.to_semver(version) < ForemanFogProxmox::Semver.to_semver('5.5.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,108 @@
+# 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
+
+    def start_on_boot(vm, args)
+      startonboot = args[:config_attributes][:onboot].blank? ? false : Foreman::Cast.to_bool(args[:config_attributes][:onboot])
+      vm.start if startonboot
+      vm
+    end
+
+    def create_vm(args = {})
+      vmid = args[:vmid].to_i
+      type = args[:type]
+      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']
+      if templated == '1' && !vm.templated?
+        vm.create_template
+      else
+        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].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))
+        start_on_boot(vm, new_attributes)
+      end
+      find_vm_by_uuid(uuid)
+    end
+  end
+end