Questo contenuto non è disponibile nella lingua selezionata.
Chapter 5. About Software Catalogs
The Red Hat Developer Hub Software Catalog is a centralized system that gives you visibility into all the software across your ecosystem, including services, websites, libraries, and data pipelines. You can use it to view ownership details and metadata for each component in one place.
The metadata for the components in your Software Catalog is stored as YAML files that live alongside your code in your version control system. The version control repositories can include one or many metadata files. Software Catalog organizes items as entities, which include Components, Resources, and APIs, and other related types. Each entity includes associated metadata such as its owner, type, and other relevant details.
By storing metadata in YAML files alongside the code, you allow Red Hat Developer Hub to process and display this information through a clear, visual interface. With the Software Catalog, you can manage and maintain your software, stay aware of all software available in your ecosystem, and take ownership of your services and tools.
The Overview page for a component provides key information such as links to the source code, documentation, dependencies, and ownership details. You can customize this page with plugins to suit specific needs.
5.1. Adding new components to your Red Hat Developer Hub instance Copia collegamentoCollegamento copiato negli appunti!
Prerequisites
- You have installed and configured the Red Hat Developer Hub instance.
- You have the required permissions. See Authorization in Red Hat Developer Hub.
Procedure
You can add components to your RHDH instance using the following methods:
-
Register components manually using the GUI or by using your
app-config.yamlwith the required permissions. - Create new components by using Software Templates.
- Use the bulk import plugin with the required permissions. For more information, see Bulk importing GitHub repositories.
5.1.1. Creating new components in your Red Hat Developer Hub instance Copia collegamentoCollegamento copiato negli appunti!
You can create new components in the Software Catalog in your RHDH instance. Red Hat Developer Hub automatically registers all components that developers or platform engineers create using Templates in the Software Catalog.
Prerequisites
- You have installed and configured the Red Hat Developer Hub instance.
- You have the required permissions. See Authorization in Red Hat Developer Hub.
Procedure
- In your Red Hat Developer Hub navigation menu, click Catalog.
- On the Catalog page, click Self-service.
5.1.2. Registering components manually in your RHDH instance Copia collegamentoCollegamento copiato negli appunti!
To manually register components in your RHDH instance, create a catalog-info.yaml file and register it with your Red Hat Developer Hub instance. The catalog-info.yaml file contains the metadata you wish to register for your software component.
Prerequisites
- You have installed and configured the Red Hat Developer Hub instance.
- You have the required permissions. See Authorization in Red Hat Developer Hub.
Procedure
In the root directory of your software project, create a file named
catalog-info.yaml.Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Commit the
catalog-info.yamlfile to the root of your project source code repository. - In your Red Hat Developer Hub navigation menu, go to Catalog > Self-service.
- On the Self-service page, click Register Existing Component.
-
On the Register an existing component page, enter the full URL of the
catalog-info.yamlfile in your repository. For example: Artist lookup component. - Complete the wizard instructions.
Verification
- Your software component is listed in the Software Catalog. You can view its details and ensure all the metadata is accurate.
5.2. Updating components in the Software Catalog in your Red Hat Developer Hub instance Copia collegamentoCollegamento copiato negli appunti!
You can update components in the Software Catalog in your Red Hat Developer Hub instance.
Prerequisites
- You have installed and configured the Red Hat Developer Hub instance.
- You have the required permissions. See Authorization in Red Hat Developer Hub.
Procedure
To update components in the Software Catalog in your Red Hat Developer Hub instance, complete the following steps:
- In your Red Hat Developer Hub navigation menu, click Catalog.
Find the software component that you want to edit, under Actions, click the Edit icon.
NoteThis action redirects you to the YAML file on GitHub.
On your remote repository UI, update your YAML file.
NoteAfter you merge your changes, the updated metadata in the Software Catalog appears after some time.
5.3. Searching and Filtering Software Catalogs Copia collegamentoCollegamento copiato negli appunti!
You can search and filter Software Catalogs by its Kind or by using the Filter field.
5.3.1. Searching and Filtering Software Catalogs by Kind Copia collegamentoCollegamento copiato negli appunti!
To filter a Software Catalog by its Kind, complete the following steps:
Procedure
- In your Red Hat Developer Hub navigation menu, click Catalog.
- On the Catalog page, click the Kind drop-down list.
Select the type of Kind you want to filter.
NoteThe available filter dropdowns vary based on the Kind you select, displaying options relevant to that specific entity type.
5.3.2. Searching and Filtering Software Catalogs using the Filter field Copia collegamentoCollegamento copiato negli appunti!
To filter a Software Catalog using the Filter field, complete the following steps:
Procedure
- In your Red Hat Developer Hub navigation menu, click Catalog.
- In the Search box, enter the text you want to use to filter the components.
5.4. Viewing the Software Catalog YAML file in your Red Hat Developer Hub instance Copia collegamentoCollegamento copiato negli appunti!
You can view the Software Catalog YAML file in your Red Hat Developer Hub instance. The YAML file displays the metadata for the components in your Software Catalog.
Procedure
To view the Software Catalog YAML file in your Red Hat Developer Hub instance, complete the following steps:
- In your Red Hat Developer Hub navigation menu, click Catalog.
Find the software component that you want to view, under Actions, click the View icon.
NoteThese steps redirect you to the YAML file on your remote repository.
5.5. Starring components in the Software Catalog Copia collegamentoCollegamento copiato negli appunti!
You can use the Add to favorites icon to add the software catalogs that you visit regularly to the Starred category.
Procedure
To quickly access the Software Catalogs that you visit regularly, complete the following steps:
- In your Red Hat Developer Hub navigation menu, click Catalog.
- Find the software component that you want to add as a favorite, under Actions, click the Add to favorites icon.
Verification
- The starred component is listed under Your Starred Entities on your Home page.