创建自定义的提供者

优质

小牛编辑

137浏览

2023-12-01

在上一节，我们创建了一个新的名为 gitrepo 的自定义资源类型并告诉 Puppet 此类型需要携带两个参数，分别为 source 和 path。然而到目前为止，我们还没有告诉 Puppet 如何检出仓库，即如何创建这种类型的具体实例。这正是提供者（provider）的用武之地。

正如我们之前看到的，一个类型经常会有几种可能的提供者。在本例中，对一个 Git 仓库进行实例化仅有一种明智的方法，所以我们只需一个提供者：git。如果你想要扩展这个自定义类型（将其称之为 repo 而非 gitrepo），不难想象只要针对不同类型的仓库创建若干不同的提供者即可，例如：git、svn、cvs 等等。

准备工作

在你的 custom 模块的 lib/puppet 目录中, 创建一个名为 provider/gitrepo 的子目录：
```
# mkdir -p lib/puppet/provider/gitrepo
```

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

require 'fileutils'

Puppet::Type.type(:gitrepo).provide(:git) do
  commands :git => "git"

  def create
    git "clone", resource[:source], resource[:path]
  end

  def exists?
    File.directory? resource[:path]
  end
end

操作步骤

在 Puppet 配置清单中添加如下代码为新的资源类型 gitrepo 创建一个实例：

gitrepo { "https://github.com/puppetlabs/puppet.git":
  path   => "/tmp/puppet",
  ensure => present,
}

现在运行 Puppet，你的新类型将被加载并进行了实例化：

# puppet agent --test
info: Retrieving plugin
notice: /File[/var/lib/puppet/lib/puppet]/ensure: created
notice: /File[/var/lib/puppet/lib/puppet/provider]/ensure: created

notice: /File[/var/lib/puppet/lib/puppet/provider/gitrepo]/ensure:
created

notice: /File[/var/lib/puppet/lib/puppet/provider/gitrepo/git.rb]/
ensure: defined content as '{md5}a12870d89a4b517e48fe417ce2e12ac2'

notice: /File[/var/lib/puppet/lib/puppet/type]/ensure: created

notice: /File[/var/lib/puppet/lib/puppet/type/gitrepo.rb]/ensure:
defined content as '{md5}90d5809e1d01dc9953464e8d431c9639'

info: Loading downloaded plugin /var/lib/puppet/lib/puppet/
provider/gitrepo/git.rb

info: Loading downloaded plugin /var/lib/puppet/lib/puppet/type/
gitrepo.rb

info: Redefining gitrepo in Puppet::Type
info: Caching catalog for cookbook.bitfieldconsulting.com
info: Applying configuration version '1299850325'

notice: /Stage[main]//Node[cookbook]/Gitrepo[https://github.com/
puppetlabs/puppet.git]/ensure: created

notice: Finished catalog run in 74.43 seconds

注意：由于 Puppet 的一个错误，当你首次创建新类型的实例时，可能需要两次运行 puppet agent：第一次加载类型的定义，第二次才真正创建实例。如果你看到如下的信息：

err: /Stage[main]//Node[cookbook]/Gitrepo[https://
github.com/puppetlabs/puppet.git]: Could not
evaluate: No ability to determine if gitrepo exists

就意味着你正遭遇此错误带来的困扰 — 别急，再次运行 Puppet 即可正常工作。当你读到本书的出版物时，这个错误很可能已经被修复。

工作原理

首先我们为 gitrepo 类型注册一个资源类型的提供者：

Puppet::Type.type(:gitrepo).provide(:git) do

当你在配置清单中声明此类型的一个实例时，Puppet 会先检查是否有已经存在的实例：

def exists?
  File.directory? resource[:path]
end

Puppet 会调用我们实现的 exists? 方法来做这种检查。如果已有一个匹配实例 path 参数的目录存在，它返回 true。

如果 exists? 返回 true，那么 Puppet 将不会采取进一步的行动，否则 Puppet 将通过调用 create 方法试图创建这个资源：

def create
  git "clone", resource[:source], resource[:path]
end

在这种情况下，create 方法会执行 git clone ，这会将原始仓库（由 source 参数指定）克隆到由 path 参数指定的目录。

创建自定义的提供者

准备工作

操作步骤

工作原理

更多用法