foreman_acd 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d211aae9186f8f78068084f48a57c33bcc12840c8c187345a195ce90b474b62
-  data.tar.gz: ffdefcc21d390b4cd379cae7f5884a1660303408824206bcede99dfc00cac23b
+  metadata.gz: 809d34cc7063d66a26a1c0c913cd95287a6329cce55a75c1684046bb47b1afe1
+  data.tar.gz: d32aa387545b3fac503996354baae6704c30118a923d95706668895cad6440f5
 SHA512:
-  metadata.gz: 596cce7e2dc9f22f8e53da0060d327e3649963a03df3b89bc60e454698c8318f96d2500dc266ef3a430da959437601154ee00682a416baeaaa0db119f2027d36
-  data.tar.gz: 357f087227ff418cf2ed0cbcf18e0ec5487fdb55c985c35fe55dea387f93db7eb1ec4268a312e325f925621bdb2cf16fdad1d06b13e893bce672e8d1aa03d2c3
+  metadata.gz: 996b0c911e71e045b232b3d6b27776eaa9c7e6c52f23f78d29c911f899d4a60024990fa8866e2f401e2d91f1c2a0c06a7264f16ffc2e4bd0b97c0e794a0a7c63
+  data.tar.gz: 445dc99ec810e7fbbdf33d2c1e69b3a60942c58938212105033e472981bee85e626ce51d7e2f36359bbfb9148dca240fff134d183481d1d8312a3e9f933f4815

data/README.md

@@ -2,143 +2,139 @@
 
 # Foreman Application Centric Deployment
 
-A plugin to bring an user self service portal and application centric deployment to Foreman.
+A Foreman plugin providing application centric deployment and a self-service portal.
 
+# Introduction
 
-# Description
-
-The target of this plugin is, to deploy whole applications which include multiple hosts and 
-configure them using an Ansible Playbook / saltstack state.
+The target of this plugin is to deploy whole applications which include multiple hosts and configure them using an Ansible playbook.
 
 This plugin follows the idea of different user types working together.
-The administrative user creates Application Definition including multiple servers and
-configuration management items (Ansible Playbook, saltstack state).
-The user can create and deploy new Application Instaces with an easy to use self service portal. 
-
-*Example Application Definition:* To run a complex web application, a loadbalancer is required.
-The loadbalancer routes the requests to 3 different web servers.
-The web servers are using a database which is in high availability mode on 2 hosts.
-=> 6 hosts are required.
+The _administrative user_ creates Application Definitions including multiple servers and configuration management items (Ansible Playbooks).
+The _user_ can create and deploy new Application Instances with an easy to use self-service portal.
 
-This plugin aims to setup all 6 hosts and to deploy the application.
+*Example Application Definition*
+To run a complex web application, a load balancer is required.
+The load balancer routes the requests to three different web servers.
+The web servers are using a database which runs in high availability mode on two hosts.
+Therefore, six hosts in total are required.
 
+This plugin aims to setup all six hosts and to deploy the application.
 
-# Current State
+# Architecture
 
-## Application Definition
+## Ansible Playbooks
 
-- Configure a ansible playbook 
-- Use the configured ansible playbook in a Application Definition
-- Overwrite ansible playbook's group variables for the Application Definition
-- Set foreman parameters in the Application Definition
-- Setup various services like webservers, database-servers, etc.
+* Specify the path on your Foreman server to the Ansible playbook and playfile
+* Read groups configured in the Ansible playbook
 
-## Application Instance
+## Application Definitions
 
-- Use an Application Definition for your Application Instance
-- Configure specific hosts which uses the Application Definitions services
-- Deploy these hosts
-- Configure the hosts using the configured ansible playbook
+* Use the configured Ansible playbook in an Application Definition
+* Overwrite group variables of the Ansible playbook for the Application Definition
+* Set Foreman parameters in the Application Definition
+* Setup various services like web servers, database servers, etc.
 
-# How it works
+## Application Instances
 
-- Configure ansible playbook, application definition and create an instance.
-- If you deploy the application instance, all hosts are created.
-- When done, you can configure the hosts with the linked ansible-playbook.
-- To do so, the [Smart Proxy ACD](https://github.com/ATIX-AG/smart_proxy_acd) is used.
-- The job to configure the hosts will be send to the Smart Proxy ACD which will
-    - download the ansible playbook from foreman (provided by an foreman_acd API)
-    - extract the ansible playbook on the Smart Proxy
-    - run the ansible-playbook on the Smart Proxy
-- On the Monitor -> Job page you see the output of the ansible-playbook run.
+* Use an Application Definition for your Application Instance
+* Configure specific hosts which use the Application Definition's services
+* Deploy these hosts
+* Configure the hosts using the configured Ansible playbook
 
+# How It Works
 
-## WARNING
+* Configure an Ansible playbook, an Application Definition, and create an Application Instance.
+* All hosts are created when deploying the Application Instance.
+* After provisioning, the hosts are configured with the linked Ansible playbook.
+* This uses the [Smart Proxy ACD](https://github.com/ATIX-AG/smart_proxy_acd) component.
+* The job to configure the hosts will be send to the Smart Proxy ACD component which will
+    * download the Ansible playbook from your Foreman server (provided by an foreman_acd API);
+    * extract the Ansible playbook on the Smart Proxy;
+    * and run the Ansible playbook on the Smart Proxy.
+* You can see the output of the Ansible playbook run on the *Monitor > Job* page.
 
-This plugin is in development. 
+:warning: This plugin is still in development.
 
 ## Installation
 
-See [How_to_Install_a_Plugin](https://theforeman.org/plugins/#2.Installation)
-for how to install Foreman plugins. 
-
-You will need to install [Smart Proxy ACD](https://github.com/ATIX-AG/smart_proxy_acd), too. 
+See the [installation](https://theforeman.org/plugins/#2.Installation) chapter of the Foreman plugins documentation on how to install Foreman plugins.
 
 ### TL;DR: 
 
-    yum install tfm-rubygem-foreman_acd tfm-rubygem-smart_proxy_acd tfm-rubygem-smart_proxy_acd_core
+    yum install tfm-rubygem-foreman_acd
     foreman-maintain service restart
 
-In some cases you need to do manally
+In some cases, you need to manually run
 
     foreman-rake db:migrate
     foreman-rake db:seed
 
-### Hints
+### Smart Proxy Installation
+
+You will need to install [Smart Proxy ACD](https://github.com/ATIX-AG/smart_proxy_acd), too. 
+
+    yum install tfm-rubygem-smart_proxy_acd tfm-rubygem-smart_proxy_acd_core
+    foreman-maintain service restart
+
+You need to refresh the smart proxy features in *Infrastructure > Smart Proxies > Your Smart-Proxy > Actions > Refresh* after the installation of the Smart Proxy ACD components.
 
-Katello plugin need to exist, too.
+### Tips
+
+* Make sure you have the [Katello](https://theforeman.org/plugins/katello/) plugin installed.
+* Make sure the Job Template `Run ACD Ansible Playbook - ACD Default` is part of your organization/location context.
 
 ## Usage
 
 ### Ansible Playbook
 
-* Copy (or checkout a git repository) to e.g. /opt/ansible-playbook
-* Add a new Ansible Playbook via Configure -> Ansible Playbook
-* Set the path to /opt/ansible-playbook and name the playbook file. (e.g. site.yml)
-* Save it and press "Import group variables" for this newly created ansible playbook.
+* Copy (or checkout a git repository) an Ansible playbook.
+Store it in `/etc/foreman/plugins/foreman_acd/ansible-playbooks/` so that SELinux is able to read it.
+* Add a new Ansible Playbook via *Applications > Ansible Playbooks*.
+* Specify the path to the Ansible playbook and name of the playbook file. (e.g. `site.yml`).
+* Save it and press *Import group variables* for this newly created Ansible playbook.
 
-### Application Definition (Admin)
+### Application Definition (for Admins)
 
-* Create an Application Definition (Configure -> Application Definition) first
+* Create an Application Definition via *Applications > Application Definitions*.
 * Select the Ansible Playbook you want to use. 
-* Add new services and specifiy the host group you want to use.
-* Specifiy the values, a user could overwrite.
-  (you can set a default value, if you want)
-
-### Application Instance (User)
+* Add new services and specify the host group you want to use.
+* Specify any values a user will be allowed to overwrite.
+You may also set a default value.
 
-* Create an Application Instance (Configure -> Application Instance) 
-* Select the Application Definition which should be used
-* Set the values.
-  Remember, all parameters need to have a value. 
-* Save the Application Instance
+### Application Instance (for Users)
 
-### Deploy & Configure the Application Instance (User)
+* Create an Application Instance via *Applications > Application Instances*.
+* Select the Application Definition you want to use.
+* Overwrite desired values.
+All Foreman parameters require a value.
+* Save the Application Instance.
 
-* To Deploy the host, select "Deploy" in the action selection dropdown field
-  on the Application Instance index site.
-* See if the hosts are deployed via action selection dropdown -> report.
-* After all hosts are deployed, run the ansible playbook via 
-  action selection dropdown -> Run ansible playbook
+### Deploy and Configure the Application Instance (for Users)
 
+* Select *Deploy* in the action drop down menu via *Applications > Application Instance* to deploy a host.
+* Verify if the hosts are deployed via the *Report* button from the action drop down menu.
+* Run the Ansible playbook via *Run Ansible playbook* from the action drop down menu after all hosts are deployed.
 
 ## TODO
 
-- "git" support for the ansible playbooks
-- Provide application templates which contains application definition and 
-  the required ansible-playbook.
-- Add saltstack support to configure the application
-- Automatically run the ansible playbook after all hosts are deployed
-- More parameter / value validation
-
+* Add `git` support for the Ansible playbooks.
+* Provide application templates which contains application definition and the required Ansible-playbook.
+* Add Saltstack support to configure the application.
+* Extend the Foreman parameter and value validation.
 
 ## Contributing
 
-Fork and send a Pull Request. Thanks!
+Fork and send a Pull Request.
+Thanks!
 
 ## Copyright
 
 Copyright (c) 2021 ATIX AG 
 
-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 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.
+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/>.
+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_acd/ansible_playbooks_controller.rb

@@ -19,14 +19,14 @@ module ForemanAcd
     def create
       @ansible_playbook = AnsiblePlaybook.new(ansible_playbook_params)
       if @ansible_playbook.save
-        process_success
+        process_success :success_msg => _("Successfully created %s. You need to press the \"Import groups\" button
+                                           before this ansible playbook can be used in App Definitions!") % @ansible_playbook
       else
         process_error
       end
     end
 
-    def edit
-    end
+    def edit; end
 
     def update
       if @ansible_playbook.update(ansible_playbook_params)
@@ -48,6 +48,8 @@ module ForemanAcd
       case params[:action]
       when 'import_vars'
         :import_vars
+      when 'grab'
+        :grab
       else
         super
       end
@@ -87,15 +89,15 @@ module ForemanAcd
         # We need to support: group_vars/group_file and group_vars/group_dir/yaml_files
         dir_and_file = File.split(vars_file)
 
-        if File.basename(dir_and_file[0]) == 'group_vars' # in case of group_vars/group_file
-          group_name = File.basename(dir_and_file[1], '.*')
-        else # in case of group_vars/group_dir/yaml_files
-          group_name = File.basename(dir_and_file[0])
-        end
+        group_name = if File.basename(dir_and_file[0]) == 'group_vars' # in case of group_vars/group_file
+                       File.basename(dir_and_file[1], '.*')
+                     else # in case of group_vars/group_dir/yaml_files
+                       File.basename(dir_and_file[0])
+                     end
 
         logger.debug("Add ansible vars from file #{vars_file} to group #{group_name}")
 
-        if vars.has_key?(group_name)
+        if vars.key?(group_name)
           vars[group_name].merge!(loaded_yaml)
         else
           vars[group_name] = loaded_yaml
@@ -104,7 +106,7 @@ module ForemanAcd
 
       errors << "No ansible group variable in #{playbook_path} defined." if everything_empty
 
-      return vars, errors
+      [vars, errors]
     end
 
     def import_vars
@@ -113,7 +115,7 @@ module ForemanAcd
       @ansible_playbook.vars = vars.to_json
       @ansible_playbook.save
       if errors.empty?
-        process_success :success_msg => _("Successfully loaded ansible group variables from %s") % @ansible_playbook.name, :redirect => ansible_playbooks_path
+        process_success :success_msg => _('Successfully loaded ansible group variables from %s') % @ansible_playbook.name, :redirect => ansible_playbooks_path
       else
         process_error :error_msg => _(errors.join(' ')), :redirect => ansible_playbooks_path
       end

data/app/controllers/foreman_acd/api/v2/ansible_playbooks_controller.rb

@@ -26,6 +26,7 @@ module ForemanAcd
         def_param_group :ansible_playbook do
           param :ansible_playbook, Hash, :required => true, :action_aware => true do
             param :name, String, :required => true
+            param_group :taxonomies, ::Api::V2::BaseController
             param :description, String, :required => true
             param :services, String, :required => true
           end
@@ -49,8 +50,8 @@ module ForemanAcd
         def grab
           ap = resource_class.find(params['id'])
           command = "tar cz -C #{ap.path} --exclude \".git\" . 2>/dev/null | base64"
-          result = %x<#{command}>
-          send_data result, type: "text/plain", disposition: 'inline'
+          result = `#{command}`
+          send_data result, :type => 'text/plain', :disposition => 'inline'
         end
 
         def action_permission
@@ -58,7 +59,7 @@ module ForemanAcd
           when 'grab'
             'grab'
           else
-           super
+            super
           end
         end
 

data/app/controllers/foreman_acd/api/v2/app_definitions_controller.rb

@@ -23,6 +23,7 @@ module ForemanAcd
         def_param_group :app_definition do
           param :app_definition, Hash, :required => true, :action_aware => true do
             param :name, String, :required => true
+            param_group :taxonomies, ::Api::V2::BaseController
             param :description, String, :required => true
             param :services, String, :required => true
           end

data/app/controllers/foreman_acd/api/v2/app_instances_controller.rb

@@ -11,18 +11,26 @@ module ForemanAcd
 
         api :GET, '/app_instances/:id', N_('Show application instance')
         param :id, :identifier, :required => true
+        param :organization_id, :identifier, :required => true
+        param :location_id, :identifier, :required => true
         def show; end
 
         api :GET, '/app_instances', N_('List application instances')
+        param :organization_id, :identifier, :required => true
+        param :location_id, :identifier, :required => true
         param_group :search_and_pagination, ::Api::V2::BaseController
         add_scoped_search_description_for(AppInstance)
         def index
-          @app_instances = resource_scope_for_index
+          scope = resource_scope_for_index.where(:organization => params[:organization_id]) if params[:organization_id].present?
+          scope = scope.where(:location => params[:location_id]) if params[:location_id].present?
+          @app_instances = scope
         end
 
         def_param_group :app_instance do
           param :app_instance, Hash, :required => true, :action_aware => true do
             param :name, String, :required => true
+            param :organization_id, :identifier, :required => true
+            param :location_id, :identifier, :required => true
             param :description, String, :required => true
             param :services, String, :required => true
           end

data/app/controllers/foreman_acd/app_definitions_controller.rb

@@ -17,7 +17,7 @@ module ForemanAcd
 
     def read_ansible_playbooks
       # Only use ansible playbooks for which the user pressed import group vars once.
-      @ansible_playbooks = AnsiblePlaybook.where.not(vars: nil).map { |elem| { elem.id => elem.name } }.reduce({}) { |h, v| h.merge v }
+      @ansible_playbooks = AnsiblePlaybook.where.not(:vars => nil).map { |elem| { elem.id => elem.name } }.reduce({}) { |h, v| h.merge v }
     end
 
     def read_hostgroups
@@ -30,18 +30,21 @@ module ForemanAcd
 
     def create
       @app_definition = AppDefinition.new(app_definition_params)
-      if @app_definition.save
-        process_success
-      else
-        process_error
+      begin
+        if @app_definition.save!
+          process_success
+        else
+          process_error
+        end
+      rescue StandardError, ValidationError => e
+        redirect_to new_app_definition_path, :flash => { :error => _(e.message) }
       end
     end
 
-    def edit
-    end
+    def edit; end
 
     def update
-      if @app_definition.update_attributes(app_definition_params)
+      if @app_definition.update(app_definition_params)
         process_success
       else
         process_error
@@ -60,6 +63,8 @@ module ForemanAcd
       case params[:action]
       when 'export'
         :export
+      when 'import'
+        :import
       else
         super
       end
@@ -78,7 +83,7 @@ module ForemanAcd
     private
 
     def handle_file_upload
-      return unless params[:foreman_acd_app_definition] && raw_file = params[:foreman_acd_app_definition][:app_definition_file]
+      return unless params[:foreman_acd_app_definition] && (raw_file = params[:foreman_acd_app_definition][:app_definition_file])
       params[:foreman_acd_app_definition][:services] = YAML.load_file(raw_file.tempfile).to_json
     end
   end

data/app/controllers/foreman_acd/app_instances_controller.rb

@@ -6,40 +6,53 @@ module ForemanAcd
     include Foreman::Controller::AutoCompleteSearch
     include ::ForemanAcd::Concerns::AppInstanceParameters
 
-    before_action :find_resource, :only => [:edit, :update, :destroy, :deploy, :report]
+    before_action :find_resource, :only => [:edit, :update, :destroy_with_hosts, :deploy, :report]
     before_action :read_applications, :only => [:new, :edit]
+    before_action :find_taxonomy
+    helper_method :collect_hosts_data
 
     def index
-      @app_instances = resource_base.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page])
+      @app_instances = resource_base.where(:organization => @organization).
+                       where(:location => @location).
+                       search_for(params[:search], :order => params[:order]).paginate(:page => params[:page])
     end
 
     def new
       @app_instance = AppInstance.new
+      @app_instance.organization = @organization
+      @app_instance.location = @location
     end
 
     def create
       @app_instance = AppInstance.new(app_instance_params)
-      if @app_instance.save
-        process_success
-      else
-        process_error
+      begin
+        if @app_instance.save!
+          app_instance_has_foreman_hosts
+          process_success
+        else
+          process_error
+        end
+      rescue StandardError, ValidationError => e
+        redirect_to new_app_instance_path, :flash => { :error => _(e.message) }
       end
     end
 
-    def edit
-    end
+    def edit; end
 
     def update
       if @app_instance.update(app_instance_params)
+        app_instance_has_foreman_hosts
         process_success
       else
         process_error
       end
     end
 
-    def destroy
+    def destroy_with_hosts
+      @app_instance = AppInstance.find(params[:id])
+      @app_instance.clean_hosts_by_id(params[:foreman_host_ids]) if params[:foreman_host_ids]
       if @app_instance.destroy
-        process_success
+        redirect_to app_instances_path, :flash => { :success => _('Successfully deleted %s') % @app_instance }
       else
         process_error
       end
@@ -51,40 +64,99 @@ module ForemanAcd
         :deploy
       when 'report'
         :report
+      when 'destroy_with_hosts'
+        :destroy
       else
         super
       end
     end
 
     def deploy
-      app_deployer = ForemanAcd::AppDeployer.new(@app_instance)
-      app_hosts = app_deployer.deploy
-
-      # save any change to the app_hosts json
-      @app_instance.hosts = app_hosts.to_json
-      @app_instance.save
-
-      @deploy_hosts = collect_host_report_data(app_hosts)
+      @app_instance.clean_all_hosts if params[:delete_hosts]
+
+      logger.info('Run async foreman task to deploy hosts')
+      async_task = ForemanTasks.async_task(::Actions::ForemanAcd::DeployAllHosts, @app_instance)
+      @app_instance.update!(:last_deploy_task => async_task)
+      process_success(:success_msg => _('Started task to deploy hosts for %s') % @app_instance)
+    rescue StandardError => e
+      error_msg = "Error happend while deploying hosts of #{@app_instance}: #{e.message}"
+      logger.error("#{error_msg} - #{e.class}\n#{e.backtrace.join($INPUT_RECORD_SEPARATOR)}")
+      process_error :error_msg => error_msg
     end
 
     def report
-      app_hosts = JSON.parse(@app_instance.hosts)
-      @report_hosts = collect_host_report_data(app_hosts)
+      @report_hosts = collect_host_report_data
+      logger.debug("app instance host details: #{@report_hosts.inspect}")
+    end
 
-      logger.debug("deploy report hosts are: #{@report_hosts.inspect}")
+    def app_instance_has_foreman_hosts
+      hosts = JSON.parse(@app_instance.hosts)
+      hosts.each do |h|
+        if @app_instance.foreman_hosts.where(:hostname => h['hostname']).exists?
+          @app_instance.foreman_hosts.where(:hostname => h['hostname']).
+            update(:service => h['service'], :description => h['description'],
+                   :foremanParameters => JSON.dump(h['foremanParameters']), :ansibleParameters => JSON.dump(h['ansibleParameters']))
+        else
+          @app_instance.foreman_hosts.create(:hostname => h['hostname'], :service => h['service'], :description => h['description'],
+                                             :foremanParameters => JSON.dump(h['foremanParameters']), :ansibleParameters => JSON.dump(h['ansibleParameters']))
+        end
+      end
+
+      # Delete record if json hosts are deleted
+      deleted_json_hosts = @app_instance.foreman_hosts.pluck('hostname') - hosts.pluck('hostname')
+      @app_instance.foreman_hosts.where(:hostname => deleted_json_hosts).destroy_all if deleted_json_hosts
+    end
+
+    def collect_hosts_data
+      hosts_data = []
+      @app_instance.foreman_hosts.each do |h|
+        hosts_data << {
+          :id => h.id,
+          :hostname => h.hostname,
+          :service => h.service,
+          :description => h.description,
+          :foremanParameters => JSON.parse(h.foremanParameters),
+          :ansibleParameters => JSON.parse(h.ansibleParameters)
+        }
+      end
+      hosts_data
     end
 
     private
 
+    def find_taxonomy
+      @organization = Organization.current
+      redirect_to '/select_organization?toState=' + request.path and return unless @organization
+
+      @location = Location.current
+      redirect_to root_path, :error => 'Select a location to show App Instances' and return unless @location
+    end
+
     def read_applications
       @applications = AppDefinition.all.map { |elem| { elem.id => elem.name } }.reduce({}) { |h, v| h.merge v }
     end
 
-    def collect_host_report_data(app_hosts)
+    def collect_host_report_data
       report_data = []
-      app_hosts.each do |host_data|
-        host = Host.find(host_data['foreman_host_id'])
-        report_data << { id: host.id, name: host_data['hostname'], hostname: host.hostname, hostUrl: host_path(host), progress_report_id: host.progress_report_id}
+
+      @app_instance.foreman_hosts.each do |foreman_host|
+        a_host = {
+          :id => nil,
+          :name => foreman_host.hostname,
+          :build => nil,
+          :hostUrl => nil,
+          :progress_report => foreman_host.last_progress_report.empty? ? [] : JSON.parse(foreman_host.last_progress_report)
+        }
+
+        if foreman_host.host.present?
+          a_host.update({
+                          :id => foreman_host.host.id,
+                          :build => foreman_host.host.build,
+                          :hostUrl => host_path(foreman_host.host),
+                          :powerStatusUrl => power_api_host_path(foreman_host.host)
+                        })
+        end
+        report_data << a_host
       end
       report_data
     end