package
1.7.0-alpha.3
Repository: https://github.com/pingcap/tidb-operator.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

AnnAdditionalProm adds additional prometheus scarping configuration annotation for the pod which has multiple metrics endpoint we assumes that the metrics path is as same as the previous metrics path.
AnnProm adds annotations for prometheus scraping metrics.
No description provided by the author
No description provided by the author
DefaultBrFedCLIConfig returns the default command line configuration.
DefaultCLIConfig returns the default command line configuration.
DeploymentPodSpecChanged checks whether the new deployment differs with the old one's last-applied-config.
DiscoveryMemberName returns the name of tidb discovery.
DMMasterMemberName returns dm-master member name.
DMMasterPeerMemberName returns dm-master peer service name.
DMWorkerMemberName returns dm-worker member name.
DMWorkerPeerMemberName returns dm-worker peer service name.
EmptyClone create an clone of the resource with the same name and namespace (if namespace-scoped), with other fields unset.
No description provided by the author
No description provided by the author
GetBackupOwnerRef returns Backup's OwnerReference.
GetBackupScheduleOwnerRef returns BackupSchedule's OwnerReference.
GetDeploymentLastAppliedPodTemplate set last applied pod template from Deployment's annotation.
GetDMOwnerRef returns DMCluster's OwnerReference.
GetFedVolumeBackupScheduleOwnerRef returns FedVolumeBackupSchedule's OwnerReference.
GetMasterClient gets the master client from the DMCluster.
GetMasterClient gets the master client from the DMCluster.
GetOwnerRef returns TidbCluster's OwnerReference.
GetPDClient tries to return an available PDClient If the pdClient built from the PD service name is unavailable, try to build another one with the ClientURL in the PeerMembers.
GetPDMSClient tries to return an available PDMSClient.
GetRestoreOwnerRef returns Restore's OwnerReference.
GetServiceType returns member's service type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GuaranteedUpdate will retry the updateFunc to mutate the object until success, updateFunc is expected to capture the object reference from the caller context to avoid unnecessary type casting.
IgnoreErrorf returns a IgnoreError.
InferObjectKind infers the object kind.
No description provided by the author
No description provided by the author
IsIgnoreError returns whether err is a IgnoreError.
IsRequeueError returns whether err is a RequeueError.
MemberConfigMapName returns the default ConfigMap name of the specified member type Deprecated TODO: remove after helm get totally abandoned.
MemberName return a component member name.
NewBrFedDependencies is used to construct the dependencies.
NewControllerRateLimiter returns a RateLimiter, which limit the request rate by the stricter one's desicion of two RateLimiters: ItemExponentialFailureRateLimiter and BucketRateLimiter.
NewDefaultTiCDCControl returns a defaultTiCDCControl instance.
NewDefaultTiDBControl returns a defaultTiDBControl instance.
NewDefaultTiProxyControl returns a defaultTiProxyControl instance.
NewDependencies is used to construct the dependencies.
NewFakeBackupConditionUpdater returns a FakeBackupConditionUpdater.
NewFakeBackupControl returns a FakeBackupControl.
NewFakeBackupScheduleStatusUpdater returns a FakeBackupScheduleStatusUpdater.
No description provided by the author
NewFakeConfigMapControl returns a FakeConfigMapControl.
NewFakeDependencies returns a fake dependencies for testing.
NewFakeDMClusterControl returns a FakeDMClusterControl.
NewFakeFedVolumeBackupControl returns a FakeFedVolumeBackupControl.
NewFakeGeneralPVCControl returns a FakeGeneralPVCControl.
NewFakeGenericControl returns a FakeGenericControl.
NewFakeJobControl returns a FakeJobControl.
NewFakeMasterClient creates a fake master client that is set as the master client.
No description provided by the author
NewFakePDClient creates a fake pdclient that is set as the pd client.
NewFakePDClientWithAddress creates a fake pdclient that is set as the pd client.
NewFakePDMSClient creates a fake pdmsclient that is set as the pdms client.
NewFakePodControl returns a FakePodControl.
NewFakePVCControl returns a FakePVCControl.
NewFakePVControl returns a FakePVControl.
NewFakeRestoreConditionUpdater returns a FakeRestoreConditionUpdater.
NewFakeRestoreControl returns a FakeRestoreControl.
NewFakeSecretControl returns a FakeSecretControl.
NewFakeServiceControl returns a FakeServiceControl.
NewFakeStatefulSetControl returns a FakeStatefulSetControl.
NewFakeTiCDCControl returns a FakeTiCDCControl instance.
NewFakeTidbClusterControl returns a FakeTidbClusterControl.
NewFakeTiDBControl returns a FakeTiDBControl instance.
NewFakeTiKVClient creates a fake tikvclient that is set as the tikv client.
NewFakeTiProxyControl returns a FakeTiProxyControl instance.
NewFakeVolumeBackupScheduleStatusUpdater returns a FakeVolumeBackupScheduleStatusUpdater.
returns a BackupConditionUpdaterInterface that updates the Status of a Backup,.
NewRealBackupControl creates a new BackupControlInterface.
returns a BackupScheduleStatusUpdaterInterface that updates the Status of a BackupSchedule, using the supplied client and bsLister.
NewRealSecretControl creates a new SecretControlInterface.
NewRealDMClusterControl creates a new DMClusterControlInterface.
NewRealFedVolumeBackupControl creates a new FedVolumeBackupControlInterface.
NewRealGeneralPVCControl creates a new GeneralPVCControlInterface.
No description provided by the author
NewRealJobControl creates a new JobControlInterface.
NewRealPodControl creates a new PodControlInterface.
NewRealPVCControl creates a new PVCControlInterface.
NewRealPVControl creates a new PVControlInterface.
returns a RestoreConditionUpdaterInterface that updates the Status of a Restore,.
NewRealRestoreControl creates a new RestoreControlInterface.
NewRealSecretControl creates a new SecretControlInterface.
NewRealServiceControl creates a new ServiceControlInterface.
NewRealStatefuSetControl returns a StatefulSetControlInterface.
NewRealTidbClusterControl creates a new TidbClusterControlInterface.
NewRealVolumeBackupScheduleStatusUpdater returns a VolumeBackupScheduleStatusUpdaterInterface that updates the Status of a VolumeBackupScheduleStatus, using the supplied client and bsLister.
NewSimpleClientDependencies returns a dependencies using NewSimpleClientset useful for testing.
NewSimpleFedClientDependencies returns a dependencies using NewSimpleClientset useful for testing.
NewTypedControl wraps a GenericControlInterface to a TypedControlInterface.
No description provided by the author
PDMemberName returns pd member name.
PDMSMemberName returns pd microservice member name.
PDMSPeerMemberName returns pd microservice peer service name.
PDMSTrimName returns last `-` separated string for `PDMSMemberName`.
No description provided by the author
PDPeerMemberName returns pd peer service name.
PumpMemberName returns pump member name.
For backward compatibility, pump peer member name do not has -peer suffix PumpPeerMemberName returns pump peer service name.
RequeueErrorf returns a RequeueError.
ServiceEqual compares the new Service's spec with old Service's last applied config.
SetServiceLastAppliedConfigAnnotation set last applied config info to Service's annotation.
TiCDCMemberName returns ticdc member name.
TiCDCPeerMemberName returns ticdc peer service name.
TiDBInitializerMemberName returns TiDBInitializer member name.
TiDBInitSecret returns tidb init secret name.
TiDBMemberName returns tidb member name.
TiDBPeerMemberName returns tidb peer service name.
TiFlashMemberName returns tiflash member name.
TiFlashPeerMemberName returns tiflash peer service name.
TiKVCapacity returns string resource requirement.
TiKVMemberName returns tikv member name.
TiKVPeerMemberName returns tikv peer service name.
TiProxyMemberName returns tiproxy member name.
TiProxyPeerMemberName returns tiproxy peer service name.
WatchForController watch the object change from informer and add it's controller to workqueue.
WacthForObject watch the object change from informer and add it to workqueue.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
LastAppliedConfigAnnotation is annotation key of last applied configuration.
LastAppliedPodTemplate is annotation key of the last applied pod template.
https://github.com/pingcap/tidb/blob/master/owner/manager.go#L183 NotDDLOwnerError is the error message which was returned when the tidb node is not a ddl owner.

# Variables

BackupControllerKind contains the schema.GroupVersionKind for backup controller type.
controllerKind contains the schema.GroupVersionKind for tidbcluster controller type.
DMControllerKind contains the schema.GroupVersionKind for dmcluster controller type.
ExternalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints.
FedVolumeBackupControllerKind contains the schema.GroupVersionKind for federation VolumeBackup controller type.
FedVolumeBackupScheduleControllerKind contains the schema.GroupVersionKind for federation VolumeBackupSchedule controller type.
FedVolumeRestoreControllerKind contains the schema.GroupVersionKind for federation VolumeRestore controller type.
RestoreControllerKind contains the schema.GroupVersionKind for restore controller type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

BackupUpdateStatus represents the status of a backup to be updated.
BrFedCLIConfig is used to save the configuration of br-federation-manager read from command line.
No description provided by the author
BrFedDependencies is used to store all shared dependent resources to avoid pass parameters everywhere.
No description provided by the author
CLIConfig is used save all configuration read from command line parameters.
No description provided by the author
No description provided by the author
Dependencies is used to store all shared dependent resources to avoid pass parameters everywhere.
FakeBackupConditionUpdater is a fake BackupConditionUpdaterInterface.
FakeBackupControl is a fake BackupControlInterface.
FakeBackupScheduleStatusUpdater is a fake BackupScheduleStatusUpdaterInterface.
FakeConfigMapControl is a fake ConfigMapControlInterface.
FakeDMClusterControl is a fake DMClusterControlInterface.
FakeFedVolumeBackupControl is a fake FedVolumeBackupControlInterface.
FakeGeneralPVCControl is a fake GeneralPVCControlInterface.
FakeGenericControl is a fake GenericControlInterface.
FakeJobControl is a fake JobControlInterface.
FakePodControl is a fake PodControlInterface.
FakePVCControl is a fake PVCControlInterface.
FakePVControl is a fake PVControlInterface.
FakeRestoreConditionUpdater is a fake RestoreConditionUpdaterInterface.
FakeRestoreControl is a fake RestoreControlInterface.
FakeSecretControl is a fake SecretControlInterface.
FakeServiceControl is a fake ServiceControlInterface.
FakeStatefulSetControl is a fake StatefulSetControlInterface.
FakeTiCDCControl is a fake implementation of TiCDCControlInterface.
FakeTidbClusterControl is a fake TidbClusterControlInterface.
FakeTiDBControl is a fake implementation of TiDBControlInterface.
No description provided by the author
FakeVolumeBackupScheduleStatusUpdater is a fake VolumeBackupScheduleStatusUpdaterInterface.
IgnoreError is used to ignore this item, this error type shouldn't be considered as a real error, no need to requeue.
RequestTracker is used by unit test for mocking request error.
RequeueError is used to requeue the item, this error type should't be considered as a real error.
RestoreUpdateStatus represents the status of a restore to be updated.

# Interfaces

BackupConditionUpdaterInterface enables updating Backup conditions.
BackupControlInterface manages Backups used in BackupSchedule.
BackupScheduleStatusUpdaterInterface is an interface used to update the BackupScheduleStatus associated with a BackupSchedule.
ConfigMapControlInterface manages configmaps used by TiDB clusters.
DMClusterControlInterface manages DMClusters.
FedVolumeBackupControlInterface manages federation VolumeBackups used in VolumeBackupSchedule.
GeneralPVCControlInterface manages PVCs used in backup and restore's pvc.
GenericControlInterface manages generic object that managed by an arbitrary controller.
JobControlInterface manages Jobs used in backup、restore and clean.
PodControlInterface manages Pods used in TidbCluster.
PVCControlInterface manages PVCs used in TidbCluster.
PVControlInterface manages PVs used in TidbCluster.
RestoreConditionUpdaterInterface enables updating Restore conditions.
RestoreControlInterface manages Restores.
SecretControlInterface manages certificates used by TiDB clusters.
ServiceControlInterface manages Services used in TidbCluster.
StatefulSetControlInterface defines the interface that uses to create, update, and delete StatefulSets,.
TiCDCControlInterface is the interface that knows how to manage ticdc captures.
TidbClusterControlInterface manages TidbClusters.
TiDBControlInterface is the interface that knows how to manage tidb peers.
TiProxyControlInterface is the interface that knows how to control tiproxy clusters.
TypedControlInterface is a wrapper to manage typed object that managed by an arbitrary controller.
VolumeBackupScheduleStatusUpdaterInterface is an interface used to update the VolumeBackupScheduleStatus associated with a VolumeBackupSchedule.

# Type aliases

No description provided by the author
MergeFn knows how to merge a desired object into the current object.