Register new software components

You can add new components to your Red Hat Developer Hub catalog by either generating new components from software templates or registering existing repositories manually.

Generate new components

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.

Before you begin

  • You have installed and configured the Red Hat Developer Hub instance.
  • If RBAC is enabled, you have a role with the following permissions: catalog.entity.create, scaffolder.template.parameter.read, scaffolder.template.step.read, scaffolder.task.create.

Procedure

  1. In your Red Hat Developer Hub navigation menu, click Catalog.
  2. On the Catalog page, click Self-service.
  3. Select the appropriate Software Template and follow the instructions to create the component.

Results

After the template workflow is complete, Red Hat Developer Hub registers the generated component in the Software Catalog.

Register existing components manually

To manually register components in your RHDH instance, create a catalog-info.yaml file and register it with your Red Hat Developer Hub instance.

Before you begin

  • You have installed and configured the Red Hat Developer Hub instance.
  • If RBAC is enabled, you have a role with the following permissions: catalog.entity.create, catalog.location.create.

Procedure

  1. In the root directory of your software project, create a file named 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>_
  2. Commit the catalog-info.yaml file to the root of your project source code repository.
  3. In your Red Hat Developer Hub navigation menu, go to Catalog > Self-service.
  4. On the Self-service page, click Register Existing Component.
  5. On the Register an existing component page, enter the full URL of the catalog-info.yaml file in your repository. For example: Artist lookup component.
  6. Complete the wizard instructions.

Results

  • Your software component is listed in the Software Catalog. You can view its details and ensure all the metadata is accurate.

Add new components to your Red Hat Developer Hub instance

You can add new components to expand your Developer Hub Software Catalog by registering them manually, creating them from Software Templates, or using bulk import.

Before you begin

  • You have installed and configured the Red Hat Developer Hub instance.
  • If RBAC is enabled, you have a role with the following permissions: catalog.entity.create, catalog.location.create, bulk.import.

Procedure

  • Add components to your RHDH instance using the following methods:
    • Register components manually using the GUI or by using your app-config.yaml with the required permissions.
    • Create new components by using Software Templates.
  • Use the bulk import plugin with the required permissions. For more information, see Configure bulk import capabilities.