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