kustomize/site/content/en/docs/Reference/API/Kustomization File/labels.md at d53c17b87499aa1217c2974f7f41bec172bfa46c

mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-05-18 02:55:22 +00:00

Files

Nick d3329453a2 Add kustomization and transformer references (#5523 )

* Add fields to kustomization file ref

* Address grammar feedback.

* labels.fields

2024-02-26 10:25:24 -08:00

title, linkTitle, type, weight, description

title	linkTitle	type	weight	description
labels	labels	docs	10	Add labels and optionally selectors to all resources.

apiVersion: kustomize.config.k8s.io/v1beta1

See the Tasks section for examples of how to use labels.

Adds labels and optionally selectors to all resources.

labels ([]Label)

List of labels and label selector options.

Label holds labels to add to resources and options for customizing how those labels are applied, potentially using selectors and template metadata.
- pairs (map[string]string)
  
  Map of labels that the transformer will add to resources.
- includeSelectors (bool), optional
  
  IncludeSelectors indicates whether the transformer should include the fieldSpecs for selectors. Custom fieldSpec specified by fields will be merged with builtin fieldSpecs if this is true. Defaults to false.
- includeTemplates (bool), optional
  
  IncludeTemplates indicates whether the transformer should include the spec/template/metadata fieldSpec. Custom fieldSpecs specified by fields will be merged with the spec/template/metadata fieldSpec if this is true. If IncludeSelectors is true, IncludeTemplates is not needed. Defaults to false.
- fields ([][FieldSpec]({{< relref "../Common%20Definitions/FieldSpec.md" >}})), optional
  
  Fields specifies the field on each resource that LabelTransformer should add the label to. It essentially allows the user to re-define the field path of the Kubernetes labels field from metadata/labels for different resources.