Merge pull request #1076 from gianlucam76/auo-deploy-dependencies

Auto deploy dependencies: enable automatic deployment of prerequisites

Author: gianlucam76

api/v1beta1/status.go

@@ -37,4 +37,8 @@ type Status struct {
 	// Spec
 	// +optional
 	UpdatedClusters Clusters `json:"updatedClusters,omitempty"`
+
+	// DependenciesHash is a hash representing the set of clusters where this ClusterProfile
+	// must be deployed, based on the combined configuration of its dependencies.
+	DependenciesHash []byte `json:"dependenciesHash,omitempty"`
 }

api/v1beta1/zz_generated.deepcopy.go

@@ -59,6 +59,7 @@ import (
 	configv1beta1 "github.com/projectsveltos/addon-controller/api/v1beta1"
 	"github.com/projectsveltos/addon-controller/api/v1beta1/index"
 	"github.com/projectsveltos/addon-controller/controllers"
+	"github.com/projectsveltos/addon-controller/controllers/dependencymanager"
 	"github.com/projectsveltos/addon-controller/internal/telemetry"
 	libsveltosv1beta1 "github.com/projectsveltos/libsveltos/api/v1beta1"
 	"github.com/projectsveltos/libsveltos/lib/crd"
@@ -91,6 +92,7 @@ var (
 	capiOnboardAnnotation   string
 	disableCaching          bool
 	disableTelemetry        bool
+	autoDeployDependencies  bool
 )
 
 const (
@@ -177,6 +179,8 @@ func main() {
 	controllers.SetDriftdetectionConfigMap(driftDetectionConfigMap)
 	controllers.SetLuaConfigMap(luaConfigMap)
 	controllers.SetCAPIOnboardAnnotation(capiOnboardAnnotation)
+	// Start dependency manager
+	dependencymanager.InitializeManagerInstance(ctx, mgr.GetClient(), autoDeployDependencies, ctrl.Log.WithName("dependency_manager"))
 
 	logsettings.RegisterForLogSettings(ctx,
 		libsveltosv1beta1.ComponentAddonManager, ctrl.Log.WithName("log-setter"),
@@ -277,6 +281,27 @@ func initFlags(fs *pflag.FlagSet) {
 	fs.DurationVar(&conflictRetryTime, "conflict-retry-time", defaultConflictRetryTime*time.Second,
 		fmt.Sprintf("The minimum interval at which watched ClusterProfile with conflicts are retried. Defaul: %d seconds",
 			defaultConflictRetryTime))
+
+	// AutoDeployDependencies enables automatic deployment of prerequisite profiles.
+	//
+	// Profile instances can specify dependencies on other profiles using the
+	// DependsOn field, forming a directed acyclic graph (DAG) of dependencies.
+	//
+	// When AutoDeployDependencies is set to true, Sveltos automatically resolves and deploys
+	// the prerequisite profiles listed in the DependsOn field. This automation
+	// ensures that all required dependencies are deployed to the same managed clusters
+	// as the dependent profile. Sveltos analyzes the dependency graph to identify
+	// and deploy prerequisites in the correct order.
+	//
+	// By default, AutoDeployDependencies is enabled (true). When disabled, administrators
+	// are responsible for ensuring that both the dependent and prerequisite profiles
+	// target the same set of managed clusters through matching cluster selectors.
+	//
+	// Enabling AutoDeployDependencies simplifies multi-cluster management by automating
+	// dependency resolution, reducing manual effort, and minimizing the risk of
+	// configuration inconsistencies.
+	fs.BoolVar(&autoDeployDependencies, "auto-deploy-dependencies", true,
+		" When AutoDeployDependencies is set to true, Sveltos will automatically resolve and deploy the prerequisite profiles specified in the DependsOn field")
 }
 
 func setupIndexes(ctx context.Context, mgr ctrl.Manager) {

cmd/main.go

@@ -1058,6 +1058,12 @@ spec:
           status:
             description: Status defines the observed state of ClusterProfile/Profile
             properties:
+              dependenciesHash:
+                description: |-
+                  DependenciesHash is a hash representing the set of clusters where this ClusterProfile
+                  must be deployed, based on the combined configuration of its dependencies.
+                format: byte
+                type: string
               matchingClusters:
                 description: |-
                   MatchingClusterRefs reference all the clusters currently matching

config/crd/bases/config.projectsveltos.io_clusterprofiles.yaml

@@ -1058,6 +1058,12 @@ spec:
           status:
             description: Status defines the observed state of ClusterProfile/Profile
             properties:
+              dependenciesHash:
+                description: |-
+                  DependenciesHash is a hash representing the set of clusters where this ClusterProfile
+                  must be deployed, based on the combined configuration of its dependencies.
+                format: byte
+                type: string
               matchingClusters:
                 description: |-
                   MatchingClusterRefs reference all the clusters currently matching

config/crd/bases/config.projectsveltos.io_profiles.yaml

@@ -38,6 +38,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/source"
 
 	configv1beta1 "github.com/projectsveltos/addon-controller/api/v1beta1"
+	"github.com/projectsveltos/addon-controller/controllers/dependencymanager"
 	"github.com/projectsveltos/addon-controller/pkg/scope"
 	libsveltosv1beta1 "github.com/projectsveltos/libsveltos/api/v1beta1"
 	logs "github.com/projectsveltos/libsveltos/lib/logsettings"
@@ -172,6 +173,15 @@ func (r *ClusterProfileReconciler) reconcileNormal(
 	}
 	matchingCluster = append(matchingCluster, clusterSetClusters...)
 
+	// Get all clusters where deployment is required based on dependent ClusterProfile instances
+	depManager, err := dependencymanager.GetManagerInstance()
+	if err != nil {
+		return reconcile.Result{Requeue: true, RequeueAfter: normalRequeueAfter}
+	}
+	profileRef := getKeyFromObject(r.Scheme, profileScope.Profile)
+	depClusters := depManager.GetClusterDeployments(profileRef)
+	matchingCluster = append(matchingCluster, depClusters...)
+
 	profileScope.SetMatchingClusterRefs(removeDuplicates(matchingCluster))
 
 	r.updateMaps(profileScope)

controllers/clusterprofile_controller.go

@@ -1,34 +0,0 @@
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: my-depl
-  namespace: foo
-  labels:
-    app: my-app
-spec:
-  replicas: 3
-  selector:
-    matchLabels:
-      app: my-app
-  template:
-    metadata:
-      labels:
-        app: my-app
-    spec:
-      containers:
-      - name: my-container
-        image: hello-world
----
-apiVersion: autoscaling/v1
-kind: HorizontalPodAutoscaler
-metadata:
-  name: my-autoscaler
-  namespace: foo
-spec:
-  scaleTargetRef:
-    apiVersion: apps/v1
-    kind: Deployment
-    name: not-my-depl
-  minReplicas: 1
-  maxReplicas: 5
-  targetCPUUtilizationPercentage: 80

controllers/compliance_policies/lua_policies/deplyoment_with_autoscaler/invalid_resources.yaml

@@ -1,44 +0,0 @@
-# This Lua policies validate that in namespace "foo"
-# each deployment has an associated HorizontalPodAutoscaler
-
-function evaluate()
-    local hs = {}
-    hs.valid = true
-    hs.message = ""
-
-    local deployments = {}
-    local autoscalers = {}
-
-    -- Separate deployments and services from the resources
-    for _, resource in ipairs(resources) do
-        local kind = resource.kind
-        if resource.metadata.namespace == "foo" then
-            if kind == "Deployment" then
-                table.insert(deployments, resource)
-            elseif kind == "HorizontalPodAutoscaler" then
-                table.insert(autoscalers, resource)
-            end
-        end
-    end
-
-    -- Check for each deployment if there is a matching HorizontalPodAutoscaler
-    for _, deployment in ipairs(deployments) do
-        local deploymentName = deployment.metadata.name
-        local matchingAutoscaler = false
-
-        for _, autoscaler in ipairs(autoscalers) do
-            if autoscaler.spec.scaleTargetRef.name == deployment.metadata.name then
-                matchingAutoscaler = true
-                break
-            end
-        end
-
-        if not matchingAutoscaler then
-            hs.valid = false
-            hs.message = "No matching autoscaler found for deployment: " .. deploymentName
-            break
-        end
-    end
-
-    return hs
-end

controllers/compliance_policies/lua_policies/deplyoment_with_autoscaler/lua_policy.lua

@@ -1,34 +0,0 @@
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: my-depl
-  namespace: foo
-  labels:
-    app: my-app
-spec:
-  replicas: 3
-  selector:
-    matchLabels:
-      app: my-app
-  template:
-    metadata:
-      labels:
-        app: my-app
-    spec:
-      containers:
-      - name: my-container
-        image: hello-world
----
-apiVersion: autoscaling/v1
-kind: HorizontalPodAutoscaler
-metadata:
-  name: my-autoscaler
-  namespace: foo
-spec:
-  scaleTargetRef:
-    apiVersion: apps/v1
-    kind: Deployment
-    name: my-depl
-  minReplicas: 1
-  maxReplicas: 5
-  targetCPUUtilizationPercentage: 80

controllers/compliance_policies/lua_policies/deplyoment_with_autoscaler/valid_resources.yaml

@@ -38,6 +38,7 @@ import (
 
 	"github.com/projectsveltos/addon-controller/api/v1beta1/index"
 	"github.com/projectsveltos/addon-controller/controllers"
+	"github.com/projectsveltos/addon-controller/controllers/dependencymanager"
 	"github.com/projectsveltos/addon-controller/internal/test/helpers"
 	libsveltosv1beta1 "github.com/projectsveltos/libsveltos/api/v1beta1"
 	"github.com/projectsveltos/libsveltos/lib/clusterproxy"
@@ -150,6 +151,8 @@ var _ = BeforeSuite(func() {
 	_, err = clusterproxy.GetListOfClusters(context.TODO(), testEnv.Client, "", "",
 		textlogger.NewLogger(textlogger.NewConfig()))
 	Expect(err).To(BeNil())
+
+	dependencymanager.InitializeManagerInstance(context.TODO(), testEnv.Client, false, ctrl.Log.WithName("controller_test_suite"))
 })
 
 var _ = AfterSuite(func() {