foreman_ipam 0.0.11 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c55538e48d175e816b53d10706a5279bd99c0d51d6a389a4e897844f4c841b2
-  data.tar.gz: f6131ec6a0c5ed2db1834c5670f8bab4e0cc7a1ec8dec9c29926b12360c6034a
+  metadata.gz: d2d6195978d83bc1a5ab6485849833ab299c8df4d081f8ffc3cd272325225b12
+  data.tar.gz: ca5d8ac1087b01665f6b1d5b7c39dd46ecda8e15702040e11e07ca817750a1d6
 SHA512:
-  metadata.gz: 5504492fd57853f8abe0530691a290b8ebb603de840dc97c8731b158c7cb99b2fdd3b25e9ae9a23b0498a60dbef4fae80d8a658af01c877d5e570e7ff780074f
-  data.tar.gz: 14567c9ea0add4e8e10a55fff634f258f8824f9884da20fc2bf03cbf474e852b35617c978370e418fbcaf36c104af11428d65f36b9b8f4f3882b6f3c75775d67
+  metadata.gz: eae660a356f4368845ca9a73b3546a71adba235c1df533d054035cfb6f7dbf5a13772aec79f8d02126dcf6ebd8abb9d386bda9c7bc745b65595dd47f81c3f19e
+  data.tar.gz: fcc77ca57bacd49f2dee7a61f11f0262cb35b5e9180c4a9b9c67a289b33e20e00312217aab36fa50dcfdf006ebe0616aea4dcfeb11d56cf9a3c90bf61d9b3f76

data/README.md

@@ -1,11 +1,6 @@
 # foreman_ipam
 
-Foreman plugin for IPAM integration with various IPAM providers.
-
-Currently supported Providers: 
-1. [phpIPAM](https://phpipam.net/). 
-
-Provides a basic Dashboard for viewing phpIPAM sections and subnets. Also allows for obtaining of the next available IPv4 address for a given subnet(via [IPAM Smart Proxy Plugin](https://github.com/grizzthedj/smart_proxy_ipam)).
+Foreman plugin for IPAM integration with External IPAM providers. Provides a basic Dashboard for viewing External IPAM groups and subnets via External IPAM Smart Proxy API's. 
 
 ## Installation
 
@@ -14,10 +9,7 @@ for how to install Foreman plugins.
 
 ## Usage
 
-Once plugin is installed, you can look at the phpIPAM Dashboard(at Infrastructure --> phpIPAM Dashboard), for a simple view of sections, subnets etc. and/or use phpIPAM to get the next available IP address for a subnet:
-
-1. Create a subnet in Foreman of IPAM type "IPAM". Click on the `Proxy` tab and associate the subnet with the IPAM proxy. _NOTE: This subnet must actually exist in phpIPAM. There is no phpIPAM integration on the subnet creation at this time._
-2. Create a host in Foreman. When adding/editing interfaces, select the above subnet, and the next available IP(pulled from phpIPAM) for the selected subnet will be displayed in the IPv4 address field. _NOTE: This is not supported for IPv6._
+Once plugin is installed, you can look at the External IPAM Dashboard at Infrastructure --> External IPAM, for a simple view of groups and subnets. 
 
 ## Local development
 
@@ -31,38 +23,44 @@ git clone https://github.com/theforeman/smart-proxy
 ```
 3. Fork both the foreman plugin and smart proxy plugin repos, then clone
 
-foreman_phpipam repo: https://github.com/grizzthedj/smart_proxy_phpipam  
-smart_proxy_phpipam repo: https://github.com/grizzthedj/smart_proxy_phpipam
+foreman_ipam repo: https://github.com/grizzthedj/foreman_ipam  
+smart_proxy_ipam repo: https://github.com/grizzthedj/smart_proxy_ipam
 
 ```
-git clone https://github.com/<GITHUB_USER>/foreman_phpipam
-git clone https://github.com/<GITHUB_USER>/smart_proxy_phpipam
+git clone https://github.com/<GITHUB_USER>/foreman_ipam
+git clone https://github.com/<GITHUB_USER>/smart_proxy_ipam
 ```
-4. Add the foreman_phpipam plugin to `Gemfile.local.rb` in the Foreman bundler.d directory
+4. Add the foreman_ipam plugin to `Gemfile.local.rb` in the Foreman bundler.d directory
 ```
-gem 'foreman_phpipam', :path => '/path/to/foreman_phpipam'
+gem 'foreman_ipam', :path => '/path/to/foreman_ipam'
 ```
 5. From Foreman root directory run 
 ```
 bundle install
 bundle exec rails db:migrate
-bundle exec rails db:seed    # This adds 'phpIPAM' feature to Features table
+bundle exec rails db:seed
 bundle exec foreman start
 ```
-6. Add the smart_proxy_phpipam plugin to `Gemfile.local.rb` in Smart Proxy bundler.d directory
+6. Add the smart_proxy_ipam plugin to `Gemfile.local.rb` in Smart Proxy bundler.d directory
 ```
-gem 'smart_proxy_phpipam', :path => '/path/to/smart_proxy_phpipam'
+gem 'smart_proxy_ipam', :path => '/path/to/smart_proxy_ipam'
 ```
-7. Copy `config/settings.d/phpipam.yml.example` to `config/settings.d/phpipam.yml` and replace values with your phpIPAM URL and credentials.
-8. From Smart Proxy root directory run ... 
+
+7. Copy `config/settings.d/externalipam.yml.example` to `config/settings.d/externalipam.yml`, and set `enabled` to true, and `use_provider` to `externalipam_phpipam` or `externalipam_netbox`.
+
+8. Copy `config/settings.d/externalipam_phpipam.yml.example` to `config/settings.d/externalipam_phpipam.yml` and replace values with your phpIPAM URL and credentials.
+
+9. Copy `config/settings.d/externalipam_netbox.yml.example` to `config/settings.d/externalipam_netbox.yml` and replace values with your Netbox URL and API token.
+
+10. From Smart Proxy root directory run ... 
 ```
 bundle install
 bundle exec smart-proxy start
 ```
-9. Navigate to Foreman UI at http://localhost:5000
-10. Add a Local Smart Proxy in the Foreman UI(Infrastructure => Smart Proxies)
-11. Ensure that the `phpipam` feature is present on the proxy(http://proxy_url/features)
-12. Create a Subnet, and associate the subnet to the `phpipam` proxy
+11. Navigate to Foreman UI at http://localhost:5000
+12. Add a Local Smart Proxy in the Foreman UI(Infrastructure => Smart Proxies)
+13. Ensure that the `External IPAM` feature is present on the proxy(http://proxy_url/features)
+14. Create a Subnet, and associate the subnet to the `External IPAM` proxy
 
 ## Run tests
 
@@ -72,15 +70,6 @@ From the Foreman core, run ...
 bundle exec rails test:foreman_ipam
 ```
 
-## TODO
-
-- Support for ip ranges
-- Sync VLAN ID with phpIPAM
-- More functionality on phpIPAM Dashboard page
-    * Create a subnet
-    * List ips within a subnet
-- Better error handling in the case connectivity to phpIPAM is lost
-
 ## Contributing
 
 Fork and send a Pull Request. Thanks!
@@ -101,4 +90,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-

data/app/controllers/foreman_ipam/external_ipam_controller.rb

@@ -0,0 +1,32 @@
+module ForemanIpam
+  class ExternalIpamController < ::DashboardController
+    def dashboard
+      begin
+        ipam_proxies = SmartProxy.with_features('External IPAM')
+        first_id = ipam_proxies.first.id
+        @response = {}
+        ipam_proxies.each do |proxy|
+          external_ipam_proxy = ProxyAPI::ExternalIpam.new({:url => proxy[:url]})
+          @response[proxy.name] = {
+            id: proxy.id,
+            first: proxy.id == first_id,
+            groups: external_ipam_proxy.get_groups
+          }
+        end
+      rescue => e
+        flash.now[:notice] = e.message
+      end
+    end
+
+    def subnets
+      begin
+        proxy = SmartProxy.find(params[:smart_proxy_id])
+        external_ipam_proxy = ProxyAPI::ExternalIpam.new({:url => proxy[:url]})
+        @subnets = external_ipam_proxy.get_subnets_by_group(params[:group])
+      rescue => e
+        flash.now[:notice] = e.message
+      end
+      render :json => @subnets.to_json, :status => :ok
+    end
+  end
+end

data/app/views/foreman_ipam/external_ipam/dashboard.html.erb

@@ -0,0 +1,106 @@
+<h1>External IPAM Dashboard</h1>
+
+<% if !flash.empty? %>
+  <div class="alert alert-warning ">
+    <span class="pficon pficon-warning-triangle-o "></span>
+    <span class="text"><%= _(flash.now[:notice]) %></span>
+  </div>
+<% else %>
+  <ul class="nav nav-tabs" data-tabs="tabs">
+    <% @response.keys.each do |proxy| %>
+      <% proxy_name = proxy.downcase.gsub(' ','_') %>
+
+      <li class='<%= @response[proxy][:first] ? "active" : "" %>' onclick="clearSubnets('<%= proxy_name %>')">
+        <a href='#<%= proxy_name %>' data-toggle="tab"><%= _(proxy) %></a>
+      </li>
+    <% end %>
+  </ul>
+  <div class="tab-content">
+    <% @response.keys.each do |proxy| %>
+      <% proxy_name = proxy.downcase.gsub(' ','_') %>
+
+      <% if @response[proxy][:groups].length == 0 %>
+        <div class="alert alert-warning ">
+          <span class="pficon pficon-warning-triangle-o "></span>
+          <span class="text"><%= _("No groups found in External IPAM.") %></span>
+        </div>
+      <% else %>
+        <div class="tab-pane <%= "active" if @response[proxy][:first] %>" id='<%= proxy_name %>' >
+          <h3>Groups:</h3>
+          <table class="<%= table_css_classes 'table-fixed' %>">
+            <thead>
+              <tr>
+                <th class="col-md-2"><%= s_("Name") %></th>
+                <th class="col-md-6"><%= s_("Description") %></th>
+              </tr>
+            </thead>
+            <tbody>
+              <% @response[proxy][:groups].each do |group| %>
+                <tr>
+                  <td class="ellipsis">
+                    <a href="#" onclick="getSubnets('<%= group['name'] %>', '<%= @response[proxy][:id] %>', '<%= proxy_name %>')">
+                      <%= group['name'] %>
+                    </a>
+                  </td>
+                  <td class="ellipsis">
+                    <%= group['description'] %>
+                  </td>
+                </tr>
+              <% end %>
+            </tbody>
+          </table>
+
+          <div id="subnet_container_<%= proxy_name %>"></div>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>
+
+<script>
+  function getSubnets(groupName, proxyId, proxyName) {
+    var subnetContainer = document.getElementById('subnet_container_' + proxyName);
+    subnetContainer.innerHTML = '<h2>Subnets for ' + groupName + '</h2>';
+
+    $.ajax({
+      type: "GET", 
+      url: "/ipam/subnets?smart_proxy_id=" + proxyId + "&group=" + groupName,
+      success: function(data) {
+        if (!data) {
+          subnetContainer.innerHTML += 'Something went wrong';
+        }
+        else {
+          if (data.message === 'No subnets found') 
+            subnetContainer.innerHTML += data.message;
+          else 
+            displaySubnets(data, proxyName);
+        }
+      }
+    });
+  }
+
+  function clearSubnets(proxyName) {
+    document.getElementById('subnet_container_' + proxyName).innerHTML = '';
+  }
+
+  function displaySubnets(subnets, proxyName) {
+    var subnetContainer = document.getElementById('subnet_container_' + proxyName);
+
+    if (subnets.length == 0) {
+      subnetContainer.innerHTML += "<div class='col-md-3'><strong>No Subnets found</strong></div>"
+    }
+    else {
+      subnetContainer.innerHTML += `
+        <div class='col-md-3'><strong>Subnet</strong></div>
+        <div class='col-md-6'><strong>Description</strong></strong></div><br />
+      `;
+    }
+
+    subnets.forEach(function(item) {
+      subnetContainer.innerHTML += `
+        <div class='col-md-3'>` + item['subnet'] + `/` + item['mask'] + `</div>
+        <div class='col-md-6'>` + item['description'] + `</div><br />
+      `;
+    });
+  }
+</script>

data/config/routes.rb

@@ -1,4 +1,4 @@
 Rails.application.routes.draw do
-  get 'ipam', to: 'foreman_ipam/dashboard#ipam'
-  get 'ipam/phpipam/subnets', to: 'foreman_ipam/dashboard#subnets'
+  get 'ipam', to: 'foreman_ipam/external_ipam#dashboard'
+  get 'ipam/subnets', to: 'foreman_ipam/external_ipam#subnets'
 end

data/lib/foreman_ipam/engine.rb

@@ -16,23 +16,23 @@ module ForemanIpam
 
     initializer 'foreman_ipam.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_ipam do
-        requires_foreman '>= 1.16'
+        requires_foreman '>= 2.1'
 
         # Add permissions
         security_block :foreman_ipam do
-          permission :view_foreman_ipam, :'foreman_ipam/dashboard' => [:ipam]
-          permission :view_foreman_ipam_subnets, :'foreman_ipam/dashboard' => [:subnets]
+          permission :view_foreman_ipam, :'foreman_ipam/external_ipam' => [:dashboard]
+          permission :view_foreman_ipam_subnets, :'foreman_ipam/external_ipam' => [:subnets]
         end
 
         # Add a new role called 'ExternalIpam' if it doesn't exist
-        role 'ExternalIpam', [:view_foreman_ipam, :view_foreman_ipam_subnets]
+        role 'ExternalIpam', [:view_foreman_ipam, :view_foreman_ipam_subnets] # , 'Role to allow for the viewing of Subnets and Sections from External IPAM']
 
         # Add menu entry to Infrastructure
         menu :top_menu, :template,
           url_hash: { 
-            controller: :'foreman_ipam/dashboard', action: :ipam 
+            controller: :'foreman_ipam/external_ipam', action: :dashboard 
           },
-          caption: 'IPAM Dashboard',
+          caption: 'External IPAM',
           parent: :infrastructure_menu
       end
     end

data/lib/foreman_ipam/version.rb

@@ -1,3 +1,3 @@
 module ForemanIpam
-  VERSION = '0.0.11'.freeze
+  VERSION = '0.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ipam
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.0
 platform: ruby
 authors:
 - Christopher Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2021-01-09 00:00:00.000000000 Z
 dependencies: []
 description: Plugin for IPAM integration with various IPAM providers
 email:
@@ -20,17 +20,13 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/controllers/foreman_ipam/dashboard_controller.rb
+- app/controllers/foreman_ipam/external_ipam_controller.rb
 - app/helpers/concerns/foreman_ipam/dashboard_helper_extensions.rb
 - app/models/concerns/foreman_ipam/dashboard_extensions.rb
-- app/views/dashboard/_foreman_ipam_widget.html.erb
-- app/views/foreman_ipam/dashboard/ipam.html.erb
-- config/initializers/phpipam.rb
+- app/views/foreman_ipam/external_ipam/dashboard.html.erb
 - config/routes.rb
-- config/settings.yaml.example
 - lib/foreman_ipam.rb
 - lib/foreman_ipam/engine.rb
-- lib/foreman_ipam/phpipam.rb
 - lib/foreman_ipam/version.rb
 - lib/tasks/foreman_ipam_tasks.rake
 - locale/Makefile
@@ -44,7 +40,7 @@ homepage: https://github.com/grizzthedj/foreman_ipam
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -60,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Plugin for IPAM integration with various IPAM providers
 test_files:

data/app/controllers/foreman_ipam/dashboard_controller.rb

@@ -1,21 +0,0 @@
-
-module ForemanIpam
-  class DashboardController < ::DashboardController
-    def ipam
-      begin
-        @response = Phpipam.proxy.get_sections
-      rescue => e
-        flash.now[:notice] = e.message
-      end 
-    end
-
-    def subnets
-      begin
-        @subnets = Phpipam.proxy.get_subnets_by_section(params[:section_name])
-      rescue => e
-        flash.now[:notice] = e.message
-      end
-      render :json => @subnets.to_json, :status => :ok
-    end
-  end
-end

data/app/views/dashboard/_foreman_ipam_widget.html.erb

@@ -1,2 +0,0 @@
-<h4 class="header ca"><%= _('ForemanIpam') %></h4>
-<%= _('Widget content') %>

data/app/views/foreman_ipam/dashboard/ipam.html.erb

@@ -1,82 +0,0 @@
-<h1>IPAM Integration Dashboard</h1>
-
-<% if !flash.empty? %>
-  <div class="alert alert-warning ">
-    <span class="pficon pficon-warning-triangle-o "></span>
-    <span class="text"><%= _(flash.now[:notice]) %></span>
-  </div>
-<% elsif @response['data'] && @response['data'].length == 0 %>
-  <div class="alert alert-warning ">
-    <span class="pficon pficon-warning-triangle-o "></span>
-    <span class="text"><%= _("No sections found in External IPAM.") %></span>
-  </div>
-<% elsif @response['data'] && @response['data'].length > 0 %>
-  <h2>phpIPAM</h2>
-  <h3>Sections:</h3>
-  <table class="<%= table_css_classes 'table-fixed' %>">
-    <thead>
-      <tr>
-        <th class="col-md-2"><%= s_("Name") %></th>
-        <th class="col-md-6"><%= s_("Description") %></th>
-      </tr>
-    </thead>
-    <tbody>
-      <% @response['data'].each do |section| %>
-        <tr>
-          <td class="ellipsis">
-            <a href="#" onclick="getSubnets('<%= section['id'] %>', '<%= section['name'] %>')"><%= section['name'] %></a>
-          </td>
-          <td class="ellipsis">
-            <%= section['description'] %>
-          </td>
-        </tr>
-      <% end %>
-    </tbody>
-  </table>
-<% end %>
-
-<div id="subnet_container"></div>
-
-<script>
-  function getSubnets(section_id, section_name) {
-    var subnet_container = document.getElementById('subnet_container');
-    subnet_container.innerHTML = '<h2>Subnets for ' + section_name + '</h2>';
-
-    $.ajax({
-      type: "GET", url: "/ipam/phpipam/subnets",
-      data: {"section_name": encodeURI(section_name)},
-      success: function(data) {
-        if (!data) {
-          subnet_container.innerHTML += 'Cannot connect to External IPAM';
-        }
-        else {
-          if (data.message === 'No subnets found') 
-            subnet_container.innerHTML += data.message;
-          else 
-            displaySubnets(data);
-        }
-      }
-    });
-  }
-
-  function displaySubnets(data) {
-    var subnets = data;
-
-    if (subnets['data'].length == 0) {
-      subnet_container.innerHTML += "<div class='col-md-2'><strong>No Subnets</strong></div>"
-    }
-    else {
-      subnet_container.innerHTML += `
-        <div class='col-md-2'><strong>Subnet</strong></div>
-        <div class='col-md-6'><strong>Description</strong></strong></div><br />
-      `;
-    }
-
-    subnets['data'].forEach(function(item) {
-      subnet_container.innerHTML += `
-        <div class='col-md-2'>` + item['subnet'] + `/` + item['mask'] + `</div>
-        <div class='col-md-6'>` + item['description'] + `</div><br />
-      `;
-    });
-  }
-</script>

data/config/initializers/phpipam.rb

@@ -1 +0,0 @@
-require_relative '../../lib/foreman_ipam/phpipam'

data/config/settings.yaml.example

@@ -1,10 +0,0 @@
-
-:ipam:
-  :phpipam:
-    :url: 'http://phpipam.example.com'
-    :user: 'phpipam_api_user'
-    :password: 'phpipam_password'
-  :netbox:
-    :url: 'http://netbox.example.com'
-    :user: 'netbox_api_user'
-    :password: 'netbox_password'

data/lib/foreman_ipam/phpipam.rb

@@ -1,8 +0,0 @@
-module ForemanIpam
-  class Phpipam
-    def self.proxy
-      external_ipam_proxy = SmartProxy.with_features('External IPAM').first
-      ProxyAPI::ExternalIpam.new({:url => external_ipam_proxy[:url]})
-    end
-  end
-end