构建自定义Ohai插件读取Windows Registry及使用方法咨询

嘿，我之前也折腾过这类需求，其实理清逻辑后没那么复杂，一步步来就能搞定。下面是我总结的完整步骤和示例代码，你可以直接参考：

一、先搞懂Ohai插件的核心规则 #

Ohai插件本质是Ruby脚本，专门用来收集系统属性并注入到Chef的node对象里。针对Windows注册表的插件，要注意两个关键点：

• 存放位置：可以放在C:\chef\ohai\plugins目录下（全局生效），或者在你的Cookbook的files/default/ohai_plugins文件夹里（通过Cookbook部署到节点）。
• 运行时机：插件只会在chef-client运行时的Ohai收集阶段执行，所以要确保插件在收集阶段前已经部署到节点上。

二、完整的插件示例代码 #

下面是一个可直接复用的插件，用来读取HKLM下某个应用的注册表配置：

Ohai.plugin(:MyAppRegistryReader) do
  # 定义这个插件提供的属性名，之后可以通过node['my_app_registry']访问
  provides 'my_app_registry'

  # 只在Windows系统上执行这个插件
  collect_data(:windows) do
    # 用Mash来存储嵌套属性，和Ruby的Hash类似但更适配Ohai
    my_app_registry Mash.new

    begin
      # 打开目标注册表路径：第一个参数是根键常量，第二个是子路径
      Ohai::System::Win32::Registry.open(Ohai::System::Win32::Registry::HKLM, 'SOFTWARE\MyCustomApplication') do |reg|
        # 读取不同类型的注册表值
        # 字符串值直接用[]访问
        my_app_registry['app_version'] = reg['Version']
        # DWORD类型用dwordread方法
        my_app_registry['max_retries'] = reg.dwordread('MaxRetries')
        # 二进制类型用binread方法，这里转成十六进制字符串方便查看
        my_app_registry['config_hash'] = reg.binread('ConfigHash').unpack('H*').first
      end
    rescue Win32::Registry::Error => e
      # 捕获异常，避免插件失败导致整个chef-client运行终止
      Ohai::Log.warn("Failed to read MyApp registry key: #{e.message}")
      my_app_registry['read_error'] = e.message
    end
  end
end

三、关键细节说明 #

• 根键常量：Ohai内置了常用的注册表根键常量，比如HKLM、HKCU、HKCR、HKU、HKCC，对应Windows的五大根键。
• 值类型处理：注册表有不同的数据类型，Ohai提供了对应的读取方法：
  • 字符串值：reg['KeyName']
  • DWORD值：reg.dwordread('KeyName')
  • 二进制值：reg.binread('KeyName')（返回二进制字符串，需要用unpack转成可读格式）
• 错误处理：一定要加异常捕获，否则如果注册表路径不存在或者权限不足，会直接导致Ohai收集失败，进而终止chef-client运行。

四、测试插件是否生效 #

在部署到节点后，你可以先手动测试插件是否能正确读取数据：

1. 打开PowerShell（以管理员身份）
2. 运行命令：ohai -d C:\chef\ohai\plugins my_app_registry
3. 如果配置正确，会输出类似下面的JSON结构：

{
  "my_app_registry": {
    "app_version": "2.3.1",
    "max_retries": 5,
    "config_hash": "a1b2c3d4..."
  }
}

五、在Cookbook中使用收集到的属性 #

当插件生效后，你就可以在Recipe里直接通过node对象访问这些属性了，比如：

# 如果应用版本低于2.0，就执行更新操作
if Gem::Version.new(node['my_app_registry']['app_version']) < Gem::Version.new('2.0.0')
  windows_package 'MyApp Update' do
    source '\\fileserver\updates\MyApp_v2.3.1.msi'
    action :install
  end
end

六、额外注意事项 #

• 权限问题：chef-client需要以管理员身份运行，才能读取HKLM下的大部分注册表路径；如果读取HKCU的路径，要确保运行chef-client的用户对该路径有读取权限。
• 插件部署：如果是通过Cookbook部署插件，可以用ohai资源来触发Ohai重新收集属性，比如：

cookbook_file 'C:/chef/ohai/plugins/my_app_registry_reader.rb' do
  source 'ohai_plugins/my_app_registry_reader.rb'
  action :create
  notifies :reload, 'ohai[reload_custom_plugin]', :immediately
end

ohai 'reload_custom_plugin' do
  action :nothing
end

内容的提问来源于stack exchange，提问作者Nikhil Reddy