You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc
+33-5Lines changed: 33 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,20 +21,48 @@ You can add components to your {product-very-short} instance using the following
21
21
22
22
== Registering components manually in your {product-very-short} instance
23
23
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
+
24
26
.Prerequisites
25
27
26
28
* You have installed and configured the {product} instance.
27
29
* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}].
28
30
29
31
.Procedure
30
32
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.
. 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].
36
60
. Complete the wizard instructions.
37
61
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
+
38
66
== Creating new components in your {product} instance
39
67
40
68
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