foreman_setup 1.0.0

data/README.md

@@ -0,0 +1,47 @@
+# foreman_setup
+
+Setting up Foreman for provisioning can be daunting at first, as there are
+lots of parameters to configure DHCP and DNS for the installer, plus for setup
+of subnets, domains, installation media etc for Foreman.
+
+# Installation
+
+Please see the Foreman wiki for appropriate instructions:
+
+* [Foreman: How to Install a Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
+
+The gem name is "foreman_setup".  Run `foreman-rake db:migrate` after
+installation.
+
+RPM users can install the "ruby193-rubygem-foreman_setup" or
+"rubygem-foreman_setup" packages.
+
+# Areas this should help
+
+* take input of subnet and domain information
+* output foreman-installer command with appropriate DHCP, DNS and TFTP parameters
+* add foreman-installer modules to the Foreman host with appropriate parameters
+* create a host group with appropriate parameters
+* create hosts (proxies/nodes) using created host groups
+* ensure provided templates and OSes are fully associated
+  * default templates should be properly associated in core
+  * when using Katello, its Foreman plugin helps associate
+* add appropriate installation media
+* add appropriate Spacewalk/redhat_register parameters
+
+# Copyright
+
+Copyright (c) 2013 Red Hat Inc.
+
+This program 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.
+
+This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

data/app/assets/javascripts/foreman_setup/provisioner.js

@@ -0,0 +1,13 @@
+function setup_media_change(ele) {
+  if ($(ele).val() == 'spacewalk') {
+    $('[id$="medium_path"]').prop('disabled', true)
+    $('#spacewalk_hostname').prop('disabled', false)
+  } else {
+    $('#spacewalk_hostname').prop('disabled', true)
+    $('[id$="medium_path"]').prop('disabled', false)
+  }
+}
+
+function setup_media_create_change(ele) {
+  $('[id$="medium_id"]').val('')
+}

data/app/controllers/foreman_setup/provisioners_controller.rb

@@ -0,0 +1,206 @@
+require 'facter'
+
+module ForemanSetup
+  class ProvisionersController < ::ApplicationController
+    include Foreman::Renderer
+
+    before_filter :find_myself, :only => [:new, :create]
+    before_filter :find_resource, :except => [:index, :new, :create]
+
+    def index
+      @provisioners = Provisioner.all.paginate :page => params[:page]
+      redirect_to new_foreman_setup_provisioner_path unless @provisioners.any?
+    end
+
+    def destroy
+      @provisioner = Provisioner.find(params[:id])
+      if @provisioner.destroy
+        process_success :success_redirect => foreman_setup_provisioners_path
+      else
+        process_error
+      end
+    end
+
+    def new
+      @provisioner = Provisioner.new(:host => @host, :smart_proxy => @proxy)
+    end
+
+    def create
+      @provisioner = Provisioner.new(params['foreman_setup_provisioner'])
+      if @provisioner.save
+        redirect_to step2_foreman_setup_provisioner_path(@provisioner)
+      else
+        @provisioner.host = @host
+        @provisioner.smart_proxy = @proxy
+        process_error :render => 'foreman_setup/provisioners/new', :object => @provisioner
+      end
+    end
+
+    # Basic model created, now fill in nested subnet/domain info using selected interface
+    def step2
+      network = @provisioner.provision_interface_data
+      @provisioner.subnet ||= Subnet.find_by_network(network[:network])
+      @provisioner.subnet ||= Subnet.new(network.slice(:network, :mask).merge(
+        :dns_primary => @provisioner.provision_interface_data[:ip],
+      ))
+
+      @provisioner.domain ||= @provisioner.host.domain
+      @provisioner.domain ||= Domain.new(:name => 'example.com')
+    end
+
+    def step2_update
+      @provisioner.hostgroup ||= Hostgroup.find_or_create_by_name(_("Provision from %s") % @provisioner.fqdn)
+      @provisioner.subnet ||= Subnet.find_by_id(params['foreman_setup_provisioner']['subnet_attributes']['id'])
+      domain_name = params['foreman_setup_provisioner'].delete('domain_name')
+      @provisioner.domain = Domain.find_by_name(domain_name)
+      @provisioner.domain ||= Domain.new(:name => domain_name)
+
+      if @provisioner.update_attributes(params['foreman_setup_provisioner'])
+        @provisioner.subnet.domains << @provisioner.domain unless @provisioner.subnet.domains.include? @provisioner.domain
+        process_success :success_msg => _("Successfully updated subnet %s.") % @provisioner.subnet.name, :success_redirect => step3_foreman_setup_provisioner_path
+      else
+        process_error :render => 'foreman_setup/provisioners/step2', :object => @provisioner, :redirect => step2_foreman_setup_provisioner_path
+      end
+    end
+
+    # foreman-installer info screen
+    def step3
+    end
+
+    # Installer completed, start associating data, begin install media setup
+    def step4
+      # Refresh proxy features (1.4 versus 1.3 techniques)
+      proxy = @provisioner.smart_proxy
+      proxy.respond_to?(:refresh) ? proxy.refresh : proxy.ping
+      proxy.save!
+
+      # Associate as much as possible
+      if proxy.features.include? Feature.find_by_name('DNS')
+        @provisioner.domain.dns_id ||= proxy.id
+        @provisioner.subnet.dns_id ||= proxy.id
+      end
+      if proxy.features.include? Feature.find_by_name('DHCP')
+        @provisioner.subnet.dhcp_id ||= proxy.id
+      end
+      if proxy.features.include? Feature.find_by_name('TFTP')
+        @provisioner.subnet.tftp_id ||= proxy.id
+      end
+      @provisioner.save!
+
+      # Helpful fix to work around #3210
+      url = Setting.find_by_name('foreman_url')
+      url.value ||= Facter.fqdn
+      url.save!
+
+      # Build default PXE menu
+      status, msg = ConfigTemplate.build_pxe_default(self)
+      warning msg unless status == 200
+
+      @provisioner.hostgroup.medium ||= @provisioner.host.os.media.first
+      @medium = Medium.new(params['foreman_setup_provisioner'].try(:[], 'medium_attributes'))
+
+      parameters = @provisioner.hostgroup.group_parameters
+      @activation_key = parameters.where(:name => 'activation_key').first || parameters.new(:name => 'activation_key')
+      @satellite_type = parameters.where(:name => 'satellite_type').first || parameters.new(:name => 'satellite_type')
+    end
+
+    def step4_update
+      if params['medium_type'] == 'spacewalk'
+        spacewalk_hostname = params['spacewalk_hostname']
+        if spacewalk_hostname.blank?
+          @provisioner.errors.add(:base, _("Spacewalk hostname is missing"))
+          process_error :render => 'foreman_setup/provisioners/step4', :object => @provisioner, :redirect => step4_foreman_setup_provisioner_path
+          return
+        end
+      end
+
+      medium_id = params['foreman_setup_provisioner']['hostgroup_attributes']['medium_id']
+      if medium_id.to_i > 0
+        @medium = Medium.find(medium_id) || raise('unable to find medium')
+      else
+        @provisioner.hostgroup.medium_id = nil
+        @medium = Medium.new(params['foreman_setup_provisioner']['create_medium'].slice(:name, :path))
+      end
+      @medium.path = "http://#{spacewalk_hostname}/ks/dist/ks-rhel-$arch-server-$major-$version" unless spacewalk_hostname.blank?
+
+      parameters = @provisioner.hostgroup.group_parameters
+      @activation_key = parameters.where(:name => 'activation_key').first
+      if @activation_key
+        @activation_key.assign_attributes(params['foreman_setup_provisioner']['activation_key'])
+      elsif params['foreman_setup_provisioner']['activation_key']['value'].present?
+        @activation_key = parameters.new(params['foreman_setup_provisioner']['activation_key'].merge(:name => 'activation_key'))
+      end
+
+      @satellite_type = parameters.where(:name => 'satellite_type').first
+      if @satellite_type
+        @satellite_type.assign_attributes(params['foreman_setup_provisioner']['satellite_type'])
+      elsif params['foreman_setup_provisioner']['satellite_type']['value'].present?
+        @satellite_type = parameters.new(params['foreman_setup_provisioner']['satellite_type'].merge(:name => 'satellite_type'))
+      end
+
+      # Associate medium with the host OS
+      @medium.os_family ||= @provisioner.host.os.type
+      @medium.operatingsystems << @provisioner.host.os unless @medium.operatingsystems.include? @provisioner.host.os
+      unless @medium.save
+        process_error :render => 'foreman_setup/provisioners/step4', :object => @provisioner, :redirect => step4_foreman_setup_provisioner_path
+        return
+      end
+
+      # Associate templates with OS and vice-versa
+      if @provisioner.host.os.family == 'Redhat'
+        tmpl_name = 'Kickstart'
+        provision_tmpl_name = @provisioner.host.os.name == 'Redhat' ? 'RHEL Kickstart' : tmpl_name
+        gpxe_tmpl_name = 'Kickstart'
+        ptable_name = 'RedHat default'
+      elsif @provisioner.host.os.family == 'Debian'
+        tmpl_name = provision_tmpl_name = 'Preseed'
+        ptable_name = 'Ubuntu default'
+      end
+
+      {'provision' => provision_tmpl_name, 'PXELinux' => tmpl_name, 'gPXE' => gpxe_tmpl_name}.each do |kind_name, tmpl_name|
+        next if tmpl_name.blank?
+        kind = TemplateKind.find_by_name(kind_name)
+        tmpls = ConfigTemplate.where('name LIKE ?', "#{tmpl_name}%").where(:template_kind_id => kind.id)
+        tmpls.any? || raise("cannot find template for #{@provisioner.host.os}")
+
+        # prefer foreman_bootdisk templates
+        tmpl = tmpls.where('name LIKE "boot disk"').first || tmpls.first
+
+        tmpl.operatingsystems << @provisioner.host.os unless tmpl.operatingsystems.include? @provisioner.host.os
+        tmpl.save!
+
+        unless @provisioner.host.os.os_default_templates.where(:template_kind_id => kind.id).any?
+          @provisioner.host.os.os_default_templates.build(:template_kind_id => kind.id, :config_template_id => tmpl.id)
+        end
+      end
+
+      @provisioner.host.os.architectures << @provisioner.host.architecture unless @provisioner.host.os.architectures.include? @provisioner.host.architecture
+      @provisioner.host.os.save!
+
+      ptable = Ptable.where('name LIKE ?', "#{ptable_name}%").first || raise("cannot find ptable for #{@provisioner.host.os}")
+      ptable.operatingsystems << @provisioner.host.os unless ptable.operatingsystems.include? @provisioner.host.os
+      ptable.save!
+
+      @provisioner.hostgroup.medium_id = @medium.id
+      @provisioner.hostgroup.ptable_id ||= ptable.id
+      @provisioner.hostgroup.save!
+
+      process_success :success_msg => _("Successfully associated OS %s.") % @provisioner.host.os.to_s, :success_redirect => step5_foreman_setup_provisioner_path
+    end
+
+    private
+
+    # foreman_setup manages only itself at the moment, so ensure we always have a reference to
+    # the Host and SmartProxy on this server
+    def find_myself
+      fqdn = Facter.fqdn
+      @host = Host.find_by_name(fqdn)
+      @proxy = SmartProxy.all.find { |p| URI.parse(p.url).host == fqdn }
+    end
+
+    def find_resource
+      @provisioner = Provisioner.find(params[:id]) or raise('unknown id')
+    end
+
+  end
+end

data/app/helpers/concerns/foreman_setup/home_helper_ext.rb

@@ -0,0 +1,15 @@
+module ForemanSetup
+  module HomeHelperExt
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :settings_menu_items, :provisioners_link
+    end
+
+    def settings_menu_items_with_provisioners_link
+      menu_items = settings_menu_items_without_provisioners_link
+      menu_items[2][2].insert(7, [_('Provisioning Setup'), :'foreman_setup/provisioners']) if menu_items[2]
+      menu_items
+    end
+  end
+end

data/app/helpers/foreman_setup/provisioner_helper.rb

@@ -0,0 +1,14 @@
+module ForemanSetup
+  module ProvisionerHelper
+    def provisioner_wizard(step)
+      wizard_header(
+        step,
+         _("Pre-requisites"),
+         _("Network config"),
+         _("Foreman installer"),
+         _("Installation media"),
+         _("Completion") 
+      )
+    end
+  end
+end

data/app/models/foreman_setup/provisioner.rb

@@ -0,0 +1,77 @@
+require 'ipaddr'
+
+module ForemanSetup
+  class Provisioner < ActiveRecord::Base
+    include ::Authorization
+    include ::Host::Hostmix
+
+    before_save :populate_hostgroup
+
+    belongs_to_host
+    belongs_to :domain
+    belongs_to :hostgroup, :autosave => true
+    belongs_to :smart_proxy
+    belongs_to :subnet
+    has_one :architecture, :through => :host
+    has_one :medium, :through => :hostgroup
+    has_one :operatingsystem, :through => :host
+
+    accepts_nested_attributes_for :hostgroup
+    # TODO: further validation on the subnet's (usually optional) attributes
+    accepts_nested_attributes_for :subnet
+
+    validates :host_id, :presence => true, :uniqueness => true
+    validates :smart_proxy_id, :presence => true
+
+    def to_s
+      host.try(:to_s)
+    end
+
+    def fqdn
+      Facter.fqdn
+    end
+
+    def interfaces
+      facts = host.facts_hash
+      (facts['interfaces'] || '').split(',').reject { |i| i == 'lo' }.inject({}) do |ifaces,i|
+        ip = facts["ipaddress_#{i}"]
+        network = facts["network_#{i}"]
+        netmask = facts["netmask_#{i}"]
+        if ip && network && netmask
+          cidr = "#{network}/#{IPAddr.new(netmask).to_i.to_s(2).count("1")}"
+          ifaces[i] = {:ip => ip, :mask => netmask, :network => network, :cidr => cidr}
+        end
+        ifaces
+      end
+    end
+
+    def provision_interface_data
+      interfaces[provision_interface]
+    end
+
+    def rdns_zone
+      netmask_octets = subnet.mask.split('.').reverse
+      subnet.network.split('.').reverse.drop_while { |i| netmask_octets.shift == '0' }.join('.') + '.in-addr.arpa'
+    end
+
+    def dns_forwarders
+      File.open('/etc/resolv.conf', 'r').each_line.map do |r|
+        $1 if r =~ /^nameserver\s+(\S+)/
+      end.compact
+    end
+
+    private
+
+    # Ensures our nested hostgroup has as much data as possible
+    def populate_hostgroup
+      return unless hostgroup.present?
+      hostgroup.architecture_id ||= domain.id
+      hostgroup.domain_id ||= domain.id
+      hostgroup.operatingsystem_id ||= operatingsystem.id
+      hostgroup.puppet_ca_proxy_id = smart_proxy.id if smart_proxy.features.include? Feature.find_by_name('Puppet CA')
+      hostgroup.puppet_proxy_id = smart_proxy.id if smart_proxy.features.include? Feature.find_by_name('Puppet')
+      hostgroup.subnet_id ||= subnet.id
+    end
+
+  end
+end

data/app/overrides/add_dashboard_provisioners_link.rb

@@ -0,0 +1,12 @@
+Deface::Override.new(:virtual_path => 'dashboard/index',
+                     :name => 'add_dashboard_provisioners_link',
+                     :surround_contents => 'code[erb-loud]:contains("title_actions")',
+                     :original => '35e276b7102eaa4feb8a4a84f66fd4812216fd48',
+                     :text => <<EOS
+if ForemanSetup::Provisioner.any?
+  <%= render_original %>
+else
+  title_actions link_to_if_authorized(_("Set up provisioning"), hash_for_new_foreman_setup_provisioner_path)
+end
+EOS
+)

data/app/overrides/remove_subnet_domains.rb

@@ -0,0 +1,9 @@
+Deface::Override.new(:virtual_path => 'subnets/_fields',
+                     :name => 'remove_subnet_domains',
+                     :surround_contents => 'code[erb-loud]:contains("multiple_checkboxes f, :domain")',
+                     :text => <<EOS
+unless controller.controller_name == 'provisioners'
+  <%= render_original %>
+end
+EOS
+)

data/app/overrides/remove_subnet_proxies.rb

@@ -0,0 +1,9 @@
+Deface::Override.new(:virtual_path => 'subnets/_fields',
+                     :name => 'remove_subnet_proxies',
+                     :surround_contents => 'code[erb-loud]:contains("SmartProxy.")',
+                     :text => <<EOS
+unless controller.controller_name == 'provisioners'
+  <%= render_original %>
+end
+EOS
+)

data/app/views/foreman_setup/provisioners/_step1.html.erb

@@ -0,0 +1,45 @@
+
+<%= form_for provisioner do |f| %>
+  <%= base_errors_for provisioner %>
+  <%= provisioner_wizard 1 %>
+
+  <p>
+    <%= _("This wizard will help set up Foreman for full host provisioning.  Before we begin, a few requirements will be verified.") %>
+  </p>
+
+  <h4><%= _("Pre-requisites") %></h4>
+  <div>
+    <%= f.hidden_field :host_id %>
+    <% if f.object.host.present? %>
+      <%= checked_icon f.object.host.present? %> <%= _("Found registered host %s") % f.object.host.name %>
+    <% else %>
+      <%= image_tag 'false.png' %> <%= _("Missing registered host %s, please ensure it is checking in") % f.object.fqdn %>
+    <% end %>
+  </div>
+  <div>
+    <%= f.hidden_field :smart_proxy_id %>
+    <% if f.object.smart_proxy.present? %>
+      <%= checked_icon f.object.smart_proxy.present? %> <%= _("Found registered smart proxy %s") % f.object.smart_proxy.name %>
+    <% else %>
+      <%= image_tag 'false.png' %> <%= _("Missing registered smart proxy %s, please ensure it is registered") % f.object.fqdn %>
+    <% end %>
+  </div>
+  <div>
+    <% if f.object.host.present? && f.object.interfaces.any? %>
+      <%= checked_icon f.object.host.present? %> <%= _("Host %s has at least one network interface") % f.object.host.name %>
+    <% else %>
+      <%= image_tag 'false.png' %> <%= _("No network interfaces listed in $interfaces fact") %>
+    <% end %>
+  </div>
+
+  <h4><%= _("Network selection") %></h4>
+  <div>
+    <% if f.object.host.present? && f.object.interfaces.any? %>
+      <%= selectable_f f, :provision_interface, f.object.interfaces.map { |i| ["#{i[1][:cidr]} (#{i[0]})", i[0]] }, {}, :label => _("Provisioning network") %>
+    <% else %>
+      <%= _("Not available until pre-requisites satisified.") %>
+    <% end %>
+  </div>
+
+  <%= submit_or_cancel f, false, {:cancel_path => foreman_setup_provisioners_path, :disabled => !(f.object.host.present? && f.object.smart_proxy.present?)} %>
+<% end %>