Terraform中`metadata.yaml`文件的功能及文档查询

我在各类GCP官方Terraform代码仓库里发现了metadata.yaml文件，比如Cloud Functions、Cloud Workflows的模块仓库中都存在这类文件。

示例内容如下：

apiVersion: blueprints.cloud.google.com/v1alpha1
kind: BlueprintMetadata
metadata:
  name: terraform-google-cloud-functions
  annotations:
    config.kubernetes.io/local-config: "true"
spec:
  title: Terraform Google Cloud Functions (Gen 2) module
  source:
    repo: sso://user/prabhuramasamy/terraform-google-cloud-functions
    sourceType: git
  version: 0.6.0
  actuationTool:
    type: Terraform
    version: '>= 0.13'
  examples:
  - name: cloud_function2_gcs_source
    location: examples/cloud_function2_gcs_source
  - name: cloud_function2_pubsub_trigger
    location: examples/cloud_function2_pubsub_trigger
  ...

请问这类文件的作用是什么？另外，该文件的相关官方文档在哪里？我自己搜索没找到有效的信息。

文件作用 #

这类metadata.yaml是**GCP Blueprints（蓝图）**的元数据定义文件，专门用于描述GCP官方Terraform模块的核心信息，主要作用包括：

• 标准化模块元数据：统一定义模块名称、版本、兼容的Terraform版本、示例代码路径等关键信息
• 对接GCP蓝图生态工具：供GCP的蓝图管理工具识别、索引和展示模块，方便用户查找和使用官方合规的Terraform模块
• 支撑自动化流程：在模块发布、文档自动生成、合规检查等流程中提供必要的元数据，确保模块符合GCP官方规范

相关文档位置 #

该文件属于GCP Cloud Foundation Toolkit (CFT) 生态的一部分，相关规范文档主要在GCP官方的CFT蓝图体系中：

• 它是BlueprintMetadata自定义资源定义（CRD）的具体实现，属于GCP蓝图框架的核心组成部分
• 官方文档集中在CFT的开发指南和模块模板规范里，不过因为当前是v1alpha1预览版本，相关文档可能分散在CFT的官方文档站点中，主要针对模块开发者说明如何编写符合规范的元数据文件

内容的提问来源于stack exchange，提问作者Vincent Yin