foreman_wreckingball 0.1.0

data/app/models/foreman_wreckingball/cpu_hot_add_status.rb

@@ -0,0 +1,58 @@
+module ForemanWreckingball
+  class CpuHotAddStatus < ::HostStatus::Status
+    OK = 0
+    PERFORMANCE_DEGRATION = 1
+
+    def self.status_name
+      N_('CPU Hot Plug')
+    end
+
+    def self.host_association
+      :vmware_cpu_hot_add_status_object
+    end
+
+    def self.description
+      N_('Enabling CPU hot-add disables vNUMA, the virtual machine will instead use UMA. This might cause a performance degration.')
+    end
+
+    def self.supports_remediate?
+      false
+    end
+
+    def to_status(_options = {})
+      performance_degration? ? PERFORMANCE_DEGRATION : OK
+    end
+
+    def to_global(_options = {})
+      case status
+      when PERFORMANCE_DEGRATION
+        HostStatus::Global::ERROR
+      else
+        HostStatus::Global::OK
+      end
+    end
+
+    def to_label(_options = {})
+      case status
+      when PERFORMANCE_DEGRATION
+        N_('Possible performance degration')
+      else
+        N_('No Impact')
+      end
+    end
+
+    def relevant?(_options = {})
+      host && !!host.vmware_facet && host.vmware_facet.try(:cpu_hot_add?)
+    end
+
+    def performance_degration?
+      min_cores = hypervisor_min_cores
+      return false unless min_cores
+      host.vmware_facet.cpu_hot_add? && host.vmware_facet.cpus > min_cores
+    end
+
+    def hypervisor_min_cores
+      host.vmware_facet.vmware_hypervisor_facets.minimum(:cpu_cores)
+    end
+  end
+end

data/app/models/foreman_wreckingball/operatingsystem_status.rb

@@ -0,0 +1,65 @@
+module ForemanWreckingball
+  class OperatingsystemStatus < ::HostStatus::Status
+    OK = 0
+    MISMATCH = 1
+
+    def self.status_name
+      N_('VM Operatingsystem')
+    end
+
+    def self.host_association
+      :vmware_operatingsystem_status_object
+    end
+
+    def self.description
+      N_('The VM operatingsystem should match the operatingsystem installed.')
+    end
+
+    def self.supports_remediate?
+      true
+    end
+
+    def self.remediate_action
+      ::Actions::ForemanWreckingball::Host::RemediateVmwareOperatingsystem
+    end
+
+    def to_status(_options = {})
+      os_matches_identifier? ? OK : MISMATCH
+    end
+
+    def to_global(_options = {})
+      case status
+      when MISMATCH
+        HostStatus::Global::WARN
+      else
+        HostStatus::Global::OK
+      end
+    end
+
+    def to_label(_options = {})
+      case status
+      when MISMATCH
+        N_('VM OS is incorrect')
+      else
+        N_('OK')
+      end
+    end
+
+    def relevant?(_options = {})
+      host && !!host.vmware_facet
+    end
+
+    def os_matches_identifier?
+      guest_id = host.vmware_facet.guest_id
+      vsphere_os = VsphereOsIdentifiers.lookup(guest_id)
+      return true unless vsphere_os
+      os = host.operatingsystem
+      return true unless host.operatingsystem && host.architecture
+      return false if vsphere_os.architecture && vsphere_os.architecture != host.architecture.name
+      return false if vsphere_os.osfamily && vsphere_os.osfamily != host.operatingsystem.family
+      return false if vsphere_os.name && vsphere_os.name != host.operatingsystem.name
+      return false if vsphere_os.major && vsphere_os.major != host.operatingsystem.major.to_i
+      true
+    end
+  end
+end

data/app/models/foreman_wreckingball/tools_status.rb

@@ -0,0 +1,46 @@
+module ForemanWreckingball
+  class ToolsStatus < ::HostStatus::Status
+    POWERDOWN = 10
+
+    def self.status_name
+      N_('VMware Tools')
+    end
+
+    def self.host_association
+      :vmware_tools_status_object
+    end
+
+    def self.description
+      N_('VMWare Tools should be running and up-to-date.')
+    end
+
+    def self.supports_remediate?
+      false
+    end
+
+    def to_status(_options = {})
+      return POWERDOWN unless host.supports_power_and_running?
+      VmwareFacet.tools_states[host.vmware_facet.tools_state]
+    end
+
+    def to_global(_options = {})
+      case status
+      when VmwareFacet.tools_states[:toolsOk], POWERDOWN
+        HostStatus::Global::OK
+      when VmwareFacet.tools_states[:toolsOld]
+        HostStatus::Global::WARN
+      else
+        HostStatus::Global::ERROR
+      end
+    end
+
+    def to_label(_options = {})
+      return N_('Powered down') if status == POWERDOWN
+      host.vmware_facet.tools_state_label
+    end
+
+    def relevant?(_options = {})
+      host && !host.build? && !!host.vmware_facet
+    end
+  end
+end

data/app/models/foreman_wreckingball/vmware_cluster.rb

@@ -0,0 +1,14 @@
+module ForemanWreckingball
+  class VmwareCluster < ActiveRecord::Base
+    has_many :vmware_hypervisor_facets, :class_name => '::ForemanWreckingball::VmwareHypervisorFacet'
+    has_many :hosts, :class_name => '::Host::Managed', :through => :vmware_hypervisor_facets,
+      :inverse_of => :vmware_cluster
+    belongs_to :compute_resource, :inverse_of => :vmware_clusters
+    has_many :vmware_facets, :class_name => '::ForemanWreckingball::VmwareFacet', :inverse_of => :vmware_clusters
+
+    validates_lengths_from_database
+
+    validates :compute_resource, :presence => true, :allow_blank => false
+    validates :name, :presence => true, :allow_blank => false, uniqueness: { scope: :compute_resource}
+  end
+end

data/app/models/foreman_wreckingball/vmware_facet.rb

@@ -0,0 +1,53 @@
+module ForemanWreckingball
+  class VmwareFacet < ActiveRecord::Base
+    include Facets::Base
+
+    VALID_GUEST_STATUSES = [:toolsNotInstalled, :toolsNotRunning, :toolsOk, :toolsOld].freeze
+
+    enum :tools_state => VALID_GUEST_STATUSES
+
+    belongs_to :vmware_cluster, :class_name => '::ForemanWreckingball::VmwareCluster',
+      :inverse_of => :vmware_facets
+
+    has_many :vmware_hypervisor_facets, :class_name => '::ForemanWreckingball::VmwareHypervisorFacet', :through => :vmware_cluster,
+      :inverse_of => :vmware_facets
+
+    validates_lengths_from_database
+
+    validates :host, :presence => true, :allow_blank => false
+
+    def tools_state_label
+      case tools_state.to_sym
+      when :toolsNotInstalled
+        N_('Not installed')
+      when :toolsNotRunning
+        N_('Not running')
+      when :toolsOk
+        N_('OK')
+      when :toolsOld
+        N_('Out of date')
+      end
+    end
+
+    def refresh!
+      vm = host.compute_object
+      return unless vm
+      self.update(
+        :vmware_cluster => ::ForemanWreckingball::VmwareCluster.find_by(:name => vm.cluster, :compute_resource => host.compute_resource),
+        :cpus => vm.cpus,
+        :corespersocket => vm.corespersocket,
+        :memory_mb => vm.memory_mb,
+        :tools_state => vm.tools_state,
+        :guest_id => vm.guest_id,
+        :cpu_hot_add => vm.cpuHotAddEnabled
+      )
+    end
+
+    def refresh_statuses
+      host.get_status(::ForemanWreckingball::ToolsStatus).refresh!
+      host.get_status(::ForemanWreckingball::CpuHotAddStatus).refresh!
+      host.get_status(::ForemanWreckingball::OperatingsystemStatus).refresh!
+      host.refresh_global_status!
+    end
+  end
+end

data/app/models/foreman_wreckingball/vmware_hypervisor_facet.rb

@@ -0,0 +1,18 @@
+module ForemanWreckingball
+  class VmwareHypervisorFacet < ActiveRecord::Base
+    include Facets::Base
+
+    validates_lengths_from_database
+
+    validates :host, :presence => true, :allow_blank => false
+
+    belongs_to :vmware_cluster, :inverse_of => :vmware_hypervisor_facets, :class_name => 'ForemanWreckingball::VmwareCluster'
+
+    has_many :vmware_facets, :class_name => '::ForemanWreckingball::VmwareFacet', :through => :vmware_clusters,
+      :inverse_of => :vmware_hypervisor_facets
+
+    def self.sanitize_name(name)
+      name.gsub('_', '-').chomp('.').downcase
+    end
+  end
+end

data/app/services/foreman_wreckingball/vmware_cluster_importer.rb

@@ -0,0 +1,41 @@
+module ForemanWreckingball
+  class VmwareClusterImporter
+    delegate :logger, :to => :Rails
+    attr_accessor :compute_resource, :counters
+
+    def initialize(options = {})
+      @compute_resource = options.fetch(:compute_resource)
+      @counters = {}
+    end
+
+    def import!
+      ActiveRecord::Base.transaction do
+        delete_removed_clusters
+        create_new_clusters
+      end
+    logger.info("Import clusters for '#{compute_resource}' completed. Added: #{counters[:added] || 0}, Updated: #{counters[:updated] || 0}, Deleted: #{counters[:deleted] || 0} clusters")
+    end
+
+    def delete_removed_clusters
+      delete_query = ::ForemanWreckingball::VmwareCluster.where(:compute_resource => compute_resource).where.not(:name => cluster_names)
+      if ActiveRecord::Base.connection.adapter_name.downcase.starts_with? 'mysql'
+        counters[:deleted] = ::ForemanWreckingball::VmwareCluster.where(:id => delete_query.pluck(:id)).delete_all
+      else
+        counters[:deleted] = delete_query.delete_all
+      end
+    end
+
+    def create_new_clusters
+      existing_clusters = ::ForemanWreckingball::VmwareCluster.where(:compute_resource => compute_resource).pluck(:name)
+      clusters_to_create = cluster_names - existing_clusters
+      clusters_to_create.each do |cluster_name|
+        ::ForemanWreckingball::VmwareCluster.create(:name => cluster_name, :compute_resource => compute_resource)
+      end
+      counters[:added] = clusters_to_create.size
+    end
+
+    def cluster_names
+      @cluster_names ||= compute_resource.clusters
+    end
+  end
+end

data/app/services/foreman_wreckingball/vmware_hypervisor_importer.rb

@@ -0,0 +1,119 @@
+module ForemanWreckingball
+  class VmwareHypervisorImporter
+    delegate :logger, :to => :Rails
+    attr_accessor :compute_resource, :counters
+
+    def initialize(options = {})
+      @compute_resource = options.fetch(:compute_resource)
+      @hypervisors = {}
+      @counters = {}
+    end
+
+    def import!
+      logger.info "Can not determine organization for compute resource #{compute_resource}." if SETTINGS[:organizations_enabled]
+      compute_resource.refresh_cache
+      compute_resource.vmware_clusters.each do |cluster|
+        import_hypervisors(cluster)
+      end
+      logger.info("Import hypervisors for '#{compute_resource}' completed. Added: #{counters[:added] || 0}, Updated: #{counters[:updated] || 0}, Deleted: #{counters[:deleted] || 0} hypervisors")
+    end
+
+    def import_hypervisors(cluster)
+      hypervisors(cluster).each do |hypervisor|
+        import_hypervisor(cluster, hypervisor)
+      end
+    end
+
+    def import_hypervisor(cluster, hypervisor)
+      host = find_host_for_hypervisor(hypervisor)
+
+      counter = host.vmware_hypervisor_facet ? :updated : :added
+
+      ipaddress6 = hypervisor.ipaddress6
+      ipaddress6 = nil if (IPAddr.new('fe80::/10').include?(ipaddress6) rescue false)
+
+      hostname = hypervisor.hostname
+      domainname = hypervisor.domainname
+
+      unless hostname.present? && domainname.present?
+        logger.info "Trying to guess host- and domainname for #{hypervisor.name}."
+        hostname, domainname = hypervisor.name.split('.', 2)
+      end
+
+      unless hostname.present? && domainname.present?
+        logger.error "Could not guess host- and domainname for #{hypervisor.name}. Skipping."
+        return false
+      end
+
+      result = host.update(
+        :name => hostname,
+        :domain => ::Domain.where(:name => domainname).first_or_create,
+        :model => ::Model.where(:name => hypervisor.model.strip).first_or_create,
+        :ip => hypervisor.ipaddress,
+        :ip6 => ipaddress6,
+        :vmware_hypervisor_facet_attributes => {
+          :vmware_cluster => cluster,
+          :cpu_cores => hypervisor.cpu_cores,
+          :cpu_sockets => hypervisor.cpu_sockets,
+          :cpu_threads => hypervisor.cpu_threads,
+          :memory => hypervisor.memory,
+          :uuid => hypervisor.uuid
+        }
+      )
+      if result
+        increment_counter(counter)
+      else
+        logger.error "Failed to save host #{host}. Reason: #{host.errors.full_messages.to_sentence}"
+      end
+    end
+
+    def hypervisors(cluster)
+      @hypervisors[cluster.name.to_sym] ||= compute_resource.hypervisors(:cluster_id => cluster.name)
+    end
+
+    def find_host_for_hypervisor(hypervisor)
+      name = ::ForemanWreckingball::VmwareHypervisorFacet.sanitize_name(hypervisor.name)
+      hostname = ::ForemanWreckingball::VmwareHypervisorFacet.sanitize_name([hypervisor.hostname, hypervisor.domainname].join('.'))
+      hostname = nil unless hostname.present?
+      katello_name = katello_hypervisor_hostname(hostname || name)
+      katello_uuid = katello_hypervisor_hostname(hypervisor.uuid)
+
+      host = ::ForemanWreckingball::VmwareHypervisorFacet.find_by(:uuid => hypervisor.uuid).try(:host)
+      host ||= ::Host.find_by(:name => hostname) if hostname
+      host ||= ::Host.find_by(:name => name)
+      host ||= ::Host.find_by(:name => katello_name) if katello_name
+      host ||= ::Host.find_by(:name => katello_uuid) if katello_uuid
+      host ||= create_host_for_hypervisor(hostname || name)
+      host
+    end
+
+    def create_host_for_hypervisor(name)
+      host = ::Host::Managed.new(:name => name, :organization => organization,
+                                 :location => location, :managed => false, :enabled => false)
+      host.save!
+      host
+    end
+
+    def organization
+      return unless SETTINGS[:organizations_enabled]
+      compute_resource.organizations.first
+    end
+
+    def location
+      return unless SETTINGS[:locations_enabled]
+      compute_resource.locations.first
+    end
+
+    def katello_hypervisor_hostname(hostname)
+      return unless organization
+      "virt-who-#{hostname}-#{organization.id}"
+    end
+
+    private
+
+    def increment_counter(id)
+      counters[id] ||= 0
+      counters[id] += 1
+    end
+  end
+end

data/app/views/foreman_wreckingball/hosts/_status_dashboard_content.erb

@@ -0,0 +1,43 @@
+<%=
+  alert(:header => _('Notice'),
+        :class => 'alert-info',
+        :text => _('The status data is not updated automatically and might be out of data. The newest data was recorded on %s.').html_safe % (respond_to?(:date_time_absolute) ? date_time_absolute(@newest_data, :long) : l(@newest_data, :format => :long))
+       )
+%>
+
+<div class="list-group list-view-pf list-view-pf-equalized-column" style="max-height: initial;">
+<% @data.each_with_index do |status, idx| %>
+<%=
+  render :partial => 'status_row', locals: {
+    name: status[:name],
+    description: status[:description],
+    counter: vmware_status_counter(status[:hosts], status[:host_association]),
+    status: status[:host_association],
+    hosts: status[:hosts],
+    supports_remediate: status[:supports_remediate],
+    id: idx
+  }
+%>
+<% end %>
+</div>
+<script>
+  $(document).ready(function () {
+    // click the list-view heading then expand a row
+    $(".list-group-item-header").click(function(event){
+      if(!$(event.target).is("button, a, input, .fa-ellipsis-v")){
+        $(this).find(".fa-angle-right").toggleClass("fa-angle-down")
+          .end().parent().toggleClass("list-view-pf-expand-active")
+            .find(".list-group-item-container").toggleClass("hidden");
+      } else {
+      }
+    })
+
+    // click the close button, hide the expand row and remove the active status
+    $(".list-group-item-container .close").on("click", function (){
+      $(this).parent().addClass("hidden")
+        .parent().removeClass("list-view-pf-expand-active")
+          .find(".fa-angle-right").removeClass("fa-angle-down");
+    })
+
+  });
+</script>

data/app/views/foreman_wreckingball/hosts/_status_dashboard_empty.erb

@@ -0,0 +1,13 @@
+<div class="blank-slate-pf">
+  <div class="blank-slate-pf-icon">
+    <%= icon_text('tachometer', '', :kind => 'fa') %>
+  </div>
+  <h1><%= _('VMware Status Overview') %></h1>
+  <p>
+  <%= _('You don\'t seem to have imported any VM data into Foreman.') %></br>
+  <%= _('You need to run an initial import to gather all required data.') %>
+  </p>
+  <div class="blank-slate-pf-main-action">
+    <%= display_link_if_authorized(_('Start Data Import'), hash_for_refresh_status_dashboard_hosts_path, :title => _('Import data into Foreman'), :method => :put, :class => 'btn btn-primary btn-lg') %>
+  </div>
+</div>

data/app/views/foreman_wreckingball/hosts/_status_row.html.erb

@@ -0,0 +1,107 @@
+<div class="list-group-item list-view-pf-stacked list-view-pf-top-align">
+  <div class="list-group-item-header">
+    <div class="list-view-pf-expand">
+      <span class="fa fa-angle-right"></span>
+    </div>
+    <div class="list-view-pf-actions">
+      <% if User.current.allowed_to?(hash_for_refresh_status_dashboard_hosts_path) %>
+        <div class="dropdown pull-right dropdown-kebab-pf">
+          <button class="btn btn-link dropdown-toggle" type="button" id="dropdownKebabRight<%= id %>" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
+            <span class="fa fa-ellipsis-v"></span>
+          </button>
+          <ul class="dropdown-menu dropdown-menu-right" aria-labelledby="dropdownKebabRight<%= id %>">
+            <li><%= display_link_if_authorized(_('Refresh'), hash_for_refresh_status_dashboard_hosts_path, :title => _('Refresh data'), :method => :put) %></li>
+          </ul>
+        </div>
+      <% end %>
+    </div>
+    <div class="list-view-pf-main-info">
+      <div class="list-view-pf-left">
+        <span class="pficon list-view-pf-icon-md <%= classes_for_vmware_status_row(counter) %>"></span>
+      </div>
+      <div class="list-view-pf-body">
+        <div class="list-view-pf-description">
+          <div class="list-group-item-heading">
+            <%= _(name) %>
+          </div>
+          <div class="list-group-item-text">
+            <%= _(description) %>
+          </div>
+        </div>
+        <div class="list-view-pf-additional-info">
+          <div class="list-view-pf-additional-info-item">
+            <%= icon_text('ok', '', :kind => 'pficon') %>
+            <strong><%= counter[:ok] %></strong>
+            <%= _('OK') %>
+          </div>
+          <div class="list-view-pf-additional-info-item">
+            <%= icon_text('warning-triangle-o', '', :kind => 'pficon') %>
+            <strong><%= counter[:warning] %></strong>
+            <%= _('Warning') %>
+          </div>
+          <div class="list-view-pf-additional-info-item">
+            <%= icon_text('error-circle-o', '', :kind => 'pficon') %>
+            <strong><%= counter[:critical] %></strong>
+            <%= _('Critical') %>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+  <div class="list-group-item-container container-fluid hidden">
+    <div class="close">
+      <span class="pficon pficon-close"></span>
+    </div>
+    <div class="row">
+      <div class="col-md-12">
+        <% if counter[:warning] > 0 || counter[:critical] > 0 %>
+          <p><%= _('The following host require manual attention:') %></p>
+          <table class="table table-striped table-fixed">
+            <thead>
+              <tr>
+                <th><%= _('Hostname') %></th>
+                <th><%= _('Status') %></th>
+                <th><%= _('Owner') %></th>
+                <th><%= _('Puppet Environment') %></th>
+                <% if supports_remediate %>
+                  <th><%= _('Actions') %></th>
+                <% end %>
+              </tr>
+            </thead>
+            <tbody>
+              <% hosts.each do |host| %>
+                <% next if host.public_send(status).to_global == HostStatus::Global::OK %>
+                <tr>
+                  <td class="ellipsis"><%= link_to_if_authorized(host.name, hash_for_host_path(:id => host)) %></td>
+                  <td>
+                    <span class="<%= host_global_status_icon_class(host.public_send(status).to_global) %>"></span>
+                    <span class="<%= host_global_status_class(host.public_send(status).to_global) %>"><%= _(host.public_send(status).to_label) %></span>
+                  </td>
+                  <td class="ellipsis"><%= host.owner %></td>
+                  <td class="ellipsis"><%= host.environment %></td>
+                  <% if supports_remediate %>
+                    <td>
+                      <%=
+                        action_buttons(
+                          display_link_if_authorized(
+                            _('Remediate'),
+                            hash_for_remediate_host_path(:id => host, :status_id => host.public_send(status).id).merge(:auth_object => host, :permission => 'remediate_vmware_status_hosts'),
+                            :data => { :confirm => _('Are you sure? This might cause a service interruption.') },
+                            :method => :put,
+                            :target => :blank
+                          )
+                        )
+                      %>
+                  </td>
+                <% end %>
+                </tr>
+              <% end %>
+            </tbody>
+          </table>
+        <% else %>
+          <p><%= _('No manual actions required.') %></p>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/foreman_wreckingball/hosts/status_dashboard.html.erb

@@ -0,0 +1,9 @@
+<% title _('VMware Status Overview') %>
+
+<%=
+  if @newest_data
+    render 'status_dashboard_content'
+  else
+    render 'status_dashboard_empty'
+  end
+%>

data/config/routes.rb

@@ -0,0 +1,15 @@
+Rails.application.routes.draw do
+  scope '/wreckingball' do
+    constraints(:id => /[^\/]+/) do
+      resources :hosts, controller: 'foreman_wreckingball/hosts', :only => [] do
+        member do
+          put :remediate
+        end
+        collection do
+          get :status_dashboard
+          put :refresh_status_dashboard
+        end
+      end
+    end
+  end
+end

data/db/migrate/20171106155000_create_vmware_facets.rb

@@ -0,0 +1,35 @@
+class CreateVmwareFacets < ActiveRecord::Migration
+  def change
+    create_table :vmware_clusters do |t|
+      t.string :name, limit: 255, index: true
+      t.references :compute_resource, foreign_key: true
+
+      t.timestamps null: false
+    end
+
+    create_table :vmware_hypervisor_facets do |t|
+      t.references :host, null: false, foreign_key: true, index: true, unique: true
+      t.references :vmware_cluster, foreign_key: true, index: true
+      t.integer :cpu_cores
+      t.integer :cpu_sockets
+      t.integer :cpu_threads
+      t.integer :memory, limit: 8
+      t.string :uuid, limit: 255
+
+      t.timestamps null: false
+    end
+
+    create_table :vmware_facets do |t|
+      t.references :host, null: false, foreign_key: true, index: true, unique: true
+      t.references :vmware_cluster, foreign_key: true, index: true
+      t.integer :cpus
+      t.integer :corespersocket
+      t.integer :memory_mb
+      t.string :guest_id, limit: 255, index: true
+      t.integer :tools_state, default: 1, index: true
+      t.boolean :cpu_hot_add, null: false, default: false
+
+      t.timestamps null: false
+    end
+  end
+end