创建自定义的资源类型

优质

小牛编辑

138浏览

2023-12-01

该到你发挥创意的时间了。你已经知道了各种不同的 Puppet 资源类型：包（package）, 文件（file）、用户（user），等等。通常情况下，你既可以组合使用这些内置资源类型做你需要做的一切，又可以通过一个自定义 define 作为一种资源（以内置资源同样的方式）来使用（参见第 4 章书写更优质的配置清单中有关 define 的内容）。

但是，如果你需要创建自己的资源类型，Puppet 也可以很容易地实现。原生的资源类型都是使用 Ruby 书写的，为了创建自己的资源类型，你需要对 Ruby 有一个基本的了解。

让我们重新回顾一下 资源类型（type）和 提供者（provider）之间的区别。资源类型描述了一个资源和它可拥有的参数（例如，package 类型）。提供者则告诉 Puppet 如何针对特定的平台或情况去实现一个资源（例如，apt/dpkg 提供者为 Debian/Ubuntu 系统实现 package 资源）。

一种类型（如：package）可以有多个提供者（如：apt、yum、fink 等等）。如果你声明一个资源时没有指定提供者，Puppet 会根据环境选择一个最合适的提供者。

在本节中，我们将看到如何创建一个管理 Git 仓库的自定义资源类型；在下一节，我们将编写一个实现这种资源类型的提供者。

准备工作

在你的 puppet.conf 文件中启用 pluginsync（若还未启用）：
```
[main]
pluginsync = true
```
在你的 Puppet 仓库中，为你的插件和类型创建一个自定义模块（若还不存在）：
```
# cd /etc/puppet/modules
# mkdir custom
```
在这个模块中，创建 lib/puppet/type 目录：
```
# cd custom
# mkdir -p lib/puppet/type
```

操作步骤

在 type 目录中创建一个名为 gitrepo.rb 的文件，其内容如下：

Puppet::Type.newtype(:gitrepo) do
  ensurable

  newparam(:source) do
    isnamevar
  end

  newparam(:path)
end

工作原理

第一行注册一个名为 gitrepo 的新类型：

Puppet::Type.newtype(:gitrepo) do

ensurable 行确保自动给出该类型的属性（与 Puppet 内置的资源类似）：

  ensurable

现在，我们将给出此类型的一些参数。就目前而言，我们所需要的参数分别是： source 参数用于指定 Git 仓库源的 URL；path 参数用于告诉 Puppet 要在文件系统中的什么位置创建仓库。

  newparam(:source) do
    isnamevar
  end

isnamevar 声明告诉 Puppet 参数 source 是此类型的 namevar。因此当你声明这个资源的实例时，你给出的任何名字将被视为 source 的值。例如：

gitrepo { "git://github.com/puppetlabs/puppet.git":
  path => "/home/john/work/puppet",
}

最后，我们添加 path 参数：

  newparam(:path)

更多用法

一旦你熟悉了创建自己的资源类型的方法，你就可以使用自定义的资源类型替换复杂的 exec 资源，这会使你的配置清单更具可读性。然而，通过对自定义资源类型的代码添加一些文档和参数校验使其更强壮更具可重用性是一个好主意。

文档

我在上面故意举了一个简单的例子，但是当你要为生产环境开发真正的自定义类型时，你应该加入文档字符串描述类型及其参数的用途。例如：

Puppet::Type.newtype(:gitrepo) do
  @doc = "Manages Git repos"

  ensurable

  newparam(:source) do
    desc "Git source URL for the repo"
    isnamevar
  end

  newparam(:path) do
    desc "Path where the repo should be created"
  end
end

校验

当某人试图向资源传递错误的值时，你可以使用参数校验（validate）生成有用的错误信息。例如，你可以校验要创建仓库的目录是否已真实存在：

  newparam(:path) do
  validate do |value|
    basepath = File.dirname(value)
    unless File.directory?(basepath)
    raise ArgumentError , "The path %s doesn't exist" %basepath
    end
  end
  end

你也可以为参数指定一个允许的取值列表，例如：

newparam(:breakfast) do
  newvalues(:bacon, :eggs, :sausages)
end