foreman_acd 0.0.1

data/README.md

@@ -0,0 +1,87 @@
+# Foreman Application Centric Deployment
+
+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. 
+
+This plugin follows the idea of different user types working together.
+The administrative user creates application definitions 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. 
+
+*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. 
+
+# 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 
+
+## 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
+
+ATM, Katello plugin need to exist, too.
+
+## Usage
+
+Application Definition (Admin)
+* Create an Application Definition (Configure -> Application Definition) first
+* Select the Hostgroup 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) 
+* 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
+
+## TODO
+
+- Add ansible playbook / saltstack support to configure the application
+- Multi-host support
+- Add validation to the different parameter types
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+## Copyright
+
+Copyright (c) 2019 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 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/>.
+

data/Rakefile

@@ -0,0 +1,49 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanAppcendep'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _e
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/assets/javascripts/foreman_acd/acd_dummy.js

@@ -0,0 +1,3 @@
+function acd_dummy_method() {
+  console.log("This file / function / method exists so that %foreman_precompile_plugin -s works during RPM build stage...");
+}

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  module Api
+    module V2
+      # API controller for App Definitions
+      class AppDefinitionsController < ::ForemanAcd::Api::V2::BaseController
+        include ::ForemanAcd::Concerns::AppDefinitionParameters
+
+        before_action :find_resource, :except => [:index, :create]
+
+        api :GET, '/app_definitions/:id', N_('Show application definition')
+        param :id, :identifier, :required => true
+        def show; end
+
+        api :GET, '/app_definitions', N_('List application definitions')
+        param_group :search_and_pagination, ::Api::V2::BaseController
+        add_scoped_search_description_for(AppDefinition)
+        def index
+          @app_definitions = resource_scope_for_index
+        end
+
+        def_param_group :app_definition do
+          param :app_definition, Hash, :required => true, :action_aware => true do
+            param :name, String, :required => true
+            param :description, String, :required => true
+            param :hostgroup_id, :number, :required => true
+            param :parameters, String, :required => true
+          end
+        end
+
+        api :POST, '/app_definitions', N_('Create a application definition')
+        param_group :app_definition, :as => :create
+        def create
+          @app_definition = AppDefinition.new(app_definition_params)
+          process_response @app_definition.save
+        end
+
+        api :DELETE, '/app_definitions/:id', N_('Deletes application definition')
+        param :id, :identifier, :required => true
+        def destroy
+          process_response @app_definition.destroy
+        end
+
+        def controller_permission
+          'app_definitions'
+        end
+
+        def resource_class
+          ForemanAcd::AppDefinition
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  module Api
+    module V2
+      # Base Controller for all Acd API controllers
+      class BaseController < ::Api::V2::BaseController
+        resource_description do
+          resource_id 'foreman_acd'
+          api_version 'v2'
+          api_base_url '/acd/api'
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_acd/app_definitions_controller.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # Application Definition Controller
+  class AppDefinitionsController < ::ForemanAcd::ApplicationController
+    include Foreman::Controller::AutoCompleteSearch
+    include ::ForemanAcd::Concerns::AppDefinitionParameters
+
+    before_action :find_resource, :only => [:edit, :update, :destroy]
+
+    def index
+      @app_definitions = resource_base.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page])
+    end
+
+    def read_hostgroups
+      @hostgroups = Hostgroup.all.map { |elem| { elem.id => elem.name } }.reduce({}) { |h, v| h.merge v }
+    end
+
+    def new
+      read_hostgroups
+      @app_definition = AppDefinition.new
+    end
+
+    def create
+      @app_definition = AppDefinition.new(app_definition_params)
+      if @app_definition.save
+        process_success
+      else
+        process_error
+      end
+    end
+
+    def edit
+      read_hostgroups
+    end
+
+    def update
+      if @app_definition.update(app_definition_params)
+        process_success
+      else
+        process_error
+      end
+    end
+
+    def destroy
+      if @app_definition.destroy
+        process_success
+      else
+        process_error
+      end
+    end
+  end
+end

data/app/controllers/foreman_acd/app_instances_controller.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # Application Instance Controller
+  class AppInstancesController < ::ForemanAcd::ApplicationController
+    include Foreman::Controller::AutoCompleteSearch
+    include ::ForemanAcd::Concerns::AppInstanceParameters
+
+    before_action :find_resource, :only => [:edit, :update, :destroy, :deploy]
+
+    def index
+      @app_instances = resource_base.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page])
+    end
+
+    def read_applications
+      @applications = ForemanAcd::AppDefinition.all.map { |elem| { elem.id => elem.name } }.reduce({}) { |h, v| h.merge v }
+    end
+
+    def new
+      @app_instance = AppInstance.new
+      read_applications
+    end
+
+    def create
+      @app_instance = AppInstance.new(app_instance_params)
+      if @app_instance.save
+        process_success
+      else
+        process_error
+      end
+    end
+
+    def edit
+      read_applications
+    end
+
+    def update
+      if @app_instance.update(app_instance_params)
+        process_success
+      else
+        process_error
+      end
+    end
+
+    def destroy
+      if @app_instance.destroy
+        process_success
+      else
+        process_error
+      end
+    end
+
+    def action_permission
+      case params[:action]
+      when 'deploy'
+        :deploy
+      else
+        super
+      end
+    end
+
+    def deploy
+      params = host_attributes(set_host_params)
+
+      # Print to log for debugging purposes
+      logger.info("Host creation parameters:\n#{params}\n")
+
+      @host = Host.new(params)
+      apply_compute_profile(@host)
+      @host.suggest_default_pxe_loader
+      @host.save
+      success _('Successfully initiated host creation')
+    rescue StandardError => e
+      logger.error("Failed to initiate host creation: #{e.backtrace.join($INPUT_RECORD_SEPARATOR)}")
+    ensure
+      redirect_to app_instances_path
+    end
+
+    private
+
+    # Copied from foreman/app/controllers/api/v2/hosts_controller.rb
+    def apply_compute_profile(host)
+      host.apply_compute_profile(InterfaceMerge.new(:merge_compute_attributes => true))
+      host.apply_compute_profile(ComputeAttributeMerge.new)
+    end
+
+    # Copied from foreman/app/controllers/api/v2/hosts_controller.rb
+    def host_attributes(params, host = nil)
+      return {} if params.nil?
+
+      params = params.deep_clone
+      if params[:interfaces_attributes]
+        # handle both hash and array styles of nested attributes
+        params[:interfaces_attributes] = params[:interfaces_attributes].values if params[:interfaces_attributes].is_a?(Hash) || params[:interfaces_attributes].is_a?(ActionController::Parameters)
+        # map interface types
+        params[:interfaces_attributes] = params[:interfaces_attributes].map do |nic_attr|
+          interface_attributes(nic_attr, :allow_nil_type => host.nil?)
+        end
+      end
+      params = host.apply_inherited_attributes(params) if host
+      params
+    end
+
+    # Copied from foreman/app/controllers/api/v2/hosts_controller.rb
+    def interface_attributes(params, allow_nil_type: false)
+      params[:type] = InterfaceTypeMapper.map(params[:type]) if params.key?(:type) || allow_nil_type
+      params
+    end
+
+    def hardcoded_params
+      result = {}
+      result['managed'] = true
+      result['enabled'] = true
+      result['build'] = true
+      result['compute_attributes'] = { 'start' => '1' }
+      result['host_parameters_attributes'] = []
+      result
+    end
+
+    def set_host_params
+      result = hardcoded_params
+      result['hostgroup_id'] = @app_instance.app_definition.hostgroup_id
+      JSON.parse(@app_instance.parameters).each do |param|
+        case param['type']
+
+        when 'computeprofile'
+          result['compute_profile_id'] = param['value']
+
+        when 'domain'
+          result['domain_id'] = param['value']
+
+        when 'hostname'
+          result['name'] = param['value']
+
+        when 'hostparam'
+          result['host_parameters_attributes'].push(:name => param['name'], :value => param['value'])
+
+        when 'ip'
+          result['ip'] = param['value']
+
+        when 'lifecycleenv'
+          result['content_facet_attributes'] = { 'lifecycle_environment_id' => param['value'] }
+
+        when 'ptable'
+          result['ptable_id'] = param['value']
+
+        when 'puppetenv'
+          result['environment_id'] = param['value']
+
+        when 'password'
+          result['root_pass'] = param['value']
+
+        end
+      end
+      result
+    end
+  end
+end

data/app/controllers/foreman_acd/application_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # Base controller for all controllers
+  class ApplicationController < ::ApplicationController
+    def resource_class
+      "ForemanAcd::#{controller_name.singularize.classify}".constantize
+    end
+  end
+end

data/app/controllers/foreman_acd/concerns/app_definition_parameters.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  module Concerns
+    # Parameters for AppDefinitions
+    module AppDefinitionParameters
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def app_definition_params_filter
+          Foreman::ParameterFilter.new(::ForemanAcd::AppDefinition).tap do |filter|
+            filter.permit(:name, :description, :hostgroup_id, :parameters)
+          end
+        end
+      end
+
+      def app_definition_params
+        param_name = parameter_filter_context.api? ? 'app_definition' : 'foreman_acd_app_definition'
+        self.class.app_definition_params_filter.filter_params(params, parameter_filter_context, param_name)
+      end
+    end
+  end
+end

data/app/controllers/foreman_acd/concerns/app_instance_parameters.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  module Concerns
+    # Parameters for AppInstances
+    module AppInstanceParameters
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def app_instance_params_filter
+          Foreman::ParameterFilter.new(::ForemanAcd::AppInstance).tap do |filter|
+            filter.permit(:name, :app_definition_id, :description, :parameters)
+          end
+        end
+      end
+
+      def app_instance_params
+        param_name = parameter_filter_context.api? ? 'app_instance' : 'foreman_acd_app_instance'
+        self.class.app_instance_params_filter.filter_params(params, parameter_filter_context, param_name)
+      end
+    end
+  end
+end

data/app/controllers/ui_acd_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Controller to create JSON data to be used in react app
+class UiAcdController < ::Api::V2::BaseController
+  def app
+    @app_data = {}
+    app_definition = ForemanAcd::AppDefinition.find(params[:id])
+    @app_data['app_definition'] = app_definition
+    @app_data['fdata'] = collect_fdata(app_definition.hostgroup_id)
+  end
+
+  def fdata
+    @fdata = collect_fdata(params['id'])
+  end
+
+  private
+
+  def collect_fdata(hostgroup_id)
+    hg = Hostgroup.find(hostgroup_id)
+    fdata = OpenStruct.new(
+      :environments => Environment.all,
+      :lifecycle_environments => Katello::KTEnvironment.all,
+      :domains => Domain.all,
+      :computeprofiles => ComputeProfile.all,
+      :hostgroup_id => hg.id,
+      :ptables => hg&.operatingsystem.ptables
+    )
+    fdata
+  end
+end

data/app/models/foreman_acd/app_definition.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # Application Definition
+  class AppDefinition < ApplicationRecord
+    include Authorizable
+    extend FriendlyId
+    friendly_id :name
+
+    validates :name, :presence => true, :uniqueness => true
+    belongs_to :hostgroup, :class_name => '::Hostgroup'
+    has_many :app_instances, :inverse_of => :app_definition, :dependent => :destroy
+    scoped_search :on => :name
+
+    def self.humanize_class_name(_name = nil)
+      _('App Definition')
+    end
+
+    def self.permission_name
+      'app_definitions'
+    end
+  end
+end

data/app/models/foreman_acd/app_instance.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ForemanAcd
+  # Application Instance
+  class AppInstance < ApplicationRecord
+    include Authorizable
+    extend FriendlyId
+    friendly_id :name
+    validates :name, :presence => true, :uniqueness => true
+    belongs_to :app_definition, :inverse_of => :app_instances
+    scoped_search :on => :name
+
+    def self.humanize_class_name(_name = nil)
+      _('App Instance')
+    end
+
+    def self.permission_name
+      'app_instances'
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+<%
+    json = {
+      "organization": current_organization,
+      "location": current_location,
+      "hostgroups": @hostgroups,
+      "loadForemanDataUrl": ui_acd_fdata_path("__id__")
+    }
+
+    if @app_definition.name.empty?
+      json["mode"] = "newDefinition"
+    else
+      json["mode"] = "editDefinition"
+      json["appDefinition"] = {
+        "id": @app_definition.id,
+        "name": @app_definition.name,
+        "hostgroup_id": @app_definition.hostgroup_id,
+      }
+      json["parameters"] = JSON.parse(@app_definition.parameters)
+    end
+
+%>
+
+<%= form_for @app_definition, :url => (@app_definition.new_record? ? app_definitions_path : app_definition_path(:id => @app_definition.id)) do |f| %>
+  <%= base_errors_for @app_definition %>
+  <ul class="nav nav-tabs" data-tabs="tabs">
+    <li class="active"><a href="#primary" data-toggle="tab"><%= _('Application Definitions') %></a></li>
+  </ul>
+
+  <div class="tab-content">
+    <div class="tab-pane active" id="primary">
+      <%= text_f f, :name %>
+      <%= text_f f, :description %>
+
+      <div id='param-selection'></div>
+      <%=  mount_react_component('ParameterSelection', "#param-selection", json.to_json) %>
+    </div>
+  </div>
+
+  <%= submit_or_cancel f %>
+<% end %>

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

@@ -0,0 +1,11 @@
+<% title(_('Edit Application Definition %s') % @app_definition) %>
+
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_acd %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_acd %>
+<% end %>
+
+<%= render :partial => 'form' %>
+

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

@@ -0,0 +1,27 @@
+<% title _('Application Definitions') %>
+
+<% title_actions button_group(new_link(_('New Application Definition'))) %>
+
+<table class="table table-bordered table-striped">
+  <tr>
+    <th><%= sort :name, :as => s_('AppDefinition|Name') %></th>
+    <th><%= _('Description') %></th>
+    <th><%= sort :hostgroup, :as => _('Host groups'), :default => 'DESC' %></th>
+    <th></th>
+  </tr>
+  <% for app_definition in @app_definitions %>
+    <tr>
+      <td><%=link_to_if_authorized h(app_definition.name), hash_for_edit_app_definition_path(:id => app_definition).merge(:auth_object => app_definition, :authorizer => authorizer) %></td>
+      <td><%= app_definition.description %></td>
+      <td><%= app_definition.hostgroup %></td>
+      <td>
+          <%= action_buttons(display_delete_if_authorized(hash_for_app_definition_path(:id => app_definition).merge(:auth_object => app_definition, :authorizer => authorizer),
+                                                          :data => { 'confirm': _('Delete %s?') % app_definition.name })) %>
+      </td>
+    </tr>
+  <% end %>
+</table>
+
+<%= page_entries_info @app_definitions %>
+<%= will_paginate @app_definitions %>
+

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

@@ -0,0 +1,10 @@
+<% title _('New Application Definition') %>
+
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_acd %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_acd %>
+<% end %>
+
+<%= render :partial => 'form' %>