kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-06-13 01:50:55 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Add kustomization and transformer references (#5523)

Browse Source 
* Add fields to kustomization file ref

* Address grammar feedback.

* labels.fields
This commit is contained in:
Nick
2024-02-26 10:25:24 -08:00
committed by GitHub
parent 6ffcc08591
commit d3329453a2
10 changed files with 219 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
site/content/en/docs/Reference/API/Kustomization File/labels.md
View File

@@ -6,5 +6,35 @@ weight: 10
description: >
Add labels and optionally selectors to all resources.
---
`apiVersion: kustomize.config.k8s.io/v1beta1`
The Tasks section contains examples of how to use [`labels`](/docs/tasks/labels_and_annotations/).
See the [Tasks section] for examples of how to use `labels`.
### 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.
[Tasks section]: /docs/tasks/labels_and_annotations/
[Labels and Selectors]: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/