使用纯 Ruby 代码书写配置清单

你会说西班牙语吗?学习一门语言可能会很有趣,但并非所有人都想这么做。 Puppet 有时会因为它使用自己专用的配置语言而不是现存的通用语言(如 Ruby)书写配置清单而遭到批评。

不是每个人都认为这是个缺点。计算机科学家 Dennis Ritchie 说:

A language that doesn’t have everything is actually easier to program in than some that do.

— Dennis Ritchie

无论你是什么观点,这种批评已不再适用。因为 Puppet 已经拥有了使用 Ruby 语言书写配置清单的实验性支持,这在生产环境上是相当有用的,即使还处于早期开发阶段。 在你的配置清单中可以混合使用两种语言,Puppet 以文件扩展名进行区别,扩展名 .rb 表示用 Ruby 语言书写的配置清单文件,而扩展名 .pp 表示 Puppet 专用的配置语言文件。

为了书写配置清单使用的 Ruby 的 特定领域语言domain-specific language,DSL) 看上去与标准的 Puppet 语言非常相似。 在下面的例子中,我将向你展示如何将典型的 Puppet 配置清单转换成 Ruby 的。 Puppet 语法的原始配置清单如下:

class admin::exim {
    package { "exim4": ensure => installed }

    service { "exim4":
        ensure  => running,
        require => Package["exim4"],
    }

    file { "/etc/exim4/exim4.conf":
        content => template("admin/exim4.conf"),
        notify  => Service["exim4"],
        require => Package["exim4"],
    }
}

操作步骤

  1. 使用如下内容创建 /etc/puppet/modules/admin/manifests/exim.rb 文件:

    hostclass "admin::exim" do
        package "exim4", :ensure => :installed
    
        service "exim4",
            :ensure  => :running,
            :require => "Package[exim4]"
    
        file "/etc/exim4/exim4.conf",
            :content => template(["admin/exim4.conf"]),
            :notify  => "Service[exim4]",
            :require => "Package[exim4]"
    end
    
  2. 在一个节点中包含这个类并运行 Puppet。

工作原理

  1. 关键字 hostclass 声明一个类,就像 Puppet 中的 class:hostclass admin::exim do

  2. 然后跟一个 do … end 语句块,这相当于 Puppet 的一对大括号。

  3. 通过在资源类型后调用函数来声明资源: 例如 package 或 service:package "exim4", :ensure => :installed

  4. 传递给函数的参数是一个用逗号分割的列表,参数必须要用双引号括起来, 或者在参数前使用前导的冒号使其成为 Ruby symbol 对象: :ensure => :running,

    又如,像 :installed 或 :running 这样的 Puppet 内置名字都是 Ruby 的 symbol 对象。

    | 注记 | 译者注

    有关 Ruby Symbol 的详细介绍请参考: http://www.ibm.com/developerworks/cn/opensource/os-cn-rubysbl/

    |

  5. 当我们需要引用资源来表示相互关系时,就要使用 :require, 资源标识符通过首字母大写的资源类型跟上写在一对方括号中的资源名给出,例如: require => "Package[exim4]"

    在调用像模板这样的函数时可以使用函数名跟一对圆括号,在圆括号中传递的参数是 一对用方括号声明的数组,例如::content => template(["admin/exim4.conf"]),。

更多用法

Ruby DSL 尚处于早期开发阶段。试验虽然有趣,除非你有使用 Ruby 的令人信服的理由否则先别用它, 至今我仍旧使用标准的 Puppet 语言。或许将来 Ruby DSL 会被广泛应用,但在此期间, 你会发现没有它的生活会更轻松。然而,若你坚持要使用它,下面介绍几个非常有用的提示。

变量

当你像常规的 Ruby 程序一样使用 Ruby 变量时,可以使用 scope.lookupvar 访问你的 Puppet 变量,例如:

notice( "I am running on node %s" % scope.lookupvar("fqdn") )

将得到:

notice: I am running on node cookbook.bitfieldconsulting.com

要在你的 Puppet 配置清单范围内设置变量,使用 scope.setvar,例如:

require 'time'
scope.setvar("now", Time.now)
notice( "At the third stroke, the time sponsored by Bitfield
Consulting will be: %s" % scope.lookupvar("now") )

上面的代码将获得如下结果:

notice: At the third stroke, the time sponsored by Bitfield Consulting
will be: Wed Mar 23 05:58:16 -0600 2011
文档

你可以在 Puppet Labs 网站找到更多如何使用 Ruby DSL 的详细资料,包括诸如 virtual resourcescollections 这样的高级主题: http://projects.puppetlabs.com/projects/1/wiki/Ruby_Dsl

Ken Barber 提供了一些语法例子,并对 Puppet 语法和 Ruby DSL 结构做了比较,网址在 https://github.com/bobsh/puppet-rubydsl-examples

最后,James Turnbull 发布过一篇 blog, 展示了使用 Ruby 连接 MySQL 服务器的高级方法: http://www.puppetlabs.com/blog/using-ruby-inthe-puppet-ruby-dsl/