From 683b3318a86962647c5b54da67a0baff0b6abe30 Mon Sep 17 00:00:00 2001 From: Vladimir Masarik Date: Mon, 21 Aug 2023 20:47:31 +0200 Subject: [PATCH] update configuration text as well Signed-off-by: Vladimir Masarik --- docs/features/software-catalog/configuration.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/features/software-catalog/configuration.md b/docs/features/software-catalog/configuration.md index 5abd266099..2f5edc3696 100644 --- a/docs/features/software-catalog/configuration.md +++ b/docs/features/software-catalog/configuration.md @@ -123,3 +123,14 @@ source that should be mirrored into Backstage. To make Backstage a mirror of this remote source, users cannot also register new entities with e.g. the [catalog-import](https://github.com/backstage/backstage/tree/master/plugins/catalog-import) plugin. + +## Clean up orphaned entities + +In short entities can become orphaned through multiple means, such as when a catalog-info YAML file is moved from one place to another in the version control system without updating the registration in the catalog. For safety reasons the default behavior is to just tag the orphaned entities, and keep them around. You can read more about orphaned entities [here](life-of-an-entity.md#orphaning). + +However, if you do with to automatically remove the orphaned entities, you can use the following configuration, and everything with an orphaned entity tag will be eventually deleted. + +``` +catalog: + orphanStrategy: delete +```