commonLabels
The commonLabels field was deprecated in v5.0.0. Please use the [labels] field instead.
The commonLabels field will never be removed from the kustomize.config.k8s.io/v1beta1 Kustomization API,
but it will not be included in the kustomize.config.k8s.io/v1 Kustomization API. When Kustomization v1 is available,
we will announce the deprecation of the v1beta1 version. There will be at least
two releases between deprecation and removal of Kustomization v1beta1 support from the
kustomize CLI, and removal itself will happen in a future major version bump.
You can run kustomize edit fix to automatically convert commonLabels to labels.
Note: Selectors for resources such as Deployments and Services shouldn’t be changed once the resource has been applied to a cluster. Changing commonLabels to live resources could result in failures.
Add labels and selectors to all resources. If the label key already is present on the resource, the value will be overridden.
An alternative to this field is the labels field, which allows adding labels without also automatically injecting corresponding selectors.
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
commonLabels:
someName: someValue
owner: alice
app: bingo
Example
File Input
# kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
commonLabels:
someName: someValue
owner: alice
app: bingo
resources:
- deploy.yaml
- service.yaml
# deploy.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: example
# service.yaml
apiVersion: v1
kind: Service
metadata:
name: example
Build Output
apiVersion: v1
kind: Service
metadata:
labels:
app: bingo
owner: alice
someName: someValue
name: example
spec:
selector:
app: bingo
owner: alice
someName: someValue
---
apiVersion: apps/v1
kind: Deployment
metadata:
labels:
app: bingo
owner: alice
someName: someValue
name: example
spec:
selector:
matchLabels:
app: bingo
owner: alice
someName: someValue
template:
metadata:
labels:
app: bingo
owner: alice
someName: someValue
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.