support krm spec v1 and legacy path, index, and id annotations

2026-06-13 18:10:59 +00:00 · 2021-09-15 09:40:01 -07:00
parent 402f6ca72b
commit 67a5f6d68f
36 changed files with 1053 additions and 92 deletions
--- a/kyaml/fn/runtime/runtimeutil/runtimeutil.go
+++ b/kyaml/fn/runtime/runtimeutil/runtimeutil.go
@@ -66,9 +66,14 @@ func (c *FunctionFilter) getFunctionScope() (string, error) {
 	if err != nil {
 		return "", errors.Wrap(err)
 	}
-	p, found := m.Annotations[kioutil.PathAnnotation]
+	var p string
+	var found bool
+	p, found = m.Annotations[kioutil.PathAnnotation]
 	if !found {
-		return "", nil
+		p, found = m.Annotations[kioutil.LegacyPathAnnotation]
+		if !found {
+			return "", nil
+		}
 	}

 	functionDir := path.Clean(path.Dir(p))
@@ -101,12 +106,17 @@ func (c *FunctionFilter) scope(dir string, nodes []*yaml.RNode) ([]*yaml.RNode,
 		if err != nil {
 			return nil, nil, err
 		}
-		p, found := m.Annotations[kioutil.PathAnnotation]
+		var p string
+		var found bool
+		p, found = m.Annotations[kioutil.PathAnnotation]
 		if !found {
-			// this Resource isn't scoped under the function -- don't know where it came from
-			// consider it out of scope
-			saved = append(saved, nodes[i])
-			continue
+			p, found = m.Annotations[kioutil.LegacyPathAnnotation]
+			if !found {
+				// this Resource isn't scoped under the function -- don't know where it came from
+				// consider it out of scope
+				saved = append(saved, nodes[i])
+				continue
+			}
 		}

 		resourceDir := path.Clean(path.Dir(p))
@@ -193,8 +203,6 @@ func (c *FunctionFilter) Filter(nodes []*yaml.RNode) ([]*yaml.RNode, error) {
 	return append(output, saved...), nil
 }

-const idAnnotation = "config.k8s.io/id"
-
 func (c *FunctionFilter) setIds(nodes []*yaml.RNode) error {
 	// set the id on each node to map inputs to outputs
 	var id int
@@ -202,7 +210,11 @@ func (c *FunctionFilter) setIds(nodes []*yaml.RNode) error {
 	for i := range nodes {
 		id++
 		idStr := fmt.Sprintf("%v", id)
-		err := nodes[i].PipeE(yaml.SetAnnotation(idAnnotation, idStr))
+		err := nodes[i].PipeE(yaml.SetAnnotation(kioutil.IdAnnotation, idStr))
+		if err != nil {
+			return errors.Wrap(err)
+		}
+		err = nodes[i].PipeE(yaml.SetAnnotation(kioutil.LegacyIdAnnotation, idStr))
 		if err != nil {
 			return errors.Wrap(err)
 		}
@@ -214,12 +226,18 @@ func (c *FunctionFilter) setIds(nodes []*yaml.RNode) error {
 func (c *FunctionFilter) copyCommentsAndSyncOrder(nodes []*yaml.RNode) error {
 	for i := range nodes {
 		node := nodes[i]
-		anID, err := node.Pipe(yaml.GetAnnotation(idAnnotation))
+		anID, err := node.Pipe(yaml.GetAnnotation(kioutil.IdAnnotation))
 		if err != nil {
 			return errors.Wrap(err)
 		}
 		if anID == nil {
-			continue
+			anID, err = node.Pipe(yaml.GetAnnotation(kioutil.LegacyIdAnnotation))
+			if err != nil {
+				return errors.Wrap(err)
+			}
+			if anID == nil {
+				continue
+			}
 		}

 		var in *yaml.RNode
@@ -233,7 +251,10 @@ func (c *FunctionFilter) copyCommentsAndSyncOrder(nodes []*yaml.RNode) error {
 		if err := order.SyncOrder(in, node); err != nil {
 			return errors.Wrap(err)
 		}
-		if err := node.PipeE(yaml.ClearAnnotation(idAnnotation)); err != nil {
+		if err := node.PipeE(yaml.ClearAnnotation(kioutil.IdAnnotation)); err != nil {
+			return errors.Wrap(err)
+		}
+		if err := node.PipeE(yaml.ClearAnnotation(kioutil.LegacyIdAnnotation)); err != nil {
 			return errors.Wrap(err)
 		}
 	}
--- a/kyaml/fn/runtime/runtimeutil/runtimeutil_test.go
+++ b/kyaml/fn/runtime/runtimeutil/runtimeutil_test.go
@@ -82,6 +82,7 @@ kind: Deployment
 metadata:
  name: deployment-foo
  annotations:
+    internal.config.kubernetes.io/path: 'deployment_deployment-foo.yaml'
    config.kubernetes.io/path: 'deployment_deployment-foo.yaml'
 `,
 				`
@@ -90,6 +91,7 @@ kind: Service
 metadata:
  name: service-foo
  annotations:
+    internal.config.kubernetes.io/path: 'service_service-foo.yaml'
    config.kubernetes.io/path: 'service_service-foo.yaml'
 `,
 			},
@@ -123,6 +125,7 @@ kind: Deployment
 metadata:
  name: deployment-foo
  annotations:
+    internal.config.kubernetes.io/path: 'deployment_deployment-foo.yaml'
    config.kubernetes.io/path: 'deployment_deployment-foo.yaml'
 `,
 				`
@@ -132,6 +135,7 @@ metadata:
  name: service-foo
  annotations:
    config.kubernetes.io/path: 'foo.yaml'
+    internal.config.kubernetes.io/path: 'foo.yaml'
 `,
 			},
 		},
@@ -180,6 +184,7 @@ metadata:
  name: service-foo
  annotations:
    config.kubernetes.io/path: 'foo.yaml'
+    internal.config.kubernetes.io/path: 'foo.yaml'
 `,
 				`
 apiVersion: v1
@@ -188,6 +193,7 @@ metadata:
  name: configmap-foo
  annotations:
    config.kubernetes.io/path: 'foo.yaml'
+    internal.config.kubernetes.io/path: 'foo.yaml'
 `,
 			},
 		},
@@ -235,6 +241,7 @@ kind: Deployment
 metadata:
  name: deployment-foo
  annotations:
+    internal.config.kubernetes.io/path: 'deployment_deployment-foo.yaml'
    config.kubernetes.io/path: 'deployment_deployment-foo.yaml'
 `, `
 apiVersion: v1
@@ -242,6 +249,7 @@ kind: Service
 metadata:
  name: service-foo
  annotations:
+    internal.config.kubernetes.io/path: 'service_service-foo.yaml'
    config.kubernetes.io/path: 'service_service-foo.yaml'
 `,
 			},
@@ -393,6 +401,7 @@ kind: Deployment
 metadata:
  name: deployment-foo
  annotations:
+    internal.config.kubernetes.io/path: 'deployment_deployment-foo.yaml'
    config.kubernetes.io/path: 'deployment_deployment-foo.yaml'
 		`, `
 apiVersion: v1
@@ -400,6 +409,7 @@ kind: Service
 metadata:
  name: service-foo
  annotations:
+    internal.config.kubernetes.io/path: 'service_service-foo.yaml'
    config.kubernetes.io/path: 'service_service-foo.yaml'
 		`,
 			},
@@ -486,6 +496,7 @@ items:
    name: service-foo
    annotations:
      config.kubernetes.io/path: 'foo/bar/s.yaml'
+      internal.config.kubernetes.io/id: '1'
      config.k8s.io/id: '1'
 functionConfig:
  apiVersion: example.com/v1
@@ -505,7 +516,7 @@ items:
    annotations:
      config.kubernetes.io/path: 'foo/bar/s.yaml'
      new: annotation
-      config.k8s.io/id: '1'
+      internal.config.kubernetes.io/id: '1'
 functionConfig:
  apiVersion: example.com/v1
  kind: Example
@@ -551,6 +562,7 @@ metadata:
  annotations:
    config.kubernetes.io/path: 'foo/bar/s.yaml'
    new: annotation
+    internal.config.kubernetes.io/path: 'foo/bar/s.yaml'
 `, `
 apiVersion: apps/v1
 kind: Deployment
@@ -575,6 +587,7 @@ items:
    name: service-foo
    annotations:
      config.kubernetes.io/path: 'foo/bar/s.yaml'
+      internal.config.kubernetes.io/id: '1'
      config.k8s.io/id: '1'
 functionConfig:
  apiVersion: example.com/v1
@@ -594,7 +607,7 @@ items:
    annotations:
      config.kubernetes.io/path: 'foo/bar/s.yaml'
      new: annotation
-      config.k8s.io/id: '1'
+      internal.config.kubernetes.io/id: '1'
 functionConfig:
  apiVersion: example.com/v1
  kind: Example
@@ -638,6 +651,7 @@ metadata:
  annotations:
    config.kubernetes.io/path: 'foo/bar/s.yaml'
    new: annotation
+    internal.config.kubernetes.io/path: 'foo/bar/s.yaml'
 `, `
 apiVersion: apps/v1
 kind: Deployment
@@ -661,6 +675,7 @@ items:
    name: deployment-foo
    annotations:
      config.kubernetes.io/path: 'baz/bar/d.yaml'
+      internal.config.kubernetes.io/id: '1'
      config.k8s.io/id: '1'
 - apiVersion: v1
  kind: Service
@@ -668,6 +683,7 @@ items:
    name: service-foo
    annotations:
      config.kubernetes.io/path: 'foo/bar/s.yaml'
+      internal.config.kubernetes.io/id: '2'
      config.k8s.io/id: '2'
 functionConfig:
  apiVersion: example.com/v1
@@ -686,7 +702,7 @@ items:
    name: deployment-foo
    annotations:
      config.kubernetes.io/path: 'baz/bar/d.yaml'
-      config.k8s.io/id: '1'
+      internal.config.kubernetes.io/id: '1'
 - apiVersion: v1
  kind: Service
  metadata:
@@ -737,6 +753,7 @@ metadata:
  name: deployment-foo
  annotations:
    config.kubernetes.io/path: 'baz/bar/d.yaml'
+    internal.config.kubernetes.io/path: 'baz/bar/d.yaml'
 `, `
 apiVersion: v1
 kind: Service
@@ -745,6 +762,7 @@ metadata:
  annotations:
    config.kubernetes.io/path: 'foo/bar/s.yaml'
    new: annotation
+    internal.config.kubernetes.io/path: 'foo/bar/s.yaml'
 `,
 			},
 		},
@@ -831,6 +849,7 @@ items:
    name: service-foo
    annotations:
      config.kubernetes.io/path: 'foo/bar/s.yaml'
+      internal.config.kubernetes.io/id: '1'
      config.k8s.io/id: '1'
 functionConfig:
  apiVersion: example.com/v1
@@ -849,8 +868,9 @@ items:
    name: service-foo
    annotations:
      config.kubernetes.io/path: 'foo/bar/s.yaml'
-      config.k8s.io/id: '1'
+      internal.config.kubernetes.io/id: '1'
      new: annotation
+      internal.config.kubernetes.io/path: 'foo/bar/s.yaml'
 functionConfig:
  apiVersion: example.com/v1
  kind: Example
@@ -896,6 +916,7 @@ metadata:
  annotations:
    config.kubernetes.io/path: 'foo/bar/s.yaml'
    new: annotation
+    internal.config.kubernetes.io/path: 'foo/bar/s.yaml'
 `, `
 apiVersion: apps/v1
 kind: Deployment
@@ -919,6 +940,7 @@ items:
    name: deployment-foo
    annotations:
      config.kubernetes.io/path: 'foo/b.yaml'
+      internal.config.kubernetes.io/id: '1'
      config.k8s.io/id: '1'
 - apiVersion: v1
  kind: Service
@@ -926,6 +948,7 @@ items:
    name: service-foo # name comment
    annotations:
      config.kubernetes.io/path: 'foo/a.yaml'
+      internal.config.kubernetes.io/id: '2'
      config.k8s.io/id: '2'
 functionConfig:
  apiVersion: example.com/v1
@@ -945,14 +968,14 @@ items:
    name: deployment-foo
    annotations:
      config.kubernetes.io/path: 'foo/b.yaml'
-      config.k8s.io/id: '1'
+      internal.config.kubernetes.io/id: '1'
 - apiVersion: v1
  kind: Service
  metadata:
    name: service-foo
    annotations:
      config.kubernetes.io/path: 'foo/a.yaml'
-      config.k8s.io/id: '2'
+      internal.config.kubernetes.io/id: '2'
      new: annotation
 functionConfig:
  apiVersion: example.com/v1
@@ -996,6 +1019,7 @@ metadata:
  name: deployment-foo
  annotations:
    config.kubernetes.io/path: 'foo/b.yaml'
+    internal.config.kubernetes.io/path: 'foo/b.yaml'
 `, `
 apiVersion: v1
 kind: Service
@@ -1004,6 +1028,7 @@ metadata:
  annotations:
    config.kubernetes.io/path: 'foo/a.yaml'
    new: annotation
+    internal.config.kubernetes.io/path: 'foo/a.yaml'
 `,
 			},
 		},