SuperAPI AI 工具集

provider-resources

编程与开发

查看项目

更新于 10-15 22:12

技能介绍

本指南面向使用 Terraform Plugin Framework 开发 Provider 资源与数据源的场景。用途:资源表示由 Create、Read、Update、Delete 管理的基础设施对象;数据源为只读、无副作用。新资源与数据源一律使用 Plugin Framework;SDKv2 仅用于维护已有资源。可通过 terraform-plugin-mux 让同一 Provider 同时服务两套代码,迁移无需一次性重写。判断现有 Provider 模式可查 go.mod:含 terraform-plugin-mux 表示两者并存;仅 terraform-plugin-sdk/v2 表示 SDKv2 专用;仅 terraform-plugin-framework 表示 Framework 专用。迁移 SDKv2 资源需谨慎,Framework 区分 null 与零值,简单迁移会改变既有用户行为。

主要能力与用法:资源为持有 API 客户端的结构体,配合接口断言显式声明能力;Metadata 设置资源名,Configure 从 ProviderData 取客户端。Schema 使用 schema.Schema 与各类 Attribute,计划修饰符包括 RequiresReplace、UseStateForUnknown,校验器包括 LengthBetween、RegexMatches、OneOf、Between、SizeAtLeast,敏感属性用 Sensitive。CRUD 中,Create 从 Plan 取数据、调用 API、写回状态,对最终一致性 API 应等待可用后再返回;Read 遇到带外删除需调用 RemoveResource 将资源移出状态;Update 仅对实际变化的属性调用 API;Delete 将“已不存在”视为成功;Import 通过 ResourceWithImportState 与 ImportStatePassthroughID 实现,多段标识符可用分隔符解析。建议把“取单个对象或类型化未找到”集中到 finder,用 retry.StateChangeConf 等待状态变化,状态函数基于 finder。测试至少包含 basic(含导入步骤与 ImportStateVerify)与 disappears,命名遵循 TestAcc{Resource}{group?}{description} 等规则。文档先写 MarkdownDescription,再用 tfplugindocs 生成。

限制与注意:不得用消息文本匹配 API 错误,应按类型匹配并用 %w 保留原因;不应添加多余 id 属性;资源应只与一个 API/服务交互;跨服务资源会破坏权限、审计与端点配置。是否提供收费、平台、价格信息暂未提供。提交前需确认使用 Framework、实现完整 CRUD、Read 移除缺失资源、Delete 容忍已删除、无冗余 id、导入有测试覆盖等。