Skip to content

Register Service

This document explains how to add a Service to the Service Catalog.

What is a Service?

In the context of the Observability Platform, a Service is a part of an Application. An Application can consist of one or more Services. See What is a Service for more information.

Register a Service

To register a Service into the Service Catalog, in the services.yml add the following required information:

services.yml
1
2
3
4
5
6
services:
  - name: "opensearch"
    application_name: "opensearch"
    owner: cloud_platform_team
    description: |
      Amazon managed service for OpenSearch (logging backend)
  • name: the name used in Cirrus for identification and mapping of the service. For example, when associating a Service with an Application, the name value is used to map this.
  • application_name: the name value of the Application entry in the Service Catalog. This field links the Service to an Application.
  • owner: the name value of the Team entry in the Service Catalog. This field links the Service to a team and will for example route any alerts related to this Service to the associated team.
  • description: used to describe the purpose of this service within the wider KNMI production landscape.