Moved resource version annotation to a different file

The newly added file can be used for storing all the metadata going forward It is added and removed from the client side and will not be present in porch Please refer this for more info: #4017
kptdev · Aug 8, 2023 · 925d1f9 · 925d1f9
1 parent f5d414e
commit 925d1f9
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 23 deletions.
diff --git a/commands/alpha/rpkg/pull/command.go b/commands/alpha/rpkg/pull/command.go
@@ -113,7 +113,7 @@ func (r *runner) runE(_ *cobra.Command, args []string) error {
 		return errors.E(op, err)
 	}
 
-	if err := util.AddResourceVersionAnnotation(&resources); err != nil {
+	if err := util.AddRevisionMetaData(&resources); err != nil {
 		return errors.E(op, err)
 	}
 
@@ -200,7 +200,7 @@ func createScheme() (*runtime.Scheme, error) {
 	return scheme, nil
 }
 
-var matchResourceContents = append(kio.MatchAll, kptfilev1.KptFileName)
+var matchResourceContents = append(kio.MatchAll, kptfilev1.KptFileName, kptfilev1.RevisionMetaDataFileName)
 
 func includeFile(path string) bool {
 	for _, m := range matchResourceContents {

diff --git a/commands/alpha/rpkg/pull/command_test.go b/commands/alpha/rpkg/pull/command_test.go
@@ -68,13 +68,22 @@ data:
 apiVersion: config.kubernetes.io/v1
 kind: ResourceList
 items:
+- apiVersion: kpt.dev/v1
+  kind: KptRevisionMetaData
+  metadata:
+    name: bar
+    annotations:
+      internal.kpt.dev/resource-version: "999"
+      config.kubernetes.io/index: '0'
+      internal.config.kubernetes.io/index: '0'
+      internal.config.kubernetes.io/path: 'KptRevisionMetaData'
+      config.kubernetes.io/path: 'KptRevisionMetaData'
 - apiVersion: kpt.dev/v1
   kind: Kptfile
   metadata:
     name: bar
     annotations:
       config.kubernetes.io/local-config: "true"
-      internal.kpt.dev/resource-version: "999"
       config.kubernetes.io/index: '0'
       internal.config.kubernetes.io/index: '0'
       internal.config.kubernetes.io/path: 'Kptfile'
@@ -121,13 +130,22 @@ data:
 apiVersion: config.kubernetes.io/v1
 kind: ResourceList
 items:
+- apiVersion: kpt.dev/v1
+  kind: KptRevisionMetaData
+  metadata:
+    name: bar
+    annotations:
+      internal.kpt.dev/resource-version: "999"
+      config.kubernetes.io/index: '0'
+      internal.config.kubernetes.io/index: '0'
+      internal.config.kubernetes.io/path: 'KptRevisionMetaData'
+      config.kubernetes.io/path: 'KptRevisionMetaData'
 - apiVersion: kpt.dev/v1
   kind: Kptfile
   metadata:
     name: bar
     annotations:
       config.kubernetes.io/local-config: "true"
-      internal.kpt.dev/resource-version: "999"
       config.kubernetes.io/index: '0'
       internal.config.kubernetes.io/index: '0'
       internal.config.kubernetes.io/path: 'Kptfile'

diff --git a/commands/alpha/rpkg/push/command.go b/commands/alpha/rpkg/push/command.go
@@ -139,7 +139,7 @@ func (r *runner) runE(cmd *cobra.Command, args []string) error {
 		return errors.E(op, err)
 	}
 	pkgResources.ResourceVersion = rv
-	if err = util.RemoveResourceVersionAnnotation(&pkgResources); err != nil {
+	if err = util.RemoveRevisionMetaData(&pkgResources); err != nil {
 		return errors.E(op, err)
 	}
 

diff --git a/commands/alpha/rpkg/util/common.go b/commands/alpha/rpkg/util/common.go
@@ -19,6 +19,7 @@ import (
 	"fmt"
 
 	fnsdk "github.com/GoogleContainerTools/kpt-functions-sdk/go/fn"
+	kptfilev1 "github.com/GoogleContainerTools/kpt/pkg/api/kptfile/v1"
 	api "github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
@@ -68,11 +69,11 @@ func GetResourceFileKubeObject(prr *api.PackageRevisionResources, file, kind, na
 }
 
 func GetResourceVersionAnnotation(prr *api.PackageRevisionResources) (string, error) {
-	ko, err := GetResourceFileKubeObject(prr, "Kptfile", "Kptfile", "")
-
+	ko, err := GetResourceFileKubeObject(prr, kptfilev1.RevisionMetaDataFileName, kptfilev1.RevisionMetaDataKind, "")
 	if err != nil {
 		return "", err
 	}
+
 	annotations := ko.GetAnnotations()
 	rv, ok := annotations[ResourceVersionAnnotation]
 	if !ok {
@@ -81,29 +82,23 @@ func GetResourceVersionAnnotation(prr *api.PackageRevisionResources) (string, er
 	return rv, nil
 }
 
-func AddResourceVersionAnnotation(prr *api.PackageRevisionResources) error {
-	ko, err := GetResourceFileKubeObject(prr, "Kptfile", "Kptfile", "")
+func AddRevisionMetaData(prr *api.PackageRevisionResources) error {
+	kptfileKo, err := GetResourceFileKubeObject(prr, "Kptfile", "Kptfile", "")
 	if err != nil {
 		return err
 	}
 
-	ko.SetAnnotation(ResourceVersionAnnotation, prr.GetResourceVersion())
-	prr.Spec.Resources["Kptfile"] = ko.String()
+	kptMetaDataKo := fnsdk.NewEmptyKubeObject()
+	kptMetaDataKo.SetAPIVersion(kptfileKo.GetAPIVersion())
+	kptMetaDataKo.SetKind(kptfilev1.RevisionMetaDataKind)
+	kptMetaDataKo.SetName(kptfileKo.GetName())
+	kptMetaDataKo.SetAnnotation(ResourceVersionAnnotation, prr.GetResourceVersion())
+	prr.Spec.Resources[kptfilev1.RevisionMetaDataFileName] = kptMetaDataKo.String()
 
 	return nil
 }
 
-func RemoveResourceVersionAnnotation(prr *api.PackageRevisionResources) error {
-	ko, err := GetResourceFileKubeObject(prr, "Kptfile", "Kptfile", "")
-	if err != nil {
-		return err
-	}
-
-	_, err = ko.RemoveNestedField("metadata", "annotations", ResourceVersionAnnotation)
-	if err != nil {
-		return err
-	}
-	prr.Spec.Resources["Kptfile"] = ko.String()
-
+func RemoveRevisionMetaData(prr *api.PackageRevisionResources) error {
+	delete(prr.Spec.Resources, kptfilev1.RevisionMetaDataFileName)
 	return nil
 }
diff --git a/pkg/api/kptfile/v1/types.go b/pkg/api/kptfile/v1/types.go
@@ -29,6 +29,10 @@ import (
 const (
 	KptFileName = "Kptfile"
 
+	RevisionMetaDataFileName = "KptRevisionMetaData"
+
+	RevisionMetaDataKind = "KptRevisionMetaData"
+
 	// Deprecated: prefer KptFileGVK
 	KptFileKind = "Kptfile"