Skip to content

Commit c63b6eb

Browse files
authored
Update README with catalog entity documentation (#25)
1 parent 3f6f536 commit c63b6eb

1 file changed

Lines changed: 29 additions & 2 deletions

File tree

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ The Rootly plugin is a frontend plugin that displays Rootly services, incidents
1212
- View and search a list of functionalities
1313
- View and search a list of teams
1414
- View and search a list of incidents
15+
- View and search a list of catalog entities (with catalog selector)
1516

16-
- The `RootlyOverviewCard` component which produces a summary of your entity with incidents over last 30 days and ongoing incidents.
17+
- The `RootlyOverviewCard` component which produces a summary of your entity with incidents over last 30 days and ongoing incidents. Also supports catalog entities with name, description, and properties display.
1718

1819
- The `RootlyIncidentsPage` component which produces a dedicated page within your entity with details about ongoing and past incidents.
1920

20-
You can link and import entities in rootly services through Backstage Web UI or through annotations.
21+
You can link and import entities in rootly services, functionalities, teams, and catalog entities through Backstage Web UI or through annotations.
2122

2223
## Installation
2324

@@ -103,6 +104,13 @@ rootly.com/team-slug: infrastucture # Use team-id or team-slug. Not both.
103104
rootly.com/team-name: Infrastucture # Use team-id or team-slug. Not both.
104105
rootly.com/team-slug: infrastucture # Use team-id or team-slug. Not both.
105106
rootly.com/team-auto-import: enabled # This will auto import the entity as a rootly team if we don't find any.
107+
rootly.com/catalog-entity-id: 7a328a08-6701-445e-a1ad-ca2fb913ed1e # Use catalog-entity-id or catalog-entity-slug. Not both.
108+
rootly.com/catalog-entity-name: Enterprise
109+
rootly.com/catalog-entity-slug: enterprise # Use catalog-entity-id or catalog-entity-slug. Not both.
110+
rootly.com/catalog-entity-auto-import: enabled # This will auto import the entity as a rootly catalog entity if we don't find any.
111+
rootly.com/catalog-id: 7a328a08-6701-445e-a1ad-ca2fb913ed1e # Required for auto-import. The catalog to create the entity in.
112+
rootly.com/catalog-slug: customer-tier # Alternative to catalog-id. The catalog slug to find or create.
113+
rootly.com/catalog-description: Customer pricing tiers # Optional. Description for the catalog when auto-creating.
106114
```
107115
108116
#### Example
@@ -126,6 +134,25 @@ spec:
126134
lifecycle: experimental
127135
```
128136
137+
#### Catalog Entity Example
138+
139+
```yaml
140+
apiVersion: backstage.io/v1alpha1
141+
kind: Component
142+
metadata:
143+
name: enterprise-tier
144+
description: Enterprise customer tier
145+
annotations:
146+
rootly.com/catalog-entity-slug: enterprise-tier
147+
rootly.com/catalog-entity-auto-import: enabled
148+
rootly.com/catalog-slug: customer-tier
149+
rootly.com/catalog-description: Customer pricing tiers
150+
spec:
151+
type: service
152+
owner: guests
153+
lifecycle: production
154+
```
155+
129156
### Global
130157
131158
#### `RootlyPage` component

0 commit comments

Comments
 (0)