Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃殌 Feature: Remove entities from old EntityProviders by default #18067

Open
2 tasks done
jhaals opened this issue Jun 1, 2023 · 4 comments
Open
2 tasks done

馃殌 Feature: Remove entities from old EntityProviders by default #18067

jhaals opened this issue Jun 1, 2023 · 4 comments
Labels
area:catalog Related to the Catalog Project Area enhancement New feature or request help wanted Help/Contributions wanted from community members will-fix We will fix this at some point
Milestone

Comments

@jhaals
Copy link
Member

jhaals commented Jun 1, 2023

馃敄 Feature description

Deleting(uninstalling) an entityProvider or changing the EntityProvider name cause Entities to remain in the catalog unless manually removed. This causes hard to debug issues for users that for example move to a new Entity Provider or change their Entity Provider name leading to reference issues as the source_key(EntityProvider name) in the refresh_state_references table still remain. This manifest itself as deletion/sync issues as the Entity is "owned" by a provider which is in reality no longer in use so the entity will not be managed any longer.

鉁岋笍 Possible Implementation

Change the default startup behaviour of the Catalog to remove entities from EntityProviders that are no longer installed.
This will work for most users but will be undesirable if you shard your ingestion and have a subset of EntityProviders installed on some backends only. This could be mitigated by having a config flag to disable this behaviour.

Initially we could add said config flag but default it to false to retain the old behaviour and potentially avoid having to introduce a breaking change in the catalog.

馃憖 Have you spent some time to check if this feature request has been raised before?

  • I checked and didn't find similar issue

馃彚 Have you read the Code of Conduct?

Are you willing to submit PR?

No, I don't have time to work on this right now

@jhaals jhaals added the enhancement New feature or request label Jun 1, 2023
@jhaals jhaals added this to the Catalog 2.0 milestone Jun 1, 2023
@jhaals jhaals added area:catalog Related to the Catalog Project Area will-fix We will fix this at some point help wanted Help/Contributions wanted from community members labels Jun 1, 2023
@efenner-cambia
Copy link
Contributor

I would also love to see this change. We recently changed the name of one of our providers and ended up getting conflicting location warnings on every refresh cycle

@Manish3323
Copy link

+1

@benjdlambert
Copy link
Member

Discussed with @backstage/catalog-maintainers and we're thinking that this is a good idea. Going to look at picking this up soon.

@SonilPro
Copy link
Contributor

@benjdlambert any news on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:catalog Related to the Catalog Project Area enhancement New feature or request help wanted Help/Contributions wanted from community members will-fix We will fix this at some point
Projects
None yet
Development

No branches or pull requests

5 participants