foreman_fog_proxmox 0.25.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d59641775e4da477886d59bf332dadd576426ef079d1c6af43ef2e9f70b9c5a5
-  data.tar.gz: 5e24be7c7881de3c05d5a59a06500bd9d35f7c1f06d4c10390df473ec6ef8b01
+  metadata.gz: 9dcd1a0e6c90d8847b0e31986425ab3354e4659676994ea6ab84ec9648b0d17d
+  data.tar.gz: 8dc424df461ebfe7f7cf07f11e7fecebf56fa75c3bdb4c52b51ef2fdcda01fa5
 SHA512:
-  metadata.gz: e04095637c92c2a341043e96f345d4d9ddcd5a3f86b4285fc1ee5199a0e9c36fd542e40a28e748d66d4da56cec743618d144300b907be7c4d82a0a4daac21d82
-  data.tar.gz: 18a1bb26c3d35273d36826012d35c7e5f21a9c65193e86b7ab9babbde49ae5d15dcea828fa37a024e91740bdfb5a29788047f8ad8cd5829215324e21267e4079
+  metadata.gz: a99138711e3912f07dfe3c875106745d543db41e466fbf50460a3fd9abab1476e1da72620f2233d4455984698c64763b849c87f317131d6021b458f1150ea2f5
+  data.tar.gz: 852428fd8ed987daca7f45d0908a8b9d71ecbacb9affe3bd65fdc9ecff12b7be80859ea3071d59bd00d8182d5bd75eac1510f922e9c3977be6fd638a879e8187

data/app/assets/javascripts/foreman_fog_proxmox/proxmox_network_interface_modal.js

@@ -0,0 +1,11 @@
+$(document)
+  .on('show.bs.modal', '#interfaceModal', function () {
+    var modal = $(this);
+    modal.toggleClass(
+      'proxmox-interface-modal',
+      modal.find('.proxmox-interface-form').length > 0
+    );
+  })
+  .on('hidden.bs.modal', '#interfaceModal', function () {
+    $(this).removeClass('proxmox-interface-modal');
+  });

data/app/assets/stylesheets/foreman_fog_proxmox/network_interface_modal.css

@@ -0,0 +1,17 @@
+#interfaceModal.proxmox-interface-modal {
+  overflow-y: hidden;
+}
+
+#interfaceModal.proxmox-interface-modal .modal-content {
+  display: flex;
+  flex-direction: column;
+  max-height: 90vh;
+  overflow: hidden;
+}
+
+#interfaceModal.proxmox-interface-modal .modal-body {
+  flex: 1 1 auto;
+  min-height: 0;
+  overflow-y: auto;
+  overflow-x: hidden;
+}

data/app/controllers/foreman_fog_proxmox/compute_resources_controller.rb

@@ -95,20 +95,21 @@ module ForemanFogProxmox
     # GET foreman_fog_proxmox/metadata/:compute_resource_id
     def metadata
       cr = ComputeResource.find(params[:compute_resource_id])
+      nodes = Array(cr.nodes)
 
       render json: {
-        nodes: extract_nodes(cr),
+        nodes: extract_nodes(nodes),
         pools: extract_pools(cr),
-        storages: extract_storages(cr),
-        bridges: extract_bridges(cr),
+        storages: extract_storages(cr, nodes),
+        bridges: extract_bridges(cr, nodes),
         images: extract_images(cr),
       }
     end
 
     private
 
-    def extract_nodes(compute_resource)
-      Array(compute_resource.nodes).map { |n| { node: n.node } }
+    def extract_nodes(nodes)
+      nodes.map { |n| { node: n.node } }
     end
 
     def extract_pools(compute_resource)
@@ -118,27 +119,34 @@ module ForemanFogProxmox
       end
     end
 
-    def extract_storages(compute_resource)
-      Array(compute_resource.storages).map do |s|
-        h = s.respond_to?(:as_json) ? s.as_json : s
-        {
-          storage: (h[:storage] || h['storage']),
-          node_id: (h[:node_id] || h['node_id']),
-          content: (h[:content] || h['content']),
-          avail: (h[:avail] || h['avail']),
-          used: (h[:used] || h['used']),
-          total: (h[:total] || h['total']),
-        }
+    def extract_storages(compute_resource, nodes)
+      nodes.flat_map do |node|
+        node_id = node.node
+        Array(compute_resource.storages(node_id)).map do |storage|
+          h = storage.respond_to?(:as_json) ? storage.as_json : storage
+          {
+            storage: (h[:storage] || h['storage']),
+            node_id: node_id,
+            content: (h[:content] || h['content']),
+            avail: (h[:avail] || h['avail']),
+            used: (h[:used] || h['used']),
+            total: (h[:total] || h['total']),
+            shared: (h[:shared] || h['shared']),
+          }
+        end
       end
     end
 
-    def extract_bridges(compute_resource)
-      Array(compute_resource.bridges).map do |b|
-        h = b.respond_to?(:as_json) ? b.as_json : b
-        {
-          node_id: (h[:node_id] || h['node_id']),
-          iface: (h[:iface] || h['iface']),
-        }
+    def extract_bridges(compute_resource, nodes)
+      nodes.flat_map do |node|
+        node_id = node.node
+        Array(compute_resource.bridges(node_id)).map do |bridge|
+          h = bridge.respond_to?(:as_json) ? bridge.as_json : bridge
+          {
+            node_id: node_id,
+            iface: (h[:iface] || h['iface']),
+          }
+        end
       end
     end
 

data/app/helpers/proxmox_vm_attrs_helper.rb

@@ -130,6 +130,7 @@ module ProxmoxVMAttrsHelper
       hostname: vms.config.hostname,
       ostemplate_storage: vms.ostemplate_storage,
       ostemplate_file: vms.ostemplate_file,
+      iso_upload_storage: vms.iso_upload_storage,
       start_after_create: vms.start_after_create,
       templated: vms.templated,
       is_secure_boot: vms.config.secure_boot?,

data/app/helpers/proxmox_vm_cloudinit_helper.rb

@@ -21,6 +21,9 @@ require 'fog/proxmox/helpers/disk_helper'
 require 'fog/proxmox/helpers/nic_helper'
 require 'foreman_fog_proxmox/value'
 require 'foreman_fog_proxmox/hash_collection'
+require 'fileutils'
+require 'open3'
+require 'tmpdir'
 
 # Convert a foreman form server hash into a fog-proxmox server attributes hash
 module ProxmoxVMCloudinitHelper
@@ -42,54 +45,59 @@ module ProxmoxVMCloudinitHelper
     cloudinit_h
   end
 
-  def create_cloudinit_iso(vm_name, configs, ssh)
-    iso = File.join(default_iso_path, "#{vm_name.tr('.', '_')}_cloudinit.iso")
+  def create_cloudinit_iso(vm_name, configs)
+    wd = create_temp_directory
+    iso = File.join(wd, "#{vm_name.tr('.', '_')}_cloudinit.iso")
     files = []
-    wd = create_temp_directory(ssh)
 
     configs.each do |config|
-      config_file = ssh.run("cat <<'EOF' > '#{wd}/#{config[0]}'\n#{config[1]}\nEOF")
-      unless config_file.first.status.zero?
-        delete_temp_dir(ssh, wd)
-        raise ::Foreman::Exception, "Failed to create file #{config[0]}: #{config_file.first.stdout}"
-      end
-      files.append(File.join(wd, config[0]))
+      config_file = File.join(wd, config[0])
+      File.write(config_file, config[1])
+      files.append(config_file)
     end
-    generated_iso = ssh.run(generate_iso_command(iso, files))
-    unless generated_iso.first.status.zero?
-      delete_temp_dir(ssh, wd)
-      raise Foreman::Exception, N_("ISO build failed: #{generated_iso.first.stdout}")
-    end
-    delete_temp_dir(ssh, wd)
-    iso
+    logger.debug("Generating cloud-init ISO at #{iso}")
+    stdout, stderr, status = Open3.capture3(*generate_iso_command(iso, files))
+    raise Foreman::Exception, N_("ISO build failed: #{stderr.presence || stdout}") unless status.success?
+
+    yield iso
+  ensure
+    delete_temp_dir(wd) if wd && Dir.exist?(wd)
   end
 
   def generate_iso_command(iso_file, config_files)
-    arguments = ["genisoimage", "-output #{iso_file}", '-volid', 'cidata', '-joliet', '-rock']
-    iso_command = arguments.concat(config_files).join(' ')
-    logger.debug("iso image generation args: #{iso_command}")
-    iso_command
+    arguments = ["genisoimage", '-output', iso_file, '-volid', 'cidata', '-joliet', '-rock']
+    arguments.concat(config_files)
+    logger.debug("iso image generation args: #{arguments.join(' ')}")
+    arguments
   end
 
-  def create_temp_directory(ssh)
-    res = ssh.run("mktemp -d")
-    raise ::Foreman::Exception, "Could not create working directory to store cloudinit config data: #{res.first.stdout}." unless res.first.status.zero?
-    res.first.stdout.chomp
+  def create_temp_directory
+    Dir.mktmpdir
+  rescue StandardError => e
+    raise ::Foreman::Exception, "Could not create working directory to store cloudinit config data: #{e}."
   end
 
-  def delete_temp_dir(ssh, working_dir)
-    ssh.run("rm -rf #{working_dir}")
-  rescue Foreman::Exception => e
+  def delete_temp_dir(working_dir)
+    FileUtils.remove_entry(working_dir)
+  rescue StandardError => e
     logger.warn("Could not delete directory for config files: #{e}. Please delete it manually at #{working_dir}")
   end
 
-  def parse_cloudinit_config(args)
+  def cloudinit_clone_args(args, vm_instance)
+    return args unless args[:user_data]
+
+    actual_node = vm_instance.node_id
+    logger.info("Cloud-init ISO storage will be validated for cloned VM node #{actual_node} instead of selected node #{args[:node_id]}") if args[:node_id] != actual_node
+
+    parse_cloudinit_config(args, vm_node: actual_node)
+  end
+
+  def parse_cloudinit_config(args, vm_node: args[:node_id])
     filenames = ["meta-data"]
     config_data = ["instance-id: #{args[:name]}"]
     user_data = args.delete(:user_data)
     return args if user_data == ''
     check_template_format(user_data)
-    ssh = vm_ssh
 
     if user_data.include?('#network-config') && user_data.include?('#cloud-config')
       config_data.concat(user_data.split('#network-config'))
@@ -105,32 +113,39 @@ module ProxmoxVMCloudinitHelper
     return args if config_data.length == 1
     configs = filenames.zip(config_data).to_h
 
-    iso = create_cloudinit_iso(args[:name], configs, ssh)
-    args.merge!(attach_cloudinit_iso(args[:node_id], iso))
+    create_cloudinit_iso(args[:name], configs) do |iso|
+      storage = upload_iso(args[:node_id], args[:iso_upload_storage], iso, vm_node: vm_node)
+      args.merge!(attach_cloudinit_iso(vm_node, storage, iso))
+    end
   end
 
-  def attach_cloudinit_iso(node, iso)
-    volume = nil
-    storages(node, 'iso').each do |storage|
-      volume = storage.volumes.detect { |v| v.volid.include? File.basename(iso) }
-      break if volume
-    end
+  def upload_iso(node, storage_id, iso, vm_node: node)
+    raise ::Foreman::Exception, _('ISO upload storage must be selected') if storage_id.blank?
 
-    raise ::Foreman::Exception, "Could not find generated cloud-init ISO #{File.basename(iso)} on any ISO storage for node #{node}" unless volume
+    iso_storages = storages(node, 'iso')
+    storage = iso_storages.find { |s| s.identity == storage_id }
+    raise ::Foreman::Exception, "Could not find selected ISO upload storage #{storage_id} for node #{node}" unless storage
 
-    { ide2: "#{volume.volid},media=cdrom" }
-  end
+    if node != vm_node
+      vm_storage = storages(vm_node, 'iso').find { |s| s.identity == storage_id }
+      raise ::Foreman::Exception, "Selected ISO upload storage #{storage_id} is not accessible from cloned VM node #{vm_node}" unless vm_storage
 
-  def default_iso_path
-    "/var/lib/vz/template/iso"
+      storage = vm_storage
+    end
+
+    storage.upload_iso(iso)
+    storage.identity
   end
 
-  def vm_ssh
-    ssh = Fog::SSH.new(URI.parse(fog_credentials[:proxmox_url]).host, fog_credentials[:proxmox_username].split('@')[0], { password: fog_credentials[:proxmox_password] })
-    ssh.run('ls') # test if ssh is successful
-    ssh
-  rescue StandardError => e
-    raise ::Foreman::Exception, "Unable to ssh into proxmox server: #{e}"
+  def attach_cloudinit_iso(node, storage_id, iso)
+    storage = client.nodes.get(node).storages.get(storage_id)
+    volume = storage&.volumes&.all&.detect do |v|
+      File.basename(v.volid) == File.basename(iso)
+    end
+
+    raise ::Foreman::Exception, "Could not find generated cloud-init ISO #{File.basename(iso)} on storage #{storage_id} for node #{node}" unless volume
+
+    { ide2: "#{volume.volid},media=cdrom" }
   end
 
   def check_template_format(user_data)

data/app/helpers/proxmox_vm_config_helper.rb

@@ -41,7 +41,7 @@ module ProxmoxVMConfigHelper
 
   def general_a(type)
     general_a = ['node_id', 'type', 'config_attributes', 'efidisk_attributes', 'volumes_attributes', 'interfaces_attributes', 'image_id']
-    general_a += ['firmware_type', 'provision_method', 'container_volumes', 'server_volumes', 'start_after_create']
+    general_a += ['firmware_type', 'provision_method', 'container_volumes', 'server_volumes', 'start_after_create', 'iso_upload_storage']
     general_a += ['name'] if type == 'lxc'
     general_a
   end

data/app/models/concerns/fog_extensions/proxmox/server.rb

@@ -21,7 +21,7 @@ module FogExtensions
   module Proxmox
     module Server
       extend ActiveSupport::Concern
-      attr_accessor :image_id, :templated, :ostemplate_storage, :ostemplate_file, :password, :start_after_create, :compute_resource_id
+      attr_accessor :image_id, :templated, :ostemplate_storage, :ostemplate_file, :iso_upload_storage, :password, :start_after_create, :compute_resource_id
 
       def unique_cluster_identity(compute_resource)
         compute_resource.id.to_s + '_' + identity.to_s

data/app/models/foreman_fog_proxmox/proxmox_images.rb

@@ -41,7 +41,7 @@ module ForemanFogProxmox
     end
 
     def available_images
-      templates.collect { |template| OpenStruct.new(id: template_uuid(template), name: template_name(template)) }
+      templates.collect { |template| OpenStruct.new(id: template_uuid(template), name: template_name(template)) }.uniq
     end
 
     def templates

data/app/models/foreman_fog_proxmox/proxmox_vm_commands.rb

@@ -42,7 +42,8 @@ module ForemanFogProxmox
         image = find_vm_by_uuid(image_id)
         validate_image_template_disk_slots!(image, args) if type == 'qemu'
         vm = clone_from_image(image, vmid)
-        vm.update(compute_clone_attributes(args, vm.container?, type, image: image))
+        cloudinit_args = cloudinit_clone_args(args, vm)
+        vm.update(compute_clone_attributes(cloudinit_args, vm.container?, type, image: image))
         update_pool(vm, args[:pool]) if args[:pool]
       else
         logger.warn("create vm: args=#{args}")
@@ -71,7 +72,6 @@ module ForemanFogProxmox
     end
 
     def compute_clone_attributes(args, container, type, image: nil)
-      args = parse_cloudinit_config(args) if args[:user_data]
       args[:config_attributes].merge!(update_boot_order(image)) if image && args[:config_attributes]
       parsed_args = parse_typed_vm(args, type)
       if container

data/app/models/foreman_fog_proxmox/proxmox_vm_new.rb

@@ -195,6 +195,17 @@ module ForemanFogProxmox
       vm_h[:is_secure_boot] = secure_boot if type == 'qemu' && secure_boot
     end
 
+    def add_image_attribute(vm_h, options)
+      image_id = options['image_id']
+      vm_h[:image_id] = image_id if image_id.present?
+    end
+
+    def add_iso_upload_storage_attribute(vm_h, options, type)
+      iso_upload_storage = options['iso_upload_storage']
+      vm_h[:iso_upload_storage] = iso_upload_storage if type == 'qemu' && iso_upload_storage.present?
+    end
+
+    # rubocop:disable Metrics/AbcSize
     def new_typed_vm(new_attr, type)
       convert_config_attributes(new_attr) if new_attr.key?(:config_attributes)
       node_id = new_attr['node_id']
@@ -210,11 +221,14 @@ module ForemanFogProxmox
       logger.debug("new_typed_vm(#{type}): options=#{options}")
       vm_h = parse_typed_vm(options, type).deep_symbolize_keys
       add_secure_boot_attribute(vm_h, options, type)
+      add_image_attribute(vm_h, options)
+      add_iso_upload_storage_attribute(vm_h, options, type)
       logger.debug("new_typed_vm(#{type}): vm_h=#{vm_h}")
       vm_h = vm_h.merge(vm_typed_instance_defaults(type)) if vm_h.empty?
       logger.debug(format(_('new_typed_vm(%<type>s) with vm_typed_instance_defaults: vm_h=%<vm_h>s'), type: type, vm_h: vm_h))
       node.send(vm_collection(type)).new(vm_h)
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end
 

data/app/views/compute_resources_vms/form/proxmox/_add_react_component_to_host_form.html.erb

@@ -1,4 +1,9 @@
+<% content_for(:stylesheets) do %>
+  <%= stylesheet_link_tag 'foreman_fog_proxmox/network_interface_modal' %>
+<% end %>
+
 <% content_for(:javascripts) do %>
+  <%= javascript_include_tag 'foreman_fog_proxmox/proxmox_network_interface_modal' %>
   <%= webpacked_plugins_js_for :foreman_fog_proxmox %>
 <% end %>
 <%= react_component('ProxmoxVmType', { registerComp: true }) unless @host.managed %>

data/app/views/compute_resources_vms/form/proxmox/_add_vm_type_to_nic_provider_specific_form.html.erb

@@ -20,12 +20,13 @@ along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>. %>
 <% vm_type = vm_type_and_node_id[:vm_type] %>
 <% node_id = vm_type_and_node_id[:node_id] %>
 
-<%= f.fields_for 'compute_attributes', OpenStruct.new(compute_attributes) do |f| %>
-    <%= render provider_partial(@host.compute_resource, 'network'), :f => f, :vm_type => vm_type, :node_id => node_id, :disabled => f.object.persisted?, :compute_resource => @host.compute_resource, :new_host => new_vm, :new_vm => new_vm %>
-<% end %>
+<div class="proxmox-interface-form">
+  <%= f.fields_for 'compute_attributes', OpenStruct.new(compute_attributes) do |f| %>
+      <%= render provider_partial(@host.compute_resource, 'network'), :f => f, :vm_type => vm_type, :node_id => node_id, :disabled => f.object.persisted?, :compute_resource => @host.compute_resource, :new_host => new_vm, :new_vm => new_vm %>
+  <% end %>
+</div>
 <% else %>
 <%= f.fields_for 'compute_attributes', OpenStruct.new(f.object.compute_attributes) do |f| %>
     <%= render provider_partial(@host.compute_resource, 'network'), :f => f, :disabled => f.object.persisted?, :compute_resource => @host.compute_resource, :new_host => new_vm, :new_vm => new_vm %>
 <% end %>
 <% end %>
-

data/lib/foreman_fog_proxmox/engine.rb

@@ -40,7 +40,14 @@ module ForemanFogProxmox
           register_global_js_file 'global'
           # Register Proxmox VE compute resource in foreman
           compute_resource ForemanFogProxmox::Proxmox
-          parameter_filter(ComputeResource, :uuid)
+          parameter_filter ComputeResource,
+            :uuid,
+            :ssl_verify_peer,
+            :ssl_certs,
+            :disable_proxy,
+            :auth_method,
+            :token_id,
+            :token
           # add dashboard widget
           widget 'foreman_fog_proxmox_widget', name: N_('Foreman Fog Proxmox widget'), sizex: 8, sizey: 1
 
@@ -111,7 +118,6 @@ module ForemanFogProxmox
       Fog::Proxmox::Compute::Interface.include FogExtensions::Proxmox::Interface
       Fog::Proxmox::Compute::Disk.include FogExtensions::Proxmox::Disk
       Fog::Proxmox::Compute::Node.include FogExtensions::Proxmox::Node
-      ::ComputeResourcesController.include ForemanFogProxmox::Controller::Parameters::ComputeResource
       ::ComputeResourcesVmsController.include ForemanFogProxmox::ComputeResourcesVmsController
       ::HostsController.include ForemanFogProxmox::HostsController
       ::Host::Managed.include Orchestration::Proxmox::Compute

data/lib/foreman_fog_proxmox/version.rb

@@ -18,5 +18,5 @@
 # along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
 
 module ForemanFogProxmox
-  VERSION = '0.25.1'
+  VERSION = '1.0.0'
 end

data/test/functional/compute_resources_controller_test.rb

@@ -79,6 +79,18 @@ module ForemanFogProxmox
       assert_instance_of Array, json_response
     end
     test 'should get metadata' do
+      node_a = stub(node: 'node-a')
+      node_b = stub(node: 'node-b')
+      node_a_storages = [{ storage: 'shared-iso', content: 'iso', avail: 100, used: 20, total: 120, shared: 1 }]
+      node_b_storages = [{ storage: 'local', content: 'iso', avail: 200, used: 30, total: 230, shared: 0 }]
+      node_a_bridges = [{ iface: 'vmbr0' }]
+      node_b_bridges = [{ iface: 'vmbr1' }]
+      @compute_resource.stubs(:nodes).returns([node_a, node_b])
+      @compute_resource.expects(:storages).with('node-a').returns(node_a_storages)
+      @compute_resource.expects(:storages).with('node-b').returns(node_b_storages)
+      @compute_resource.expects(:bridges).with('node-a').returns(node_a_bridges)
+      @compute_resource.expects(:bridges).with('node-b').returns(node_b_bridges)
+
       get :metadata, params: { :compute_resource_id => @compute_resource.id }, session: set_session_user
       assert_response :success
       show_response = @response.body
@@ -93,6 +105,35 @@ module ForemanFogProxmox
       assert_instance_of Array, json_response['pools']
       assert_instance_of Array, json_response['storages']
       assert_instance_of Array, json_response['bridges']
+      assert_equal ['node-a', 'node-b'], (json_response['storages'].map { |storage| storage['node_id'] })
+      assert_equal [1, 0], (json_response['storages'].map { |storage| storage['shared'] })
+      assert_equal ['node-a', 'node-b'], (json_response['bridges'].map { |bridge| bridge['node_id'] })
+      assert_equal ['vmbr0', 'vmbr1'], (json_response['bridges'].map { |bridge| bridge['iface'] })
+    end
+
+    test 'metadata includes shared storage for every node where it is available' do
+      node_a = stub(node: 'node-a')
+      node_b = stub(node: 'node-b')
+      shared_storage = {
+        storage: 'shared-iso',
+        content: 'iso',
+        avail: 100,
+        used: 20,
+        total: 120,
+        shared: 1,
+      }
+      @compute_resource.stubs(:nodes).returns([node_a, node_b])
+      @compute_resource.expects(:storages).with('node-a').returns([shared_storage])
+      @compute_resource.expects(:storages).with('node-b').returns([shared_storage])
+
+      get :metadata, params: { :compute_resource_id => @compute_resource.id }, session: set_session_user
+      assert_response :success
+      json_response = JSON.parse(@response.body)
+
+      assert_equal [
+        ['shared-iso', 'node-a'],
+        ['shared-iso', 'node-b'],
+      ], (json_response['storages'].map { |storage| [storage['storage'], storage['node_id']] })
     end
   end
 end

data/test/unit/foreman_fog_proxmox/proxmox_images_test.rb

@@ -43,5 +43,18 @@ module ForemanFogProxmox
         @cr.clone_from_image(@image, @vmid)
       end
     end
+
+    describe 'available_images' do
+      it 'removes duplicates' do
+        @cr = FactoryBot.build_stubbed(:proxmox_cr)
+        clone = mock('vm')
+        clone.stubs(:name).returns('vm-1')
+        @cr.stubs(:find_vm_by_uuid).returns(clone)
+        template = mock('template')
+        template.stubs(:vmid).returns(100).at_least(2)
+        @cr.stubs(:templates).returns([template, template])
+        assert_equal 1, @cr.available_images.length
+      end
+    end
   end
 end