From abb3dda3d0183bab30593719bce4a68c0493074d Mon Sep 17 00:00:00 2001 From: Edvin Norling Date: Wed, 4 Jan 2023 08:55:59 +0100 Subject: [PATCH] Initial docs about labeling --- docs/xks/developer-guide/best-practices.md | 28 +++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/xks/developer-guide/best-practices.md b/docs/xks/developer-guide/best-practices.md index 652bb927650..78c248e4b00 100644 --- a/docs/xks/developer-guide/best-practices.md +++ b/docs/xks/developer-guide/best-practices.md @@ -17,4 +17,30 @@ This page aims to collect best practices and common mistakes that can be made wh Here are some good resources to also read on top of this page. -* [https://srcco.de/posts/web-service-on-kubernetes-production-checklist-2019.html](https://srcco.de/posts/web-service-on-kubernetes-production-checklist-2019.html) +- [https://srcco.de/posts/web-service-on-kubernetes-production-checklist-2019.html](https://srcco.de/posts/web-service-on-kubernetes-production-checklist-2019.html) + +## Labels + +There are multiple reasons to label your workloads. + +- Grouping +- Searchability +- Billing + +The Kubernetes communnity have a number of default labels that they recommend to put on all your workloads. +There are also a number of extra labels that might be useful for you, remember that these labels are only +examples and you will have to try around to find which labels fits best for you. + +### Kubernetes standard Labels + +```.yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: deployment + labels: + app.kubernetes.io/name: user-api + app.kubernetes.io/version: "42" + app.kubernetes.io/component: api + app.kubernetes.io/part-of: payment-gateway +```