foreman_fog_proxmox 0.13.0 → 0.13.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6101f16731ab275d2adfb1b0abc8fd25690688e34569b7f63c360fb6442da5ec
-  data.tar.gz: 62bfd05f02a526de1a4decc27d5a8c6ee5539b58316fb0bc29338dc26f4c0a04
+  metadata.gz: e42832dc77d338bb20585f27678bc2207c23a610f7c7b478f24f3791ca65a414
+  data.tar.gz: 1385bea7eed802496ae7ab85ca013e75dc0343a8a433a347d8811b59fd620cd0
 SHA512:
-  metadata.gz: d46aa0181a540105670a8b4cc988f791cde9ac05d8323c2eec250d53ee44c1b1eaea581619276f21cc7a433931470007019e2e3028ece8f750b4fcef704398ac
-  data.tar.gz: ce879270338d08b684991184079b8106519de9394c4e85b8cfcc74e5e30620a75d217eefa8ce8301711b30fbcd20ef051925a3190ae5b8b34e4c4157a1a3895c
+  metadata.gz: 91a262ffeb2b720fae01136cdcd158cd8c577702fafbea36d550eae859c6734f7a7ec1c390b39077852100d4507d9b3502bb7f3f1cb5c7d22c02cd7b012c51cf
+  data.tar.gz: 25512a916934966d9b5e66494f1b294c5b13d69ba326ed61170e330bff616111103984701a6311b150fb444dab3f0a48920c8debe193b7698a2ec43a0110cdd1

data/README.md

@@ -32,7 +32,9 @@ You can support the plugin development via the following methods:
 |>=0.10 |>=5.4|>=0.9.4|>=1.22|>=2.5|
 |>=0.11 |>=5.4|>=0.10|>=1.22|>=2.5|
 |>=0.12 |>=6.1|>=0.11|>=2.0|>=2.5|
-|>=0.14 |>=6.2|>=0.13|>=2.0|>=2.5|
+|>=0.14 |>=6.2|=0.13.0|>=2.4|>=2.7|
+|>=0.14 |>=6.2|>=0.13.1|>=2.3|>=2.5|
+|>=0.14 |>=6.2|>=0.14.0|>=2.5|>=2.5|
 
 ## Installation
 
@@ -46,10 +48,10 @@ See complete details in [plugin installation from gem](https://theforeman.org/pl
 
 Here is a Debian sample:
 
-* Install foreman [from OS packages](https://theforeman.org/manuals/1.19/index.html#3.3InstallFromPackages):
+* Install foreman [from OS packages](https://theforeman.org/manuals/latest/index.html#3.3InstallFromPackages):
 
 ```shell
-sudo apt install -y foreman foreman-compute foreman-sqlite3 foreman-assets
+sudo apt install -y foreman foreman-pgsql
 ```
 
 * Use only foreman user (**not root!**) `sudo -u foreman ...`
@@ -101,7 +103,21 @@ Then you can check plugin installation after login into your new foreman server
 
 Please see the Foreman manual for complete instructions:
 
-* [Foreman: How to Install a Plugin](http://theforeman.org/manuals/latest/index.html#6.1InstallaPlugin)
+* [Foreman: How to Install a Plugin from package](https://theforeman.org/plugins/#2.Installation)
+
+[Install from package](https://theforeman.org/plugins/#2.2Packageinstallation) is the easiest way to install the plugin. Choose the latest release plugins repository. If you don't find it in the same foreman release repository, get it from the `nightly` repository.
+
+Then you can install it with the package manager, in Debian/Ubuntu:
+
+```shell
+sudo apt-get install ruby-foreman-fog-proxmox
+```
+
+and in Fedora/Redhat Linux:
+
+```shell
+sudo dnf install rubygem-foreman_fog_proxmox
+```
 
 Redhat, CentOS or Fedora users should also [setup Selinux](https://projects.theforeman.org/projects/foreman/wiki/SELinux) to allow foreman and all its plugins to work.
 
@@ -112,7 +128,7 @@ Redhat, CentOS or Fedora users should also [setup Selinux](https://projects.thef
 
 ## Development
 
-### Prerequisites
+### Dev prerequisites
 
 * You need a Proxmox VE 5.4+ server running.
 * You need ruby >= 2.5. You can install it with [asdf-vm](https://asdf-vm.com).
@@ -136,6 +152,7 @@ gem 'foreman_fog_proxmox', :path => '../../theforeman/foreman_fog_proxmox'
 gem 'fog-proxmox', :path => '../../fog/fog-proxmox' # optional if you need to modify fog-proxmox code too
 gem 'ruby-debug-ide' # dev
 gem 'debase' # dev
+gem 'solargraph' # dev
 gem 'simplecov' # test
 ```
 
@@ -143,8 +160,9 @@ gem 'simplecov' # test
 
 ```shell
 gem install bundler
-# prerequisites postgresql-client library on OS
+# prerequisites postgresql-XX-client library on OS (XX=major release installed in OS)
 bundle config set without 'libvirt ovirt mysql2'
+bundle config build.pg --with-pg-config=/usr/pgsql-XX/bin/pg_config
 bundle install
 ```
 
@@ -177,7 +195,7 @@ cp config/model.mappings.example config/model.mappings
 cp config/database.yml.example config/database.yml
 ```
 
-add these lines to config/database.yml:
+add these lines to each environment in config/database.yml:
 
 ```yaml
     username: foreman
@@ -186,8 +204,9 @@ add these lines to config/database.yml:
 
 ```shell
 cp config/ignored_environments.yml.sample config/ignored_environments.yml
-docker run --name foreman-db -e POSTGRES_DB=foreman -e POSTGRES_USER=foreman -e POSTGRES_PASSWORD=foreman -p 5432:5432 -d postgres
+docker run --name foreman-db -v foreman_data:/var/lib/postgresql/data -e POSTGRES_DB=foreman -e POSTGRES_USER=foreman -e POSTGRES_PASSWORD=foreman -p 5432:5432 -d postgres
 bundle exec bin/rake db:migrate
+# reboot if settings.NAME error in schema
 bundle exec bin/rake db:seed assets:precompile locale:pack webpack:compile
 ```
 
@@ -206,7 +225,15 @@ docker exec -it foreman-db psql -U foreman
 foreman=# create database "foreman-test";
 ```
 
-all:
+then add test schema and seeds:
+
+```shell
+RAILS_ENV=test bundle exec bin/rake db:migrate
+# reboot if error: "ActiveRecord::RecordNotFound: Couldn't find Setting with [WHERE "settings"."name" = $1]"
+RAILS_ENV=test bundle exec bin/rake db:seed
+```
+
+Finally you can test all:
 
 ```shell
 export DISABLE_SPRING=true
@@ -274,6 +301,12 @@ bundle exec bin/rails server
 bundle exec foreman start
 ```
 
+If you want to delete vm on host destroy, add this line in config/settings.yml:
+
+```yml
+:destroy_vm_on_host_delete: false
+```
+
 See details in [foreman plugin development](https://projects.theforeman.org/projects/foreman/wiki/How_to_Create_a_Plugin)
 
 ## Contributing

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

@@ -36,20 +36,32 @@ function sslVerifyPeerSelected() {
   }
 }
 
+function enableField(item) {
+  $(item).show();
+  $(item).removeAttr('disabled');
+}
+
+function disableField(item) {  
+  $(item).hide();
+  $(item).attr('disabled','disabled');
+}
+
+function toggleFieldset(method, selected){
+  return method === selected ? enableField(authMethodFieldsetId(method)) : disableField(authMethodFieldsetId(method));
+}
+
+function authMethods(){
+  return ['user_token', 'access_ticket'];
+}
+
+function authMethodFieldsetId(method){
+  return '#compute_ressource_' + method + '_field_set';
+}
+
 function authMethodSelected() {
   var selected = $("#compute_resource_auth_method").val();
   console.log("auth_method="+selected);
-  var compute_ressource_user_token_field_set = $('#compute_ressource_user_token_field_set');
-  var compute_ressource_access_ticket_field_set = $('#compute_ressource_access_ticket_field_set');
-  if (selected == 'user_token') {
-    compute_ressource_user_token_field_set.show();
-    compute_ressource_user_token_field_set.removeAttr('disabled');
-    compute_ressource_access_ticket_field_set.hide();
-    compute_ressource_access_ticket_field_set.attr('disabled','disabled');
-  } else {
-    compute_ressource_access_ticket_field_set.show();
-    compute_ressource_access_ticket_field_set.removeAttr('disabled');
-    compute_ressource_user_token_field_set.hide();
-    compute_ressource_user_token_field_set.attr('disabled','disabled');
-  }
+  authMethods().forEach(function(method){
+    toggleFieldset(method, selected);
+  });
 }

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

@@ -39,17 +39,17 @@ function vmTypeSelected() {
   return false;
 }
 
-function volumeButtonAddId(id){
-  return $("a[data-association='" + id + "_volumes']");
+function volumeButtonAddId(item){
+  return $("a[data-association='" + item + "_volumes']");
 }
 
-function volumeFieldsetId(id, type){
-  return $("fieldset[id^='" + type + "_volume_"+ id +"']").not("fieldset[id$='_new_" + id +"_volumes']");
+function volumeFieldsetId(item, type){
+  return $("fieldset[id^='" + type + "_volume_"+ item +"']").not("fieldset[id$='_new_" + item +"_volumes']");
 }
 
-function indexByIdAndType(id, storage_type, vm_type){
-  let regex = new RegExp(`${vm_type}_volume_${storage_type}_(\\d+)`);
-  return id.match(regex)[1];
+function indexByIdAndType(item, storage_type, vm_type){
+  var regex = new RegExp(vm_type +"_volume_" + storage_type +"_(\\d+)");
+  return item.match(regex)[1];
 }
 
 function volidByIndexAndTag(index, tag){
@@ -58,10 +58,10 @@ function volidByIndexAndTag(index, tag){
 
 function hasCloudinit(){
   result = false;
-  let id = volumeFieldsetId('cloud_init', 'server').attr('id');
-  if (id !== undefined){
-    let index = indexByIdAndType(id, 'cloud_init', 'server');
-    let volid = volidByIndexAndTag(index, 'input');
+  var volume_id = volumeFieldsetId('cloud_init', 'server').attr('id');
+  if (volume_id !== undefined){
+    var index = indexByIdAndType(volume_id, 'cloud_init', 'server');
+    var volid = volidByIndexAndTag(index, 'input');
     result = volid.includes("cloudinit");
   }
   return result;
@@ -69,42 +69,42 @@ function hasCloudinit(){
 
 function hasCdrom(){
   result = false;
-  let id = volumeFieldsetId('cdrom', 'server').attr('id');
-  if (id !== undefined){
-    let index = indexByIdAndType(id, 'cdrom', 'server');
-    let checked = $("input[id^='host_compute_attributes_volumes_attributes_" + index + "_cdrom']:checked").val();
-    let isCdrom = checked === 'cdrom';
+  var volume_id = volumeFieldsetId('cdrom', 'server').attr('id');
+  if (volume_id !== undefined){
+    var index = indexByIdAndType(volume_id, 'cdrom', 'server');
+    var checked = $("input[id^='host_compute_attributes_volumes_attributes_" + index + "_cdrom']:checked").val();
+    var isCdrom = checked === 'cdrom';
     result = isCdrom;
-    let isImage = checked === 'image';
+    var isImage = checked === 'image';
     if (isImage) {
-      let volid = volidByIndexAndTag(index, 'select');
+      var volid = volidByIndexAndTag(index, 'select');
       result = volid.includes("iso");
     }
   }
   return result;
 }
 
-function cloudinit(id){
-  return id === 'cloud_init' && hasCloudinit();
+function cloudinit(item){
+  return item === 'cloud_init' && hasCloudinit();
 }
 
-function cdrom(id){
-  return id === 'cdrom' && hasCdrom();
+function cdrom(item){
+  return item === 'cdrom' && hasCdrom();
 }
 
-function enableVolume(id, type){
-  volumeFieldsetId(id, type).show();
-  volumeButtonAddId(id).show();
-  if (cloudinit(id) || cdrom(id)){
-    volumeButtonAddId(id).hide();
+function enableVolume(volume_id, type){
+  volumeFieldsetId(volume_id, type).show();
+  volumeButtonAddId(volume_id).show();
+  if (cloudinit(volume_id) || cdrom(volume_id)){
+    volumeButtonAddId(volume_id).hide();
   }
-  volumeFieldsetId(id, type).removeAttr('disabled');
+  volumeFieldsetId(volume_id, type).removeAttr('disabled');
 }
 
-function disableVolume(id, type){
-  volumeFieldsetId(id, type).hide();
-  volumeButtonAddId(id).hide();
-  volumeFieldsetId(id, type).attr('disabled','disabled');
+function disableVolume(volume_id, type){
+  volumeFieldsetId(volume_id, type).hide();
+  volumeButtonAddId(volume_id).hide();
+  volumeFieldsetId(volume_id, type).attr('disabled','disabled');
 }
 
 function volumes(type){
@@ -115,44 +115,44 @@ function volume(type){
   return type === 'qemu' ? 'server' : 'container';
 }
 
-function toggleVolume(id, type1, type2){
-  type1 === type2 ? enableVolume(id, volume(type1)) : disableVolume(id, volume(type1));
+function toggleVolume(volume_id, type1, type2){
+  type1 === type2 ? enableVolume(volume_id, volume(type1)) : disableVolume(volume_id, volume(type1));
 }
 
 function toggleVolumes(selected){
    ['qemu', 'lxc'].forEach(function(type){
-    volumes(type).forEach(function(id){
-      toggleVolume(id, selected, type);
+    volumes(type).forEach(function(volume_id){
+      toggleVolume(volume_id, selected, type);
     });
   });
 }
 
-function enableFieldset(id, fieldset) {
+function enableFieldset(fieldsetId, fieldset) {
   if (fieldset.toggle && fieldset.new_vm){
-    fieldset_id(id, fieldset).show();
+    fieldset_id(fieldsetId, fieldset).show();
   }
-  fieldset_id(id, fieldset).removeAttr('disabled');
-  input_hidden_id(id).removeAttr('disabled');
+  fieldset_id(fieldsetId, fieldset).removeAttr('disabled');
+  input_hidden_id(fieldsetId).removeAttr('disabled');
 }
 
-function disableFieldset(id, fieldset) {  
+function disableFieldset(fieldsetId, fieldset) {  
   if (fieldset.toggle && fieldset.new_vm){
-    fieldset_id(id, fieldset).hide();
+    fieldset_id(fieldsetId, fieldset).hide();
   }
-  fieldset_id(id, fieldset).attr('disabled','disabled');
-  input_hidden_id(id).attr('disabled','disabled');
+  fieldset_id(fieldsetId, fieldset).attr('disabled','disabled');
+  input_hidden_id(fieldsetId).attr('disabled','disabled');
 }
 
-function toggleFieldset(id, fieldset, type1, type2) {  
-  type1 === type2 ? enableFieldset(id, fieldset) : disableFieldset(id, fieldset);
+function toggleFieldset(fieldsetId, fieldset, type1, type2) {  
+  type1 === type2 ? enableFieldset(fieldsetId, fieldset) : disableFieldset(fieldsetId, fieldset);
 }
 
-function input_hidden_id(id){
-  return $("div[id^='"+ id +"_volumes']" + " + input:hidden");
+function input_hidden_id(volume_id){
+  return $("div[id^='"+ volume_id +"_volumes']" + " + input:hidden");
 }
 
-function fieldset_id(id, fieldset){
-  return $("fieldset[id^='" + id + "_"+fieldset.id+"']");
+function fieldset_id(fieldsetId, fieldset){
+  return $("fieldset[id^='" + fieldsetId + "_"+fieldset.id+"']");
 }
 
 function fieldsets(type){
@@ -163,8 +163,8 @@ function toggleFieldsets(fieldset){
   var removable_input_hidden = $("div.removable-item[style='display: none;']" + " + input:hidden");
   removable_input_hidden.attr('disabled','disabled');  
   ['qemu', 'lxc'].forEach(function(type){
-    fieldsets(type).forEach(function(id){
-      toggleFieldset(id, fieldset, fieldset.selected, type);
+    fieldsets(type).forEach(function(fieldsetId){
+      toggleFieldset(fieldsetId, fieldset, fieldset.selected, type);
     });
   });
 }
@@ -190,18 +190,18 @@ function nodeSelected(item) {
   }
 }
 
-function emptySelect(select){
-  $(select).empty();
-  $(select).append($("<option></option>").val('').text(''));
-  $(select).val('');
+function emptySelect(select_id){
+  $(select_id).empty();
+  $(select_id).append($("<option></option>").val('').text(''));
+  $(select_id).val('');
 }
 
 function initOptions(select_ids){
   console.log('initOptions(' + select_ids[0] + ')');
   select_ids.forEach(emptySelect);
-  select_ids.forEach(function(select){
-    $(select + ' option:selected').prop('selected',false);
-    $(select).val('');
+  select_ids.forEach(function(select_id){
+    $(select_id + ' option:selected').prop('selected',false);
+    $(select_id).val('');
   });
 }
 
@@ -228,7 +228,9 @@ function updateOptions(options_path, start_options_id, end_options_id, start_sec
   if ( start_second_options_id != undefined && end_second_options_id != undefined) {
     select_second_ids = selectIds(start_second_options_id, end_second_options_id);
   }
-  var url = '/foreman_fog_proxmox/' + options_path +  '/' + node_id;
+  var compute_resource_id = $("#host_compute_resource_id").val();
+  if (compute_resource_id == undefined) compute_resource_id = $("#compute_attribute_compute_resource_id").val(); // profil
+  var url = '/foreman_fog_proxmox/' + options_path +  '/' + compute_resource_id +  '/' + node_id;
   if (second_id != undefined) url += '/' + second_id;
   tfm.tools.showSpinner();
   $.getJSON({

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

@@ -24,9 +24,9 @@ function volumesAttributesSelector(profile,index,selector) {
 }
 
 function getIndex(item) {
-  var id = $(item).attr('id');
+  var index_id = $(item).attr('id');
   var pattern = /(host_compute_attributes_volumes_attributes_||compute_attribute_vm_attrs_volumes_attributes_)(\d+)[_](.*)/i;
-  pattern_a = pattern.exec(id);
+  pattern_a = pattern.exec(index_id);
   var index = pattern_a[2];
   return index;
 }

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

@@ -16,24 +16,24 @@
 // along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
 
 function getIndex(item) {
-  var id = $(item).attr('id');
+  var index_id = $(item).attr('id');
   var pattern = /(host_compute_attributes_volumes_attributes_||compute_attribute_vm_attrs_volumes_attributes_)(\d+)[_](.*)/i;
-  pattern_a = pattern.exec(id);
+  pattern_a = pattern.exec(index_id);
   var index = pattern_a[2];
   return index;
 }
 
 function volumeId(type,index){
-  let id = '#volume_' + type + '_' + index;
-  return id;
+  var volume_id = '#volume_' + type + '_' + index;
+  return volume_id;
 }
 
-function enableField(id) {
-  $(id).show();
-  $(id).removeAttr('disabled');
+function enableField(item) {
+  $(item).show();
+  $(item).removeAttr('disabled');
 }
 
-function disableField(id) {  
-  $(id).hide();
-  $(id).attr('disabled','disabled');
+function disableField(item) {  
+  $(item).hide();
+  $(item).attr('disabled','disabled');
 }

data/app/controllers/concerns/foreman_fog_proxmox/compute_resources_vms_controller.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 ComputeResourcesVmsController
+    extend ActiveSupport::Concern
+    included do
+      prepend Overrides
+    end
+    module Overrides
+      def associate
+        if Host.for_vm_uuid(@compute_resource, @vm).any?
+          process_error(:error_msg => _("VM already associated with a host"), :redirect => compute_resource_vm_path(:compute_resource_id => params[:compute_resource_id], :id => proxmox_vm_id(@compute_resource, @vm)))
+          return
+        end
+        host = @compute_resource.associated_host(@vm) if @compute_resource.respond_to?(:associated_host)
+        if host.present?
+          host.associate!(@compute_resource, @vm)
+          process_success(:success_msg => _("VM associated to host %s") % host.name, :success_redirect => host_path(host))
+        else
+          process_error(:error_msg => _("No host found to associate this VM with"), :redirect => compute_resource_vm_path(:compute_resource_id => params[:compute_resource_id], :id => proxmox_vm_id(@compute_resource, @vm)))
+        end
+      end
+
+      def console
+        @console = @compute_resource.console proxmox_vm_id(@compute_resource, @vm)
+        render case @console[:type]
+               when 'spice'
+                 'hosts/console/spice'
+               when 'vnc'
+                 'hosts/console/vnc'
+               when 'vmrc'
+                 'hosts/console/vmrc'
+               else
+                 'hosts/console/log'
+               end
+      rescue StandardError => e
+        process_error :redirect => compute_resource_vm_path(@compute_resource, proxmox_vm_id(@compute_resource, @vm)), :error_msg => (_("Failed to set console: %s") % e), :object => @vm
+      end
+
+      private
+
+      def proxmox_vm_id(compute_resource, vm)
+        id = vm.identity
+        id = vm.unique_cluster_identity(compute_resource) if compute_resource.class == ForemanFogProxmox::Proxmox
+        id
+      end
+
+      def run_vm_action(action)
+        if @vm.send(action)
+          @vm.reload
+          success format(_("%<vm>s is now %<vm_state>s"), { :vm => @vm, :vm_state => @vm.state.capitalize })
+        else
+          error format(_("failed to %<action>s %<vm>s"), { :action => _(action), :vm => @vm })
+        end
+        redirect_back(:fallback_location => compute_resource_vm_path(:compute_resource_id => params[:compute_resource_id], :id => proxmox_vm_id(@compute_resource, @vm)))
+      # This should only rescue Fog::Errors, but Fog returns all kinds of errors...
+      rescue StandardError => e
+        error format(_("Error - %<message>s"), { :message => _(e.message) })
+        redirect_back(:fallback_location => compute_resource_vm_path(:compute_resource_id => params[:compute_resource_id], :id => proxmox_vm_id(@compute_resource, @vm)))
+      end
+    end
+  end
+end