Procedure

1. The Bulk Import plugins are installed but disabled by default. To enable the ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import-backend-dynamic and ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import plugins, edit your dynamic-plugins.yaml with the following content:

   plugins:
     - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import-backend-dynamic
       disabled: false
     - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import
       disabled: false

   See Installing and viewing plugins in Red Hat Developer Hub.

2. Configure the required bulk.import RBAC permission for the users who are not administrators as shown in the following code:

   rbac-policy.csv fragment

   p, role:default/bulk-import, bulk.import, use, allow
   g, user:default/<your_user>, role:default/bulk-import

   Note that only Developer Hub administrators or users with the bulk.import permission can use the Bulk Import feature. See Permission policies in Red Hat Developer Hub.

Verification

1. The sidebar displays a Bulk Import option.
2. The Bulk Import page shows a list of added GitHub repositories and GitLab projects.

Procedure

1. Click Bulk Import in Developer Hub left sidebar.
2. If your RHDH instance has multiple source control tools configured, select GitHub from the Source control tool list.

3. Select the repositories to import, and validate.

   Developer Hub creates a pull request in each selected repository to add the required catalog-info.yaml file.

4. For each repository to import, click PR to review and merge the changes in GitHub.

Verification

1. Click Bulk Import in Developer Hub left sidebar.
2. Verify that each imported GitHub repository in the Selected repositories list has the status Waiting for approval or Imported.
3. For each Waiting for approval repository, click the pull request link to review and merge the catalog-info.yaml file in the corresponding repository.

Procedure

1. Access your Developer Hub backend logs where audit log events are recorded.

2. Review the following Bulk Import audit log events to monitor repository operations:

   BulkImportUnknownEndpoint

   Tracks requests to unknown endpoints.

   BulkImportPing

   Tracks GET requests to the /ping endpoint, which allows us to make sure the bulk import backend is up and running.

   BulkImportFindAllOrganizations

   Tracks GET requests to the /organizations endpoint, which returns the list of organizations accessible from all configured GitHub Integrations.

   BulkImportFindRepositoriesByOrganization

   Tracks GET requests to the /organizations/:orgName/repositories endpoint, which returns the list of repositories for the specified organization (accessible from any of the configured GitHub Integrations).

   BulkImportFindAllRepositories

   Tracks GET requests to the /repositories endpoint, which returns the list of repositories accessible from all configured GitHub Integrations.

   BulkImportFindAllImports

   Tracks GET requests to the /imports endpoint, which returns the list of existing import jobs along with their statuses.

   BulkImportCreateImportJobs

   Tracks POST requests to the /imports endpoint, which allows to submit requests to bulk-import one or many repositories into the Developer Hub catalog, by eventually creating import pull requests in the target repositories.

   BulkImportFindImportStatusByRepo

   Tracks GET requests to the /import/by-repo endpoint, which fetches details about the import job for the specified repository.

   BulkImportDeleteImportByRepo

   Tracks DELETE requests to the /import/by-repo endpoint, which deletes any existing import job for the specified repository, by closing any open import pull request that could have been created.

   Example audit log output:

   {
     "actor": {
       "actorId": "user:default/myuser",
       "hostname": "localhost",
       "ip": "::1",
       "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
     },
     "eventName": "BulkImportFindAllOrganizations",
     "isAuditLog": true,
     "level": "info",
     "message": "'get /organizations' endpoint hit by user:default/myuser",
     "meta": {},
     "plugin": "bulk-import",
     "request": {
       "body": {},
       "method": "GET",
       "params": {},
       "query": {
         "pagePerIntegration": "1",
         "sizePerIntegration": "5"
       },
       "url": "/api/bulk-import/organizations?pagePerIntegration=1&sizePerIntegration=5"
     },
     "response": {
       "status": 200
     },
     "service": "backstage",
     "stage": "completion",
     "status": "succeeded",
     "timestamp": "2024-08-26 16:41:02"
   }

Procedure

1. In your Red Hat Developer Hub navigation menu, click Catalog.

2. Find the software component that you want to edit, under Actions, click the Edit icon.

   Note

   This action redirects you to the YAML file on GitHub.

3. On your remote repository UI, update your YAML file.

   Note

   After you merge your changes, the updated metadata in the Software Catalog appears after some time.

Procedure

1. In your Red Hat Developer Hub navigation menu, click Catalog.
2. On the Catalog page, click the Kind drop-down list.

3. Select the Kind you want to filter by, such as Component, API, or Template.

   Note

   The available filter lists change based on the Kind you select, showing options relevant to that entity type.

Procedure

1. In your Red Hat Developer Hub navigation menu, click Catalog.
2. In the Search field, enter a component name, description, or keyword that you are looking for.

Procedure

1. In your Red Hat Developer Hub navigation menu, click Catalog.

2. Find the software component that you want to view, under Actions, click the View icon.

   Note

   These steps redirect you to the YAML file on your remote repository.

Procedure

1. In the Red Hat Developer Hub navigation menu, select Catalog.
2. Locate the components you want to add as a favorite.
3. In the Actions column for that component, click the Add to favorites (star) icon.

Procedure

1. On the Red Hat Developer Hub navigation menu, click Catalog > Self-service or in the Global Header, click Create (+).
2. On the Self-service page, locate the Templates you want to use and click Choose to start the scaffolding process.
3. Follow the wizard instructions to enter the required project details.

4. In the Review step, verify your parameters and click Create.

   The scaffolding process begins. You can monitor the progress in the logs or click Cancel to stop the operation.

Procedure

1. In the Red Hat Developer Hub navigation menu, click Catalog > Self-service.
2. In the Search field, enter the name for the Software Template.
3. Optional: To refine the results, select a category from the Category list.

Procedure

1. Open your RHDH app-config.yaml configuration file.

2. In the catalog.rules section, add a rule to allow Templates kinds, as shown in the following example:

   # ...
   catalog:
     rules:
       - allow: [Template]
     locations:
       - type: url
         target: https://<repository_url/template-name>.yaml
   # ...

   where:

   catalog.rules.allow

   Specify the Template rule to allow new Software Templates in the catalog.

   catalog.locations.type

   Specify the url type when importing templates from a repository (for example, GitHub or GitLab).

   catalog.locations.target

   Specify the full URL to the template file.

Verification

1. In the Red Hat Developer Hub navigation menu, click Catalog.
2. From the Kind list, select Template.
3. Verify that the Template list displays your template.