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 tools_packages = []
 229 status_packages = {}
 230
 231 if node[:virtualization][:role] != "guest" ||
 232    (node[:virtualization][:system] != "lxc" &&
 233     node[:virtualization][:system] != "lxd" &&
 234     node[:virtualization][:system] != "openvz")
 235
 236   node[:kernel][:modules].each_key do |modname|
 237     case modname
 238     when "cciss"
 239       tools_packages << "ssacli"
 240       status_packages["cciss-vol-status"] ||= []
 241     when "hpsa"
 242       tools_packages << "ssacli"
 243       status_packages["cciss-vol-status"] ||= []
 244     when "mptsas"
 245       tools_packages << "lsiutil"
 246       status_packages["mpt-status"] ||= []
 247     when "mpt2sas", "mpt3sas"
 248       tools_packages << "sas2ircu"
 249       status_packages["sas2ircu-status"] ||= []
 250     when "megaraid_mm"
 251       tools_packages << "megactl"
 252       status_packages["megaraid-status"] ||= []
 253     when "megaraid_sas"
 254       tools_packages << "megacli"
 255       status_packages["megaclisas-status"] ||= []
 256     when "aacraid"
 257       tools_packages << "arcconf"
 258       status_packages["aacraid-status"] ||= []
 259     when "arcmsr"
 260       tools_packages << "areca"
 261     end
 262   end
 263
 264   node[:block_device].each do |name, attributes|
 265     next unless attributes[:vendor] == "HP" && attributes[:model] == "LOGICAL VOLUME"
 266
 267     if name =~ /^cciss!(c[0-9]+)d[0-9]+$/
 268       status_packages["cciss-vol-status"] |= ["cciss/#{Regexp.last_match[1]}d0"]
 269     else
 270       Dir.glob("/sys/block/#{name}/device/scsi_generic/*").each do |sg|
 271         status_packages["cciss-vol-status"] |= [File.basename(sg)]
 272       end
 273     end
 274   end
 275 end
 276
 277 %w[ssacli lsiutil sas2ircu megactl megacli arcconf].each do |tools_package|
 278   if tools_packages.include?(tools_package)
 279     package tools_package
 280   else
 281     package tools_package do
 282       action :purge
 283     end
 284   end
 285 end
 286
 287 if tools_packages.include?("areca")
 288   include_recipe "git"
 289
 290   git "/opt/areca" do
 291     action :sync
 292     repository "https://git.openstreetmap.org/private/areca.git"
 293     depth 1
 294     user "root"
 295     group "root"
 296     not_if { kitchen? }
 297   end
 298 else
 299   directory "/opt/areca" do
 300     action :delete
 301     recursive true
 302   end
 303 end
 304
 305 if status_packages.include?("cciss-vol-status")
 306   template "/usr/local/bin/cciss-vol-statusd" do
 307     source "cciss-vol-statusd.erb"
 308     owner "root"
 309     group "root"
 310     mode "755"
 311     notifies :restart, "service[cciss-vol-statusd]"
 312   end
 313
 314   systemd_service "cciss-vol-statusd" do
 315     description "Check cciss_vol_status values in the background"
 316     exec_start "/usr/local/bin/cciss-vol-statusd"
 317     private_tmp true
 318     protect_system "full"
 319     protect_home true
 320     no_new_privileges true
 321     notifies :restart, "service[cciss-vol-statusd]"
 322   end
 323 else
 324   systemd_service "cciss-vol-statusd" do
 325     action :delete
 326   end
 327
 328   template "/usr/local/bin/cciss-vol-statusd" do
 329     action :delete
 330   end
 331 end
 332
 333 %w[cciss-vol-status mpt-status sas2ircu-status megaraid-status megaclisas-status aacraid-status].each do |status_package|
 334   if status_packages.include?(status_package)
 335     package status_package
 336
 337     template "/etc/default/#{status_package}d" do
 338       source "raid.default.erb"
 339       owner "root"
 340       group "root"
 341       mode "644"
 342       variables :devices => status_packages[status_package]
 343     end
 344
 345     service "#{status_package}d" do
 346       action [:start, :enable]
 347       supports :status => false, :restart => true, :reload => false
 348       subscribes :restart, "template[/etc/default/#{status_package}d]"
 349     end
 350   else
 351     package status_package do
 352       action :purge
 353     end
 354
 355     file "/etc/default/#{status_package}d" do
 356       action :delete
 357     end
 358   end
 359 end
 360
 361 disks = if node[:hardware][:disk]
 362           node[:hardware][:disk][:disks]
 363         else
 364           []
 365         end
 366
 367 intel_ssds = disks.select { |d| d[:vendor] == "INTEL" && d[:model] =~ /^SSD/ }
 368
 369 nvmes = if node[:hardware][:pci]
 370           node[:hardware][:pci].values.select { |pci| pci[:driver] == "nvme" }
 371         else
 372           []
 373         end
 374
 375 unless nvmes.empty?
 376   package "nvme-cli"
 377 end
 378
 379 intel_nvmes = nvmes.select { |pci| pci[:vendor_name] == "Intel Corporation" }
 380
 381 if !intel_ssds.empty? || !intel_nvmes.empty?
 382   package "unzip"
 383
 384   intel_mas_tool_version = "1.10"
 385   intel_mas_package_version = "#{intel_mas_tool_version}.155-0"
 386
 387   remote_file "#{Chef::Config[:file_cache_path]}/Intel_MAS_CLI_Tool_#{intel_mas_tool_version}_Linux.zip" do
 388     source "https://downloadmirror.intel.com/646992/Intel_MAS_CLI_Tool_Linux_#{intel_mas_tool_version}-v2.zip"
 389   end
 390
 391   execute "#{Chef::Config[:file_cache_path]}/Intel_MAS_CLI_Tool_#{intel_mas_tool_version}_Linux.zip" do
 392     command "unzip Intel_MAS_CLI_Tool_#{intel_mas_tool_version}_Linux.zip intelmas_#{intel_mas_package_version}_amd64.deb"
 393     cwd Chef::Config[:file_cache_path]
 394     user "root"
 395     group "root"
 396     not_if { ::File.exist?("#{Chef::Config[:file_cache_path]}/intelmas_#{intel_mas_package_version}_amd64.deb") }
 397   end
 398
 399   dpkg_package "intelmas" do
 400     version "#{intel_mas_package_version}"
 401     source "#{Chef::Config[:file_cache_path]}/intelmas_#{intel_mas_package_version}_amd64.deb"
 402   end
 403
 404   dpkg_package "isdct" do
 405     action :purge
 406   end
 407 end
 408
 409 disks = disks.map do |disk|
 410   next if disk[:state] == "spun_down" || %w[unconfigured failed].any?(disk[:status])
 411
 412   if disk[:smart_device]
 413     controller = node[:hardware][:disk][:controllers][disk[:controller]]
 414
 415     if controller && controller[:device]
 416       device = controller[:device].sub("/dev/", "")
 417       smart = disk[:smart_device]
 418
 419       if device.start_with?("cciss/") && smart =~ /^cciss,(\d+)$/
 420         array = node[:hardware][:disk][:arrays][disk[:arrays].first]
 421         munin = "cciss-3#{array[:wwn]}-#{Regexp.last_match(1)}"
 422       elsif smart =~ /^.*,(\d+)$/
 423         munin = "#{device}-#{Regexp.last_match(1)}"
 424       elsif smart =~ %r{^.*,(\d+)/(\d+)$}
 425         munin = "#{device}-#{Regexp.last_match(1)}:#{Regexp.last_match(2)}"
 426       end
 427     elsif disk[:device]
 428       device = disk[:device].sub("/dev/", "")
 429       smart = disk[:smart_device]
 430
 431       if smart =~ /^.*,(\d+),(\d+),(\d+)$/
 432         munin = "#{device}-#{Regexp.last_match(1)}:#{Regexp.last_match(2)}:#{Regexp.last_match(3)}"
 433       end
 434     end
 435   elsif disk[:device] =~ %r{^/dev/(nvme\d+)n\d+$}
 436     device = Regexp.last_match(1)
 437     munin = device
 438   elsif disk[:device]
 439     device = disk[:device].sub("/dev/", "")
 440     munin = device
 441   end
 442
 443   next if device.nil?
 444
 445   Hash[
 446     :device => device,
 447     :smart => smart,
 448     :munin => munin,
 449     :hddtemp => munin.tr("-:", "_")
 450   ]
 451 end
 452
 453 disks = disks.compact.uniq
 454
 455 if disks.count.positive?
 456   package "smartmontools"
 457
 458   template "/etc/cron.daily/update-smart-drivedb" do
 459     source "update-smart-drivedb.erb"
 460     owner "root"
 461     group "root"
 462     mode "755"
 463   end
 464
 465   template "/usr/local/bin/smartd-mailer" do
 466     source "smartd-mailer.erb"
 467     owner "root"
 468     group "root"
 469     mode "755"
 470   end
 471
 472   template "/etc/smartd.conf" do
 473     source "smartd.conf.erb"
 474     owner "root"
 475     group "root"
 476     mode "644"
 477     variables :disks => disks
 478   end
 479
 480   template "/etc/default/smartmontools" do
 481     source "smartmontools.erb"
 482     owner "root"
 483     group "root"
 484     mode "644"
 485   end
 486
 487   service "smartmontools" do
 488     action [:enable, :start]
 489     subscribes :reload, "template[/etc/smartd.conf]"
 490     subscribes :restart, "template[/etc/default/smartmontools]"
 491   end
 492
 493   template "/etc/prometheus/collectors/smart.devices" do
 494     source "smart.devices.erb"
 495     owner "root"
 496     group "root"
 497     mode "644"
 498     variables :disks => disks
 499   end
 500
 501   prometheus_collector "smart" do
 502     interval "15m"
 503   end
 504
 505   # Don't try and do munin monitoring of disks behind
 506   # an Areca controller as they only allow one thing to
 507   # talk to the controller at a time and smartd will
 508   # throw errors if it clashes with munin
 509   disks = disks.reject { |disk| disk[:smart]&.start_with?("areca,") }
 510
 511   disks.each do |disk|
 512     munin_plugin "smart_#{disk[:munin]}" do
 513       target "smart_"
 514       conf "munin.smart.erb"
 515       conf_variables :disk => disk
 516     end
 517   end
 518 else
 519   service "smartd" do
 520     action [:stop, :disable]
 521   end
 522 end
 523
 524 if disks.count.positive?
 525   munin_plugin "hddtemp_smartctl" do
 526     conf "munin.hddtemp.erb"
 527     conf_variables :disks => disks
 528   end
 529 else
 530   munin_plugin "hddtemp_smartctl" do
 531     action :delete
 532     conf "munin.hddtemp.erb"
 533   end
 534 end
 535
 536 plugins = Dir.glob("/etc/munin/plugins/smart_*").map { |p| File.basename(p) } -
 537           disks.map { |d| "smart_#{d[:munin]}" }
 538
 539 plugins.each do |plugin|
 540   munin_plugin plugin do
 541     action :delete
 542     conf "munin.smart.erb"
 543   end
 544 end
 545
 546 if File.exist?("/etc/mdadm/mdadm.conf")
 547   mdadm_conf = edit_file "/etc/mdadm/mdadm.conf" do |line|
 548     line.gsub!(/^MAILADDR .*$/, "MAILADDR admins@openstreetmap.org")
 549
 550     line
 551   end
 552
 553   file "/etc/mdadm/mdadm.conf" do
 554     owner "root"
 555     group "root"
 556     mode "644"
 557     content mdadm_conf
 558   end
 559
 560   service "mdadm" do
 561     action :nothing
 562     subscribes :restart, "file[/etc/mdadm/mdadm.conf]"
 563   end
 564 end
 565
 566 file "/etc/modules" do
 567   action :delete
 568 end
 569
 570 node[:hardware][:modules].each do |module_name|
 571   kernel_module module_name do
 572     action :install
 573     not_if { kitchen? }
 574   end
 575 end
 576
 577 node[:hardware][:blacklisted_modules].each do |module_name|
 578   kernel_module module_name do
 579     action :blacklist
 580   end
 581 end
 582
 583 if node[:hardware][:watchdog]
 584   package "watchdog"
 585
 586   template "/etc/default/watchdog" do
 587     source "watchdog.erb"
 588     owner "root"
 589     group "root"
 590     mode "644"
 591     variables :module => node[:hardware][:watchdog]
 592   end
 593
 594   service "watchdog" do
 595     action [:enable, :start]
 596   end
 597 end
 598
 599 unless Dir.glob("/sys/class/hwmon/hwmon*").empty?
 600   package "lm-sensors"
 601
 602   Dir.glob("/sys/devices/platform/coretemp.*").each do |coretemp|
 603     cpu = File.basename(coretemp).sub("coretemp.", "").to_i
 604     chip = format("coretemp-isa-%04d", cpu)
 605
 606     temps = if File.exist?("#{coretemp}/name")
 607               Dir.glob("#{coretemp}/temp*_input").map do |temp|
 608                 File.basename(temp).sub("temp", "").sub("_input", "").to_i
 609               end.sort
 610             else
 611               Dir.glob("#{coretemp}/hwmon/hwmon*/temp*_input").map do |temp|
 612                 File.basename(temp).sub("temp", "").sub("_input", "").to_i
 613               end.sort
 614             end
 615
 616     if temps.first == 1
 617       node.default[:hardware][:sensors][chip][:temps][:temp1][:label] = "CPU #{cpu}"
 618       temps.shift
 619     end
 620
 621     temps.each_with_index do |temp, index|
 622       node.default[:hardware][:sensors][chip][:temps]["temp#{temp}"][:label] = "CPU #{cpu} Core #{index}"
 623     end
 624   end
 625
 626   execute "/etc/sensors.d/chef.conf" do
 627     action :nothing
 628     command "/usr/bin/sensors -s"
 629     user "root"
 630     group "root"
 631   end
 632
 633   template "/etc/sensors.d/chef.conf" do
 634     source "sensors.conf.erb"
 635     owner "root"
 636     group "root"
 637     mode "644"
 638     notifies :run, "execute[/etc/sensors.d/chef.conf]"
 639   end
 640 end
 641
 642 if node[:hardware][:shm_size]
 643   execute "remount-dev-shm" do
 644     action :nothing
 645     command "/bin/mount -o remount /dev/shm"
 646     user "root"
 647     group "root"
 648   end
 649
 650   mount "/dev/shm" do
 651     action :enable
 652     device "tmpfs"
 653     fstype "tmpfs"
 654     options "rw,nosuid,nodev,size=#{node[:hardware][:shm_size]}"
 655     notifies :run, "execute[remount-dev-shm]"
 656   end
 657 end