红帽全球峰会This documentation is for a release that is no longer maintained
See documentation for the latest supported version.7.2. 创建模板作为 YAML 文件
您可以通过将 Template 对象定义为 YAML 文件来创建模板。
Template 对象描述了模板及其元数据。它还包含必要的输入变量以及由 scaffolding 服务执行的操作列表。
模板 对象示例
apiVersion: scaffolder.backstage.io/v1beta3
kind: Template
metadata:
name: template-name
title: Example template
description: An example template for v1beta3 scaffolder.
spec:
owner: backstage/techdocs-core
type: service
parameters:
- title: Fill in some steps
required:
- name
properties:
name:
title: Name
type: string
description: Unique name of the component
owner:
title: Owner
type: string
description: Owner of the component
- title: Choose a location
required:
- repoUrl
properties:
repoUrl:
title: Repository Location
type: string
steps:
- id: fetch-base
name: Fetch Base
action: fetch:template
# ...
output:
links:
- title: Repository
url: ${{ steps['publish'].output.remoteUrl }}
- title: Open in catalog
icon: catalog
entityRef: ${{ steps['register'].output.entityRef }}
# ...
apiVersion: scaffolder.backstage.io/v1beta3
kind: Template
metadata:
name: template-name
title: Example template
description: An example template for v1beta3 scaffolder.
spec:
owner: backstage/techdocs-core
type: service
parameters:
- title: Fill in some steps
required:
- name
properties:
name:
title: Name
type: string
description: Unique name of the component
owner:
title: Owner
type: string
description: Owner of the component
- title: Choose a location
required:
- repoUrl
properties:
repoUrl:
title: Repository Location
type: string
steps:
- id: fetch-base
name: Fetch Base
action: fetch:template
# ...
output:
links:
- title: Repository
url: ${{ steps['publish'].output.remoteUrl }}
- title: Open in catalog
icon: catalog
entityRef: ${{ steps['register'].output.entityRef }}
# ...- 1
- 指定模板的名称。
- 2
- 指定模板的标题。这是在 Create… 视图中的模板标题上可见的标题。
- 3
- 指定模板的描述。这是在 Create… view 中的模板标题上可见的描述。
- 4
- 指定模板的所有权。
owner字段提供有关负责维护或监督系统或机构中模板的信息。在提供的示例中，owner字段设置为backstage/busybox-core。这意味着此模板属于backstage命名空间中的 zFCP-core项目。 - 5
- 指定组件类型。此必填字段接受任何字符串值，但您的组织应为其建立正确的税款。Red Hat Developer Hub 实例可能会读取此字段，并根据它的值的不同行为。例如，
Web 站点类型组件可能会在特定于 Web 站点的 Red Hat Developer Hub 界面中显示工具。此字段通常有以下值：
service- 后端服务，通常是公开 API。
网站- 网站。
程序库- 软件库，如 npm 模块或 Java 库。
- 6
- 当用户使用 Red Hat Developer Hub 控制台中的模板创建组件时，使用
parameters部分为用户输入指定参数。每个参数子部分由标题和属性定义，创建一个具有该定义的新表单页面。 - 7
- 使用
steps部分指定后端中执行的步骤。这些步骤必须通过使用唯一的步骤 ID、名称和操作来定义。您可以通过访问 URLhttps://<rhdh_url>/create/actions来查看 Red Hat Developer Hub 实例上可用的操作。 - 8
- 使用
output部分指定使用模板时创建的输出数据的结构。output部分（特别是links子部分）为用户提供了可用于访问和与从模板创建的组件交互的宝贵引用和 URL。 - 9
- 提供与生成组件关联的存储库的引用或 URL。
- 10
- 提供允许用户在列出各种组件的目录或目录中打开生成的组件的参考或 URL。
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}