cookbooks/hardware/recipes/default.rb

   1 #
   2 # Cookbook:: hardware
   3 # Recipe:: default
   4 #
   5 # Copyright:: 2012, OpenStreetMap Foundation
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 #     https://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19
  20 include_recipe "apt"
  21 include_recipe "git"
  22 include_recipe "munin"
  23 include_recipe "prometheus"
  24 include_recipe "sysfs"
  25 include_recipe "tools"
  26
  27 ohai_plugin "hardware" do
  28   template "ohai.rb.erb"
  29 end
  30
  31 case node[:cpu][:"0"][:vendor_id]
  32 when "GenuineIntel"
  33   package "intel-microcode"
  34 when "AuthenticAMD"
  35   package "amd64-microcode"
  36 end
  37
  38 if node[:dmi] && node[:dmi][:system]
  39   case node[:dmi][:system][:manufacturer]
  40   when "empty"
  41     manufacturer = node[:dmi][:base_board][:manufacturer]
  42     product = node[:dmi][:base_board][:product_name]
  43   else
  44     manufacturer = node[:dmi][:system][:manufacturer]
  45     product = node[:dmi][:system][:product_name]
  46   end
  47 else
  48   manufacturer = "Unknown"
  49   product = "Unknown"
  50 end
  51
  52 units = []
  53
  54 if node[:roles].include?("bytemark") || node[:roles].include?("exonetric") || node[:roles].include?("prgmr")
  55   units << "0"
  56 end
  57
  58 case manufacturer
  59 when "HP"
  60   package "hponcfg"
  61
  62   execute "update-ilo" do
  63     action :nothing
  64     command "/usr/sbin/hponcfg -f /etc/ilo-defaults.xml"
  65   end
  66
  67   template "/etc/ilo-defaults.xml" do
  68     source "ilo-defaults.xml.erb"
  69     owner "root"
  70     group "root"
  71     mode "644"
  72     notifies :run, "execute[update-ilo]"
  73   end
  74
  75   package "hp-health" do
  76     action :install
  77     notifies :restart, "service[hp-health]"
  78     only_if { node[:lsb][:release].to_f < 22.04 }
  79   end
  80
  81   service "hp-health" do
  82     action [:enable, :start]
  83     supports :status => true, :restart => true
  84     only_if { node[:lsb][:release].to_f < 22.04 }
  85   end
  86
  87   if product.end_with?("Gen8", "Gen9")
  88     package "hp-ams" do
  89       action :install
  90       notifies :restart, "service[hp-ams]"
  91     end
  92
  93     service "hp-ams" do
  94       action [:enable, :start]
  95       supports :status => true, :restart => true
  96     end
  97   end
  98
  99   units << "1"
 100 when "TYAN"
 101   units << "0"
 102 when "TYAN Computer Corporation"
 103   units << "0"
 104 when "Supermicro"
 105   units << "1"
 106 when "IBM"
 107   units << "0"
 108 when "VMware, Inc."
 109   package "open-vm-tools"
 110
 111   # Remove timeSync plugin completely
 112   # https://github.com/vmware/open-vm-tools/issues/302
 113   file "/usr/lib/open-vm-tools/plugins/vmsvc/libtimeSync.so" do
 114     action :delete
 115     notifies :restart, "service[open-vm-tools]"
 116   end
 117
 118   # Attempt to tell Host we are not interested in timeSync
 119   execute "vmware-toolbox-cmd-timesync-disable" do
 120     command "/usr/bin/vmware-toolbox-cmd timesync disable"
 121     ignore_failure true
 122   end
 123
 124   service "open-vm-tools" do
 125     action [:enable, :start]
 126     supports :status => true, :restart => true
 127   end
 128 end
 129
 130 units.sort.uniq.each do |unit|
 131   service "serial-getty@ttyS#{unit}" do
 132     action [:enable, :start]
 133   end
 134 end
 135
 136 # if we need a different / special kernel version to make the hardware
 137 # work (e.g: https://github.com/openstreetmap/operations/issues/45) then
 138 # ensure that we have the package installed. the grub template will
 139 # make sure that this is the default on boot.
 140 if node[:hardware][:grub][:kernel]
 141   kernel_version = node[:hardware][:grub][:kernel]
 142
 143   package "linux-image-#{kernel_version}-generic"
 144   package "linux-image-extra-#{kernel_version}-generic"
 145   package "linux-headers-#{kernel_version}-generic"
 146   package "linux-tools-#{kernel_version}-generic"
 147
 148   boot_device = IO.popen(["df", "/boot"]).readlines.last.split.first
 149   boot_uuid = IO.popen(["blkid", "-o", "value", "-s", "UUID", boot_device]).readlines.first.chomp
 150   grub_entry = "gnulinux-advanced-#{boot_uuid}>gnulinux-#{kernel_version}-advanced-#{boot_uuid}"
 151 else
 152   grub_entry = "0"
 153 end
 154
 155 if File.exist?("/etc/default/grub")
 156   execute "update-grub" do
 157     action :nothing
 158     command "/usr/sbin/update-grub"
 159     not_if { kitchen? }
 160   end
 161
 162   template "/etc/default/grub" do
 163     source "grub.erb"
 164     owner "root"
 165     group "root"
 166     mode "644"
 167     variables :units => units, :entry => grub_entry
 168     notifies :run, "execute[update-grub]"
 169   end
 170 end
 171
 172 execute "update-initramfs" do
 173   action :nothing
 174   command "update-initramfs -u -k all"
 175   user "root"
 176   group "root"
 177 end
 178
 179 template "/etc/initramfs-tools/conf.d/mdadm" do
 180   source "initramfs-mdadm.erb"
 181   owner "root"
 182   group "root"
 183   mode "644"
 184   notifies :run, "execute[update-initramfs]"
 185 end
 186
 187 package "haveged"
 188 service "haveged" do
 189   action [:enable, :start]
 190 end
 191
 192 if node[:kernel][:modules].include?("ipmi_si")
 193   package "ipmitool"
 194   package "freeipmi-tools"
 195
 196   template "/etc/prometheus/ipmi_local.yml" do
 197     source "ipmi_local.yml.erb"
 198     owner "root"
 199     group "root"
 200     mode "644"
 201   end
 202
 203   prometheus_exporter "ipmi" do
 204     port 9290
 205     options "--config.file=/etc/prometheus/ipmi_local.yml"
 206     subscribes :restart, "template[/etc/prometheus/ipmi_local.yml]"
 207   end
 208 end
 209
 210 package "irqbalance"
 211
 212 service "irqbalance" do
 213   action [:start, :enable]
 214   supports :status => false, :restart => true, :reload => false
 215 end
 216
 217 package "lldpd"
 218
 219 service "lldpd" do
 220   action [:start, :enable]
 221   supports :status => true, :restart => true, :reload => true
 222 end
 223
 224 ohai_plugin "lldp" do
 225   template "lldp.rb.erb"
 226 end
 227
 228 %w[bus cache dimm iomca page socket-memory unknown].each do |trigger|
 229   file "/etc/mcelog/#{trigger}-error-trigger.local" do
 230     action :delete
 231   end
 232 end
 233
 234 service "mcelog" do
 235   action [:stop, :disable]
 236 end
 237
 238 package "mcelog" do
 239   action :purge
 240 end
 241
 242 tools_packages = []
 243 status_packages = {}
 244
 245 if node[:virtualization][:role] != "guest" ||
 246    (node[:virtualization][:system] != "lxc" &&
 247     node[:virtualization][:system] != "lxd" &&
 248     node[:virtualization][:system] != "openvz")
 249
 250   node[:kernel][:modules].each_key do |modname|
 251     case modname
 252     when "cciss"
 253       tools_packages << "ssacli"
 254       status_packages["cciss-vol-status"] ||= []
 255     when "hpsa"
 256       tools_packages << "ssacli"
 257       status_packages["cciss-vol-status"] ||= []
 258     when "mptsas"
 259       tools_packages << "lsiutil"
 260       status_packages["mpt-status"] ||= []
 261     when "mpt2sas", "mpt3sas"
 262       tools_packages << "sas2ircu"
 263       status_packages["sas2ircu-status"] ||= []
 264     when "megaraid_sas"
 265       tools_packages << "megacli"
 266       status_packages["megaclisas-status"] ||= []
 267     when "aacraid"
 268       tools_packages << "arcconf"
 269       status_packages["aacraid-status"] ||= []
 270     when "arcmsr"
 271       tools_packages << "areca"
 272     end
 273   end
 274
 275   node[:block_device].each do |name, attributes|
 276     next unless attributes[:vendor] == "HP" && attributes[:model] == "LOGICAL VOLUME"
 277
 278     if name =~ /^cciss!(c[0-9]+)d[0-9]+$/
 279       status_packages["cciss-vol-status"] |= ["cciss/#{Regexp.last_match[1]}d0"]
 280     else
 281       Dir.glob("/sys/block/#{name}/device/scsi_generic/*").each do |sg|
 282         status_packages["cciss-vol-status"] |= [File.basename(sg)]
 283       end
 284     end
 285   end
 286 end
 287
 288 %w[ssacli lsiutil sas2ircu megactl megacli arcconf].each do |tools_package|
 289   if tools_packages.include?(tools_package)
 290     package tools_package
 291   else
 292     package tools_package do
 293       action :purge
 294     end
 295   end
 296 end
 297
 298 if tools_packages.include?("areca")
 299   include_recipe "git"
 300
 301   git "/opt/areca" do
 302     action :sync
 303     repository "https://git.openstreetmap.org/private/areca.git"
 304     depth 1
 305     user "root"
 306     group "root"
 307     not_if { kitchen? }
 308   end
 309 else
 310   directory "/opt/areca" do
 311     action :delete
 312     recursive true
 313   end
 314 end
 315
 316 if status_packages.include?("cciss-vol-status")
 317   template "/usr/local/bin/cciss-vol-statusd" do
 318     source "cciss-vol-statusd.erb"
 319     owner "root"
 320     group "root"
 321     mode "755"
 322     notifies :restart, "service[cciss-vol-statusd]"
 323   end
 324
 325   systemd_service "cciss-vol-statusd" do
 326     description "Check cciss_vol_status values in the background"
 327     exec_start "/usr/local/bin/cciss-vol-statusd"
 328     private_tmp true
 329     protect_system "full"
 330     protect_home true
 331     no_new_privileges true
 332     notifies :restart, "service[cciss-vol-statusd]"
 333   end
 334 else
 335   systemd_service "cciss-vol-statusd" do
 336     action :delete
 337   end
 338
 339   template "/usr/local/bin/cciss-vol-statusd" do
 340     action :delete
 341   end
 342 end
 343
 344 %w[cciss-vol-status mpt-status sas2ircu-status megaclisas-status aacraid-status].each do |status_package|
 345   if status_packages.include?(status_package)
 346     package status_package
 347
 348     template "/etc/default/#{status_package}d" do
 349       source "raid.default.erb"
 350       owner "root"
 351       group "root"
 352       mode "644"
 353       variables :devices => status_packages[status_package]
 354     end
 355
 356     service "#{status_package}d" do
 357       action [:start, :enable]
 358       supports :status => false, :restart => true, :reload => false
 359       subscribes :restart, "template[/etc/default/#{status_package}d]"
 360     end
 361   else
 362     package status_package do
 363       action :purge
 364     end
 365
 366     file "/etc/default/#{status_package}d" do
 367       action :delete
 368     end
 369   end
 370 end
 371
 372 disks = if node[:hardware][:disk]
 373           node[:hardware][:disk][:disks]
 374         else
 375           []
 376         end
 377
 378 intel_ssds = disks.select { |d| d[:vendor] == "INTEL" && d[:model] =~ /^SSD/ }
 379
 380 nvmes = if node[:hardware][:pci]
 381           node[:hardware][:pci].values.select { |pci| pci[:driver] == "nvme" }
 382         else
 383           []
 384         end
 385
 386 unless nvmes.empty?
 387   package "nvme-cli"
 388 end
 389
 390 intel_nvmes = nvmes.select { |pci| pci[:vendor_name] == "Intel Corporation" }
 391
 392 if !intel_ssds.empty? || !intel_nvmes.empty?
 393   package "unzip"
 394
 395   intel_mas_tool_version = "1.10"
 396   intel_mas_package_version = "#{intel_mas_tool_version}.155-0"
 397
 398   remote_file "#{Chef::Config[:file_cache_path]}/Intel_MAS_CLI_Tool_#{intel_mas_tool_version}_Linux.zip" do
 399     source "https://downloadmirror.intel.com/646992/Intel_MAS_CLI_Tool_Linux_#{intel_mas_tool_version}-v2.zip"
 400   end
 401
 402   execute "#{Chef::Config[:file_cache_path]}/Intel_MAS_CLI_Tool_#{intel_mas_tool_version}_Linux.zip" do
 403     command "unzip Intel_MAS_CLI_Tool_#{intel_mas_tool_version}_Linux.zip intelmas_#{intel_mas_package_version}_amd64.deb"
 404     cwd Chef::Config[:file_cache_path]
 405     user "root"
 406     group "root"
 407     not_if { ::File.exist?("#{Chef::Config[:file_cache_path]}/intelmas_#{intel_mas_package_version}_amd64.deb") }
 408   end
 409
 410   dpkg_package "intelmas" do
 411     version "#{intel_mas_package_version}"
 412     source "#{Chef::Config[:file_cache_path]}/intelmas_#{intel_mas_package_version}_amd64.deb"
 413   end
 414
 415   dpkg_package "isdct" do
 416     action :purge
 417   end
 418 end
 419
 420 disks = disks.map do |disk|
 421   next if disk[:state] == "spun_down" || %w[unconfigured failed].any?(disk[:status])
 422
 423   if disk[:smart_device]
 424     controller = node[:hardware][:disk][:controllers][disk[:controller]]
 425
 426     if controller && controller[:device]
 427       device = controller[:device].sub("/dev/", "")
 428       smart = disk[:smart_device]
 429
 430       if device.start_with?("cciss/") && smart =~ /^cciss,(\d+)$/
 431         array = node[:hardware][:disk][:arrays][disk[:arrays].first]
 432         munin = "cciss-3#{array[:wwn]}-#{Regexp.last_match(1)}"
 433       elsif smart =~ /^.*,(\d+)$/
 434         munin = "#{device}-#{Regexp.last_match(1)}"
 435       elsif smart =~ %r{^.*,(\d+)/(\d+)$}
 436         munin = "#{device}-#{Regexp.last_match(1)}:#{Regexp.last_match(2)}"
 437       end
 438     elsif disk[:device]
 439       device = disk[:device].sub("/dev/", "")
 440       smart = disk[:smart_device]
 441
 442       if smart =~ /^.*,(\d+),(\d+),(\d+)$/
 443         munin = "#{device}-#{Regexp.last_match(1)}:#{Regexp.last_match(2)}:#{Regexp.last_match(3)}"
 444       end
 445     end
 446   elsif disk[:device] =~ %r{^/dev/(nvme\d+)n\d+$}
 447     device = Regexp.last_match(1)
 448     munin = device
 449   elsif disk[:device]
 450     device = disk[:device].sub("/dev/", "")
 451     munin = device
 452   end
 453
 454   next if device.nil?
 455
 456   Hash[
 457     :device => device,
 458     :smart => smart,
 459     :munin => munin,
 460     :hddtemp => munin.tr("-:", "_")
 461   ]
 462 end
 463
 464 disks = disks.compact.uniq
 465
 466 if disks.count.positive?
 467   package "smartmontools"
 468
 469   template "/etc/cron.daily/update-smart-drivedb" do
 470     source "update-smart-drivedb.erb"
 471     owner "root"
 472     group "root"
 473     mode "755"
 474   end
 475
 476   template "/usr/local/bin/smartd-mailer" do
 477     source "smartd-mailer.erb"
 478     owner "root"
 479     group "root"
 480     mode "755"
 481   end
 482
 483   template "/etc/smartd.conf" do
 484     source "smartd.conf.erb"
 485     owner "root"
 486     group "root"
 487     mode "644"
 488     variables :disks => disks
 489   end
 490
 491   template "/etc/default/smartmontools" do
 492     source "smartmontools.erb"
 493     owner "root"
 494     group "root"
 495     mode "644"
 496   end
 497
 498   service "smartmontools" do
 499     action [:enable, :start]
 500     subscribes :reload, "template[/etc/smartd.conf]"
 501     subscribes :restart, "template[/etc/default/smartmontools]"
 502   end
 503
 504   template "/etc/prometheus/collectors/smart.devices" do
 505     source "smart.devices.erb"
 506     owner "root"
 507     group "root"
 508     mode "644"
 509     variables :disks => disks
 510   end
 511
 512   prometheus_collector "smart" do
 513     interval "15m"
 514   end
 515
 516   # Don't try and do munin monitoring of disks behind
 517   # an Areca controller as they only allow one thing to
 518   # talk to the controller at a time and smartd will
 519   # throw errors if it clashes with munin
 520   disks = disks.reject { |disk| disk[:smart]&.start_with?("areca,") }
 521
 522   disks.each do |disk|
 523     munin_plugin "smart_#{disk[:munin]}" do
 524       target "smart_"
 525       conf "munin.smart.erb"
 526       conf_variables :disk => disk
 527     end
 528   end
 529 else
 530   service "smartd" do
 531     action [:stop, :disable]
 532   end
 533 end
 534
 535 if disks.count.positive?
 536   munin_plugin "hddtemp_smartctl" do
 537     conf "munin.hddtemp.erb"
 538     conf_variables :disks => disks
 539   end
 540 else
 541   munin_plugin "hddtemp_smartctl" do
 542     action :delete
 543     conf "munin.hddtemp.erb"
 544   end
 545 end
 546
 547 plugins = Dir.glob("/etc/munin/plugins/smart_*").map { |p| File.basename(p) } -
 548           disks.map { |d| "smart_#{d[:munin]}" }
 549
 550 plugins.each do |plugin|
 551   munin_plugin plugin do
 552     action :delete
 553     conf "munin.smart.erb"
 554   end
 555 end
 556
 557 if File.exist?("/etc/mdadm/mdadm.conf")
 558   mdadm_conf = edit_file "/etc/mdadm/mdadm.conf" do |line|
 559     line.gsub!(/^MAILADDR .*$/, "MAILADDR admins@openstreetmap.org")
 560
 561     line
 562   end
 563
 564   file "/etc/mdadm/mdadm.conf" do
 565     owner "root"
 566     group "root"
 567     mode "644"
 568     content mdadm_conf
 569   end
 570
 571   service "mdadm" do
 572     action :nothing
 573     subscribes :restart, "file[/etc/mdadm/mdadm.conf]"
 574   end
 575 end
 576
 577 file "/etc/modules" do
 578   action :delete
 579 end
 580
 581 node[:hardware][:modules].each do |module_name|
 582   kernel_module module_name do
 583     action :install
 584     not_if { kitchen? }
 585   end
 586 end
 587
 588 node[:hardware][:blacklisted_modules].each do |module_name|
 589   kernel_module module_name do
 590     action :blacklist
 591   end
 592 end
 593
 594 if node[:hardware][:watchdog]
 595   package "watchdog"
 596
 597   template "/etc/default/watchdog" do
 598     source "watchdog.erb"
 599     owner "root"
 600     group "root"
 601     mode "644"
 602     variables :module => node[:hardware][:watchdog]
 603   end
 604
 605   service "watchdog" do
 606     action [:enable, :start]
 607   end
 608 end
 609
 610 unless Dir.glob("/sys/class/hwmon/hwmon*").empty?
 611   package "lm-sensors"
 612
 613   Dir.glob("/sys/devices/platform/coretemp.*").each do |coretemp|
 614     cpu = File.basename(coretemp).sub("coretemp.", "").to_i
 615     chip = format("coretemp-isa-%04d", cpu)
 616
 617     temps = if File.exist?("#{coretemp}/name")
 618               Dir.glob("#{coretemp}/temp*_input").map do |temp|
 619                 File.basename(temp).sub("temp", "").sub("_input", "").to_i
 620               end.sort
 621             else
 622               Dir.glob("#{coretemp}/hwmon/hwmon*/temp*_input").map do |temp|
 623                 File.basename(temp).sub("temp", "").sub("_input", "").to_i
 624               end.sort
 625             end
 626
 627     if temps.first == 1
 628       node.default[:hardware][:sensors][chip][:temps][:temp1][:label] = "CPU #{cpu}"
 629       temps.shift
 630     end
 631
 632     temps.each_with_index do |temp, index|
 633       node.default[:hardware][:sensors][chip][:temps]["temp#{temp}"][:label] = "CPU #{cpu} Core #{index}"
 634     end
 635   end
 636
 637   execute "/etc/sensors.d/chef.conf" do
 638     action :nothing
 639     command "/usr/bin/sensors -s"
 640     user "root"
 641     group "root"
 642   end
 643
 644   template "/etc/sensors.d/chef.conf" do
 645     source "sensors.conf.erb"
 646     owner "root"
 647     group "root"
 648     mode "644"
 649     notifies :run, "execute[/etc/sensors.d/chef.conf]"
 650   end
 651 end
 652
 653 if node[:hardware][:shm_size]
 654   execute "remount-dev-shm" do
 655     action :nothing
 656     command "/bin/mount -o remount /dev/shm"
 657     user "root"
 658     group "root"
 659   end
 660
 661   mount "/dev/shm" do
 662     action :enable
 663     device "tmpfs"
 664     fstype "tmpfs"
 665     options "rw,nosuid,nodev,size=#{node[:hardware][:shm_size]}"
 666     notifies :run, "execute[remount-dev-shm]"
 667   end
 668 end
 669
 670 prometheus_collector "ohai" do
 671   interval "15m"
 672 end