foreman_maintain 1.3.0 → 1.3.1

data/definitions/features/mongo.rb

@@ -1,217 +0,0 @@
-class Features::Mongo < ForemanMaintain::Feature
-  include ForemanMaintain::Concerns::DirectoryMarker
-
-  # assume mongo is installed when there is Pulp
-  PULP_DB_CONFIG = '/etc/pulp/server.conf'.freeze
-
-  attr_reader :configuration
-  metadata do
-    label :mongo
-
-    confine do
-      feature(:pulp2)
-    end
-  end
-
-  def services
-    core.services.map do |service, priority|
-      system_service(service, priority, :db_feature => self)
-    end
-  end
-
-  def data_dir
-    '/var/lib/mongodb'
-  end
-
-  def config_files
-    [config_file] + (local? ? core.server_config_files : [])
-  end
-
-  def config_file
-    PULP_DB_CONFIG
-  end
-
-  def initialize
-    reload_db_config
-  end
-
-  def reload_db_config
-    @configuration = load_db_config(config_file)
-  end
-
-  # guess mongo version from installed packages
-  # safe method to run mongo commands prior we know
-  # what version uses the target DB
-  def available_core
-    return @core unless @core.nil? # return correct mongo ver if known
-    if @available_core.nil?
-      @available_core = ForemanMaintain::Utils::MongoCoreInstalled.new
-    end
-    @available_core
-  end
-
-  def core
-    if @core.nil?
-      begin
-        version = server_version
-        @core = if version =~ /^3\.4/
-                  load_mongo_core_34(version)
-                else
-                  load_mongo_core_default(version)
-                end
-      rescue ForemanMaintain::Error::ExecutionError
-        # server version detection failed
-        logger.debug('Mongo version detection failed, choosing from installed versions')
-        @core = @available_core
-      end
-    end
-    @core
-  end
-
-  def local?
-    ['localhost', '127.0.0.1', hostname].include?(configuration['host'])
-  end
-
-  # rubocop:disable Metrics/AbcSize
-  def base_command(command, config = configuration, args = '')
-    if config['ssl']
-      ssl = ' --ssl'
-      if config['ca_path'] && !config['ca_path'].empty?
-        ca_cert = " --sslCAFile #{config['ca_path']}"
-      end
-      if config['ssl_certfile'] && !config['ssl_certfile'].empty?
-        client_cert = " --sslPEMKeyFile #{config['ssl_certfile']}"
-      end
-      verify_ssl = ' --sslAllowInvalidCertificates' if config['verify_ssl'] == false
-    end
-    username = " -u #{config['username']}" if config['username']
-    password = " -p #{config['password']}" if config['password']
-    host = "--host #{config['host']} --port #{config['port']}"
-    "#{command}#{username}#{password} #{host}#{ssl}#{verify_ssl}#{ca_cert}#{client_cert} #{args}"
-  end
-  # rubocop:enable Metrics/AbcSize
-
-  def mongo_command(args, config = configuration)
-    base_command(core.client_command, config, "#{args} #{config['name']}")
-  end
-
-  def dump(target, config = configuration)
-    execute!(base_command(core.dump_command, config, "-d #{config['name']} --out #{target}"),
-             :hidden_patterns => [config['password']])
-  end
-
-  def restore(dir, config = configuration)
-    cmd = base_command(core.restore_command, config,
-                       "-d #{config['name']} #{File.join(dir, config['name'])}")
-    execute!(cmd, :hidden_patterns => [config['password']])
-  end
-
-  def dropdb(config = configuration)
-    execute!(mongo_command("--eval 'db.dropDatabase()'", config),
-             :hidden_patterns => [config['password']])
-  end
-
-  def ping(config = configuration)
-    execute?(mongo_command("--eval 'ping:1'", config),
-             :hidden_patterns => [config['password']])
-  end
-
-  def server_version(config = configuration)
-    # do not use any core methods as we need this prior the core is created
-    mongo_cmd = base_command(available_core.client_command, config,
-                             "--eval 'db.version()' #{config['name']}")
-    version = execute!(mongo_cmd, :hidden_patterns => [config['password']])
-    version.split("\n").last
-  end
-
-  def backup_local(backup_file, extra_tar_options = {})
-    dir = extra_tar_options.fetch(:data_dir, nil) || data_dir
-    logger.info("Backup of Mongo DB at #{dir} into #{backup_file}")
-    logger.debug(extra_tar_options.inspect)
-    FileUtils.cd(dir) do
-      tar_options = {
-        :archive => backup_file,
-        :command => 'create',
-        :exclude => ['mongod.lock'],
-        :transform => 's,^,var/lib/mongodb/,S',
-        :files => '*'
-      }.merge(extra_tar_options)
-      feature(:tar).run(tar_options)
-    end
-  end
-
-  def mongo_cmd_available?
-    exit_status, _output = execute_with_status('which mongo')
-    exit_status == 0
-  end
-
-  def raise_mongo_client_missing_error
-    raise ForemanMaintain::Error::Fail, 'The mongo command not found.'\
-                                  ' Make sure system has mongo utility installed.'
-  end
-
-  private
-
-  def load_mongo_core_default(version)
-    unless find_package('mongodb')
-      raise ForemanMaintain::Error::Fail, 'Mongo client was not found'
-    end
-    logger.debug("Mongo #{version} detected, using default commands")
-    ForemanMaintain::Utils::MongoCore.new
-  end
-
-  def load_mongo_core_34(version)
-    unless find_package('rh-mongodb34-mongodb')
-      raise ForemanMaintain::Error::Fail, 'Mongo client ver. 3.4 was not found'
-    end
-    logger.debug("Mongo #{version} detected, using commands from rh-mongodb34 SCL")
-    ForemanMaintain::Utils::MongoCore34.new
-  end
-
-  def norm_value(value)
-    value = value.strip
-    case value
-    when 'true'
-      true
-    when 'false'
-      false
-    else
-      value
-    end
-  end
-
-  def load_db_config(config)
-    cfg = read_db_section(config)
-    if cfg['seeds']
-      seed = cfg['seeds'].split(',').first
-      host, port = seed.split(':')
-    end
-    cfg['host'] = host || 'localhost'
-    cfg['port'] = port || '27017'
-    cfg
-  end
-
-  # rubocop:disable  Metrics/MethodLength
-  def read_db_section(config)
-    cfg = {}
-    section = nil
-    File.readlines(config).each do |line|
-      case line
-      when /^\s*#/
-        next # skip comments
-      when /^\s*$/
-        next # skip empty lines
-      when /\[([^\]]+)\]/
-        section = Regexp.last_match(1)
-        next
-      else
-        if section == 'database'
-          key, value = line.split(':', 2)
-          cfg[key.strip] = norm_value(value)
-        end
-      end
-    end
-    cfg
-  end
-  # rubocop:enable  Metrics/MethodLength
-end

data/definitions/features/pulp2.rb

@@ -1,35 +0,0 @@
-class Features::Pulp < ForemanMaintain::Feature
-  include ForemanMaintain::Concerns::DirectoryMarker
-  include ForemanMaintain::Concerns::PulpCommon
-
-  metadata do
-    label :pulp2
-
-    confine do
-      !check_min_version('katello-common', '4.0') &&
-        ForemanMaintain::Utils::Service::Systemd.new('pulp_resource_manager', 0).enabled?
-    end
-  end
-
-  def services
-    [
-      system_service('squid', 10),
-      system_service('qpidd', 10),
-      system_service('qdrouterd', 10),
-      system_service('pulp_workers', 20),
-      system_service('pulp_celerybeat', 20),
-      system_service('pulp_resource_manager', 20),
-      system_service('pulp_streamer', 20),
-      system_service('httpd', 30)
-    ]
-  end
-
-  def config_files
-    [
-      '/etc/pki/pulp',
-      '/etc/pulp',
-      '/etc/crane.conf',
-      '/etc/default/pulp_workers'
-    ]
-  end
-end

data/definitions/procedures/backup/offline/mongo.rb

@@ -1,56 +0,0 @@
-module Procedures::Backup
-  module Offline
-    class Mongo < ForemanMaintain::Procedure
-      metadata do
-        description 'Backup mongo offline'
-        tags :backup
-        for_feature :mongo
-        preparation_steps do
-          unless feature(:mongo).local?
-            [Checks::Mongo::DBUp.new, Checks::Mongo::ToolsInstalled.new]
-          end
-        end
-        param :backup_dir, 'Directory where to backup to', :required => true
-        param :tar_volume_size, 'Size of tar volume (indicates splitting)'
-        param :mount_dir, 'Snapshot mount directory'
-      end
-
-      def run
-        if feature(:mongo).local?
-          local_backup
-        else
-          dump_mongo
-        end
-      end
-
-      def data_dir
-        return nil if @mount_dir.nil?
-        mount_point = File.join(@mount_dir, 'mongodb')
-        dir = feature(:mongo).find_marked_directory(mount_point)
-        fail!("Snapshot of Mongo DB was not found mounted in #{mount_point}") if dir.nil?
-        dir
-      end
-
-      private
-
-      def dump_mongo
-        puts "Backup of #{feature(:mongo).data_dir} is not supported for remote databases." \
-            ' Doing dump instead... '
-        with_spinner('Getting dump of Mongo DB') do
-          feature(:mongo).dump(File.join(@backup_dir, 'mongo_dump'))
-        end
-      end
-
-      def local_backup
-        with_spinner('Collecting Mongo data') do
-          feature(:mongo).backup_local(
-            File.join(@backup_dir, 'mongo_data.tar'),
-            :listed_incremental => File.join(@backup_dir, '.mongo.snar'),
-            :volume_size => @tar_volume_size,
-            :data_dir => data_dir
-          )
-        end
-      end
-    end
-  end
-end

data/definitions/procedures/backup/online/mongo.rb

@@ -1,21 +0,0 @@
-module Procedures::Backup
-  module Online
-    class Mongo < ForemanMaintain::Procedure
-      metadata do
-        description 'Backup Mongo online'
-        tags :backup
-        for_feature :mongo
-        preparation_steps do
-          [Checks::Mongo::DBUp.new, Checks::Mongo::ToolsInstalled.new]
-        end
-        param :backup_dir, 'Directory where to backup to', :required => true
-      end
-
-      def run
-        with_spinner('Getting dump of Mongo DB') do
-          feature(:mongo).dump(File.join(@backup_dir, 'mongo_dump'))
-        end
-      end
-    end
-  end
-end

data/definitions/procedures/backup/snapshot/mount_mongo.rb

@@ -1,43 +0,0 @@
-require 'procedures/backup/snapshot/mount_base'
-module Procedures::Backup
-  module Snapshot
-    class MountMongo < MountBase
-      metadata do
-        description 'Create and mount snapshot of Mongo DB'
-        tags :backup
-        for_feature :mongo
-        preparation_steps do
-          unless feature(:mongo).local?
-            [Checks::Mongo::DBUp.new, Checks::Mongo::ToolsInstalled.new]
-          end
-        end
-        MountBase.common_params(self)
-        param :backup_dir, 'Directory where to backup to'
-      end
-
-      def run
-        if feature(:mongo).local?
-          mount_local
-        else
-          puts 'LV snapshots are not supported for remote databases. Doing dump instead...'
-          with_spinner('Getting dump of Mongo DB') do
-            feature(:mongo).dump(File.join(@backup_dir, 'mongo_dump'))
-          end
-        end
-      end
-
-      private
-
-      def mount_local
-        with_spinner('Creating snapshot of Mongo DB') do |spinner|
-          feature(:mongo).with_marked_directory(feature(:mongo).data_dir) do
-            lv_info = get_lv_info(feature(:mongo).data_dir)
-            create_lv_snapshot('mongodb-snap', @block_size, lv_info[0])
-            spinner.update("Mounting snapshot of Mongo DB on #{mount_location('mongodb')}")
-            mount_snapshot('mongodb', lv_info[1])
-          end
-        end
-      end
-    end
-  end
-end

data/definitions/procedures/candlepin/delete_orphaned_records_from_env_content.rb

@@ -1,40 +0,0 @@
-module Procedures::Candlepin
-  class DeleteOrphanedRecordsFromEnvContent < ForemanMaintain::Procedure
-    metadata do
-      description 'Delete orphaned record(s) from cp_env_content with unresolvable content'
-      label :candlepin_delete_orphaned_records_from_env_content
-
-      confine do
-        feature(:candlepin_database) &&
-          feature(:satellite) && feature(:satellite).current_minor_version == '6.2'
-      end
-    end
-
-    def run
-      if feature(:candlepin_database).table_exist?('cp_env_content')
-        with_spinner('Deleting cp_env_content record(s) with unresolvable content') do |spinner|
-          spinner.update 'Finding cp_env_content records with unresolvable content'
-          env_content_ids = feature(:candlepin_database).env_content_ids_with_null_content
-          if env_content_ids.empty?
-            spinner.update 'No orphaned records found'
-          else
-            backup_and_delete_records(spinner, env_content_ids)
-          end
-        end
-      end
-    end
-
-    private
-
-    def backup_and_delete_records(spinner, env_content_ids)
-      spinner.update 'Taking a backup of the candlepin database'
-      feature(:candlepin_database).perform_backup
-
-      puts "Total #{env_content_ids.length} records with unresolvable content"
-      spinner.update 'Deleting record(s) from cp_env_content table'
-      feature(:candlepin_database).delete_records_by_ids(
-        'cp_env_content', env_content_ids
-      )
-    end
-  end
-end

data/definitions/procedures/content/fix_pulpcore_artifact_permissions.rb

@@ -1,31 +0,0 @@
-module Procedures::Content
-  class FixPulpcoreArtifactOwnership < ForemanMaintain::Procedure
-    metadata do
-      description 'Fix Pulpcore artifact ownership to be pulp:pulp'
-      param :assumeyes, 'Do not ask for confirmation', :default => false
-
-      confine do
-        check_min_version(foreman_plugin_name('katello'), '4.0') &&
-          Dir.exist?('/var/lib/pulp/media/artifact')
-      end
-    end
-
-    def ask_to_proceed
-      question = "\nWARNING: Only proceed if your system is fully switched to Pulp 3.\n"
-      question += "\n\nDo you want to proceed?"
-      answer = ask_decision(question, actions_msg: 'y(yes), q(quit)')
-      abort! if answer != :yes
-    end
-
-    def run
-      assumeyes_val = @assumeyes.nil? ? assumeyes? : @assumeyes
-
-      ask_to_proceed unless assumeyes_val
-
-      with_spinner('Updating artifact ownership for Pulp 3') do |spinner|
-        spinner.update('# chown -hR pulp.pulp /var/lib/pulp/media/artifact')
-        FileUtils.chown_R 'pulp', 'pulp', '/var/lib/pulp/media/artifact'
-      end
-    end
-  end
-end

data/definitions/procedures/content/migration_reset.rb

@@ -1,12 +0,0 @@
-module Procedures::Content
-  class MigrationReset < ForemanMaintain::Procedure
-    metadata do
-      description 'Reset the Pulp 2 to Pulp 3 migration data (pre-switchover)'
-      for_feature :pulpcore
-    end
-
-    def run
-      puts execute!('foreman-rake katello:pulp3_migration_reset')
-    end
-  end
-end

data/definitions/procedures/content/migration_stats.rb

@@ -1,12 +0,0 @@
-module Procedures::Content
-  class MigrationStats < ForemanMaintain::Procedure
-    metadata do
-      description 'Retrieve Pulp 2 to Pulp 3 migration statistics'
-      for_feature :pulpcore
-    end
-
-    def run
-      puts execute!('foreman-rake katello:pulp3_migration_stats')
-    end
-  end
-end

data/definitions/procedures/content/prepare.rb

@@ -1,17 +0,0 @@
-module Procedures::Content
-  class Prepare < ForemanMaintain::Procedure
-    metadata do
-      description 'Prepare content for Pulp 3'
-      for_feature :pulpcore
-      param :quiet, 'Keep the output on a single line', :flag => true, :default => false
-      do_not_whitelist
-    end
-
-    def run
-      sleep(20) # in satellite 6.9 the services are still coming up
-      # use interactive to get realtime output
-      env_vars = @quiet ? '' : 'preserve_output=true '
-      execute!("#{env_vars}foreman-rake katello:pulp3_migration", :interactive => true)
-    end
-  end
-end

data/definitions/procedures/content/prepare_abort.rb

@@ -1,12 +0,0 @@
-module Procedures::Content
-  class PrepareAbort < ForemanMaintain::Procedure
-    metadata do
-      description 'Abort all running Pulp 2 to Pulp 3 migration tasks'
-      for_feature :pulpcore
-    end
-
-    def run
-      puts execute!('foreman-rake katello:pulp3_migration_abort')
-    end
-  end
-end

data/definitions/procedures/content/switchover.rb

@@ -1,41 +0,0 @@
-module Procedures::Content
-  class Switchover < ForemanMaintain::Procedure
-    metadata do
-      description 'Switch support for certain content from Pulp 2 to Pulp 3'
-      for_feature :pulpcore
-
-      confine do
-        !check_min_version(foreman_plugin_name('katello'), '4.0')
-      end
-
-      param :skip_deb, 'Do not run debian options in installer.'
-      do_not_whitelist
-    end
-
-    def run
-      puts 'Performing final content migration before switching content'
-      puts execute!('foreman-rake katello:pulp3_migration')
-      puts 'Performing a check to verify everything that is needed has been migrated'
-      puts execute!('foreman-rake katello:pulp3_post_migration_check')
-      puts 'Switching specified content over to pulp 3'
-      puts execute!('foreman-rake katello:pulp3_content_switchover')
-      run_installer if feature(:katello_install)
-    end
-
-    def run_installer
-      puts 'Re-running the installer to switch specified content over to pulp3'
-      args = ['--foreman-proxy-content-proxy-pulp-isos-to-pulpcore=true',
-              '--foreman-proxy-content-proxy-pulp-yum-to-pulpcore=true',
-              '--katello-use-pulp-2-for-file=false',
-              '--katello-use-pulp-2-for-docker=false',
-              '--katello-use-pulp-2-for-yum=false']
-
-      unless @skip_deb
-        args += ['--katello-use-pulp-2-for-deb=false',
-                 '--foreman-proxy-content-proxy-pulp-deb-to-pulpcore=true']
-      end
-
-      feature(:installer).run(args.join(' '))
-    end
-  end
-end

data/definitions/procedures/prep_6_10_upgrade.rb

@@ -1,29 +0,0 @@
-class Procedures::Prep610Upgrade < ForemanMaintain::Procedure
-  metadata do
-    description 'Preparations for the Satellite 6.10 upgrade'
-
-    confine do
-      feature(:satellite) &&
-        feature(:satellite).current_minor_version == '6.9'
-    end
-  end
-
-  def run
-    puts time_warning
-    with_spinner('Updating filesystem permissions for Pulp 3') do |spinner|
-      spinner.update('# chmod -R g=rwX /var/lib/pulp/content')
-      FileUtils.chmod_R 'g=rwX', '/var/lib/pulp/content'
-      spinner.update("# find /var/lib/pulp/content -type d \! -perm -g+s -exec chmod g+s {} +")
-      execute!('find /var/lib/pulp/content -type d \! -perm -g+s -exec chmod g+s {} +')
-      spinner.update('# chgrp -R pulp /var/lib/pulp/content')
-      FileUtils.chown_R nil, 'pulp', '/var/lib/pulp/content'
-    end
-  end
-
-  private
-
-  def time_warning
-    "\e[33mprep-6.10-upgrade may take a while depending on the "\
-    "size of /var/lib/pulp/content\e[0m"
-  end
-end

data/definitions/procedures/pulp/cleanup_old_metadata_files.rb

@@ -1,75 +0,0 @@
-require 'find'
-require 'rexml/document'
-
-module Procedures::Pulp
-  class CleanupOldMetadataFiles < ForemanMaintain::Procedure
-    metadata do
-      description 'Cleanup old and unneeded yum metadata files from /var/lib/pulp/'
-      confine do
-        check_max_version('katello-common', '4.0')
-      end
-      param :remove_files, 'If true, will actually delete files, otherwise will print them out.'
-    end
-
-    PULP_METADATA_DIR = '/var/lib/pulp/published/yum/master/yum_distributor/'.freeze
-    REPOMD_FILE = 'repomd.xml'.freeze
-
-    def run
-      return unless File.directory?(PULP_METADATA_DIR)
-      found = []
-
-      puts 'Warning: This command may cause reduced performance related to content operations.'
-      message = 'Locating repository metadata (this may take a while)'
-      with_spinner(message) do |spinner|
-        Find.find(PULP_METADATA_DIR) do |path|
-          next if File.basename(path) != REPOMD_FILE
-          found << path
-          spinner.update("#{message}: Found #{found.count} repos.")
-        end
-      end
-
-      found.each do |repo_md_path|
-        handle(repo_md_path, @remove_files)
-      end
-    end
-
-    def handle(repo_md_path, remove_files)
-      base_path = File.dirname(repo_md_path)
-      to_remove = list_existing_files(repo_md_path) - list_repomd_files(repo_md_path)
-
-      if to_remove.empty?
-        "Skipping #{base_path}, no files to remove."
-      elsif remove_files
-        puts '================================================================================'
-        puts "Removing #{to_remove.count} files from #{base_path}"
-        to_remove.each { |file| File.delete(File.join(base_path, file)) }
-      else
-        puts '================================================================================'
-        puts "For #{base_path} would remove, but --remove-files was not specified:"
-        to_remove.each { |file| puts "   #{file}" }
-      end
-    end
-
-    def list_repomd_files(repo_md_path)
-      doc = REXML::Document.new(File.new(repo_md_path))
-      filenames = []
-      doc.root.elements.each do |data|
-        locations = data.elements['location']
-        next unless locations
-
-        if locations.attributes
-          filenames << locations.attributes['href']
-        end
-      end
-      base_names(filenames.flatten)
-    end
-
-    def list_existing_files(repo_md_path)
-      base_names(Dir[File.dirname(repo_md_path) + '/*']) - [REPOMD_FILE]
-    end
-
-    def base_names(file_list)
-      file_list.map { |file| File.basename(file) }
-    end
-  end
-end

data/definitions/procedures/pulp/migrate.rb

@@ -1,23 +0,0 @@
-module Procedures::Pulp
-  class Migrate < ForemanMaintain::Procedure
-    include ForemanMaintain::Concerns::SystemService
-
-    metadata do
-      description 'Migrate pulp db'
-      for_feature :pulp2
-    end
-
-    def run
-      with_spinner('Migrating pulp') do |spinner|
-        necessary_services = feature(:mongo).services + [system_service('qpidd', 10)]
-        pulp_services = %w[pulp_celerybeat pulp_workers pulp_resource_manager]
-
-        feature(:service).handle_services(spinner, 'start', :only => necessary_services)
-        feature(:service).handle_services(spinner, 'stop', :only => pulp_services)
-
-        spinner.update('Migrating pulp database')
-        execute!('su - apache -s /bin/bash -c pulp-manage-db')
-      end
-    end
-  end
-end