the_foreman_proxmox

Foreman plugin adds Proxmox VE compute resource using fog-proxmox. It is compatible with Foreman 1.17


Keywords
cloud, cloud-computing, fog, fog-computing, fog-proxmox, foreman, foreman-plugins, foreman-proxmox, proxmox, proxmox-ve, theforeman
License
GPL-3.0
Install
gem install the_foreman_proxmox -v 0.3.5

Documentation

ForemanFogProxmox

Build Status Maintainability Test Coverage

ForemanFogProxmox

Foreman plugin that adds Proxmox compute resource: managing virtual machines and containers using the fog-proxmox module.

It is intended to satisfy this feature.

If you like it and need more features you can support it.

Compatibility versions

Fog-proxmox Proxmox Foreman-fog-proxmox Foreman Ruby
<0.6 <5.3 <0.6 <=1.20 >=2.3
=0.6 =5.3 =0.6 =1.21 >=2.3
<= 0.8 =5.4 >=0.7 >=1.22 >=2.3

Installation

Prerequisites

You need nodejs installed in order to use foreman-assets package.

From gem

See complete details in plugin installation from gem

Here is a Debian sample:

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:
echo "gem 'foreman_fog_proxmox'" | sudo -u foreman tee /usr/share/foreman/bundler.d/Gemfile.local.rb
  • Install the gem plugin:
sudo -u foreman /usr/bin/foreman-ruby /usr/bin/bundle install
  • Precompile plugin assets:
/usr/bin/foreman-ruby /usr/bin/bundle exec bin/rake plugin:assets:precompile[foreman_fog_proxmox]
  • Compile plugin translations if (french) needed :
/usr/bin/foreman-ruby /usr/bin/bundle exec bin/rake plugin:gettext[foreman_fog_proxmox]
  • Complete installation of foreman 1.22 with foreman-installer:
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:

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

Then you can check plugin installation after login into your new foreman server seeing the about foreman page:

About resources About greffon

From OS packages

Please see the Foreman manual for complete instructions:

Redhat, CentOS or Fedora users should also setup Selinux to allow foreman and all its plugins to work.

Usage

Development

Prerequisites

  • You need a Proxmox VE 5.4 server running.
  • You need ruby >= 2.3. You can install it with rbenv.
  • You also need nodejs in your dev machine to run webpack-dev-server. You can install it with nvm.

Platform

  • Fork this github repo.
  • Clone it on your local machine
  • Install foreman v1.22 on your machine:
git clone https://github.com/theforeman/foreman -b develop
  • Create a Gemfile.local.rb file in foreman/bundler.d/
  • Add this line:
gem 'foreman_fog_proxmox', :path => '/your_path_to/foreman_fog_proxmox'
gem 'fog-proxmox', :path => '/your_path_to/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:
bundle install --without libvirt postgresql mysql2
npm install
  • Configure foreman settings:
cp config/settings.yaml.test config/settings.yaml
  • Install foreman database (sqlite is default in rails development):
cp config/model.mappings.example config/model.mappings
cp config/database.yml.example config/database.yml
cp config/ignored_environments.yml.sample config/ignored_environments.yml
bundle exec bin/rake db:migrate
bundle exec bin/rake db:seed
  • You can reset admin password if needed:
bundle exec bin/rake permissions:reset
  • You should write tests and you can execute those specific to this plugin:

all:

export DISABLE_SPRING=true
bundle exec bin/rake test:foreman_fog_proxmox

or just one:

export DISABLE_SPRING=true
bundle exec bin/rake test TEST=test/functional/compute_resources_controller_test.rb
  • See deface overrides result:
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:
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:
bundle exec bin/rake plugin:gettext[foreman_fog_proxmox]
  • In foreman directory, run rails server:
bundle exec bin/rails server
  • In foreman directory, run in a new terminal the webpack-dev-server:
./node_modules/.bin/webpack-dev-server --config config/webpack.config.js
  • Or you can launch all together:
bundle exec foreman start

See details in foreman plugin development

Contributing

You can reach the contributors. Bug reports and pull requests are welcome on GitHub at ForemanFogProxmox.

Please read more information about how to contribute.

License

The code is available as open source under the terms of the GNU Public License v3.