label

Documentation

Index

• Constants
• type Label
  • func New() Label
  • func NewBackup() Label
  • func NewBackupSchedule() Label
  • func NewRestore() Label
  • func (l Label) Backup(val string) Label
  • func (l Label) BackupJob() Label
  • func (l Label) BackupSchedule(val string) Label
  • func (l Label) CleanJob() Label
  • func (l Label) Component(name string) Label
  • func (l Label) ComponentType() string
  • func (l Label) Instance(name string) Label
  • func (l Label) IsPD() bool
  • func (l Label) IsTiDB() bool
  • func (l Label) IsTiKV() bool
  • func (l Label) LabelSelector() *metav1.LabelSelector
  • func (l Label) Labels() map[string]string
  • func (l Label) Namespace(name string) Label
  • func (l Label) PD() Label
  • func (l Label) Restore(val string) Label
  • func (l Label) RestoreJob() Label
  • func (l Label) Selector() (labels.Selector, error)
  • func (l Label) String() string
  • func (l Label) TiDB() Label
  • func (l Label) TiKV() Label

Constants

const (

	// ManagedByLabelKey is Kubernetes recommended label key, it represents the tool being used to manage the operation of an application
	// For resources managed by TiDB Operator, its value is always tidb-operator
	ManagedByLabelKey string = "app.kubernetes.io/managed-by"
	// ComponentLabelKey is Kubernetes recommended label key, it represents the component within the architecture
	ComponentLabelKey string = "app.kubernetes.io/component"
	// NameLabelKey is Kubernetes recommended label key, it represents the name of the application
	// It should always be tidb-cluster in our case.
	NameLabelKey string = "app.kubernetes.io/name"
	// InstanceLabelKey is Kubernetes recommended label key, it represents a unique name identifying the instance of an application
	// It's set by helm when installing a release
	InstanceLabelKey string = "app.kubernetes.io/instance"

	// NamespaceLabelKey is label key used in PV for easy querying
	NamespaceLabelKey string = "app.kubernetes.io/namespace"

	// ClusterIDLabelKey is cluster id label key
	ClusterIDLabelKey string = "tidb.pingcap.com/cluster-id"
	// StoreIDLabelKey is store id label key
	StoreIDLabelKey string = "tidb.pingcap.com/store-id"
	// MemberIDLabelKey is member id label key
	MemberIDLabelKey string = "tidb.pingcap.com/member-id"

	// BackupScheduleLabelKey is backup schedule key
	BackupScheduleLabelKey string = "tidb.pingcap.com/backup-schedule"

	// BackupLabelKey is backup key
	BackupLabelKey string = "tidb.pingcap.com/backup"

	// RestoreLabelKey is restore key
	RestoreLabelKey string = "tidb.pingcap.com/restore"

	// BackupProtectionFinalizer is the name of finalizer on backups
	BackupProtectionFinalizer string = "tidb.pingcap.com/backup-protection"

	// AnnFailTiDBScheduler is for injecting a failure into the TiDB custom scheduler
	// A pod with this annotation will produce an error when scheduled.
	AnnFailTiDBScheduler string = "tidb.pingcap.com/fail-scheduler"
	// AnnPodNameKey is pod name annotation key used in PV/PVC for synchronizing tidb cluster meta info
	AnnPodNameKey string = "tidb.pingcap.com/pod-name"
	// AnnPVCDeferDeleting is pvc defer deletion annotation key used in PVC for defer deleting PVC
	AnnPVCDeferDeleting = "tidb.pingcap.com/pvc-defer-deleting"
	// AnnPVCPodScheduling is pod scheduling annotation key, it represents whether the pod is scheduling
	AnnPVCPodScheduling = "tidb.pingcap.com/pod-scheduling"
	// AnnTiDBPartition is pod annotation which TiDB pod should upgrade to
	AnnTiDBPartition string = "tidb.pingcap.com/tidb-partition"
	// AnnTiKVPartition is pod annotation which TiKV pod should upgrade to
	AnnTiKVPartition string = "tidb.pingcap.com/tikv-partition"
	// AnnForceUpgradeKey is tc annotation key to indicate whether force upgrade should be done
	AnnForceUpgradeKey = "tidb.pingcap.com/force-upgrade"
	// AnnPDDeferDeleting is pd pod annotation key  in pod for defer for deleting pod
	AnnPDDeferDeleting = "tidb.pingcap.com/pd-defer-deleting"
	// AnnSysctlInit is pod annotation key to indicate whether configuring sysctls with init container
	AnnSysctlInit = "tidb.pingcap.com/sysctl-init"

	// AnnForceUpgradeVal is tc annotation value to indicate whether force upgrade should be done
	AnnForceUpgradeVal = "true"
	// AnnSysctlInitVal is pod annotation value to indicate whether configuring sysctls with init container
	AnnSysctlInitVal = "true"

	// PDLabelVal is PD label value
	PDLabelVal string = "pd"
	// TiDBLabelVal is TiDB label value
	TiDBLabelVal string = "tidb"
	// TiKVLabelVal is TiKV label value
	TiKVLabelVal string = "tikv"

	// CleanJobLabelVal is clean job label value
	CleanJobLabelVal string = "clean"
	// RestoreJobLabelVal is restore job label value
	RestoreJobLabelVal string = "restore"
	// BackupJobLabelVal is backup job label value
	BackupJobLabelVal string = "backup"
)

Types

type Label

type Label map[string]string

Label is the label field in metadata

func New

func New() Label

New initialize a new Label for components of tidb cluster

func NewBackup

func NewBackup() Label

NewBackup initialize a new Label for Jobs of bakcup

func NewBackupSchedule

func NewBackupSchedule() Label

NewBackupSchedule initialize a new Label for backups of bakcup schedule

func NewRestore

func NewRestore() Label

NewRestore initialize a new Label for Jobs of restore

func (Label) Backup

func (l Label) Backup(val string) Label

Backup assigns specific value to backup key in label

func (Label) BackupJob

func (l Label) BackupJob() Label

BackupJob assigns backup to component key in label

func (Label) BackupSchedule

func (l Label) BackupSchedule(val string) Label

BackupSchedule assigns specific value to backup schedule key in label

func (Label) CleanJob

func (l Label) CleanJob() Label

CleanJob assigns clean to component key in label

func (Label) Component

func (l Label) Component(name string) Label

Component adds component kv pair to label

func (Label) ComponentType

func (l Label) ComponentType() string

ComponentType returns component type

func (Label) Instance

func (l Label) Instance(name string) Label

Instance adds instance kv pair to label

func (Label) IsPD

func (l Label) IsPD() bool

IsPD returns whether label is a PD

func (Label) IsTiDB

func (l Label) IsTiDB() bool

IsTiDB returns whether label is a TiDB

func (Label) IsTiKV

func (l Label) IsTiKV() bool

IsTiKV returns whether label is a TiKV

func (Label) LabelSelector

func (l Label) LabelSelector() *metav1.LabelSelector

LabelSelector gets LabelSelector from label

func (Label) Labels

func (l Label) Labels() map[string]string

Labels converts label to map[string]string

func (Label) Namespace

func (l Label) Namespace(name string) Label

Namespace adds namespace kv pair to label

func (Label) PD

func (l Label) PD() Label

PD assigns pd to component key in label

func (Label) Restore

func (l Label) Restore(val string) Label

Restore assigns specific value to restore key in label

func (Label) RestoreJob

func (l Label) RestoreJob() Label

RestoreJob assigns restore to component key in label

func (Label) Selector

func (l Label) Selector() (labels.Selector, error)

Selector gets labels.Selector from label

func (Label) String

func (l Label) String() string

String converts label to a string

func (Label) TiDB

func (l Label) TiDB() Label

TiDB assigns tidb to component key in label

func (Label) TiKV

func (l Label) TiKV() Label

TiKV assigns tikv to component key in label