feat: add labels to managedcluster resource if present and have the ability to pass it through helm chart.

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

Author: ramekris3163

deploy/klusterlet/chart/klusterlet/values.yaml

@@ -127,6 +127,9 @@ klusterlet:
 #     - feature: ""
 #       mode: ""
 #    clientCertExpirationSeconds: 600
+#    clusterLabels:
+#      environment: "production"
+#      region: "us-west-2"
   workConfiguration: {}
 #   featureGates:
 #     - feature: ""

manifests/klusterlet/management/klusterlet-agent-deployment.yaml

@@ -103,6 +103,9 @@ spec:
           {{if .ClusterAnnotationsString}}
           - "--cluster-annotations={{ .ClusterAnnotationsString }}"
           {{end}}
+          {{if .ClusterLabelsString}}
+          - "--cluster-labels={{ .ClusterLabelsString }}"
+          {{end}}
           {{if eq .InstallMode "SingletonHosted"}}
           - "--spoke-kubeconfig=/spoke/config/kubeconfig"
           - "--terminate-on-files=/spoke/config/kubeconfig"

manifests/klusterlet/management/klusterlet-registration-deployment.yaml

@@ -88,6 +88,9 @@ spec:
           {{if .ClusterAnnotationsString}}
           - "--cluster-annotations={{ .ClusterAnnotationsString }}"
           {{end}}
+          {{if .ClusterLabelsString}}
+          - "--cluster-labels={{ .ClusterLabelsString }}"
+          {{end}}
           {{if gt .RegistrationKubeAPIQPS 0.0}}
           - "--kube-api-qps={{ .RegistrationKubeAPIQPS }}"
           {{end}}

pkg/operator/operators/klusterlet/controllers/klusterletcontroller/klusterlet_controller.go

@@ -167,6 +167,7 @@ type klusterletConfig struct {
 	Replica                                     int32
 	ClientCertExpirationSeconds                 int32
 	ClusterAnnotationsString                    string
+	ClusterLabelsString                         string
 	RegistrationKubeAPIQPS                      float32
 	RegistrationKubeAPIBurst                    int32
 	WorkKubeAPIQPS                              float32
@@ -389,6 +390,13 @@ func (n *klusterletController) sync(ctx context.Context, controllerContext facto
 			annotationsArray = append(annotationsArray, fmt.Sprintf("%s=%s", k, v))
 		}
 		config.ClusterAnnotationsString = strings.Join(annotationsArray, ",")
+
+		// construct cluster labels string, the final format is "key1=value1,key2=value2"
+		var labelsArray []string
+		for k, v := range klusterlet.Spec.RegistrationConfiguration.ClusterLabels {
+			labelsArray = append(labelsArray, fmt.Sprintf("%s=%s", k, v))
+		}
+		config.ClusterLabelsString = strings.Join(labelsArray, ",")
 	}
 
 	config.AboutAPIEnabled = helpers.FeatureGateEnabled(

pkg/registration/spoke/options.go

@@ -36,6 +36,7 @@ type SpokeAgentOptions struct {
 	MaxCustomClusterClaims       int
 	ReservedClusterClaimSuffixes []string
 	ClusterAnnotations           map[string]string
+	ClusterLabels                map[string]string
 
 	RegisterDriverOption *registerfactory.Options
 }
@@ -76,6 +77,7 @@ func (o *SpokeAgentOptions) AddFlags(fs *pflag.FlagSet) {
 		"A list of suffixes for reserved cluster claims.")
 	fs.StringToStringVar(&o.ClusterAnnotations, "cluster-annotations", o.ClusterAnnotations, `the annotations with the reserve
 	 prefix "agent.open-cluster-management.io" set on ManagedCluster when creating only, other actors can update it afterwards.`)
+	fs.StringToStringVar(&o.ClusterLabels, "cluster-labels", o.ClusterLabels, `the labels set on ManagedCluster when creating only, other actors can update it afterwards.`)
 
 	o.RegisterDriverOption.AddFlags(fs)
 }

pkg/registration/spoke/registration/creating_controller.go

@@ -89,11 +89,14 @@ func (c *managedClusterCreatingController) sync(ctx context.Context, syncCtx fac
 		managedCluster = decorator(managedCluster)
 	}
 
-	if len(existingCluster.Spec.ManagedClusterClientConfigs) == len(managedCluster.Spec.ManagedClusterClientConfigs) {
+	// Check if any updates are needed (ClientConfigs, Labels, or Annotations)
+	if equalClientConfigs(existingCluster.Spec.ManagedClusterClientConfigs, managedCluster.Spec.ManagedClusterClientConfigs) &&
+		equalLabels(existingCluster.Labels, managedCluster.Labels) &&
+		equalAnnotations(existingCluster.Annotations, managedCluster.Annotations) {
 		return nil
 	}
 
-	// update ManagedClusterClientConfigs in ManagedCluster
+	// update ManagedCluster (ClientConfigs, Labels, and Annotations)
 	_, err = c.hubClusterClient.ClusterV1().ManagedClusters().Update(ctx, managedCluster, metav1.UpdateOptions{})
 	// ManagedClusterClientConfigs in ManagedCluster is only allowed updated during bootstrap.
 	// After bootstrap secret expired, an unauthorized error will be got, skip it
@@ -112,15 +115,33 @@ func skipUnauthorizedError(err error) error {
 	return err
 }
 
+// AnnotationDecorator set annotations from annotation map to ManagedCluster
 func AnnotationDecorator(annotations map[string]string) ManagedClusterDecorator {
 	return func(cluster *clusterv1.ManagedCluster) *clusterv1.ManagedCluster {
-		filteredAnnotations := commonhelpers.FilterClusterAnnotations(annotations)
 		if cluster.Annotations == nil {
 			cluster.Annotations = make(map[string]string)
 		}
-		for key, value := range filteredAnnotations {
-			cluster.Annotations[key] = value
+
+		filteredAnnotations := commonhelpers.FilterClusterAnnotations(annotations)
+		for k, v := range filteredAnnotations {
+			cluster.Annotations[k] = v
 		}
+
+		return cluster
+	}
+}
+
+// LabelDecorator set labels from label map to ManagedCluster
+func LabelDecorator(labels map[string]string) ManagedClusterDecorator {
+	return func(cluster *clusterv1.ManagedCluster) *clusterv1.ManagedCluster {
+		if cluster.Labels == nil {
+			cluster.Labels = make(map[string]string)
+		}
+
+		for k, v := range labels {
+			cluster.Labels[k] = v
+		}
+
 		return cluster
 	}
 }
@@ -148,3 +169,46 @@ func ClientConfigDecorator(externalServerURLs []string, caBundle []byte) Managed
 		return cluster
 	}
 }
+
+// equalClientConfigs compares two ClientConfig slices for equality
+func equalClientConfigs(configs1, configs2 []clusterv1.ClientConfig) bool {
+	if len(configs1) != len(configs2) {
+		return false
+	}
+	for i, config1 := range configs1 {
+		config2 := configs2[i]
+		if config1.URL != config2.URL {
+			return false
+		}
+		if string(config1.CABundle) != string(config2.CABundle) {
+			return false
+		}
+	}
+	return true
+}
+
+// equalLabels compares two label maps for equality
+func equalLabels(labels1, labels2 map[string]string) bool {
+	if len(labels1) != len(labels2) {
+		return false
+	}
+	for k, v := range labels1 {
+		if labels2[k] != v {
+			return false
+		}
+	}
+	return true
+}
+
+// equalAnnotations compares two annotation maps for equality
+func equalAnnotations(annotations1, annotations2 map[string]string) bool {
+	if len(annotations1) != len(annotations2) {
+		return false
+	}
+	for k, v := range annotations1 {
+		if annotations2[k] != v {
+			return false
+		}
+	}
+	return true
+}