plan

Documentation

Index

• func BuiltInCustomFunctions(c *configTemplateBuilder, component *component.SynthesizedComponent, ...) *gotemplate.BuiltInObjectsFunc
• func CheckTLSSecretRef(ctx context.Context, cli client2.ReadonlyClient, namespace string, ...) error
• func ComposeTLSSecret(namespace, clusterName, componentName string) (*v1.Secret, error)
• func DoPITRCleanup(ctx context.Context, cli client.Client, cluster *appsv1alpha1.Cluster) error
• func DoPITRIfNeed(ctx context.Context, cli client.Client, cluster *appsv1alpha1.Cluster) (shouldRequeue bool, err error)
• func DoPITRPrepare(ctx context.Context, cli client.Client, cluster *appsv1alpha1.Cluster, ...) error
• func GenerateTLSSecretName(clusterName, componentName string) string
• func GetTLSKeyWord(cType string) string
• func RenderConfigNScriptFiles(clusterVersion *appsv1alpha1.ClusterVersion, cluster *appsv1alpha1.Cluster, ...) ([]client.Object, error)
• type PointInTimeRecoveryManager
• type ResourceDefinition

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 CheckTLSSecretRef

func CheckTLSSecretRef(ctx context.Context, cli client2.ReadonlyClient, namespace string,
	secretRef *dbaasv1alpha1.TLSSecretRef) error

func ComposeTLSSecret

func ComposeTLSSecret(namespace, clusterName, componentName string) (*v1.Secret, error)

ComposeTLSSecret composes a TSL secret object. REVIEW/TODO:

1. missing public function doc
2. should avoid using Go template to call a function, this is too hacky & costly, should just call underlying registered Go template function.

func DoPITRCleanup

func DoPITRCleanup(ctx context.Context, cli client.Client, cluster *appsv1alpha1.Cluster) error

DoPITRCleanup cleanups the resources and annotations after recovery

func DoPITRIfNeed

func DoPITRIfNeed(ctx context.Context, cli client.Client, cluster *appsv1alpha1.Cluster) (shouldRequeue bool, err error)

DoPITRIfNeed if needs to run restore job and copy data for pitr

func DoPITRPrepare

func DoPITRPrepare(ctx context.Context, cli client.Client, cluster *appsv1alpha1.Cluster, component *component.SynthesizedComponent) error

DoPITRPrepare prepares init container and pvc before point in time recovery

func GenerateTLSSecretName

func GenerateTLSSecretName(clusterName, componentName string) string

func GetTLSKeyWord

func GetTLSKeyWord(cType string) string

func RenderConfigNScriptFiles

func RenderConfigNScriptFiles(clusterVersion *appsv1alpha1.ClusterVersion,
	cluster *appsv1alpha1.Cluster,
	component *component.SynthesizedComponent,
	obj client.Object,
	podSpec *corev1.PodSpec,
	localObjs []client.Object,
	ctx context.Context,
	cli client.Client) ([]client.Object, error)

RenderConfigNScriptFiles generates volumes for PodTemplate, volumeMount for container, rendered configTemplate and scriptTemplate, and generates configManager sidecar for the reconfigure operation. TODO rename this function, this function name is not very reasonable, but there is no suitable name.

Types

type PointInTimeRecoveryManager

type PointInTimeRecoveryManager struct {
	client.Client
	Ctx     context.Context
	Cluster *appsv1alpha1.Cluster
	// contains filtered or unexported fields
}

PointInTimeRecoveryManager pitr manager functions 1. get the latest base backup 2. get the next earliest backup 3. add log pvc by datasource volume snapshot 4. create init container to prepare log 5. run recovery jobs 6. cleanup

type ResourceDefinition

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