parameters

package
v1.1.0-alpha.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 13, 2025 License: AGPL-3.0 Imports: 32 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ApplyParameters 

func ApplyParameters(item parametersv1alpha1.ConfigTemplateItemDetail,
	baseConfig *corev1.ConfigMap,
	configRender *parametersv1alpha1.ParamConfigRenderer,
	paramsDefs []*parametersv1alpha1.ParametersDefinition) (*corev1.ConfigMap, error)

func AsSidecarContainerImage 

func AsSidecarContainerImage(toolImage parametersv1alpha1.ToolConfig) bool

func BuildReloadActionContainer 

func BuildReloadActionContainer(resourceCtx *render.ResourceCtx, cluster *appsv1.Cluster, synthesizedComp *component.SynthesizedComponent, cmpd *appsv1.ComponentDefinition) error

BuildReloadActionContainer build the configmgr sidecar container and update it into PodSpec if configuration reload option is on

func CheckAndPatchPayload 

func CheckAndPatchPayload(item *parametersv1alpha1.ConfigTemplateItemDetail, payloadID string, payload interface{}) (bool, error)

func ClassifyComponentParameters 

func ClassifyComponentParameters(parameters parametersv1alpha1.ComponentParameters,
	parametersDefs []*parametersv1alpha1.ParametersDefinition,
	templates []appsv1.ComponentFileTemplate,
	tpls map[string]*corev1.ConfigMap,
	pcr *parametersv1alpha1.ParamConfigRenderer) (map[string]map[string]*parametersv1alpha1.ParametersInFile, error)

func ClassifyParamsFromConfigTemplate 

func ClassifyParamsFromConfigTemplate(params parametersv1alpha1.ComponentParameters,
	cmpd *appsv1.ComponentDefinition,
	paramsDefs []*parametersv1alpha1.ParametersDefinition,
	tpls map[string]*corev1.ConfigMap,
	pcr *parametersv1alpha1.ParamConfigRenderer) ([]parametersv1alpha1.ConfigTemplateItemDetail, error)

func DerefMapValues 

func DerefMapValues(m map[string]*parametersv1alpha1.ParametersInFile) map[string]parametersv1alpha1.ParametersInFile

func DoMerge 

func DoMerge(baseData map[string]string,
	patch map[string]parametersv1alpha1.ParametersInFile,
	paramsDefs []*parametersv1alpha1.ParametersDefinition,
	configDescs []parametersv1alpha1.ComponentConfigDescription) (map[string]string, error)

func FindParameterSchema 

func FindParameterSchema[T any](parametersMap map[string]T, paramKey string) (T, bool)

func GetComponentConfigDescription 

func GetComponentConfigDescription(pdcr *parametersv1alpha1.ParamConfigRendererSpec, name string) *parametersv1alpha1.ComponentConfigDescription

func GetComponentConfigDescriptions 

func GetComponentConfigDescriptions(pdcr *parametersv1alpha1.ParamConfigRendererSpec, tpl string) []parametersv1alpha1.ComponentConfigDescription

func GetConfigTemplateItem 

func GetConfigTemplateItem(parameterSpec *parametersv1alpha1.ComponentParameterSpec, name string) *parametersv1alpha1.ConfigTemplateItemDetail

func GetItemStatus 

func GetItemStatus(status *parametersv1alpha1.ComponentParameterStatus, name string) *parametersv1alpha1.ConfigTemplateItemDetailStatus

func GetParameter 

func GetParameter(spec *parametersv1alpha1.ParameterSpec, component string) *parametersv1alpha1.ComponentParametersSpec

func GetParameterReconfiguringStatus 

func GetParameterReconfiguringStatus(status *parametersv1alpha1.ComponentReconfiguringStatus, name string) *parametersv1alpha1.ReconfiguringStatus

func GetParameterStatus 

func GetParameterStatus(status *parametersv1alpha1.ParameterStatus, name string) *parametersv1alpha1.ComponentReconfiguringStatus

func GetPodSelector 

func GetPodSelector(pd *parametersv1alpha1.ParametersDefinitionSpec) *metav1.LabelSelector

func GetUpdatedParametersReconciledPhase 

func GetUpdatedParametersReconciledPhase(configMap *corev1.ConfigMap,
	item parametersv1alpha1.ConfigTemplateItemDetail,
	status *parametersv1alpha1.ConfigTemplateItemDetailStatus) parametersv1alpha1.ParameterPhase

GetUpdatedParametersReconciledPhase gets the configuration phase

func HasValidParameterTemplate 

func HasValidParameterTemplate(pcr *parametersv1alpha1.ParamConfigRenderer) bool

func IsApplyUpdatedParameters 

func IsApplyUpdatedParameters(configMap *corev1.ConfigMap, item parametersv1alpha1.ConfigTemplateItemDetail) bool

IsApplyUpdatedParameters checks if the configuration is changed

func IsFailedPhase 

func IsFailedPhase(phase parametersv1alpha1.ParameterPhase) bool

func IsParameterFinished 

func IsParameterFinished(phase parametersv1alpha1.ParameterPhase) bool

func IsRerender 

func IsRerender(configMap *corev1.ConfigMap, item parametersv1alpha1.ConfigTemplateItemDetail) bool

IsRerender checks if the configuration template is changed

func MergeAndValidateConfigs 

func MergeAndValidateConfigs(baseConfigs map[string]string,
	updatedParams []core.ParamPairs,
	paramsDefs []*parametersv1alpha1.ParametersDefinition,
	configDescs []parametersv1alpha1.ComponentConfigDescription) (map[string]string, error)

MergeAndValidateConfigs merges and validates configuration files

func MergeComponentParameter 

func MergeComponentParameter(expected *parametersv1alpha1.ComponentParameter, existing *parametersv1alpha1.ComponentParameter, mutate MutateFunc) *parametersv1alpha1.ComponentParameter

func NeedDynamicReloadAction 

func NeedDynamicReloadAction(pd *parametersv1alpha1.ParametersDefinitionSpec) bool

func NewValueManager 

func NewValueManager(paramsDefs []*parametersv1alpha1.ParametersDefinition, configs []parametersv1alpha1.ComponentConfigDescription) *valueManager

func ParametersDefinitionTerminalPhases 

func ParametersDefinitionTerminalPhases(status parametersv1alpha1.ParametersDefinitionStatus, generation int64) bool

func ParametersDrivenConfigRenderTerminalPhases 

func ParametersDrivenConfigRenderTerminalPhases(status parametersv1alpha1.ParamConfigRendererStatus, generation int64) bool

func ParametersTerminalPhases 

func ParametersTerminalPhases(status parametersv1alpha1.ParameterStatus, generation int64) bool

func ReloadStaticParameters 

func ReloadStaticParameters(pd *parametersv1alpha1.ParametersDefinitionSpec) bool

func RerenderParametersTemplate 

func RerenderParametersTemplate(reconcileCtx *render.ReconcileCtx,
	item parametersv1alpha1.ConfigTemplateItemDetail,
	configRender *parametersv1alpha1.ParamConfigRenderer,
	parametersDefs []*parametersv1alpha1.ParametersDefinition) (*corev1.ConfigMap, error)

func ResolveCmpdParametersDefs 

func ResolveCmpdParametersDefs(ctx context.Context, reader client.Reader, cmpd *appsv1.ComponentDefinition) (*parametersv1alpha1.ParamConfigRenderer, []*parametersv1alpha1.ParametersDefinition, error)

func ResolveComponentConfigRender 

func ResolveComponentConfigRender(ctx context.Context, reader client.Reader, cmpd *appsv1.ComponentDefinition) (*parametersv1alpha1.ParamConfigRenderer, error)

func ResolveComponentTemplate 

func ResolveComponentTemplate(ctx context.Context, reader client.Reader, cmpd *appsv1.ComponentDefinition) (map[string]*corev1.ConfigMap, error)

func ResolveConfigParameterSchema 

func ResolveConfigParameterSchema(paramDef *parametersv1alpha1.ParametersDefinition, configTemplate *appsv1.ComponentFileTemplate) map[string]*ParameterMeta

func ResolveParameterTemplate 

func ResolveParameterTemplate(cmpd appsv1.ComponentDefinitionSpec, pcr parametersv1alpha1.ParamConfigRendererSpec) []appsv1.ComponentFileTemplate

func ResolveReloadServerGRPCPort 

func ResolveReloadServerGRPCPort(containers []corev1.Container) (int32, error)

func ResolveShardingReference 

func ResolveShardingReference(ctx context.Context, reader client.Reader, comp *appsv1.Component) (*appsv1.ClusterSharding, error)

func ResourcesPayloadForComponent 

func ResourcesPayloadForComponent(resources corev1.ResourceRequirements) any

func UpdateConfigPayload 

func UpdateConfigPayload(config *parametersv1alpha1.ComponentParameterSpec, component *appsv1.ComponentSpec, configRender *parametersv1alpha1.ParamConfigRendererSpec, sharding *appsv1.ClusterSharding) error

UpdateConfigPayload updates the configuration payload

Types

type Fetcher 

type Fetcher struct {
	ResourceFetcher[Fetcher]
}

func NewResourceFetcher 

func NewResourceFetcher(resourceCtx *render.ResourceCtx) *Fetcher

type MutateFunc 

type MutateFunc func(dest, expected *parametersv1alpha1.ConfigTemplateItemDetail)

type ParameterMeta 

type ParameterMeta struct {
	FileName           string
	ConfigTemplateName string
}

type ResourceFetcher 

type ResourceFetcher[T any] struct {
	*render.ResourceCtx

	ClusterObj      *appsv1.Cluster
	ComponentObj    *appsv1.Component
	ComponentDefObj *appsv1.ComponentDefinition
	ClusterComObj   *appsv1.ClusterComponentSpec

	ConfigMapObj          *corev1.ConfigMap
	ComponentParameterObj *parametersv1alpha1.ComponentParameter
	// contains filtered or unexported fields
}

func (*ResourceFetcher[T]) Cluster 

func (r *ResourceFetcher[T]) Cluster() *T

func (*ResourceFetcher[T]) Complete 

func (r *ResourceFetcher[T]) Complete() error

func (*ResourceFetcher[T]) ComponentAndComponentDef 

func (r *ResourceFetcher[T]) ComponentAndComponentDef() *T

func (*ResourceFetcher[T]) ComponentParameter 

func (r *ResourceFetcher[T]) ComponentParameter() *T

func (*ResourceFetcher[T]) ComponentSpec 

func (r *ResourceFetcher[T]) ComponentSpec() *T

func (*ResourceFetcher[T]) ConfigMap 

func (r *ResourceFetcher[T]) ConfigMap(configSpec string) *T

func (*ResourceFetcher[T]) Init 

func (r *ResourceFetcher[T]) Init(ctx *render.ResourceCtx, object *T) *T

func (*ResourceFetcher[T]) Wrap 

func (r *ResourceFetcher[T]) Wrap(fn func() error) (ret *T)

type Result 

type Result struct {
	Phase      parametersv1alpha1.ParameterPhase `json:"phase"`
	Revision   string                            `json:"revision"`
	Policy     string                            `json:"policy"`
	ExecResult string                            `json:"execResult"`

	SucceedCount  int32 `json:"succeedCount"`
	ExpectedCount int32 `json:"expectedCount"`

	Retry   bool   `json:"retry"`
	Failed  bool   `json:"failed"`
	Message string `json:"message"`
}

type TemplateMerger 

type TemplateMerger interface {
	// contains filtered or unexported methods
}

func NewTemplateMerger 

func NewTemplateMerger(template parametersv1alpha1.ConfigTemplateExtension,
	templateRender render.TemplateRender,
	configSpec appsv1.ComponentFileTemplate,
	paramsDefs []*parametersv1alpha1.ParametersDefinition,
	configRender *parametersv1alpha1.ParamConfigRenderer,
) (TemplateMerger, error)

Source Files

View all Source files

Directories

Path Synopsis
mocks

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.