Chef自定义资源如何优雅透传vault_certificate的全部属性
自定义Chef封装资源的属性透传方案
一、无hack的优雅实现
你目前用的“动态为自定义资源实例添加代理方法”的方案,本质是单例方法绑定,在Chef运行时的资源克隆、序列化场景下很容易丢失方法(比如why-run模式、资源审计功能触发的资源拷贝操作,都会导致单例方法失效,随机抛出方法未定义错误)。
不需要靠这类临时方案,Chef本身提供了原生的封装能力,完全匹配外观模式的需求:
- 优先使用Chef 15.3+内置的
delegate_property宏
这个能力是Chef核心专门为资源封装场景设计的,不需要手动遍历原资源属性列表做单例绑定,直接在自定义资源的类定义层面完成属性委托。
典型实现结构:
这种实现的核心优势是:委托关系是类级别的,和单个资源实例无关,不管Chef运行时对资源做多少次克隆、序列化,外部对# resources/vault_certificate_handle_exceptions.rb # 引入原vault_certificate对应的资源类定义 require 'chef_vault' ORIGINAL_CERT_RESOURCE = ChefVault::Resource::VaultCertificate # 批量将原资源的所有属性,委托到自定义资源内部持有的原资源实例上 delegate_property(*ORIGINAL_CERT_RESOURCE.properties.keys, to: :@internal_cert) # 自定义资源扩展的重试配置属性 property :max_retries, Integer, default: 3 action :create do # 直接在自定义资源的编译上下文持有原资源实例引用,不要将原资源提交到全局资源队列 @internal_cert = ORIGINAL_CERT_RESOURCE.new(new_resource.name, run_context) # 将外部传入的属性值同步到内部原资源实例 ORIGINAL_CERT_RESOURCE.properties.each do |prop_name, _| next if prop_name == :max_retries @internal_cert.send("#{prop_name}=", new_resource.send(prop_name)) end # 嵌入自定义的异常捕获、重试逻辑 retry_block(max_retries: new_resource.max_retries, retry_delay: 2) do @internal_cert.run_action(:create) end endcertificate_filename、key_filename这类属性的读取都能正常工作,使用体验和直接调用原生vault_certificate完全一致。 - 低版本Chef的替代优雅实现
如果使用的Chef版本低于15.3,没有delegate_property能力,也不需要动态绑定单例方法,只要在自定义资源类上实现统一的方法转发逻辑即可:
这种方式不需要提前遍历原资源的属性列表,所有属性读取请求会统一转发到内部持有的原资源实例上,可维护性远高于临时的单例方法绑定。# 在自定义资源类的顶层定义通用转发规则,所有实例通用 def method_missing(method_name, *args, &block) if defined?(@internal_cert) && @internal_cert.respond_to?(method_name) @internal_cert.send(method_name, *args, &block) else super end end # 必须同步实现这个方法,否则外部通过respond_to?检测方法存在性时会误判 def respond_to_missing?(method_name, include_private = false) (defined?(@internal_cert) && @internal_cert.respond_to?(method_name, include_private)) || super end
二、获取Chef资源全量定义属性的正确姿势
你之前尝试调用cert.properties不生效,核心原因是混淆了元数据的存储层级:properties是资源类的类方法,不是资源实例的实例方法,在实例上调用自然会抛出方法未定义的错误。
正确的获取路径:
- 先通过节点上下文拿到目标资源对应的类对象,再调用类上的
properties方法,返回的是包含所有已定义属性的Hash,key是属性名的Symbol,value是对应的属性定义对象。代码示例:# 获取vault_certificate对应的资源类 original_resource_class = Chef.resource_for_node(:vault_certificate, node) # 获取全量属性元数据 all_prop_definitions = original_resource_class.properties prop_name_list = all_prop_definitions.keys - 如果已经拿到了编译完成的资源实例,想获取实例上所有属性的当前取值,可以直接调用实例的
state方法,会返回当前实例所有属性值的Hash,这是实例级别的公开方法,不要和类级别的properties元数据方法混淆。
内容的提问来源于stack exchange,提问作者Simão Martins
相关产品推荐
相关产品推荐

