Skip to content

Commit 56af4ef

Browse files
committed
Adding manually
1 parent 2a8c41e commit 56af4ef

File tree

1 file changed

+33
-5
lines changed

1 file changed

+33
-5
lines changed

modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,48 @@ You can add components to your {product-very-short} instance using the following
2121
2222
== Registering components manually in your {product-very-short} instance
2323

24+
You can manually register components in your {product-very-short} instance by creating a `catalog-info.yaml` file and adding it with {product}. The `catalog-info.yaml` file is a metadata for your software component.
25+
2426
.Prerequisites
2527

2628
* You have installed and configured the {product} instance.
2729
* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}].
2830

2931
.Procedure
3032

31-
To register components in the Software Catalog manually in your {product-very-short} instance, complete the following steps:
32-
33-
. In your {product} navigation menu, click *Catalog*.
34-
. On the *Catalog* page, click *Register Existing Component*.
35-
. On the *Register an existing component* page, enter the full URL to the YAML file you want to register. For example: link:https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/artist-lookup-component.yaml[Artist lookup component].
33+
To add a new component to your {product-very-short} instance, complete the following steps:
34+
35+
. In the root directory of your software project, create a file named `catalog-info.yaml` file.
36+
+
37+
--
38+
.`catalog-info.yaml` file example
39+
[source,yaml]
40+
----
41+
apiVersion: backstage.io/v1alpha1
42+
kind: Component
43+
metadata:
44+
name: _<your_software_component>_
45+
description: _<software_component_brief_description>_
46+
tags:
47+
- example
48+
- service
49+
annotations:
50+
github.com/project-slug: my-org/my-repo
51+
spec:
52+
type: service
53+
owner: team-name
54+
lifecycle: production
55+
----
56+
. Commit and the `catalog-info.yaml` file to the root of your project source code repository.
57+
. In your {product} navigation menu, go to *Catalog* > *Self-service*.
58+
. On the *Self-service* page, click *Register Existing Component*.
59+
. On the *Register an existing component* page, enter the full URL of the `catalog-info.yaml` file in your repository. For example: link:https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/artist-lookup-component.yaml[Artist lookup component].
3660
. Complete the wizard instructions.
3761

62+
.Verification
63+
64+
* Your software component is listed in the Software Catalog. You can view its details and ensure all the metadata is accurate.
65+
3866
== Creating new components in your {product} instance
3967

4068
You can create new components in the Software Catalog in your {product-very-short} instance. {product} automatically registers all components that developers or platform engineers create using Templates in the Software Catalog.

0 commit comments

Comments
 (0)