foreman_virt_who_configure 0.5.7 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a6d5edff03f44341f5a5c589b370b07df3fc79be8da03cc15a8e510c3bbab25
-  data.tar.gz: 14532602b8e22287a71eae220793f2865bed9265630b25ee326bb9b457cbabf2
+  metadata.gz: 4530753c078a8fb15731435042afcbc985207fe160b96d242e04ecfc9d2078f2
+  data.tar.gz: 8013fca41321555482fe77a5203d7558b7828cfe7989208c4121686aa8c5dc2f
 SHA512:
-  metadata.gz: 70d8749e99f5ca805edda408c2fe9bb2013c6df149bcf403d79405c88363889e73170c6f3180f6b1b5ee0c42565649b5b4b68bbba86cd654af831a832de4ed1c
-  data.tar.gz: d762a6229d23557e188accde65b70a32faec53d98f62b55914e9f380e18671feb401fc7df033fbe20e74527e1aa860f319c95923a39fa682c31c7d9cd7aeda90
+  metadata.gz: 45f214c29a0c4e76fb92834bb6f5a124fbac03788e5e235da28dfe798be08d7a36c121d50e7e135bc5fb78a93ba6616784965e76ec6a1ea46949207c0c99e706
+  data.tar.gz: 3f66cb56f3efa3e59c016e40d22ff0f9aeff357be3901f2c7937e3eeef98bfb802d7ae762ec83f40030dc4211b2f6c81c134127d548b9dc8162f9a50016e04bf

data/app/assets/javascripts/foreman_virt_who_configure/config_edit.js

@@ -35,7 +35,13 @@ function virt_who_update_hypervisor_fields() {
   element.closest('.form-group').toggle(selected_type == 'kubevirt');
   var element = $('#foreman_virt_who_configure_config_hypervisor_server');
   element.closest('.form-group').toggle(selected_type != 'kubevirt');
+  var element = $('#foreman_virt_who_configure_config_ahv_update_interval');
+  element.closest('.form-group').toggle(selected_type == 'ahv');
+  var element = $('#foreman_virt_who_configure_config_ahv_internal_debug');
+  element.closest('.form-group').toggle(selected_type == 'ahv');
   virt_who_update_listing_mode();
+  var element = $('#foreman_virt_who_configure_config_prism_flavor');
+  element.closest('.form-group').toggle(selected_type == 'ahv');
 }
 
 function virt_who_update_credentials_help() {
@@ -53,9 +59,23 @@ function virt_who_update_credentials_help() {
   });
 }
 
+function virt_who_update_ahv_debug() {
+  var element = $('#foreman_virt_who_configure_config_ahv_internal_debug');
+  var element_debug = $('#foreman_virt_who_configure_config_debug');
+
+  element.mouseenter(function(){
+    var inline_help_popover_ahv = element.parents('.form-group').find('.help-inline a[rel=popover]');
+    var inline_help_popover_global = element_debug.parents('.form-group').find('.help-inline a[rel=popover]');
+    inline_help_popover_ahv.popover('show');
+    inline_help_popover_global.popover('show');
+  });
+}
+
 $(document).ready(function () {
   virt_who_update_listing_mode();
   virt_who_update_hypervisor_fields();
+  virt_who_update_ahv_debug();
+
   $('#foreman_virt_who_configure_config_listing_mode').change(virt_who_update_listing_mode);
   $('#foreman_virt_who_configure_config_hypervisor_type').change(virt_who_update_credentials_help);
   $('#foreman_virt_who_configure_config_hypervisor_type').change(virt_who_update_hypervisor_fields);

data/app/controllers/foreman_virt_who_configure/api/v2/configs_controller.rb

@@ -47,14 +47,18 @@ module ForemanVirtWhoConfigure
             param :exclude_host_parents, String, :desc => N_("Applicable only for esx provider type. Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will <b>NOT</b> be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end."), :required => false
             param :hypervisor_id, Config::HYPERVISOR_IDS, :desc => N_("Specifies how the hypervisor will be identified."), :required => true
             param :hypervisor_type, Config::HYPERVISOR_TYPES.keys, :desc => N_("Hypervisor type"), :required => true
-            param :hypervisor_server, String, :desc => N_("Fully qualified host name or IP address of the hypervisor"), :required => true
-            param :hypervisor_username, String, :desc => N_("Account name by which virt-who is to connect to the hypervisor."), :required => true
-            param :hypervisor_password, String, :desc => N_("Hypervisor password, required for all hypervisor types except for libvirt"), :required => false
+            param :hypervisor_server, String, :desc => N_("Fully qualified host name or IP address of the hypervisor"), :required => false
+            param :hypervisor_username, String, :desc => N_("Account name by which virt-who is to connect to the hypervisor."), :required => false
+            param :hypervisor_password, String, :desc => N_("Hypervisor password, required for all hypervisor types except for libvirt/kubevirt."), :required => false
             param :satellite_url, String, :desc => N_("Foreman server FQDN"), :required => true
             param :debug, :bool, :desc => N_("Enable debugging output")
+            param :kubeconfig_path, String, :desc => N_('Configuration file containing details about how to connect to the cluster and authentication details.'), :required => false
             param :http_proxy_id, Integer, :desc => N_('HTTP proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers.')
             param :no_proxy, String, :desc => N_("Ignore proxy. A comma-separated list of hostnames or domains or ip addresses to ignore proxy settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses.")
             param :organization_id, Integer, :required => true, :desc => N_("Organization of the virt-who configuration") if ::SETTINGS[:organizations_enabled]
+            param :prism_flavor, Config::PRISM_FLAVORS.keys, :desc => N_("Select the Prism flavor you are connecting to"), :required => false
+            param :ahv_update_interval, Integer, :desc => N_("The frequency of VM-to-host mapping updates for AHV(in seconds)"), :required => false
+            param :ahv_internal_debug, :bool, :desc => N_("Option Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled"), :required => false
           end
         end
 

data/app/helpers/foreman_virt_who_configure/configs_helper.rb

@@ -5,7 +5,8 @@ module ForemanVirtWhoConfigure
         'esx' => _('VMware vCenter server’s fully qualified host name or IP address.'),
         'hyperv' => _('Microsoft Hyper-V fully qualified host name or IP address.'),
         'libvirt' => _('Libvirt server’s fully qualified host name or IP address. You can also specify preferred schema, for example: <code>qemu+ssh://libvirt.example.com/system</code>. If you use SSH, make sure you setup root\'s SSH key on target host for a user specified at hypervisor username field'),
-        'kubevirt' => _('Container-native virtualization’s fully qualified host name or IP address. In order to connect to the cluster it is required to provide path to kubeconfig which contains connection details and authentication token.')
+        'kubevirt' => _('Container-native virtualization’s fully qualified host name or IP address. In order to connect to the cluster it is required to provide path to kubeconfig which contains connection details and authentication token.'),
+        'ahv' => _('Nutanix AHV’s IP address.')
       }
     end
 
@@ -14,7 +15,8 @@ module ForemanVirtWhoConfigure
         'esx' => _('Account name by which virt-who is to connect to the hypervisor, in the format <code>domain_name\account_name</code>. Note that only a single backslash separates the values for domain_name and account_name. If you are using a domain account, and the global configuration file <code>/etc/virt-who.conf</code>, then <b>two</b> backslashes are required. For further details, see <a href="https://access.redhat.com/solutions/1270223">Red Hat Knowledgebase solution How to use a windows domain account with virt-who</a> for more information.'),
         'hyperv' => _('Account name by which virt-who is to connect to the hypervisor. By default this is <code>Administrator</code>. To use an alternate account, create a user account and assign that account to the following groups (Windows 2012 Server): Hyper-V Administrators and Remote Management Users.'),
         'libvirt' => _('Account name by which virt-who is to connect to the hypervisor. Virt-who does not support password based authentication, you must manually setup SSH key, see <a href="https://access.redhat.com/solutions/1515983">Red Hat Knowledgebase solution How to configure virt-who for a KVM host</a> for more information.'),
-        'kubevirt' => ''
+        'kubevirt' => '',
+        'ahv' => _('Account name by which virt-who is to connect to Nutanix AHV.')
       }
     end
 

data/app/models/foreman_virt_who_configure/config.rb

@@ -6,7 +6,8 @@ module ForemanVirtWhoConfigure
       :satellite_url, :http_proxy_id, :no_proxy, :name,
       # API parameter filtering_mode gets translated to listing_mode in the controller
       # We keep both params permitted for compatibility with 1.11
-      :listing_mode, :filtering_mode, :filter_host_parents, :exclude_host_parents, :kubeconfig_path
+      :listing_mode, :filtering_mode, :filter_host_parents, :exclude_host_parents, :kubeconfig_path,
+      :prism_flavor, :ahv_update_interval, :ahv_internal_debug
     ]
     audited :except => [ :hypervisor_password, :last_report_at, :out_of_date_at ], :associations => []
     include Authorizable
@@ -33,7 +34,8 @@ module ForemanVirtWhoConfigure
       'esx' => 'VMware vSphere / vCenter (esx)',
       'hyperv' => 'Microsoft Hyper-V (hyperv)',
       'libvirt' => 'libvirt',
-      'kubevirt' => 'Container-native virtualization'
+      'kubevirt' => 'Container-native virtualization',
+      'ahv' => 'Nutanix AHV (ahv)'
     }
 
     HYPERVISOR_DEFAULT_TYPE = 'esx'
@@ -65,6 +67,15 @@ module ForemanVirtWhoConfigure
       }
     )
 
+    PRISM_FLAVORS = {
+      'central' => N_('Prism Central'),
+      'element' => N_('Prism Element')
+    }       
+
+    AHV_VALID_OPTIONS = %w(prism_flavor ahv_update_interval ahv_internal_debug)
+    KUBEVIRT_VALID_OPTIONS = %w(kubeconfig_path)
+    KUBEVIRT_INVALID_OPTIONS = %w(hypervisor_server hypervisor_username)
+
     include Encryptable
     encrypts :hypervisor_password
 
@@ -97,11 +108,16 @@ module ForemanVirtWhoConfigure
     validates :hypervisor_password, :presence => true, :if => Proc.new { |c| c.hypervisor_type != 'libvirt' && c.hypervisor_type != 'kubevirt' }
     validates :hypervisor_username, :presence => true, :if => Proc.new { |c| c.hypervisor_type != 'kubevirt' }
     validates :hypervisor_server, :presence => true, :if => Proc.new { |c| c.hypervisor_type != 'kubevirt' }
+    validates :kubeconfig_path, :presence => true, :if => Proc.new { |c| c.hypervisor_type == 'kubevirt' }
     validates :hypervisor_type, :inclusion => HYPERVISOR_TYPES.keys
     validates :hypervisor_id, :inclusion => HYPERVISOR_IDS
     validates :interval, :inclusion => AVAILABLE_INTERVALS.keys.map(&:to_i)
     validates :listing_mode, :inclusion => FILTERING_MODES.keys.map(&:to_i)
+    validates :ahv_update_interval, numericality: { only_integer: true, allow_nil: true, greater_than: 0 }, :if => Proc.new { |c| c.hypervisor_type == 'ahv' }
+    validates :prism_flavor, :inclusion => {:in => PRISM_FLAVORS.keys, :message => "should be either central or element"}, :if => Proc.new { |c| c.hypervisor_type == 'ahv' }
     validate :validates_whitelist_blacklist
+    validate :validates_debug_settings, :if => Proc.new { |c| c.hypervisor_type == 'ahv' }
+    validate :validates_hypervisor_options
 
     def validates_whitelist_blacklist
       case listing_mode.to_i
@@ -116,6 +132,18 @@ module ForemanVirtWhoConfigure
       end
     end
 
+    def validates_debug_settings
+      if ahv_internal_debug && !debug
+        errors.add(:ahv_internal_debug, "Enable debugging output is required for Enable AHV debug") 
+      end
+    end    
+
+    def validates_hypervisor_options
+      invalid = hypervisor_type == 'kubevirt' ? KUBEVIRT_INVALID_OPTIONS : KUBEVIRT_VALID_OPTIONS
+      invalid.concat(AHV_VALID_OPTIONS) unless hypervisor_type == 'ahv'
+      invalid.each { |f| errors.add(f, "Invalid option for hypervisor [#{hypervisor_type}]") if eval(f).present? }
+    end
+
     validates_lengths_from_database
 
     before_validation :remove_whitespaces

data/app/models/foreman_virt_who_configure/output_generator.rb

@@ -120,7 +120,7 @@ env=Library#{connection_details}#{filtering}
 rhsm_hostname=#{satellite_url}
 rhsm_username=#{service_user_username}
 rhsm_encrypted_password=$user_password
-rhsm_prefix=/rhsm#{kubeconfig}
+rhsm_prefix=/rhsm#{kubeconfig}#{ahv_config_options}
 EOF
   if [ $? -ne 0 ]; then result_code=$(($result_code|#{error_code(:virt_who_config_file_issue)})); fi
 
@@ -165,6 +165,18 @@ encrypted_password=$cr_password"
       end
     end
 
+    def ahv_config_options
+      if config.hypervisor_type == 'ahv'
+        prism_central = config.prism_flavor == "central"
+        update_interval = config.ahv_update_interval.present? ? "\nupdate_interval=#{config.ahv_update_interval}" : nil
+        internal_debug = config.ahv_internal_debug.present? ? "\ninternal_debug=#{config.ahv_internal_debug}" : nil
+
+        "\nprism_central=#{prism_central}#{internal_debug}#{update_interval}"
+      else
+        ""
+      end
+    end
+
     def error_handling
       CONFIGURATION_RESULTS.map do |result|
         "[ $(($result_code&#{result.code})) -ge 1 ] && echo '#{result.message}'"

data/app/views/foreman_virt_who_configure/api/v2/configs/main.json.rabl

@@ -9,7 +9,8 @@ end
 attributes :name, :interval, :organization_id, :whitelist, :blacklist, :hypervisor_id,
            :hypervisor_type, :hypervisor_server, :hypervisor_username, :debug,
            :satellite_url, :proxy, :no_proxy, :status, :last_report_at, :out_of_date_at,
-           :filter_host_parents, :exclude_host_parents, :kubeconfig_path
+           :filter_host_parents, :exclude_host_parents, :kubeconfig_path,
+           :prism_flavor, :ahv_update_interval, :ahv_internal_debug
 
 child :http_proxy do
   attributes :id, :name, :url

data/app/views/foreman_virt_who_configure/configs/show.html.erb

@@ -52,6 +52,9 @@
           <%= config_attribute :http_proxy_id, @config.http_proxy.full_url, _('HTTP Proxy') if @config.http_proxy.present? %>
           <%= config_attribute :no_proxy, @config.no_proxy, _('Ignore Proxy') if @config.no_proxy.present? %>
           <%= config_attribute :kubeconfig_path, @config.kubeconfig_path if @config.hypervisor_type == 'kubevirt' %>
+          <%= config_attribute :prism_flavor, @config.prism_flavor if @config.hypervisor_type == 'ahv' %>
+          <%= config_attribute :ahv_update_interval, @config.ahv_update_interval if @config.hypervisor_type == 'ahv' %>
+          <%= config_attribute :ahv_internal_debug, checked_icon(@config.ahv_internal_debug) if @config.hypervisor_type == 'ahv' %>
         </div>
       </div>
     </div>

data/app/views/foreman_virt_who_configure/configs/steps/_connection_form.erb

@@ -22,4 +22,10 @@
         inline_help_popover(_('HTTP proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers. Leave this blank if no proxy is used.').html_safe)) %>
   <%= text_f f, :no_proxy, inline_help_popover(_('A comma-separated list of hostnames or domains or ip addresses to ignore proxy settings for. Optionally this may be set to <code>*</code> to bypass proxy settings for all hostnames domains or ip addresses.')).merge(:label => _('Ignore proxy')) %>
   <%= text_f f, :kubeconfig_path, inline_help_popover(_('Configuration file containing details about how to connect to the cluster and authentication details')).merge(:label => _('Path to kubeconfig file')) %>
+
+  <%= selectable_f f, :prism_flavor, {'' => 'Nothing selected'}.merge(ForemanVirtWhoConfigure::Config::PRISM_FLAVORS).map { |k,v| [_(v), k] },
+        {}, { label: _('Prism Flavor'), :required => true }.merge(
+        inline_help_popover(_("Select the Prism flavor you are connecting to"))) %>
+  <%= text_f f, :ahv_update_interval, inline_help_popover(_('The frequency of VM-to-host mapping updates for AHV(in seconds)')).merge(:label => _('AHV update interval')) %>
+  <%= checkbox_f f, :ahv_internal_debug, inline_help_popover(_('Option Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled ')).merge(:label => _('Enable AHV debug')) %>
 </div>

data/db/migrate/20210910184516_add_ahv_to_config.rb

@@ -0,0 +1,7 @@
+class AddAhvToConfig < ActiveRecord::Migration[6.0]
+  def change
+    add_column :foreman_virt_who_configure_configs, :prism_flavor, :string, :null => true
+    add_column :foreman_virt_who_configure_configs, :ahv_update_interval, :integer, :null => true
+    add_column :foreman_virt_who_configure_configs, :ahv_internal_debug, :boolean, :null => true
+  end
+end

data/lib/foreman_virt_who_configure/version.rb

@@ -1,3 +1,3 @@
 module ForemanVirtWhoConfigure
-  VERSION = '0.5.7'.freeze
+  VERSION = '0.5.8'.freeze
 end

data/test/functional/api/v2/configs_controller_test.rb

@@ -17,7 +17,6 @@ class ForemanVirtWhoConfigure::Api::V2::ConfigsControllerTest < ActionController
                                  :http_proxy_id => @http_proxy.id,
                                  :no_proxy => nil
     )
-
     @out_of_date_config = FactoryBot.create(:virt_who_config, :out_of_date)
     @ok_config = FactoryBot.create(:virt_who_config, :ok)
   end
@@ -128,6 +127,45 @@ class ForemanVirtWhoConfigure::Api::V2::ConfigsControllerTest < ActionController
     assert_equal @out_of_date_config.virt_who_config_script(:bash_script), response
   end
 
+  test 'should fail without kubeconfig_path in kubeconfig config' do
+    org = FactoryBot.create(:organization)
+    post :create, :params => { :foreman_virt_who_configure_config => { :name => 'my new config',
+                                                            :filtering_mode => ForemanVirtWhoConfigure::Config::UNLIMITED,
+                                                            :hypervisor_id => 'uuid',
+                                                            :hypervisor_type => 'kubevirt',
+                                                            :satellite_url => "foreman.example.com",
+                                                            :organization_id => org.id }
+    }, :session => set_session_user
+
+    assert_response :unprocessable_entity
+
+    response = ActiveSupport::JSON.decode(@response.body)
+    assert_equal "Kubeconfig path can't be blank", response['error']['full_messages'].join('')
+  end
+
+  test 'should not accept kubeconfig for other hypervisor types' do
+    org = FactoryBot.create(:organization)
+    post :create, :params => { :foreman_virt_who_configure_config => { :name => 'my new config',
+                                                            :interval => 240,
+                                                            :filtering_mode => ForemanVirtWhoConfigure::Config::BLACKLIST,
+                                                            :blacklist => ' a,b ',
+                                                            :hypervisor_id => 'uuid',
+                                                            :hypervisor_type => 'esx',
+                                                            :hypervisor_server => "vmware.example.com",
+                                                            :hypervisor_username => "root",
+                                                            :hypervisor_password => "password",
+                                                            :debug => true,
+                                                            :satellite_url => "foreman.example.com",
+                                                            :kubeconfig_path => '/tmp/food',
+                                                            :organization_id => org.id }
+    }, :session => set_session_user
+
+    assert_response :unprocessable_entity
+
+    response = ActiveSupport::JSON.decode(@response.body)
+    assert_equal "Kubeconfig path Invalid option for hypervisor [esx]", response['error']['full_messages'].join('')
+  end
+
   test "should create the config" do
     org = FactoryBot.create(:organization)
     post :create, :params => { :foreman_virt_who_configure_config => { :name => 'my new config',

data/test/unit/output_generator_test.rb

@@ -128,5 +128,29 @@ module ForemanVirtWhoConfigure
         assert_includes bash_script_output, 'step 1 "Installing virt-who"'
       end
     end
+
+    describe 'nutanix ahv' do
+      test 'options specific to ahv are all set' do
+        config.hypervisor_type = 'ahv'
+        config.prism_flavor = 'central'
+        config.ahv_update_interval = 100
+        config.ahv_internal_debug = true
+
+        assert_includes output, 'type=ahv'
+        assert_includes output, 'prism_central=true'
+        assert_includes output, 'update_interval=100'
+        assert_includes output, 'internal_debug=true'
+      end
+
+      test 'options specific to ahv are not all set' do
+        config.hypervisor_type = 'ahv'
+        config.prism_flavor = 'central'
+
+        assert_includes output, 'type=ahv'
+        assert_includes output, 'prism_central=true'
+        assert_not_includes output, 'update_interval='
+        assert_not_includes output, 'update_interval='
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_virt_who_configure
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors:
 - Foreman virt-who-configure team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katello
@@ -111,6 +111,7 @@ files:
 - db/migrate/20201211160234_add_foreign_key_proxy_id.rb
 - db/migrate/20210413165147_delete_xen_profiles.rb
 - db/migrate/20210608100743_delete_rhevm_profiles.rb
+- db/migrate/20210910184516_add_ahv_to_config.rb
 - lib/foreman_virt_who_configure.rb
 - lib/foreman_virt_who_configure/engine.rb
 - lib/foreman_virt_who_configure/version.rb