util

Documentation

Index

• Constants
• Variables
• func AppendEnv(a []corev1.EnvVar, b []corev1.EnvVar) []corev1.EnvVar
• func AppendEnvIfPresent(envs []corev1.EnvVar, name string) []corev1.EnvVar
• func AppendOverwriteEnv(a []corev1.EnvVar, b []corev1.EnvVar) []corev1.EnvVar
• func BuildStorageVolumeAndVolumeMount(storageVolumes []v1alpha1.StorageVolume, defaultStorageClassName *string, ...) ([]corev1.VolumeMount, []corev1.PersistentVolumeClaim)
• func ClusterClientTLSSecretName(tcName string) string
• func ClusterTLSSecretName(tcName, component string) string
• func CombineStringMap(maps ...map[string]string) map[string]string
• func CopyStringMap(src map[string]string) map[string]string
• func DMClientTLSSecretName(dcName string) string
• func Encode(obj interface{}) (string, error)
• func FixedLengthRandomPasswordBytes() []byte
• func GetDSN(tc *v1alpha1.TidbCluster, password string) string
• func GetDeleteSlotsNumber(annotations map[string]string) (int32, error)
• func GetOrdinalFromPodName(podName string) (int32, error)
• func GetPodName(tc *v1alpha1.TidbCluster, memberType v1alpha1.MemberType, ordinal int32) string
• func GetPodOrdinals(tc *v1alpha1.TidbCluster, memberType v1alpha1.MemberType) (sets.Int32, error)
• func GetStatefulSetName(tc *v1alpha1.TidbCluster, memberType v1alpha1.MemberType) string
• func IsOwnedByTidbCluster(obj metav1.Object) (bool, *metav1.OwnerReference)
• func IsPodOrdinalNotExceedReplicas(pod *corev1.Pod, sts *appsv1.StatefulSet) (bool, error)
• func IsStatefulSetScaling(set *appsv1.StatefulSet) bool
• func IsStatefulSetUpgrading(set *appsv1.StatefulSet) bool
• func IsSubMapOf(first map[string]string, second map[string]string) bool
• func MatchLabelFromStoreLabels(storeLabels []*metapb.StoreLabel, componentLabel string) bool
• func MustNewRequirement(key string, op selection.Operator, vals []string) *labels.Requirement
• func OpenDB(ctx context.Context, dsn string) (*sql.DB, error)
• func OrdinalPVCName(memberType v1alpha1.MemberType, setName string, ordinal int32) string
• func RandomBytes(length int) []byte
• func ResolvePVCFromPod(pod *corev1.Pod, pvcLister corelisterv1.PersistentVolumeClaimLister) ([]*corev1.PersistentVolumeClaim, error)
• func RetainManagedFields(desiredSvc, existedSvc *corev1.Service)
• func SetPassword(ctx context.Context, db *sql.DB, password string) error
• func StatefulSetEqual(new apps.StatefulSet, old apps.StatefulSet) (equal bool, podTemplateCheckedAndNotEqual bool)
• func TiDBAuthTokenJWKSSecretName(tcName string) string
• func TiDBClientTLSSecretName(tcName string, secretName *string) string
• func TiDBServerTLSSecretName(tcName string) string
• func VolumeClaimTemplate(r corev1.ResourceRequirements, metaName string, storageClassName *string) corev1.PersistentVolumeClaim
• type SortEnvByName
  • func (e SortEnvByName) Len() int
  • func (e SortEnvByName) Less(i, j int) bool
  • func (e SortEnvByName) Swap(i, j int)

Constants

const (
	// LastAppliedConfigAnnotation is annotation key of last applied configuration
	LastAppliedConfigAnnotation = "pingcap.com/last-applied-configuration"
)

Variables

var (
	ClusterClientTLSPath   = "/var/lib/cluster-client-tls"
	ClusterAssetsTLSPath   = "/var/lib/cluster-assets-tls"
	TiDBClientTLSPath      = "/var/lib/tidb-client-tls"
	BRBinPath              = "/var/lib/br-bin"
	DumplingBinPath        = "/var/lib/dumpling-bin"
	LightningBinPath       = "/var/lib/lightning-bin"
	ClusterClientVolName   = "cluster-client-tls"
	DMClusterClientVolName = "dm-cluster-client-tls"
)

Functions

func AppendEnv

func AppendEnv(a []corev1.EnvVar, b []corev1.EnvVar) []corev1.EnvVar

AppendEnv appends envs `b` into `a` ignoring envs whose names already exist in `b`. Note that this will not change relative order of envs.

func AppendEnvIfPresent

func AppendEnvIfPresent(envs []corev1.EnvVar, name string) []corev1.EnvVar

AppendEnvIfPresent appends the given environment if present

func AppendOverwriteEnv

func AppendOverwriteEnv(a []corev1.EnvVar, b []corev1.EnvVar) []corev1.EnvVar

AppendOverwriteEnv appends envs b into a and overwrites the envs whose names already exist in b. Note that this will not change relative order of envs.

func BuildStorageVolumeAndVolumeMount

func BuildStorageVolumeAndVolumeMount(storageVolumes []v1alpha1.StorageVolume, defaultStorageClassName *string, memberType v1alpha1.MemberType) ([]corev1.VolumeMount, []corev1.PersistentVolumeClaim)

BuildStorageVolumeAndVolumeMount builds VolumeMounts and PVCs for volumes declaired in spec.storageVolumes of ComponentSpec

func ClusterClientTLSSecretName

func ClusterClientTLSSecretName(tcName string) string

func ClusterTLSSecretName

func ClusterTLSSecretName(tcName, component string) string

func CombineStringMap

func CombineStringMap(maps ...map[string]string) map[string]string

CombineStringMap merges maps into a new map. NOTE: if the same key exists in multiple source maps, the value of the first one will be kept. so we suggest to :

• pass the map generated by TiDB-Operator as the first argument.
• pass components' map (labels or annotations) before cluster's.

func CopyStringMap

func CopyStringMap(src map[string]string) map[string]string

CopyStringMap copy annotations to a new string map

func DMClientTLSSecretName

func DMClientTLSSecretName(dcName string) string

func Encode

func Encode(obj interface{}) (string, error)

func FixedLengthRandomPasswordBytes

func FixedLengthRandomPasswordBytes() []byte

FixedLengthRandomPasswordBytes generates a random password

func GetDSN

func GetDSN(tc *v1alpha1.TidbCluster, password string) string

GetDSN get tidb dsn

func GetDeleteSlotsNumber

func GetDeleteSlotsNumber(annotations map[string]string) (int32, error)

func GetOrdinalFromPodName

func GetOrdinalFromPodName(podName string) (int32, error)

func GetPodName

func GetPodName(tc *v1alpha1.TidbCluster, memberType v1alpha1.MemberType, ordinal int32) string

func GetPodOrdinals

func GetPodOrdinals(tc *v1alpha1.TidbCluster, memberType v1alpha1.MemberType) (sets.Int32, error)

GetPodOrdinals gets desired ordials of member in given TidbCluster.

func GetStatefulSetName

func GetStatefulSetName(tc *v1alpha1.TidbCluster, memberType v1alpha1.MemberType) string

func IsOwnedByTidbCluster

func IsOwnedByTidbCluster(obj metav1.Object) (bool, *metav1.OwnerReference)

IsOwnedByTidbCluster checks if the given object is owned by TidbCluster. Schema Kind and Group are checked, Version is ignored.

func IsPodOrdinalNotExceedReplicas

func IsPodOrdinalNotExceedReplicas(pod *corev1.Pod, sts *appsv1.StatefulSet) (bool, error)

func IsStatefulSetScaling

func IsStatefulSetScaling(set *appsv1.StatefulSet) bool

func IsStatefulSetUpgrading

func IsStatefulSetUpgrading(set *appsv1.StatefulSet) bool

func IsSubMapOf

func IsSubMapOf(first map[string]string, second map[string]string) bool

IsSubMapOf returns whether the first map is a sub map of the second map

func MatchLabelFromStoreLabels

func MatchLabelFromStoreLabels(storeLabels []*metapb.StoreLabel, componentLabel string) bool

func MustNewRequirement

func MustNewRequirement(key string, op selection.Operator, vals []string) *labels.Requirement

MustNewRequirement calls NewRequirement and panics on failure.

func OpenDB

func OpenDB(ctx context.Context, dsn string) (*sql.DB, error)

OpenDB opens db

func OrdinalPVCName

func OrdinalPVCName(memberType v1alpha1.MemberType, setName string, ordinal int32) string

func RandomBytes

func RandomBytes(length int) []byte

RandomBytes generates some random bytes that can be used as a token or as a key

func ResolvePVCFromPod

func ResolvePVCFromPod(pod *corev1.Pod, pvcLister corelisterv1.PersistentVolumeClaimLister) ([]*corev1.PersistentVolumeClaim, error)

ResolvePVCFromPod parses pod volumes definition, and returns all PVCs mounted by this pod

If the Pod don't have any PVC, return error 'NotFound'.

func RetainManagedFields

func RetainManagedFields(desiredSvc, existedSvc *corev1.Service)

RetainManagedFields retains the fields in the old object that are managed by kube-controller-manager, such as node ports

func SetPassword

func SetPassword(ctx context.Context, db *sql.DB, password string) error

SetPassword set tidb password

func StatefulSetEqual

func StatefulSetEqual(new apps.StatefulSet, old apps.StatefulSet) (equal bool, podTemplateCheckedAndNotEqual bool)

StatefulSetEqual compares the new Statefulset's spec with old Statefulset's last applied config

func TiDBAuthTokenJWKSSecretName

func TiDBAuthTokenJWKSSecretName(tcName string) string

func TiDBClientTLSSecretName

func TiDBClientTLSSecretName(tcName string, secretName *string) string

func TiDBServerTLSSecretName

func TiDBServerTLSSecretName(tcName string) string

func VolumeClaimTemplate

func VolumeClaimTemplate(r corev1.ResourceRequirements, metaName string, storageClassName *string) corev1.PersistentVolumeClaim

Types

type SortEnvByName

type SortEnvByName []corev1.EnvVar

SortEnvByName implements sort.Interface to sort env list by name.

func (SortEnvByName) Len

func (e SortEnvByName) Len() int

func (SortEnvByName) Less

func (e SortEnvByName) Less(i, j int) bool

func (SortEnvByName) Swap

func (e SortEnvByName) Swap(i, j int)