Convention For Annotations In Kubernetes Services
There is a Convention for Annotations in Kubernetes in order to ensure consistency and readability. A documented set of convention is given below:
Key |
Value |
---|---|
a8r.io/owner |
Add the GitHub username or email address linked to GitHub. |
a8r.io/repository |
Add link to the repository |
a8r.io/runbook |
Add link to external project runbook. |
a8r.io/chat |
Add a link to external chat system like Slack channels. |
a8r.io/support |
Add a link to external support center. |
a8r.io/bugs |
Add a link to external bug tracker. |
a8r.io/description |
You can add a description of the service file here. |
a8r.io/incidents |
Add a link to external incident dashboard. |
a8r.io/dependencies |
You can add some text for describing the service dependencies for humans. |
a8r.io/performance |
Add a link to external performance dashboard. |
a8r.io/logs |
Add a link to external log viewer. |
a8r.io/uptime |
Add a link to external uptime dashboard. |
How to Use Kubernetes Annotations?
Annotations are key-value pairs that are used to attach non-identifying metadata to Kubernetes objects. Various tools that are built over Kubernetes use this metadata attached by annotations to perform actions or enhance resource management. Labels and Annotations are used to attach metadata to Kubernetes objects. This makes annotations important for working with Kubernetes clusters. To learn more about Kubernetes cluster and its architecture refer to Kubernetes – Architecture.