Merge pull request #52 from kcp-dev/multi-group

Remove 1 APIExport = 1 API group limitation

Author: kcp-ci-bot

cmd/api-syncagent/main.go

@@ -117,7 +117,7 @@ func run(ctx context.Context, log *zap.SugaredLogger, opts *Options) error {
 		return fmt.Errorf("failed to resolve APIExport: %w", err)
 	}
 
-	log.Infow("Resolved APIExport", "apigroup", opts.APIExportRef, "workspace", lcPath, "logicalcluster", lcName)
+	log.Infow("Resolved APIExport", "workspace", lcPath, "logicalcluster", lcName)
 
 	// init the "permanent" kcp cluster connection
 	kcpCluster, err := setupKcpCluster(kcpRestConfig, opts)
@@ -131,7 +131,7 @@ func run(ctx context.Context, log *zap.SugaredLogger, opts *Options) error {
 		return fmt.Errorf("failed to add kcp cluster runnable: %w", err)
 	}
 
-	if err := apiresourceschema.Add(mgr, kcpCluster, lcName, log, 4, opts.AgentName, opts.APIExportRef, opts.PublishedResourceSelector); err != nil {
+	if err := apiresourceschema.Add(mgr, kcpCluster, lcName, log, 4, opts.AgentName, opts.PublishedResourceSelector); err != nil {
 		return fmt.Errorf("failed to add apiresourceschema controller: %w", err)
 	}
 

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

@@ -285,6 +285,9 @@ spec:
                       items:
                         type: string
                       type: array
+                    group:
+                      description: The API group, for example "myservice.example.com".
+                      type: string
                     kind:
                       description: |-
                         The resource Kind, for example "Database". Setting this field will also overwrite

internal/controller/apiexport/reconciler.go

@@ -34,7 +34,7 @@ import (
 func (r *Reconciler) createAPIExportReconciler(availableResourceSchemas sets.Set[string], claimedResourceKinds sets.Set[string], agentName string, apiExportName string) reconciling.NamedAPIExportReconcilerFactory {
 	return func() (string, reconciling.APIExportReconciler) {
 		return apiExportName, func(existing *kcpdevv1alpha1.APIExport) (*kcpdevv1alpha1.APIExport, error) {
-			known := sets.New[string](existing.Spec.LatestResourceSchemas...)
+			known := sets.New(existing.Spec.LatestResourceSchemas...)
 
 			if existing.Annotations == nil {
 				existing.Annotations = map[string]string{}

internal/controller/apiresourceschema/controller.go

@@ -54,14 +54,13 @@ const (
 )
 
 type Reconciler struct {
-	localClient   ctrlruntimeclient.Client
-	kcpClient     ctrlruntimeclient.Client
-	restConfig    *rest.Config
-	log           *zap.SugaredLogger
-	recorder      record.EventRecorder
-	lcName        logicalcluster.Name
-	agentName     string
-	apiExportName string
+	localClient ctrlruntimeclient.Client
+	kcpClient   ctrlruntimeclient.Client
+	restConfig  *rest.Config
+	log         *zap.SugaredLogger
+	recorder    record.EventRecorder
+	lcName      logicalcluster.Name
+	agentName   string
 }
 
 // Add creates a new controller and adds it to the given manager.
@@ -72,18 +71,16 @@ func Add(
 	log *zap.SugaredLogger,
 	numWorkers int,
 	agentName string,
-	apiExportName string,
 	prFilter labels.Selector,
 ) error {
 	reconciler := &Reconciler{
-		localClient:   mgr.GetClient(),
-		kcpClient:     kcpCluster.GetClient(),
-		restConfig:    mgr.GetConfig(),
-		lcName:        lcName,
-		log:           log.Named(ControllerName),
-		recorder:      mgr.GetEventRecorderFor(ControllerName),
-		agentName:     agentName,
-		apiExportName: apiExportName,
+		localClient: mgr.GetClient(),
+		kcpClient:   kcpCluster.GetClient(),
+		restConfig:  mgr.GetConfig(),
+		lcName:      lcName,
+		log:         log.Named(ControllerName),
+		recorder:    mgr.GetEventRecorderFor(ControllerName),
+		agentName:   agentName,
 	}
 
 	_, err := builder.ControllerManagedBy(mgr).
@@ -138,14 +135,14 @@ func (r *Reconciler) reconcile(ctx context.Context, log *zap.SugaredLogger, pubR
 	}
 
 	// project the CRD
-	projectedCRD, err := r.applyProjection(r.apiExportName, crd, pubResource)
+	projectedCRD, err := r.applyProjection(crd, pubResource)
 	if err != nil {
 		return nil, fmt.Errorf("failed to apply projection rules: %w", err)
 	}
 
 	// to prevent changing the source GVK e.g. from "apps/v1 Daemonset" to "core/v1 Pod",
 	// we include the source GVK in hashed form in the final APIResourceSchema name.
-	arsName := r.getAPIResourceSchemaName(r.apiExportName, projectedCRD)
+	arsName := r.getAPIResourceSchemaName(projectedCRD)
 
 	// ARS'es cannot be updated, their entire spec is immutable. For now we do not care about
 	// CRDs being updated on the service cluster, but in the future (TODO) we must allow
@@ -155,7 +152,7 @@ func (r *Reconciler) reconcile(ctx context.Context, log *zap.SugaredLogger, pubR
 	err = r.kcpClient.Get(wsCtx, types.NamespacedName{Name: arsName}, ars, &ctrlruntimeclient.GetOptions{})
 
 	if apierrors.IsNotFound(err) {
-		if err := r.createAPIResourceSchema(wsCtx, log, r.apiExportName, projectedCRD, arsName); err != nil {
+		if err := r.createAPIResourceSchema(wsCtx, log, projectedCRD, arsName); err != nil {
 			return nil, fmt.Errorf("failed to create APIResourceSchema: %w", err)
 		}
 	} else if err != nil {
@@ -178,7 +175,7 @@ func (r *Reconciler) reconcile(ctx context.Context, log *zap.SugaredLogger, pubR
 	return nil, nil
 }
 
-func (r *Reconciler) createAPIResourceSchema(ctx context.Context, log *zap.SugaredLogger, apigroup string, projectedCRD *apiextensionsv1.CustomResourceDefinition, arsName string) error {
+func (r *Reconciler) createAPIResourceSchema(ctx context.Context, log *zap.SugaredLogger, projectedCRD *apiextensionsv1.CustomResourceDefinition, arsName string) error {
 	// prefix is irrelevant as the reconciling framework will use arsName anyway
 	converted, err := kcpdevv1alpha1.CRDToAPIResourceSchema(projectedCRD, "irrelevant")
 	if err != nil {
@@ -191,9 +188,6 @@ func (r *Reconciler) createAPIResourceSchema(ctx context.Context, log *zap.Sugar
 		syncagentv1alpha1.SourceGenerationAnnotation: fmt.Sprintf("%d", projectedCRD.Generation),
 		syncagentv1alpha1.AgentNameAnnotation:        r.agentName,
 	}
-	ars.Labels = map[string]string{
-		syncagentv1alpha1.APIGroupLabel: apigroup,
-	}
 	ars.Spec.Group = converted.Spec.Group
 	ars.Spec.Names = converted.Spec.Names
 	ars.Spec.Scope = converted.Spec.Scope
@@ -204,9 +198,8 @@ func (r *Reconciler) createAPIResourceSchema(ctx context.Context, log *zap.Sugar
 	return r.kcpClient.Create(ctx, ars)
 }
 
-func (r *Reconciler) applyProjection(apiGroup string, crd *apiextensionsv1.CustomResourceDefinition, pr *syncagentv1alpha1.PublishedResource) (*apiextensionsv1.CustomResourceDefinition, error) {
+func (r *Reconciler) applyProjection(crd *apiextensionsv1.CustomResourceDefinition, pr *syncagentv1alpha1.PublishedResource) (*apiextensionsv1.CustomResourceDefinition, error) {
 	result := crd.DeepCopy()
-	result.Spec.Group = apiGroup
 
 	// Currently CRDs generated by our discovery mechanism already set these to true, but that's just
 	// because it doesn't care to set them correctly; we keep this code here because from here on,
@@ -219,6 +212,10 @@ func (r *Reconciler) applyProjection(apiGroup string, crd *apiextensionsv1.Custo
 		return result, nil
 	}
 
+	if projection.Group != "" {
+		result.Spec.Group = projection.Group
+	}
+
 	if projection.Version != "" {
 		result.Spec.Versions[0].Name = projection.Version
 	}
@@ -252,9 +249,9 @@ func (r *Reconciler) applyProjection(apiGroup string, crd *apiextensionsv1.Custo
 
 // getAPIResourceSchemaName generates the name for the ARS in kcp. Note that
 // kcp requires, just like CRDs, that ARS are named following a specific pattern.
-func (r *Reconciler) getAPIResourceSchemaName(apiGroup string, crd *apiextensionsv1.CustomResourceDefinition) string {
+func (r *Reconciler) getAPIResourceSchemaName(crd *apiextensionsv1.CustomResourceDefinition) string {
 	checksum := crypto.Hash(crd.Spec.Names)
 
 	// include a leading "v" to prevent SHA-1 hashes with digits to break the name
-	return fmt.Sprintf("v%s.%s.%s", checksum[:8], crd.Spec.Names.Plural, apiGroup)
+	return fmt.Sprintf("v%s.%s.%s", checksum[:8], crd.Spec.Names.Plural, crd.Spec.Group)
 }

internal/controller/sync/controller.go

@@ -71,7 +71,6 @@ func Create(
 	virtualWorkspaceCluster cluster.Cluster,
 	pubRes *syncagentv1alpha1.PublishedResource,
 	discoveryClient *discovery.Client,
-	apiExportName string,
 	stateNamespace string,
 	agentName string,
 	log *zap.SugaredLogger,
@@ -85,7 +84,7 @@ func Create(
 	localDummy.SetGroupVersionKind(localGVK)
 
 	// create a dummy unstructured object with the projected GVK inside the workspace
-	remoteGVK := projection.PublishedResourceProjectedGVK(pubRes, apiExportName)
+	remoteGVK := projection.PublishedResourceProjectedGVK(pubRes)
 	remoteDummy := &unstructured.Unstructured{}
 	remoteDummy.SetGroupVersionKind(remoteGVK)
 
@@ -97,7 +96,7 @@ func Create(
 
 	// create the syncer that holds the meat&potatoes of the synchronization logic
 	mutator := mutation.NewMutator(pubRes.Spec.Mutation)
-	syncer, err := sync.NewResourceSyncer(log, localManager.GetClient(), virtualWorkspaceCluster.GetClient(), pubRes, localCRD, apiExportName, mutator, stateNamespace, agentName)
+	syncer, err := sync.NewResourceSyncer(log, localManager.GetClient(), virtualWorkspaceCluster.GetClient(), pubRes, localCRD, mutator, stateNamespace, agentName)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create syncer: %w", err)
 	}

internal/controller/syncmanager/controller.go

@@ -286,7 +286,6 @@ func (r *Reconciler) ensureSyncControllers(ctx context.Context, log *zap.Sugared
 			r.vwCluster.GetCluster(),
 			&pubRes,
 			r.discoveryClient,
-			r.apiExport.Name,
 			r.stateNamespace,
 			r.agentName,
 			r.log,

internal/projection/projection.go

@@ -34,11 +34,16 @@ func PublishedResourceSourceGVK(pubRes *syncagentv1alpha1.PublishedResource) sch
 
 // PublishedResourceProjectedGVK returns the effective GVK after the projection
 // rules have been applied according to the PublishedResource.
-func PublishedResourceProjectedGVK(pubRes *syncagentv1alpha1.PublishedResource, kcpAPIGroup string) schema.GroupVersionKind {
+func PublishedResourceProjectedGVK(pubRes *syncagentv1alpha1.PublishedResource) schema.GroupVersionKind {
+	apiGroup := pubRes.Spec.Resource.APIGroup
 	apiVersion := pubRes.Spec.Resource.Version
 	kind := pubRes.Spec.Resource.Kind
 
 	if projection := pubRes.Spec.Projection; projection != nil {
+		if v := projection.Group; v != "" {
+			apiGroup = v
+		}
+
 		if v := projection.Version; v != "" {
 			apiVersion = v
 		}
@@ -49,7 +54,7 @@ func PublishedResourceProjectedGVK(pubRes *syncagentv1alpha1.PublishedResource,
 	}
 
 	return schema.GroupVersionKind{
-		Group:   kcpAPIGroup,
+		Group:   apiGroup,
 		Version: apiVersion,
 		Kind:    kind,
 	}

internal/projection/projection_test.go

@@ -58,10 +58,9 @@ func TestPublishedResourceSourceGVK(t *testing.T) {
 
 func TestPublishedResourceProjectedGVK(t *testing.T) {
 	const (
-		apiGroup         = "testgroup"
-		overrideAPIGroup = "newgroup"
-		version          = "v1"
-		kind             = "test"
+		apiGroup = "testgroup"
+		version  = "v1"
+		kind     = "test"
 	)
 
 	pubRes := &syncagentv1alpha1.PublishedResource{
@@ -82,22 +81,27 @@ func TestPublishedResourceProjectedGVK(t *testing.T) {
 		{
 			name:       "no projection",
 			projection: nil,
-			expected:   schema.GroupVersionKind{Group: overrideAPIGroup, Version: version, Kind: kind},
+			expected:   schema.GroupVersionKind{Group: apiGroup, Version: version, Kind: kind},
 		},
 		{
 			name:       "override version",
 			projection: &syncagentv1alpha1.ResourceProjection{Version: "v2"},
-			expected:   schema.GroupVersionKind{Group: overrideAPIGroup, Version: "v2", Kind: kind},
+			expected:   schema.GroupVersionKind{Group: apiGroup, Version: "v2", Kind: kind},
 		},
 		{
 			name:       "override kind",
 			projection: &syncagentv1alpha1.ResourceProjection{Kind: "dummy"},
-			expected:   schema.GroupVersionKind{Group: overrideAPIGroup, Version: version, Kind: "dummy"},
+			expected:   schema.GroupVersionKind{Group: apiGroup, Version: version, Kind: "dummy"},
 		},
 		{
 			name:       "override both",
 			projection: &syncagentv1alpha1.ResourceProjection{Version: "v2", Kind: "dummy"},
-			expected:   schema.GroupVersionKind{Group: overrideAPIGroup, Version: "v2", Kind: "dummy"},
+			expected:   schema.GroupVersionKind{Group: apiGroup, Version: "v2", Kind: "dummy"},
+		},
+		{
+			name:       "override group",
+			projection: &syncagentv1alpha1.ResourceProjection{Group: "projected.com"},
+			expected:   schema.GroupVersionKind{Group: "projected.com", Version: version, Kind: kind},
 		},
 	}
 
@@ -106,7 +110,7 @@ func TestPublishedResourceProjectedGVK(t *testing.T) {
 			pr := pubRes.DeepCopy()
 			pr.Spec.Projection = testcase.projection
 
-			gvk := PublishedResourceProjectedGVK(pr, overrideAPIGroup)
+			gvk := PublishedResourceProjectedGVK(pr)
 
 			if gvk.Group != testcase.expected.Group {
 				t.Errorf("Expected API group to be %q, but got %q.", testcase.expected.Group, gvk.Group)

internal/sync/syncer.go

@@ -58,7 +58,6 @@ func NewResourceSyncer(
 	remoteClient ctrlruntimeclient.Client,
 	pubRes *syncagentv1alpha1.PublishedResource,
 	localCRD *apiextensionsv1.CustomResourceDefinition,
-	remoteAPIGroup string,
 	mutator mutation.Mutator,
 	stateNamespace string,
 	agentName string,
@@ -69,7 +68,7 @@ func NewResourceSyncer(
 	localDummy.SetGroupVersionKind(localGVK)
 
 	// create a dummy unstructured object with the projected GVK inside the workspace
-	remoteGVK := projection.PublishedResourceProjectedGVK(pubRes, remoteAPIGroup)
+	remoteGVK := projection.PublishedResourceProjectedGVK(pubRes)
 
 	// determine whether the CRD has a status subresource in the relevant version
 	subresources := []string{}