github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/configuration/core/reconfigure_util.go

/*
Copyright (C) 2022-2023 ApeCloud Co., Ltd

This file is part of KubeBlocks project

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package core

import (
	"encoding/json"
	"reflect"

	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"sigs.k8s.io/controller-runtime/pkg/client"

	appsv1alpha1 "github.com/1aal/kubeblocks/apis/apps/v1alpha1"
	"github.com/1aal/kubeblocks/pkg/configuration/util"
	"github.com/1aal/kubeblocks/pkg/constant"
)

func getUpdateParameterList(cfg *ConfigPatchInfo, trimField string) ([]string, error) {
	params := make([]string, 0)
	walkFn := func(parent, cur string, v reflect.Value, fn util.UpdateFn) error {
		if cur != "" {
			if parent != "" {
				cur = parent + "." + cur
			}
			params = append(params, cur)
		}
		return nil
	}

	for _, diff := range cfg.UpdateConfig {
		var err error
		var updatedParams any
		if err = json.Unmarshal(diff, &updatedParams); err != nil {
			return nil, err
		}
		if updatedParams, err = trimNestedField(updatedParams, trimField); err != nil {
			return nil, err
		}
		if err := util.UnstructuredObjectWalk(updatedParams, walkFn, true); err != nil {
			return nil, WrapError(err, "failed to walk params: [%s]", diff)
		}
	}
	return params, nil
}

func trimNestedField(updatedParams any, trimField string) (any, error) {
	if trimField == "" {
		return updatedParams, nil
	}
	if m, ok := updatedParams.(map[string]interface{}); ok {
		trimParams, found, err := unstructured.NestedFieldNoCopy(m, trimField)
		if err != nil {
			return nil, err
		}
		if found {
			return trimParams, nil
		}
	}
	return updatedParams, nil
}

// ValidateConfigPatch Verifies if the changed parameters have been removed
func ValidateConfigPatch(patch *ConfigPatchInfo, formatCfg *appsv1alpha1.FormatterConfig) error {
	if !patch.IsModify || len(patch.UpdateConfig) == 0 {
		return nil
	}

	vParams := GenerateVisualizedParamsList(patch, formatCfg, nil)
	for _, param := range vParams {
		for _, p := range param.Parameters {
			if p.Value == nil {
				return MakeError("delete config parameter [%s] is not support!", p.Key)
			}
		}
	}
	return nil
}

// IsUpdateDynamicParameters checks if the changed parameters require a restart
func IsUpdateDynamicParameters(cc *appsv1alpha1.ConfigConstraintSpec, cfg *ConfigPatchInfo) (bool, error) {
	if len(cfg.DeleteConfig) > 0 || len(cfg.AddConfig) > 0 {
		return false, nil
	}

	params, err := getUpdateParameterList(cfg, NestedPrefixField(cc.FormatterConfig))
	if err != nil {
		return false, err
	}
	updateParams := util.NewSet(params...)

	// if ConfigConstraint has StaticParameters, check updated parameter
	if len(cc.StaticParameters) > 0 {
		staticParams := util.NewSet(cc.StaticParameters...)
		union := util.Union(staticParams, updateParams)
		if union.Length() > 0 {
			return false, nil
		}
		// if no dynamicParameters is configured, reload is the default behavior
		if len(cc.DynamicParameters) == 0 {
			return true, nil
		}
	}

	// if ConfigConstraint has DynamicParameter, and all updated params are dynamic
	if len(cc.DynamicParameters) > 0 {
		dynamicParams := util.NewSet(cc.DynamicParameters...)
		diff := util.Difference(updateParams, dynamicParams)
		return diff.Length() == 0, nil
	}

	// if the updated parameter is not in list of DynamicParameter,
	// it is StaticParameter by default, and restart is the default behavior.
	return false, nil
}

// IsParametersUpdateFromManager checks if the parameters are updated from manager
func IsParametersUpdateFromManager(cm *corev1.ConfigMap) bool {
	annotation := cm.ObjectMeta.Annotations
	if annotation == nil {
		return false
	}
	v := annotation[constant.KBParameterUpdateSourceAnnotationKey]
	return v == constant.ReconfigureManagerSource
}

// IsNotUserReconfigureOperation checks if the parameters are updated from operation
func IsNotUserReconfigureOperation(cm *corev1.ConfigMap) bool {
	labels := cm.GetLabels()
	annotations := cm.GetAnnotations()
	if labels == nil || annotations == nil {
		return false
	}
	if _, ok := annotations[constant.CMInsEnableRerenderTemplateKey]; !ok {
		return false
	}
	lastReconfigurePhase := labels[constant.CMInsLastReconfigurePhaseKey]
	if annotations[constant.KBParameterUpdateSourceAnnotationKey] != constant.ReconfigureManagerSource {
		return false
	}
	return lastReconfigurePhase == "" || ReconfigureCreatedPhase == lastReconfigurePhase
}

// SetParametersUpdateSource sets the parameters' update source
// manager: parameter only updated from manager
// external-template: parameter only updated from template
// ops: parameter updated from operation
func SetParametersUpdateSource(cm *corev1.ConfigMap, source string) {
	annotation := cm.GetAnnotations()
	if annotation == nil {
		annotation = make(map[string]string)
	}
	annotation[constant.KBParameterUpdateSourceAnnotationKey] = source
	cm.SetAnnotations(annotation)
}

func IsSchedulableConfigResource(object client.Object) bool {
	var requiredLabels = []string{
		constant.AppNameLabelKey,
		constant.AppInstanceLabelKey,
		constant.KBAppComponentLabelKey,
		constant.CMConfigurationTemplateNameLabelKey,
		constant.CMConfigurationTypeLabelKey,
		constant.CMConfigurationSpecProviderLabelKey,
	}

	labels := object.GetLabels()
	if len(labels) == 0 {
		return false
	}
	for _, label := range requiredLabels {
		if _, ok := labels[label]; !ok {
			return false
		}
	}
	return true
}