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