From da04ead6beac93d697e116bc2571242de1e5f3b4 Mon Sep 17 00:00:00 2001 From: Jack Palmer Date: Tue, 25 Feb 2025 20:31:02 +0000 Subject: [PATCH] chore: docs Signed-off-by: Jack Palmer --- docs/features/software-catalog/configuration.md | 11 +++++++++++ plugins/catalog-backend/config.d.ts | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/features/software-catalog/configuration.md b/docs/features/software-catalog/configuration.md index 6ed5a1d4b6..df252808eb 100644 --- a/docs/features/software-catalog/configuration.md +++ b/docs/features/software-catalog/configuration.md @@ -163,6 +163,17 @@ catalog: orphanStrategy: delete ``` +## Clean up entities from orphaned entity providers + +By default, if an entity provider which has provided entities to the catalog, is no longer configured, then the entities remain in the catalog until they are manually unregistered. + +To remove these entities automatically, you can use the following configuration. + +```yaml +catalog: + evictOrphanedEntityProviders: true +``` + ## Processing Interval The [processing loop](./life-of-an-entity.md#processing) is diff --git a/plugins/catalog-backend/config.d.ts b/plugins/catalog-backend/config.d.ts index 1169b4ccfa..057d581e80 100644 --- a/plugins/catalog-backend/config.d.ts +++ b/plugins/catalog-backend/config.d.ts @@ -218,7 +218,7 @@ export interface Config { useUrlReadersSearch?: boolean; /** - * Evicts entities from the catalog that are no longer referenced by entity providers added to the catalog. + * Evicts entities from the catalog when their related entity provider no longer exists. */ evictOrphanedEntityProviders?: boolean; };