第 5 章 关于软件目录
Red Hat Developer Hub Software Catalog 是一个集中的系统,可让您了解您生态系统中的所有软件,包括服务、网站、库和数据管道。您可以使用它来查看每个组件的所有权详情和元数据。
软件目录中组件的元数据作为 YAML 文件存储在您的版本控制系统中,该文件与您的代码一起存储在您的版本控制系统中。版本控制存储库可以包括一个或多个元数据文件。软件目录将项目组织为实体,其中包括组件、资源和 API 和其他相关类型。每个实体都包括相关的元数据,如其所有者、类型和其他相关详情。
通过将元数据存储在 YAML 文件中以及代码,您可以允许 Red Hat Developer Hub 通过清晰的可视界面处理和显示这些信息。借助软件目录,您可以管理和维护软件,了解生态系统中所有可用的软件,并获得您的服务和工具的所有权。
组件的 Overview 页面提供关键信息,如源代码的链接、文档、依赖项和所有权详情。您可以使用插件自定义此页面来满足特定的需求。
5.1. 在 Red Hat Developer Hub 实例中添加新组件
先决条件
- 已安装并配置了 Red Hat Developer Hub 实例。
- 您有所需的权限。请参阅 Red Hat Developer Hub 中的授权。
流程
您可以使用以下方法将组件添加到 RHDH 实例中:
-
使用 GUI 手动注册组件,或使用
app-config.yaml
与所需权限手动注册组件。 - 使用软件模板创建新组件。
- 使用带有所需权限的批量导入插件。如需更多信息,请参阅 Bulk 导入 GitHub 存储库。
5.1.1. 在 Red Hat Developer Hub 实例中创建新组件
您可以在 RHDH 实例的 Software Catalog 中创建新组件。Red Hat Developer Hub 会自动注册开发人员或平台工程师在软件目录中使用模板创建的所有组件。
先决条件
- 已安装并配置了 Red Hat Developer Hub 实例。
- 您有所需的权限。请参阅 Red Hat Developer Hub 中的授权。
流程
- 在 Red Hat Developer Hub 导航菜单中,点 Catalog。
- 在 Catalog 页面上,单击 Self-service。
5.1.2. 在您的 RHDH 实例中手动注册组件
要在 RHDH 实例中手动注册组件,请创建一个 catalog-info.yaml
文件,并将其注册到 Red Hat Developer Hub 实例。catalog-info.yaml
文件包含您要为软件组件注册的元数据。
先决条件
- 已安装并配置了 Red Hat Developer Hub 实例。
- 您有所需的权限。请参阅 Red Hat Developer Hub 中的授权。
流程
在软件项目的根目录中,创建名为
catalog-info.yaml
的文件。catalog-info.yaml
文件示例apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: _<your_software_component>_ description: _<software_component_brief_description>_ tags: - example - service annotations: github.com/project-slug: _<repo_link_of_your_component_to_register>_ spec: type: _<your_service>_ owner: _<your_team_name>_ lifecycle: _<your_lifecycle>_
apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: _<your_software_component>_ description: _<software_component_brief_description>_ tags: - example - service annotations: github.com/project-slug: _<repo_link_of_your_component_to_register>_ spec: type: _<your_service>_ owner: _<your_team_name>_ lifecycle: _<your_lifecycle>_
Copy to Clipboard Copied! -
将
catalog-info.yaml
文件提交到项目源代码存储库的根目录。 - 在 Red Hat Developer Hub 导航菜单中,进入 Catalog > Self-service。
- 在 Self-service 页面中,单击 Register Existing Component。
-
在 Register a existing component 页面中,在仓库中输入
catalog-info.yaml
文件的完整 URL。例如: Artist lookup component。 - 完成向导说明。
验证
- 您的软件组件列在 Software Catalog 中。您可以查看其详情并确保所有元数据都准确。