use annotation because labels do not allow colons

On-behalf-of: @SAP [email protected]

Author: xrstf

internal/sync/meta.go

@@ -134,14 +134,18 @@ func (k objectKey) Key() string {
 }
 
 func (k objectKey) Labels() labels.Set {
-	s := labels.Set{
+	return labels.Set{
 		remoteObjectClusterLabel:   string(k.ClusterName),
 		remoteObjectNamespaceLabel: k.Namespace,
 		remoteObjectNameLabel:      k.Name,
 	}
+}
+
+func (k objectKey) Annotations() labels.Set {
+	s := labels.Set{}
 
 	if !k.ClusterPath.Empty() {
-		s[remoteObjectClusterPathLabel] = k.ClusterPath.String()
+		s[remoteObjectClusterPathAnnotation] = k.ClusterPath.String()
 	}
 
 	return s

internal/sync/object_syncer.go

@@ -183,6 +183,11 @@ func (s *objectSyncer) syncObjectSpec(log *zap.SugaredLogger, source, dest syncS
 		lastKnownSourceState.SetAPIVersion(sourceObjCopy.GetAPIVersion())
 		lastKnownSourceState.SetKind(sourceObjCopy.GetKind())
 
+		// update annotations (this is important if the admin later flipped the enableClusterPaths
+		// option in the PublishedResource)
+		sourceKey := newObjectKey(source.object, source.clusterName, source.clusterPath)
+		ensureAnnotations(sourceObjCopy, sourceKey.Annotations())
+
 		// now we can diff the two versions and create a patch
 		rawPatch, err := s.createMergePatch(lastKnownSourceState, sourceObjCopy)
 		if err != nil {
@@ -276,6 +281,9 @@ func (s *objectSyncer) ensureDestinationObject(log *zap.SugaredLogger, source, d
 	sourceObjKey := newObjectKey(source.object, source.clusterName, source.clusterPath)
 	ensureLabels(destObj, sourceObjKey.Labels())
 
+	// put optional additional annotations on the new object
+	ensureAnnotations(destObj, sourceObjKey.Annotations())
+
 	// finally, we can create the destination object
 	objectLog := log.With("dest-object", newObjectKey(destObj, dest.clusterName, logicalcluster.None))
 	objectLog.Debugw("Creating destination object…")
@@ -318,6 +326,7 @@ func (s *objectSyncer) adoptExistingDestinationObject(log *zap.SugaredLogger, de
 	// the destination object from another source object, which would then lead to the two source objects
 	// "fighting" about the one destination object.
 	ensureLabels(existingDestObj, sourceKey.Labels())
+	ensureAnnotations(existingDestObj, sourceKey.Annotations())
 
 	if err := dest.client.Update(dest.ctx, existingDestObj); err != nil {
 		return fmt.Errorf("failed to upsert current destination object labels: %w", err)

internal/sync/types.go

@@ -21,14 +21,15 @@ const (
 	// them from being deleted before the local objects can be cleaned up.
 	deletionFinalizer = "syncagent.kcp.io/cleanup"
 
-	// The following 4 labels are put on local objects to link them to their
+	// The following 4 labels/annotations are put on local objects to link them to their
 	// origin remote objects. Note that the cluster *path* label is optional and
 	// has to be enabled per PublishedResource.
 
-	remoteObjectClusterLabel     = "syncagent.kcp.io/remote-object-cluster"
-	remoteObjectClusterPathLabel = "syncagent.kcp.io/remote-object-cluster-path"
-	remoteObjectNamespaceLabel   = "syncagent.kcp.io/remote-object-namespace"
-	remoteObjectNameLabel        = "syncagent.kcp.io/remote-object-name"
+	remoteObjectClusterLabel   = "syncagent.kcp.io/remote-object-cluster"
+	remoteObjectNamespaceLabel = "syncagent.kcp.io/remote-object-namespace"
+	remoteObjectNameLabel      = "syncagent.kcp.io/remote-object-name"
+
+	remoteObjectClusterPathAnnotation = "syncagent.kcp.io/remote-object-cluster-path"
 
 	// objectStateLabelName is put on object state Secrets to allow for easier mass deletions
 	// if ever necessary.