foreman_maintain 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ba0d1619770cae069e142f20a49d40591000521
-  data.tar.gz: f3ffcb2023e8070b5dc5764f9496654a32c65687
+  metadata.gz: a95032534af5a5f6533cf1b1623321f71462bd98
+  data.tar.gz: 9fbc367b8ea5dfbf01112d614123661921b146f4
 SHA512:
-  metadata.gz: 2f14ff8e193e7f421f7d7e9c3183013abdc7b83d3d7eda31faa09502f561a3cb7a9069afd1301a3d59d5f48f2dadda36929ae5d4515d950d2b525ff1e317406b
-  data.tar.gz: c9c14e9df45fcfcadf4a2a3ea2e710b30edd698f9c4cc19c1f0b52b3690c4ffaf23b9b9d6749b8e091cdca3fb8e4a167a84781ec857c287e25c5f8afed479bf1
+  metadata.gz: 41f25e7065a7752525906ab02073c1af43a426ea450c68ca91b03c8ded84e9c55bd0f129166ecfd7b3bc7dfb9a870b54ad9f307bcaeb14b33e154d588e35c480
+  data.tar.gz: 7894e033e22c4c378afc3d4aafac9ae53279409f1796e05099e391b250cf9ed825bb5453749fc59e385da1eda18993a4bdc31c8dd120067204619396104639e5

data/README.md

@@ -21,6 +21,20 @@ Subcommands:
       check --target-version TARGET_VERSION   Run pre-upgrade checks for upgrading to specified version
       run --target-version TARGET_VERSION     Run the full upgrade
           [--phase=phase TARGET_VERSION]      Run just a specific phase of the upgrade
+
+    advanced                      Advanced tools for server maintenance
+      procedure                     Run maintain procedures manually
+        run                           Run maintain procedures manually
+        by-tag                        Run maintain procedures in bulks
+
+    service                       Control applicable services
+      start                         Start applicable services
+      stop                          Stop applicable services
+      restart                       Restart applicable services
+      status                        Get statuses of applicable services
+      list                          List applicable services
+      enable                        Enable applicable services
+      disable                       Disable applicable services
 ```
 
 ### Upgrades
@@ -283,24 +297,48 @@ end
 ### Hammer
 
 In some cases, it's useful to be able to use the hammer as part of check/fix procedures.
-The easiest way to achieve this is to include `ForemanMaintain::Concerns::Hammer` module:
+It is as simple as:
 
 ```ruby
-include ForemanMaintain::Concerns::Hammer
-
 def run
-  hammer('task resume')
+  feature(:hammer).run('task resume')
 end
 ```
 
-We expect the credentials for the hammer commands to to be stored inside the hammer settings:
+Before executing the command the feature checks if it has valid hammer configuration to run the command.
+Foreman maintain always use the 'admin' account to run the commands. The password is taken either form
+the Hammer config or installer answer files or asked from the user interactively (in this order).
+The valid credentials are stored and reused next time if still valid.
 
+Usually we want to do the user interaction at the beginning of our scenario.
+The easiest way to achieve this is to include `ForemanMaintain::Concerns::Hammer` module:
+
+```ruby
+include ForemanMaintain::Concerns::Hammer
 ```
-# ~/.hammer/cli.modules.d/foreman.yml
-:foreman:
-  :username: 'admin'
-  :password: 'changeme'
-```
+
+which adds `Procedures::HammerSetup` as a preparation step to your metadata. We are adding this
+to all procedures and checks automatically.
+
+## Metadata
+
+A set of data that describes and gives information about any definition.
+
+You can describe a definition using following methods available in metadata:
+
+  * **label** - specify an unique name per definition
+  * **tags** -  comma separated labels attached for the purpose of creating
+    groups of definitions
+  * **description** - specify short description about definition
+  * **param** - declare parameters for a definition using this method
+  * **for_feature** - specify feature name for a definition. It implicitly confines the presence
+    of that feature.
+  * **preparation_steps** - takes block using which you can perform additional steps
+    before executing actual definition
+  * **confine** - takes block as argument to restrict execution of it
+  * **advanced_run** - takes a boolean value for procedure definition & will restrict
+    execution of procedure from `advanced procedure run` sub-command
+  * **before**, **after** - methods used to define order for particular check. Specify label of other check.
 
 ## Implementation components
 

data/bin/foreman-maintain-rotate-tar

@@ -0,0 +1,18 @@
+#!/bin/bash
+## For this script it's advisable to use a shell, such as Bash,
+## that supports a TAR_FD value greater than 9.
+
+# This script taken from the tar info doc
+
+name=`expr ${TAR_ARCHIVE} : '\(.*\)\..*'`
+volnum=`printf "%04d" ${TAR_VOLUME}`
+filename="${name:-$TAR_ARCHIVE}.part${volnum:-$TAR_VOLUME}"
+case ${TAR_SUBCOMMAND} in
+-c)       ;;
+-d|-x|-t) test -r ${filename} || exit 1
+          ;;
+*)        exit 1
+esac
+
+echo ${filename} >&${TAR_FD}
+echo " Switched to multi-volume ${filename}"

data/definitions/checks/backup/certs_tar_exist.rb

@@ -0,0 +1,24 @@
+module Checks::Backup
+  class CertsTarExist < ForemanMaintain::Check
+    metadata do
+      description 'Check if proxy certs_tar exist'
+      tags :backup
+      for_feature :foreman_proxy
+    end
+
+    def run
+      unless feature(:foreman_proxy).internal?
+        if certs_tar && !File.exist?(certs_tar)
+          name = feature(:instance).proxy_product_name
+          fail! "#{name} certs tar file is not present on the system" \
+                " in path '#{certs_tar}'. \nPlease move the file back to that" \
+                ' location or generate a new one on the main server.'
+        end
+      end
+    end
+
+    def certs_tar
+      feature(:foreman_proxy).certs_tar
+    end
+  end
+end

data/definitions/checks/backup/directory_ready.rb

@@ -0,0 +1,21 @@
+module Checks::Backup
+  class DirectoryReady < ForemanMaintain::Check
+    metadata do
+      description 'Check if the directory exists and is writable'
+      tags :backup
+      manual_detection
+      param :backup_dir, 'Directory where to backup to', :required => true
+      param :preserve_dir, 'Directory where to backup to', :flag => true, :default => false
+    end
+
+    def run
+      assert(File.directory?(@backup_dir), "Backup directory (#{@backup_dir}) does not exit.")
+      if local_psql_database?
+        result = system("runuser - postgres -c 'test -w #{@backup_dir}'")
+        assert(result, "Postgres user needs write access to the backup directory \n" \
+          "Please allow the postgres user write access to #{@backup_dir}" \
+          ' or choose another directory.')
+      end
+    end
+  end
+end

data/definitions/checks/candlepin/db_up.rb

@@ -0,0 +1,29 @@
+module Checks
+  module Candlepin
+    class DBUp < ForemanMaintain::Check
+      metadata do
+        description 'Make sure Candlepin DB is up'
+        label :candlepin_db_up
+        for_feature :candlepin_database
+      end
+
+      def run
+        status = false
+        with_spinner('Checking connection to the Candlepin DB') do
+          status = feature(:candlepin_database).ping
+        end
+        assert(status, 'Candlepin DB is not responding. ' \
+          'It needs to be up and running to perform the following steps',
+               :next_steps => next_steps)
+      end
+
+      def next_steps
+        if feature(:foreman_database).local?
+          [Procedures::Service::Start.new(:only => 'postgresql')]
+        else
+          [] # there is nothing we can do for remote db
+        end
+      end
+    end
+  end
+end

data/definitions/checks/check_epel_repository.rb

@@ -0,0 +1,21 @@
+class Checks::CheckEpelRepository < ForemanMaintain::Check
+  metadata do
+    label :check_epel_repository
+    description 'Check if EPEL repository enabled on system'
+    tags :pre_upgrade
+    confine do
+      feature(:downstream)
+    end
+  end
+
+  def run
+    with_spinner('Checking for presence of EPEL repository') do
+      assert(!epel_enabled?, 'System is subscribed to EPEL repository')
+    end
+  end
+
+  def epel_enabled?
+    system_repos = execute("yum repolist enabled -d 6 -e 0| grep -E 'Repo-baseurl|Repo-id'")
+    system_repos.to_s.match(/\bepel\b/i)
+  end
+end

data/definitions/checks/foreman/db_up.rb

@@ -0,0 +1,29 @@
+module Checks
+  module Foreman
+    class DBUp < ForemanMaintain::Check
+      metadata do
+        description 'Make sure Foreman DB is up'
+        label :foreman_db_up
+        for_feature :foreman_database
+      end
+
+      def run
+        status = false
+        with_spinner('Checking connection to the Foreman DB') do
+          status = feature(:foreman_database).ping
+        end
+        assert(status, 'Foreman DB is not responding. ' \
+          'It needs to be up and running to perform the following steps',
+               :next_steps => next_steps)
+      end
+
+      def next_steps
+        if feature(:foreman_database).local?
+          [Procedures::Service::Start.new(:only => 'postgresql')]
+        else
+          [] # there is nothing we can do for remote db
+        end
+      end
+    end
+  end
+end

data/definitions/checks/hammer_ping.rb

@@ -13,8 +13,10 @@ class Checks::HammerPing < ForemanMaintain::Check
 
   def run
     result = feature(:hammer).hammer_ping_cmd
+    restart_procedure = Procedures::Service::Restart.new(:only => result[:data],
+                                                         :wait_for_hammer_ping => true)
     assert(result[:success],
            result[:message],
-           :next_steps => Procedures::KatelloService::Restart.new(:only => result[:data]))
+           :next_steps => restart_procedure)
   end
 end

data/definitions/checks/mongo/db_up.rb

@@ -0,0 +1,29 @@
+module Checks
+  module Mongo
+    class DBUp < ForemanMaintain::Check
+      metadata do
+        description 'Make sure Mongo DB is up'
+        label :mongo_db_up
+        for_feature :mongo
+      end
+
+      def run
+        status = false
+        with_spinner('Checking connection to the Mongo DB') do
+          status = feature(:mongo).ping
+        end
+        assert(status, 'Mongo DB is not responding. ' \
+          'It needs to be up and running to perform the following steps.',
+               :next_steps => next_steps)
+      end
+
+      def next_steps
+        if feature(:mongo).local?
+          [Procedures::Service::Start.new(:only => 'mongod')]
+        else
+          [] # there is nothing we can do for remote db
+        end
+      end
+    end
+  end
+end

data/definitions/checks/mongo/tools_installed.rb

@@ -0,0 +1,31 @@
+module Checks::Mongo
+  class ToolsInstalled < ForemanMaintain::Check
+    metadata do
+      manual_detection
+      description 'Checks whether the tools for Mongo DB are installed'
+      for_feature :mongo
+    end
+
+    def run
+      if feature(:mongo).server_version =~ /^3\.4/
+        tools_pkg = 'rh-mongodb34-mongo-tools'
+        result = find_package(tools_pkg)
+      else
+        result = execute?('which mongodump')
+        tools_pkg = 'mongodb'
+      end
+      handle_result(result, tools_pkg)
+    end
+
+    private
+
+    def handle_result(result, tools_pkg)
+      assert(result,
+             "#{tools_pkg} was not found among installed package.\nThis package is needed to " \
+               'do various operations such as backup, restore and import with Mongo DB.',
+             :next_steps => [
+               Procedures::Packages::Install.new(:packages => [tools_pkg])
+             ])
+    end
+  end
+end

data/definitions/checks/repositories/validate.rb

@@ -2,9 +2,6 @@ module Checks::Repositories
   class Validate < ForemanMaintain::Check
     metadata do
       description 'Validate availability of repositories'
-      preparation_steps do
-        Procedures::Packages::Install.new(:packages => [ForemanMaintain::Utils::Facter.package])
-      end
 
       confine do
         feature(:downstream)

data/definitions/checks/root_user.rb

@@ -0,0 +1,12 @@
+class Checks::RootUser < ForemanMaintain::Check
+  metadata do
+    label :root_user
+    tags :root_user
+    description 'Check if command is run as root user'
+  end
+
+  def run
+    is_root_user = Process.uid == 0
+    assert(is_root_user, 'This command needs to be run as the root user')
+  end
+end

data/definitions/features/candlepin.rb

@@ -0,0 +1,16 @@
+class Features::Candlepin < ForemanMaintain::Feature
+  metadata do
+    label :candlepin
+
+    confine do
+      find_package('candlepin')
+    end
+  end
+
+  def services
+    {
+      'tomcat' => 20,
+      'tomcat6' => 20
+    }
+  end
+end

data/definitions/features/candlepin_database.rb

@@ -48,13 +48,15 @@ class Features::CandlepinDatabase < ForemanMaintain::Feature
   def load_configuration
     raw_config = File.read(CANDLEPIN_DB_CONFIG)
     full_config = Hash[raw_config.scan(/(^[^#\n][^=]*)=(.*)/)]
-    uri = %r{://(([^/:]*):?([^/]*))/(.*)}.match(full_config['jpa.config.hibernate.connection.url'])
+    uri_regexp = %r{://(([^/:]*):?([^/]*))/([^?]*)\??(ssl=([^&]*))?}
+    uri = uri_regexp.match(full_config['jpa.config.hibernate.connection.url'])
     @configuration = {
       'username' => full_config['jpa.config.hibernate.connection.username'],
       'password' => full_config['jpa.config.hibernate.connection.password'],
       'database' => uri[4],
       'host' => uri[2],
       'port' => uri[3] || '5432',
+      'ssl' => (uri[6] == 'true'),
       'driver_class' => full_config['jpa.config.hibernate.connection.driver_class'],
       'url' => full_config['jpa.config.hibernate.connection.url']
     }

data/definitions/features/downstream.rb

@@ -7,6 +7,14 @@ class Features::Downstream < ForemanMaintain::Feature
     end
   end
 
+  def less_than_version?(version)
+    Gem::Version.new(current_version) < Gem::Version.new(version)
+  end
+
+  def at_least_version?(version)
+    Gem::Version.new(current_version) >= Gem::Version.new(version)
+  end
+
   def current_version
     @current_version ||= rpm_version('satellite') || version_from_source
   end
@@ -46,32 +54,23 @@ class Features::Downstream < ForemanMaintain::Feature
 
   def rh_repos(sat_version)
     sat_version = version(sat_version)
-    rh_version_major = ForemanMaintain::Utils::Facter.os_major_release
-
-    rh_repos = main_rh_repos(rh_version_major)
-
-    rh_repos.concat(sat_and_tools_repos(rh_version_major, sat_version))
-
-    if current_minor_version == '6.3' && sat_version.to_s != '6.4' && (
-      feature(:puppet_server) && feature(:puppet_server).puppet_version.major == 4)
-      rh_repos << "rhel-#{rh_version_major}-server-satellite-tools-6.3-puppet4-rpms"
-    end
-
-    rh_repos
-  end
-
-  def sat_and_tools_repos(rh_version_major, sat_version)
+    rh_version_major = execute!('facter operatingsystemmajrelease')
     sat_version_full = "#{sat_version.major}.#{sat_version.minor}"
+
     sat_repo_id = "rhel-#{rh_version_major}-server-satellite-#{sat_version_full}-rpms"
     sat_tools_repo_id = "rhel-#{rh_version_major}-server-satellite-tools-#{sat_version_full}-rpms"
+    # Override to use Beta repositories for 6.4 until GA
+    if sat_version.to_s == '6.4'
+      sat_repo_id = "rhel-server-#{rh_version_major}-satellite-6-beta-rpms"
+    end
 
-    [sat_repo_id, sat_tools_repo_id]
-  end
-
-  def main_rh_repos(rh_version_major)
-    ["rhel-#{rh_version_major}-server-rpms",
-     "rhel-server-rhscl-#{rh_version_major}-rpms",
-     "rhel-#{rh_version_major}-server-satellite-maintenance-6-rpms"]
+    rh_repos = ["rhel-#{rh_version_major}-server-rpms",
+                "rhel-server-rhscl-#{rh_version_major}-rpms",
+                "rhel-#{rh_version_major}-server-satellite-maintenance-6-rpms",
+                sat_tools_repo_id,
+                sat_repo_id]
+    rh_repos << 'rhel-7-server-ansible-2-rpms' if sat_version.to_s == '6.4'
+    rh_repos
   end
 
   def version_from_source

data/definitions/features/foreman_database.rb

@@ -20,5 +20,7 @@ class Features::ForemanDatabase < ForemanMaintain::Feature
   def load_configuration
     config = YAML.load(File.read(FOREMAN_DB_CONFIG))
     @configuration = config['production']
+    @configuration['host'] ||= 'localhost'
+    @configuration
   end
 end