4.3. 跟踪组件源和软件模板版本
平台工程师使用软件模板构建过程中的自定义操作来构建和跟踪生成的实体(Component 或 Resource)与其源模板之间的依赖关系链接。这种关系称为构建可靠。
平台管理员在 scaffolder backend 模块中使用 catalog:scaffolded-from 和 catalog:template:version 等自定义操作来跟踪模板版本和对应的实体版本,从而简化生命周期管理。
4.3.1. 配置经过验证的红帽软件模板版本 Red Hat Developer Hub 复制链接链接已复制到粘贴板!
作为平台工程师,您必须修改 Software Template YAML 定义,以确保在构建过程中添加了所需的经验证信息。
先决条件
- 有 Red Hat Developer Hub 的管理员权限。
流程
-
找到您要添加证明信息的 Software Template 对象 YAML 文件,并添加使用
catalog:scaffolded-from操作的步骤。此操作会将生成的目录实体链接回源模板。 可选: 要跟踪模板版本(例如 v1.0 与 v1.5),请在
steps部分包含catalog:template:version操作。以下代码块是在steps部分添加 versioning 操作的示例:Copy to Clipboard Copied! Toggle word wrap Toggle overflow 其中:
steps:input:templateVersion读取 version 参数
注意catalog:template:version操作读取模板中定义的 version 参数,并将其作为注解应用到生成的目录实体。
在 Red Hat Developer Hub
app-config.yaml文件中,将catalog.locations部分配置为指向要添加的软件模板。您可能需要将Template添加到全局catalog.rules.allow列表中,或者在允许软件模板 estion 的位置添加一个粒度规则,如下例所示:Copy to Clipboard Copied! Toggle word wrap Toggle overflow 其中:
catalog.locations.type-
如果您要从存储库(如 GitHub 或 GitLab)导入模板,请输入
url类型。 catalog.locations.target- 输入模板的 URL。
catalog.locations.rules.allow-
输入
Template规则,以允许将新软件模板添加到目录中。
验证
使用更新的模板创建了组件后,验证生成的 Catalog Entity YAML 中的验证注解。
- 在 Red Hat Developer Hub 导航菜单中,进入 Catalog 并找到新创建的目录组件。
- 要查看将实体链接到模板的底层数据,请选择 INSPECT ENTITY 选项。
要验证验证注解,请完成以下步骤:
-
选择 YAML Raw 或 JSON Raw 视图,并验证
scaffoldedFrom链接的数据项是否存在。 可选:如果包含 versioning,请验证
backstage.io/template-version注解是否存在。注意如果将目录组件发布到外部存储库(如 Git),则该存储库中的组件文件也必须包含
backstage.io/template-version注解。
-
选择 YAML Raw 或 JSON Raw 视图,并验证
4.3.2. 查看软件模板依赖项 复制链接链接已复制到粘贴板!
作为开发者,您可以跟踪从特定软件模板创建哪些实体。当平台工程师对模板进行了验证时,您可以通过查看目录中所有链接的组件和资源来快速识别该模板的完整依赖项和影响映射。
流程
要查看从特定模板创建的所有组件,请完成以下步骤:
- 在 Red Hat Developer Hub 导航菜单中,单击 Catalog,使用过滤器来查找并选择要检查的 Software Template。
- 在 Software Template 详情页面中,点 Dependencies 选项卡。此视图列出了所有引用此模板的目录实体,如组件、资源和系统,包括配置时的任何版本信息。