configuration

Documentation

Index

• func BuiltInCustomFunctions(c *configTemplateBuilder, component *component.SynthesizedComponent, ...) *gotemplate.BuiltInObjectsFunc
• func CheckAndUpdateItemStatus(updated *appsv1alpha1.Configuration, item appsv1alpha1.ConfigurationItemDetail, ...)
• func CheckEnvFrom(container *corev1.Container, cmName string) bool
• func DoMerge(baseData map[string]string, patch map[string]appsv1alpha1.ConfigParams, ...) (map[string]string, error)
• func GetConfigManagerGRPCPort(containers []corev1.Container) (int32, error)
• func NewConfigReconcileTask(resourceCtx *ResourceCtx, cluster *appsv1alpha1.Cluster, ...) *configOperator
• func NewCreatePipeline(ctx ReconcileCtx) *pipeline
• func NewReconcilePipeline(ctx ReconcileCtx, item appsv1alpha1.ConfigurationItemDetail, ...) *updatePipeline
• func SyncEnvConfigmap(configSpec appsv1alpha1.ComponentConfigSpec, cmObj *corev1.ConfigMap, ...) error
• func UpdateCMConfigSpecLabels(cm *corev1.ConfigMap, configSpec appsv1alpha1.ComponentConfigSpec)
• type DynamicComponentInfo
• type Fetcher
  • func NewResourceFetcher(resourceCtx *ResourceCtx) *Fetcher
• type ReconcileCtx
• type ResourceCtx
• type ResourceDefinition
• type ResourceFetcher
  • func (r *ResourceFetcher[T]) Cluster() *T
  • func (r *ResourceFetcher[T]) ClusterComponent() *T
  • func (r *ResourceFetcher[T]) ClusterDef() *T
  • func (r *ResourceFetcher[T]) ClusterVer() *T
  • func (r *ResourceFetcher[T]) Complete() error
  • func (r *ResourceFetcher[T]) ConfigConstraints(ccName string) *T
  • func (r *ResourceFetcher[T]) ConfigMap(configSpec string) *T
  • func (r *ResourceFetcher[T]) Configuration() *T
  • func (r *ResourceFetcher[T]) Init(ctx *ResourceCtx, object *T) *T
  • func (r *ResourceFetcher[T]) Wrap(fn func() error) (ret *T)
• type TemplateMerger
  • func NewTemplateMerger(template appsv1alpha1.ConfigTemplateExtension, ctx context.Context, ...) (TemplateMerger, error)

Functions

func BuiltInCustomFunctions

func BuiltInCustomFunctions(c *configTemplateBuilder, component *component.SynthesizedComponent, localObjs []client.Object) *gotemplate.BuiltInObjectsFunc

BuiltInCustomFunctions builds a map of customized functions for KubeBlocks

func CheckAndUpdateItemStatus

func CheckAndUpdateItemStatus(updated *appsv1alpha1.Configuration, item appsv1alpha1.ConfigurationItemDetail, reversion string)

func CheckEnvFrom

func CheckEnvFrom(container *corev1.Container, cmName string) bool

func DoMerge

func DoMerge(baseData map[string]string, patch map[string]appsv1alpha1.ConfigParams, cc *appsv1alpha1.ConfigConstraint, configSpec appsv1alpha1.ComponentConfigSpec) (map[string]string, error)

func GetConfigManagerGRPCPort

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

func NewConfigReconcileTask

func NewConfigReconcileTask(resourceCtx *ResourceCtx,
	cluster *appsv1alpha1.Cluster,
	component *component.SynthesizedComponent,
	podSpec *corev1.PodSpec,
	localObjs []client.Object,
) *configOperator

func NewCreatePipeline

func NewCreatePipeline(ctx ReconcileCtx) *pipeline

func NewReconcilePipeline

func NewReconcilePipeline(ctx ReconcileCtx, item appsv1alpha1.ConfigurationItemDetail, itemStatus *appsv1alpha1.ConfigurationItemDetailStatus, configSpec *appsv1alpha1.ComponentConfigSpec) *updatePipeline

func SyncEnvConfigmap

func SyncEnvConfigmap(configSpec appsv1alpha1.ComponentConfigSpec, cmObj *corev1.ConfigMap, cc *appsv1alpha1.ConfigConstraintSpec, cli client.Client, ctx context.Context) error

func UpdateCMConfigSpecLabels

func UpdateCMConfigSpecLabels(cm *corev1.ConfigMap, configSpec appsv1alpha1.ComponentConfigSpec)

Types

type DynamicComponentInfo

type DynamicComponentInfo struct {
	Name       string             `json:"name"`
	Containers []corev1.Container `json:"containers,omitempty"`
}

DynamicComponentInfo records information dynamically generated by component controller

type Fetcher

type Fetcher struct {
	ResourceFetcher[Fetcher]
}

func NewResourceFetcher

func NewResourceFetcher(resourceCtx *ResourceCtx) *Fetcher

type ReconcileCtx

type ReconcileCtx struct {
	*ResourceCtx

	Cluster   *appsv1alpha1.Cluster
	Component *component.SynthesizedComponent
	PodSpec   *corev1.PodSpec

	Cache []client.Object
}

type ResourceCtx

type ResourceCtx struct {
	context.Context

	Err    error
	Client client.Client

	Namespace     string
	ClusterName   string
	ComponentName string
}

type ResourceDefinition

type ResourceDefinition struct {
	MemorySize int64 `json:"memorySize,omitempty"`
	CoreNum    int64 `json:"coreNum,omitempty"`
}

type ResourceFetcher

type ResourceFetcher[T any] struct {
	*ResourceCtx

	ClusterObj *appsv1alpha1.Cluster
	// Deprecated: this API will be removed from version 0.9.0
	ClusterDefObj *appsv1alpha1.ClusterDefinition
	// Deprecated: use ComponentDefinition instead
	ClusterVerObj *appsv1alpha1.ClusterVersion

	ConfigMapObj        *corev1.ConfigMap
	ConfigurationObj    *appsv1alpha1.Configuration
	ConfigConstraintObj *appsv1alpha1.ConfigConstraint

	ClusterComObj *appsv1alpha1.ClusterComponentSpec
	// contains filtered or unexported fields
}

func (*ResourceFetcher[T]) Cluster

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

func (*ResourceFetcher[T]) ClusterComponent

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

func (*ResourceFetcher[T]) ClusterDef

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

ClusterDef get clusterDefinition cr Deprecated: use ComponentDefinition instead

func (*ResourceFetcher[T]) ClusterVer

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

ClusterVer get clusterVersion cr Deprecated: this API will be removed from version 0.9.0

func (*ResourceFetcher[T]) Complete

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

func (*ResourceFetcher[T]) ConfigConstraints

func (r *ResourceFetcher[T]) ConfigConstraints(ccName string) *T

func (*ResourceFetcher[T]) ConfigMap

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

func (*ResourceFetcher[T]) Configuration

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

func (*ResourceFetcher[T]) Init

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

func (*ResourceFetcher[T]) Wrap

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

type TemplateMerger

type TemplateMerger interface {

	// Merge merges the baseData with the data from the template.
	Merge(baseData map[string]string, updatedData map[string]string) (map[string]string, error)
	// contains filtered or unexported methods
}

func NewTemplateMerger

func NewTemplateMerger(template appsv1alpha1.ConfigTemplateExtension, ctx context.Context, cli client.Client, builder *configTemplateBuilder, configSpec appsv1alpha1.ComponentConfigSpec, ccSpec *appsv1alpha1.ConfigConstraintSpec) (TemplateMerger, error)