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