Version gate to deprecate node_version using update desired nodes API (#7628)

thbkrkr · web-flow · commit b162f18b1402 · 2024-03-14T15:50:29.000+01:00
diff --git a/pkg/controller/elasticsearch/client/desired_nodes.go b/pkg/controller/elasticsearch/client/desired_nodes.go
@@ -12,6 +12,7 @@ import (
 )
 
 var desiredNodesMinVersion = version.MinFor(8, 3, 0)
+var DeprecatedNodeVersionReqBodyParamMinVersion = version.MinFor(8, 13, 0)
 
 type DesiredNodesClient interface {
 	IsDesiredNodesSupported() bool
@@ -38,7 +39,7 @@ type DesiredNode struct {
 	ProcessorsRange ProcessorsRange        `json:"processors_range"`
 	Memory          string                 `json:"memory"`
 	Storage         string                 `json:"storage"`
-	NodeVersion     string                 `json:"node_version"`
+	NodeVersion     string                 `json:"node_version,omitempty"` // deprecated in 8.13+
 }
 
 type ProcessorsRange struct {
diff --git a/pkg/controller/elasticsearch/driver/desired_nodes.go b/pkg/controller/elasticsearch/driver/desired_nodes.go
@@ -37,7 +37,7 @@ func (d *defaultDriver) updateDesiredNodes(
 	if err != nil {
 		return results.WithError(err)
 	}
-	nodes, requeue, err := expectedResources.ToDesiredNodes(ctx, d.Client, esVersion.FinalizeVersion())
+	nodes, requeue, err := expectedResources.ToDesiredNodes(ctx, d.Client, esVersion)
 	switch {
 	case err == nil:
 		d.ReconcileState.ReportCondition(
diff --git a/pkg/controller/elasticsearch/nodespec/desired_nodes.go b/pkg/controller/elasticsearch/nodespec/desired_nodes.go
@@ -19,6 +19,7 @@ import (
 	esv1 "github.com/elastic/cloud-on-k8s/v2/pkg/apis/elasticsearch/v1"
 	sset "github.com/elastic/cloud-on-k8s/v2/pkg/controller/common/statefulset"
 	"github.com/elastic/cloud-on-k8s/v2/pkg/controller/common/tracing"
+	"github.com/elastic/cloud-on-k8s/v2/pkg/controller/common/version"
 	"github.com/elastic/cloud-on-k8s/v2/pkg/controller/elasticsearch/client"
 	"github.com/elastic/cloud-on-k8s/v2/pkg/controller/elasticsearch/settings"
 	"github.com/elastic/cloud-on-k8s/v2/pkg/utils/k8s"
@@ -226,7 +227,7 @@ const (
 func (l ResourcesList) ToDesiredNodes(
 	ctx context.Context,
 	k8sClient k8s.Client,
-	version string,
+	version version.Version,
 ) (desiredNodes []client.DesiredNode, requeue bool, err error) {
 	span, ctx := apm.StartSpan(ctx, "compute_desired_nodes", tracing.SpanTypeApp)
 	defer span.End()
@@ -266,7 +267,7 @@ func (l ResourcesList) ToDesiredNodes(
 			})
 
 			node := client.DesiredNode{
-				NodeVersion:     version,
+				NodeVersion:     emptyIfDeprecated(version, client.DeprecatedNodeVersionReqBodyParamMinVersion),
 				ProcessorsRange: nodeResource.cpu,
 				Memory:          fmt.Sprintf("%db", nodeResource.memory),
 				Storage:         fmt.Sprintf("%db", nodeResource.storage),
@@ -279,6 +280,15 @@ func (l ResourcesList) ToDesiredNodes(
 	return desiredNodes, requeue, nil
 }
 
+// emptyIfDeprecated returns an empty string if the version is greater than equal to the deprecated version,
+// else the finalized version.
+func emptyIfDeprecated(version, deprecatedMinVersion version.Version) string {
+	if version.GTE(deprecatedMinVersion) {
+		return ""
+	}
+	return version.FinalizeVersion()
+}
+
 // visit recursively visits a map holding a tree structure and apply a function to nodes that hold a string.
 func visit(keys []string, m map[string]interface{}, apply func(string) string) {
 	for k, v := range m {

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ import (`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`var desiredNodesMinVersion = version.MinFor(8, 3, 0)`
	`15`	`+var DeprecatedNodeVersionReqBodyParamMinVersion = version.MinFor(8, 13, 0)`
`15`	`16`
`16`	`17`	`type DesiredNodesClient interface {`
`17`	`18`	`IsDesiredNodesSupported() bool`
`@@ -38,7 +39,7 @@ type DesiredNode struct {`
`38`	`39`	ProcessorsRange ProcessorsRange `json:"processors_range"`
`39`	`40`	Memory string `json:"memory"`
`40`	`41`	Storage string `json:"storage"`
`41`		- NodeVersion string `json:"node_version"`
	`42`	+ NodeVersion string `json:"node_version,omitempty"` // deprecated in 8.13+
`42`	`43`	`}`
`43`	`44`
`44`	`45`	`type ProcessorsRange struct {`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ func (d *defaultDriver) updateDesiredNodes(`
`37`	`37`	`if err != nil {`
`38`	`38`	`return results.WithError(err)`
`39`	`39`	`}`
`40`		`- nodes, requeue, err := expectedResources.ToDesiredNodes(ctx, d.Client, esVersion.FinalizeVersion())`
	`40`	`+ nodes, requeue, err := expectedResources.ToDesiredNodes(ctx, d.Client, esVersion)`
`41`	`41`	`switch {`
`42`	`42`	`case err == nil:`
`43`	`43`	`d.ReconcileState.ReportCondition(`