使用 Augeas 自动修改配置文件

当然，有关标准的事物是如此之多。有时每个应用程序的配置格式都略有不同， 书写正则表达式来解析和修改所有这些配置文件是一项很烦人的工作。

幸好 Augeas 在这方面可以帮助我们。Augeas 是一个旨在简化使用不同配置文件格式工作的工具， 它将不同格式的配置文件统一呈现为一个简单的包含所有配置项的树状结构。 Puppet 的 Augeas 支持允许你创建 augeas 资源，它可以智能地自动地为所需的配置做相应的改变。

准备工作

在使用 Augeas 之前需要先安装它。如下的 Puppet 代码将添加 Augeas 到你的配置。

  1. 使用如下内容创建 /etc/puppet/modules/admin/manifests/augeas.pp 文件：

    class admin::augeas {
    package { [ "augeas-lenses",
                "augeas-tools",
                "libaugeas0",
                "libaugeas-ruby1.8" ]:
        ensure => "present"
    }
}

  2. 在一个节点上包含此类：

    node cookbook {
    include admin::augeas
}

  3. 运行 Puppet：

    # puppet agent --test
info: Retrieving plugin
info: Caching catalog for cookbook.bitfieldconsulting.com
info: Applying configuration version '1303657095'
notice: /Stage[main]/Admin::Augeas/Package[augeas-tools]/ensure:
ensure changed 'purged' to 'present'
notice: Finished catalog run in 21.96 seconds

操作步骤

  1. 使用如下内容创建 /etc/puppet/modules/admin/manifests/ipforward.pp 文件：

    class admin::ipforward {
    augeas { "enable-ip-forwarding":
        context => "/files/etc/sysctl.conf",
        changes => [
            "set net.ipv4.ip_forward 1",
        ],
    }
}

  2. 在一个节点上包含此类：

    node cookbook {
    include admin::augeas
    include admin::ipforward
}

  3. 运行 Puppet：

    # puppet agent --test
info: Retrieving plugin
info: Caching catalog for cookbook.bitfieldconsulting.com
info: Applying configuration version '1303729376'
notice: /Stage[main]/Admin::Ipforward/Augeas[enable-ipforwarding]/
returns: executed successfully
notice: Finished catalog run in 3.53 seconds

  4. 使用如下命令检查配置是否生效：

    # sysctl -p |grep forward
net.ipv4.ip_forward = 1

工作原理

下面将描述前面的代码是如何工作的：

  1. 我们声明了一个名为 enable-ip-forwarding 的 augeas 资源：

    augeas { "enable-ip-forwarding":

  2. 我们指定要实施改变的文件 /etc/sysctl.conf：

        context => "/files/etc/sysctl.conf",

  3. 将我们需要改变的设置作为一个数组（本例中只有一个数组元素）传递给 changes 参数：

        changes => [
        "set net.ipv4.ip_forward 1",
    ],

    通常使用 Augeas 改变设置需用如下的格式：

    set <parameter> <value>

    Augeas 使用一套名为 lenses 的转换文件，使其能够为给定的配置文件以适当的格式改写设置。 在本例中，此设置将转换为 /etc/sysctl.conf 文件中的如下一行：

    net.ipv4.ip_forward=1

更多用法

之所以使用 /etc/sysctl.conf 文件做例子，是因为它包含了各种各样的内核设置， 你可能想要在不同的 Puppet 类中因各种不同的目的而改变这些设置。 在前面的例子中，我们为一个路由器的类启用了 IP 转发， 然而你也可以为一个负载均衡的类调整 net.core.somaxconn 的值。

这意味着简单地对 /etc/sysctl.conf 文件“Puppet化”（"Puppetizing"） 并分发它不能胜任所有的情况，因为你要修改的设置根据不同的服务需求可能会有不同， 从而引发版本冲突。Augeas 则是这种情况的正确解决方案，因为你可以在不同的位置定义 augeas 资源去修改相同的配置文件，这样就不会引起冲突。

Augeas 是个强大的工具，使用 lenses 可以转换绝大多数标准的 Linux 配置文件， 而且如果需要管理自己的专有格式的配置文件，你也可以书写自己的专有配置格式。 更多关于使用 Puppet 和 Augeas 的信息，请访问 Puppet Labs 的 wiki 页面： http://projects.puppetlabs.com/projects/1/wiki/Puppet_Augeas 。