docs(api/kustomizaion-file): migrate field sections

2026-06-13 01:50:55 +00:00 · 2023-09-17 16:05:32 +09:00
parent d30e457031
commit 2c444d6bf4
25 changed files with 12 additions and 12 deletions
--- a/site/content/en/docs/Reference/API/Kustomization
+++ b/site/content/en/docs/Reference/API/Kustomization
@@ -0,0 +1,237 @@
+---
+title: "labels"
+linkTitle: "labels"
+type: docs
+weight: 10
+description: >
+    Add labels and optionally selectors to all resources.
+---
+
+A field that allows adding labels without also automatically injecting corresponding selectors.
+This can be used instead of the `commonLabels` field, which always adds selectors.
+
+{{% pageinfo color="warning" %}}
+Selectors for resources such as Deployments and Services shouldn't be changed once the
+resource has been applied to a cluster.
+
+Changing `includeSelectors` to `true` or changing labels when `includeSelectors` is `true` in live resources
+is equivalent to changing `commonLabels` and could result in failures.
+{{% /pageinfo %}}
+
+The following flags are available:
+* `includeTemplates`: When set will also apply labels to metadata/labels and spec/template/metadata/labels. This can be used to add labels to Pods from owner resources, such as Deployments and StatefulSets, without modifying selectors. False by default.
+* `includeSelectors`: When set will apply labels to metadata/labels, selectors, and spec/template/metadata/labels. False by default.
+
+```yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+labels:
+  - pairs:
+      someName: someValue
+      owner: alice
+      app: bingo
+    includeSelectors: true # <-- false by default
+    includeTemplates: true # <-- false by default
+```
+
+## Example 1 - selectors and templates NOT modified
+
+### File Input
+
+```yaml
+# kustomization.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+labels:
+  - pairs:
+      someName: someValue
+      owner: alice
+      app: bingo
+
+resources:
+- deploy.yaml
+- service.yaml
+```
+
+```yaml
+# deploy.yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: example
+```
+
+```yaml
+# service.yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: example
+```
+
+### Build Output
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app: bingo
+    owner: alice
+    someName: someValue
+  name: example
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    app: bingo
+    owner: alice
+    someName: someValue
+  name: example
+```
+
+
+## Example 2 - selectors modified
+
+### File Input
+
+```yaml
+# kustomization.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+labels:
+  - pairs:
+      someName: someValue
+      owner: alice
+      app: bingo
+    includeSelectors: true 
+
+resources:
+- deploy.yaml
+- service.yaml
+```
+
+```yaml
+# deploy.yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: example
+```
+
+```yaml
+# service.yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: example
+```
+
+### Build Output
+
+```yaml
+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
+```
+
+## Example 3 - templates modified
+
+### File Input
+
+```yaml
+# kustomization.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+labels:
+  - pairs:
+      someName: someValue
+      owner: alice
+      app: bingo
+    includeTemplates: true 
+
+resources:
+- deploy.yaml
+- service.yaml
+```
+
+```yaml
+# deploy.yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: example
+```
+
+```yaml
+# service.yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: example
+```
+
+### Build Output
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app: bingo
+    owner: alice
+    someName: someValue
+  name: example
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    app: bingo
+    owner: alice
+    someName: someValue
+  name: example
+spec:
+  template:
+    metadata:
+      labels:
+        app: bingo
+        owner: alice
+        someName: someValue
+```