update API

Author: leon-inf

apis/apps/v1/deprecated.go

@@ -50,9 +50,9 @@ func (r *Cluster) GetComponentByName(componentName string) *ClusterComponentSpec
 }
 
 func (r *ClusterSpec) GetComponentByName(componentName string) *ClusterComponentSpec {
-	for _, v := range r.ComponentSpecs {
+	for i, v := range r.ComponentSpecs {
 		if v.Name == componentName {
-			return &v
+			return &r.ComponentSpecs[i]
 		}
 	}
 	return nil

apis/apps/v1/types.go

@@ -502,6 +502,11 @@ type ClusterComponentConfig struct {
 	// +optional
 	ExternalManaged *bool `json:"externalManaged,omitempty"`
 
+	// The versioned hash of the config content.
+	//
+	// +optional
+	VersionHash string `json:"versionHash,omitempty"`
+
 	// The custom reconfigure action to reload the configuration whenever changes to this config are detected.
 	//
 	// The container executing this action has access to following variables:

apis/workloads/v1/instanceset_types.go

@@ -514,8 +514,15 @@ type ConfigTemplate struct {
 	// The name of the config.
 	Name string `json:"name"`
 
-	// The generation of the config.
-	Generation int64 `json:"generation"`
+	// The generation of the config content.
+	//
+	// +optional
+	Generation int64 `json:"generation,omitempty"`
+
+	// The versioned hash of the config content.
+	//
+	// +optional
+	VersionHash string `json:"versionHash,omitempty"`
 
 	// The custom reconfigure action.
 	//
@@ -566,8 +573,13 @@ type InstanceConfigStatus struct {
 
 	// The generation of the config.
 	//
-	// +kubebuilder:validation:Required
-	Generation int64 `json:"generation"`
+	// +optional
+	Generation int64 `json:"generation,omitempty"`
+
+	// The hash of the config content.
+	//
+	// +optional
+	VersionHash string `json:"versionHash,omitempty"`
 }
 
 // InstanceTemplateStatus aggregates the status of replicas for each InstanceTemplate

config/crd/bases/apps.kubeblocks.io_clusters.yaml

@@ -739,6 +739,9 @@ spec:
                             description: Variables are key-value pairs for dynamic
                               configuration values that can be provided by the user.
                             type: object
+                          versionHash:
+                            description: The versioned hash of the config content.
+                            type: string
                         type: object
                       type: array
                     disableExporter:
@@ -11963,6 +11966,9 @@ spec:
                                   configuration values that can be provided by the
                                   user.
                                 type: object
+                              versionHash:
+                                description: The versioned hash of the config content.
+                                type: string
                             type: object
                           type: array
                         disableExporter:

config/crd/bases/apps.kubeblocks.io_components.yaml

@@ -610,6 +610,9 @@ spec:
                       description: Variables are key-value pairs for dynamic configuration
                         values that can be provided by the user.
                       type: object
+                    versionHash:
+                      description: The versioned hash of the config content.
+                      type: string
                   type: object
                 type: array
               disableExporter:

config/crd/bases/workloads.kubeblocks.io_instancesets.yaml

@@ -70,7 +70,7 @@ spec:
                 items:
                   properties:
                     generation:
-                      description: The generation of the config.
+                      description: The generation of the config content.
                       format: int64
                       type: integer
                     name:
@@ -519,8 +519,10 @@ spec:
 
                         An empty name indicates that the reconfigure action is the default one defined by lifecycle actions.
                       type: string
+                    versionHash:
+                      description: The versioned hash of the config content.
+                      type: string
                   required:
-                  - generation
                   - name
                   type: object
                 type: array
@@ -11716,8 +11718,10 @@ spec:
                           name:
                             description: The name of the config.
                             type: string
+                          versionHash:
+                            description: The hash of the config content.
+                            type: string
                         required:
-                        - generation
                         - name
                         type: object
                       type: array

controllers/parameters/config_reconcile_wrapper.go

@@ -25,6 +25,8 @@ import (
 
 	appsv1 "github.com/apecloud/kubeblocks/apis/apps/v1"
 	parametersv1alpha1 "github.com/apecloud/kubeblocks/apis/parameters/v1alpha1"
+	workloads "github.com/apecloud/kubeblocks/apis/workloads/v1"
+	"github.com/apecloud/kubeblocks/pkg/constant"
 	"github.com/apecloud/kubeblocks/pkg/controller/component"
 	"github.com/apecloud/kubeblocks/pkg/controller/render"
 	intctrlutil "github.com/apecloud/kubeblocks/pkg/controllerutil"
@@ -39,6 +41,8 @@ type ReconcileContext struct {
 	ConfigMap        *corev1.ConfigMap
 	BuiltinComponent *component.SynthesizedComponent
 
+	ITS *workloads.InstanceSet
+
 	ConfigRender   *parametersv1alpha1.ParamConfigRenderer
 	ParametersDefs map[string]*parametersv1alpha1.ParametersDefinition
 }
@@ -63,11 +67,23 @@ func (c *ReconcileContext) GetRelatedObjects() error {
 	return c.Cluster().
 		ComponentAndComponentDef().
 		ComponentSpec().
+		Workload().
 		SynthesizedComponent().
 		ParametersDefinitions().
 		Complete()
 }
 
+func (c *ReconcileContext) Workload() *ReconcileContext {
+	return c.Wrap(func() error {
+		itsKey := client.ObjectKey{
+			Namespace: c.Namespace,
+			Name:      constant.GenerateWorkloadNamePattern(c.ClusterName, c.ComponentName),
+		}
+		c.ITS = &workloads.InstanceSet{}
+		return c.Client.Get(c.Context, itsKey, c.ITS)
+	})
+}
+
 func (c *ReconcileContext) SynthesizedComponent() *ReconcileContext {
 	return c.Wrap(func() (err error) {
 		// build synthesized component for the component

controllers/parameters/policy_util.go

@@ -20,7 +20,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 package parameters
 
 import (
-	"context"
 	"fmt"
 
 	corev1 "k8s.io/api/core/v1"
@@ -74,11 +73,6 @@ func getPodsForOnlineUpdate(params reconfigureContext) ([]corev1.Pod, error) {
 	return podList.Items, nil
 }
 
-func commonOnlineUpdateWithPod(pod *corev1.Pod, ctx context.Context, configSpec string, configFile string, updatedParams map[string]string) error {
-	// TODO: update cluster spec to call the reconfigure action
-	return fmt.Errorf("not yet implemented")
-}
-
 func getComponentSpecPtrByName(cli client.Client, ctx intctrlutil.RequestCtx, cluster *appsv1.Cluster, compName string) (*appsv1.ClusterComponentSpec, error) {
 	for i := range cluster.Spec.ComponentSpecs {
 		componentSpec := &cluster.Spec.ComponentSpecs[i]
@@ -147,7 +141,6 @@ func (r reconfigureTask) ExecReload() (returnedStatus, error) {
 	if executor, ok := upgradePolicyMap[r.ReloadPolicy]; ok {
 		return executor.Upgrade(r.taskCtx)
 	}
-
 	return returnedStatus{}, fmt.Errorf("not support reload action[%s]", r.ReloadPolicy)
 }
 
@@ -227,12 +220,13 @@ func buildReloadActionTask(reloadPolicy parametersv1alpha1.ReloadPolicy, templat
 			RequestCtx:           rctx.RequestCtx,
 			Client:               rctx.Client,
 			ConfigTemplate:       *templateSpec,
-			ConfigMap:            rctx.ConfigMap,
+			VersionHash:          computeTargetVersionHash(rctx.RequestCtx, rctx.ConfigMap.Data),
 			ParametersDef:        &pd.Spec,
 			ConfigDescription:    configDescription,
 			Cluster:              rctx.ClusterObj,
 			ClusterComponent:     rctx.ClusterComObj,
 			SynthesizedComponent: rctx.BuiltinComponent,
+			ITS:                  rctx.ITS,
 			Patch:                patch,
 		},
 	}
@@ -245,32 +239,11 @@ func buildRestartTask(configTemplate *appsv1.ComponentFileTemplate, rctx *Reconc
 			RequestCtx:           rctx.RequestCtx,
 			Client:               rctx.Client,
 			ConfigTemplate:       *configTemplate,
+			VersionHash:          computeTargetVersionHash(rctx.RequestCtx, rctx.ConfigMap.Data),
 			ClusterComponent:     rctx.ClusterComObj,
 			Cluster:              rctx.ClusterObj,
 			SynthesizedComponent: rctx.BuiltinComponent,
-			ConfigMap:            rctx.ConfigMap,
+			ITS:                  rctx.ITS,
 		},
 	}
 }
-
-func generateOnlineUpdateParams(configPatch *core.ConfigPatchInfo, paramDef *parametersv1alpha1.ParametersDefinitionSpec, description parametersv1alpha1.ComponentConfigDescription) map[string]string {
-	params := make(map[string]string)
-	dynamicAction := parameters.NeedDynamicReloadAction(paramDef)
-	needReloadStaticParams := parameters.ReloadStaticParameters(paramDef)
-	visualizedParams := core.GenerateVisualizedParamsList(configPatch, []parametersv1alpha1.ComponentConfigDescription{description})
-
-	for _, key := range visualizedParams {
-		if key.UpdateType != core.UpdatedType {
-			continue
-		}
-		for _, p := range key.Parameters {
-			if dynamicAction && !needReloadStaticParams && !core.IsDynamicParameter(p.Key, paramDef) {
-				continue
-			}
-			if p.Value != nil {
-				params[p.Key] = *p.Value
-			}
-		}
-	}
-	return params
-}

controllers/parameters/policy_util_test.go

@@ -34,6 +34,7 @@ import (
 
 	appsv1 "github.com/apecloud/kubeblocks/apis/apps/v1"
 	parametersv1alpha1 "github.com/apecloud/kubeblocks/apis/parameters/v1alpha1"
+	workloads "github.com/apecloud/kubeblocks/apis/workloads/v1"
 	"github.com/apecloud/kubeblocks/pkg/controller/component"
 	intctrlutil "github.com/apecloud/kubeblocks/pkg/controllerutil"
 	"github.com/apecloud/kubeblocks/pkg/parameters/core"
@@ -63,12 +64,26 @@ func withClusterComponent(replicas int) paramsOps {
 	}
 }
 
-func withConfigSpec(configSpecName string, data map[string]string) paramsOps {
+func withClusterComponentNConfigs(replicas int, configs []appsv1.ClusterComponentConfig) paramsOps {
 	return func(params *reconfigureContext) {
-		params.ConfigMap = &corev1.ConfigMap{
-			Data: data,
+		params.ClusterComponent = &appsv1.ClusterComponentSpec{
+			Name:     "test",
+			Replicas: func() int32 { rep := int32(replicas); return rep }(),
+			Configs:  configs,
 		}
+	}
+}
+
+func withWorkload() paramsOps {
+	return func(params *reconfigureContext) {
+		params.ITS = &workloads.InstanceSet{}
+	}
+}
+
+func withConfigSpec(configSpecName string, data map[string]string) paramsOps {
+	return func(params *reconfigureContext) {
 		params.ConfigTemplate.Name = configSpecName
+		params.VersionHash = computeTargetVersionHash(params.RequestCtx, data)
 	}
 }
 

controllers/parameters/reconfigure_controller.go

@@ -23,6 +23,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"reflect"
 	"time"
 
 	"github.com/pkg/errors"
@@ -234,46 +235,64 @@ func (r *ReconfigureReconciler) updateConfigCMStatus(reqCtx intctrlutil.RequestC
 }
 
 func (r *ReconfigureReconciler) performUpgrade(rctx *ReconcileContext, reloadTasks []ReloadAction) (ctrl.Result, error) {
-	var err error
-	var returnedStatus returnedStatus
-	var reloadType string
-
+	var (
+		err        error
+		status     returnedStatus
+		reloadType string
+	)
 	for _, task := range reloadTasks {
 		reloadType = task.ReloadType()
-		returnedStatus, err = task.ExecReload()
-		if err != nil || returnedStatus.Status != ESNone {
-			return r.status(rctx, returnedStatus, reloadType, err)
+		status, err = task.ExecReload()
+		if err != nil || status.Status != ESNone {
+			break
 		}
 	}
-	return r.succeed(rctx, reloadType, returnedStatus)
+	// submit changes to the cluster
+	if err1 := r.submit(rctx); err1 != nil {
+		return intctrlutil.RequeueAfter(configReconcileInterval, rctx.Log, "failed to submit changes to the cluster", "error", err1)
+	}
+	if err != nil || status.Status != ESNone {
+		return r.status(rctx, reloadType, status, err)
+	}
+	return r.succeed(rctx, reloadType, status)
+}
+
+func (r *ReconfigureReconciler) submit(rctx *ReconcileContext) error {
+	if rctx.ClusterObj == nil || rctx.ClusterObjCopy == nil {
+		return fmt.Errorf("the cluster object is nil")
+	}
+	if reflect.DeepEqual(rctx.ClusterObj.Spec, rctx.ClusterObjCopy.Spec) {
+		return nil
+	}
+	return rctx.Client.Update(rctx.RequestCtx.Ctx, rctx.ClusterObj)
 }
 
-func (r *ReconfigureReconciler) status(rctx *ReconcileContext, returnedStatus returnedStatus, policy string, err error) (ctrl.Result, error) {
+func (r *ReconfigureReconciler) status(rctx *ReconcileContext, reloadType string, status returnedStatus, err error) (ctrl.Result, error) {
 	updatePhase := func(phase parametersv1alpha1.ParameterPhase, options ...options) (ctrl.Result, error) {
-		return updateConfigPhaseWithResult(rctx.Client, rctx.RequestCtx, rctx.ConfigMap, reconciled(returnedStatus, policy, phase, options...))
+		return updateConfigPhaseWithResult(rctx.Client, rctx.RequestCtx, rctx.ConfigMap, reconciled(status, reloadType, phase, options...))
 	}
 
-	switch returnedStatus.Status {
+	switch status.Status {
 	case ESFailedAndRetry:
 		return updatePhase(parametersv1alpha1.CFailedPhase, withFailed(err, true))
 	case ESRetry:
 		return updatePhase(parametersv1alpha1.CUpgradingPhase)
 	case ESFailed:
 		return updatePhase(parametersv1alpha1.CFailedAndPausePhase, withFailed(err, false))
 	case ESNone:
-		return r.succeed(rctx, policy, returnedStatus)
+		return r.succeed(rctx, reloadType, status)
 	default:
 		return updatePhase(parametersv1alpha1.CFailedAndPausePhase, withFailed(cfgcore.MakeError("unknown status"), false))
 	}
 }
 
-func (r *ReconfigureReconciler) succeed(rctx *ReconcileContext, reloadType string, returnedStatus returnedStatus) (ctrl.Result, error) {
+func (r *ReconfigureReconciler) succeed(rctx *ReconcileContext, reloadType string, status returnedStatus) (ctrl.Result, error) {
 	rctx.Recorder.Eventf(rctx.ConfigMap,
 		corev1.EventTypeNormal,
 		appsv1alpha1.ReasonReconfigureSucceed,
 		"the reconfigure[%s] has been processed successfully",
 		reloadType)
 
-	result := reconciled(returnedStatus, reloadType, parametersv1alpha1.CFinishedPhase)
+	result := reconciled(status, reloadType, parametersv1alpha1.CFinishedPhase)
 	return r.updateConfigCMStatus(rctx.RequestCtx, rctx.ConfigMap, reloadType, &result)
 }