@backstage/plugin-catalog-backend
Home > @backstage/plugin-catalog-backend
The Backstage backend plugin that provides the Backstage catalog
Classes
Class |
Description |
---|---|
A builder that helps wire up all of the component parts of the catalog. The touch points where you can replace or extend behavior are as follows:
| |
Legacy processor, should not be used. | |
Traverses raw entity JSON looking for occurrences of $-prefixed placeholders that it then fills in with actual data. | |
Functions
Function |
Description |
---|---|
Creates a function that returns a random processing interval between minSeconds and maxSeconds. | |
Transform a given entity policy to an entity processor. |
Interfaces
Interface |
Description |
---|---|
Represents the engine that drives the processing and stitching loops. Some backend instances may choose to not call start, if they focus only on API interactions. |
Variables
Variable |
Description |
---|---|
Catalog plugin | |
Type Aliases
Type Alias |
Description |
---|---|
This is where I get really vague. Something like this perhaps? Or it could be something like a json-schema that contains enough info for the frontend to be able to present a form and explanations | |
If the folder pointed to already contained catalog info yaml files, they are read and emitted like this so that the frontend can inform the user that it located them and can make sure to register them as well if they weren't already | |
This is some form of representation of what the analyzer could deduce. We should probably have a chat about how this can best be conveyed to the frontend. It'll probably contain a (possibly incomplete) entity, plus enough info for the frontend to know what form data to show to the user for overriding/completing the info. | |
This is a duplicate of the alpha | |
Holds the entity location information. | |
Function that returns the catalog processing interval in seconds. | |