gimlet icon indicating copy to clipboard operation
gimlet copied to clipboard

Service catalog taxonomy

Open laszlocph opened this issue 3 years ago • 0 comments

Gimlet today uses Kubernetes annotations to add metadata to application deployments.

  • gimlet.io/git-repository is used to match the deployed application to a source code git repository
  • gimlet.io/git-sha is used to match the deployed application version to a git hash of the source code repository

Example:

gimlet.io/git-repository: gimlet-io/demo-app
gimlet.io/git-sha: a200980dd0bdb6ce123f1feded293fc9866bae2a

The primary place of the service catalog labels is the Kubernetes Service resource, as that is the one identifying a deployed service application the most unambiguous way.

This issue is meant to extend the Gimlet service catalog taxonomy further.

Proposed new elements:

  • gimlet.io/owner: Owner's name. An arbitrary string holding the owner person or team's name
  • gimlet.io/im-room: The owner's instant messaging (Slack / Discord) room where alerts should arrive about the service
  • gimlet.io/im-dm: The owner's instant messaging (Slack / Discord) name where alerts should be DM-d
  • gimlet.io/dashboard: Operational dashboard link of the service

laszlocph avatar Sep 15 '22 13:09 laszlocph