Merge pull request #652 from chifu1234/kkl-dev

feat: add subressource patch

Author: gianlucam76

controllers/handlers_helm.go

@@ -2096,7 +2096,7 @@ func addExtraMetadata(ctx context.Context, requestedChart *configv1beta1.HelmCha
 		addExtraLabels(r, clusterSummary.Spec.ClusterProfileSpec.ExtraLabels)
 		addExtraAnnotations(r, clusterSummary.Spec.ClusterProfileSpec.ExtraAnnotations)
 
-		err = updateResource(ctx, dr, clusterSummary, r, logger)
+		err = updateResource(ctx, dr, clusterSummary, r, []string{}, logger)
 		if err != nil {
 			logger.V(logs.LogInfo).Info(fmt.Sprintf("failed to update resource %s %s/%s: %v",
 				r.GetKind(), r.GetNamespace(), r.GetName(), err))

controllers/handlers_kustomize.go

@@ -707,7 +707,7 @@ func deployKustomizeResources(ctx context.Context, c client.Client, remoteRestCo
 		Name:      kustomizationRef.Name,
 	}
 	localReports, err = deployUnstructured(ctx, true, localConfig, c, objectsToDeployLocally,
-		ref, configv1beta1.FeatureKustomize, clusterSummary, mgmtResources, logger)
+		ref, configv1beta1.FeatureKustomize, clusterSummary, mgmtResources, []string{}, logger)
 	if err != nil {
 		logger.V(logs.LogInfo).Info(fmt.Sprintf("failed to deploy to management cluster %v", err))
 		return localReports, nil, err
@@ -719,7 +719,7 @@ func deployKustomizeResources(ctx context.Context, c client.Client, remoteRestCo
 	}
 
 	remoteReports, err = deployUnstructured(ctx, false, remoteRestConfig, remoteClient, objectsToDeployRemotely,
-		ref, configv1beta1.FeatureKustomize, clusterSummary, mgmtResources, logger)
+		ref, configv1beta1.FeatureKustomize, clusterSummary, mgmtResources, []string{}, logger)
 	if err != nil {
 		logger.V(logs.LogInfo).Info(fmt.Sprintf("failed to deploy to remote cluster %v", err))
 		return localReports, remoteReports, err

controllers/handlers_utils.go

@@ -64,6 +64,7 @@ const (
 	separator                = "---\n"
 	reasonLabel              = "projectsveltos.io/reason"
 	clusterSummaryAnnotation = "projectsveltos.io/clustersummary"
+	subresourcesAnnotation   = "projectsveltos.io/subresources"
 	pathAnnotation           = "path"
 )
 
@@ -202,18 +203,34 @@ func readFiles(dir string) (map[string]string, error) {
 // updateResource creates or updates a resource in a CAPI Cluster.
 // No action in DryRun mode.
 func updateResource(ctx context.Context, dr dynamic.ResourceInterface,
-	clusterSummary *configv1beta1.ClusterSummary, object *unstructured.Unstructured,
+	clusterSummary *configv1beta1.ClusterSummary, object *unstructured.Unstructured, subresources []string,
 	logger logr.Logger) error {
 
 	// No-op in DryRun mode
 	if clusterSummary.Spec.ClusterProfileSpec.SyncMode == configv1beta1.SyncModeDryRun {
 		return nil
 	}
 
-	l := logger.WithValues("resourceNamespace", object.GetNamespace(),
-		"resourceName", object.GetName(), "resourceGVK", object.GetObjectKind().GroupVersionKind())
+	l := logger.WithValues("resourceNamespace", object.GetNamespace(), "resourceName", object.GetName(),
+		"resourceGVK", object.GetObjectKind().GroupVersionKind(), "subresources", subresources)
 	l.V(logs.LogDebug).Info("deploying policy")
 
+	if len(subresources) > 0 {
+		// Patch without subresources. This will make sure metadata and spec are eventually updated
+		err := patchRessource(ctx, dr, object, nil)
+		if err != nil {
+			return err
+		}
+	}
+	// Reset resource version in case of subresources a patch has already been made
+	// and that alters the resourceVersion
+	object.SetResourceVersion("")
+	return patchRessource(ctx, dr, object, subresources)
+}
+
+func patchRessource(ctx context.Context, dr dynamic.ResourceInterface,
+	object *unstructured.Unstructured, subresources []string) error {
+
 	data, err := runtime.Encode(unstructured.UnstructuredJSONScheme, object)
 	if err != nil {
 		return err
@@ -224,7 +241,7 @@ func updateResource(ctx context.Context, dr dynamic.ResourceInterface,
 		FieldManager: "application/apply-patch",
 		Force:        &forceConflict,
 	}
-	_, err = dr.Patch(ctx, object.GetName(), types.ApplyPatchType, data, options)
+	_, err = dr.Patch(ctx, object.GetName(), types.ApplyPatchType, data, options, subresources...)
 	return err
 }
 
@@ -241,6 +258,18 @@ func instantiateTemplate(referencedObject client.Object, logger logr.Logger) boo
 	return false
 }
 
+func getSubresources(referencedObject client.Object) []string {
+	annotations := referencedObject.GetAnnotations()
+	if annotations != nil {
+		value, exists := annotations[subresourcesAnnotation]
+		if exists {
+			subresources := strings.Split(value, ",")
+			return subresources
+		}
+	}
+	return nil
+}
+
 // deployContent deploys policies contained in a ConfigMap/Secret.
 // data might have one or more keys. Each key might contain a single policy
 // or multiple policies separated by '---'
@@ -252,6 +281,7 @@ func deployContent(ctx context.Context, deployingToMgmtCluster bool, destConfig
 	mgmtResources map[string]*unstructured.Unstructured, logger logr.Logger,
 ) (reports []configv1beta1.ResourceReport, err error) {
 
+	subresources := getSubresources(referencedObject)
 	instantiateTemplate := instantiateTemplate(referencedObject, logger)
 	resources, err := collectContent(ctx, clusterSummary, mgmtResources, data, instantiateTemplate, logger)
 	if err != nil {
@@ -265,7 +295,7 @@ func deployContent(ctx context.Context, deployingToMgmtCluster bool, destConfig
 	}
 
 	return deployUnstructured(ctx, deployingToMgmtCluster, destConfig, destClient, resources, ref,
-		configv1beta1.FeatureResources, clusterSummary, mgmtResources, logger)
+		configv1beta1.FeatureResources, clusterSummary, mgmtResources, subresources, logger)
 }
 
 // adjustNamespace fixes namespace.
@@ -298,8 +328,8 @@ func adjustNamespace(policy *unstructured.Unstructured, destConfig *rest.Config)
 //nolint:funlen // requires a lot of arguments because kustomize and plain resources are using this function
 func deployUnstructured(ctx context.Context, deployingToMgmtCluster bool, destConfig *rest.Config,
 	destClient client.Client, referencedUnstructured []*unstructured.Unstructured, referencedObject *corev1.ObjectReference,
-	featureID configv1beta1.FeatureID, clusterSummary *configv1beta1.ClusterSummary, mgmtResources map[string]*unstructured.Unstructured, logger logr.Logger,
-) (reports []configv1beta1.ResourceReport, err error) {
+	featureID configv1beta1.FeatureID, clusterSummary *configv1beta1.ClusterSummary, mgmtResources map[string]*unstructured.Unstructured,
+	subresources []string, logger logr.Logger) (reports []configv1beta1.ResourceReport, err error) {
 
 	profile, profileTier, err := configv1beta1.GetProfileOwnerAndTier(ctx, getManagementClusterClient(), clusterSummary)
 	if err != nil {
@@ -343,9 +373,6 @@ func deployUnstructured(ctx context.Context, deployingToMgmtCluster bool, destCo
 			return nil, err
 		}
 
-		// If policy already exists, just get current version and update it by overridding
-		// all metadata and spec.
-		// If policy does not exist already, create it
 		dr, err := utils.GetDynamicResourceInterface(destConfig, policy.GroupVersionKind(), policy.GetNamespace())
 		if err != nil {
 			return nil, err
@@ -393,7 +420,7 @@ func deployUnstructured(ctx context.Context, deployingToMgmtCluster bool, destCo
 			}
 		}
 
-		err = updateResource(ctx, dr, clusterSummary, policy, logger)
+		err = updateResource(ctx, dr, clusterSummary, policy, subresources, logger)
 		if err != nil {
 			return reports, err
 		}

controllers/handlers_utils_test.go

@@ -33,6 +33,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/apimachinery/pkg/util/intstr"
 	"k8s.io/client-go/util/retry"
 	"k8s.io/klog/v2/textlogger"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
@@ -1317,6 +1318,71 @@ stringData:
 		Expect(err).To(BeNil())
 		Expect(len(u)).To(Equal(3))
 	})
+
+	It("patchRessource with subresources correctly update instance", func() {
+		serviceName := randomString()
+		key := randomString()
+		value := randomString()
+		servicePatch := `apiVersion: v1
+kind: Service
+metadata:
+  name: %s
+  namespace: default
+  labels:
+    %s: %s
+spec:
+  selector:
+    %s: %s
+status:
+  loadBalancer:
+    ingress:
+    - ip: 1.1.1.1`
+
+		service := &corev1.Service{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      serviceName,
+				Namespace: "default",
+			},
+			Spec: corev1.ServiceSpec{
+				Type: corev1.ServiceTypeLoadBalancer,
+				Selector: map[string]string{
+					"app.kubernetes.io/name": "service0",
+				},
+				Ports: []corev1.ServicePort{
+					{
+						Protocol:   "TCP",
+						Port:       80,
+						TargetPort: intstr.FromInt(1234),
+					},
+				},
+			},
+		}
+
+		Expect(testEnv.Client.Create(context.TODO(), service)).To(Succeed())
+		Expect(waitForObject(ctx, testEnv.Client, service)).To(Succeed())
+		Expect(addTypeInformationToObject(testEnv.Scheme(), clusterSummary)).To(Succeed())
+
+		configMap := createConfigMapWithPolicy(namespace, randomString(), fmt.Sprintf(servicePatch,
+			serviceName, key, value, key, value))
+		configMap.Annotations = map[string]string{
+			"projectsveltos.io/subresources": "status"}
+		_, err := controllers.DeployContentOfConfigMap(context.TODO(), false, testEnv.Config, testEnv.Client,
+			configMap, clusterSummary, nil, textlogger.NewLogger(textlogger.NewConfig()))
+		Expect(err).To(BeNil())
+
+		serviceOut := corev1.Service{}
+		Expect(testEnv.Client.Get(context.TODO(),
+			types.NamespacedName{Namespace: "default", Name: serviceName}, &serviceOut)).To(Succeed())
+
+		// verify status has been updated
+		Expect(serviceOut.Status.LoadBalancer.Ingress[0].IP).To(Equal("1.1.1.1"))
+		// verify metadata has been updated
+		Expect(serviceOut.Labels).To(Not(BeNil()))
+		Expect(serviceOut.Labels[key]).To(Equal(value))
+		// verify spec has been updated
+		Expect(serviceOut.Spec.Selector).To(Not(BeNil()))
+		Expect(serviceOut.Spec.Selector[key]).To(Equal(value))
+	})
 })
 
 // validateResourceReports validates that number of resourceResources with certain actions