Added unregistering and deleting a component file

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2025-11-25 10:30:36 -05:00
parent cc60909224
commit 2250d7b604
1 changed files with 67 additions and 0 deletions
@@ -0,0 +1,67 @@
+---
+id: unregister-delete-component
+title: Unregistering and deleting a component
+description: Unregistering and deleting a component from the catalog
+---
+
+Audience: Developers
+
+## Overview
+
+URLs to YAML files that you registered either using the `Create` button or by adding to your app-config file are both handled by entity providers.
+
+[Implicit deletion](../features/software-catalog/life-of-an-entity.md#implicit-deletion) occurs when an entity provider issues a deltion of an entity. That entity, as well as the entire tree of entities processed out of it are considered for immediate deletion.
+
+However, you are also able to manually unregister an entity from the catalog or perform a direct, [explicit deletion](../features/software-catalog/life-of-an-entity.md#explicit-deletion), of individual entities. This is especially useful for removing [orphaned entities](../features/software-catalog/life-of-an-entity.md#orphaning).
+
+## Unregisteing an entity
+
+You can unregister an entity so it will not be displayed in the Catalog but still keep its catalog-info.yaml file in the repository. This provides the ability to register the entity again in the future.
+
+To unregister an entity:
+
+1. In the Catalog, select the entity you want to delete. In this example, `mytutorial` is being deleted.
+
+2. Select the three dots.
+3. Select `Unregister entity` in the dropdown menu.
+
+   ![Screenshot of selecting unregister entity.](../assets/uiguide/select-unregister-entity-from-three-dots.png)
+
+4. Select `UNREGISTER LOCATION`.
+
+   The entity is removed from the Catalog.
+
+   ![Screenshot of confirming unregister entity.](../assets/uiguide/confirm-unregister-entity.png)
+
+## Deleting an entity
+
+You can also delete an entity from the catalog. However, this requires that you also delete the `catalog-info.yaml` entity definition file associated with the entity.
+
+To delete an entity:
+
+1. Delete the following entity definition files for the entity in the repository:
+
+   - catalog-info.yaml
+   - index.js
+   - packaage.json
+
+2. In the Backstage App Catalog view, select the entity being deleted. In this example, `mytutorial` is being deleted.
+
+   Since you have deleted the entity definition files, an error is displayed that states the `catalog-info.yaml` file cannot be found.
+
+   ![Screenshot of error finding catalog info yaml file.](../assets/uiguide/error-message-catalog-info-file-deleted.png)
+
+3. Select the three dots.
+4. Select `Unregister entity` in the dropdown menu.
+
+   ![Screenshot of selecting unregister entity.](../assets/uiguide/select-unregister-entity-from-three-dots.png)
+
+5. Select `ADVANCED OPTIONS`.
+
+   ![Screenshot of selecting advanced options.](../assets/uiguide/select-advanced-options.png)
+
+6. Select `DELETE ENTITY`.
+
+   ![Screenshot of selecting delete entity.](../assets/uiguide/select-delete-entity.png)
+
+   A confirmation message that the entity has been successfully deleted is briefly displayed.The entity is no longer displayed in the Catalog.