Module: Beaker::DSL::InstallUtils::PEUtils
- Included in:
- Beaker::DSL::InstallUtils
- Defined in:
- lib/beaker/dsl/install_utils/pe_utils.rb
Overview
This module contains methods to help installing/upgrading PE builds - including Higgs installs
To mix this is into a class you need the following:
-
a method hosts that yields any hosts implementing Host‘s interface to act upon.
-
a method options that provides an options hash, see Options::OptionsHash
-
the module Roles that provides access to the various hosts implementing Host‘s interface to act upon
-
the module Wrappers the provides convenience methods for Command creation
Instance Method Summary collapse
-
#deploy_frictionless_to_master(host) ⇒ Object
private
Classify the master so that it can deploy frictionless packages for a given host.
-
#do_higgs_install(host, opts) ⇒ Object
private
Perform a Puppet Enterprise Higgs install up until web browser interaction is required, runs on linux hosts only.
-
#do_install(hosts, opts = {}) ⇒ Object
private
Perform a Puppet Enterprise upgrade or install.
-
#fetch_pe(hosts, opts) ⇒ Object
private
Determine the PE package to download/upload per-host, download/upload that package onto the host and unpack it.
-
#fetch_pe_on_mac(host, opts) ⇒ Object
private
Determine the PE package to download/upload on a mac host, download/upload that package onto the host.
-
#fetch_pe_on_unix(host, opts) ⇒ Object
private
Determine the PE package to download/upload on a unix style host, download/upload that package onto the host and unpack it.
-
#fetch_pe_on_windows(host, opts) ⇒ Object
private
Determine the PE package to download/upload on a windows host, download/upload that package onto the host.
-
#higgs_installer_cmd(host) ⇒ Object
private
Create the Higgs install command string based upon the host and options settings.
-
#install_higgs(higgs_host = master) ⇒ Object
Install Higgs up till the point where you need to continue installation in a web browser, defaults to execution on the master node.
-
#install_pe ⇒ Object
Install PE based upon host configuration and options.
-
#installer_cmd(host, opts) ⇒ Object
private
Create the PE install command string based upon the host and options settings.
-
#upgrade_pe(path = nil) ⇒ Object
Upgrade PE based upon host configuration and options.
Instance Method Details
#deploy_frictionless_to_master(host) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Classify the master so that it can deploy frictionless packages for a given host.
221 222 223 224 225 226 227 228 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 221 def deploy_frictionless_to_master(host) klass = host['platform'].gsub(/-/, '_').gsub(/\./,'') klass = "pe_repo::platform::#{klass}" on dashboard, "cd /opt/puppet/share/puppet-dashboard && /opt/puppet/bin/bundle exec /opt/puppet/bin/rake nodeclass:add[#{klass},skip]" on dashboard, "cd /opt/puppet/share/puppet-dashboard && /opt/puppet/bin/bundle exec /opt/puppet/bin/rake node:add[#{master},,,skip]" on dashboard, "cd /opt/puppet/share/puppet-dashboard && /opt/puppet/bin/bundle exec /opt/puppet/bin/rake node:addclass[#{master},#{klass}]" on master, puppet("agent -t"), :acceptable_exit_codes => [0,2] end |
#do_higgs_install(host, opts) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Perform a Puppet Enterprise Higgs install up until web browser interaction is required, runs on linux hosts only.
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 458 def do_higgs_install host, opts use_all_tar = ENV['PE_USE_ALL_TAR'] == 'true' platform = use_all_tar ? 'all' : host['platform'] version = host['pe_ver'] || opts[:pe_ver] host['dist'] = "puppet-enterprise-#{version}-#{platform}" use_all_tar = ENV['PE_USE_ALL_TAR'] == 'true' host['pe_installer'] ||= 'puppet-enterprise-installer' host['working_dir'] = host.tmpdir(Time.new.strftime("%Y-%m-%d_%H.%M.%S")) fetch_pe([host], opts) host['higgs_file'] = "higgs_#{File.basename(host['working_dir'])}.log" on host, higgs_installer_cmd(host), opts #wait for output to host['higgs_file'] #we're all done when we find this line in the PE installation log higgs_re = /Please\s+go\s+to\s+https:\/\/.*\s+in\s+your\s+browser\s+to\s+continue\s+installation/m res = Result.new(host, 'tmp cmd') tries = 10 attempts = 0 prev_sleep = 0 cur_sleep = 1 while (res.stdout !~ higgs_re) and (attempts < tries) res = on host, "cd #{host['working_dir']}/#{host['dist']} && cat #{host['higgs_file']}", :acceptable_exit_codes => (0..255) attempts += 1 sleep( cur_sleep ) prev_sleep = cur_sleep cur_sleep = cur_sleep + prev_sleep end if attempts >= tries raise "Failed to kick off PE (Higgs) web installation" end end |
#do_install(hosts, opts = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Perform a Puppet Enterprise upgrade or install
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 249 def do_install hosts, opts = {} masterless = (defined? ) ? [:masterless] : false opts[:masterless] = masterless # has to pass masterless down for answer generation awareness opts[:type] = opts[:type] || :install unless masterless pre30database = version_is_less(opts[:pe_ver] || database['pe_ver'], '3.0') pre30master = version_is_less(opts[:pe_ver] || master['pe_ver'], '3.0') unless version_is_less(opts[:pe_ver] || master['pe_ver'], '3.4') master['puppetservice'] = 'pe-puppetserver' end end # Set PE distribution for all the hosts, create working dir use_all_tar = ENV['PE_USE_ALL_TAR'] == 'true' hosts.each do |host| host['pe_installer'] ||= 'puppet-enterprise-installer' if host['platform'] !~ /windows|osx/ platform = use_all_tar ? 'all' : host['platform'] version = host['pe_ver'] || opts[:pe_ver] host['dist'] = "puppet-enterprise-#{version}-#{platform}" elsif host['platform'] =~ /osx/ version = host['pe_ver'] || opts[:pe_ver] host['dist'] = "puppet-enterprise-#{version}-#{host['platform']}" elsif host['platform'] =~ /windows/ version = host[:pe_ver] || opts['pe_ver_win'] should_install_64bit = !(version_is_less(version, '3.4')) && host.is_x86_64? && !host['install_32'] && !opts['install_32'] #only install 64bit builds if # - we are on pe version 3.4+ # - we do not have install_32 set on host # - we do not have install_32 set globally if !(version_is_less(version, '4.0')) if should_install_64bit host['dist'] = "puppet-agent-#{version}-x64" else host['dist'] = "puppet-agent-#{version}-x86" end elsif should_install_64bit host['dist'] = "puppet-enterprise-#{version}-x64" else host['dist'] = "puppet-enterprise-#{version}" end end host['working_dir'] = host.tmpdir(Time.new.strftime("%Y-%m-%d_%H.%M.%S")) end fetch_pe(hosts, opts) install_hosts = hosts.dup unless masterless # If we're installing a database version less than 3.0, ignore the database host install_hosts.delete(database) if pre30database and database != master and database != dashboard end install_hosts.each do |host| if host['platform'] =~ /windows/ on host, installer_cmd(host, opts) if not host.is_cygwin? # HACK: for some reason, post install we need to refresh the connection to make puppet available for execution host.close end else # We only need answers if we're using the classic installer version = host['pe_ver'] || opts[:pe_ver] if host['roles'].include?('frictionless') && (! version_is_less(version, '3.2.0')) # If We're *not* running the classic installer, we want # to make sure the master has packages for us. deploy_frictionless_to_master(host) on host, installer_cmd(host, opts) elsif host['platform'] =~ /osx|eos/ # If we're not frictionless, we need to run the OSX special-case on host, installer_cmd(host, opts) #set the certname and master on host, puppet("config set server #{master}") on host, puppet("config set certname #{host}") #run once to request cert acceptable_codes = host['platform'] =~ /osx/ ? [1] : [0, 1] on host, puppet_agent('-t'), :acceptable_exit_codes => acceptable_codes else answers = Beaker::Answers.create(opts[:pe_ver] || host['pe_ver'], hosts, opts) create_remote_file host, "#{host['working_dir']}/answers", answers.answer_string(host) on host, installer_cmd(host, opts) end end # On each agent, we ensure the certificate is signed then shut down the agent sign_certificate_for(host) unless masterless stop_agent_on(host) end unless masterless # Wait for PuppetDB to be totally up and running (post 3.0 version of pe only) sleep_until_puppetdb_started(database) unless pre30database # Run the agent once to ensure everything is in the dashboard install_hosts.each do |host| on host, puppet_agent('-t'), :acceptable_exit_codes => [0,2] # Workaround for PE-1105 when deploying 3.0.0 # The installer did not respect our database host answers in 3.0.0, # and would cause puppetdb to be bounced by the agent run. By sleeping # again here, we ensure that if that bounce happens during an upgrade # test we won't fail early in the install process. if host['pe_ver'] == '3.0.0' and host == database sleep_until_puppetdb_started(database) end end install_hosts.each do |host| wait_for_host_in_dashboard(host) end if pre30master task = 'nodegroup:add_all_nodes group=default' else task = 'defaultgroup:ensure_default_group' end on dashboard, "/opt/puppet/bin/rake -sf /opt/puppet/share/puppet-dashboard/Rakefile #{task} RAILS_ENV=production" # Now that all hosts are in the dashbaord, run puppet one more # time to configure mcollective on install_hosts, puppet_agent('-t'), :acceptable_exit_codes => [0,2] end end |
#fetch_pe(hosts, opts) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Determine the PE package to download/upload per-host, download/upload that package onto the host and unpack it.
203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 203 def fetch_pe(hosts, opts) hosts.each do |host| # We install Puppet from the master for frictionless installs, so we don't need to *fetch* anything next if host['roles'].include?('frictionless') && (! version_is_less(opts[:pe_ver] || host['pe_ver'], '3.2.0')) if host['platform'] =~ /windows/ fetch_pe_on_windows(host, opts) elsif host['platform'] =~ /osx/ fetch_pe_on_mac(host, opts) else fetch_pe_on_unix(host, opts) end end end |
#fetch_pe_on_mac(host, opts) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Determine the PE package to download/upload on a mac host, download/upload that package onto the host. Assumed file name format: puppet-enterprise-3.3.0-rc1-559-g97f0833-osx-10.9-x86_64.dmg.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 96 def fetch_pe_on_mac(host, opts) path = host['pe_dir'] || opts[:pe_dir] local = File.directory?(path) filename = "#{host['dist']}" extension = ".dmg" if local if not File.exists?("#{path}/#{filename}#{extension}") raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" end scp_to host, "#{path}/#{filename}#{extension}", "#{host['working_dir']}/#{filename}#{extension}" else if not link_exists?("#{path}/#{filename}#{extension}") raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" end on host, "cd #{host['working_dir']}; curl -O #{path}/#{filename}#{extension}" end end |
#fetch_pe_on_unix(host, opts) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Determine the PE package to download/upload on a unix style host, download/upload that package onto the host and unpack it.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 154 def fetch_pe_on_unix(host, opts) path = host['pe_dir'] || opts[:pe_dir] local = File.directory?(path) filename = "#{host['dist']}" if local extension = File.exists?("#{path}/#{filename}.tar.gz") ? ".tar.gz" : ".tar" if not File.exists?("#{path}/#{filename}#{extension}") raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" end scp_to host, "#{path}/#{filename}#{extension}", "#{host['working_dir']}/#{filename}#{extension}" if extension =~ /gz/ on host, "cd #{host['working_dir']}; gunzip #{filename}#{extension}" end if extension =~ /tar/ on host, "cd #{host['working_dir']}; tar -xvf #{filename}.tar" end else if host['platform'] =~ /eos/ extension = '.swix' else extension = link_exists?("#{path}/#{filename}.tar.gz") ? ".tar.gz" : ".tar" end if not link_exists?("#{path}/#{filename}#{extension}") raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" end if host['platform'] =~ /eos/ commands = ['enable', "copy #{path}/#{filename}#{extension} extension:"] command = commands.join("\n") on host, "Cli -c '#{command}'" else unpack = 'tar -xvf -' unpack = extension =~ /gz/ ? 'gunzip | ' + unpack : unpack on host, "cd #{host['working_dir']}; curl #{path}/#{filename}#{extension} | #{unpack}" end end end |
#fetch_pe_on_windows(host, opts) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Determine the PE package to download/upload on a windows host, download/upload that package onto the host. Assumed file name format: puppet-enterprise-3.3.0-rc1-559-g97f0833.msi
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 123 def fetch_pe_on_windows(host, opts) path = host['pe_dir'] || opts[:pe_dir] local = File.directory?(path) version = host['pe_ver'] || opts[:pe_ver_win] filename = "#{host['dist']}" extension = ".msi" if local if not File.exists?("#{path}/#{filename}#{extension}") raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" end scp_to host, "#{path}/#{filename}#{extension}", "#{host['working_dir']}/#{filename}#{extension}" else if not link_exists?("#{path}/#{filename}#{extension}") raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" end if host.is_cygwin? on host, "cd #{host['working_dir']}; curl -O #{path}/#{filename}#{extension}" else on host, powershell("$webclient = New-Object System.Net.WebClient; $webclient.DownloadFile('#{path}/#{filename}#{extension}','#{host['wor king_dir']}\\#{filename}#{extension}')") end end end |
#higgs_installer_cmd(host) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Create the Higgs install command string based upon the host and options settings. Installation command will be run as a background process. The output of the command will be stored in the provided host.
438 439 440 441 442 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 438 def higgs_installer_cmd host "cd #{host['working_dir']}/#{host['dist']} ; nohup ./#{host['pe_installer']} <<<Y > #{host['higgs_file']} 2>&1 &" end |
#install_higgs(higgs_host = master) ⇒ Object
Either pe_ver and pe_dir should be set in the ENV or each host should have pe_ver and pe_dir set individually. Install file names are assumed to be of the format puppet-enterprise-VERSION-PLATFORM.(tar)|(tar.gz).
Install Higgs up till the point where you need to continue installation in a web browser, defaults to execution on the master node.
503 504 505 506 507 508 509 510 511 512 513 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 503 def install_higgs( higgs_host = master ) #process the version files if necessary master['pe_dir'] ||= [:pe_dir] master['pe_ver'] = master['pe_ver'] || ['pe_ver'] || Beaker::Options::PEVersionScraper.load_pe_version(master[:pe_dir] || [:pe_dir], [:pe_version_file]) if higgs_host['platform'] =~ /osx|windows/ raise "Attempting higgs installation on host #{higgs_host.name} with unsupported platform #{higgs_host['platform']}" end #send in the global options hash do_higgs_install higgs_host, end |
#install_pe ⇒ Object
Either pe_ver and pe_dir should be set in the ENV or each host should have pe_ver and pe_dir set individually. Install file names are assumed to be of the format puppet-enterprise-VERSION-PLATFORM.(tar)|(tar.gz) for Unix like systems and puppet-enterprise-VERSION.msi for Windows systems.
Install PE based upon host configuration and options
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 382 def install_pe #process the version files if necessary hosts.each do |host| host['pe_dir'] ||= [:pe_dir] if host['platform'] =~ /windows/ host['pe_ver'] = host['pe_ver'] || ['pe_ver'] || Beaker::Options::PEVersionScraper.load_pe_version(host[:pe_dir] || [:pe_dir], [:pe_version_file_win]) else host['pe_ver'] = host['pe_ver'] || ['pe_ver'] || Beaker::Options::PEVersionScraper.load_pe_version(host[:pe_dir] || [:pe_dir], [:pe_version_file]) end end #send in the global options hash do_install sorted_hosts, end |
#installer_cmd(host, opts) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Create the PE install command string based upon the host and options settings
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 48 def installer_cmd(host, opts) version = host['pe_ver'] || opts[:pe_ver] if host['platform'] =~ /windows/ log_file = "#{File.basename(host['working_dir'])}.log" pe_debug = host[:pe_debug] || opts[:pe_debug] ? " && cat #{log_file}" : '' if host.is_cygwin? "cd #{host['working_dir']} && cmd /C 'start /w msiexec.exe /qn /L*V #{log_file} /i #{host['dist']}.msi PUPPET_MASTER_SERVER=#{master} PUPPET_AGENT_CERTNAME=#{host}'#{pe_debug}" else "cd #{host['working_dir']} && msiexec.exe /qn /L*V #{log_file} /i #{host['dist']}.msi PUPPET_MASTER_SERVER=#{master} PUPPET_AGENT_CERTNAME=#{host}#{pe_debug}" end # Frictionless install didn't exist pre-3.2.0, so in that case we fall # through and do a regular install. elsif host['roles'].include? 'frictionless' and ! version_is_less(version, '3.2.0') # PE 3.4 introduced the ability to pass in config options to the bash script in the form # of <section>:<key>=<value> frictionless_install_opts = [] if host.has_key?('frictionless_options') and ! version_is_less(version, '3.4.0') # since we have options to pass in, we need to tell the bash script host['frictionless_options'].each do |section, settings| settings.each do |key, value| frictionless_install_opts << "#{section}:#{key}=#{value}" end end end pe_debug = host[:pe_debug] || opts[:pe_debug] ? ' -x' : '' "cd #{host['working_dir']} && curl --tlsv1 -kO https://#{master}:8140/packages/#{version}/install.bash && bash#{pe_debug} install.bash #{frictionless_install_opts.join(' ')}".strip elsif host['platform'] =~ /osx/ version = host['pe_ver'] || opts[:pe_ver] pe_debug = host[:pe_debug] || opts[:pe_debug] ? ' -verboseR' : '' "cd #{host['working_dir']} && hdiutil attach #{host['dist']}.dmg && installer#{pe_debug} -pkg /Volumes/puppet-enterprise-#{version}/puppet-enterprise-installer-#{version}.pkg -target /" elsif host['platform'] =~ /eos/ commands = ['enable', "extension puppet-enterprise-#{version}-#{host['platform']}.swix"] command = commands.join("\n") "Cli -c '#{command}'" else pe_debug = host[:pe_debug] || opts[:pe_debug] ? ' -D' : '' "cd #{host['working_dir']}/#{host['dist']} && ./#{host['pe_installer']}#{pe_debug} -a #{host['working_dir']}/answers" end end |
#upgrade_pe(path = nil) ⇒ Object
Install file names are assumed to be of the format puppet-enterprise-VERSION-PLATFORM.(tar)|(tar.gz) for Unix like systems and puppet-enterprise-VERSION.msi for Windows systems.
Upgrade PE based upon host configuration and options
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 |
# File 'lib/beaker/dsl/install_utils/pe_utils.rb', line 408 def upgrade_pe path=nil set_console_password = false # if we are upgrading from something lower than 3.4 then we need to set the pe console password if (dashboard[:pe_ver] ? version_is_less(dashboard[:pe_ver], "3.4.0") : true) set_console_password = true end # get new version information hosts.each do |host| host['pe_dir'] = host['pe_upgrade_dir'] || path if host['platform'] =~ /windows/ host['pe_ver'] = host['pe_upgrade_ver'] || ['pe_upgrade_ver'] || Options::PEVersionScraper.load_pe_version(host['pe_dir'], [:pe_version_file_win]) else host['pe_ver'] = host['pe_upgrade_ver'] || ['pe_upgrade_ver'] || Options::PEVersionScraper.load_pe_version(host['pe_dir'], [:pe_version_file]) end if version_is_less(host['pe_ver'], '3.0') host['pe_installer'] ||= 'puppet-enterprise-upgrader' end end # send in the global options hash do_install(sorted_hosts, .merge({:type => :upgrade, :set_console_password => set_console_password})) ['upgrade'] = true end |