feat: support dry run

Signed-off-by: shentiecheng <[email protected]>

pkg/controllers/common/constants.go

@@ -121,6 +121,9 @@ const (
 	MigrationConfigurationAnnotation = DefaultPrefix + "migration-configuration"
 	// AppliedMigrationConfigurationAnnotation contains the applied custom migration configuration.
 	AppliedMigrationConfigurationAnnotation = DefaultPrefix + "applied-migration-configuration"
+	// DryRunAnnotation indicates resource is in dry run process. It will prevent new resources from being dispatched by the sync controller.
+	// It works only when resources have not been propagated to member clusters.
+	DryRunAnnotation = DefaultPrefix + "dry-run"
 )
 
 // PropagatedAnnotationKeys and PropagatedLabelKeys are used to store the keys of annotations and labels that are present

pkg/controllers/federate/util.go

@@ -266,12 +266,14 @@ var (
 		common.FollowersAnnotation,
 		common.DisableFollowingAnnotation,
 		common.MigrationConfigurationAnnotation,
+		common.DryRunAnnotation,
 	)
 
 	// List of annotations that should be ignored on the source object
 	ignoredAnnotationSet = sets.New(
 		common.LatestReplicasetDigestsAnnotation,
 		common.AppliedMigrationConfigurationAnnotation,
+		scheduler.SchedulingAnnotation,
 	)
 
 	federatedLabelSet = sets.New[string](

pkg/controllers/scheduler/scheduler.go

@@ -770,6 +770,15 @@ func (s *Scheduler) applySchedulingResult(
 		}
 	}
 
+	if objectModified {
+		value, err := getSchedulingAnnotationValue(fedObject, result)
+		if err != nil {
+			return false, err
+		}
+		annotations[SchedulingAnnotation] = value
+		annotationsModified = true
+	}
+
 	if annotationsModified {
 		fedObject.SetAnnotations(annotations)
 		objectModified = true

pkg/controllers/scheduler/schedulingannotation.go

@@ -0,0 +1,66 @@
+/*
+Copyright 2023 The KubeAdmiral Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package scheduler
+
+import (
+	"encoding/json"
+
+	"k8s.io/klog/v2"
+
+	fedcorev1a1 "github.com/kubewharf/kubeadmiral/pkg/apis/core/v1alpha1"
+	"github.com/kubewharf/kubeadmiral/pkg/controllers/common"
+	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/core"
+)
+
+var SchedulingAnnotation = common.DefaultPrefix + "scheduling"
+
+type Scheduling struct {
+	// SourceGeneration is the generation of the source object
+	// observed in the federated object when this placement is sampled.
+	SourceGeneration int64 `json:"sourceGeneration"`
+
+	// FederatedGeneration is the generation of the federated object
+	// observed when this placement is sampled.
+	FederatedGeneration int64 `json:"fedGeneration"`
+
+	// Placement contains a list of FederatedCluster object names and replicas on them.
+	Placement map[string]*int64 `json:"placement,omitempty"`
+}
+
+func getSchedulingAnnotationValue(
+	fedObject fedcorev1a1.GenericFederatedObject,
+	result core.ScheduleResult,
+) (value string, err error) {
+	scheduling := Scheduling{}
+
+	srcMeta, err := fedObject.GetSpec().GetTemplateMetadata()
+	if err != nil {
+		return "", err
+	}
+
+	scheduling.SourceGeneration = srcMeta.GetGeneration()
+	scheduling.FederatedGeneration = fedObject.GetGeneration()
+	scheduling.Placement = result.SuggestedClusters
+
+	jsonBuf, err := json.Marshal(scheduling)
+	if err != nil {
+		klog.Errorf("Cannot marshal JSON: %v", err)
+		return "", err
+	}
+
+	return string(jsonBuf), nil
+}

pkg/controllers/scheduler/schedulingtriggers.go

@@ -304,6 +304,7 @@ var knownSchedulingAnnotations = sets.New(
 	MaxClustersAnnotations,
 	FollowsObjectAnnotation,
 	common.AppliedMigrationConfigurationAnnotation,
+	common.DryRunAnnotation,
 )
 
 func getSchedulingAnnotationsHash(fedObject fedcorev1a1.GenericFederatedObject) (string, error) {

pkg/controllers/statusaggregator/controller.go

@@ -40,6 +40,7 @@ import (
 	fedcorev1a1informers "github.com/kubewharf/kubeadmiral/pkg/client/informers/externalversions/core/v1alpha1"
 	"github.com/kubewharf/kubeadmiral/pkg/controllers/federate"
 	"github.com/kubewharf/kubeadmiral/pkg/controllers/statusaggregator/plugins"
+	"github.com/kubewharf/kubeadmiral/pkg/controllers/statusaggregator/plugins/sourcefeedback"
 	"github.com/kubewharf/kubeadmiral/pkg/stats"
 	"github.com/kubewharf/kubeadmiral/pkg/stats/metrics"
 	clusterutil "github.com/kubewharf/kubeadmiral/pkg/util/cluster"
@@ -342,16 +343,7 @@ func (a *StatusAggregator) reconcile(ctx context.Context, key reconcileKey) (sta
 		return worker.StatusError
 	}
 
-	needUpdate := false
-	for _, plugin := range plugins.DefaultCommonPlugins {
-		newObj, newNeedUpdate, err := plugin.AggregateStatuses(ctx, sourceObject, fedObject, clusterObjs, clusterObjsUpToDate)
-		if err != nil {
-			return worker.StatusError
-		}
-		sourceObject = newObj
-		needUpdate = needUpdate || newNeedUpdate
-	}
-
+	needUpdate := sourcefeedback.PopulateAnnotations(sourceObject, fedObject)
 	if needUpdate {
 		logger.V(1).Info("Updating metadata of source object")
 		_, err = a.dynamicClient.Resource(ftc.GetSourceTypeGVR()).Namespace(key.namespace).

pkg/controllers/statusaggregator/plugins/plugin.go

@@ -27,7 +27,6 @@ import (
 
 	fedcorev1a1 "github.com/kubewharf/kubeadmiral/pkg/apis/core/v1alpha1"
 	"github.com/kubewharf/kubeadmiral/pkg/controllers/common"
-	plugincommon "github.com/kubewharf/kubeadmiral/pkg/controllers/statusaggregator/plugins/common"
 )
 
 type Plugin interface {
@@ -48,10 +47,6 @@ var pluginsMap = map[schema.GroupVersionKind]Plugin{
 	corev1.SchemeGroupVersion.WithKind(common.PodKind):         NewPodPlugin(),
 }
 
-var DefaultCommonPlugins = []Plugin{
-	plugincommon.NewMigrationConfigPlugin(),
-}
-
 func GetPlugin(gvk schema.GroupVersionKind) Plugin {
 	return pluginsMap[gvk]
 }