Add APIExport annotation to skip APIExportEndpointSlice creation

Author: mjudeikis

pkg/reconciler/apis/apiexport/apiexport_controller_test.go

@@ -50,6 +50,7 @@ func TestReconcile(t *testing.T) {
 		hasPreexistingVerifyFailure          bool
 		listShardsError                      error
 		apiExportEndpointSliceNotFound       bool
+		skipEndpointSliceAnnotation          bool
 
 		apiBindings []interface{}
 
@@ -133,11 +134,22 @@ func TestReconcile(t *testing.T) {
 			wantCreateAPIExportEndpointSlice: true,
 			wantIdentityValid:                true,
 		},
+		"skip APIExportEndpointSlice creation when skip annotation is present": {
+			secretRefSet: true,
+			secretExists: true,
+
+			wantStatusHashSet:                true,
+			apiExportEndpointSliceNotFound:   true,
+			wantCreateAPIExportEndpointSlice: false,
+			wantIdentityValid:                true,
+			skipEndpointSliceAnnotation:      true,
+		},
 	}
 
 	for name, tc := range tests {
 		t.Run(name, func(t *testing.T) {
 			createSecretCalled := false
+			createEndpointSliceCalled := false
 
 			expectedKey := "abc"
 			expectedHash := fmt.Sprintf("%x", sha256.Sum256([]byte(expectedKey)))
@@ -158,6 +170,7 @@ func TestReconcile(t *testing.T) {
 					return &apisv1alpha1.APIExportEndpointSlice{}, nil
 				},
 				createAPIExportEndpointSlice: func(ctx context.Context, clusterName logicalcluster.Path, apiExportEndpointSlice *apisv1alpha1.APIExportEndpointSlice) error {
+					createEndpointSliceCalled = true
 					return nil
 				},
 				getSecret: func(ctx context.Context, clusterName logicalcluster.Name, ns, name string) (*corev1.Secret, error) {
@@ -242,6 +255,10 @@ func TestReconcile(t *testing.T) {
 				conditions.MarkFalse(apiExport, apisv1alpha2.APIExportIdentityValid, apisv1alpha2.IdentityVerificationFailedReason, conditionsv1alpha1.ConditionSeverityError, "")
 			}
 
+			if tc.skipEndpointSliceAnnotation {
+				apiExport.Annotations[apisv1alpha2.APIExportEndpointSliceSkipAnnotation] = "true"
+			}
+
 			err := c.reconcile(context.Background(), apiExport)
 			if tc.wantError {
 				require.Error(t, err, "expected an error")
@@ -292,6 +309,8 @@ func TestReconcile(t *testing.T) {
 			if tc.wantIdentityValid {
 				requireConditionMatches(t, apiExport, conditions.TrueCondition(apisv1alpha2.APIExportIdentityValid))
 			}
+
+			require.Equal(t, tc.wantCreateAPIExportEndpointSlice, createEndpointSliceCalled, "expected createEndpointSliceCalled to be %v", tc.wantCreateAPIExportEndpointSlice)
 		})
 	}
 }

pkg/reconciler/apis/apiexport/apiexport_reconcile.go

@@ -101,26 +101,36 @@ func (c *controller) reconcile(ctx context.Context, apiExport *apisv1alpha2.APIE
 	}
 
 	// Ensure the APIExportEndpointSlice exists
-	_, err := c.getAPIExportEndpointSlice(clusterName, apiExport.Name)
-	if err != nil {
-		if errors.IsNotFound(err) {
-			// Create the APIExportEndpointSlice
-			apiExportEndpointSlice := &apisv1alpha1.APIExportEndpointSlice{
-				ObjectMeta: metav1.ObjectMeta{
-					Name: apiExport.Name,
-				},
-				Spec: apisv1alpha1.APIExportEndpointSliceSpec{
-					APIExport: apisv1alpha1.ExportBindingReference{
+	if _, ok := apiExport.Annotations[apisv1alpha2.APIExportEndpointSliceSkipAnnotation]; !ok {
+		_, err := c.getAPIExportEndpointSlice(clusterName, apiExport.Name)
+		if err != nil {
+			if errors.IsNotFound(err) {
+				// Create the APIExportEndpointSlice
+				apiExportEndpointSlice := &apisv1alpha1.APIExportEndpointSlice{
+					ObjectMeta: metav1.ObjectMeta{
 						Name: apiExport.Name,
-						Path: clusterPath,
+						OwnerReferences: []metav1.OwnerReference{
+							{
+								APIVersion: apisv1alpha1.SchemeGroupVersion.String(),
+								Kind:       "APIExport",
+								Name:       apiExport.Name,
+								UID:        apiExport.UID,
+							},
+						},
 					},
-				},
-			}
-			if err := c.createAPIExportEndpointSlice(ctx, clusterName.Path(), apiExportEndpointSlice); err != nil {
-				return fmt.Errorf("error creating APIExportEndpointSlice for APIExport %s|%s: %w", clusterName, apiExport.Name, err)
+					Spec: apisv1alpha1.APIExportEndpointSliceSpec{
+						APIExport: apisv1alpha1.ExportBindingReference{
+							Name: apiExport.Name,
+							Path: clusterPath,
+						},
+					},
+				}
+				if err := c.createAPIExportEndpointSlice(ctx, clusterName.Path(), apiExportEndpointSlice); err != nil {
+					return fmt.Errorf("error creating APIExportEndpointSlice for APIExport %s|%s: %w", clusterName, apiExport.Name, err)
+				}
+			} else {
+				return fmt.Errorf("error getting APIExportEndpointSlice for APIExport %s|%s: %w", clusterName, apiExport.Name, err)
 			}
-		} else {
-			return fmt.Errorf("error getting APIExportEndpointSlice for APIExport %s|%s: %w", clusterName, apiExport.Name, err)
 		}
 	}
 

sdk/apis/apis/v1alpha2/types_apiexport.go

@@ -26,6 +26,11 @@ import (
 	conditionsv1alpha1 "github.com/kcp-dev/kcp/sdk/apis/third_party/conditions/apis/conditions/v1alpha1"
 )
 
+const (
+	// APIExportEndpointSliceSkipAnnotation is an annotation that can be set on an APIExport to skip the creation of default APIExportEndpointSlice.
+	APIExportEndpointSliceSkipAnnotation = "apiexports.apis.kcp.io/skip-endpointslice"
+)
+
 // These are valid conditions of APIExport.
 const (
 	APIExportIdentityValid conditionsv1alpha1.ConditionType = "IdentityValid"