Kiali tutorial: show custom information per service (like ownership)
Kiali is useful for troubleshooting Istio service mesh, and one aspect where it can help is by showing information about services ownership and contact details, to facilitate communications between teams when an issue is spotted.
There is a generic feature that allows adding custom information on the Service or Workload detail page in order to achieve that goal. In this post we’ll see how to do it, in just two little steps.
Let’s configure the additional_display_details field. Edit the Kiali CR or ConfigMap to add a couple of annotations to be recognized by Kiali:
- annotation: kiali.io/api-spec
title: API Documentation
- annotation: kiali.io/owner
- annotation: kiali.io/email
title: Contact email
- annotation: kiali.io/channels
title: Contact channels
- annotation: kiali.io/app-admin
title: Admin link
The “API Documentation” link is already there if you haven’t changed the defaults. We’re adding “Owner”, “Contact email”, “Contact channels” and “Admin link”.
Note: there isn’t any restriction about the annotations written there. In this example, the kiali.io prefix helps to clarify what the annotations are for in the service templates, but it’s not mandatory.
Configuring your services or workloads
Now let’s configure our services or workloads accordingly. Here I have a “UI” service deployed on my cluster for an application called “Arena”. I’m adding these annotations in the Service metadata:
kiali.io/owner: Arena frontend team
See the result in Kiali
We can similarly annotate the workloads (deployments…) to get the same under the Workload detail page.