chef-infra - Chef 包装 Recipe 最佳实践

Question

在学习 Chef 时，我发现包装 Recipe 的模式相互矛盾。例如。

一些 Recipe 使用default.rb，而另一些则使用customize.rb进行覆盖。

attributes/default.rb

attributes/customize.rb 

哪一个是最佳实践？

此外，一些包装 Recipe 在recipes/default.rb 文件中具有如下参数:

normal['foo']['bar'] = 42

而其他人则有

default['foo']['bar'] = 42

有些有

node.set['foo']['bar'] = 42

此外，一些 Recipe 使用符号和其他字符串

['foo']['bar']
[:foo][:bar]

我应该使用哪种风格？

更新

看起来 Chef 已经发布了官方风格指南，它至少解决了部分问题(例如符号与字符串)。 https://docs.chef.io/ruby.html#

Answer 1

我还没有看到任何关于如何覆盖包装器说明书中的属性的正式最佳实践，我认为必须选择一种风格，只要您的所有说明书在您的组织内保持一致，您就应该很好。以下是我个人的看法。

<小时/>

属性文件

我们最初遵循类似于您描述的 attributes/customize.rb 格式的分隔属性文件的风格。但是，我们发现将所有属性保留在 attributes/default.rb 中要简单得多，特别是因为我们的属性保持在 50 行代码以下。

覆盖优先级

我们始终使用lowest attribute precedence当覆盖我们的包装器说明书中的属性时。我们尽可能坚持default，因为优先顺序决定了您的 Recipe 的default 胜过包装的 Recipe default。

属性访问样式

您看到的大多数 Recipe 都使用字符串访问格式。

default['foo']['bar'] = 42

事实上有一个foodcritic rule特别不鼓励使用符号访问。 Foodcritic 还鼓励使用 consistent style for accessing attributes 。如果您正在决定一种样式，请记住社区已经决定了字符串访问格式。

但是，还有另一种方法。 Chef 中的属性不是 Hash，它们实际上是 Mash 。 Mash 恰好支持将属性作为方法访问，因此:

default.foo.bar = 42

我们更喜欢这种语法，因为它更紧凑。

但是，请谨慎，如 Tejay Cardon points out ，Chef 使用 method_missing 实现了这一点，因此如果属性名称与当前(或将来)node 对象方法相同，您可能会遇到问题。我们用我们的组织名称作为所有 Recipe 的序言，因此不太可能发生冲突，但是当我们覆盖社区 Recipe 时，我们可能会遇到问题。值得庆幸的是，测试应该可以发现任何此类错误。

注意事项

重写包装器说明书中的属性不会以令人惊讶的方式工作，特别是在涉及字符串插值时。这在 this blog post 中有很好的解释。 。主要要点是 Recipe 是否将属性定义为:

default['version'] = '1.0'
default['url'] = "http://example.com/#{node['version']}.zip"

并在您的包装器 Recipe 中覆盖版本:

default['version'] = '2.0'

default['url'] 仍将解析为 http://example.com/1.0.zip，而不是 http://example。 com/2.0.zip 如您所料。发生这种情况是因为 url 属性是在您的覆盖发生之前插入的。这篇博文进行了更深入的探讨，并提供了一个潜在的解决方案。

总结

归根结底，Chef 中有多种方法可以做事，而且社区仍处于成熟阶段。有一些关于编写可重复使用的 Recipe 等的最佳实践，但这些实践仍在不断发展。

您能做的最好的事情就是尝试各种风格并找出最适合您和您的团队的风格。一旦你决定了一种风格，我建议整理一份风格指南(我使用过 this Angular style guide as inspiration )。您还可以使用 custom foodcritic rules 强制执行您的风格指南。 。我们通过这种方法取得了成功。