定制厨师处理程序

问题描述

我正在尝试了解Custom Handlers上的Chef文档。

这些步骤似乎很简单，但我仍然不明白它是如何工作的。

下载Chef_handler食谱
创建自定义处理程序
使用chef_handler资源编写食谱
将该配方添加到节点的运行列表中，通常作为该运行列表中的第一个配方

步骤1不再需要，因为chef_handler食谱现已成为Chef的一部分。

第2步创建一个处理程序。给出的示例是

require 'net/smtp'

module OrgName
  class SendEmail < Chef::Handler
    def report
      if run_status.Failed? then
        message  = "From: sender_name <[email protected]>\n"
        message << "To: recipient_address <[email protected]>\n"
        message << "Subject: chef-client Run Failed\n"
        message << "Date: #{Time.Now.rfc2822}\n\n"
        message << "Chef run Failed on #{node.name}\n"
        message << "#{run_status.formatted_exception}\n"
        message << Array(backtrace).join('\n')
        Net::SMTP.start('your.smtp.server',25) do |smtp|
          smtp.send_message message,'sender@example','recipient@example'
        end
      end
    end
  end
end

现在是我不理解的第3步，将以下内容添加到食谱中

send_email 'blah' do
  # recipe code
end

当我运行我的食谱时，它只会产生我希望以以下内容开头的错误消息：

FATAL: NoMethodError: undefined method `send_email` for cookbook: test,recipe: default :Chef::Recipe

这应该如何工作？还有其他简单但可行的自定义处理程序示例吗？

对于厨师15.0.300

解决方法

乍看之下，有关Chef处理程序的文档确实有些不清楚。调查更多细节，一件事很清楚。 chef_handler是Chef资源（自Chef客户端14起）。默认情况下，它支持两个处理程序-JsonFile和ErrorReport。

custom handlers上有更多文档。这表明我们需要安装一些chef_gem才能使自定义处理程序正常工作（上面两个除外）。

Simple Email

一个处理程序，该处理程序收集异常和报告处理程序数据，然后使用pony发送基于Erubis模板的电子邮件报告。

连接点...然后我们应该有一个安装chef_gem并启用处理程序的配方。我创建了一个单独的食谱，其他食谱可以重复使用。

在下面的示例中，我有一个食谱my_handlers：

recipes/json.rb
recipes/error_report.rb
recipes/email.rb
libraries/send_mail.rb

在my_handlers/recipes/email.rb中：

chef_gem 'chef-handler-mail'

chef_handler 'MailHandler' do
  source 'chef/handler/mail'
  arguments :to_address => 'root'
  action :enable
end

在my_handlers/libraries/send_mail.rb中：

require 'net/smtp'

module HandlerSendEmail
  class Helper

    def send_email_on_run_failure(node_name)
      message = "From: Chef <[email protected]>\n"
      message << "To: Grant <[email protected]>\n"
      message << "Subject: Chef run failed\n"
      message << "Date: #{Time.now.rfc2822}\n\n"
      message << "Chef run failed on #{node_name}\n"
      Net::SMTP.start('your.smtp.server',25) do |smtp|
        smtp.send_message message,'[email protected]','[email protected]'
      end
    end
  end
end

现在我可以在其他食谱中重复使用一些东西，并选择要启用的处理程序。

比方说，我有一本食谱cookbook1，在其中我想在失败时使用电子邮件处理程序：

在cookbook1/metadata.rb中：

depends 'my_handlers'

在recipes/default.rb中：

# Enable the Chef email handler by calling "my_handler"
include_recipe 'my_handlers::email'

Chef.event_handler do
  on :run_failed do
    HandlerSendEmail::Helper.new.send_email_on_run_failure(Chef.run_context.node.name)
  end
end

# Usual resource declarations

ruby_block 'fail the run' do
  block do
    fail 'deliberately fail the run'
  end
end

如果发生故障（故意如上所述），则将调用Chef电子邮件处理程序并触发一封指示故障的电子邮件。

我认为步骤3在文档中是错误的。应该是这样的：

# recipe:
chef_handler 'OrgName::SendEmail' do # Full class name
  # relative path to your handler
  source ::File.expandpath('../../files/default/handlers/send_mail.rb',__FILE__)
  arguments() # Hash or Array to pass to handler constructor
end

通常将处理程序存储在Cookbook的files/default/handlers/目录中，这就是source属性是这样的原因。在您的情况下，arguments不是必需的，因为处理程序中的initialize方法不需要任何参数。

chef-infra handler