foreman_acd 0.2.1 → 0.7.0

data/app/models/foreman_acd/foreman_host.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # Foreman Host
+  class ForemanHost < ApplicationRecord
+    include Authorizable
+
+    self.table_name = 'acd_foreman_hosts'
+    validates :hostname, :presence => true
+    belongs_to :app_instance, :inverse_of => :foreman_hosts
+    belongs_to :host, :class_name => '::Host::Managed'
+    scoped_search :on => :hostname
+    default_scope -> { order('acd_foreman_hosts.hostname') }
+
+    def self.humanize_class_name(_name = nil)
+      _('Foreman Host')
+    end
+
+    def self.permission_name
+      'foreman_hosts'
+    end
+  end
+end

data/app/models/foreman_acd/taxonomy_extensions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # This is a TaxonomyExtensions
+  module TaxonomyExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      if SETTINGS[:version].to_s.to_f <= 1.7
+        def self.enabled_taxonomies
+          %w[locations organizations].select { |taxonomy| SETTINGS["#{taxonomy}_enabled".to_sym] }
+        end
+      end
+    end
+  end
+end
+# To be removed after 1.7 compatibility is no longer required

data/app/services/foreman_acd/acd_proxy_proxy_selector.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # AcdProxy Selector implementing a RemoteExecutionProxySelector which
+  # only returns the Smart Proxy of the given host
+  class AcdProxyProxySelector < ::RemoteExecutionProxySelector
+    def determine_proxy(*args)
+      host, _provider = args
+
+      # We already did the determine_proxy in app_configurator. We want that REX
+      # isn't doing the determination of the proxy twice.
+      # Therefore, we will just return the host, which is the proxy!
+
+      ::SmartProxy.find_by(:name => host.name)
+    end
+  end
+end

data/app/services/foreman_acd/app_configurator.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # application instances configurator
+  class AppConfigurator
+    delegate :logger, :to => :Rails
+
+    def initialize(app_instance)
+      @app_instance = app_instance
+    end
+
+    def configure
+      job_input = {}
+      job_input['application_name'] = @app_instance.name
+      job_input['playbook_id'] = @app_instance.app_definition.ansible_playbook.id
+      job_input['playbook_file'] = @app_instance.app_definition.ansible_playbook.playfile
+
+      logger.info("Use inventory to configure #{@app_instance.name} with ansible playbook #{@app_instance.app_definition.ansible_playbook.name}")
+
+      begin
+        proxy_hosts = {}
+        job = nil
+        result = OpenStruct.new
+
+        hosts = @app_instance.foreman_hosts
+
+        # Important: This uses the REX Proxy Selector and not
+        #  the AcdProxySelection because the AcdProxySelector
+        #  does not find the proxy but only return the given
+        #  host. This is required because we want to run the
+        #  ansible playbook for a group of hosts on the smart proxy.
+        #  So the process need to be:
+        #  1. get the proxy which is required to connect to host a,b,c
+        #  2. run the job on the proxy
+        #  In 2. we need to make sure that REX doesn't try to find the
+        #  proxy which is necessary to connect to the proxy
+        proxy_selector = RemoteExecutionProxySelector.new
+        hosts.each do |h|
+          begin
+            unless h.host
+              result.success = false
+              result.error = 'App Instance is not deployed'
+              return [result, job]
+            end
+            proxy = proxy_selector.determine_proxy(h.host, 'ACD')
+            result.success = true
+          rescue NoMethodError => e
+            result.success = false
+            result.error = "#{e}, Install/Update smart-proxies for ACD"
+            return [result, job]
+          end
+          proxy_hosts[proxy.name] = [] unless proxy_hosts.key?(proxy.name)
+          proxy_hosts[proxy.name] << h
+        end
+
+        # TODO: just for testing...
+        # proxy_hosts = { Host.first.name => [ Host.first.id] }
+
+        proxy_inventories = {}
+        proxy_host_ids =  []
+        proxy_hosts.each do |proxy_name, foreman_hosts|
+          proxy_inventories[proxy_name] = ForemanAcd::InventoryCreator.new(@app_instance, foreman_hosts).create_inventory
+
+          # Workaround till infrastructure jobs on proxies are possible. See
+          #     https://community.theforeman.org/t/infrastructure-roles/22001/33
+          #
+          # Why do we use 'foreman_hosts.first.host'? REX is 'host-centric'. During
+          # job execution, REX will try to find the proxy on which the job should be executed.
+          # We throw the first host at REX's feet so that the resolution of the
+          # proxy works (... which we have already done above).
+          # ACD on the smart proxy side will call the ansible-playbook for ALL hosts
+          # which are behind this smart proxy.
+          #
+          # Additionally, we disable that  AcdProxyProxySelector is used.
+          # See required_proxy_selector_for in models/foreman_acd/acd_provider.rb
+          proxy_host_ids << foreman_hosts.first.host.id
+
+          # Actually, we want this:
+          # proxy_host_ids << Host.find_by(:name => proxy_name).id
+        end
+
+        job_input['inventory'] = YAML.dump(proxy_inventories)
+        composer = JobInvocationComposer.for_feature(
+          :run_acd_ansible_playbook,
+          proxy_host_ids,
+          job_input.to_hash
+        )
+        job = composer
+      rescue StandardError => e
+        result.success = false
+        result.error = _('Failed to configure hosts: %{err_msg}' % { :err_msg => e.message })
+        logger.error('Failed to configure hosts: %{err_class}: %{err_msg}' % { :err_class => e.class, :err_msg => e.message })
+        job = nil
+      end
+      [result, job]
+    end
+  end
+end

data/app/services/foreman_acd/app_deployer.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # application instances deployer
+  class AppDeployer
+    delegate :logger, :to => :Rails
+
+    def initialize(app_instance)
+      @app_instance = app_instance
+    end
+
+    def deploy(safe_deploy)
+      output = []
+      services = JSON.parse(@app_instance.app_definition.services)
+      all_hosts = []
+
+      foreman_hosts = if safe_deploy
+                        @app_instance.foreman_hosts.find(safe_deploy)
+                      else
+                        @app_instance.foreman_hosts
+                      end
+
+      foreman_hosts.each do |foreman_host|
+        service_data = services.select { |k| k['id'] == foreman_host.service.to_i }.first
+        host_params = set_host_params(foreman_host, service_data)
+
+        host = foreman_host.host.presence
+
+        is_rebuild = false
+
+        if host.blank?
+          params = host_attributes(host_params)
+          log_params = params.dup
+          log_params['root_pass'] = '****' if log_params.key?('root_pass')
+          msg = "Host creation parameters for #{foreman_host.hostname}:\n#{log_params}\n"
+          logger.info(msg)
+          output << msg
+          host = Host.new(params)
+        else
+          msg = "Update parameters and re-deploy host #{foreman_host.hostname}"
+          logger.info(msg)
+          output << msg
+          host.attributes = host_attributes(host_params, host)
+          is_rebuild = true
+        end
+
+        # REMOVE ME (but very nice for testing)
+        # host.mac = "00:11:22:33:44:55"
+
+        apply_compute_profile(host)
+        host.suggest_default_pxe_loader
+
+        all_hosts << OpenStruct.new(:foreman_host => foreman_host, :host => host, :rebuild => is_rebuild)
+      end
+
+      # do this in a second step, so that we get the progress report for all
+      all_hosts.each do |os_host|
+        # Save the host -> will initiate the deployment
+        os_host.host.save!
+        msg = "Saved and initiated/updated host #{os_host.foreman_host.hostname}"
+        logger.info(msg)
+        output << msg
+
+        os_host.host.power.reset if os_host.rebuild
+
+        # save the foreman host id
+        os_host.foreman_host.update!(:host_id => os_host.host.id)
+
+        progress_report = Rails.cache.fetch(os_host.host.progress_report_id)
+        os_host.foreman_host.update!(:last_progress_report => progress_report)
+        if progress_report.empty?
+          msg = "Progress report for #{os_host.foreman_host.hostname} is empty!"
+          output << msg
+        end
+      end
+      output
+    end
+
+    private
+
+    # Copied from foreman/app/controllers/api/v2/hosts_controller.rb
+    def apply_compute_profile(host)
+      host.apply_compute_profile(InterfaceMerge.new(:merge_compute_attributes => true))
+      host.apply_compute_profile(ComputeAttributeMerge.new)
+    end
+
+    # Copied from foreman/app/controllers/api/v2/hosts_controller.rb
+    def host_attributes(params, host = nil)
+      return {} if params.nil?
+
+      params = params.deep_clone
+      if params[:interfaces_attributes]
+        # handle both hash and array styles of nested attributes
+        params[:interfaces_attributes] = params[:interfaces_attributes].values if params[:interfaces_attributes].is_a?(Hash) || params[:interfaces_attributes].is_a?(ActionController::Parameters)
+        # map interface types
+        params[:interfaces_attributes] = params[:interfaces_attributes].map do |nic_attr|
+          interface_attributes(nic_attr, :allow_nil_type => host.nil?)
+        end
+      end
+      params = host.apply_inherited_attributes(params) if host
+      params
+    end
+
+    # Copied from foreman/app/controllers/api/v2/hosts_controller.rb
+    def interface_attributes(params, allow_nil_type: false)
+      params[:type] = InterfaceTypeMapper.map(params[:type]) if params.key?(:type) || allow_nil_type
+      params
+    end
+
+    def hardcoded_params
+      result = {}
+      result['build'] = true
+      result['compute_attributes'] = { 'start' => '1' }
+      result['enabled'] = true
+      result['host_parameters_attributes'] = []
+      result['managed'] = true
+      result
+    end
+
+    def set_host_params(foreman_host, service_data)
+      result = hardcoded_params
+      result['name'] = foreman_host.hostname
+      result['hostgroup_id'] = service_data['hostgroup']
+
+      JSON.parse(foreman_host.foremanParameters).each do |param|
+        case param['type']
+
+        when 'computeprofile'
+          result['compute_profile_id'] = param['value']
+
+        when 'domain'
+          result['domain_id'] = param['value']
+
+        when 'hostparam'
+          result['host_parameters_attributes'].push(:name => param['name'], :value => param['value'])
+
+        when 'ip'
+          result['ip'] = param['value']
+
+        when 'lifecycleenv'
+          result['content_facet_attributes'] = { 'lifecycle_environment_id' => param['value'] }
+
+        when 'ptable'
+          result['ptable_id'] = param['value']
+
+        when 'puppetenv'
+          result['environment_id'] = param['value']
+
+        when 'password'
+          result['root_pass'] = param['value']
+
+        end
+      end
+      result
+    end
+  end
+end

data/app/services/foreman_acd/inventory_creator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # inventory creator for application instances
+  class InventoryCreator
+    delegate :logger, :to => :Rails
+
+    def initialize(app_instance, foreman_hosts)
+      @app_instance = app_instance
+      @foreman_hosts = foreman_hosts
+    end
+
+    # TODO: this might be part of the smart proxy plugin.
+    def create_inventory
+      inventory = {}
+      inventory['all'] = {}
+
+      inventory['all'] = { 'vars' => inventory_all_vars } if @app_instance.ansible_vars_all.present?
+
+      services = JSON.parse(@app_instance.app_definition.services)
+
+      children = {}
+      @foreman_hosts.each do |foreman_host|
+        if foreman_host.host_id.nil?
+          logger.warn "Ignore host #{foreman_h.hostname} because no foreman host id could be found. Is the host not provisioned yet?"
+          next
+        end
+
+        service_id = foreman_host.service.to_i
+        host_service = services.select { |s| s['id'] == service_id }.first
+        ansible_group = host_service['ansibleGroup']
+
+        children[ansible_group] = { 'hosts' => {} } unless children.key?(host_service['ansibleGroup'])
+
+        ansible_vars = JSON.parse(foreman_host.ansibleParameters).map { |v| { v['name'] => v['value'] } }.reduce({}, :merge!)
+
+        # in case there is no ansible_user defined, set "root" as default.
+        ansible_vars['ansible_user'] = 'root' unless ansible_vars.key?('ansible_user')
+        ansible_vars['ansible_ssh_private_key_file'] = ansible_or_rex_ssh_private_key(foreman_host.host)
+
+        children[ansible_group]['hosts'][foreman_host.host.name] = ansible_vars
+      end
+      inventory['all']['children'] = children
+      inventory
+    end
+
+    private
+
+    def ansible_or_rex_ssh_private_key(host)
+      ansible_private_file = host_setting(host, 'ansible_ssh_private_key_file')
+      if !ansible_private_file.empty?
+        ansible_private_file
+      else
+        ForemanRemoteExecutionCore.settings[:ssh_identity_key_file]
+      end
+    end
+
+    def host_setting(host, setting)
+      host.params[setting] || Setting[setting]
+    end
+
+    def inventory_all_vars
+      JSON.parse(@app_instance.ansible_vars_all).map do |a|
+        { a['name'] => a['value'] }
+      end.reduce({}, :merge!)
+    end
+  end
+end

data/app/views/foreman_acd/ansible_playbooks/_form.html.erb

@@ -0,0 +1,64 @@
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_acd %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_acd %>
+<% end %>
+
+<%
+    if @ansible_playbook.new_record?
+    json = {
+      "scmTypes": {"directory" => "directory", "git" => "git"},
+      "mode": "newPlaybook",
+      "organization": current_organization,
+      "location": current_location,
+      "path": "",
+      "gitUrl": "",
+      "gitCommit": "",
+      "scmType": "",
+      "appDefinitions": [],
+    }
+
+    else
+      json = {
+      "scmTypes": {"directory" => "directory", "git" => "git"},
+      "mode": "editPlaybook",
+      "organization": current_organization,
+      "location": current_location,
+      "path": @ansible_playbook.path,
+      "gitUrl": @ansible_playbook.git_url,
+      "gitCommit": @ansible_playbook.git_commit,
+      "scmType": @ansible_playbook.scm_type,
+      "appDefinitions": @ansible_playbook.app_definitions
+      }
+    end
+%>
+
+<%= form_for @ansible_playbook, :url => (@ansible_playbook.new_record? ? ansible_playbooks_path : ansible_playbook_path(:id => @ansible_playbook.id)) do |f| %>
+  <%= base_errors_for @ansible_playbook %>
+
+  <ul class="nav nav-tabs" data-tabs="tabs">
+    <li class="active"><a href="#primary" data-toggle="tab"><%= _('Ansible playbooks') %></a></li>
+    <% if show_location_tab? %>
+          <li><a href="#locations" data-toggle="tab"><%= _("Locations") %></a></li>
+      <% end %>
+      <% if show_organization_tab? %>
+          <li><a href="#organizations" data-toggle="tab"><%= _("Organizations") %></a></li>
+      <% end %>
+  </ul>
+
+  <div class="tab-content">
+    <div class="tab-pane active" id="primary">
+    
+      <%= text_f f, :name %>
+      <%= text_f f, :description %>
+      <div id='ansible_playbook'>
+       <%= react_component('SyncGitRepo', :data => json,)  %>
+      </div>
+      <%= text_f f, :playfile, :required => true %>
+    </div>
+    
+    <%= render 'taxonomies/loc_org_tabs', :f => f, :obj => @ansible_playbook %>
+  </div>
+  <%= submit_or_cancel f %>
+<% end %>