component

Documentation

Index

• func BuildRestoreInfoFromBackup(reqCtx intctrlutil.RequestCtx, cli client.Client, cluster appsv1alpha1.Cluster, ...) error
• func BuildRestoredInfo(reqCtx intctrlutil.RequestCtx, cli client.Client, namespace string, ...) error
• func BuildTolerations(cluster *appsv1alpha1.Cluster, ...) ([]corev1.Toleration, error)
• func GenerateComponentEnvName(clusterName, componentName string) string
• func GenerateConnCredential(clusterName string) string
• func GetClusterDefCompByName(clusterDef appsv1alpha1.ClusterDefinition, cluster appsv1alpha1.Cluster, ...) *appsv1alpha1.ClusterComponentDefinition
• func GetEnvReplacementMapForConnCredential(clusterName string) map[string]string
• func GetReplacementMapForBuiltInEnv(clusterName, clusterUID, componentName string) map[string]string
• func GetRestoredInitContainerName(backupName string) string
• func ReplaceNamedVars(namedValuesMap map[string]string, targetVar string, limits int, matchAll bool) string
• func ReplaceSecretEnvVars(namedValuesMap map[string]string, envs []corev1.EnvVar) []corev1.EnvVar
• type MonitorConfig
• type SynthesizedComponent
  • func BuildComponent(reqCtx intctrlutil.RequestCtx, cluster appsv1alpha1.Cluster, ...) (*SynthesizedComponent, error)
  • func BuildSynthesizedComponent(reqCtx intctrlutil.RequestCtx, cli client.Client, cluster appsv1alpha1.Cluster, ...) (*SynthesizedComponent, error)
  • func (r *SynthesizedComponent) GetPrimaryIndex() int32

Functions

func BuildRestoreInfoFromBackup

func BuildRestoreInfoFromBackup(reqCtx intctrlutil.RequestCtx, cli client.Client, cluster appsv1alpha1.Cluster,
	component *SynthesizedComponent) error

BuildRestoreInfoFromBackup restore from snapshot or datafile Deprecated: using DoRestore function instead.

func BuildRestoredInfo

func BuildRestoredInfo(reqCtx intctrlutil.RequestCtx,
	cli client.Client,
	namespace string,
	component *SynthesizedComponent,
	backupName string) error

BuildRestoredInfo builds restore infos when restore from backup, such as init-container, pvc dataSource. Deprecated: using DoRestore function instead.

func BuildTolerations

func BuildTolerations(cluster *appsv1alpha1.Cluster, clusterCompSpec *appsv1alpha1.ClusterComponentSpec) ([]corev1.Toleration, error)

BuildTolerations builds tolerations from config

func GenerateComponentEnvName

func GenerateComponentEnvName(clusterName, componentName string) string

func GenerateConnCredential

func GenerateConnCredential(clusterName string) string

func GetClusterDefCompByName

func GetClusterDefCompByName(clusterDef appsv1alpha1.ClusterDefinition,
	cluster appsv1alpha1.Cluster,
	compName string) *appsv1alpha1.ClusterComponentDefinition

func GetEnvReplacementMapForConnCredential

func GetEnvReplacementMapForConnCredential(clusterName string) map[string]string

GetEnvReplacementMapForConnCredential gets the replacement map for connect credential

func GetReplacementMapForBuiltInEnv

func GetReplacementMapForBuiltInEnv(clusterName, clusterUID, componentName string) map[string]string

GetReplacementMapForBuiltInEnv gets the replacement map for KubeBlocks built-in environment variables.

func GetRestoredInitContainerName

func GetRestoredInitContainerName(backupName string) string

GetRestoredInitContainerName gets the restore init container name. Deprecated: using DoRestore function instead.

func ReplaceNamedVars

func ReplaceNamedVars(namedValuesMap map[string]string, targetVar string, limits int, matchAll bool) string

ReplaceNamedVars replaces the placeholder in targetVar if it is match and returns the replaced result

func ReplaceSecretEnvVars

func ReplaceSecretEnvVars(namedValuesMap map[string]string, envs []corev1.EnvVar) []corev1.EnvVar

ReplaceSecretEnvVars replaces the env secret value with namedValues and returns new envs

Types

type MonitorConfig

type MonitorConfig struct {
	Enable     bool   `json:"enable"`
	BuiltIn    bool   `json:"builtIn"`
	ScrapePort int32  `json:"scrapePort,omitempty"`
	ScrapePath string `json:"scrapePath,omitempty"`
}

type SynthesizedComponent

type SynthesizedComponent struct {
	ClusterDefName        string                                 `json:"clusterDefName,omitempty"`
	ClusterName           string                                 `json:"clusterName,omitempty"`
	ClusterUID            string                                 `json:"clusterUID,omitempty"`
	Name                  string                                 `json:"name,omitempty"`
	CompDefName           string                                 `json:"compDefName,omitempty"`
	CharacterType         string                                 `json:"characterType,omitempty"`
	MinAvailable          *intstr.IntOrString                    `json:"minAvailable,omitempty"`
	Replicas              int32                                  `json:"replicas"`
	WorkloadType          v1alpha1.WorkloadType                  `json:"workloadType,omitempty"`
	StatelessSpec         *v1alpha1.StatelessSetSpec             `json:"statelessSpec,omitempty"`
	StatefulSpec          *v1alpha1.StatefulSetSpec              `json:"statefulSpec,omitempty"`
	ConsensusSpec         *v1alpha1.ConsensusSetSpec             `json:"consensusSpec,omitempty"`
	ReplicationSpec       *v1alpha1.ReplicationSetSpec           `json:"replicationSpec,omitempty"`
	PrimaryIndex          *int32                                 `json:"primaryIndex,omitempty"`
	PodSpec               *corev1.PodSpec                        `json:"podSpec,omitempty"`
	Services              []corev1.Service                       `json:"services,omitempty"`
	Probes                *v1alpha1.ClusterDefinitionProbes      `json:"probes,omitempty"`
	VolumeClaimTemplates  []corev1.PersistentVolumeClaimTemplate `json:"volumeClaimTemplates,omitempty"`
	Monitor               *MonitorConfig                         `json:"monitor,omitempty"`
	EnabledLogs           []string                               `json:"enabledLogs,omitempty"`
	LogConfigs            []v1alpha1.LogConfig                   `json:"logConfigs,omitempty"`
	ConfigTemplates       []v1alpha1.ComponentConfigSpec         `json:"configTemplates,omitempty"`
	ScriptTemplates       []v1alpha1.ComponentTemplateSpec       `json:"scriptTemplates,omitempty"`
	HorizontalScalePolicy *v1alpha1.HorizontalScalePolicy        `json:"horizontalScalePolicy,omitempty"`
	TLS                   bool                                   `json:"tls"`
	Issuer                *v1alpha1.Issuer                       `json:"issuer,omitempty"`
	VolumeTypes           []v1alpha1.VolumeTypeSpec              `json:"volumeTypes,omitempty"`
	CustomLabelSpecs      []v1alpha1.CustomLabelSpec             `json:"customLabelSpecs,omitempty"`
	ComponentDef          string                                 `json:"componentDef,omitempty"`
	ServiceAccountName    string                                 `json:"serviceAccountName,omitempty"`
	StatefulSetWorkload   v1alpha1.StatefulSetWorkload
}

func BuildComponent

func BuildComponent(reqCtx intctrlutil.RequestCtx,
	cluster appsv1alpha1.Cluster,
	clusterDef appsv1alpha1.ClusterDefinition,
	clusterCompDef appsv1alpha1.ClusterComponentDefinition,
	clusterCompSpec appsv1alpha1.ClusterComponentSpec,
	clusterCompVers ...*appsv1alpha1.ClusterComponentVersion,
) (*SynthesizedComponent, error)

func BuildSynthesizedComponent

func BuildSynthesizedComponent(reqCtx intctrlutil.RequestCtx,
	cli client.Client,
	cluster appsv1alpha1.Cluster,
	clusterDef appsv1alpha1.ClusterDefinition,
	clusterCompDef appsv1alpha1.ClusterComponentDefinition,
	clusterCompSpec appsv1alpha1.ClusterComponentSpec,
	clusterCompVers ...*appsv1alpha1.ClusterComponentVersion,
) (*SynthesizedComponent, error)

func (*SynthesizedComponent) GetPrimaryIndex

func (r *SynthesizedComponent) GetPrimaryIndex() int32

GetPrimaryIndex provides PrimaryIndex value getter, if PrimaryIndex is a nil pointer it's treated as 0, return -1 if function receiver is nil.