foreman_acd 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63b0fc4a685be137bfd8d72d166d0c157081dc4c2ad34cbde4ac7e75faed4e1a
-  data.tar.gz: 9484df12c6738faa15f1b6d76721992b74a5ae0a795bbe6fc1f20cb08d3e7edd
+  metadata.gz: 433f2c68da81192db3c98fc013ed2149490f2471e84d372db8241522a33b6630
+  data.tar.gz: aa46c833de3feb1cce0802de82dec78f1610331984e6df8df649fdadfffa2b2a
 SHA512:
-  metadata.gz: 18caaab55b04561db5addf6d8376d37a4d7b043ccf7bba5cc98bb3d4fbc4b163b1a72416a5cffae556fa08626377dfa94608a0946d7009fd34a89989e96e9679
-  data.tar.gz: 7f00242c823cf86a6a315885009d19ed05b8215fbfd3b2d973a819aad716dfe576fdc719b8d3b1ea3f5c869fed1eb4b3647aa264aedcca8c6a0dc24fc237085f
+  metadata.gz: 0accbf314dd5776a5b012507d97619be98beff2c11e523da4d27f69e9fdb1bf1d284c134dba6549719312a66ede8cb80c8a06e3851f01a14951b1752ef2e29e8
+  data.tar.gz: d003bc7a5de1c180b2e33ade4e85b2912776db564d59ff9d8eca4f9ccc00c38591fd061649df07bb89e76ad0b0ac5efe1c64dd506132148aaf087b758a18c078

data/README.md

@@ -4,67 +4,121 @@
 
 A plugin to bring an user self service portal and application centric deployment to Foreman.
 
+
 # Description
 
-The target of this plugin is, to deploy whole applications which include multiple hosts 
-and an Ansible Playbook / saltstack state to configure the application. 
+The target of this plugin is, to deploy whole applications which include multiple hosts and 
+configure them using an Ansible Playbook / saltstack state.
 
 This plugin follows the idea of different user types working together.
-The administrative user creates application definitions including multiple servers and
+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 instances with an easy to use self service portal. 
+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.
+*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.
 
 This plugin aims to setup all 6 hosts and to deploy the application.
 
+
 # Current State
-In the current state the plugin can be used to provide an easy to use self service user portal 
-to deploy new servers. 
+
+## Application Definition
+
+- 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.
+
+## Application Instance
+
+- 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
+
 
 # Road Map
-- Self service portal for single host deployments (current version)
-- Add application deployment with single host requirements 
-- Add application deployment with multi host requirements 
+- 
+- Add Application deployment with single host requirements 
+- Add Application deployment with multi host requirements 
 
 ## WARNING
 
 This plugin is in development. 
-In the current state, a self service portal to deploy single servers can be created.
 
 ## Installation
 
-See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
-for how to install Foreman plugins
+See [How_to_Install_a_Plugin](https://theforeman.org/plugins/#2.Installation)
+for how to install Foreman plugins. 
+
+### TL;DR: 
+
+    yum install tfm-rubygem-foreman_acd
+    foreman-maintain service restart --only foreman
+
+In some cases you need to do manally
+
+    foreman-rake db:migrate
+    foreman-rake db:seed
+
+### Hints
 
-ATM, Katello plugin need to exist, too.
+Katello plugin need to exist, too.
+
+### Configuration
+
+To get ansible playbooks running, you need to:
+
+    cat /var/lib/foreman-proxy/ssh/id_rsa_foreman_proxy.pub >> /root/.ssh/authorized_keys
+    
+Make sure, that the job template 'Run ACD Ansible Playbook - SSH Default' is part of your organization / location.     
 
 ## Usage
 
-Application Definition (Admin)
+### 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.
+
+### Application Definition (Admin)
+
 * Create an Application Definition (Configure -> Application Definition) first
-* Select the Hostgroup you want to use. 
+* 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)
-* Create an Application Instance (Configure -> Application Instrane) 
+### Application Instance (User)
+
+* 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
-* To Deploy the host, select "Deploy" in the Action selection dropdown field
-  on the Application Instance index site
+
+### Deploy & Configure the Application Instance (User)
+
+* 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
+
 
 ## TODO
 
-- Add ansible playbook / saltstack support to configure the application
-- Multi-host support
-- Add validation to the different parameter types
+- Add saltstack support to configure the application
+- "git" support for the ansible playbooks
+- Automatically run the ansible playbook after all hosts are deployed
+- More parameter / value validation
+- Deliver ansible playbooks to the connected foreman smart proxies
+
 
 ## Contributing
 
@@ -72,7 +126,7 @@ Fork and send a Pull Request. Thanks!
 
 ## Copyright
 
-Copyright (c) 2019 ATIX AG 
+Copyright (c) 2020 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
@@ -86,4 +140,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_acd/ansible_playbooks_controller.rb

@@ -86,11 +86,11 @@ module ForemanAcd
 
         # We need to support: group_vars/group_file and group_vars/group_dir/yaml_files
         dir_and_file = File.split(vars_file)
-        basename = File.basename(dir_and_file[0], '.*')
-        if basename == 'group_vars'
-          group_name = dir_and_file[1]
-        else
-          group_name = basename
+
+        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
 
         logger.debug("Add ansible vars from file #{vars_file} to group #{group_name}")

data/app/controllers/foreman_acd/app_definitions_controller.rb

@@ -16,7 +16,8 @@ module ForemanAcd
     end
 
     def read_ansible_playbooks
-      @ansible_playbooks = AnsiblePlaybook.all.map { |elem| { elem.id => elem.name } }.reduce({}) { |h, v| h.merge v }
+      # 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 }
     end
 
     def read_hostgroups

data/app/controllers/foreman_acd/app_instances_controller.rb

@@ -6,17 +6,13 @@ module ForemanAcd
     include Foreman::Controller::AutoCompleteSearch
     include ::ForemanAcd::Concerns::AppInstanceParameters
 
-    before_action :find_resource, :only => [:edit, :update, :destroy, :deploy, :report, :configure]
+    before_action :find_resource, :only => [:edit, :update, :destroy, :deploy, :report]
     before_action :read_applications, :only => [:new, :edit]
 
     def index
       @app_instances = resource_base.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page])
     end
 
-    def read_applications
-      @applications = AppDefinition.all.map { |elem| { elem.id => elem.name } }.reduce({}) { |h, v| h.merge v }
-    end
-
     def new
       @app_instance = AppInstance.new
     end
@@ -55,8 +51,6 @@ module ForemanAcd
         :deploy
       when 'report'
         :report
-      when 'configure'
-        :configure
       else
         super
       end
@@ -64,51 +58,35 @@ module ForemanAcd
 
     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_deployer.deploy.to_json
+      @app_instance.hosts = app_hosts.to_json
       @app_instance.save
 
-      @deploy_hosts = app_deployer.deploy_hosts
+      @deploy_hosts = collect_host_report_data(app_hosts)
     end
 
     def report
-      @report_hosts = []
       app_hosts = JSON.parse(@app_instance.hosts)
-      app_hosts.each do |host_data|
-        h = Host.find(host_data['foreman_host_id'])
-        @report_hosts.push({id: h.id, name: host_data['hostname'], hostname: h.hostname, hostUrl: host_path(h), powerStatusUrl: power_api_host_path(h) })
-      end
+      @report_hosts = collect_host_report_data(app_hosts)
 
       logger.debug("deploy report hosts are: #{@report_hosts.inspect}")
     end
 
-    def configure
-      app_configurator = ForemanAcd::AppConfigurator.new(@app_instance)
-      jobs = app_configurator.configure
-      job_count = jobs.count
-
-      customize_first = if params[:customize] == 'true'
-                          true
-                        else
-                          false
-                        end
-
-      logger.debug("Created #{job_count} to configure #{@app_instance} - customize: #{customize_first}")
-
-      if job_count == 1 && customize_first == false
-        jobs.first.trigger!
-        redirect_to job_invocation_path(jobs.first.job_invocation)
-      elsif customize_first == false
-        jobs.each do |composer|
-          composer.save
-        end
-        # redirect to the job itself if we want to customize the job
-        redirect_to job_invocations_path
-      else
-        # redirect to the job itself if we only have one job, otherwise to the index page
-        redirect_to job_invocations_path
+    private
+
+    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)
+      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}
       end
+      report_data
     end
   end
 end

data/app/controllers/foreman_acd/remote_execution_controller.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # Class to run remote execution jobs
+  class RemoteExecutionController < JobInvocationsController
+
+    def new
+      jobs = init_configuration
+      @composer = jobs.first
+    end
+
+    def create
+      customize_first = params[:customize] || false
+      jobs = init_configuration
+
+      if jobs.count == 1 && customize_first == false
+        @composer = jobs.first
+        @composer.trigger!
+        redirect_to job_invocation_path(@composer.job_invocation)
+      elsif customize_first == false
+        jobs.each do |composer|
+          composer.trigger
+        end
+        # redirect to the job itself if we want to customize the job
+        redirect_to job_invocations_path
+      else
+        @composer = jobs.first
+        render :action => 'new'
+      end
+    end
+
+    # to overcome the isolated namespace engine difficulties with paths
+    helper Rails.application.routes.url_helpers
+    def _routes
+      Rails.application.routes
+    end
+
+    private
+
+    def init_configuration
+      app_instance = ForemanAcd::AppInstance.find_by(:name => params[:id])
+      app_configurator = ForemanAcd::AppConfigurator.new(app_instance)
+
+      jobs = app_configurator.configure
+      logger.debug("Creating #{jobs.count} job(s) to configure the app #{app_instance}. Customize first: #{params[:customize]}")
+      return jobs
+    end
+  end
+end

data/app/models/foreman_acd/ansible_playbook.rb

@@ -8,7 +8,7 @@ module ForemanAcd
     friendly_id :name
 
     self.table_name = 'acd_ansible_playbooks'
-    has_many :app_definitions, :inverse_of => :ansible_playbook, :dependent => :destroy
+    has_many :app_definitions, :inverse_of => :ansible_playbook, :foreign_key => 'acd_ansible_playbook_id', dependent: :restrict_with_error
     validates :name, :presence => true, :uniqueness => true
     scoped_search :on => :name
     default_scope -> { order("acd_ansible_playbooks.name") }

data/app/services/foreman_acd/app_deployer.rb

@@ -5,11 +5,9 @@ module ForemanAcd
   class AppDeployer
 
     delegate :logger, :to => :Rails
-    attr_reader :deploy_hosts
 
     def initialize(app_instance)
       @app_instance = app_instance
-      @deploy_hosts = []
     end
 
     def deploy
@@ -44,7 +42,7 @@ module ForemanAcd
           end
 
           # REMOVE ME (but very nice for testing)
-          #host.mac = "00:11:22:33:44:55"
+          # host.mac = "00:11:22:33:44:55"
 
           apply_compute_profile(host)
           host.suggest_default_pxe_loader
@@ -52,8 +50,6 @@ module ForemanAcd
 
           # save the foreman host id
           host_data['foreman_host_id'] = host.id
-
-          @deploy_hosts.push({ id: host.id, name: host_data['hostname'], hostname: host.hostname, hostUrl: host_path(h), progress_report_id: host.progress_report_id})
         rescue StandardError => e
           logger.error("Failed to initiate host creation: #{e.class}: #{e.message}\n#{e.backtrace.join($INPUT_RECORD_SEPARATOR)}")
         end

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

@@ -16,9 +16,9 @@
       <td><%= ansible_playbook.description %></td>
       <td>
         <%= action_buttons(
+          display_link_if_authorized(_("Import group variables"), hash_for_import_vars_ansible_playbook_path(:id => ansible_playbook).merge(:auth_object => ansible_playbook, :authorizer => authorizer)),
           display_delete_if_authorized(hash_for_ansible_playbook_path(:id => ansible_playbook).merge(:auth_object => ansible_playbook, :authorizer => authorizer),
-                                       :data => { 'confirm': _('Delete %s?') % ansible_playbook.name }),
-          display_link_if_authorized(_("Import group variables"), hash_for_import_vars_ansible_playbook_path(:id => ansible_playbook).merge(:auth_object => ansible_playbook, :authorizer => authorizer))
+                                       :data => { 'confirm': _('Delete %s?') % ansible_playbook.name })
         ) %>
       </td>
     </tr>

data/app/views/foreman_acd/app_instances/index.html.erb

@@ -17,9 +17,9 @@
       <td>
         <%= action_buttons(display_link_if_authorized(_("Deploy"), hash_for_deploy_app_instance_path(:id => app_instance), :method => :post,
                                                         :title => _("Deploy application #{app_instance}")),
-                           display_link_if_authorized(_("Run Playbook"), hash_for_configure_app_instance_path(:id => app_instance), :method => :post,
+                           display_link_if_authorized(_("Run Playbook"), hash_for_remote_execution_path(:id => app_instance), :method => :post,
                                                         :title => _("Run ansible playbook for application #{app_instance}")),
-        display_link_if_authorized(_("Run Playbook - customize first"), hash_for_configure_app_instance_path(:id => app_instance, :customize => true), :method => :post,
+        display_link_if_authorized(_("Run Playbook - customize first"), hash_for_remote_execution_path(:id => app_instance, :customize => true), :method => :post,
                                                         :title => _("Prepare job to run ansible playbook for application #{app_instance}")),
                            display_link_if_authorized(_("Report"), hash_for_report_app_instance_path(:id => app_instance), :method => :get,
                                                         :title => _("Show last deployment report for application #{app_instance}")),

data/config/routes.rb

@@ -31,11 +31,12 @@ Rails.application.routes.draw do
 
       member do
         post 'deploy'
-        post 'configure'
         get 'report'
       end
     end
 
+    match '/remote_execution', :controller => 'foreman_acd/remote_execution', :action => 'create', :via => [:post]
+
     get 'ui_acd_app/:id', :to => 'ui_acd#app', :constraints => { :id => /[\w\.-]+/ }, :as => :ui_acd_app
     get 'ui_acd_foreman_data/:id', :to => 'ui_acd#foreman_data', :constraints => { :id => /[\w\.-]+/ }, :as => :ui_acd_foreman_data
     get 'ui_acd_ansible_data/:id', :to => 'ui_acd#ansible_data', :constraints => { :id => /[\w\.-]+/ }, :as => :ui_acd_ansible_data

data/lib/foreman_acd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanAcd
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/webpack/components/ApplicationDefinition/ApplicationDefinition.js

@@ -11,7 +11,8 @@ import Select from 'foremanReact/components/common/forms/Select';
 import ParameterSelection from '../ParameterSelection';
 import AddTableEntry from '../common/AddTableEntry';
 import DeleteTableEntry from '../common/DeleteTableEntry';
-import RailsData from '../common/RailsData'
+import RailsData from '../common/RailsData';
+import EasyHeaderFormatter from '../common/EasyHeaderFormatter';
 import AnsiblePlaybookSelector from './components/AnsiblePlaybookSelector';
 
 import {
@@ -118,8 +119,7 @@ class ApplicationDefinition extends React.Component {
     });
     this.inlineEditButtonsFormatter = inlineEditButtonsFormatter;
 
-    const headerFormatter = value => <Table.Heading>{value}</Table.Heading>;
-    this.headerFormatter = headerFormatter;
+    this.headerFormatter = EasyHeaderFormatter;
 
     const inlineEditFormatterImpl = {
       renderValue: (value, additionalData) => (

data/webpack/components/ApplicationDefinition/ApplicationDefinitionActions.js

@@ -55,7 +55,7 @@ export const initApplicationDefinition = (
         props: {
           index: 0,
           style: {
-            width: '20%'
+            width: '15%'
           }
         },
       },
@@ -71,7 +71,7 @@ export const initApplicationDefinition = (
         props: {
           index: 1,
           style: {
-            width: '20%'
+            width: '10%'
           }
         },
       },
@@ -151,7 +151,7 @@ export const initApplicationDefinition = (
         props: {
           index: 6,
           style: {
-            width: '20%'
+            width: '15%'
           }
         },
       },

data/webpack/components/ApplicationInstance/ApplicationInstance.js

@@ -10,7 +10,8 @@ import Select from 'foremanReact/components/common/forms/Select';
 import ParameterSelection from '../ParameterSelection';
 import AddTableEntry from '../common/AddTableEntry';
 import DeleteTableEntry from '../common/DeleteTableEntry';
-import RailsData from '../common/RailsData'
+import RailsData from '../common/RailsData';
+import EasyHeaderFormatter from '../common/EasyHeaderFormatter';
 import AppDefinitionSelector from './components/AppDefinitionSelector';
 import ServiceCounter from './components/ServiceCounter';
 import { arrayToObject } from '../../helper';
@@ -145,8 +146,7 @@ class ApplicationInstance extends React.Component {
     });
     this.inlineEditButtonsFormatter = inlineEditButtonsFormatter;
 
-    const headerFormatter = value => <Table.Heading>{value}</Table.Heading>;
-    this.headerFormatter = headerFormatter;
+    this.headerFormatter = EasyHeaderFormatter;
 
     const inlineEditFormatterImpl = {
       renderValue: (value, additionalData) => (

data/webpack/components/ApplicationInstance/ApplicationInstanceActions.js

@@ -50,7 +50,7 @@ export const initApplicationInstance = (
         props: {
           index: 0,
           style: {
-            width: '20%'
+            width: '30%'
           }
         },
       },
@@ -66,7 +66,7 @@ export const initApplicationInstance = (
         props: {
           index: 1,
           style: {
-            width: '20%'
+            width: '30%'
           }
         },
       },

data/webpack/components/ParameterSelection/ParameterSelectionActions.js

@@ -77,7 +77,7 @@ export const initParameterSelection = (
         props: {
           sort: true,
           style: {
-            width: '20%'
+            width: '25%'
           }
         },
         transforms: [sortableTransform],
@@ -96,7 +96,7 @@ export const initParameterSelection = (
         props: {
           sort: true,
           style: {
-            width: '20%'
+            width: '25%'
           }
         },
         transforms: [sortableTransform],
@@ -159,7 +159,7 @@ export const initParameterSelection = (
         label: 'Actions',
         props: {
           style: {
-            width: '20%'
+            width: '10%'
           }
         },
         formatters: [actionHeaderCellFormatter]

data/webpack/components/common/EasyHeaderFormatter.js

@@ -0,0 +1,18 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import {
+  Table,
+} from 'patternfly-react';
+
+const EasyHeaderFormatter = (value, { column }) => (
+  <Table.Heading aria-label={column.header.label} {...column.header.props}>
+  {value}
+  </Table.Heading>
+);
+
+EasyHeaderFormatter.propTypes = {
+  value: PropTypes.string.isRequired,
+  column: PropTypes.object.isRequired,
+};
+
+export default EasyHeaderFormatter;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_acd
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - ATIX AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-26 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -62,6 +62,7 @@ files:
 - app/controllers/foreman_acd/concerns/ansible_playbook_parameters.rb
 - app/controllers/foreman_acd/concerns/app_definition_parameters.rb
 - app/controllers/foreman_acd/concerns/app_instance_parameters.rb
+- app/controllers/foreman_acd/remote_execution_controller.rb
 - app/controllers/ui_acd_controller.rb
 - app/models/foreman_acd/ansible_playbook.rb
 - app/models/foreman_acd/app_definition.rb
@@ -175,6 +176,7 @@ files:
 - webpack/components/ParameterSelection/index.js
 - webpack/components/common/AddTableEntry.js
 - webpack/components/common/DeleteTableEntry.js
+- webpack/components/common/EasyHeaderFormatter.js
 - webpack/components/common/ExtSelect.js
 - webpack/components/common/RailsData.js
 - webpack/components/common/__tests__/AddTableEntry.test.js