foreman_acd 0.2.1 → 0.3.0

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

@@ -0,0 +1,3 @@
+<% title(_('Edit Ansible Playbook %s') % @ansible_playbook) %>
+
+<%= render :partial => 'form' %>

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

@@ -0,0 +1,30 @@
+<% title _('Ansible Playbooks') %>
+
+<% title_actions button_group(
+  new_link(_('New Ansible Playbook')),
+) %>
+
+<table class="table table-bordered table-striped">
+  <tr>
+    <th><%= sort :name, :as => s_('AnsiblePlaybook|Name') %></th>
+    <th><%= _('Description') %></th>
+    <th></th>
+  </tr>
+  <% for ansible_playbook in @ansible_playbooks %>
+    <tr>
+      <td><%=link_to_if_authorized h(ansible_playbook.name), hash_for_edit_ansible_playbook_path(:id => ansible_playbook).merge(:auth_object => ansible_playbook, :authorizer => authorizer) %></td>
+      <td><%= ansible_playbook.description %></td>
+      <td>
+        <%= action_buttons(
+          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))
+        ) %>
+      </td>
+    </tr>
+  <% end %>
+</table>
+
+<%= page_entries_info @ansible_playbooks %>
+<%= will_paginate @ansible_playbooks %>
+

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

@@ -0,0 +1,3 @@
+<% title _('New Ansible Playbook') %>
+
+<%= render :partial => 'form' %>

data/app/views/foreman_acd/api/v2/ansible_playbooks/base.json.rabl

@@ -0,0 +1,3 @@
+object @ansible_playbook
+
+attributes :id, :name

data/app/views/foreman_acd/api/v2/ansible_playbooks/index.json.rabl

@@ -0,0 +1,3 @@
+collection @ansible_playbooks
+
+extends 'foreman_acd/api/v2/ansible_playbooks/base'

data/app/views/foreman_acd/api/v2/ansible_playbooks/show.json.rabl

@@ -0,0 +1,3 @@
+object @ansible_playbook
+
+extends 'foreman_acd/api/v2/ansible_playbooks/base'

data/app/views/foreman_acd/api/v2/app_definitions/base.json.rabl

@@ -0,0 +1,3 @@
+object @app_definition
+
+attributes :id, :name

data/app/views/foreman_acd/api/v2/app_definitions/index.json.rabl

@@ -0,0 +1,3 @@
+collection @app_definitions
+
+extends 'foreman_acd/api/v2/app_definitions/base'

data/app/views/foreman_acd/api/v2/app_definitions/show.json.rabl

@@ -0,0 +1,3 @@
+object @app_definition
+
+extends 'foreman_acd/api/v2/app_definitions/base'

data/app/views/foreman_acd/api/v2/app_instances/base.json.rabl

@@ -0,0 +1,3 @@
+object @app_instance
+
+attributes :id, :name

data/app/views/foreman_acd/api/v2/app_instances/index.json.rabl

@@ -0,0 +1,3 @@
+collection @app_instances
+
+extends 'foreman_acd/api/v2/app_instances/base'

data/app/views/foreman_acd/api/v2/app_instances/show.json.rabl

@@ -0,0 +1,3 @@
+object @app_instance
+
+extends 'foreman_acd/api/v2/app_instances/base'

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

@@ -1,15 +1,29 @@
 <%
-    json = {
-      "organization": current_organization,
-      "location": current_location,
-      "hostgroups": @hostgroups,
-      "loadForemanDataUrl": ui_acd_fdata_path("__id__"),
-      "services": [],
-    }
+  json = {
+    "organization": current_organization,
+    "location": current_location,
+    "hostgroups": @hostgroups,
+    "foremanDataUrl": ui_acd_foreman_data_path("__id__"),
+    "ansibleDataUrl": ui_acd_ansible_data_path("__id__"),
+    "services": [],
+    "ansibleVarsAll": [],
+  }
 
-    if !@app_definition.name.empty?
-      json["services"] = JSON.parse(@app_definition.services)
-    end
+  if @app_definition.new_record?
+    json["mode"] = "newDefinition"
+    json["ansiblePlaybooks"] = @ansible_playbooks
+  else
+    json["mode"] = "editDefinition"
+    json["ansiblePlaybook"] = @app_definition.ansible_playbook.as_unified_structobj
+  end
+
+  if @app_definition.services.present?
+    json["services"] = JSON.parse(@app_definition.services)
+  end
+
+  if @app_definition.ansible_vars_all.present?
+    json["ansibleVarsAll"] = JSON.parse(@app_definition.ansible_vars_all)
+  end
 %>
 
 <%= form_for @app_definition, :url => (@app_definition.new_record? ? app_definitions_path : app_definition_path(:id => @app_definition.id)) do |f| %>

data/app/views/foreman_acd/app_definitions/edit.html.erb

@@ -1,5 +1,10 @@
 <% title(_('Edit Application Definition %s') % @app_definition) %>
 
+<%= breadcrumbs(
+  :resource_url => acd_api_v2_app_definitions_path
+  )
+%>
+
 <% content_for(:javascripts) do %>
   <%= webpacked_plugins_js_for :foreman_acd %>
 <% end %>

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

@@ -1,25 +1,27 @@
 <%
-    if @app_instance.app_definition_id.blank?
+    if @app_instance.new_record?
       json = {
         "mode": "newInstance",
         "organization": current_organization,
         "location": current_location,
         "applications": @applications,
-        "loadAppDefinitionUrl": ui_acd_app_path("__id__"),
-        "loadForemanDataUrl": ui_acd_fdata_path("__id__"),
+        "appDefinitionUrl": ui_acd_app_path("__id__"),
+        "foremanDataUrl": ui_acd_foreman_data_path("__id__"),
+        "ansibleVarsAll": [],
       }
     else
       json = {
         "mode": "editInstance",
         "organization": current_organization,
         "location": current_location,
-        "loadAppDefinitionUrl": ui_acd_app_path("__id__"),
-        "loadForemanDataUrl": ui_acd_fdata_path("__id__"),
+        "appDefinitionUrl": ui_acd_app_path("__id__"),
+        "foremanDataUrl": ui_acd_foreman_data_path("__id__"),
         "appDefinition": {
           "id": @app_instance.app_definition.id,
           "name": @app_instance.app_definition.name,
         },
         "hosts": JSON.parse(@app_instance.hosts),
+        "ansibleVarsAll": @app_instance.ansible_vars_all.blank? ? [] : JSON.parse(@app_instance.ansible_vars_all),
       }
     end
 %>

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

@@ -17,10 +17,14 @@
       <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,
+                                                        :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,
+                                                        :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}")),
                            display_delete_if_authorized(hash_for_app_instance_path(:id => app_instance).merge(:auth_object => app_instance, :authorizer => authorizer),
-                                                          :data => { 'confirm': _('Delete %s?') % app_instance.name })) %>
+                                                        :data => { 'confirm': _('Delete %s?') % app_instance.name })) %>
       </td>
     </tr>
   <% end %>

data/app/views/templates/job/run_acd_ansible_playbook.erb

@@ -0,0 +1,49 @@
+<%#
+kind: job_template
+name: Run ACD Ansible Playbook - SSH Default
+model: JobTemplate
+job_category: Application Centric Deployment
+description_format: "Run Ansible playbook %{playbook_name} for ACD application %{application_name}"
+provider_type: SSH
+feature: run_acd_ansible_playbook
+template_inputs:
+- name: application_name
+  description: The name of the ACD application instance to run
+  input_type: user
+  required: true
+  advanced: false
+- name: playbook_name
+  description: The name of the Ansible playbook to run
+  input_type: user
+  required: true
+  advanced: false
+- name: playbook_path
+  description: The full path to the Ansible playbook
+  input_type: user
+  required: true
+  advanced: false
+- name: inventory
+  description: The Ansible inventory
+  input_type: user
+  required: true
+  advanced: false
+- name: extra_vars
+  description: Set ansible-playbook extra vars
+  input_type: user
+  required: false
+  advanced: true
+- name: verbose
+  description: Whether to run the ansible-playbook in verbose mode or not.
+  input_type: user
+  options: "false\ntrue"
+  required: false
+  advanced: true
+%>
+
+INVENTORY_FILE=$(mktemp --suffix ".yaml")
+cat << EOF >$INVENTORY_FILE
+<%= input('inventory') %>
+EOF
+
+echo "Run ansible-playbook <%= input('playbook_name') %> to configure ACD app <%= input('application_name') %>"
+ansible-playbook -i $INVENTORY_FILE <%= "-v" if input('verbose').present? && input('verbose') == 'true' %> <%= "--extra-vars \"#{input('extra_vars')}\"" unless input('extra_vars').blank? %> <%= input('playbook_path') %>

data/app/views/ui_acd/ansible_data.json.rabl

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+object @ansible_data
+attribute :id
+attribute :name
+attribute :groups

data/app/views/ui_acd/app.json.rabl

@@ -4,6 +4,10 @@ child @app_data['app_definition'] => :app_definition do
   extends 'ui_acd/app_definition'
 end
 
-child @app_data['fdata'] => :fdata do
-  extends 'ui_acd/fdata'
+child @app_data['foreman_data'] => :foreman_data do
+  extends 'ui_acd/foreman_data'
+end
+
+child @app_data['ansible_data'] => :ansible_data do
+  extends 'ui_acd/ansible_data'
 end

data/app/views/ui_acd/app_definition.json.rabl

@@ -2,4 +2,4 @@
 
 object @app_definition
 
-attributes :id, :name, :description, :services, :created_at, :updated_at
+attributes :id, :name, :description, :services, :ansible_vars_all, :created_at, :updated_at

data/app/views/ui_acd/{fdata.json.rabl → foreman_data.json.rabl}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-object @fdata
+object @foreman_data
 attribute :hostgroup_id
 
 child :environments => :environments do

data/config/routes.rb

@@ -2,6 +2,16 @@
 
 Rails.application.routes.draw do
   scope :acd, :path => '/acd' do
+    resources :ansible_playbooks, :controller => 'foreman_acd/ansible_playbooks' do
+      collection do
+        get 'auto_complete_search'
+      end
+
+      member do
+        get 'import_vars'
+      end
+
+    end
     resources :app_definitions, :controller => 'foreman_acd/app_definitions' do
       collection do
         get 'auto_complete_search'
@@ -21,11 +31,24 @@ Rails.application.routes.draw do
 
       member do
         post 'deploy'
+        post 'configure'
         get 'report'
       end
     end
 
     get 'ui_acd_app/:id', :to => 'ui_acd#app', :constraints => { :id => /[\w\.-]+/ }, :as => :ui_acd_app
-    get 'ui_acd_fdata/:id', :to => 'ui_acd#fdata', :constraints => { :id => /[\w\.-]+/ }, :as => :ui_acd_fdata
+    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
+
+    scope :api, :path => '/api', :defaults => { :format => 'json' } do
+      scope '(:apiv)', :defaults => { :apiv => 'v2' },
+                       :apiv => /v1|v2/, :constraints => ApiConstraints.new(:version => 2) do
+        constraints(:id => /[\w\.-]+/) do
+          resources :app_definitions, :only => [:show, :index], :controller => 'foreman_acd/api/v2/app_definitions', :as => :acd_api_v2_app_definitions
+          resources :app_instances, :only => [:show, :index], :controller => 'foreman_acd/api/v2/app_instances', :as => :api_v2_foreman_acd_app_instances
+          resources :ansible_playbooks, :only => [:show, :index], :controller => 'foreman_acd/api/v2/ansible_playbooks', :as => :api_v2_foreman_acd_ansible_playbooks
+        end
+      end
+    end
   end
 end

data/db/migrate/20200916091018_create_ansible_playbooks.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Adding acd ansible playbooks db table
+class CreateAnsiblePlaybooks < ActiveRecord::Migration[5.2]
+  def up
+    create_table :acd_ansible_playbooks do |t|
+      t.string :name, :default => '', :null => false, :limit => 255, :unique => true
+      t.text :description
+      t.string :scm_type
+      t.string :path
+      t.string :playfile
+      t.text :vars
+      t.timestamps :null => true
+    end
+  end
+
+  def down
+    drop_table :acd_ansible_playbooks
+  end
+end

data/db/migrate/20200917120220_add_ansible_playbook_id.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Adding acd ansible playbooks db table
+class AddAnsiblePlaybookId < ActiveRecord::Migration[5.2]
+  def up
+    add_column :app_definitions, :acd_ansible_playbook_id, :integer
+    add_foreign_key "app_definitions", "acd_ansible_playbooks", :name => "app_definitions_acd_ansible_playbooks_id_fk"
+  end
+
+  def down
+    remove_foreign_key 'app_definitions', :name => 'app_definitions_acd_ansible_playbooks_id_fk'
+    remove_column :app_definitions, :acd_ansible_playbook_id
+  end
+end

data/db/migrate/20201016002819_add_ansible_vars_all_to_app_definitions.rb

@@ -0,0 +1,5 @@
+class AddAnsibleVarsAllToAppDefinitions < ActiveRecord::Migration[5.2]
+  def change
+    add_column :app_definitions, :ansible_vars_all, :text
+  end
+end

data/db/migrate/20201016104338_add_ansible_vars_all_to_app_instances.rb

@@ -0,0 +1,5 @@
+class AddAnsibleVarsAllToAppInstances < ActiveRecord::Migration[5.2]
+  def change
+    add_column :app_instances, :ansible_vars_all, :text
+  end
+end

data/db/seeds.d/75-job_templates.rb

@@ -0,0 +1,8 @@
+User.as_anonymous_admin do
+  JobTemplate.without_auditing do
+    Dir[File.join("#{ForemanAcd::Engine.root}/app/views/templates/**/*.erb")].each do |template|
+      sync = !Rails.env.test? && Setting[:remote_execution_sync_templates]
+      JobTemplate.import_raw!(File.read(template), :default => true, :locked => true, :update => sync)
+    end
+  end
+end

data/lib/foreman_acd/engine.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'foreman_remote_execution'
+
 module ForemanAcd
   # This engine connects ForemanAcd with Foreman core
   class Engine < ::Rails::Engine
@@ -12,6 +14,7 @@ module ForemanAcd
     config.autoload_paths += Dir["#{config.root}/app/overrides"]
     config.autoload_paths += Dir["#{config.root}/app/services"]
     config.autoload_paths += Dir["#{config.root}/app/lib"]
+    config.autoload_paths += Dir["#{config.root}/lib"]
 
     # Add any db migrations
     initializer 'foreman_acd.load_app_instance_data' do |app|

data/lib/foreman_acd/plugin.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 Foreman::Plugin.register :foreman_acd do
-  requires_foreman '>= 1.19'
+  requires_foreman '>= 2.1'
 
   apipie_documented_controllers ["#{ForemanAcd::Engine.root}/app/controllers/foreman_acd/api/v2/*.rb"]
 
   # Menus
   divider :top_menu, :parent => :configure_menu, :caption => 'Applications'
+  menu :top_menu, :ansible_playbooks,
+       :url_hash => { :controller => :'foreman_acd/ansible_playbooks', :action => :index },
+       :caption => 'Ansible Playbooks',
+       :parent => :configure_menu
+
   menu :top_menu, :app_definitions,
        :url_hash => { :controller => :'foreman_acd/app_definitions', :action => :index },
        :caption => 'App Definitions',
@@ -19,6 +24,31 @@ Foreman::Plugin.register :foreman_acd do
 
   # Add permissions
   security_block :foreman_acd do
+    permission :create_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:new, :create],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:create] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
+    permission :view_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:index, :show, :auto_complete_search],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:index, :show] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
+    permission :edit_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:update, :edit],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:update] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
+    permission :destroy_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:destroy],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:destroy] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
+    permission :import_vars_ansible_playbooks,
+               { :'foreman_acd/ansible_playbooks' => [:import_vars],
+                 :'foreman_acd/api/v2/ansible_playbooks' => [:import_vars] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
     permission :create_app_definitions,
                { :'foreman_acd/app_definitions' => [:new, :create],
                  :'foreman_acd/api/v2/app_definitions' => [:create] },
@@ -74,6 +104,11 @@ Foreman::Plugin.register :foreman_acd do
                  :'foreman_acd/api/v2/app_instances' => [:deploy] },
                :resource_type => 'ForemanAcd::AppInstance'
 
+    permission :configure_app_instances,
+               { :'foreman_acd/app_instances' => [:configure],
+                 :'foreman_acd/api/v2/app_instances' => [:configure] },
+               :resource_type => 'ForemanAcd::AppInstance'
+
     permission :report_app_instances,
                { :'foreman_acd/app_instances' => [:report],
                  :'foreman_acd/api/v2/app_instances' => [:report] },
@@ -81,9 +116,15 @@ Foreman::Plugin.register :foreman_acd do
   end
 
   # Manager Role
-  role 'Application Centric Deployment Manager', [:create_app_definitions,
+  role 'Application Centric Deployment Manager', [:create_ansible_playbooks,
+                                                  :view_ansible_playbooks,
+                                                  :edit_ansible_playbooks,
+                                                  :destroy_ansible_playbooks,
+                                                  :import_vars_ansible_playbooks,
+                                                  :create_app_definitions,
                                                   :view_app_definitions,
                                                   :edit_app_definitions,
+                                                  :destroy_app_definitions,
                                                   :export_app_definitions,
                                                   :import_app_definitions]
 
@@ -93,5 +134,15 @@ Foreman::Plugin.register :foreman_acd do
                                                :edit_app_instances,
                                                :destroy_app_instances,
                                                :deploy_app_instances,
+                                               :configure_app_instances,
                                                :report_app_instances]
+
+  RemoteExecutionFeature.register(
+    :run_acd_ansible_playbook,
+    N_('Run playbook for ACD'),
+    {
+      :description => N_('Run an Ansible playbook to configure ACD application'),
+      :provided_inputs => %w[application_name playbook_name playbook_path inventory_path]
+    }
+  )
 end