Register Multiple Entities

Preface

This how-to will take you through the steps of registering multiple entities in the catalogue from a single repository.

Get a Repository

To begin, you will need to create or clone a repository in or from one of the Git discovery locations, such that they are available to entity ingress.

Discovery Locations

• github.com/DiamondLightSource
  • Entity descriptors at /catalog-info.yaml
• gitlab.diamond.ac.uk
  • Entity descriptors at /catalog-info.yaml

Create an Entity Descriptor

Firstly, we must create the entity descriptor file, please reference the Discovery Locations above for the appropriate location - this is typically catalog-info.yaml at the root of the repository.

Entity Definitions

We can now create numerous entity descriptors seperated by ---. These will be read independantly, as if they were their own entity-descriptor files.

Example

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
    name: developer-portal-backend
spec:
    type: service

---

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
    name: developer-portal-frontend
spec:
    type: website