Merge pull request #15 from kcp-dev/add-cluster-paths

✨ Add workspace paths as annotations to synced objects

Author: kcp-ci-bot

deploy/crd/kcp.io/syncagent.kcp.io_publishedresources.yaml

@@ -47,6 +47,14 @@ spec:
                 PublishedResourceSpec describes the desired resource publication from a service
                 cluster to kcp.
               properties:
+                enableWorkspacePaths:
+                  description: |-
+                    EnableWorkspacePaths toggles whether the Sync Agent will not just store the kcp
+                    cluster name as a label on each locally synced object, but also the full workspace
+                    path. This is optional because it requires additional requests to kcp and
+                    should only be used if the workspace path is of interest on the
+                    service cluster side.
+                  type: boolean
                 filter:
                   description: |-
                     If specified, the filter will be applied to the resources in a workspace

go.mod

@@ -70,7 +70,7 @@ require (
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/go-homedir v1.1.0 // indirect
-	github.com/mitchellh/mapstructure v1.3.3 // indirect
+	github.com/mitchellh/mapstructure v1.4.1 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect

go.sum

@@ -229,8 +229,8 @@ github.com/mitchellh/gox v0.4.0/go.mod h1:Sd9lOJ0+aimLBi73mGofS1ycjY8lL3uZM3JPS4
 github.com/mitchellh/iochan v1.0.0/go.mod h1:JwYml1nuB7xOzsp52dPpHFffvOCDupsG0QubkSMEySY=
 github.com/mitchellh/mapstructure v0.0.0-20160808181253-ca63d7c062ee/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
-github.com/mitchellh/mapstructure v1.3.3 h1:SzB1nHZ2Xi+17FP0zVQBHIZqvwRN9408fJO8h+eeNA8=
-github.com/mitchellh/mapstructure v1.3.3/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
+github.com/mitchellh/mapstructure v1.4.1 h1:CpVNEelQCZBooIPDn+AR3NpivK/TIKU8bDxdASFVQag=
+github.com/mitchellh/mapstructure v1.4.1/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ=
 github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=

internal/controller/sync/controller.go

@@ -30,7 +30,11 @@ import (
 	"github.com/kcp-dev/api-syncagent/internal/sync"
 	syncagentv1alpha1 "github.com/kcp-dev/api-syncagent/sdk/apis/syncagent/v1alpha1"
 
+	kcpcore "github.com/kcp-dev/kcp/sdk/apis/core"
+	kcpdevcorev1alpha1 "github.com/kcp-dev/kcp/sdk/apis/core/v1alpha1"
+
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/utils/ptr"
 	ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/cluster"
@@ -52,6 +56,7 @@ type Reconciler struct {
 	log         *zap.SugaredLogger
 	syncer      *sync.ResourceSyncer
 	remoteDummy *unstructured.Unstructured
+	pubRes      *syncagentv1alpha1.PublishedResource
 }
 
 // Create creates a new controller and importantly does *not* add it to the manager,
@@ -99,6 +104,7 @@ func Create(
 		log:         log,
 		remoteDummy: remoteDummy,
 		syncer:      syncer,
+		pubRes:      pubRes,
 	}
 
 	ctrlOptions := controller.Options{
@@ -152,8 +158,22 @@ func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (
 		return reconcile.Result{}, nil
 	}
 
+	syncContext := sync.NewContext(ctx, wsCtx)
+
+	// if desired, fetch the cluster path as well (some downstream service providers might make use of it,
+	// but since it requires an additional permission claim, it's optional)
+	if r.pubRes.Spec.EnableWorkspacePaths {
+		lc := &kcpdevcorev1alpha1.LogicalCluster{}
+		if err := r.vwClient.Get(wsCtx, types.NamespacedName{Name: kcpdevcorev1alpha1.LogicalClusterName}, lc); err != nil {
+			return reconcile.Result{}, fmt.Errorf("failed to retrieve remote logicalcluster: %w", err)
+		}
+
+		path := lc.Annotations[kcpcore.LogicalClusterPathAnnotationKey]
+		syncContext = syncContext.WithWorkspacePath(logicalcluster.NewPath(path))
+	}
+
 	// sync main object
-	requeue, err := r.syncer.Process(sync.NewContext(ctx, wsCtx), remoteObj)
+	requeue, err := r.syncer.Process(syncContext, remoteObj)
 	if err != nil {
 		return reconcile.Result{}, err
 	}

internal/controller/syncmanager/lifecycle/cluster.go

@@ -27,7 +27,10 @@ import (
 	"github.com/kcp-dev/logicalcluster/v3"
 	"go.uber.org/zap"
 
+	kcpdevcorev1alpha1 "github.com/kcp-dev/kcp/sdk/apis/core/v1alpha1"
+
 	"k8s.io/apimachinery/pkg/api/meta"
+	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/cache"
 	ctrlruntimeclient "sigs.k8s.io/controller-runtime/pkg/client"
@@ -100,18 +103,18 @@ func (c clusterRoundTripper) RoundTrip(req *http.Request) (*http.Response, error
 var apiRegex = regexp.MustCompile(`(/api/|/apis/)`)
 
 // generatePath formats the request path to target the specified cluster.
-func generatePath(originalPath string, clusterPath logicalcluster.Path) string {
+func generatePath(originalPath string, workspacePath logicalcluster.Path) string {
 	// If the originalPath already has cluster.Path() then the path was already modifed and no change needed
-	if strings.Contains(originalPath, clusterPath.RequestPath()) {
+	if strings.Contains(originalPath, workspacePath.RequestPath()) {
 		return originalPath
 	}
 	// If the originalPath has /api/ or /apis/ in it, it might be anywhere in the path, so we use a regex to find and
 	// replaces /api/ or /apis/ with $cluster/api/ or $cluster/apis/
 	if apiRegex.MatchString(originalPath) {
-		return apiRegex.ReplaceAllString(originalPath, fmt.Sprintf("%s$1", clusterPath.RequestPath()))
+		return apiRegex.ReplaceAllString(originalPath, fmt.Sprintf("%s$1", workspacePath.RequestPath()))
 	}
 	// Otherwise, we're just prepending /clusters/$name
-	path := clusterPath.RequestPath()
+	path := workspacePath.RequestPath()
 	// if the original path is relative, add a / separator
 	if len(originalPath) > 0 && originalPath[0] != '/' {
 		path += "/"
@@ -130,7 +133,14 @@ func NewCluster(address string, baseRestConfig *rest.Config) (*Cluster, error) {
 		return newClusterAwareRoundTripper(rt)
 	})
 
+	scheme := runtime.NewScheme()
+
+	if err := kcpdevcorev1alpha1.AddToScheme(scheme); err != nil {
+		return nil, fmt.Errorf("failed to register scheme %s: %w", kcpdevcorev1alpha1.SchemeGroupVersion, err)
+	}
+
 	clusterObj, err := cluster.New(config, func(o *cluster.Options) {
+		o.Scheme = scheme
 		o.NewCache = kcp.NewClusterAwareCache
 		o.NewAPIReader = kcp.NewClusterAwareAPIReader
 		o.NewClient = kcp.NewClusterAwareClient

internal/sync/context.go

@@ -19,13 +19,16 @@ package sync
 import (
 	"context"
 
+	"github.com/kcp-dev/logicalcluster/v3"
+
 	"sigs.k8s.io/controller-runtime/pkg/kontext"
 )
 
 type Context struct {
-	clusterName string
-	local       context.Context
-	remote      context.Context
+	clusterName   logicalcluster.Name
+	workspacePath logicalcluster.Path
+	local         context.Context
+	remote        context.Context
 }
 
 func NewContext(local, remote context.Context) Context {
@@ -35,8 +38,17 @@ func NewContext(local, remote context.Context) Context {
 	}
 
 	return Context{
-		clusterName: string(clusterName),
+		clusterName: clusterName,
 		local:       local,
 		remote:      remote,
 	}
 }
+
+func (c *Context) WithWorkspacePath(path logicalcluster.Path) Context {
+	return Context{
+		clusterName:   c.clusterName,
+		workspacePath: path,
+		local:         c.local,
+		remote:        c.remote,
+	}
+}

internal/sync/context_test.go

@@ -31,7 +31,7 @@ func TestNewContext(t *testing.T) {
 
 	combinedCtx := NewContext(context.Background(), ctx)
 
-	if combinedCtx.clusterName != clusterName.String() {
+	if combinedCtx.clusterName != clusterName {
 		t.Fatalf("Expected function to recognize the cluster name in the context, but got %q", combinedCtx.clusterName)
 	}
 }

internal/sync/meta.go

@@ -19,6 +19,7 @@ package sync
 import (
 	"context"
 
+	"github.com/kcp-dev/logicalcluster/v3"
 	"go.uber.org/zap"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -65,7 +66,7 @@ func ensureFinalizer(ctx context.Context, log *zap.SugaredLogger, client ctrlrun
 	finalizers.Insert(deletionFinalizer)
 	obj.SetFinalizers(sets.List(finalizers))
 
-	log.Debugw("Adding finalizer…", "on", newObjectKey(obj, ""), "finalizer", finalizer)
+	log.Debugw("Adding finalizer…", "on", newObjectKey(obj, "", logicalcluster.None), "finalizer", finalizer)
 	if err := client.Patch(ctx, obj, ctrlruntimeclient.MergeFrom(original)); err != nil {
 		return false, err
 	}
@@ -84,7 +85,7 @@ func removeFinalizer(ctx context.Context, log *zap.SugaredLogger, client ctrlrun
 	finalizers.Delete(deletionFinalizer)
 	obj.SetFinalizers(sets.List(finalizers))
 
-	log.Debugw("Removing finalizer…", "on", newObjectKey(obj, ""), "finalizer", finalizer)
+	log.Debugw("Removing finalizer…", "on", newObjectKey(obj, "", logicalcluster.None), "finalizer", finalizer)
 	if err := client.Patch(ctx, obj, ctrlruntimeclient.MergeFrom(original)); err != nil {
 		return false, err
 	}
@@ -93,16 +94,18 @@ func removeFinalizer(ctx context.Context, log *zap.SugaredLogger, client ctrlrun
 }
 
 type objectKey struct {
-	Cluster   string
-	Namespace string
-	Name      string
+	ClusterName   logicalcluster.Name
+	WorkspacePath logicalcluster.Path
+	Namespace     string
+	Name          string
 }
 
-func newObjectKey(obj metav1.Object, clusterName string) objectKey {
+func newObjectKey(obj metav1.Object, clusterName logicalcluster.Name, workspacePath logicalcluster.Path) objectKey {
 	return objectKey{
-		Cluster:   clusterName,
-		Namespace: obj.GetNamespace(),
-		Name:      obj.GetName(),
+		ClusterName:   clusterName,
+		WorkspacePath: workspacePath,
+		Namespace:     obj.GetNamespace(),
+		Name:          obj.GetName(),
 	}
 }
 
@@ -111,8 +114,8 @@ func (k objectKey) String() string {
 	if k.Namespace != "" {
 		result = k.Namespace + "/" + result
 	}
-	if k.Cluster != "" {
-		result = k.Cluster + "|" + result
+	if k.ClusterName != "" {
+		result = string(k.ClusterName) + "|" + result
 	}
 
 	return result
@@ -123,17 +126,27 @@ func (k objectKey) Key() string {
 	if k.Namespace != "" {
 		result = k.Namespace + "_" + result
 	}
-	if k.Cluster != "" {
-		result = k.Cluster + "_" + result
+	if k.ClusterName != "" {
+		result = string(k.ClusterName) + "_" + result
 	}
 
 	return result
 }
 
 func (k objectKey) Labels() labels.Set {
 	return labels.Set{
-		remoteObjectClusterLabel:   k.Cluster,
+		remoteObjectClusterLabel:   string(k.ClusterName),
 		remoteObjectNamespaceLabel: k.Namespace,
 		remoteObjectNameLabel:      k.Name,
 	}
 }
+
+func (k objectKey) Annotations() labels.Set {
+	s := labels.Set{}
+
+	if !k.WorkspacePath.Empty() {
+		s[remoteObjectWorkspacePathAnnotation] = k.WorkspacePath.String()
+	}
+
+	return s
+}

internal/sync/meta_test.go

@@ -19,6 +19,8 @@ package sync
 import (
 	"testing"
 
+	"github.com/kcp-dev/logicalcluster/v3"
+
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 )
@@ -33,9 +35,10 @@ func createNewObject(name, namespace string) metav1.Object {
 
 func TestObjectKey(t *testing.T) {
 	testcases := []struct {
-		object      metav1.Object
-		clusterName string
-		expected    string
+		object        metav1.Object
+		clusterName   logicalcluster.Name
+		workspacePath logicalcluster.Path
+		expected      string
 	}{
 		{
 			object:      createNewObject("test", ""),
@@ -57,11 +60,17 @@ func TestObjectKey(t *testing.T) {
 			clusterName: "abc123",
 			expected:    "abc123|namespace/test",
 		},
+		{
+			object:        createNewObject("test", "namespace"),
+			clusterName:   "abc123",
+			workspacePath: logicalcluster.NewPath("this:should:not:appear:in:the:key"),
+			expected:      "abc123|namespace/test",
+		},
 	}
 
 	for _, testcase := range testcases {
 		t.Run("", func(t *testing.T) {
-			key := newObjectKey(testcase.object, testcase.clusterName)
+			key := newObjectKey(testcase.object, testcase.clusterName, testcase.workspacePath)
 
 			if stringified := key.String(); stringified != testcase.expected {
 				t.Fatalf("Expected %q but got %q.", testcase.expected, stringified)