Register Team¶
This document explains how to add a team to the Service Catalog.
What is a team?
In the context of the Observability Platform, a team is any entity within KNMI that owns one or multiple applications. Teams are associated with Services within the Service Catalog and will receive notifications (e.g: Grafana Alerts) to their configured MS Teams channel(s).
Register a Team¶
To register a team into the Service Catalog, in the
teams.yml add the following required information:
name: the name used in Cirrus for identifaction and mapping of the team. For example, when associating your team with a Service, theteamvalue is used to map this.display_name: the text displayed in any user-facing objects. For example, the Grafana Dashboard tags.
Add MS Teams Channel to Team¶
The notifications block defines where your alerts go. We currently support Microsoft Teams as the primary internal communication channel. There is also an OpsGenie communication channel, but this is managed KNMI wide and not on a per-team basis.
Channel Types¶
We support two specific channel_type values to help separate production alerts from development noise:
| Type | Purpose | Behavior |
|---|---|---|
default |
Production / Catch-all | Receives alerts are labeled prd or when no other alerting channel is configured |
dta |
Non-production | If configured, receives alerts when environment label is dev, tst or acc |
To add an MS Teams channel to your configured team, in the teams.yml add the following required information:
| teams.yml | |
|---|---|
channel_type: See Channel Types.group_name: Name of MS Teams team. No other use than to make the group_id human understandable.group_id: the Group ID of the MS Teams team. See the following section how to find the Group ID.channel_name: Name of MS Teams channel. No other use than to make the channel_id human understandable.channel_id: the Channel ID of the MS Teams team. See the following section how to find the Channel ID.
Find an MS Teams group_id And channel_id¶
To find the group_id and channel_id for a Microsoft Teams contact point:
- Open Microsoft Teams and navigate to the team and channel you want to use.
- Click on the three dots (
...) next to the channel name and selectGet link to channel. - The URL will look something like this:
https://teams.microsoft.com/l/channel/<channel_id>/General?groupId=<group_id>&tenantId=<tenant_id>. - Extract the
group_idandchannel_idfrom the URL. Thechannel_idis the part afterl/channel/and before/General, and thegroup_idis the value aftergroupId=. - Use these values in the
ms_teamssection of your notifications configuration.
There is no use for tenant_id. It is only in the example to represent the URL structure.