kuberneteskubernetes-deployment

Why labels are mentioned three times in a single deployment


I've gone over the following docomentation page: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/

The example deployment yaml is as follows:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
  labels:
    app: nginx
spec:
  replicas: 3
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.7.9
        ports:
        - containerPort: 80

We can see here three different times where the label app: nginx is mentioned.

Why do we need each of them? I had a hard time understanding it from the official documentation.


Solution

  • The first label is for deployment itself, it gives label for that particular deployment. Lets say you want to delete that deployment then you run following command:

    kubectl delete deployment -l app=nginx
    

    This will delete the entire deployment.

    The second label is selector: matchLabels which tells the resources(service etc) to match the pod according to label. So lets say if you want to create the service which has all the pods having labels of app=nginx then you provide following definition:

    apiVersion: v1
    kind: Service
    metadata:
      name: nginx
    spec:
      type: LoadBalancer
      ports:
        - port:  80
      selector:
        app: nginx
    

    The above service will look for the matchLabels and bind pods which have label app: nginx assigned to them

    The third label is podTemplate labels, the template is actually podTemplate. It describe the pod that it is launched. So lets say you have two replica deployment and k8s will launch 2 pods with the label specified in template: metadata: labels. This is subtle but important difference, so you can have the different labels for deployment and pods generated by that deployment.