Module: ForemanMaintain
- Extended by:
- Concerns::PrimaryChecks
- Defined in:
- lib/foreman_maintain.rb,
lib/foreman_maintain/cli.rb,
lib/foreman_maintain/check.rb,
lib/foreman_maintain/error.rb,
lib/foreman_maintain/param.rb,
lib/foreman_maintain/config.rb,
lib/foreman_maintain/runner.rb,
lib/foreman_maintain/context.rb,
lib/foreman_maintain/feature.rb,
lib/foreman_maintain/version.rb,
lib/foreman_maintain/cli/base.rb,
lib/foreman_maintain/core_ext.rb,
lib/foreman_maintain/detector.rb,
lib/foreman_maintain/reporter.rb,
lib/foreman_maintain/scenario.rb,
lib/foreman_maintain/procedure.rb,
lib/foreman_maintain/csv_parser.rb,
lib/foreman_maintain/executable.rb,
lib/foreman_maintain/utils/bash.rb,
lib/foreman_maintain/utils/backup.rb,
lib/foreman_maintain/yaml_storage.rb,
lib/foreman_maintain/upgrade_runner.rb,
lib/foreman_maintain/utils/response.rb,
lib/foreman_maintain/concerns/hammer.rb,
lib/foreman_maintain/concerns/logger.rb,
lib/foreman_maintain/package_manager.rb,
lib/foreman_maintain/concerns/finders.rb,
lib/foreman_maintain/dependency_graph.rb,
lib/foreman_maintain/runner/execution.rb,
lib/foreman_maintain/utils/disk/stats.rb,
lib/foreman_maintain/concerns/metadata.rb,
lib/foreman_maintain/concerns/os_facts.rb,
lib/foreman_maintain/concerns/reporter.rb,
lib/foreman_maintain/utils/disk/device.rb,
lib/foreman_maintain/cli/backup_command.rb,
lib/foreman_maintain/cli/health_command.rb,
lib/foreman_maintain/cli/plugin_command.rb,
lib/foreman_maintain/cli/content_command.rb,
lib/foreman_maintain/cli/restore_command.rb,
lib/foreman_maintain/cli/service_command.rb,
lib/foreman_maintain/cli/upgrade_command.rb,
lib/foreman_maintain/concerns/downstream.rb,
lib/foreman_maintain/utils/curl_response.rb,
lib/foreman_maintain/cli/advanced_command.rb,
lib/foreman_maintain/cli/packages_command.rb,
lib/foreman_maintain/concerns/pulp_common.rb,
lib/foreman_maintain/utils/command_runner.rb,
lib/foreman_maintain/utils/disk/io_device.rb,
lib/foreman_maintain/utils/system_helpers.rb,
lib/foreman_maintain/reporter/cli_reporter.rb,
lib/foreman_maintain/utils/disk/nil_device.rb,
lib/foreman_maintain/concerns/base_database.rb,
lib/foreman_maintain/concerns/primary_checks.rb,
lib/foreman_maintain/concerns/system_helpers.rb,
lib/foreman_maintain/concerns/system_service.rb,
lib/foreman_maintain/runner/stored_execution.rb,
lib/foreman_maintain/cli/self_upgrade_command.rb,
lib/foreman_maintain/concerns/directory_marker.rb,
lib/foreman_maintain/concerns/scenario_metadata.rb,
lib/foreman_maintain/cli/transform_clamp_options.rb,
lib/foreman_maintain/cli/maintenance_mode_command.rb,
lib/foreman_maintain/cli/advanced/procedure_command.rb,
lib/foreman_maintain/cli/advanced/procedure/run_command.rb,
lib/foreman_maintain/cli/advanced/prebuild_bash_completion.rb,
lib/foreman_maintain/cli/advanced/procedure/by_tag_command.rb,
lib/foreman_maintain/cli/advanced/procedure/abstract_by_tag_command.rb,
lib/foreman_maintain/cli/advanced/procedure/abstract_procedure_command.rb
Defined Under Namespace
Modules: Cli, Concerns, CoreExt, Error, PackageManager, Utils
Classes: CSVParser, Check, Config, Context, DependencyGraph, Detector, Executable, Feature, HammerConfigurationError, Param, Procedure, Reporter, Runner, Scenario, UpgradeRunner, YamlStorage
Constant Summary
collapse
- LOGGER_LEVEL_MAPPING =
{
'debug' => ::Logger::DEBUG,
'info' => ::Logger::INFO,
'warn' => ::Logger::WARN,
'error' => ::Logger::ERROR,
'fatal' => ::Logger::FATAL,
'unknown' => ::Logger::UNKNOWN
}.freeze
- VERSION =
'1.0.0'.freeze
Class Attribute Summary collapse
Class Method Summary
collapse
package_name, validate_downstream_packages
Class Attribute Details
.config ⇒ Object
Returns the value of attribute config.
48
49
50
|
# File 'lib/foreman_maintain.rb', line 48
def config
@config
end
|
.logger ⇒ Object
Returns the value of attribute logger.
48
49
50
|
# File 'lib/foreman_maintain.rb', line 48
def logger
@logger
end
|
Class Method Details
.allowed_available_procedures(*args) ⇒ Object
130
131
132
133
|
# File 'lib/foreman_maintain.rb', line 130
def allowed_available_procedures(*args)
procedures = detector.available_procedures(*args)
procedures.select(&:advanced_run?)
end
|
.available_checks(*args) ⇒ Object
122
123
124
|
# File 'lib/foreman_maintain.rb', line 122
def available_checks(*args)
detector.available_checks(*args)
end
|
.available_features(*args) ⇒ Object
114
115
116
|
# File 'lib/foreman_maintain.rb', line 114
def available_features(*args)
detector.available_features(*args)
end
|
.available_procedures(*args) ⇒ Object
126
127
128
|
# File 'lib/foreman_maintain.rb', line 126
def available_procedures(*args)
detector.available_procedures(*args)
end
|
.available_scenarios(*args) ⇒ Object
118
119
120
|
# File 'lib/foreman_maintain.rb', line 118
def available_scenarios(*args)
detector.available_scenarios(*args)
end
|
.cache ⇒ Object
98
99
100
|
# File 'lib/foreman_maintain.rb', line 98
def cache
ObjectCache.instance
end
|
.config_file ⇒ Object
84
85
86
|
# File 'lib/foreman_maintain.rb', line 84
def config_file
config.config_file
end
|
.detector ⇒ Object
102
103
104
|
# File 'lib/foreman_maintain.rb', line 102
def detector
@detector ||= Detector.new
end
|
.init_logger ⇒ Object
135
136
137
138
139
140
141
142
143
|
# File 'lib/foreman_maintain.rb', line 135
def init_logger
log_fsize = config.log_file_size.to_i * 1024
@logger = Logger.new(config.log_filename, 10, log_fsize).tap do |logger|
logger.level = LOGGER_LEVEL_MAPPING[config.log_level] || Logger::DEBUG
logger.datetime_format = '%Y-%m-%d %H:%M:%S%z '
end
pickup_log_messages
end
|
.load_definitions ⇒ Object
88
89
90
91
92
93
94
95
96
|
# File 'lib/foreman_maintain.rb', line 88
def load_definitions
$LOAD_PATH.concat(config.definitions_dirs)
config.definitions_dirs.each do |definitions_dir|
file_paths = File.expand_path(File.join(definitions_dir, '**', '*.rb'))
Dir.glob(file_paths).each { |f| require f }
end
end
|
.main_package_name ⇒ Object
184
185
186
|
# File 'lib/foreman_maintain.rb', line 184
def main_package_name
'rubygem-foreman_maintain'
end
|
.package_manager ⇒ Object
6
7
8
9
10
11
12
13
14
15
|
# File 'lib/foreman_maintain/package_manager.rb', line 6
def self.package_manager
@package_manager ||= case (%w[dnf yum apt].find { |manager| !`command -v #{manager}`.empty? })
when 'dnf'
ForemanMaintain::PackageManager::Dnf.new
when 'yum'
ForemanMaintain::PackageManager::Yum.new
else
raise 'No supported package manager was found'
end
end
|
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# File 'lib/foreman_maintain.rb', line 170
def perform_self_upgrade
package_name, command = pkg_and_cmd_name
puts "Checking for new version of #{package_name}..."
if ForemanMaintain.package_manager.update_available?(main_package_name)
puts "\nUpdating #{package_name} package."
ForemanMaintain.package_manager.update(main_package_name, :assumeyes => true)
puts "\nThe #{package_name} package successfully updated."\
"\nRe-run #{command} with required options!"
exit 75
end
puts "Nothing to update, can't find new version of #{package_name}."
end
|
.pickup_log_messages ⇒ Object
145
146
147
148
149
|
# File 'lib/foreman_maintain.rb', line 145
def pickup_log_messages
return if config.pre_setup_log_messages.empty?
config.pre_setup_log_messages.each { |msg| logger.info msg }
config.pre_setup_log_messages.clear
end
|
.pkg_and_cmd_name ⇒ Object
161
162
163
164
165
166
167
168
|
# File 'lib/foreman_maintain.rb', line 161
def pkg_and_cmd_name
instance_feature = ForemanMaintain.available_features(:label => :instance).first
if instance_feature.downstream
return instance_feature.downstream.fm_pkg_and_cmd_name
end
[main_package_name, 'foreman-maintain']
end
|
.refresh_features ⇒ Object
106
107
108
|
# File 'lib/foreman_maintain.rb', line 106
def refresh_features
@detector = Detector.new
end
|
.set_home_environment ⇒ Object
69
70
71
|
# File 'lib/foreman_maintain.rb', line 69
def set_home_environment
ENV['HOME'] ||= '/root'
end
|
.setup(options = {}) ⇒ Object
59
60
61
62
63
64
65
66
67
|
# File 'lib/foreman_maintain.rb', line 59
def setup(options = {})
set_home_environment
self.config = Config.new(options)
load_definitions
init_logger
update_path
end
|
.storage(label = :default) ⇒ Object
151
152
153
154
155
|
# File 'lib/foreman_maintain.rb', line 151
def storage(label = :default)
ForemanMaintain::YamlStorage.load(label)
rescue StandardError => e
logger.error "Invalid Storage label i.e #{label}. Error - #{e.message}"
end
|
.update_path ⇒ Object
Appending PATH with expected paths needed for commands we run
74
75
76
77
78
79
80
81
82
|
# File 'lib/foreman_maintain.rb', line 74
def update_path
paths = ['/sbin']
existing_paths = ENV['PATH'].split(':')
paths -= existing_paths
if paths.any?
paths = paths.join(':').chomp(':')
ENV['PATH'] = "#{ENV['PATH']}:#{paths}"
end
end
|
.upgrade_in_progress ⇒ Object
157
158
159
|
# File 'lib/foreman_maintain.rb', line 157
def upgrade_in_progress
storage[:upgrade_target_version]
end
|