Add common Tasks to documentation (#5383)

* Add labels, annotations, namespaces, and names tasks * Remove redundant information from ref/labels ref/annotations * Update labels and annotations example names for consistency * Remove name, prefix and suffix api examples * Add link to tasks in reference * Add link to tasks section for ref/configMapGenerator and ref/secretGenerator * Add Labels/Annotatations headers * Add Labels * Add Template Labels * Cleanup Add Template Labels * Consolidate commonLabels and labels.includeSelectors * Improve commonAnnotations example * Add labels and annotations ref links * Add generated ConfigMap to namespace example * Add name headers * Change header weights so they appear in sidebar * Add namespace/name links * Add generated ConfigMap to namePrefix example * Add name propagation example * Add more description of name propagation * template labels * Address feedback for labels * Address names feedback * Update for consistency * Address feedback * Remove API
kubernetes-sigs · Nov 25, 2023 · bfb00ec · bfb00ec
1 parent 0122aa8
commit bfb00ec
Show file tree

Hide file tree

Showing 10 changed files with 547 additions and 531 deletions.
diff --git a/site/content/en/docs/Reference/API/Kustomization File/commonAnnotations.md b/site/content/en/docs/Reference/API/Kustomization File/commonAnnotations.md
@@ -7,52 +7,4 @@ description: >
     Add annotations to add all resources.
 ---
 
-Add annotations to all resources.  If the annotation key already is present on the resource,
-the value will be overridden.
-
-```yaml
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
-
-commonAnnotations:
-  oncallPager: 800-555-1212
-```
-
-## Example
-
-### File Input
-
-```yaml
-# kustomization.yaml
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
-
-commonAnnotations:
-  oncallPager: 800-555-1212
-
-resources:
-- deploy.yaml
-```
-
-```yaml
-# deploy.yaml
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: example
-spec:
-  ...
-```
-
-### Build Output
-
-```yaml
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: example
-  annotations:
-    oncallPager: 800-555-1212
-spec:
-  ...
-```
+The Tasks section contains examples of how to use [`commonAnnotations`](/docs/tasks/labels_and_annotations/).
diff --git a/site/content/en/docs/Reference/API/Kustomization File/commonLabels.md b/site/content/en/docs/Reference/API/Kustomization File/commonLabels.md
@@ -7,101 +7,4 @@ description: >
     Add labels and selectors to add all resources.
 ---
 
-[labels]: /docs/reference/api/kustomization-file/labels/
-
-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.
-
-{{% 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 commonLabels to live resources could result in failures.
-{{% /pageinfo %}}
-
-```yaml
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
-
-commonLabels:
-  someName: someValue
-  owner: alice
-  app: bingo
-```
-
-## Example
-
-### File Input
-
-```yaml
-# kustomization.yaml
-apiVersion: kustomize.config.k8s.io/v1beta1
-kind: Kustomization
-
-commonLabels:
-  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
-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
-```
+The Tasks section contains examples of how to use [`commonLabels`](/docs/tasks/labels_and_annotations/).
diff --git a/site/content/en/docs/Reference/API/Kustomization File/configMapGenerator.md b/site/content/en/docs/Reference/API/Kustomization File/configMapGenerator.md
@@ -6,3 +6,5 @@ weight: 6
 description: >
     Generate ConfigMap resources.
 ---
+
+The Tasks section contains examples of how to use [`configMapGenerator`](/docs/tasks/configmap_generator/).
diff --git a/site/content/en/docs/Reference/API/Kustomization File/labels.md b/site/content/en/docs/Reference/API/Kustomization File/labels.md
@@ -7,231 +7,4 @@ 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
-```
+The Tasks section contains examples of how to use [`labels`](/docs/tasks/labels_and_annotations/).