Skip to content

Commit

Permalink
update unregister docs (#1061)
Browse files Browse the repository at this point in the history
Signed-off-by: Kiss Miklos <miklos@roadie.io>
  • Loading branch information
kissmikijr authored Jul 6, 2023
1 parent 3d1098d commit cc27401
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions content/docs/details/unregister-components/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,18 @@ You can remove a component from Roadie Backstage if required in two ways dependi

If the path matches a Github Autodiscovery pattern in your Admin Settings and was therefore ingested automatically, you must delete the entity in question from Github by either removing the entry from the yaml file or deleting the file or repository altogether.

This should then remove the entity from your catalog within a minute or so.

This should then remove the entity from your catalog within a minute or so.

## Manually ingested entities

If you imported the entity manually using the url, and the path does not match a Github Autodiscovery pattern set for your organisation:

1. Go to the component in question i.e. `/catalog/default/component/sample-service` and click the kebab menu on the top right.
2. Select Inspect Entity
3. Select the Ancestry tab
4. Click on the "generated" location that is the parent of your current entity.
5. Click the kebab menu again on this generated location entity and select unregister entity.
![Remove item menu](./unregister-menu.png)
6. Go back to the entity in step 1 and unregister that also.

NB: you can always re-ingest the entity via the `/register-existing-component` page.
2. Select `Unregister entity` ![Remove item menu](./unregister-menu.png)
3. Review the content's that will be removed. It is ok to have a `location:generated-...` and the actual entity listed here.
4. Confirm
5. Your entities should be almost immediately removed from the catalog

If you see a big list of entities when you press `Unregister entity` it means that the entity is likely to be coming from a file which has multiple entities defined in it. Unfortunately you can only delete all of the entities that are coming from a file from the Roadie UI. To delete only one of the entities go to your SCM and delete the entity from the file.

NB: you can always re-ingest the entity via the `/register-existing-component` page.

0 comments on commit cc27401

Please sign in to comment.