fix(kuma-cp): change affinityTag field in MeshLoadBalancingStrategy t…

…o optional Signed-off-by: Marcin Skalski <[email protected]>
kumahq · Nov 8, 2023 · 0ba1eb9 · 0ba1eb9
1 parent a9a165b
commit 0ba1eb9
Show file tree

Hide file tree

Showing 17 changed files with 20 additions and 37 deletions.
diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.defaults.golden.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.defaults.golden.yaml
@@ -2151,8 +2151,6 @@ spec:
                                     - key
                                     type: object
                                   type: array
-                              required:
-                              - affinityTags
                               type: object
                           type: object
                       type: object

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present-not-enabled.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present-not-enabled.yaml
@@ -2151,8 +2151,6 @@ spec:
                                     - key
                                     type: object
                                   type: array
-                              required:
-                              - affinityTags
                               type: object
                           type: object
                       type: object

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.gateway-api-present.yaml
@@ -2355,8 +2355,6 @@ spec:
                                     - key
                                     type: object
                                   type: array
-                              required:
-                              - affinityTags
                               type: object
                           type: object
                       type: object

diff --git a/app/kumactl/cmd/install/testdata/install-control-plane.with-helm-set.yaml b/app/kumactl/cmd/install/testdata/install-control-plane.with-helm-set.yaml
@@ -2171,8 +2171,6 @@ spec:
                                     - key
                                     type: object
                                   type: array
-                              required:
-                              - affinityTags
                               type: object
                           type: object
                       type: object

diff --git a/app/kumactl/cmd/install/testdata/install-crds.all.golden.yaml b/app/kumactl/cmd/install/testdata/install-crds.all.golden.yaml
@@ -3456,8 +3456,6 @@ spec:
                                     - key
                                     type: object
                                   type: array
-                              required:
-                              - affinityTags
                               type: object
                           type: object
                       type: object

diff --git a/app/kumactl/cmd/install/testdata/install-crds.experimental-gatewayapi.golden.yaml b/app/kumactl/cmd/install/testdata/install-crds.experimental-gatewayapi.golden.yaml
@@ -3660,8 +3660,6 @@ spec:
                                     - key
                                     type: object
                                   type: array
-                              required:
-                              - affinityTags
                               type: object
                           type: object
                       type: object

diff --git a/deployments/charts/kuma/crds/kuma.io_meshloadbalancingstrategies.yaml b/deployments/charts/kuma/crds/kuma.io_meshloadbalancingstrategies.yaml
@@ -479,8 +479,6 @@ spec:
                                     - key
                                     type: object
                                   type: array
-                              required:
-                              - affinityTags
                               type: object
                           type: object
                       type: object

diff --git a/docs/generated/openapi.yaml b/docs/generated/openapi.yaml
@@ -4126,8 +4126,6 @@ components:
                                     - key
                                   type: object
                                 type: array
-                            required:
-                              - affinityTags
                             type: object
                         type: object
                     type: object

diff --git a/docs/generated/raw/crds/kuma.io_meshloadbalancingstrategies.yaml b/docs/generated/raw/crds/kuma.io_meshloadbalancingstrategies.yaml
@@ -479,8 +479,6 @@ spec:
                                     - key
                                     type: object
                                   type: array
-                              required:
-                              - affinityTags
                               type: object
                           type: object
                       type: object

diff --git a/pkg/plugins/policies/meshloadbalancingstrategy/api/v1alpha1/meshloadbalancingstrategy.go b/pkg/plugins/policies/meshloadbalancingstrategy/api/v1alpha1/meshloadbalancingstrategy.go
@@ -48,7 +48,7 @@ type LocalityAwareness struct {
 
 type LocalZone struct {
 	// AffinityTags list of tags for local zone load balancing.
-	AffinityTags []AffinityTag `json:"affinityTags"`
+	AffinityTags *[]AffinityTag `json:"affinityTags,omitempty"`
 }
 
 type AffinityTag struct {

diff --git a/pkg/plugins/policies/meshloadbalancingstrategy/api/v1alpha1/schema.yaml b/pkg/plugins/policies/meshloadbalancingstrategy/api/v1alpha1/schema.yaml
@@ -317,8 +317,6 @@ properties:
                               - key
                             type: object
                           type: array
-                      required:
-                        - affinityTags
                       type: object
                   type: object
               type: object

diff --git a/pkg/plugins/policies/meshloadbalancingstrategy/api/v1alpha1/validator.go b/pkg/plugins/policies/meshloadbalancingstrategy/api/v1alpha1/validator.go
@@ -7,6 +7,7 @@ import (
 	common_api "github.com/kumahq/kuma/api/common/v1alpha1"
 	"github.com/kumahq/kuma/pkg/core/resources/apis/mesh"
 	"github.com/kumahq/kuma/pkg/core/validators"
+	"github.com/kumahq/kuma/pkg/util/pointer"
 )
 
 func (r *MeshLoadBalancingStrategyResource) validate() error {
@@ -71,7 +72,7 @@ func validateLocalZone(localZone *LocalZone) validators.ValidationError {
 	}
 
 	var weightSpecified int
-	for idx, affinityTag := range localZone.AffinityTags {
+	for idx, affinityTag := range pointer.Deref(localZone.AffinityTags) {
 		path := validators.RootedAt("affinityTags").Index(idx)
 		if affinityTag.Key == "" {
 			verr.AddViolationAt(path.Field("key"), validators.MustNotBeEmpty)
@@ -82,7 +83,7 @@ func validateLocalZone(localZone *LocalZone) validators.ValidationError {
 		}
 	}
 
-	if weightSpecified > 0 && weightSpecified != len(localZone.AffinityTags) {
+	if weightSpecified > 0 && weightSpecified != len(pointer.Deref(localZone.AffinityTags)) {
 		verr.AddViolation("affinityTags", "all or none affinity tags should have weight")
 	}
 	return verr

diff --git a/pkg/plugins/policies/meshloadbalancingstrategy/api/v1alpha1/zz_generated.deepcopy.go b/pkg/plugins/policies/meshloadbalancingstrategy/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/...ugins/policies/meshloadbalancingstrategy/k8s/crd/kuma.io_meshloadbalancingstrategies.yaml b/...ugins/policies/meshloadbalancingstrategy/k8s/crd/kuma.io_meshloadbalancingstrategies.yaml
@@ -479,8 +479,6 @@ spec:
                                     - key
                                     type: object
                                   type: array
-                              required:
-                              - affinityTags
                               type: object
                           type: object
                       type: object

diff --git a/pkg/plugins/policies/meshloadbalancingstrategy/plugin/v1alpha1/plugin.go b/pkg/plugins/policies/meshloadbalancingstrategy/plugin/v1alpha1/plugin.go
@@ -321,5 +321,5 @@ func (p plugin) configureCluster(c *envoy_cluster.Cluster, config api.Conf) erro
 }
 
 func shouldUseLocalityWeightedLb(config api.Conf) bool {
-	return config.LocalityAwareness != nil && config.LocalityAwareness.LocalZone != nil && len(config.LocalityAwareness.LocalZone.AffinityTags) > 0
+	return config.LocalityAwareness != nil && config.LocalityAwareness.LocalZone != nil && len(pointer.Deref(config.LocalityAwareness.LocalZone.AffinityTags)) > 0
 }
diff --git a/pkg/plugins/policies/meshloadbalancingstrategy/plugin/v1alpha1/plugin_test.go b/pkg/plugins/policies/meshloadbalancingstrategy/plugin/v1alpha1/plugin_test.go
@@ -448,7 +448,7 @@ var _ = Describe("MeshLoadBalancingStrategy", func() {
 											},
 											LocalityAwareness: &v1alpha1.LocalityAwareness{
 												LocalZone: &v1alpha1.LocalZone{
-													AffinityTags: []v1alpha1.AffinityTag{
+													AffinityTags: &[]v1alpha1.AffinityTag{
 														{
 															Key:    "k8s.io/node",
 															Weight: pointer.To[uint32](9000),
@@ -520,7 +520,7 @@ var _ = Describe("MeshLoadBalancingStrategy", func() {
 											},
 											LocalityAwareness: &v1alpha1.LocalityAwareness{
 												LocalZone: &v1alpha1.LocalZone{
-													AffinityTags: []v1alpha1.AffinityTag{
+													AffinityTags: &[]v1alpha1.AffinityTag{
 														{
 															Key:    "k8s.io/node",
 															Weight: pointer.To[uint32](9000),
@@ -649,7 +649,7 @@ var _ = Describe("MeshLoadBalancingStrategy", func() {
 											},
 											LocalityAwareness: &v1alpha1.LocalityAwareness{
 												LocalZone: &v1alpha1.LocalZone{
-													AffinityTags: []v1alpha1.AffinityTag{
+													AffinityTags: &[]v1alpha1.AffinityTag{
 														{
 															Key:    "k8s.io/node",
 															Weight: pointer.To[uint32](9000),
@@ -721,7 +721,7 @@ var _ = Describe("MeshLoadBalancingStrategy", func() {
 											},
 											LocalityAwareness: &v1alpha1.LocalityAwareness{
 												LocalZone: &v1alpha1.LocalZone{
-													AffinityTags: []v1alpha1.AffinityTag{
+													AffinityTags: &[]v1alpha1.AffinityTag{
 														{
 															Key:    "k8s.io/node",
 															Weight: pointer.To[uint32](9000),
@@ -853,7 +853,7 @@ var _ = Describe("MeshLoadBalancingStrategy", func() {
 											},
 											LocalityAwareness: &v1alpha1.LocalityAwareness{
 												LocalZone: &v1alpha1.LocalZone{
-													AffinityTags: []v1alpha1.AffinityTag{
+													AffinityTags: &[]v1alpha1.AffinityTag{
 														{
 															Key:    "k8s.io/node",
 															Weight: pointer.To[uint32](9000),
@@ -1205,7 +1205,7 @@ var _ = Describe("MeshLoadBalancingStrategy", func() {
 											},
 											LocalityAwareness: &v1alpha1.LocalityAwareness{
 												LocalZone: &v1alpha1.LocalZone{
-													AffinityTags: []v1alpha1.AffinityTag{
+													AffinityTags: &[]v1alpha1.AffinityTag{
 														{
 															Key: "k8s.io/node",
 														},

diff --git a/pkg/plugins/policies/meshloadbalancingstrategy/plugin/v1alpha1/priority.go b/pkg/plugins/policies/meshloadbalancingstrategy/plugin/v1alpha1/priority.go
@@ -31,8 +31,8 @@ func GetLocalityGroups(conf *api.Conf, inboundTags mesh_proto.MultiValueTagSet,
 func getLocalLbGroups(conf *api.Conf, inboundTags mesh_proto.MultiValueTagSet) []LocalLbGroup {
 	var localGroups []LocalLbGroup
 	if conf.LocalityAwareness.LocalZone != nil {
-		rulesLen := len(conf.LocalityAwareness.LocalZone.AffinityTags)
-		for i, tag := range conf.LocalityAwareness.LocalZone.AffinityTags {
+		rulesLen := len(pointer.Deref(conf.LocalityAwareness.LocalZone.AffinityTags))
+		for i, tag := range pointer.Deref(conf.LocalityAwareness.LocalZone.AffinityTags) {
 			values := inboundTags.Values(tag.Key)
 			// when weights are not provided we are generating weights by ourselves
 			// the first rule has the highest priority which is 9 * 10^(number of rules - rules position -1)