Annotating Kubernetes Services for Humans

This page outlines a convention for using annotations to help developers manage Kubernetes services.
These annotations can be applied to a Kubernetes service with kubectl annotate.

For example:
kubectl annotate service MYSERVICE”sallydev”

Annotation Description
Unstructured text description of the service for humans.
GitHub or equivalent username (prefix with @), email address, or unstructured owner description.
Slack channel (prefix with #), or link to other external chat system.
Link to external bug tracker.
Link to external log viewer.
Link to external project documentation.
Link to external VCS repository.
Link to external support center.
Link to external project runbook.
Link to external incident dashboard.
Link to external uptime dashboard.
Link to external performance dashboard.
Unstructured text description of the service dependencies for humans.

Feedback? Suggestions?
File an issue on GitHub

Created by Ambassador Labs