Default_host_group plugin config file through the installer

apatelKmd · May 15, 2020, 7:40pm

Problem:
I perform the installation using the foreman-installer --scenario katello --enable-foreman-plugin-default-hostgroup ... and want to stage the config file /etc/foreman/plugins/default_hostgroup.yaml through the installer. If I perform the same step after the install it requires systemctl restart httpd that is not ideal.

Is that possible through custom-hiera.yaml or other means prior to executing the installer? Basically, I don’t want to do any follow on steps but the pre-steps are ok.

Distribution and version:
Katello 3.14

ekohl · May 27, 2020, 11:32am

This should be done in foreman-installer itself. This line in the Foreman scenario exposes it:

github.com

theforeman/foreman-installer/blob/94207e8ba6b153c3b8c86231fdb18931c1ec22d5/config/foreman-answers.yaml#L34


      
          foreman::compute::gce: false
          foreman::compute::libvirt: false
          foreman::compute::openstack: false
          foreman::compute::ovirt: false
          foreman::compute::rackspace: false
          foreman::compute::vmware: false
          foreman::plugin::ansible: false
          foreman::plugin::azure: false
          foreman::plugin::bootdisk: false
          foreman::plugin::chef: false
          foreman::plugin::default_hostgroup: false
          foreman::plugin::dhcp_browser: false
          foreman::plugin::digitalocean: false
          foreman::plugin::discovery: false
          foreman::plugin::expire_hosts: false
          foreman::plugin::hooks: false
          foreman::plugin::host_extra_validator: false
          foreman::plugin::kubevirt: false
          foreman::plugin::leapp: false
          foreman::plugin::memcache: false
          foreman::plugin::monitoring: false

But it’s missing in the katello scenario. Please submit a PR for this. This commit can serve as a good indication of how:

There is a helper to create the migration:

github.com

theforeman/foreman-installer/blob/develop/bin/create-migration

#!/usr/bin/env ruby

if ARGV.length < 2
  $stderr.puts "Usage #{$PROGRAM_NAME} MIGRATION_NAME DIRECTORY [DIRECTORY]"
  $stderr.puts "e.g., #{$PROGRAM_NAME} add-server-ssl-crl config/foreman.migrations"
  exit 1
end

migration_name = ARGV[0]
directories = ARGV[1..-1]
content = (STDIN.tty? || STDIN.closed?) ? nil : STDIN.read

directories.each do |directory|
  unless File.directory?(directory)
    $stderr.puts "Directory #{directory} not found"
    exit 2
  end

  if File.basename(directory) == 'foreman.migrations'
    # Used by the foreman scenario

This file has been truncated. show original

apatelKmd · May 27, 2020, 5:27pm

Thanks for the code snippets. I have follow on questions.

How do I add an option to use the YAML file for the plugin configuration? I am thinking something along the line

--enable-foreman-plugin-default-hostgroup
--plugin-default-hostgroup-config=/path/to/a/config/file

I am not familiar with the migration process. Can you point me to resources to read up?

apatelKmd · June 3, 2020, 1:04am

Here is the pull request

ekohl · June 25, 2020, 12:51pm

As stated in my reply on the PR, the initial hints I gave were incorrect. The plugin is part of the scenario but there’s no way to configure the plugin through the installer.

This file needs to gain parameters to manage the config file:

github.com

theforeman/puppet-foreman/blob/master/manifests/plugin/default_hostgroup.pp

# Installs foreman_default_hostgroup plugin
class foreman::plugin::default_hostgroup {
  foreman::plugin {'default_hostgroup': }
}

I’d recommend looking at the memcache plugin since that already manages a config file:

github.com

theforeman/puppet-foreman/blob/master/manifests/plugin/memcache.pp

# = Foreman Memcache plugin
#
# This class installs the memcache plugin and configuration file
#
# === Parameters:
#
# $hosts::      an array of hosts running memcache
#
# $expires_in:: global default for key TTL in seconds
#
# $namespace::  prepends each key with this value to provide simple namespacing
#
# $compress::   will gzip-compress values larger than 1K
#
class foreman::plugin::memcache (
  Array[String] $hosts = [],
  Integer[0] $expires_in = 86400,
  String $namespace = 'foreman',
  Boolean $compress = true,
) {

This file has been truncated. show original

After that you’ll have --foreman-plugin-default-hostgroup-* parameters on the CLI.

apatelKmd · June 25, 2020, 1:22pm

Excellent, I will look in to it. Is it ok to use the same Redmine ticket #30078 or need to create another one?

ekohl · June 25, 2020, 1:31pm

Reusing it is good since the installer and all installer modules share the same Redmine project.