Skip to content

Commit

Permalink
Add docs for customizing catalog components
Browse files Browse the repository at this point in the history
  • Loading branch information
Espen Henriksen authored Mar 4, 2024
1 parent 29fc45a commit 684822d
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 18 deletions.
18 changes: 0 additions & 18 deletions docs/getting-started/onboarding.md

This file was deleted.

73 changes: 73 additions & 0 deletions docs/getting-started/using-the-catalog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
id: using-the-catalog
title: Using the catalog
description: How to add new services to the developer portal and edit existing services
---
## Onboarding
In order to use the developer portal the first step to adding your service is to add it to the [catalog](/catalog). The catalog is a list of all the services that exist in Kartverket.

Since the developer portal is based on Backstage we have configured it to scan all repositories belonging to the Kartverket organization for backstage configuration files.
You can read more about such files [here](https://backstage.io/docs/features/software-catalog/descriptor-format#kind-component).

To make it easier for you to add your service to the catalog we have created a [template](/create/templates/default/onboarding).
This template will create a basic backstage configuration for you, and create a pull request in your repository.

After merging the pull request your service will be added to the catalog within 30 minutes.

![onboarding-template](../assets/onboarding-template.png)

## Customizing components

Once your component is added to the catalog, you may want to add optional features to the detail view of the component. Currently we support the following features:

- [Lighthouse Insights](#lighthouse-insights)
- [Grafana alerts and dashboards](#grafana-alerts-and-dashboards)
- [Kubernetes](#kubernetes)

### Lighthouse Insights

Your application can opt in to being scanned by Lighthouse, an open-source,
automated tool for improving the quality of web pages. Lighthouse has audits
for performance, accessibility, progressive web apps, SEO, and more.

Add the following annotation to your component:

```
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
# ...
annotations:
lighthouse.com/website-url: # A single website url e.g. https://backstage.io/
```

This will enable scanning of the website periodically.

### Grafana alerts and dashboards


```
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
# ...
annotations:
grafana/alert-label-selector: # An alert selector, for example source=skiperator
grafana/dashboard-selector: # A dashboard selector
grafana/overview-dashboard: # A dashboard URL, for example: 'https://monitoring.kartverket.dev/d/b48615bc-3801-4d0b-be37-858483dfb3d3/skiperator?orgId=1&kiosk'
```

### Kubernetes

Adding this will enable us to add more features in the future that show data of
your app on Kubernetes, for example showing exposed endpoints on your Skiperator
Application manifest.

```
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
# ...
annotations:
backstage.io/kubernetes-label-selector: # A label selector, for example app=skiperator
```

0 comments on commit 684822d

Please sign in to comment.