fix json tags for fields 1.0.x (#2159)

* Fix json tags for added fields * update tests * update consul image --------- Co-authored-by: Maliz <maliheh.monshizadeh@hashicorp.com>
hashicorp · May 26, 2023 · cd8d675 · cd8d675
1 parent 74ab182
commit cd8d675
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 35 deletions.
diff --git a/.changelog/2159.txt b/.changelog/2159.txt
@@ -0,0 +1,3 @@
+```release-note:bug
+control-plane: fix issue with json tags of service defaults fields EnforcingConsecutive5xx, MaxEjectionPercent and BaseEjectionTime.
+```
diff --git a/charts/consul/templates/crd-servicedefaults.yaml b/charts/consul/templates/crd-servicedefaults.yaml
@@ -252,7 +252,14 @@ spec:
                           upstream proxy instances will be monitored for removal from
                           the load balancing pool.
                         properties:
-                          enforcing_consecutive_5xx:
+                          baseEjectionTime:
+                            description: The base time that a host is ejected for.
+                              The real time is equal to the base time multiplied by
+                              the number of times the host has been ejected and is
+                              capped by max_ejection_time (Default 300s). Defaults
+                              to 30000ms or 30s.
+                            type: string
+                          enforcingConsecutive5xx:
                             description: EnforcingConsecutive5xx is the % chance that
                               a host will be actually ejected when an outlier status
                               is detected through consecutive 5xx. This setting can
@@ -263,6 +270,13 @@ spec:
                             description: Interval between health check analysis sweeps.
                               Each sweep may remove hosts or return hosts to the pool.
                             type: string
+                          maxEjectionPercent:
+                            description: The maximum % of an upstream cluster that
+                              can be ejected due to outlier detection. Defaults to
+                              10% but will eject at least one host regardless of the
+                              value.
+                            format: int32
+                            type: integer
                           maxFailures:
                             description: MaxFailures is the count of consecutive failures
                               that results in a host being removed from the pool.
@@ -352,12 +366,13 @@ spec:
                             from the load balancing pool.
                           properties:
                             baseEjectionTime:
-                              description: The base time that a host is ejected for. The
-                                real time is equal to the base time multiplied by the number
-                                of times the host has been ejected and is capped by
-                                max_ejection_time (Default 300s). Defaults to 30s.
+                              description: The base time that a host is ejected for.
+                                The real time is equal to the base time multiplied
+                                by the number of times the host has been ejected and
+                                is capped by max_ejection_time (Default 300s). Defaults
+                                to 30000ms or 30s.
                               type: string
-                            enforcing_consecutive_5xx:
+                            enforcingConsecutive5xx:
                               description: EnforcingConsecutive5xx is the % chance
                                 that a host will be actually ejected when an outlier
                                 status is detected through consecutive 5xx. This setting
@@ -371,8 +386,9 @@ spec:
                               type: string
                             maxEjectionPercent:
                               description: The maximum % of an upstream cluster that
-                                can be ejected due to outlier detection. Defaults to
-                                10% but will eject at least one host regardless of the value.
+                                can be ejected due to outlier detection. Defaults
+                                to 10% but will eject at least one host regardless
+                                of the value.
                               format: int32
                               type: integer
                             maxFailures:

diff --git a/charts/consul/values.yaml b/charts/consul/values.yaml
@@ -63,7 +63,7 @@ global:
   # image: "hashicorp/consul-enterprise:1.10.0-ent"
   # ```
   # @default: hashicorp/consul:<latest version>
-  image: "hashicorp/consul:1.14.7"
+  image: "docker.mirror.hashicorp.services/hashicorppreview/consul-enterprise:1.14-dev"
 
   # Array of objects containing image pull secret names that will be applied to each service account.
   # This can be used to reference image pull secrets if using a custom consul or consul-k8s-control-plane Docker image.

diff --git a/control-plane/api/v1alpha1/servicedefaults_types.go b/control-plane/api/v1alpha1/servicedefaults_types.go
@@ -4,7 +4,6 @@ import (
 	"fmt"
 	"net"
 	"strings"
-	"time"
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
@@ -172,14 +171,14 @@ type PassiveHealthCheck struct {
 	// EnforcingConsecutive5xx is the % chance that a host will be actually ejected
 	// when an outlier status is detected through consecutive 5xx.
 	// This setting can be used to disable ejection or to ramp it up slowly.
-	EnforcingConsecutive5xx *uint32 `json:"enforcing_consecutive_5xx,omitempty"`
+	EnforcingConsecutive5xx *uint32 `json:"enforcingConsecutive5xx,omitempty"`
 	// The maximum % of an upstream cluster that can be ejected due to outlier detection.
 	// Defaults to 10% but will eject at least one host regardless of the value.
-	MaxEjectionPercent *uint32 `json:",omitempty" alias:"max_ejection_percent"`
+	MaxEjectionPercent *uint32 `json:"maxEjectionPercent,omitempty"`
 	// The base time that a host is ejected for. The real time is equal to the base time
 	// multiplied by the number of times the host has been ejected and is capped by
 	// max_ejection_time (Default 300s). Defaults to 30000ms or 30s.
-	BaseEjectionTime *time.Duration `json:",omitempty" alias:"base_ejection_time"`
+	BaseEjectionTime *metav1.Duration `json:"baseEjectionTime,omitempty"`
 }
 
 type ServiceDefaultsDestination struct {
@@ -422,7 +421,7 @@ func (in *PassiveHealthCheck) toConsul() *capi.PassiveHealthCheck {
 		MaxFailures:             in.MaxFailures,
 		EnforcingConsecutive5xx: in.EnforcingConsecutive5xx,
 		MaxEjectionPercent:      in.MaxEjectionPercent,
-		BaseEjectionTime:        in.BaseEjectionTime,
+		BaseEjectionTime:        &in.BaseEjectionTime.Duration,
 	}
 }
 

diff --git a/control-plane/api/v1alpha1/servicedefaults_types_test.go b/control-plane/api/v1alpha1/servicedefaults_types_test.go
@@ -86,7 +86,9 @@ func TestServiceDefaults_ToConsul(t *testing.T) {
 								MaxFailures:             uint32(20),
 								EnforcingConsecutive5xx: pointer.Uint32(100),
 								MaxEjectionPercent:      pointer.Uint32(10),
-								BaseEjectionTime:        pointer.Duration(10 * time.Second),
+								BaseEjectionTime: &metav1.Duration{
+									Duration: 10 * time.Second,
+								},
 							},
 							MeshGateway: MeshGateway{
 								Mode: "local",
@@ -113,7 +115,9 @@ func TestServiceDefaults_ToConsul(t *testing.T) {
 									MaxFailures:             uint32(10),
 									EnforcingConsecutive5xx: pointer.Uint32(60),
 									MaxEjectionPercent:      pointer.Uint32(20),
-									BaseEjectionTime:        pointer.Duration(20 * time.Second),
+									BaseEjectionTime: &metav1.Duration{
+										Duration: 20 * time.Second,
+									},
 								},
 								MeshGateway: MeshGateway{
 									Mode: "remote",
@@ -139,7 +143,9 @@ func TestServiceDefaults_ToConsul(t *testing.T) {
 									MaxFailures:             uint32(10),
 									EnforcingConsecutive5xx: pointer.Uint32(60),
 									MaxEjectionPercent:      pointer.Uint32(30),
-									BaseEjectionTime:        pointer.Duration(30 * time.Second),
+									BaseEjectionTime: &metav1.Duration{
+										Duration: 30 * time.Second,
+									},
 								},
 								MeshGateway: MeshGateway{
 									Mode: "remote",
@@ -361,7 +367,9 @@ func TestServiceDefaults_MatchesConsul(t *testing.T) {
 								MaxFailures:             uint32(20),
 								EnforcingConsecutive5xx: pointer.Uint32(100),
 								MaxEjectionPercent:      pointer.Uint32(10),
-								BaseEjectionTime:        pointer.Duration(10 * time.Second),
+								BaseEjectionTime: &metav1.Duration{
+									Duration: 10 * time.Second,
+								},
 							},
 							MeshGateway: MeshGateway{
 								Mode: "local",
@@ -387,7 +395,9 @@ func TestServiceDefaults_MatchesConsul(t *testing.T) {
 									MaxFailures:             uint32(10),
 									EnforcingConsecutive5xx: pointer.Uint32(60),
 									MaxEjectionPercent:      pointer.Uint32(20),
-									BaseEjectionTime:        pointer.Duration(20 * time.Second),
+									BaseEjectionTime: &metav1.Duration{
+										Duration: 20 * time.Second,
+									},
 								},
 								MeshGateway: MeshGateway{
 									Mode: "remote",
@@ -412,7 +422,9 @@ func TestServiceDefaults_MatchesConsul(t *testing.T) {
 									MaxFailures:             uint32(10),
 									EnforcingConsecutive5xx: pointer.Uint32(60),
 									MaxEjectionPercent:      pointer.Uint32(30),
-									BaseEjectionTime:        pointer.Duration(30 * time.Second),
+									BaseEjectionTime: &metav1.Duration{
+										Duration: 30 * time.Second,
+									},
 								},
 								MeshGateway: MeshGateway{
 									Mode: "remote",

diff --git a/control-plane/api/v1alpha1/zz_generated.deepcopy.go b/control-plane/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/control-plane/config/crd/bases/consul.hashicorp.com_servicedefaults.yaml b/control-plane/config/crd/bases/consul.hashicorp.com_servicedefaults.yaml
@@ -246,12 +246,13 @@ spec:
                           the load balancing pool.
                         properties:
                           baseEjectionTime:
-                            description: The base time that a host is ejected for. The
-                              real time is equal to the base time multiplied by the number
-                              of times the host has been ejected and is capped by
-                              max_ejection_time (Default 300s). Defaults to 30s.
+                            description: The base time that a host is ejected for.
+                              The real time is equal to the base time multiplied by
+                              the number of times the host has been ejected and is
+                              capped by max_ejection_time (Default 300s). Defaults
+                              to 30000ms or 30s.
                             type: string
-                          enforcing_consecutive_5xx:
+                          enforcingConsecutive5xx:
                             description: EnforcingConsecutive5xx is the % chance that
                               a host will be actually ejected when an outlier status
                               is detected through consecutive 5xx. This setting can
@@ -265,7 +266,8 @@ spec:
                           maxEjectionPercent:
                             description: The maximum % of an upstream cluster that
                               can be ejected due to outlier detection. Defaults to
-                              10% but will eject at least one host regardless of the value.
+                              10% but will eject at least one host regardless of the
+                              value.
                             format: int32
                             type: integer
                           maxFailures:
@@ -357,12 +359,13 @@ spec:
                             from the load balancing pool.
                           properties:
                             baseEjectionTime:
-                              description: The base time that a host is ejected for. The
-                                real time is equal to the base time multiplied by the number
-                                of times the host has been ejected and is capped by
-                                max_ejection_time (Default 300s). Defaults to 30s.
+                              description: The base time that a host is ejected for.
+                                The real time is equal to the base time multiplied
+                                by the number of times the host has been ejected and
+                                is capped by max_ejection_time (Default 300s). Defaults
+                                to 30000ms or 30s.
                               type: string
-                            enforcing_consecutive_5xx:
+                            enforcingConsecutive5xx:
                               description: EnforcingConsecutive5xx is the % chance
                                 that a host will be actually ejected when an outlier
                                 status is detected through consecutive 5xx. This setting
@@ -376,8 +379,9 @@ spec:
                               type: string
                             maxEjectionPercent:
                               description: The maximum % of an upstream cluster that
-                                can be ejected due to outlier detection. Defaults to
-                                10% but will eject at least one host regardless of the value.
+                                can be ejected due to outlier detection. Defaults
+                                to 10% but will eject at least one host regardless
+                                of the value.
                               format: int32
                               type: integer
                             maxFailures: