foreman_fog_proxmox 0.4.0

data/README.md

@@ -0,0 +1,175 @@
+![ForemanFogProxmox](.github/images/foremanproxmox.png)
+
+[![Build Status](https://travis-ci.com/tristanrobert/foreman_proxmox.svg?branch=master)](https://travis-ci.com/tristanrobert/foreman_proxmox)
+[![Maintainability](https://api.codeclimate.com/v1/badges/922162c278e0fa9207ba/maintainability)](https://codeclimate.com/github/tristanrobert/foreman_proxmox/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/922162c278e0fa9207ba/test_coverage)](https://codeclimate.com/github/tristanrobert/foreman_proxmox/test_coverage)
+
+# 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).
+
+## Compatibility
+
+Tested with:
+
+* Foreman = 1.17.1
+* Fog-proxmox >= 0.4.0
+
+## 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 1.17 [from OS packages](https://theforeman.org/manuals/1.17/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]
+```
+
+* Complete installation of foreman 1.17 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
+
+Deb, rpm: work in progress...
+
+Please see the Foreman manual for complete instructions:
+
+* [Foreman: How to Install a Plugin](http://theforeman.org/manuals/latest/index.html#6.1InstallaPlugin)
+
+## Usage
+
+* [Compute resource](.github/compute_resource.md)
+* [Manage hosts](.github/hosts.md)
+
+## Development
+
+### Prerequisites
+
+You need a Proxmox VE >= 5.1 server running.
+
+You also need nodejs in your dev machine to run webpack-dev-server.
+
+### Platform
+
+* Fork this github repo.
+* Clone it on your local machine
+* Install foreman v1.17 on your machine:
+
+```shell
+git clone https://github.com/theforeman/foreman
+git checkout tags/1.17
+```
+
+* Create a Gemfile.local.rb file in foreman/bundler.d/
+* Add this line:
+
+```ruby
+gem 'foreman_fog_proxmox', :path => '/your_path_to/foreman_proxmox'
+```
+
+* In foreman directory, install dependencies:
+
+```shell
+bundle install
+```
+
+* Configure foreman settings:
+
+```shell
+cp config/settings.yaml.example config/settings.yaml
+```
+
+* Install foreman database (sqlite is default in rails development):
+
+```shell
+cp config/database.yaml.example config/database.yaml
+bundle exec rake db:migrate
+bundle exec rake db:seed
+```
+
+* You can reset admin password if needed:
+
+```shell
+bundle exec rake permissions:reset
+```
+
+* In foreman directory, after you modify foreman_fog_proxmox specific assets (proxmox.js, etc) you have to precompile it:
+
+```shell
+bundle plugin:assets:precompile[foreman_fog_proxmox]
+```
+
+* In foreman directory, run rails server:
+
+```shell
+rails server
+```
+
+* In foreman directory, run in a new terminal the webpack-dev-server:
+
+```shell
+./node_modules/.bin/webpack-dev-server --config config/webpack.config.js
+```
+
+See details in [foreman plugin development](https://projects.theforeman.org/projects/foreman/wiki/How_to_Create_a_Plugin)
+
+## Contributing
+
+You can reach the [contributors](CONTRIBUTORS.md).
+Bug reports and pull requests are welcome on GitHub at [ForemanFogProxmox](https://github.com/tristanrobert/foreman_proxmox). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+Please read [how to contribute](CONTRIBUTING.md).
+
+## License
+
+The code is available as open source under the terms of the [GNU Public License v3](LICENSE).
+
+## Code of Conduct
+
+Everyone interacting in the ForemanProxmox project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,47 @@
+#!/usr/bin/env rake
+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 => _
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

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

@@ -0,0 +1,110 @@
+// 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/>.
+
+function cdromSelected(item) {
+  var selected = $(item).val();
+  var cdrom_image_form = $('#cdrom_image_form');
+
+  switch (selected) {
+    case 'none':
+      initStorage();
+      initOptions('iso');
+      cdrom_image_form.hide();
+      break;
+    case 'cdrom':
+      initStorage();
+      initOptions('iso');
+      cdrom_image_form.hide();
+      break;
+    case 'image':
+      initStorage();
+      initOptions('iso');
+      cdrom_image_form.show();
+      break;
+    default:
+      break;
+  }
+  return false;
+}
+
+function initStorage(){
+  var select = '#host_compute_attributes_config_attributes_cdrom_storage';
+  $(select + ' option:selected').prop('selected',false);
+  $(select).val('');
+}
+
+function initOptions(name){
+  var select = '#host_compute_attributes_config_attributes_cdrom_'+name;
+  $(select).empty();
+  $(select).append($("<option></option>").val('').text(''));
+  $(select).val('');
+}
+
+  function storageIsoSelected(item) {
+    var storage = $(item).val();
+    if (storage != '') {
+      tfm.tools.showSpinner();
+      $.getJSON({
+        type: 'get',
+        url: '/foreman_fog_proxmox/isos/'+storage,
+        complete: function(){
+          tfm.tools.hideSpinner();
+        },
+        error: function(j,status,error){
+          console.log("Error=" + error +", status=" + status + " loading isos for storage=" + storage);
+        },
+        success: function(isos) {
+          initOptions('iso');
+          $.each(isos, function(i,iso){
+            $('#host_compute_attributes_config_attributes_cdrom_iso').append($("<option></option>").val(iso.volid).text(iso.volid));
+          });
+        }
+      });
+    } else {
+      initOptions('iso');
+    }
+  }
+
+function controllerSelected(item){
+  var controller = $(item).val();
+  var id = $(item).attr('id');
+  var pattern = /(\w+)(\d+)(\w+)/i;
+  var index =  pattern.exec(id)[2];
+  var max = computeControllerMaxDevice(controller);
+  $('#host_compute_attributes_volumes_attributes_' + index + '_device').attr('data-soft-max',max);
+  tfm.numFields.initAll();
+}
+
+function computeControllerMaxDevice(controller){
+  switch (controller) {
+    case 'ide':
+      return 3;
+      break;
+    case 'sata':
+      return 5;
+      break;
+    case 'scsi':
+      return 13;
+      break;
+    case 'virtio':
+      return 15;
+      break;
+    default:
+      return 1;
+      break;
+  }
+}

data/app/controllers/concerns/foreman_fog_proxmox/controller/parameters/compute_resource.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# 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/>.
+
+module ForemanFogProxmox
+  module Controller
+    module Parameters
+      module ComputeResource
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def compute_resource_params_filter
+            super.tap do |filter|   
+              filter.permit :ssl_verify_peer,
+                :ssl_certs, :disable_proxy
+            end
+          end
+
+          def compute_resource_params
+            self.class.compute_resource_params_filter.filter_params(params, parameter_filter_context)
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_fog_proxmox/compute_resources_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# 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/>.
+
+module ForemanFogProxmox
+  class ComputeResourcesController < ::ApplicationController
+    before_action :load_compute_resource
+
+    # GET foreman_fog_proxmox/isos/:storage
+    def isos
+      volumes = @compute_resource.isos(params[:storage])
+      respond_to do |format|
+        format.json { render :json => volumes }
+      end
+    end
+
+    private
+
+    def load_compute_resource
+      @compute_resource = ComputeResource.find_by(type: 'ForemanFogProxmox::Proxmox')
+    end
+  end
+end

data/app/helpers/proxmox_compute_helper.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# 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/>.
+
+require 'fog/proxmox/helpers/disk_helper'
+require 'fog/proxmox/helpers/nic_helper'
+
+module ProxmoxComputeHelper
+
+  KILO = 1024
+  MEGA = KILO * KILO
+  GIGA = KILO * MEGA
+
+  def parse_vm(args)
+    return {} unless args
+    return {} if args.empty?
+    config = args['config_attributes']
+    cdrom_a = %w[cdrom cdrom_storage cdrom_iso]
+    cdrom = parse_cdrom(config.select { |key,_value| cdrom_a.include? key })
+    volumes = parse_volumes(args['volumes_attributes'])
+    cpu_a = %w[cpu_type spectre pcid vcpus cpulimit cpuunits cores sockets numa]
+    cpu = parse_cpu(config.select { |key,_value| cpu_a.include? key })
+    memory_a = %w[memory min_memory balloon shares]
+    memory = parse_memory(config.select { |key,_value| memory_a.include? key })
+    interfaces_attributes = args['interfaces_attributes']
+    networks = parse_interfaces(interfaces_attributes)
+    general_a = %w[node config_attributes volumes_attributes interfaces_attributes firmware_type provision_method]
+    logger.debug("general_a: #{general_a}")
+    parsed_vm = args.reject { |key,value| general_a.include?(key) || value.empty? }
+    config_a = []
+    config_a += cpu_a
+    config_a += cdrom_a
+    config_a += memory_a
+    parsed_config = config.reject { |key,value| config_a.include?(key) || value.empty? }
+    logger.debug("parse_config(): #{parsed_config}")
+    parsed_vm = parsed_vm.merge(parsed_config).merge(cpu).merge(memory).merge(cdrom)
+    networks.each { |network| parsed_vm = parsed_vm.merge(network) }
+    volumes.each { |volume| parsed_vm = parsed_vm.merge(volume) }
+    logger.debug("parse_vm(): #{parsed_vm}")
+    parsed_vm
+  end
+
+  def parse_memory(args)
+    memory = { memory: args['memory'].to_i }
+    ballooned = args['balloon'].to_i == 1
+    if ballooned
+      memory.store(:shares,args['shares'].to_i)
+      memory.store(:balloon,args['min_memory'].to_i)
+    else
+      memory.store(:balloon,args['balloon'].to_i)
+    end
+    logger.debug("parse_memory(): #{memory}")
+    memory
+  end
+
+  def parse_cpu(args)
+    cpu = "cputype=#{args['cpu_type']}"
+    spectre = args['spectre'].to_i == 1
+    pcid = args['pcid'].to_i == 1
+    cpu += ",flags=" if spectre || pcid
+    cpu += "+spec-ctrl" if spectre
+    cpu += ";" if spectre && pcid
+    cpu += "+pcid" if pcid      
+    args.delete_if { |key,value| %w[cpu_type spectre pcid].include?(key) || value.empty? }
+    args.each_value { |value| value.to_i }
+    parsed_cpu = { cpu: cpu }.merge(args)
+    logger.debug("parse_cpu(): #{parsed_cpu}")
+    parsed_cpu
+  end
+
+  def parse_cdrom(args)
+    cdrom = args['cdrom']
+    cdrom_image = args['cdrom_iso']
+    volid = cdrom_image.empty? ? cdrom : cdrom_image
+    cdrom = "#{volid},media=cdrom"
+    {ide2: cdrom}
+  end
+
+  def parse_volume(args)
+    disk = {}
+    id = args['id']
+    id = "#{args['controller']}#{args['device']}" unless id
+    delete = args['_delete'].to_i == 1
+    args.delete_if { |_key,value| value.empty? }
+    if delete
+      logger.debug("parse_volume(): delete id=#{id}")
+      disk.store(:delete, id)
+      disk
+    else
+      disk.store(:id, id)
+      disk.store(:volid, args['volid'])
+      disk.store(:storage, args['storage'].to_s)
+      disk.store(:size, args['size'])
+      options = args.reject { |key,_value| %w[id volid controller device storage size _delete].include? key}
+      disk.store(:options, options)
+      logger.debug("parse_volume(): add disk=#{disk}")
+      Fog::Proxmox::DiskHelper.flatten(disk)
+    end 
+  end
+
+  def parse_volumes(args)
+    volumes = []
+    args.each_value { |value| volumes.push(parse_volume(value))} if args
+    logger.debug("parse_volumes(): volumes=#{volumes}")
+    volumes
+  end
+
+  def parse_interfaces(args)
+    nics = []
+    args.each_value { |value| nics.push(parse_interface(value))} if args
+    logger.debug("parse_interfaces(): nics=#{nics}")
+    nics
+  end
+
+  def parse_interface(args)
+    args.delete_if { |_key,value| value.empty? }
+    nic = {}
+    id = args['id']
+    logger.debug("parse_interface(): id=#{id}")
+    delete = args['_delete'].to_i == 1
+    if delete
+      logger.debug("parse_interface(): delete id=#{id}")
+      nic.store(:delete, id)
+      nic
+    else
+      nic.store(:id, id)
+      nic.store(:tag, args['vlan'].to_i) if args['vlan']
+      nic.store(:model, args['model'].to_s)
+      nic.store(:bridge, args['bridge'].to_s) if args['bridge']
+      nic.store(:firewall, args['firewall'].to_i) if args['firewall']
+      nic.store(:rate, args['rate'].to_i) if args['rate']
+      nic.store(:link_down, args['disconnect'].to_i) if args['disconnect']
+      nic.store(:queues, args['queues'].to_i) if args['queues']
+      logger.debug("parse_interface(): add nic=#{nic}")
+      Fog::Proxmox::NicHelper.flatten(nic)
+    end 
+  end
+
+end