How to install foreman_ipam plugin

balu · February 9, 2020, 12:51pm

Problem:
I would like to install foreman_ipam, but I do not know, how to do this. In the foreman documentation and the Github project is described, how to achieve this. I tried it with the “scl enable tfm bash” and " `gem install --ignore-dependencies foreman_ipam", as well as compile the whole project again. After that, I have restarted the whole server, but no menu icons for phpipam found, yet.

What I am doing wrong? Can you give me some hints please?

Expected outcome:
Install the plugin and connect to PHPIpam for give me the next new unused ip address.

Foreman and Proxy versions: 1.24.2

Foreman and Proxy plugin versions:

Distribution and version: CentOS 7.7.1908 (Core)

Other relevant data:

ekohl · February 22, 2020, 12:07pm

You also need to make sure the gem is loaded. Foreman :: Plugin Manuals mentions Add to the bundler.d/Gemfile.local.rb file as detailed below. which you probably missed.

On a related note, there’s an open PR to add it to Foreman itself via:

github.com/theforeman/foreman

Fixes #27067 - IPAM Integration with phpIPAM

theforeman:develop ← grizzthedj:feature/ipam_integration

opened 03:48PM - 17 Oct 19 UTC

grizzthedj

+862 -6

NOTE: Submitting a new PR for "Fixes #27067 - IPAM Integration with phpIPAM" usi…ng a new branch named: feature/ipam_integration. There were some issues with the previous branch(plugin/foreman_ipam), that I was not able to recover from. We can use the old PR(which is now closed) as a reference to the code review history. https://github.com/theforeman/foreman/pull/6847 =========================================== This PR is a patch to support of the use of plugins for external IPAM use, with opensource provider phpIPAM(https://phpipam.net). The primary use case is to provide the next available IPv4 address from phpIPAM, for a given phpIPAM subnet. The functionality that Foreman will use for external IPAM is encompassed in the below plugins(which are both new). **foreman_ipam(v0.0.10)** **Git:** https://github.com/grizzthedj/foreman_ipam **Gem:** https://rubygems.org/gems/foreman_ipam **smart_proxy_ipam(v0.0.15)** **Git:** https://github.com/grizzthedj/smart_proxy_ipam **Gem:** https://rubygems.org/gems/smart_proxy_ipam The `foreman_ipam` plugin provides a very basic dashboard to display sections and subnets from phpIPAM, and the `smart_proxy_ipam` plugin communicates with the phpIPAM API. Features and functionality * Simple IPAM Dashboard page(Infrastructure => IPAM Dashboard) to view sections and subnets for phpIPAM. More features will be added here based on internal user feedback and from the community. * When creating a phpIPAM subnet(IPAM type = External IPAM) in Foreman, subnet/mask must exist in phpIPAM, or error will be thrown * When creating a new host in Foreman, auto suggested IP's from phpIPAM will be persisted back to phpIPAM on Host submit. * When updating the IP address on a NIC that uses a phpIPAM subnet, the old IP will be deleted from phpIPAM, and new one will be added. * Deleting a host in Foreman will delete all NIC ip's that used a phpIPAM subnet * Deleting a NIC from a host will also delete the IP from phpIPAM * Deleting a subnet in Foreman will NOT delete the associated subnet in phpIPAM. This could easily be added later if it makes sense to the community, however initial thoughts are to not delete it. Prerequisites for testing: * Working Foreman environment. * A phpIPAM instance that at least one Forman Smart Proxy has network connectivity to. * The API must be enabled in phpIPAM settings, and `Prettify Links` should also be enabled. * An API user in phpIPAM must be created. The credentials for this user are to be put in the `config/settings.d/externalipam.yml` file in the Smart Proxy core

I hope this will be merged in 2.1.

balu · March 20, 2020, 9:06am

Hi Ewoud,

thanks for your answer and sorry for the delay. I did a fresh installation of foreman and tried again. I installed it on CentOS 7 and created /usr/share/foreman/bundler.d/Gemfile.

After that I run foreman-rake bundler install and this came up:

/opt/theforeman/tfm/root/usr/share/gems/gems/rake-13.0.1/exe/rake:27:in `<top (required)>'

Caused by:
LoadError: cannot load such file -- rails/i18n
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:325:in `block in require'
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:291:in `load_dependency'
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:325:in `require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:49:in `rescue in block in system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:39:in `block in system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:37:in `each'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:37:in `system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:19:in `block in system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:14:in `each'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:14:in `system_require'
/usr/share/foreman/config/application.rb:17:in `<top (required)>'
/usr/share/foreman/Rakefile:1:in `<top (required)>'
/opt/theforeman/tfm/root/usr/share/gems/gems/rake-13.0.1/exe/rake:27:in `<top (required)>'

Caused by:
Gem::ConflictError: Unable to activate rails-i18n-5.1.1, because railties-6.0.2.1 conflicts with railties (< 6, >= 5.0)
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:325:in `block in require'
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:291:in `load_dependency'
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:325:in `require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:41:in `block in system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:37:in `each'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:37:in `system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:19:in `block in system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:14:in `each'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:14:in `system_require'
/usr/share/foreman/config/application.rb:17:in `<top (required)>'
/usr/share/foreman/Rakefile:1:in `<top (required)>'
/opt/theforeman/tfm/root/usr/share/gems/gems/rake-13.0.1/exe/rake:27:in `<top (required)>'

Caused by:
Gem::ConflictError: Unable to activate rails-i18n-5.1.1, because railties-6.0.2.1 conflicts with railties (< 6, >= 5.0)
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:325:in `block in require'
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:291:in `load_dependency'
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:325:in `require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:41:in `block in system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:37:in `each'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:37:in `system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:19:in `block in system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:14:in `each'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:14:in `system_require'
/usr/share/foreman/config/application.rb:17:in `<top (required)>'
/usr/share/foreman/Rakefile:1:in `<top (required)>'
/opt/theforeman/tfm/root/usr/share/gems/gems/rake-13.0.1/exe/rake:27:in `<top (required)>'

Caused by:
LoadError: cannot load such file -- rails-i18n
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:325:in `block in require'
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:291:in `load_dependency'
/opt/theforeman/tfm/root/usr/share/gems/gems/activesupport-6.0.2.1/lib/active_support/dependencies.rb:325:in `require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:41:in `block in system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:37:in `each'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext/runtime.rb:37:in `system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:19:in `block in system_require'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:14:in `each'
/opt/theforeman/tfm/root/usr/share/gems/gems/bundler_ext-0.4.1/lib/bundler_ext.rb:14:in `system_require'
/usr/share/foreman/config/application.rb:17:in `<top (required)>'
/usr/share/foreman/Rakefile:1:in `<top (required)>'
/opt/theforeman/tfm/root/usr/share/gems/gems/rake-13.0.1/exe/rake:27:in `<top (required)>'
(See full trace by running task with --trace)

Unfortunately I am not a ruby developer. I can not debug this on a deeper level. But is this a dependency on the plugin or has it to be solved in the foreman env?

Thanks very much

lzap · March 20, 2020, 9:55am

Hello,

you can’t use this plugin with a stable version. The changes for Foreman core has been merged today! So the first Foreman version that will work is 2.1. We don’t have any installation information yet, but generally speaking you only need Foreman 2.1 (or today’s nightly) and smart_proxy_ipam plugin to have the integration. Then, optionally, you can install foreman_ipam plugin to get the dashboard widget but it does not provide anything else IIRC, so it’s not crucial to have it.

In short, you are a bit too early but we would love to see you testing this. For little bit more info go here: