foreman_fog_proxmox 0.12.0

data/README.md

@@ -0,0 +1,290 @@
+![ForemanFogProxmox](.github/images/foremanproxmox.png)
+
+![CI](https://github.com/theforeman/foreman_fog_proxmox/workflows/CI/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/922162c278e0fa9207ba/maintainability)](https://codeclimate.com/github/theforeman/foreman_fog_proxmox/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/922162c278e0fa9207ba/test_coverage)](https://codeclimate.com/github/theforeman/foreman_fog_proxmox/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/foreman_fog_proxmox.svg)](https://badge.fury.io/rb/foreman_fog_proxmox)
+
+# ForemanFogProxmox
+
+[Foreman](http://theforeman.org/) plugin that adds [Proxmox](https://www.proxmox.com/en/proxmox-ve) compute resource: managing virtual machines and containers using the [fog-proxmox](https://github.com/fog/fog-proxmox) module.
+
+It is intended to satisfy this [feature](http://projects.theforeman.org/issues/2186).
+
+If you like it and need more features you can [contribute](.github/CONTRIBUTING.md) or simply [support](.github/SUPPORT.md) it:
+
+## Support
+
+You can support the plugin development via the following methods:
+
+* [Donate by PayPal](https://paypal.me/TristanRobert)
+* [Sponsor by Github](https://github.com/sponsors/tristanrobert)
+
+## Compatibility versions
+
+|Fog-proxmox|Proxmox|Foreman-fog-proxmox|Foreman|Ruby|
+|--|--|--|--|--|
+|<0.6|<5.3|<0.6|<=1.20|>=2.3|
+|=0.6|<5.4|=0.6|=1.21|>=2.3|
+|<=0.8 |<6.0|>=0.7|>=1.22|>=2.3|
+|<0.9 |<6.0|=0.9|>=1.22|>=2.3|
+|>=0.9 |>=5.4|>=0.9.1|>=1.22|>=2.3|
+|>=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|
+
+## Installation
+
+### Prerequisites
+
+You need [nodejs](https://nodejs.org/en/download/package-manager/) installed in order to use foreman-assets package.
+
+### From gem
+
+See complete details in [plugin installation from gem](https://theforeman.org/plugins/#2.3AdvancedInstallationfromGems)
+
+Here is a Debian sample:
+
+* Install foreman [from OS packages](https://theforeman.org/manuals/1.19/index.html#3.3InstallFromPackages):
+
+```shell
+sudo apt install -y foreman foreman-compute foreman-sqlite3 foreman-assets
+```
+
+* Use only foreman user (**not root!**) `sudo -u foreman ...`
+* In /usr/share/foreman/bundler.d directory, add Gemfile.local.rb file and add this line in it:
+
+```shell
+echo "gem 'foreman_fog_proxmox'" | sudo -u foreman tee /usr/share/foreman/bundler.d/Gemfile.local.rb
+```
+
+* Install the gem plugin:
+
+```shell
+sudo -u foreman /usr/bin/foreman-ruby /usr/bin/bundle install
+```
+
+* Precompile plugin assets:
+
+```shell
+/usr/bin/foreman-ruby /usr/bin/bundle exec bin/rake plugin:assets:precompile[foreman_fog_proxmox]
+```
+
+* Compile plugin translations if (french) needed :
+
+```shell
+/usr/bin/foreman-ruby /usr/bin/bundle exec bin/rake plugin:gettext[foreman_fog_proxmox]
+```
+
+* Complete installation of foreman 1.22 with foreman-installer:
+
+```shell
+sudo apt install -y foreman-installer
+sudo foreman-installer
+```
+
+If you don't want to have HTTP 503 errors when apt is trying to install puppetserver, then add this before launching foreman-installer:
+
+```shell
+echo 'Acquire::http::User-agent "Mozilla/5.0 (Linux)";' | sudo tee /etc/apt/apt.conf.d/96useragent
+```
+
+See complete details in [plugin installation from gem](https://theforeman.org/plugins/#2.3.2Debiandistributions)
+
+Then you can check plugin installation after login into your new foreman server seeing the about foreman page:
+
+![About resources](.github/images/about_resources.png)
+![About greffon](.github/images/about_greffon.png)
+
+### From OS packages
+
+Please see the Foreman manual for complete instructions:
+
+* [Foreman: How to Install a Plugin](http://theforeman.org/manuals/latest/index.html#6.1InstallaPlugin)
+
+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.
+
+## Usage
+
+* [Compute resource](.github/compute_resource.md)
+* [Manage hosts](.github/hosts.md)
+
+## Development
+
+### Prerequisites
+
+* You need a Proxmox VE 5.4+ server running.
+* You need ruby >= 2.5. You can install it with [rbenv](https://github.com/rbenv/rbenv).
+* You also need nodejs in your dev machine to run webpack-dev-server. You can install it with [nvm](https://github.com/creationix/nvm).
+
+### Platform
+
+* Fork this github repo.
+* Clone it on your local machine
+* Install foreman v1.22+ on your machine:
+
+```shell
+git clone https://github.com/theforeman/foreman -b develop
+```
+
+* Create a Gemfile.local.rb file in foreman/bundler.d/
+* Add this line:
+
+```ruby
+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 'simplecov' # test
+```
+
+* In foreman directory, install dependencies:
+
+```shell
+gem install bundler
+# prerequisites postgresql-client library on OS
+bundle config set without 'libvirt ovirt mysql2'
+bundle install
+```
+
+```shell
+npm install
+```
+
+* Configure foreman settings:
+
+```shell
+cp config/settings.yaml.test config/settings.yaml
+```
+
+add these lines to config/settings.yml:
+
+```yaml
+    :webpack_dev_server: true
+```
+
+* SQLite is no more default rails dev or test database, instead add:
+
+```shell
+DATABASE_URL=nulldb://nohost
+```
+
+* (Optional) test and dev with postgresql database:
+
+```shell
+cp config/model.mappings.example config/model.mappings
+cp config/database.yml.example config/database.yml
+```
+
+add these lines to config/database.yml:
+
+```yaml
+    username: foreman
+    password: foreman
+```
+
+```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
+bundle exec bin/rake db:migrate
+bundle exec bin/rake db:seed assets:precompile locale:pack webpack:compile
+```
+
+* You can reset admin password if needed:
+
+```shell
+bundle exec bin/rake permissions:reset
+```
+
+* You should write tests and you can execute those specific to this plugin:
+
+first, create database `foreman-test` with psql commands:
+
+```shell
+docker exec -it foreman-db psql -U foreman
+foreman=# create database "foreman-test";
+```
+
+all:
+
+```shell
+export DISABLE_SPRING=true
+bundle exec bin/rake test:foreman_fog_proxmox
+```
+
+or just one:
+
+```shell
+export DISABLE_SPRING=true
+bundle exec bin/rake test TEST=test/functional/compute_resources_controller_test.rb DATABASE_URL=nulldb://nohost
+```
+
+* Check code syntax with rubocop and foreman rules:
+
+```shell
+bundle exec bin/rake foreman_fog_proxmox:rubocop
+```
+
+* See deface overrides result:
+
+```shell
+bundle exec bin/rake deface:get_result['hosts/_compute_detail']
+```
+
+* In foreman directory, after you modify foreman_fog_proxmox specific assets (proxmox.js, etc) you have to precompile it:
+
+```shell
+bundle exec bin/rake plugin:assets:precompile[foreman_fog_proxmox]
+```
+
+* In foreman directory, after you modify foreman_fog_proxmox translations (language, texts in new files, etc) you have to compile it:
+
+```shell
+bundle exec bin/rake plugin:gettext[foreman_fog_proxmox]
+```
+
+* In foreman directory, run in a new terminal the webpack-dev-server:
+
+```shell
+./node_modules/.bin/webpack-dev-server --config config/webpack.config.js
+```
+
+* Or without webpack-dev-server, add this line in config/settings.yml:
+
+```yml
+:webpack_dev_server: false
+```
+
+then compile webpack assets:
+
+```shell
+bundle exec bin/rake webpack:compile
+```
+
+* In foreman directory, run rails server:
+
+```shell
+bundle exec bin/rails server
+```
+
+* Or you can launch all together:
+
+```shell
+bundle exec foreman start
+```
+
+See details in [foreman plugin development](https://projects.theforeman.org/projects/foreman/wiki/How_to_Create_a_Plugin)
+
+## Contributing
+
+If you like it and still want to improve it, [sponsor me](https://github.com/sponsors/tristanrobert)!
+
+* You can reach the [contributors](.github/CONTRIBUTORS.md).
+* [Translate it in your favorite language](https://www.transifex.com/foreman/foreman/foreman_fog_proxmox/)
+* Bug reports and pull requests are welcome on GitHub at [ForemanFogProxmox](https://github.com/theforeman/foreman_fog_proxmox).
+
+Please read more information about [how to contribute](.github/CONTRIBUTING.md).
+
+## License
+
+The code is available as open source under the terms of the [GNU Public License v3](LICENSE).

data/Rakefile

@@ -0,0 +1,49 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanFogProxmox'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _e
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

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

@@ -0,0 +1,33 @@
+// Copyright 2018 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/>.
+
+$(document).on('ContentLoad', tfm.numFields.initAll);
+$(document).ready(sslVerifyPeerSelected);
+
+function sslVerifyPeerSelected(){
+  var selected = $("#compute_resource_ssl_verify_peer").is(':checked');
+  var ssl_certs_block = $('#compute_resource_ssl_certs').parents('.clearfix');
+  var ssl_certs_textarea = $('#compute_resource_ssl_certs');
+  if (selected) {
+    ssl_certs_block.show();
+    ssl_certs_textarea.show();
+  } else {
+    ssl_certs_block.hide();
+    ssl_certs_textarea.text('');
+    ssl_certs_textarea.hide();
+  }
+}

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

@@ -0,0 +1,187 @@
+// Copyright 2018 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/>.
+
+$(document).on('ContentLoad', tfm.numFields.initAll);
+$(document).ready(vmTypeSelected);
+
+function vmTypeSelected() {
+  var selected = $("#host_compute_attributes_type").val();
+  if (selected == undefined) selected = $("#compute_attribute_vm_attrs_type").val();
+  var host_uuid = $("input[id='host_uuid']").val();
+  var new_vm =  host_uuid == undefined;
+  var fieldsets = [];
+  fieldsets.push({id: 'config_advanced_options', toggle: true, new_vm: new_vm, selected: selected});
+  fieldsets.push({id: 'config_ext', toggle: true, new_vm: new_vm, selected: selected});
+  fieldsets.push({id: 'volume', toggle: true, new_vm: new_vm, selected: selected});
+  fieldsets.push({id: 'network', toggle: true, new_vm: true, selected: selected});
+  fieldsets.push({id: 'config_options', toggle: false, new_vm: new_vm, selected: selected});
+  fieldsets.push({id: 'config_cpu', toggle: false, new_vm: new_vm, selected: selected});
+  fieldsets.push({id: 'config_memory', toggle: false, new_vm: new_vm, selected: selected});
+  fieldsets.push({id: 'config_cdrom', toggle: false, new_vm: new_vm, selected: selected});
+  fieldsets.push({id: 'config_os', toggle: false, new_vm: new_vm, selected: selected});
+  fieldsets.push({id: 'config_dns', toggle: false, new_vm: new_vm, selected: selected});
+  fieldsets.forEach(toggleFieldset);
+  toggleVolumes(selected);
+  return false;
+}
+
+function toggleVolumes(selected){
+  var div_container = $("div[id^='container_volumes']");
+  var div_server = $("div[id^='server_volumes']");
+  var a_container = $("a[data-association='container_volumes']");
+  var a_server = $("a[data-association='server_volumes']");
+  switch (selected) {
+    case 'qemu':
+      div_container.hide();
+      div_server.show();
+      a_container.hide();
+      a_server.show();
+      break;
+    case 'lxc':
+      div_container.show();
+      div_server.hide();
+      a_container.show();
+      a_server.hide();
+      break;
+    default:
+      console.log("unkown type="+selected);
+      break;
+  }
+}
+
+function toggleFieldset(fieldset, index, fieldsets){
+  var server_input_hidden = $("div[id^='server_volumes']" + " + input:hidden");
+  var container_input_hidden = $("div[id^='container_volumes']" + " + input:hidden");
+  var removable_input_hidden = $("div.removable-item[style='display: none;']" + " + input:hidden");
+  var server_fieldset = $("fieldset[id^='server_"+fieldset.id+"']");
+  var container_fieldset = $("fieldset[id^='container_"+fieldset.id+"']");
+  removable_input_hidden.attr('disabled','disabled');
+  switch (fieldset.selected) {
+    case 'qemu':
+      if (fieldset.toggle && fieldset.new_vm){
+        server_fieldset.show();
+        container_fieldset.hide();
+      }
+      server_fieldset.removeAttr('disabled');
+      container_fieldset.attr('disabled','disabled');
+      server_input_hidden.removeAttr('disabled');
+      container_input_hidden.attr('disabled','disabled');
+      break;
+    case 'lxc':
+      if (fieldset.toggle && fieldset.new_vm){
+        server_fieldset.hide();
+        container_fieldset.show();
+      }
+      server_fieldset.attr('disabled','disabled');
+      container_fieldset.removeAttr('disabled');
+      container_input_hidden.removeAttr('disabled');
+      server_input_hidden.attr('disabled','disabled');
+      break;
+    default:
+      console.log("unkown type="+fieldset.selected);
+      break;
+  }
+}
+
+function nodeSelected(item) {
+  var node_id = $(item).val();
+  var type = $("#host_compute_attributes_type").val();
+  if (type == undefined) type = $("#compute_attribute_vm_attrs_type").val();
+  switch (type) {
+    case 'qemu':
+      updateOptions('isostorages', 'compute_attributes_config_attributes', 'cdrom_storage', 'compute_attributes_config_attributes', 'cdrom_iso', 'storage', node_id, undefined);
+      updateOptions('storages', 'compute_attributes_volumes_attributes', 'storage', undefined, undefined, 'storage', node_id, undefined);
+      updateOptions('bridges', 'interfaces_attributes', 'compute_attributes_bridge', undefined, undefined, 'iface', node_id, undefined);
+      break;
+    case 'lxc':
+      updateOptions('ostemplates', 'compute_attributes_ostemplate', 'storage', 'compute_attributes_ostemplate', 'file', 'storage', node_id, undefined);
+      updateOptions('storages', 'compute_attributes_volumes_attributes', 'storage', undefined, undefined, 'storage', node_id, undefined);
+      updateOptions('bridges', 'interfaces_attributes', 'compute_attributes_bridge', undefined, undefined, 'iface', node_id, undefined);
+      break;
+    default:
+      console.log("unkown type=" + type);
+      break;
+  }
+}
+
+function emptySelect(select){
+  $(select).empty();
+  $(select).append($("<option></option>").val('').text(''));
+  $(select).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('');
+  });
+}
+
+function updateOption(select_id, option, option_id){
+  console.log('update '+ select_id + ' with '+ option[option_id]);
+  $(select_id).append($('<option></option>').val(option[option_id]).text(option[option_id]));
+}
+
+function selectIds(start_options_id, end_options_id){
+  var select_host_id = 'select[id^=host_' + start_options_id + ']';
+  var compute_attributes_regex = /compute_attributes_/gi;
+  var select_profile_id = 'select[id^=compute_attribute_vm_attrs_' + start_options_id.replace(compute_attributes_regex, '') + ']';
+  if (end_options_id != undefined) {
+    select_host_id += '[id$=' + end_options_id + ']';
+    select_profile_id += '[id$=' + end_options_id.replace(compute_attributes_regex, '') + ']';
+  }
+  return [select_host_id, select_profile_id];
+}
+
+function updateOptions(options_path, start_options_id, end_options_id, start_second_options_id, end_second_options_id, option_id, node_id, second_id) {
+  
+  var select_ids = selectIds(start_options_id, end_options_id);
+  var select_second_ids;
+  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;
+  if (second_id != undefined) url += '/' + second_id;
+  tfm.tools.showSpinner();
+  $.getJSON({
+    type: 'get',
+    url: url,
+    error: function(j,status,error){
+      var errorMsg = 'Error=' + error + ', status=' + status + ' loading ' + options_path + ' for node_id=' + node_id;
+      if (second_id != undefined) errorMsg += ' and second_id=' + second_id;
+      console.log(errorMsg);
+    },
+    success: function(options) {
+      initOptions(select_ids);
+      if (select_second_ids != undefined) {
+        initOptions(select_second_ids);
+      }
+      $.each(options, function(i,option){
+        for (var j = 0; j < select_ids.length; j++) {
+          updateOption(select_ids[j], option, option_id);
+        }
+      });
+    },
+    complete: function(item){
+      // eslint-disable-next-line no-undef
+      reloadOnAjaxComplete(item);
+      tfm.tools.hideSpinner();
+    }
+  });
+}