https://github.com/codesandtags/backstage-huge-catalog
Representation of a huge backstage catalog following several approaches
https://github.com/codesandtags/backstage-huge-catalog
Last synced: 8 months ago
JSON representation
Representation of a huge backstage catalog following several approaches
- Host: GitHub
- URL: https://github.com/codesandtags/backstage-huge-catalog
- Owner: codesandtags
- Created: 2023-08-17T15:41:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T14:37:10.000Z (almost 3 years ago)
- Last Synced: 2025-03-13T09:39:29.428Z (over 1 year ago)
- Language: Shell
- Size: 3.84 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Backstage Huge Catalog
This repo represents a huge catalog of components, apis, teams, domains and systems to simulate a real world backstage instance.
I have defined 2 approaches to use this catalog:
1. Centralized catalog
2. Decentralized catalog
For more information about the approaches, please check the `excalidraw` diagram in the `docs` folder.
## Centralized Catalog
In this approach, the catalog is defined in a single file `all.yaml` and all the entities are referenced from this file using the Location kind. Using this approach the catalog will be generated from one single file.
You will have something like this:
```sh
all-apis.yaml
all-components.yaml
all-domains.yaml
all-entities.yaml
all-groups.yaml
all-systems.yaml
|____apis
| |____api-0.yaml
| |____api-n.yaml
|____components
| |____component-0.yaml
| |____component-n.yaml
|____domain
| |____domain-0.yaml
| |____domain-n.yaml
|____groups
| |____group-0.yaml
| |____group-n.yaml
|____systems
| |____system-0.yaml
| |____system-n.yaml
```
## Decentralized Catalog
In this approach, the catalog is generated using different folders to represent `repos` and each folder contains a `catalog-info.yaml` file that defines the entities for that repo. Using this approach the catalog can be generated using a provider to filter the information or using the discovery option.
You will have something like the next example, where each folder represents a repo:
```sh
.
|____petstore
| |____catalog-info.yaml
|____artist-lookup
| |____catalog-info.yaml
|____n
| |____catalog-info.yaml
```
If you want to see a real example on Github with this approach, please check the next organization, where I have created a catalog with the next entities:
```json
"generator": {
"groups": 10,
"components": 1000,
"apis": 1000,
"domains": 5,
"systems": 10,
},
```
https://github.com/ricteam
### ⚠️ Warning
Running the script will generate a lot of traffict to Github GraphQL API, so you may get the error `GraphQL error: You have created too many repositories, too quickly. Please try again later.`, for more information about this error, please check the next [link - rate-limit](https://docs.github.com/en/graphql/overview/resource-limitations#rate-limit).
## Why do I need this?
This `Backstage Huge Catalog` will help to test the performance of the catalog and the different approaches to generate the catalog. Also, it will help to test the different plugins that are using the catalog.
## How to use it?
I have already generated a catalog according to the 2 approaches, these catalog contains about 10,000 entities each one. If you want to play with your own settings, you can use the `backstage-toolkit` to generate the catalog.