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