Merge pull request #565 from zoncoen/name-suffix-3

Update docs, examples, comments, and test data for nameSuffix

Author: k8s-ci-robot

docs/glossary.md

@@ -150,7 +150,7 @@ Here's an [example](kustomization.yaml).
 A kustomization contains fields falling into these categories:
 
  * _Customization operators_ for modifying operands, e.g.
-   _namePrefix_, _commonLabels_, _patches_, etc.
+   _namePrefix_, _nameSuffix_, _commonLabels_, _patches_, etc.
 
  * _Customization operands_:
    * [resources] - completely specified k8s API objects,

docs/kustomization.yaml

@@ -40,6 +40,13 @@ namespace: my-namespace
 # "wordpress" becomes "alices-wordpress".
 namePrefix: alices-
 
+# Value of this field is appended to the
+# names of all resources, e.g. a deployment named
+# "wordpress" becomes "wordpress-v2".
+# The suffix is appended before content hash
+# if resource type is ConfigMap or Secret.
+nameSuffix: -v2
+
 # Labels to add to all resources and selectors.
 commonLabels:
   someName: someValue
@@ -205,9 +212,9 @@ patchesJson6902:
 # transformation for any objects in those types.
 #
 # Typical use case: A CRD object refers to a ConfigMap object.
-# In kustomization, the ConfigMap object name may change by adding namePrefix or hashing
+# In kustomization, the ConfigMap object name may change by adding namePrefix, nameSuffix, or hashing
 # The name reference for this ConfigMap object in CRD object need to be
-# updated with namePrefix or hashing in the same way.
+# updated with namePrefix, nameSuffix, or hashing in the same way.
 crds:
 - crds/typeA.yaml
 - crds/typeB.yaml

examples/combineConfigs.md

@@ -194,6 +194,7 @@ cat <<EOF >$OVERLAYS/development/kustomization.yaml
 bases:
 - ../../base
 namePrefix: dev-
+nameSuffix: -v1
 configMapGenerator:
 - name: my-configmap
   behavior: merge
@@ -215,11 +216,12 @@ kustomize build $OVERLAYS/development
 The name of the generated `ConfigMap` is visible in this
 output.
 
-The name should be something like `dev-my-configmap-b5m75ck895`:
+The name should be something like `dev-my-configmap-v1-2gccmccgd5`:
 
  * `"dev-"` comes from the `namePrefix` field,
  * `"my-configmap"` comes from the `configMapGenerator/name` field,
- * `"-b5m75ck895"` comes from a deterministic hash that `kustomize`
+ * `"-v1"` comes from the `nameSuffix` field,
+ * `"-2gccmccgd5"` comes from a deterministic hash that `kustomize`
     computes from the contents of the configMap.
 
 The hash suffix is critical.  If the configMap content

examples/configGeneration.md

@@ -60,6 +60,7 @@ mkdir -p $OVERLAYS/staging
 
 cat <<'EOF' >$OVERLAYS/staging/kustomization.yaml
 namePrefix: staging-
+nameSuffix: -v1
 commonLabels:
   variant: staging
   org: acmeCorporation
@@ -150,13 +151,17 @@ The configMap name is prefixed by _staging-_, per the
 `namePrefix` field in
 `$OVERLAYS/staging/kustomization.yaml`.
 
+The configMap name is suffixed by _-v1_, per the
+`nameSuffix` field in
+`$OVERLAYS/staging/kustomization.yaml`.
+
 The suffix to the configMap name is generated from a
 hash of the maps content - in this case the name suffix
-is _hhhhkfmgmk_:
+is _k25m8k5k5m_:
 
 <!-- @grepStagingHash @test -->
 ```
-kustomize build $OVERLAYS/staging | grep hhhhkfmgmk
+kustomize build $OVERLAYS/staging | grep k25m8k5k5m
 ```
 
 Now modify the map patch, to change the greeting
@@ -183,20 +188,20 @@ kustomize build $OVERLAYS/staging |\
 ```
 
 Confirm that the change in configMap content resulted
-in three new names ending in _khk45ktkd9_ - one in the
+in three new names ending in _cd7kdh48fd_ - one in the
 configMap name itself, and two in the deployment that
 uses the map:
 
 <!-- @countHashes @test -->
 ```
 test 3 == \
-  $(kustomize build $OVERLAYS/staging | grep khk45ktkd9 | wc -l); \
+  $(kustomize build $OVERLAYS/staging | grep cd7kdh48fd | wc -l); \
   echo $?
 ```
 
 Applying these resources to the cluster will result in
 a rolling update of the deployments pods, retargetting
-them from the _hhhhkfmgmk_ maps to the _khk45ktkd9_
+them from the _k25m8k5k5m_ maps to the _cd7kdh48fd_
 maps.  The system will later garbage collect the
 unused maps.
 

examples/transformerconfigs/README.md

@@ -2,7 +2,7 @@
 
 Kustomize computes the resources by applying a series of transformers:
 - namespace transformer
-- prefix transformer
+- prefix/suffix transformer
 - label transformer
 - annotation transformer
 - name reference transformer
@@ -22,8 +22,8 @@ create: false
 ```
 If `create` is set to true, it indicates the transformer to create the path if it is not found in the resources. This is most useful for label and annotation transformers, where the path for labels or annotations may not be set before the transformation.
 
-## prefix transformer
-Name prefix transformer adds prefix to the `metadata/name` field for all resources with following configuration:
+## prefix/suffix transformer
+Name prefix suffix transformer adds prefix and suffix to the `metadata/name` field for all resources with following configuration:
 ```
 namePrefix:
 - path: metadata/name

pkg/commands/build/testdata/testcase-multibases-conflict/base/kustomization.yaml

@@ -2,3 +2,4 @@ resources:
 - serviceaccount.yaml
 - rolebinding.yaml
 namePrefix: base-
+nameSuffix: -suffix

pkg/commands/build/testdata/testcase-multibases-conflict/overlays/a/kustomization.yaml

@@ -2,6 +2,7 @@ bases:
 - ../../base/
 
 namePrefix: a-
+nameSuffix: -suffixA
 
 resources:
 - serviceaccount.yaml

pkg/commands/build/testdata/testcase-multibases-conflict/overlays/b/kustomization.yaml

@@ -2,3 +2,4 @@ bases:
 - ../../base/
 
 namePrefix: b-
+nameSuffix: -suffixB

pkg/commands/build/testdata/testcase-multibases-nonconflict/base/kustomization.yaml

@@ -2,3 +2,4 @@ resources:
 - serviceaccount.yaml
 - rolebinding.yaml
 namePrefix: base-
+nameSuffix: -suffix

pkg/commands/build/testdata/testcase-multibases-nonconflict/expected.yaml

@@ -1,33 +1,33 @@
 apiVersion: v1
 kind: ServiceAccount
 metadata:
-  name: a-base-serviceaccount
+  name: a-base-serviceaccount-suffix-suffixA
 ---
 apiVersion: v1
 kind: ServiceAccount
 metadata:
-  name: b-base-serviceaccount
+  name: b-base-serviceaccount-suffix-suffixB
 ---
 apiVersion: rbac.authorization.k8s.io/v1beta1
 kind: RoleBinding
 metadata:
-  name: a-base-rolebinding
+  name: a-base-rolebinding-suffix-suffixA
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: Role
   name: role
 subjects:
 - kind: ServiceAccount
-  name: a-base-serviceaccount
+  name: a-base-serviceaccount-suffix-suffixA
 ---
 apiVersion: rbac.authorization.k8s.io/v1beta1
 kind: RoleBinding
 metadata:
-  name: b-base-rolebinding
+  name: b-base-rolebinding-suffix-suffixB
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: Role
   name: role
 subjects:
 - kind: ServiceAccount
-  name: b-base-serviceaccount
+  name: b-base-serviceaccount-suffix-suffixB