foreman_acd 0.0.6 → 0.6.0

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

@@ -0,0 +1,22 @@
+<% title _("Provisioning details for application instance #{@app_instance}") %>
+
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_acd %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_acd %>
+<% end %>
+
+<%
+  json = {
+    "mode": 'lastReport',
+    "appInstanceName": @app_instance.name,
+    "hosts": @report_hosts,
+    "deployTaskUrl": foreman_tasks_task_path(@app_instance.last_deploy_task),
+    "configureJobUrl": job_invocations_path(search: "description ~ \"ACD application #{@app_instance.name}\"")
+  }
+%>
+
+<div id='report'></div>
+  <%=  mount_react_component('ApplicationInstanceReport', "#report", json.to_json) %>
+</div

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

@@ -0,0 +1,62 @@
+<%#
+kind: job_template
+name: Run ACD Ansible Playbook - ACD Default
+model: JobTemplate
+job_category: Application Centric Deployment
+description_format: "Run Ansible playbook %{playbook_name} for ACD application %{application_name}"
+feature: run_acd_ansible_playbook
+provider_type: ACD
+template_inputs:
+- name: application_name
+  description: The name of the ACD application instance to run
+  input_type: user
+  required: true
+  advanced: false
+- name: playbook_id
+  description: The id of the Ansible playbook to run
+  input_type: user
+  required: true
+  advanced: false
+- name: playbook_file
+  description: The playbook file of 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: "0 - Normal\n1 - Verbose\n2 - More Verbose\n3 - Debug\n4 - Connection Debug"
+  default: "0 - Normal"
+  required: false
+  advanced: true
+- name: tags
+  description: List of playbook tags to specify which tasks to execute.
+  input_type: user
+  required: false
+  advanced: true
+- name: skip_tags
+  description: List of playbook tags to skip certain tasks.
+  input_type: user
+  required: false
+  advanced: true
+%>
+
+application_name: <%= input('application_name') %>
+playbook_id: <%= input('playbook_id') %>
+playbook_file: <%= input('playbook_file') %>
+extra_vars: <%= input('extra_vars') %>
+verbose: <%= input('verbose') %>
+tags: <%= input('tags') %>
+skip_tags: <%= input('skip_tags') %>
+inventory: |
+<%=  indent(2) { input('inventory') } %>

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, :hostgroup_id, :parameters, :created_at, :updated_at
+attributes :id, :name, :description, :services, :ansible_vars_all, :location_ids, :organization_ids, :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,9 +2,23 @@
 
 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'
+        get 'import'
+      end
+
+      member do
+        get 'export'
       end
     end
 
@@ -15,10 +29,30 @@ Rails.application.routes.draw do
 
       member do
         post 'deploy'
+        get 'report'
+        delete 'destroy_with_hosts'
       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_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 do
+            member do
+              get 'grab'
+            end
+          end
+        end
+      end
+    end
   end
 end

data/db/migrate/20190610202252_create_app_definitions.rb

@@ -6,11 +6,9 @@ class CreateAppDefinitions < ActiveRecord::Migration[5.2]
     create_table :app_definitions do |t|
       t.string :name, :default => '', :null => false, :limit => 255, :unique => true
       t.text :description
-      t.column :hostgroup_id, :integer
-      t.text :parameters
+      t.text :services
       t.timestamps :null => true
     end
-    add_foreign_key :app_definitions, :hostgroups
   end
 
   def down

data/db/migrate/20190625140305_create_app_instances.rb

@@ -7,7 +7,7 @@ class CreateAppInstances < ActiveRecord::Migration[5.2]
       t.string :name, :default => '', :null => false, :limit => 255, :unique => true
       t.column :app_definition_id, :integer, :null => false
       t.text :description
-      t.text :parameters
+      t.text :hosts
       t.timestamps :null => true
     end
     add_foreign_key :app_instances, :app_definitions

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,8 @@
+# frozen_string_literal: true
+
+# Add ansible variables to app definitions
+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,8 @@
+# frozen_string_literal: true
+
+# Add ansible variables to app instances
+class AddAnsibleVarsAllToAppInstances < ActiveRecord::Migration[5.2]
+  def change
+    add_column :app_instances, :ansible_vars_all, :text
+  end
+end

data/db/migrate/20210112111548_add_organization_to_app_instance.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Add organization to app instance
+class AddOrganizationToAppInstance < ActiveRecord::Migration[6.0]
+  # FakeAppInstance, because of 'validates :location'
+  class AppInstance < ApplicationRecord
+    belongs_to :organization
+  end
+
+  def up
+    add_column :app_instances, :organization_id, :integer, :null => true, :index => true
+    AppInstance.all.each do |a|
+      a.organization = ::Organization.first
+      a.save!
+    end
+    change_column :app_instances, :organization_id, :integer, :null => false, :index => true
+  end
+
+  def down
+    remove_column :app_instances, :organization_id, :integer
+  end
+end

data/db/migrate/20210112113853_add_location_to_app_instance.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add location to app instance
+class AddLocationToAppInstance < ActiveRecord::Migration[6.0]
+  def change
+    add_column :app_instances, :location_id, :integer, :null => true, :index => true
+  end
+end

data/db/migrate/20210202141658_create_foreman_hosts.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Adding acd_foreman_hosts db table
+class CreateForemanHosts < ActiveRecord::Migration[6.0]
+  def up
+    create_table :foreman_hosts do |t|
+      t.string :hostname, :default => '', :null => false, :limit => 255, :unique => true
+      t.column :app_instance_id, :integer, :null => false
+      t.column :host_id, :integer
+      t.string :service
+      t.string :description
+      t.text :foremanParameters
+      t.text :ansibleParameters
+
+      t.timestamps :null => false
+    end
+    add_foreign_key :foreman_hosts, :app_instances
+    add_foreign_key :foreman_hosts, :hosts
+  end
+
+  def down
+    drop_table :foreman_hosts
+  end
+end

data/db/migrate/20210204111306_remove_hosts_from_app_instances.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Remove hosts column from app_instances db table
+class RemoveHostsFromAppInstances < ActiveRecord::Migration[6.0]
+  def change
+    remove_column :app_instances, :hosts, :text
+  end
+end

data/db/migrate/20210209091014_rename_acd_tables.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Adding Rename ACD db tables
+class RenameAcdTables < ActiveRecord::Migration[6.0]
+  def up
+    rename_table :app_definitions, :acd_app_definitions
+    rename_table :app_instances, :acd_app_instances
+    rename_table :foreman_hosts, :acd_foreman_hosts
+  end
+
+  def down
+    rename_table :acd_app_definitions
+    rename_table :acd_app_instances
+    rename_table :acd_foreman_hosts
+  end
+end

data/db/migrate/20210216083522_add_last_progress_report.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add AddLastProgressReport
+class AddLastProgressReport < ActiveRecord::Migration[5.2]
+  def change
+    add_column :acd_foreman_hosts, :last_progress_report, :text
+  end
+end

data/db/migrate/20210216091529_add_last_deploy_task.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add AddLastDeployTask
+class AddLastDeployTask < ActiveRecord::Migration[5.2]
+  def change
+    add_column :acd_app_instances, :last_deploy_task_id, :uuid, :null => true
+  end
+end

data/db/seeds.d/62_acd_proxy_feature.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+proxy_feature = Feature.where(:name => 'ACD').first_or_create
+raise "Unable to create proxy feature: #{format_errors proxy_feature}" if proxy_feature.nil? || proxy_feature.errors.any?

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+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]
+      template = JobTemplate.import_raw!(File.read(template), :default => true, :locked => true, :update => sync)
+
+      template.organizations << Organization.unscoped.all if template&.organizations&.empty?
+      template.locations << Location.unscoped.all if template&.locations&.empty?
+    end
+  end
+end

data/lib/foreman_acd/engine.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
+require 'foreman_remote_execution'
+
 module ForemanAcd
   # This engine connects ForemanAcd with Foreman core
   class Engine < ::Rails::Engine
     engine_name 'foreman_acd'
 
     config.autoload_paths += Dir["#{config.root}/app/controllers/foreman_acd/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models"]
+    config.autoload_paths += Dir["#{config.root}/app/services"]
     config.autoload_paths += Dir["#{config.root}/app/helpers"]
-    config.autoload_paths += Dir["#{config.root}/app/models/foreman_acd/concerns"]
-    config.autoload_paths += Dir["#{config.root}/app/models/parameters"]
     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|
@@ -39,5 +41,21 @@ module ForemanAcd
     initializer 'foreman_acd.register_plugin', :before => :finisher_hook do
       require 'foreman_acd/plugin'
     end
+
+    initializer 'foreman_acd.register_actions', :before => :finisher_hook do |_app|
+      ForemanTasks.dynflow.require!
+      action_paths = %W[#{ForemanAcd::Engine.root}/app/lib/actions]
+      ForemanTasks.dynflow.config.eager_load_paths.concat(action_paths)
+    end
+
+    config.to_prepare do
+      RemoteExecutionProvider.register(:ACD, AcdProvider)
+      ::Taxonomy.include ForemanAcd::TaxonomyExtensions
+      ::Host::Managed.prepend ForemanAcd::HostManagedExtensions
+    end
+
+    def self.with_katello?
+      defined?(::Katello)
+    end
   end
 end

data/lib/foreman_acd/plugin.rb

@@ -1,24 +1,56 @@
 # 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, :app_definitions,
-       :url_hash => { :controller => :'foreman_acd/app_definitions', :action => :index },
-       :caption => 'App Definitions',
-       :parent => :configure_menu
+  sub_menu :top_menu, :application, :caption => N_('Applications'), :after => :hosts_menu, :icon => 'pficon pficon-integration' do
+    menu :top_menu, :ansible_playbooks,
+         :url_hash => { :controller => :'foreman_acd/ansible_playbooks', :action => :index },
+         :caption => 'Ansible Playbooks'
 
-  menu :top_menu, :app_instances,
-       :url_hash => { :controller => :'foreman_acd/app_instances', :action => :index },
-       :caption => 'App Instances',
-       :parent => :configure_menu
+    menu :top_menu, :app_definitions,
+         :url_hash => { :controller => :'foreman_acd/app_definitions', :action => :index },
+         :caption => 'App Definitions'
+
+    menu :top_menu, :app_instances,
+         :url_hash => { :controller => :'foreman_acd/app_instances', :action => :index },
+         :caption => 'App Instances'
+  end
 
   # 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 :grab_ansible_playbooks,
+               { :'foreman_acd/api/v2/ansible_playbooks' => [:grab] },
+               :resource_type => 'ForemanAcd::AnsiblePlaybook'
+
     permission :create_app_definitions,
                { :'foreman_acd/app_definitions' => [:new, :create],
                  :'foreman_acd/api/v2/app_definitions' => [:create] },
@@ -39,6 +71,16 @@ Foreman::Plugin.register :foreman_acd do
                  :'foreman_acd/api/v2/app_definitions' => [:destroy] },
                :resource_type => 'ForemanAcd::AppDefinition'
 
+    permission :export_app_definitions,
+               { :'foreman_acd/app_definitions' => [:export],
+                 :'foreman_acd/api/v2/app_definitions' => [:export] },
+               :resource_type => 'ForemanAcd::AppDefinition'
+
+    permission :import_app_definitions,
+               { :'foreman_acd/app_definitions' => [:import],
+                 :'foreman_acd/api/v2/app_definitions' => [:import] },
+               :resource_type => 'ForemanAcd::AppDefinition'
+
     permission :create_app_instances,
                { :'foreman_acd/app_instances' => [:new, :create],
                  :'foreman_acd/api/v2/app_instances' => [:create] },
@@ -55,26 +97,76 @@ Foreman::Plugin.register :foreman_acd do
                :resource_type => 'ForemanAcd::AppInstance'
 
     permission :destroy_app_instances,
-               { :'foreman_acd/app_instances' => [:destroy],
-                 :'foreman_acd/api/v2/app_instances' => [:destroy] },
+               { :'foreman_acd/app_instances' => [:destroy, :destroy_with_hosts],
+                 :'foreman_acd/api/v2/app_instances' => [:destroy, :destroy_with_hosts] },
                :resource_type => 'ForemanAcd::AppInstance'
 
     permission :deploy_app_instances,
                { :'foreman_acd/app_instances' => [:deploy],
                  :'foreman_acd/api/v2/app_instances' => [:deploy] },
                :resource_type => 'ForemanAcd::AppInstance'
+
+    permission :report_app_instances,
+               { :'foreman_acd/app_instances' => [:report],
+                 :'foreman_acd/api/v2/app_instances' => [:report] },
+               :resource_type => 'ForemanAcd::AppInstance'
+
+    permission :new_remote_execution,
+               { :'foreman_acd/remote_execution' => [:new] },
+               :resource_type => 'ForemanAcd::RemoteExecution'
+
+    permission :create_remote_execution,
+               { :'foreman_acd/remote_execution' => [:create] },
+               :resource_type => 'ForemanAcd::RemoteExecution'
+
+    permission :view_ui_acd,
+               { :ui_acd => [:app, :foreman_data, :ansible_data] }
+
+    permission :acd_foreman_hosts,
+               { :'foreman_acd/app_instances' => [:create, :edit, :update, :deploy, :destroy_with_hosts, :destroy] },
+               :resource_type => 'ForemanAcd::ForemanHost'
   end
 
   # Manager Role
-  role 'Application Centric Deployment Manager', [:create_app_definitions,
-                                                  :view_app_definitions,
-                                                  :edit_app_definitions,
-                                                  :destroy_app_definitions]
+  role 'Application Centric Deployment Manager', [:create_ansible_playbooks, :view_ansible_playbooks, :edit_ansible_playbooks,
+                                                  :destroy_ansible_playbooks,
+                                                  :import_vars_ansible_playbooks, :grab_ansible_playbooks,
+                                                  :create_app_definitions, :view_app_definitions, :edit_app_definitions,
+                                                  :destroy_app_definitions,
+                                                  :export_app_definitions, :import_app_definitions,
+                                                  :create_app_instances, :view_app_instances, :edit_app_instances,
+                                                  :destroy_app_instances,
+                                                  :deploy_app_instances,
+                                                  :new_remote_execution, :create_remote_execution,
+                                                  :report_app_instances,
+                                                  :view_ui_acd,
+                                                  :view_hosts, :build_hosts, :power_hosts, :create_hosts, :edit_hosts, :destroy_hosts, :console_hosts,
+                                                  :view_job_invocations, :cancel_job_invocations, :create_job_invocations, :create_template_invocations,
+                                                  :view_job_templates,
+                                                  :view_foreman_tasks,
+                                                  :acd_foreman_hosts, :view_smart_proxies]
 
   # User Role
-  role 'Application Centric Deployment User', [:create_app_instances,
-                                               :view_app_instances,
-                                               :edit_app_instances,
+  role 'Application Centric Deployment User', [:create_app_instances, :view_app_instances, :edit_app_instances,
                                                :destroy_app_instances,
-                                               :deploy_app_instances]
+                                               :deploy_app_instances,
+                                               :new_remote_execution, :create_remote_execution,
+                                               :report_app_instances,
+                                               :view_ui_acd,
+                                               :view_hosts, :build_hosts, :power_hosts, :create_hosts, :edit_hosts, :destroy_hosts, :console_hosts,
+                                               :view_job_invocations, :cancel_job_invocations, :create_job_invocations, :create_template_invocations,
+                                               :view_job_templates,
+                                               :view_foreman_tasks,
+                                               :acd_foreman_hosts, :view_smart_proxies]
+
+  add_all_permissions_to_default_roles
+
+  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