Add weighted address strategy for multi-key listeners (#2394)

config/crd/bases/skupper_multikeylistener_crd.yaml

@@ -105,12 +105,36 @@ spec:
                     required:
                     - routingKeys
                     type: object
+                  weighted:
+                    description: |-
+                      WeightedStrategySpec specifies a map of routing keys to route traffic to.
+                      Each routingKey has a weight value.
+
+                      With this strategy traffic is distributed randomly among the reachable
+                      routing keys. The larger the weight of a routing key - relative to the
+                      weights of the other routing keys - the higher the likelihood of
+                      receiving more traffic. E.g. if all routing keys have equal weights then the
+                      traffic is distributed in a random uniform fashion among the reachable
+                      routing keys.
+                    properties:
+                      routingKeys:
+                        additionalProperties:
+                          type: integer
+                        description: routingKeys to route traffic to according to
+                          their weight values
+                        maxProperties: 256
+                        minProperties: 1
+                        type: object
+                        x-kubernetes-map-type: granular
+                    required:
+                    - routingKeys
+                    type: object
                 type: object
                 x-kubernetes-validations:
-                - message: exactly one of the fields in [priority] must be
+                - message: exactly one of the fields in [priority weighted] must be
                     set
-                  rule: '[has(self.priority)].filter(x,x==true).size() ==
-                    1'
+                  rule: '[has(self.priority),has(self.weighted)].filter(x,x==true).size()
+                    == 1'
               tlsCredentials:
                 description: tlsCredentials for client-to-listener
                 type: string
@@ -214,12 +238,27 @@ spec:
                     required:
                     - routingKeysReachable
                     type: object
+                  weighted:
+                    description: weighted status
+                    properties:
+                      routingKeysReachable:
+                        additionalProperties:
+                          type: integer
+                        description: |-
+                          routingKeysReachable is a map of routingKeys with at least one
+                          reachable connector. The value of each routingKey is the weight in
+                          the map.
+                        type: object
+                        x-kubernetes-map-type: granular
+                    required:
+                    - routingKeysReachable
+                    type: object
                 type: object
                 x-kubernetes-validations:
-                - message: exactly one of the fields in [priority] must be
+                - message: exactly one of the fields in [priority weighted] must be
                     set
-                  rule: '[has(self.priority)].filter(x,x==true).size() ==
-                    1'
+                  rule: '[has(self.priority),has(self.weighted)].filter(x,x==true).size()
+                    == 1'
             type: object
         required:
         - spec

config/samples/skupper_v2alpha1_multikeylistener.yaml

@@ -1,12 +1,26 @@
 apiVersion: skupper.io/v2alpha1
 kind: MultiKeyListener
 metadata:
-  name: backend
+  name: backend-priority
 spec:
-  host: backend
+  host: backend-priority
   port: 8080
   strategy:
     priority:
       routingKeys:
         - backend-primary
         - backend-secondary
+
+---
+apiVersion: skupper.io/v2alpha1
+kind: MultiKeyListener
+metadata:
+  name: backend-weighted
+spec:
+  host: backend-weighted
+  port: 8081
+  strategy:
+    weighted:
+      routingKeys:
+        backend-single: 1
+        backend-double: 2

internal/nonkube/common/fs_config_renderer_test.go

@@ -314,6 +314,24 @@ func fakeSiteState() *api.SiteState {
 					},
 				},
 			},
+			"mkl-two": {
+				TypeMeta: metav1.TypeMeta{
+					Kind:       "MultiKeyListener",
+					APIVersion: "skupper.io/v2alpha1",
+				},
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "mkl-two",
+				},
+				Spec: v2alpha1.MultiKeyListenerSpec{
+					Host: "10.0.0.3",
+					Port: 5679,
+					Strategy: v2alpha1.MultiKeyListenerStrategy{
+						Weighted: &v2alpha1.WeightedStrategySpec{
+							RoutingKeys: map[string]uint{"key-primary": 1, "key-secondary": 2},
+						},
+					},
+				},
+			},
 		},
 		ConfigMaps: make(map[string]*corev1.ConfigMap),
 	}

internal/nonkube/common/site_state_validator.go

@@ -198,15 +198,30 @@ func (s *SiteStateValidator) validateMultiKeyListeners(multiKeyListeners map[str
 			return fmt.Errorf("port %d is already mapped for host %q (multikeylistener: %q)", mkl.Spec.Port, mkl.Spec.Host, name)
 		}
 		hostPorts[mkl.Spec.Host] = append(hostPorts[mkl.Spec.Host], mkl.Spec.Port)
-		if mkl.Spec.Strategy.Priority == nil {
-			return fmt.Errorf("invalid multikeylistener: %s - strategy.priority is required", mkl.Name)
+		if mkl.Spec.Strategy.Priority == nil && mkl.Spec.Strategy.Weighted == nil {
+			return fmt.Errorf("invalid multikeylistener: %s - strategy.priority or strategy.weighted is required", mkl.Name)
 		}
-		if len(mkl.Spec.Strategy.Priority.RoutingKeys) == 0 {
-			return fmt.Errorf("invalid multikeylistener: %s - routingKeys must not be empty", mkl.Name)
+		if mkl.Spec.Strategy.Priority != nil {
+			if len(mkl.Spec.Strategy.Priority.RoutingKeys) == 0 {
+				return fmt.Errorf("invalid multikeylistener: %s - routingKeys must not be empty", mkl.Name)
+			}
+			for _, key := range mkl.Spec.Strategy.Priority.RoutingKeys {
+				if key == "" {
+					return fmt.Errorf("invalid multikeylistener: %s - routingKey must not be empty", mkl.Name)
+				}
+			}
 		}
-		for _, key := range mkl.Spec.Strategy.Priority.RoutingKeys {
-			if key == "" {
-				return fmt.Errorf("invalid multikeylistener: %s - routingKey must not be empty", mkl.Name)
+		if mkl.Spec.Strategy.Weighted != nil {
+			if len(mkl.Spec.Strategy.Weighted.RoutingKeys) == 0 {
+				return fmt.Errorf("invalid multikeylistener: %s - routingKeys must not be empty", mkl.Name)
+			}
+			for key, weight := range mkl.Spec.Strategy.Weighted.RoutingKeys {
+				if key == "" {
+					return fmt.Errorf("invalid multikeylistener: %s - routingKey must not be empty", mkl.Name)
+				}
+				if weight <= 0 {
+					return fmt.Errorf("invalid multikeylistener: %s - weight value must not be positive", mkl.Name)
+				}
 			}
 		}
 	}

internal/nonkube/common/site_state_validator_test.go

@@ -268,21 +268,41 @@ func TestSiteStateValidator_Validate(t *testing.T) {
 			siteState: customize(func(siteState *api.SiteState) {
 				for _, mkl := range siteState.MultiKeyListeners {
 					mkl.Spec.Strategy.Priority = nil
+					mkl.Spec.Strategy.Weighted = nil
 				}
 			}),
 			valid:         false,
-			errorContains: "strategy.priority is required",
+			errorContains: "strategy.priority or strategy.weighted is required",
 		},
 		{
 			info: "invalid-multikeylistener-empty-routing-keys",
 			siteState: customize(func(siteState *api.SiteState) {
 				for _, mkl := range siteState.MultiKeyListeners {
-					mkl.Spec.Strategy.Priority.RoutingKeys = []string{}
+					if mkl.Spec.Strategy.Priority != nil {
+						mkl.Spec.Strategy.Priority.RoutingKeys = []string{}
+					}
+					if mkl.Spec.Strategy.Weighted != nil {
+						mkl.Spec.Strategy.Weighted.RoutingKeys = map[string]uint{}
+					}
 				}
 			}),
 			valid:         false,
 			errorContains: "routingKeys must not be empty",
 		},
+		{
+			info: "invalid-multikeylistener-zero-weight",
+			siteState: customize(func(siteState *api.SiteState) {
+				for _, mkl := range siteState.MultiKeyListeners {
+					if mkl.Spec.Strategy.Weighted != nil {
+						for key := range mkl.Spec.Strategy.Weighted.RoutingKeys {
+							mkl.Spec.Strategy.Weighted.RoutingKeys[key] = 0
+						}
+					}
+				}
+			}),
+			valid:         false,
+			errorContains: "weight value must not be positive",
+		},
 		{
 			info: "invalid-multikeylistener-port-conflict-with-listener",
 			siteState: customize(func(siteState *api.SiteState) {

internal/site/bindings.go

@@ -196,6 +196,19 @@ func (b *Bindings) updateMultiKeyListener(mkl *skupperv2alpha1.MultiKeyListener)
 	if ok && reflect.DeepEqual(existing.Spec, mkl.Spec) {
 		return nil
 	}
+
+	if mkl.Spec.Strategy.Weighted != nil && mkl.Status.Strategy != nil && mkl.Status.Strategy.Weighted != nil {
+		// update weight values in status if they changed in the spec
+		for k, w := range mkl.Status.Strategy.Weighted.RoutingKeysReachable {
+			if ws, ok := mkl.Spec.Strategy.Weighted.RoutingKeys[k]; ok {
+				if w != ws {
+					mkl.Status.Strategy.Weighted.RoutingKeysReachable[k] = ws
+				}
+			} else {
+				delete(mkl.Status.Strategy.Weighted.RoutingKeysReachable, k)
+			}
+		}
+	}
 	return b
 }
 

internal/site/multikeylistener.go

@@ -30,19 +30,18 @@ func UpdateBridgeConfigForMultiKeyListener(siteId string, mkl *skupperv2alpha1.M
 func UpdateBridgeConfigForMultiKeyListenerWithHostAndPort(siteId string, mkl *skupperv2alpha1.MultiKeyListener, host string, port int, config *qdr.BridgeConfig) {
 	name := mkl.Name
 	tcpListenerName := multiAddressTcpListenerName(name)
-
-	config.AddTcpListener(qdr.TcpEndpoint{
-		Name:                 tcpListenerName,
-		SiteId:               siteId,
-		Host:                 host,
-		Port:                 strconv.Itoa(port),
-		SslProfile:           mkl.Spec.TlsCredentials,
-		MultiAddressStrategy: "priority",
-		AuthenticatePeer:     mkl.Spec.RequireClientCert,
-	})
+	tcpListenerConfig := qdr.TcpEndpoint{
+		Name:             tcpListenerName,
+		SiteId:           siteId,
+		Host:             host,
+		Port:             strconv.Itoa(port),
+		SslProfile:       mkl.Spec.TlsCredentials,
+		AuthenticatePeer: mkl.Spec.RequireClientCert,
+	}
 
 	// Create listenerAddress entities for each routing key in the strategy
 	if mkl.Spec.Strategy.Priority != nil {
+		tcpListenerConfig.MultiAddressStrategy = "priority"
 		numKeys := len(mkl.Spec.Strategy.Priority.RoutingKeys)
 		for i, routingKey := range mkl.Spec.Strategy.Priority.RoutingKeys {
 			laName := listenerAddressName(name, routingKey)
@@ -53,7 +52,19 @@ func UpdateBridgeConfigForMultiKeyListenerWithHostAndPort(siteId string, mkl *sk
 				Listener: tcpListenerName,
 			})
 		}
+	} else if mkl.Spec.Strategy.Weighted != nil {
+		tcpListenerConfig.MultiAddressStrategy = "weighted"
+		for routingKey, weight := range mkl.Spec.Strategy.Weighted.RoutingKeys {
+			laName := listenerAddressName(name, routingKey)
+			config.AddListenerAddress(qdr.ListenerAddress{
+				Name:     laName,
+				Address:  routingKey,
+				Value:    int(weight),
+				Listener: tcpListenerName,
+			})
+		}
 	}
+	config.AddTcpListener(tcpListenerConfig)
 }
 
 // RemoveBridgeConfigForMultiKeyListener removes the tcpListener and listenerAddress