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