| title | summary | category |
|---|---|---|
TiDB Operator API Document |
Reference of TiDB Operator API |
how-to |
Package v1alpha1 is the v1alpha1 version of the API.
Resource Types:- Backup
- BackupSchedule
- DMCluster
- Restore
- TidbCluster
- TidbClusterAutoScaler
- TidbInitializer
- TidbMonitor
Backup is a backup of tidb cluster.
| Field | Description | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
pingcap.com/v1alpha1
|
||||||||||||||||||||||||||||||||||
kindstring |
Backup |
||||||||||||||||||||||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||
specBackupSpec |
|
||||||||||||||||||||||||||||||||||
statusBackupStatus |
BackupSchedule is a backup schedule of tidb cluster.
| Field | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
pingcap.com/v1alpha1
|
||||||||||||||||
kindstring |
BackupSchedule |
||||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
specBackupScheduleSpec |
|
||||||||||||||||
statusBackupScheduleStatus |
DMCluster is the control script’s spec
| Field | Description | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
pingcap.com/v1alpha1
|
||||||||||||||||||||||||||||||||||||||
kindstring |
DMCluster |
||||||||||||||||||||||||||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||
specDMClusterSpec |
Spec defines the behavior of a dm cluster
|
||||||||||||||||||||||||||||||||||||||
statusDMClusterStatus |
Most recently observed status of the dm cluster |
Restore represents the restoration of backup of a tidb cluster.
| Field | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
pingcap.com/v1alpha1
|
||||||||||||||||||||||||||||||
kindstring |
Restore |
||||||||||||||||||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||
specRestoreSpec |
|
||||||||||||||||||||||||||||||
statusRestoreStatus |
TidbCluster is the control script’s spec
| Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
pingcap.com/v1alpha1
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kindstring |
TidbCluster |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specTidbClusterSpec |
Spec defines the behavior of a tidb cluster
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statusTidbClusterStatus |
Most recently observed status of the tidb cluster |
TidbClusterAutoScaler is the control script’s spec
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
apiVersionstring |
pingcap.com/v1alpha1
|
||||||
kindstring |
TidbClusterAutoScaler |
||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
specTidbClusterAutoScalerSpec |
Spec describes the state of the TidbClusterAutoScaler
|
||||||
statusTidbClusterAutoScalerStatus |
Status describe the status of the TidbClusterAutoScaler |
TidbInitializer is a TiDB cluster initializing job
| Field | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
pingcap.com/v1alpha1
|
||||||||||||||||||||||
kindstring |
TidbInitializer |
||||||||||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||
specTidbInitializerSpec |
Spec defines the desired state of TidbInitializer
|
||||||||||||||||||||||
statusTidbInitializerStatus |
Most recently observed status of the TidbInitializer |
TidbMonitor encode the spec and status of the monitoring component of a TiDB cluster
| Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
pingcap.com/v1alpha1
|
||||||||||||||||||||||||||||||||||||||||||||||
kindstring |
TidbMonitor |
||||||||||||||||||||||||||||||||||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||
specTidbMonitorSpec |
Spec defines the desired state of TidbMonitor
|
||||||||||||||||||||||||||||||||||||||||||||||
statusTidbMonitorStatus |
Most recently observed status of the TidbMonitor |
(Appears on: BasicAutoScalerSpec)
AutoResource describes the resource type definitions
| Field | Description |
|---|---|
cpuk8s.io/apimachinery/pkg/api/resource.Quantity |
CPU defines the CPU of this resource type |
memoryk8s.io/apimachinery/pkg/api/resource.Quantity |
Memory defines the memory of this resource type |
storagek8s.io/apimachinery/pkg/api/resource.Quantity |
Storage defines the storage of this resource type |
countint32 |
Count defines the max availabel count of this resource type |
(Appears on: BasicAutoScalerSpec)
AutoRule describes the rules for auto-scaling with PD API
| Field | Description |
|---|---|
max_thresholdfloat64 |
MaxThreshold defines the threshold to scale out |
min_thresholdfloat64 |
MinThreshold defines the threshold to scale in, not applicable to |
resource_types[]string |
ResourceTypes defines the resource types that can be used for scaling |
(Appears on: BackupSpec, RestoreSpec)
BRConfig contains config for BR
| Field | Description |
|---|---|
clusterstring |
ClusterName of backup/restore cluster |
clusterNamespacestring |
Namespace of backup/restore cluster |
dbstring |
Deprecated from BR v4.0.3. Please use |
tablestring |
Deprecated from BR v4.0.3. Please use |
logLevelstring |
LogLevel is the log level |
statusAddrstring |
StatusAddr is the HTTP listening address for the status report service. Set to empty string to disable |
concurrencyuint32 |
Concurrency is the size of thread pool on each node that execute the backup task |
rateLimituint |
RateLimit is the rate limit of the backup task, MB/s per node |
timeAgostring |
TimeAgo is the history version of the backup task, e.g. 1m, 1h |
checksumbool |
Checksum specifies whether to run checksum after backup |
sendCredToTikvbool |
SendCredToTikv specifies whether to send credentials to TiKV |
onLinebool |
OnLine specifies whether online during restore |
options[]string |
Options means options for backup data to remote storage with BR. These options has highest priority. |
(Appears on: BackupStatus)
BackupCondition describes the observed state of a Backup at a certain point.
| Field | Description |
|---|---|
typeBackupConditionType |
|
statusKubernetes core/v1.ConditionStatus |
|
lastTransitionTimeKubernetes meta/v1.Time |
|
reasonstring |
|
messagestring |
(Appears on: BackupCondition, BackupStatus)
BackupConditionType represents a valid condition of a Backup.
(Appears on: BackupSchedule)
BackupScheduleSpec contains the backup schedule specification for a tidb cluster.
| Field | Description |
|---|---|
schedulestring |
Schedule specifies the cron string used for backup scheduling. |
pausebool |
Pause means paused backupSchedule |
maxBackupsint32 |
MaxBackups is to specify how many backups we want to keep 0 is magic number to indicate un-limited backups. if MaxBackups and MaxReservedTime are set at the same time, MaxReservedTime is preferred and MaxBackups is ignored. |
maxReservedTimestring |
MaxReservedTime is to specify how long backups we want to keep. |
backupTemplateBackupSpec |
BackupTemplate is the specification of the backup structure to get scheduled. |
storageClassNamestring |
(Optional)
The storageClassName of the persistent volume for Backup data storage if not storage class name set in BackupSpec. Defaults to Kubernetes default storage class. |
storageSizestring |
StorageSize is the request storage size for backup job |
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference |
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. |
(Appears on: BackupSchedule)
BackupScheduleStatus represents the current state of a BackupSchedule.
| Field | Description |
|---|---|
lastBackupstring |
LastBackup represents the last backup. |
lastBackupTimeKubernetes meta/v1.Time |
LastBackupTime represents the last time the backup was successfully created. |
allBackupCleanTimeKubernetes meta/v1.Time |
AllBackupCleanTime represents the time when all backup entries are cleaned up |
(Appears on: Backup, BackupScheduleSpec)
BackupSpec contains the backup specification for a tidb cluster.
| Field | Description |
|---|---|
resourcesKubernetes core/v1.ResourceRequirements |
|
fromTiDBAccessConfig |
From is the tidb cluster that needs to backup. |
backupTypeBackupType |
Type is the backup type for tidb cluster. |
tikvGCLifeTimestring |
TikvGCLifeTime is to specify the safe gc life time for backup. The time limit during which data is retained for each GC, in the format of Go Duration. When a GC happens, the current time minus this value is the safe point. |
StorageProviderStorageProvider |
(Members of StorageProvider configures where and how backups should be stored. |
storageClassNamestring |
(Optional)
The storageClassName of the persistent volume for Backup data storage. Defaults to Kubernetes default storage class. |
storageSizestring |
StorageSize is the request storage size for backup job |
brBRConfig |
BRConfig is the configs for BR |
dumplingDumplingConfig |
DumplingConfig is the configs for dumpling |
tolerations[]Kubernetes core/v1.Toleration |
(Optional)
Base tolerations of backup Pods, components may add more tolerations upon this respectively |
toolImagestring |
(Optional)
ToolImage specifies the tool image used in |
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference |
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. |
tableFilter[]string |
TableFilter means Table filter expression for ‘db.table’ matching. BR supports this from v4.0.3. |
affinityKubernetes core/v1.Affinity |
(Optional)
Affinity of backup Pods |
useKMSbool |
Use KMS to decrypt the secrets |
serviceAccountstring |
Specify service account of backup |
cleanPolicyCleanPolicyType |
CleanPolicy denotes whether to clean backup data when the object is deleted from the cluster, if not set, the backup data will be retained |
(Appears on: Backup)
BackupStatus represents the current status of a backup.
| Field | Description |
|---|---|
backupPathstring |
BackupPath is the location of the backup. |
timeStartedKubernetes meta/v1.Time |
TimeStarted is the time at which the backup was started. |
timeCompletedKubernetes meta/v1.Time |
TimeCompleted is the time at which the backup was completed. |
backupSizeReadablestring |
BackupSizeReadable is the data size of the backup. the difference with BackupSize is that its format is human readable |
backupSizeint64 |
BackupSize is the data size of the backup. |
commitTsstring |
CommitTs is the snapshot time point of tidb cluster. |
phaseBackupConditionType |
Phase is a user readable state inferred from the underlying Backup conditions |
conditions[]BackupCondition |
BackupStorageType represents the backend storage type of backup.
(Appears on: BackupSpec, RestoreSpec)
BackupType represents the backup type.
(Appears on: RemoteWriteSpec)
BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints
| Field | Description |
|---|---|
usernameKubernetes core/v1.SecretKeySelector |
The secret in the service monitor namespace that contains the username for authentication. |
passwordKubernetes core/v1.SecretKeySelector |
The secret in the service monitor namespace that contains the password for authentication. |
(Appears on: TidbAutoScalerSpec, TikvAutoScalerSpec)
BasicAutoScalerSpec describes the basic spec for auto-scaling
| Field | Description |
|---|---|
rulesmap[k8s.io/api/core/v1.ResourceName]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.AutoRule |
Rules defines the rules for auto-scaling with PD API |
scaleInIntervalSecondsint32 |
(Optional)
ScaleInIntervalSeconds represents the duration seconds between each auto-scaling-in If not set, the default ScaleInIntervalSeconds will be set to 500 |
scaleOutIntervalSecondsint32 |
(Optional)
ScaleOutIntervalSeconds represents the duration seconds between each auto-scaling-out If not set, the default ScaleOutIntervalSeconds will be set to 300 |
externalExternalConfig |
(Optional)
External makes the auto-scaler controller able to query the external service to fetch the recommended replicas for TiKV/TiDB |
resourcesmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.AutoResource |
(Optional)
Resources represent the resource type definitions that can be used for TiDB/TiKV The key is resource_type name of the resource |
(Appears on: TidbAutoScalerStatus, TikvAutoScalerStatus)
BasicAutoScalerStatus describe the basic auto-scaling status
| Field | Description |
|---|---|
lastAutoScalingTimestampKubernetes meta/v1.Time |
(Optional)
LastAutoScalingTimestamp describes the last auto-scaling timestamp for the component(tidb/tikv) |
(Appears on: TiDBConfig)
Binlog is the config for binlog.
| Field | Description |
|---|---|
enablebool |
optional |
write-timeoutstring |
(Optional)
Optional: Defaults to 15s |
ignore-errorbool |
(Optional)
If IgnoreError is true, when writing binlog meets error, TiDB would ignore the error. |
binlog-socketstring |
(Optional)
Use socket file to write binlog, for compatible with kafka version tidb-binlog. |
strategystring |
(Optional)
The strategy for sending binlog to pump, value can be “range,omitempty” or “hash,omitempty” now. Optional: Defaults to range |
(Appears on: BackupSpec)
CleanPolicyType represents the clean policy of backup data in remote storage
(Appears on: DMMonitorSpec)
ClusterRef reference to a TidbCluster
| Field | Description |
|---|---|
namespacestring |
(Optional)
Namespace is the namespace that TidbCluster object locates, default to the same namespace with TidbMonitor |
namestring |
Name is the name of TidbCluster object |
clusterDomainstring |
(Optional)
ClusterDomain is the domain of TidbCluster object |
(Appears on: TiFlashConfig)
CommonConfig is the configuration of TiFlash process.
| Field | Description |
|---|---|
tmp_pathstring |
(Optional)
Optional: Defaults to “/data0/tmp” |
path_realtime_modebool |
(Optional)
Optional: Defaults to false |
mark_cache_sizeint64 |
(Optional)
Optional: Defaults to 5368709120 |
minmax_index_cache_sizeint64 |
(Optional)
Optional: Defaults to 5368709120 |
flashFlash |
(Optional) |
loggerFlashLogger |
(Optional) |
securityFlashSecurity |
(Optional) |
ComponentAccessor is the interface to access component details, which respects the cluster-level properties and component-level overrides
(Appears on: MasterSpec, PDSpec, PumpSpec, TiCDCSpec, TiDBSpec, TiFlashSpec, TiKVSpec, WorkerSpec)
ComponentSpec is the base spec of each component, the fields should always accessed by the BasicSpec() method to respect the cluster-level properties
| Field | Description |
|---|---|
imagestring |
(Deprecated) Image of the component
Use |
versionstring |
(Optional)
Version of the component. Override the cluster-level version if non-empty Optional: Defaults to cluster-level setting |
imagePullPolicyKubernetes core/v1.PullPolicy |
(Optional)
ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Optional: Defaults to cluster-level setting |
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference |
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. |
hostNetworkbool |
(Optional)
Whether Hostnetwork of the component is enabled. Override the cluster-level setting if present Optional: Defaults to cluster-level setting |
affinityKubernetes core/v1.Affinity |
(Optional)
Affinity of the component. Override the cluster-level setting if present. Optional: Defaults to cluster-level setting |
priorityClassNamestring |
(Optional)
PriorityClassName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting |
schedulerNamestring |
(Optional)
SchedulerName of the component. Override the cluster-level one if present Optional: Defaults to cluster-level setting |
nodeSelectormap[string]string |
(Optional)
NodeSelector of the component. Merged into the cluster-level nodeSelector if non-empty Optional: Defaults to cluster-level setting |
annotationsmap[string]string |
(Optional)
Annotations of the component. Merged into the cluster-level annotations if non-empty Optional: Defaults to cluster-level setting |
tolerations[]Kubernetes core/v1.Toleration |
(Optional)
Tolerations of the component. Override the cluster-level tolerations if non-empty Optional: Defaults to cluster-level setting |
podSecurityContextKubernetes core/v1.PodSecurityContext |
(Optional)
PodSecurityContext of the component |
configUpdateStrategyConfigUpdateStrategy |
(Optional)
ConfigUpdateStrategy of the component. Override the cluster-level updateStrategy if present Optional: Defaults to cluster-level setting |
env[]Kubernetes core/v1.EnvVar |
(Optional)
List of environment variables to set in the container, like v1.Container.Env. Note that the following env names cannot be used and will be overridden by TiDB Operator builtin envs - NAMESPACE - TZ - SERVICE_NAME - PEER_SERVICE_NAME - HEADLESS_SERVICE_NAME - SET_NAME - HOSTNAME - CLUSTER_NAME - POD_NAME - BINLOG_ENABLED - SLOW_LOG_FILE |
initContainers[]Kubernetes core/v1.Container |
(Optional)
Init containers of the components |
additionalContainers[]Kubernetes core/v1.Container |
(Optional)
Additional containers of the component. |
additionalVolumes[]Kubernetes core/v1.Volume |
(Optional)
Additional volumes of component pod. |
additionalVolumeMounts[]Kubernetes core/v1.VolumeMount |
Additional volume mounts of component pod. |
terminationGracePeriodSecondsint64 |
(Optional)
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
statefulSetUpdateStrategyKubernetes apps/v1.StatefulSetUpdateStrategyType |
(Optional)
StatefulSetUpdateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. |
(Appears on: PrometheusConfiguration)
ConfigMapRef is the external configMap
| Field | Description |
|---|---|
namestring |
|
namespacestring |
(Optional)
if the namespace is omitted, the operator controller would use the Tidbmonitor’s namespace instead. |
(Appears on: ComponentSpec, TidbClusterSpec)
ConfigUpdateStrategy represents the strategy to update configuration
(Appears on: TiKVClient)
CoprocessorCache is the config for coprocessor cache.
| Field | Description |
|---|---|
enablebool |
(Optional)
Whether to enable the copr cache. The copr cache saves the result from TiKV Coprocessor in the memory and reuses the result when corresponding data in TiKV is unchanged, on a region basis. |
capacity-mbfloat64 |
(Optional)
The capacity in MB of the cache. |
admission-max-result-mbfloat64 |
(Optional)
Only cache requests whose result set is small. |
admission-min-process-msuint64 |
(Optional)
Only cache requests takes notable time to process. |
(Appears on: CrdKinds)
| Field | Description |
|---|---|
Kindstring |
|
Pluralstring |
|
SpecNamestring |
|
ShortNames[]string |
|
AdditionalPrinterColums[]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1.CustomResourceColumnDefinition |
| Field | Description |
|---|---|
KindsStringstring |
|
TiDBClusterCrdKind |
|
DMClusterCrdKind |
|
BackupCrdKind |
|
RestoreCrdKind |
|
BackupScheduleCrdKind |
|
TiDBMonitorCrdKind |
|
TiDBInitializerCrdKind |
|
TidbClusterAutoScalerCrdKind |
(Appears on: DMClusterStatus)
DMClusterCondition is dm cluster condition
| Field | Description |
|---|---|
typeDMClusterConditionType |
Type of the condition. |
statusKubernetes core/v1.ConditionStatus |
Status of the condition, one of True, False, Unknown. |
lastUpdateTimeKubernetes meta/v1.Time |
The last time this condition was updated. |
lastTransitionTimeKubernetes meta/v1.Time |
(Optional)
Last time the condition transitioned from one status to another. |
reasonstring |
(Optional)
The reason for the condition’s last transition. |
messagestring |
(Optional)
A human readable message indicating details about the transition. |
(Appears on: DMClusterCondition)
DMClusterConditionType represents a dm cluster condition value.
(Appears on: DMCluster)
DMClusterSpec describes the attributes that a user creates on a dm cluster
| Field | Description |
|---|---|
discoveryDMDiscoverySpec |
Discovery spec |
masterMasterSpec |
(Optional)
dm-master cluster spec |
workerWorkerSpec |
(Optional)
dm-worker cluster spec |
pausedbool |
(Optional)
Indicates that the dm cluster is paused and will not be processed by the controller. |
versionstring |
(Optional)
dm cluster version |
schedulerNamestring |
SchedulerName of DM cluster Pods |
pvReclaimPolicyKubernetes core/v1.PersistentVolumeReclaimPolicy |
Persistent volume reclaim policy applied to the PVs that consumed by DM cluster |
imagePullPolicyKubernetes core/v1.PullPolicy |
ImagePullPolicy of DM cluster Pods |
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference |
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. |
enablePVReclaimbool |
(Optional)
Whether enable PVC reclaim for orphan PVC left by statefulset scale-in Optional: Defaults to false |
tlsClusterTLSCluster |
(Optional)
Whether enable the TLS connection between DM server components Optional: Defaults to nil |
tlsClientSecretNames[]string |
(Optional)
TLSClientSecretNames are the names of secrets which stores mysql/tidb server client certificates that used by dm-master and dm-worker. |
hostNetworkbool |
(Optional)
Whether Hostnetwork is enabled for DM cluster Pods Optional: Defaults to false |
affinityKubernetes core/v1.Affinity |
(Optional)
Affinity of DM cluster Pods |
priorityClassNamestring |
(Optional)
PriorityClassName of DM cluster Pods Optional: Defaults to omitted |
nodeSelectormap[string]string |
(Optional)
Base node selectors of DM cluster Pods, components may add or override selectors upon this respectively |
annotationsmap[string]string |
(Optional)
Base annotations of DM cluster Pods, components may add or override selectors upon this respectively |
timezonestring |
(Optional)
Time zone of DM cluster Pods Optional: Defaults to UTC |
tolerations[]Kubernetes core/v1.Toleration |
(Optional)
Base tolerations of DM cluster Pods, components may add more tolerations upon this respectively |
(Appears on: DMCluster)
DMClusterStatus represents the current status of a dm cluster.
| Field | Description |
|---|---|
masterMasterStatus |
|
workerWorkerStatus |
|
conditions[]DMClusterCondition |
(Optional)
Represents the latest available observations of a dm cluster’s state. |
(Appears on: DMClusterSpec)
DMDiscoverySpec contains details of Discovery members for dm
| Field | Description |
|---|---|
addressstring |
Address indicates the existed TiDB discovery address |
(Appears on: TidbMonitorSpec)
| Field | Description |
|---|---|
clusters[]ClusterRef |
|
initializerInitializerSpec |
(Appears on: MasterConfig, WorkerConfig)
DM common security config
| Field | Description |
|---|---|
ssl-castring |
(Optional)
SSLCA is the path of file that contains list of trusted SSL CAs. |
ssl-certstring |
(Optional)
SSLCert is the path of file that contains X509 certificate in PEM format. |
ssl-keystring |
(Optional)
SSLKey is the path of file that contains X509 key in PEM format. |
cert-allowed-cn[]string |
(Optional)
CertAllowedCN is the Common Name that allowed |
(Appears on: PDConfig)
DashboardConfig is the configuration for tidb-dashboard.
| Field | Description |
|---|---|
tidb-cacert-pathstring |
(Optional) |
tidb-cert-pathstring |
(Optional) |
tidb-key-pathstring |
(Optional) |
public-path-prefixstring |
(Optional) |
internal-proxybool |
(Optional) |
disable-telemetrybool |
(Optional)
When not disabled, usage data will be sent to PingCAP for improving user experience. Optional: Defaults to false Deprecated in PD v4.0.3, use EnableTelemetry instead |
enable-telemetrybool |
(Optional)
When enabled, usage data will be sent to PingCAP for improving user experience. Optional: Defaults to true |
enable-experimentalbool |
(Optional)
When enabled, experimental TiDB Dashboard features will be available. These features are incomplete or not well tested. Suggest not to enable in production. Optional: Defaults to false |
(Appears on: TidbMonitorStatus)
DeploymentStorageStatus is the storage information of the deployment
| Field | Description |
|---|---|
pvNamestring |
PV name |
(Appears on: TidbClusterSpec)
DiscoverySpec contains details of Discovery members
| Field | Description |
|---|---|
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
(Appears on: BackupSpec)
DumplingConfig contains config for dumpling
| Field | Description |
|---|---|
options[]string |
Options means options for backup data to remote storage with dumpling. |
tableFilter[]string |
Deprecated. Please use |
(Appears on: TiDBConfig)
Experimental controls the features that are still experimental: their semantics, interfaces are subject to change. Using these features in the production environment is not recommended.
| Field | Description |
|---|---|
allow-auto-randombool |
(Optional)
Whether enable the syntax like |
allow-expression-indexbool |
(Optional)
Whether enable creating expression index. |
(Appears on: BasicAutoScalerSpec)
ExternalConfig represents the external config.
| Field | Description |
|---|---|
endpointExternalEndpoint |
(Optional)
ExternalEndpoint makes the auto-scaler controller able to query the external service to fetch the recommended replicas for TiKV/TiDB |
maxReplicasint32 |
maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale out. |
(Appears on: ExternalConfig)
ExternalEndpoint describes the external service endpoint which provides the ability to get the tikv/tidb auto-scaling recommended replicas
| Field | Description |
|---|---|
hoststring |
Host indicates the external service’s host |
portint32 |
Port indicates the external service’s port |
pathstring |
Path indicates the external service’s path |
tlsSecretSecretRef |
(Optional)
TLSSecret indicates the Secret which stores the TLS configuration. If set, the operator will use https to communicate to the external service |
(Appears on: Log, PDLogConfig)
| Field | Description |
|---|---|
filenamestring |
(Optional)
Log filename, leave empty to disable file log. |
log-rotatebool |
(Optional)
Deprecated in v4.0.0 Is log rotate enabled. |
max-sizeint |
(Optional)
Max size for a single file, in MB. |
max-daysint |
(Optional)
Max log keep days, default is never deleting. |
max-backupsint |
(Optional)
Maximum number of old log files to retain. |
(Appears on: CommonConfig)
Flash is the configuration of [flash] section.
| Field | Description |
|---|---|
overlap_thresholdfloat64 |
(Optional)
Optional: Defaults to 0.6 |
compact_log_min_periodint32 |
(Optional)
Optional: Defaults to 200 |
flash_clusterFlashCluster |
(Optional) |
proxyFlashProxy |
(Optional) |
(Appears on: Flash)
FlashCluster is the configuration of [flash.flash_cluster] section.
| Field | Description |
|---|---|
logstring |
(Optional)
Optional: Defaults to /data0/logs/flash_cluster_manager.log |
refresh_intervalint32 |
(Optional)
Optional: Defaults to 20 |
update_rule_intervalint32 |
(Optional)
Optional: Defaults to 10 |
master_ttlint32 |
(Optional)
Optional: Defaults to 60 |
(Appears on: CommonConfig)
FlashLogger is the configuration of [logger] section.
| Field | Description |
|---|---|
errorlogstring |
(Optional)
Optional: Defaults to /data0/logs/error.log |
sizestring |
(Optional)
Optional: Defaults to 100M |
logstring |
(Optional)
Optional: Defaults to /data0/logs/server.log |
levelstring |
(Optional)
Optional: Defaults to information |
countint32 |
(Optional)
Optional: Defaults to 10 |
(Appears on: Flash)
FlashProxy is the configuration of [flash.proxy] section.
| Field | Description |
|---|---|
addrstring |
(Optional)
Optional: Defaults to 0.0.0.0:20170 |
advertise-addrstring |
(Optional)
Optional: Defaults to {clusterName}-tiflash-POD_NUM.{clusterName}-tiflash-peer.{namespace}:20170 |
data-dirstring |
(Optional)
Optional: Defaults to /data0/proxy |
configstring |
(Optional)
Optional: Defaults to /data0/proxy.toml |
log-filestring |
(Optional)
Optional: Defaults to /data0/logs/proxy.log |
(Appears on: CommonConfig)
| Field | Description |
|---|---|
ca_pathstring |
(Optional)
Be set automatically by Operator |
cert_pathstring |
(Optional)
Be set automatically by Operator |
key_pathstring |
(Optional)
Be set automatically by Operator |
cert_allowed_cn[]string |
(Optional)
CertAllowedCN is the Common Name that allowed |
(Appears on: ProxyConfig)
FlashServerConfig is the configuration of Proxy server.
| Field | Description |
|---|---|
engine-addrstring |
(Optional)
Default to {clusterName}-tiflash-POD_NUM.{clusterName}-tiflash-peer.{namespace}:3930 |
status-addrstring |
(Optional)
Default to 0.0.0.0:20292 |
advertise-status-addrstring |
(Optional)
Default to {clusterName}-tiflash-POD_NUM.{clusterName}-tiflash-peer.{namespace}:20292 |
TiKVServerConfigTiKVServerConfig |
(Members of |
(Appears on: StorageProvider)
GcsStorageProvider represents the google cloud storage for storing backups.
| Field | Description |
|---|---|
projectIdstring |
ProjectId represents the project that organizes all your Google Cloud Platform resources |
locationstring |
Location in which the gcs bucket is located. |
pathstring |
Path is the full path where the backup is saved. The format of the path must be: “/” |
bucketstring |
Bucket in which to store the backup data. |
storageClassstring |
StorageClass represents the storage class |
objectAclstring |
ObjectAcl represents the access control list for new objects |
bucketAclstring |
BucketAcl represents the access control list for new buckets |
secretNamestring |
SecretName is the name of secret which stores the gcs service account credentials JSON. |
prefixstring |
Prefix of the data path. |
(Appears on: TidbMonitorSpec)
GrafanaSpec is the desired state of grafana
| Field | Description |
|---|---|
MonitorContainerMonitorContainer |
(Members of |
logLevelstring |
|
serviceServiceSpec |
|
usernamestring |
|
passwordstring |
|
envsmap[string]string |
(Optional) |
ingressIngressSpec |
(Optional) |
(Appears on: TidbClusterSpec)
HelperSpec contains details of helper component
| Field | Description |
|---|---|
imagestring |
(Optional)
Image used to tail slow log and set kernel parameters if necessary, must have |
imagePullPolicyKubernetes core/v1.PullPolicy |
(Optional)
ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present Optional: Defaults to the cluster-level setting |
(Appears on: GrafanaSpec, PrometheusSpec)
IngressSpec describe the ingress desired state for the target component
| Field | Description |
|---|---|
hosts[]string |
Hosts describe the hosts for the ingress |
annotationsmap[string]string |
(Optional)
Annotations describe the desired annotations for the ingress |
tls[]Kubernetes extensions/v1beta1.IngressTLS |
(Optional)
TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. |
(Appears on: TidbInitializerStatus)
(Appears on: DMMonitorSpec, TidbMonitorSpec)
InitializerSpec is the desired state of initializer
| Field | Description |
|---|---|
MonitorContainerMonitorContainer |
(Members of |
envsmap[string]string |
(Optional) |
(Appears on: Quota)
Interval is the configuration of [quotas.default.interval] section.
| Field | Description |
|---|---|
durationint32 |
(Optional)
Optional: Defaults to 3600 |
queriesint32 |
(Optional)
Optional: Defaults to 0 |
errorsint32 |
(Optional)
Optional: Defaults to 0 |
result_rowsint32 |
(Optional)
Optional: Defaults to 0 |
read_rowsint32 |
(Optional)
Optional: Defaults to 0 |
execution_timeint32 |
(Optional)
Optional: Defaults to 0 |
(Appears on: TiDBConfig)
IsolationRead is the config for isolation read.
| Field | Description |
|---|---|
engines[]string |
(Optional)
Engines filters tidb-server access paths by engine type. imported from v3.1.0 |
(Appears on: StorageProvider)
LocalStorageProvider defines local storage options, which can be any k8s supported mounted volume
| Field | Description |
|---|---|
volumeKubernetes core/v1.Volume |
|
volumeMountKubernetes core/v1.VolumeMount |
|
prefixstring |
(Appears on: TiDBConfig)
Log is the log section of config.
| Field | Description |
|---|---|
levelstring |
(Optional)
Log level. Optional: Defaults to info |
formatstring |
(Optional)
Log format. one of json, text, or console. Optional: Defaults to text |
disable-timestampbool |
(Optional)
Deprecated in v3.0.5. Use EnableTimestamp instead Disable automatic timestamps in output. |
enable-timestampbool |
(Optional)
EnableTimestamp enables automatic timestamps in log output. |
enable-error-stackbool |
(Optional)
EnableErrorStack enables annotating logs with the full stack error message. |
fileFileLogConfig |
(Optional)
File log config. |
enable-slow-logbool |
(Optional) |
slow-query-filestring |
(Optional) |
slow-thresholduint64 |
(Optional)
Optional: Defaults to 300 |
expensive-thresholduint |
(Optional)
Optional: Defaults to 10000 |
query-log-max-lenuint64 |
(Optional)
Optional: Defaults to 2048 |
record-plan-in-slow-loguint32 |
(Optional)
Optional: Defaults to 1 |
(Appears on: TiFlashSpec, TiKVSpec)
LogTailerSpec represents an optional log tailer sidecar container
| Field | Description |
|---|---|
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
(Appears on: MasterSpec)
MasterConfig is the configuration of dm-master-server
| Field | Description |
|---|---|
log-levelstring |
(Optional)
Log level. Optional: Defaults to info |
log-filestring |
(Optional)
File log config. |
log-formatstring |
(Optional)
Log format. one of json or text. |
rpc-timeoutstring |
(Optional)
RPC timeout when dm-master request to dm-worker Optional: Defaults to 30s |
rpc-rate-limitfloat64 |
(Optional)
RPC agent rate limit when dm-master request to dm-worker Optional: Defaults to 10 |
rpc-rate-burstint |
(Optional)
RPC agent rate burst when dm-master request to dm-worker Optional: Defaults to 40 |
DMSecurityConfigDMSecurityConfig |
(Members of dm-master’s security config |
(Appears on: MasterStatus)
MasterFailureMember is the dm-master failure member information
| Field | Description |
|---|---|
podNamestring |
|
memberIDstring |
|
pvcUIDk8s.io/apimachinery/pkg/types.UID |
|
memberDeletedbool |
|
createdAtKubernetes meta/v1.Time |
(Appears on: TiKVMasterKeyConfig, TiKVSecurityConfigEncryptionMasterKey, TiKVSecurityConfigEncryptionPreviousMasterKey)
| Field | Description |
|---|---|
methodstring |
Encrypyion method, use master key encryption data key Possible values: plaintext, aes128-ctr, aes192-ctr, aes256-ctr Optional: Default to plaintext optional |
pathstring |
Text file containing the key in hex form, end with ‘\n’ |
(Appears on: TiKVMasterKeyConfig, TiKVSecurityConfigEncryptionMasterKey, TiKVSecurityConfigEncryptionPreviousMasterKey)
| Field | Description |
|---|---|
key-idstring |
AWS CMK key-id it can be find in AWS Console or use aws cli This field is required |
access-keystring |
AccessKey of AWS user, leave empty if using other authrization method optional |
secret-access-keystring |
SecretKey of AWS user, leave empty if using other authrization method optional |
regionstring |
Region of this KMS key Optional: Default to us-east-1 optional |
endpointstring |
Used for KMS compatible KMS, such as Ceph, minio, If use AWS, leave empty optional |
(Appears on: MasterStatus)
MasterMember is dm-master member status
| Field | Description |
|---|---|
namestring |
|
idstring |
member id is actually a uint64, but apimachinery’s json only treats numbers as int64/float64 so uint64 may overflow int64 and thus convert to float64 |
clientURLstring |
|
healthbool |
|
lastTransitionTimeKubernetes meta/v1.Time |
Last time the health transitioned from one to another. |
(Appears on: MasterSpec)
| Field | Description |
|---|---|
ServiceSpecServiceSpec |
(Members of |
externalTrafficPolicyKubernetes core/v1.ServiceExternalTrafficPolicyType |
(Optional)
ExternalTrafficPolicy of the service Optional: Defaults to omitted |
masterNodePortint |
(Optional)
Optional: Defaults to 0 |
(Appears on: DMClusterSpec)
MasterSpec contains details of dm-master members
| Field | Description |
|---|---|
ComponentSpecComponentSpec |
(Members of |
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
replicasint32 |
The desired ready replicas |
baseImagestring |
(Optional)
Base image of the component, image tag is now allowed during validation |
serviceMasterServiceSpec |
(Optional)
Service defines a Kubernetes service of Master cluster.
Optional: Defaults to |
maxFailoverCountint32 |
(Optional)
MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover. Optional: Defaults to 3 |
storageClassNamestring |
(Optional)
The storageClassName of the persistent volume for dm-master data storage. Defaults to Kubernetes default storage class. |
storageSizestring |
(Optional)
StorageSize is the request storage size for dm-master. Defaults to “10Gi”. |
dataSubDirstring |
(Optional)
Subdirectory within the volume to store dm-master Data. By default, the data is stored in the root directory of volume which is mounted at /var/lib/dm-master. Specifying this will change the data directory to a subdirectory, e.g. /var/lib/dm-master/data if you set the value to “data”. It’s dangerous to change this value for a running cluster as it will upgrade your cluster to use a new storage directory. Defaults to “” (volume’s root). |
configMasterConfig |
(Optional)
Config is the Configuration of dm-master-servers |
(Appears on: DMClusterStatus)
MasterStatus is dm-master status
| Field | Description |
|---|---|
syncedbool |
|
phaseMemberPhase |
|
statefulSetKubernetes apps/v1.StatefulSetStatus |
|
membersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.MasterMember |
|
leaderMasterMember |
|
failureMembersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.MasterFailureMember |
|
unjoinedMembersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.UnjoinedMember |
|
imagestring |
(Appears on: MasterStatus, PDStatus, PumpStatus, TiCDCStatus, TiDBStatus, TiKVStatus, WorkerStatus)
MemberPhase is the current state of member
MemberType represents member type
(Appears on: GrafanaSpec, InitializerSpec, PrometheusSpec, ReloaderSpec, ThanosSpec)
MonitorContainer is the common attributes of the container of monitoring
| Field | Description |
|---|---|
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
baseImagestring |
|
versionstring |
|
imagePullPolicyKubernetes core/v1.PullPolicy |
(Optional) |
(Appears on: User)
Networks is the configuration of [users.readonly.networks] section.
| Field | Description |
|---|---|
ipstring |
(Optional) |
(Appears on: TiDBConfig)
OpenTracing is the opentracing section of the config.
| Field | Description |
|---|---|
enablebool |
(Optional)
Optional: Defaults to false |
samplerOpenTracingSampler |
(Optional) |
reporterOpenTracingReporter |
(Optional) |
rpc-metricsbool |
(Optional) |
(Appears on: OpenTracing)
OpenTracingReporter is the config for opentracing reporter. See https://godoc.org/github.com/uber/jaeger-client-go/config#ReporterConfig
| Field | Description |
|---|---|
queue-sizeint |
(Optional) |
buffer-flush-intervaltime.Duration |
(Optional) |
log-spansbool |
(Optional) |
local-agent-host-portstring |
(Optional) |
(Appears on: OpenTracing)
OpenTracingSampler is the config for opentracing sampler. See https://godoc.org/github.com/uber/jaeger-client-go/config#SamplerConfig
| Field | Description |
|---|---|
typestring |
(Optional) |
paramfloat64 |
(Optional) |
sampling-server-urlstring |
(Optional) |
max-operationsint |
(Optional) |
sampling-refresh-intervaltime.Duration |
(Optional) |
PDConfig is the configuration of pd-server
| Field | Description |
|---|---|
force-new-clusterbool |
(Optional) |
enable-grpc-gatewaybool |
(Optional)
Optional: Defaults to true |
initial-cluster-tokenstring |
(Optional)
set different tokens to prevent communication between PDs in different clusters. |
leaseint64 |
(Optional)
LeaderLease time, if leader doesn’t update its TTL in etcd after lease time, etcd will expire the leader key and other servers can campaign the leader again. Etcd only supports seconds TTL, so here is second too. Optional: Defaults to 3 |
logPDLogConfig |
(Optional)
Log related config. |
log-filestring |
(Optional)
Backward compatibility. |
log-levelstring |
(Optional) |
tso-save-intervalstring |
(Optional)
TsoSaveInterval is the interval to save timestamp. Optional: Defaults to 3s |
metricPDMetricConfig |
(Optional) |
schedulePDScheduleConfig |
(Optional)
Immutable, change should be made through pd-ctl after cluster creation |
replicationPDReplicationConfig |
(Optional)
Immutable, change should be made through pd-ctl after cluster creation |
namespacemap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDNamespaceConfig |
(Optional) |
pd-serverPDServerConfig |
(Optional) |
cluster-versionstring |
(Optional) |
quota-backend-bytesstring |
(Optional)
QuotaBackendBytes Raise alarms when backend size exceeds the given quota. 0 means use the default quota. the default size is 2GB, the maximum is 8GB. |
auto-compaction-modestring |
(Optional)
AutoCompactionMode is either ‘periodic’ or ‘revision’. The default value is ‘periodic’. |
auto-compaction-retention-v2string |
(Optional)
AutoCompactionRetention is either duration string with time unit (e.g. ‘5m’ for 5-minute), or revision unit (e.g. ‘5000’). If no time unit is provided and compaction mode is ‘periodic’, the unit defaults to hour. For example, ‘5’ translates into 5-hour. The default retention is 1 hour. Before etcd v3.3.x, the type of retention is int. We add ‘v2’ suffix to make it backward compatible. |
tikv-intervalstring |
(Optional)
TickInterval is the interval for etcd Raft tick. |
election-intervalstring |
(Optional)
ElectionInterval is the interval for etcd Raft election. |
enable-prevotebool |
(Optional)
Prevote is true to enable Raft Pre-Vote. If enabled, Raft runs an additional election phase to check whether it would get enough votes to win an election, thus minimizing disruptions. Optional: Defaults to true |
securityPDSecurityConfig |
(Optional) |
label-propertyPDLabelPropertyConfig |
(Optional) |
namespace-classifierstring |
(Optional)
Deprecated in v4.0.0 NamespaceClassifier is for classifying stores/regions into different namespaces. Optional: Defaults to true |
dashboardDashboardConfig |
(Optional) |
(Appears on: PDSpec)
| Field | Description |
|---|---|
GenericConfiggithub.com/pingcap/tidb-operator/pkg/util/config.GenericConfig |
(Appears on: PDStatus)
PDFailureMember is the pd failure member information
| Field | Description |
|---|---|
podNamestring |
|
memberIDstring |
|
pvcUIDk8s.io/apimachinery/pkg/types.UID |
|
pvcUIDSetmap[k8s.io/apimachinery/pkg/types.UID]struct{} |
|
memberDeletedbool |
|
createdAtKubernetes meta/v1.Time |
(Appears on: PDConfig)
(Appears on: PDConfig)
PDLogConfig serializes log related config in toml/json.
| Field | Description |
|---|---|
levelstring |
(Optional)
Log level. Optional: Defaults to info |
formatstring |
(Optional)
Log format. one of json, text, or console. |
disable-timestampbool |
(Optional)
Disable automatic timestamps in output. |
fileFileLogConfig |
(Optional)
File log config. |
developmentbool |
(Optional)
Development puts the logger in development mode, which changes the behavior of DPanicLevel and takes stacktraces more liberally. |
disable-callerbool |
(Optional)
DisableCaller stops annotating logs with the calling function’s file name and line number. By default, all logs are annotated. |
disable-stacktracebool |
(Optional)
DisableStacktrace completely disables automatic stacktrace capturing. By default, stacktraces are captured for WarnLevel and above logs in development and ErrorLevel and above in production. |
disable-error-verbosebool |
(Optional)
DisableErrorVerbose stops annotating logs with the full verbose error message. |
(Appears on: PDStatus)
PDMember is PD member
| Field | Description |
|---|---|
namestring |
|
idstring |
member id is actually a uint64, but apimachinery’s json only treats numbers as int64/float64 so uint64 may overflow int64 and thus convert to float64 |
clientURLstring |
|
healthbool |
|
lastTransitionTimeKubernetes meta/v1.Time |
Last time the health transitioned from one to another. |
(Appears on: PDConfig)
| Field | Description |
|---|---|
jobstring |
(Optional) |
addressstring |
(Optional) |
intervalstring |
(Optional) |
(Appears on: PDConfig)
PDNamespaceConfig is to overwrite the global setting for specific namespace
| Field | Description |
|---|---|
leader-schedule-limituint64 |
(Optional)
LeaderScheduleLimit is the max coexist leader schedules. |
region-schedule-limituint64 |
(Optional)
RegionScheduleLimit is the max coexist region schedules. |
replica-schedule-limituint64 |
(Optional)
ReplicaScheduleLimit is the max coexist replica schedules. |
merge-schedule-limituint64 |
(Optional)
MergeScheduleLimit is the max coexist merge schedules. |
hot-region-schedule-limituint64 |
(Optional)
HotRegionScheduleLimit is the max coexist hot region schedules. |
max-replicasuint64 |
(Optional)
MaxReplicas is the number of replicas for each region. |
(Appears on: PDConfig)
PDReplicationConfig is the replication configuration.
| Field | Description |
|---|---|
max-replicasuint64 |
(Optional)
MaxReplicas is the number of replicas for each region. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 3 |
location-labels[]string |
(Optional)
The label keys specified the location of a store. The placement priorities is implied by the order of label keys. For example, [“zone”, “rack”] means that we should place replicas to different zones first, then to different racks if we don’t have enough zones. Immutable, change should be made through pd-ctl after cluster creation |
strictly-match-labelbool |
(Optional)
StrictlyMatchLabel strictly checks if the label of TiKV is matched with LocaltionLabels. Immutable, change should be made through pd-ctl after cluster creation. Imported from v3.1.0 |
enable-placement-rulesbool |
(Optional)
When PlacementRules feature is enabled. MaxReplicas and LocationLabels are not used anymore. |
(Appears on: PDConfig)
ScheduleConfig is the schedule configuration.
| Field | Description |
|---|---|
max-snapshot-countuint64 |
(Optional)
If the snapshot count of one store is greater than this value, it will never be used as a source or target store. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 3 |
max-pending-peer-countuint64 |
(Optional)
Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 16 |
max-merge-region-sizeuint64 |
(Optional)
If both the size of region is smaller than MaxMergeRegionSize and the number of rows in region is smaller than MaxMergeRegionKeys, it will try to merge with adjacent regions. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 20 |
max-merge-region-keysuint64 |
(Optional)
Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 200000 |
split-merge-intervalstring |
(Optional)
SplitMergeInterval is the minimum interval time to permit merge after split. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 1h |
patrol-region-intervalstring |
(Optional)
PatrolRegionInterval is the interval for scanning region during patrol. Immutable, change should be made through pd-ctl after cluster creation |
max-store-down-timestring |
(Optional)
MaxStoreDownTime is the max duration after which a store will be considered to be down if it hasn’t reported heartbeats. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 30m |
leader-schedule-limituint64 |
(Optional)
LeaderScheduleLimit is the max coexist leader schedules. Immutable, change should be made through pd-ctl after cluster creation. Optional: Defaults to 4. Imported from v3.1.0 |
region-schedule-limituint64 |
(Optional)
RegionScheduleLimit is the max coexist region schedules. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 2048 |
replica-schedule-limituint64 |
(Optional)
ReplicaScheduleLimit is the max coexist replica schedules. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 64 |
merge-schedule-limituint64 |
(Optional)
MergeScheduleLimit is the max coexist merge schedules. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 8 |
hot-region-schedule-limituint64 |
(Optional)
HotRegionScheduleLimit is the max coexist hot region schedules. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 4 |
hot-region-cache-hits-thresholduint64 |
(Optional)
HotRegionCacheHitThreshold is the cache hits threshold of the hot region. If the number of times a region hits the hot cache is greater than this threshold, it is considered a hot region. Immutable, change should be made through pd-ctl after cluster creation |
tolerant-size-ratiofloat64 |
(Optional)
TolerantSizeRatio is the ratio of buffer size for balance scheduler. Immutable, change should be made through pd-ctl after cluster creation. Imported from v3.1.0 |
low-space-ratiofloat64 |
(Optional)
|——————–|—————————–|————————-| ^ ^ ^ ^ 0 HighSpaceRatio * capacity LowSpaceRatio * capacity capacity LowSpaceRatio is the lowest usage ratio of store which regraded as low space. When in low space, store region score increases to very large and varies inversely with available size. Immutable, change should be made through pd-ctl after cluster creation |
high-space-ratiofloat64 |
(Optional)
HighSpaceRatio is the highest usage ratio of store which regraded as high space. High space means there is a lot of spare capacity, and store region score varies directly with used size. Immutable, change should be made through pd-ctl after cluster creation |
disable-raft-learnerbool |
(Optional)
DisableLearner is the option to disable using AddLearnerNode instead of AddNode Immutable, change should be made through pd-ctl after cluster creation |
disable-remove-down-replicabool |
(Optional)
DisableRemoveDownReplica is the option to prevent replica checker from removing down replicas. Immutable, change should be made through pd-ctl after cluster creation |
disable-replace-offline-replicabool |
(Optional)
DisableReplaceOfflineReplica is the option to prevent replica checker from repalcing offline replicas. Immutable, change should be made through pd-ctl after cluster creation |
disable-make-up-replicabool |
(Optional)
DisableMakeUpReplica is the option to prevent replica checker from making up replicas when replica count is less than expected. Immutable, change should be made through pd-ctl after cluster creation |
disable-remove-extra-replicabool |
(Optional)
DisableRemoveExtraReplica is the option to prevent replica checker from removing extra replicas. Immutable, change should be made through pd-ctl after cluster creation |
disable-location-replacementbool |
(Optional)
DisableLocationReplacement is the option to prevent replica checker from moving replica to a better location. Immutable, change should be made through pd-ctl after cluster creation |
disable-namespace-relocationbool |
(Optional)
DisableNamespaceRelocation is the option to prevent namespace checker from moving replica to the target namespace. Immutable, change should be made through pd-ctl after cluster creation |
schedulers-v2PDSchedulerConfigs |
(Optional)
Schedulers support for loding customized schedulers Immutable, change should be made through pd-ctl after cluster creation |
schedulers-payloadmap[string]string |
(Optional)
Only used to display |
enable-one-way-mergebool |
(Optional)
EnableOneWayMerge is the option to enable one way merge. This means a Region can only be merged into the next region of it. Imported from v3.1.0 |
enable-cross-table-mergebool |
(Optional)
EnableCrossTableMerge is the option to enable cross table merge. This means two Regions can be merged with different table IDs. This option only works when key type is “table”. Imported from v3.1.0 |
PDSchedulerConfig is customized scheduler configuration
| Field | Description |
|---|---|
typestring |
(Optional)
Immutable, change should be made through pd-ctl after cluster creation |
args[]string |
(Optional)
Immutable, change should be made through pd-ctl after cluster creation |
disablebool |
(Optional)
Immutable, change should be made through pd-ctl after cluster creation |
(Appears on: PDScheduleConfig)
(Appears on: PDConfig)
PDSecurityConfig is the configuration for supporting tls.
| Field | Description |
|---|---|
cacert-pathstring |
(Optional)
CAPath is the path of file that contains list of trusted SSL CAs. |
cert-pathstring |
(Optional)
CertPath is the path of file that contains X509 certificate in PEM format. |
key-pathstring |
(Optional)
KeyPath is the path of file that contains X509 key in PEM format. |
cert-allowed-cn[]string |
(Optional)
CertAllowedCN is the Common Name that allowed |
(Appears on: PDConfig)
PDServerConfig is the configuration for pd server.
| Field | Description |
|---|---|
use-region-storagebool |
(Optional)
UseRegionStorage enables the independent region storage. |
metric-storagestring |
(Optional)
MetricStorage is the cluster metric storage. Currently we use prometheus as metric storage, we may use PD/TiKV as metric storage later. Imported from v3.1.0 |
(Appears on: TidbClusterSpec)
PDSpec contains details of PD members
| Field | Description |
|---|---|
ComponentSpecComponentSpec |
(Members of |
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
serviceAccountstring |
Specify a Service Account for pd |
replicasint32 |
The desired ready replicas |
baseImagestring |
(Optional)
Base image of the component, image tag is now allowed during validation |
serviceServiceSpec |
(Optional)
Service defines a Kubernetes service of PD cluster.
Optional: Defaults to |
maxFailoverCountint32 |
(Optional)
MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover. Optional: Defaults to 3 |
storageClassNamestring |
(Optional)
The storageClassName of the persistent volume for PD data storage. Defaults to Kubernetes default storage class. |
storageVolumes[]StorageVolume |
(Optional)
StorageVolumes configure additional storage for PD pods. |
dataSubDirstring |
(Optional)
Subdirectory within the volume to store PD Data. By default, the data is stored in the root directory of volume which is mounted at /var/lib/pd. Specifying this will change the data directory to a subdirectory, e.g. /var/lib/pd/data if you set the value to “data”. It’s dangerous to change this value for a running cluster as it will upgrade your cluster to use a new storage directory. Defaults to “” (volume’s root). |
configPDConfigWraper |
(Optional)
Config is the Configuration of pd-servers |
tlsClientSecretNamestring |
(Optional)
TLSClientSecretName is the name of secret which stores tidb server client certificate which used by Dashboard. |
enableDashboardInternalProxybool |
(Optional)
(Deprecated) EnableDashboardInternalProxy would directly set |
mountClusterClientSecretbool |
(Optional)
MountClusterClientSecret indicates whether to mount |
(Appears on: TidbClusterStatus)
PDStatus is PD status
| Field | Description |
|---|---|
syncedbool |
|
phaseMemberPhase |
|
statefulSetKubernetes apps/v1.StatefulSetStatus |
|
membersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDMember |
Members contains PDs in current TidbCluster |
peerMembersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDMember |
PeerMembers contains PDs NOT in current TidbCluster |
leaderPDMember |
|
failureMembersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDFailureMember |
|
unjoinedMembersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.UnjoinedMember |
|
imagestring |
PDStoreLabel is the config item of LabelPropertyConfig.
| Field | Description |
|---|---|
keystring |
(Optional) |
valuestring |
(Optional) |
(Appears on: TiDBConfig)
Performance is the performance section of the config.
| Field | Description |
|---|---|
max-procsuint |
(Optional) |
max-memoryuint64 |
(Optional)
Optional: Defaults to 0 |
stats-leasestring |
(Optional)
Optional: Defaults to 3s |
stmt-count-limituint |
(Optional)
Optional: Defaults to 5000 |
feedback-probabilityfloat64 |
(Optional)
Optional: Defaults to 0.05 |
query-feedback-limituint |
(Optional)
Optional: Defaults to 512 |
pseudo-estimate-ratiofloat64 |
(Optional)
Optional: Defaults to 0.8 |
force-prioritystring |
(Optional)
Optional: Defaults to NO_PRIORITY |
bind-info-leasestring |
(Optional)
Optional: Defaults to 3s |
txn-total-size-limituint64 |
(Optional)
Optional: Defaults to 104857600 |
tcp-keep-alivebool |
(Optional)
Optional: Defaults to true |
cross-joinbool |
(Optional)
Optional: Defaults to true |
run-auto-analyzebool |
(Optional)
Optional: Defaults to true |
agg-push-down-joinbool |
(Optional) |
committer-concurrencyint |
(Optional) |
max-txn-ttluint64 |
(Optional) |
txn-entry-count-limituint64 |
(Optional)
Deprecated in v4.0.0 Optional: Defaults to 300000 |
(Appears on: TiDBConfig)
PessimisticTxn is the config for pessimistic transaction.
| Field | Description |
|---|---|
enablebool |
(Optional)
Enable must be true for ‘begin lock’ or session variable to start a pessimistic transaction. Optional: Defaults to true |
max-retry-countuint |
(Optional)
The max count of retry for a single statement in a pessimistic transaction. Optional: Defaults to 256 |
PlanCache is the PlanCache section of the config.
| Field | Description |
|---|---|
enabledbool |
(Optional) |
capacityuint |
(Optional) |
shardsuint |
(Optional) |
(Appears on: TiDBConfig)
Plugin is the config for plugin
| Field | Description |
|---|---|
dirstring |
(Optional) |
loadstring |
(Optional) |
(Appears on: TiDBConfig)
PreparedPlanCache is the PreparedPlanCache section of the config.
| Field | Description |
|---|---|
enabledbool |
(Optional)
Optional: Defaults to false |
capacityuint |
(Optional)
Optional: Defaults to 100 |
memory-guard-ratiofloat64 |
(Optional)
Optional: Defaults to 0.1 |
Profile is the configuration profiles.
| Field | Description |
|---|---|
readonlyint32 |
(Optional) |
max_memory_usageint64 |
(Optional) |
use_uncompressed_cacheint32 |
(Optional) |
load_balancingstring |
(Optional) |
(Appears on: PrometheusSpec)
Config is the the desired state of Prometheus Configuration
| Field | Description |
|---|---|
configMapRefConfigMapRef |
user can mount prometheus rule config with external configMap.If use this feature, the external configMap must contain |
commandOptions[]string |
user can use it specify prometheus command options |
(Appears on: TidbMonitorSpec)
PrometheusSpec is the desired state of prometheus
| Field | Description |
|---|---|
MonitorContainerMonitorContainer |
(Members of |
logLevelstring |
|
serviceServiceSpec |
|
reserveDaysint |
(Optional) |
ingressIngressSpec |
(Optional) |
configPrometheusConfiguration |
(Optional) |
disableCompactionbool |
Disable prometheus compaction. |
remoteWrite[]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.RemoteWriteSpec |
If specified, the remote_write spec. This is an experimental feature, it may change in any upcoming release in a breaking way. |
(Appears on: TiFlashConfig)
ProxyConfig is the configuration of TiFlash proxy process.
All the configurations are same with those of TiKV except adding engine-addr in the TiKVServerConfig
| Field | Description |
|---|---|
log-levelstring |
(Optional)
Optional: Defaults to info |
log-filestring |
(Optional) |
log-rotation-timespanstring |
(Optional)
Optional: Defaults to 24h |
panic-when-unexpected-key-or-databool |
(Optional) |
serverFlashServerConfig |
(Optional) |
storageTiKVStorageConfig |
(Optional) |
raftstoreTiKVRaftstoreConfig |
(Optional) |
rocksdbTiKVDbConfig |
(Optional) |
coprocessorTiKVCoprocessorConfig |
(Optional) |
readpoolTiKVReadPoolConfig |
(Optional) |
raftdbTiKVRaftDBConfig |
(Optional) |
importTiKVImportConfig |
(Optional) |
gcTiKVGCConfig |
(Optional) |
pdTiKVPDConfig |
(Optional) |
securityTiKVSecurityConfig |
(Optional) |
(Appears on: TiDBConfig)
ProxyProtocol is the PROXY protocol section of the config.
| Field | Description |
|---|---|
networksstring |
(Optional)
PROXY protocol acceptable client networks. Empty *string means disable PROXY protocol, * means all networks. |
header-timeoutuint |
(Optional)
PROXY protocol header read timeout, Unit is second. |
(Appears on: TidbClusterSpec)
PumpSpec contains details of Pump members
| Field | Description |
|---|---|
ComponentSpecComponentSpec |
(Members of |
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
serviceAccountstring |
Specify a Service Account for pump |
replicasint32 |
The desired ready replicas |
baseImagestring |
(Optional)
Base image of the component, image tag is now allowed during validation |
storageClassNamestring |
(Optional)
The storageClassName of the persistent volume for Pump data storage. Defaults to Kubernetes default storage class. |
configgithub.com/pingcap/tidb-operator/pkg/util/config.GenericConfig |
(Optional)
The configuration of Pump cluster. |
setTimeZonebool |
For backward compatibility with helm chart |
(Appears on: TidbClusterStatus)
PumpStatus is Pump status
| Field | Description |
|---|---|
phaseMemberPhase |
|
statefulSetKubernetes apps/v1.StatefulSetStatus |
(Appears on: RemoteWriteSpec)
QueueConfig allows the tuning of remote_write queue_config parameters. This object is referenced in the RemoteWriteSpec object.
| Field | Description |
|---|---|
capacityint |
Number of samples to buffer per shard before we start dropping them. |
maxShardsint |
Max number of shards, i.e. amount of concurrency. |
maxSamplesPperSendint |
Maximum number of samples per send. |
batchSendDeadlinetime.Duration |
Maximum time sample will wait in buffer. |
maxRetriesint |
Max number of times to retry a batch on recoverable errors. |
minBackofftime.Duration |
On recoverable errors, backoff exponentially. |
maxBackofftime.Duration |
Quota is the configuration of [quotas.default] section.
| Field | Description |
|---|---|
intervalInterval |
(Optional) |
(Appears on: RemoteWriteSpec)
RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion.
It defines <metric_relabel_configs>-section of Prometheus configuration.
More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
| Field | Description |
|---|---|
sourceLabelsgithub.com/prometheus/common/model.LabelNames |
A list of labels from which values are taken and concatenated with the configured separator in order. |
separatorstring |
Separator is the string between concatenated values from the source labels. |
regexstring |
Regular expression against which the extracted value is matched. Default is ‘(.*)’ |
modulusuint64 |
Modulus to take of the hash of concatenated values from the source labels. |
targetLabelstring |
TargetLabel is the label to which the resulting string is written in a replacement. Regexp interpolation is allowed for the replace action. |
replacementstring |
Replacement is the regex replacement pattern to be used. |
actiongithub.com/prometheus/prometheus/config.RelabelAction |
Action is the action to be performed for the relabeling. |
(Appears on: TidbMonitorSpec)
ReloaderSpec is the desired state of reloader
| Field | Description |
|---|---|
MonitorContainerMonitorContainer |
(Members of |
serviceServiceSpec |
RemoteWriteSpec defines the remote_write configuration for prometheus.
| Field | Description |
|---|---|
urlstring |
The URL of the endpoint to send samples to. |
remoteTimeoutgithub.com/prometheus/common/model.Duration |
(Optional) |
writeRelabelConfigs[]RelabelConfig |
(Optional)
The list of remote write relabel configurations. |
basicAuthBasicAuth |
(Optional)
BasicAuth for the URL. |
bearerTokenstring |
(Optional)
File to read bearer token for remote write. |
bearerTokenFilestring |
(Optional)
File to read bearer token for remote write. |
tlsConfigTLSConfig |
(Optional)
TLS Config to use for remote write. |
proxyUrlstring |
(Optional)
Proxy url |
queueConfigQueueConfig |
(Optional) |
(Appears on: RestoreStatus)
RestoreCondition describes the observed state of a Restore at a certain point.
| Field | Description |
|---|---|
typeRestoreConditionType |
|
statusKubernetes core/v1.ConditionStatus |
|
lastTransitionTimeKubernetes meta/v1.Time |
|
reasonstring |
|
messagestring |
(Appears on: RestoreCondition, RestoreStatus)
RestoreConditionType represents a valid condition of a Restore.
(Appears on: Restore)
RestoreSpec contains the specification for a restore of a tidb cluster backup.
| Field | Description |
|---|---|
resourcesKubernetes core/v1.ResourceRequirements |
|
toTiDBAccessConfig |
To is the tidb cluster that needs to restore. |
backupTypeBackupType |
Type is the backup type for tidb cluster. |
tikvGCLifeTimestring |
TikvGCLifeTime is to specify the safe gc life time for restore. The time limit during which data is retained for each GC, in the format of Go Duration. When a GC happens, the current time minus this value is the safe point. |
StorageProviderStorageProvider |
(Members of StorageProvider configures where and how backups should be stored. |
storageClassNamestring |
(Optional)
The storageClassName of the persistent volume for Restore data storage. Defaults to Kubernetes default storage class. |
storageSizestring |
StorageSize is the request storage size for backup job |
brBRConfig |
BR is the configs for BR. |
tolerations[]Kubernetes core/v1.Toleration |
(Optional)
Base tolerations of restore Pods, components may add more tolerations upon this respectively |
affinityKubernetes core/v1.Affinity |
(Optional)
Affinity of restore Pods |
useKMSbool |
Use KMS to decrypt the secrets |
serviceAccountstring |
Specify service account of restore |
toolImagestring |
(Optional)
ToolImage specifies the tool image used in |
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference |
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. |
tableFilter[]string |
TableFilter means Table filter expression for ‘db.table’ matching. BR supports this from v4.0.3. |
(Appears on: Restore)
RestoreStatus represents the current status of a tidb cluster restore.
| Field | Description |
|---|---|
timeStartedKubernetes meta/v1.Time |
TimeStarted is the time at which the restore was started. |
timeCompletedKubernetes meta/v1.Time |
TimeCompleted is the time at which the restore was completed. |
commitTsstring |
CommitTs is the snapshot time point of tidb cluster. |
phaseRestoreConditionType |
Phase is a user readable state inferred from the underlying Restore conditions |
conditions[]RestoreCondition |
(Appears on: StorageProvider)
S3StorageProvider represents a S3 compliant storage for storing backups.
| Field | Description |
|---|---|
providerS3StorageProviderType |
Provider represents the specific storage provider that implements the S3 interface |
regionstring |
Region in which the S3 compatible bucket is located. |
pathstring |
Path is the full path where the backup is saved. The format of the path must be: “/” |
bucketstring |
Bucket in which to store the backup data. |
endpointstring |
Endpoint of S3 compatible storage service |
storageClassstring |
StorageClass represents the storage class |
aclstring |
Acl represents access control permissions for this bucket |
secretNamestring |
SecretName is the name of secret which stores S3 compliant storage access key and secret key. |
prefixstring |
Prefix of the data path. |
ssestring |
SSE Sever-Side Encryption. |
options[]string |
Options Rclone options for backup and restore with mydumper and lightning. |
(Appears on: S3StorageProvider)
S3StorageProviderType represents the specific storage provider that implements the S3 interface
(Appears on: TLSConfig)
SafeTLSConfig specifies safe TLS configuration parameters.
| Field | Description |
|---|---|
caSecretOrConfigMap |
Struct containing the CA cert to use for the targets. |
certSecretOrConfigMap |
Struct containing the client cert file for the targets. |
keySecretKubernetes core/v1.SecretKeySelector |
Secret containing the client key file for the targets. |
serverNamestring |
Used to verify the hostname for the targets. |
insecureSkipVerifybool |
Disable target certificate validation. |
(Appears on: SafeTLSConfig)
SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive.
| Field | Description |
|---|---|
secretKubernetes core/v1.SecretKeySelector |
Secret containing data to use for the targets. |
configMapKubernetes core/v1.ConfigMapKeySelector |
ConfigMap containing data to use for the targets. |
(Appears on: ExternalEndpoint)
SecretRef indicates to secret ref
| Field | Description |
|---|---|
namestring |
|
namespacestring |
(Appears on: TiDBConfig)
Security is the security section of the config.
| Field | Description |
|---|---|
skip-grant-tablebool |
(Optional) |
ssl-castring |
(Optional) |
ssl-certstring |
(Optional) |
ssl-keystring |
(Optional) |
cluster-ssl-castring |
(Optional) |
cluster-ssl-certstring |
(Optional) |
cluster-ssl-keystring |
(Optional) |
cluster-verify-cn[]string |
(Optional)
ClusterVerifyCN is the Common Name that allowed |
(Appears on: TidbClusterSpec)
(Deprecated) Service represent service type used in TidbCluster
| Field | Description |
|---|---|
namestring |
|
typestring |
(Appears on: GrafanaSpec, MasterServiceSpec, PDSpec, PrometheusSpec, ReloaderSpec, TiDBServiceSpec)
ServiceSpec specifies the service object in k8s
| Field | Description |
|---|---|
typeKubernetes core/v1.ServiceType |
Type of the real kubernetes service |
annotationsmap[string]string |
(Optional)
Additional annotations of the kubernetes service object |
loadBalancerIPstring |
(Optional)
LoadBalancerIP is the loadBalancerIP of service Optional: Defaults to omitted |
clusterIPstring |
(Optional)
ClusterIP is the clusterIP of service |
portNamestring |
(Optional)
PortName is the name of service port |
loadBalancerSourceRanges[]string |
(Optional)
LoadBalancerSourceRanges is the loadBalancerSourceRanges of service If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.” More info: https://kubernetes.io/docs/concepts/services-networking/service/#aws-nlb-support Optional: Defaults to omitted |
(Appears on: TiDBConfig)
Status is the status section of the config.
| Field | Description |
|---|---|
metrics-addrstring |
(Optional) |
metrics-intervaluint |
(Optional)
Optional: Defaults to 15 |
report-statusbool |
(Optional)
Optional: Defaults to true |
record-db-qpsbool |
(Optional)
Optional: Defaults to false |
(Appears on: TiDBConfig)
StmtSummary is the config for statement summary.
| Field | Description |
|---|---|
enablebool |
(Optional)
Enable statement summary or not. |
enable-internal-querybool |
(Optional)
Enable summary internal query. |
max-stmt-countuint |
(Optional)
The maximum number of statements kept in memory. Optional: Defaults to 100 |
max-sql-lengthuint |
(Optional)
The maximum length of displayed normalized SQL and sample SQL. Optional: Defaults to 4096 |
refresh-intervalint |
(Optional)
The refresh interval of statement summary. |
history-sizeint |
(Optional)
The maximum history size of statement summary. |
(Appears on: TiFlashSpec)
StorageClaim contains details of TiFlash storages
| Field | Description |
|---|---|
resourcesKubernetes core/v1.ResourceRequirements |
(Optional)
Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
storageClassNamestring |
(Optional)
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
(Appears on: BackupSpec, RestoreSpec)
StorageProvider defines the configuration for storing a backup in backend storage.
| Field | Description |
|---|---|
s3S3StorageProvider |
|
gcsGcsStorageProvider |
|
localLocalStorageProvider |
(Appears on: PDSpec, TiDBSpec, TiKVSpec)
StorageVolume configures additional storage for PD/TiDB/TiKV pods.
If StorageClassName not set, default to the spec.[pd|tidb|tikv].storageClassName
| Field | Description |
|---|---|
namestring |
|
storageClassNamestring |
|
storageSizestring |
|
mountPathstring |
(Appears on: DMClusterSpec, TidbClusterSpec)
TLSCluster can enable mutual TLS connection between TiDB cluster components https://pingcap.com/docs/stable/how-to/secure/enable-tls-between-components/
| Field | Description |
|---|---|
enabledbool |
(Optional)
Enable mutual TLS connection between TiDB cluster components Once enabled, the mutual authentication applies to all components, and it does not support applying to only part of the components. The steps to enable this feature: 1. Generate TiDB cluster components certificates and a client-side certifiacete for them. There are multiple ways to generate these certificates: - user-provided certificates: https://pingcap.com/docs/stable/how-to/secure/generate-self-signed-certificates/ - use the K8s built-in certificate signing system signed certificates: https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/ - or use cert-manager signed certificates: https://cert-manager.io/ 2. Create one secret object for one component which contains the certificates created above. The name of this Secret must be: --cluster-secret. For PD: kubectl create secret generic -pd-cluster-secret –namespace= –from-file=tls.crt= –from-file=tls.key= –from-file=ca.crt= For TiKV: kubectl create secret generic -tikv-cluster-secret –namespace= –from-file=tls.crt= –from-file=tls.key= –from-file=ca.crt= For TiDB: kubectl create secret generic -tidb-cluster-secret –namespace= –from-file=tls.crt= –from-file=tls.key= –from-file=ca.crt= For Client: kubectl create secret generic -cluster-client-secret –namespace= –from-file=tls.crt= –from-file=tls.key= –from-file=ca.crt= Same for other components. |
(Appears on: RemoteWriteSpec, ThanosSpec)
TLSConfig extends the safe TLS configuration with file parameters.
| Field | Description |
|---|---|
SafeTLSConfigSafeTLSConfig |
(Members of |
caFilestring |
Path to the CA cert in the Prometheus container to use for the targets. |
certFilestring |
Path to the client cert file in the Prometheus container for the targets. |
keyFilestring |
Path to the client key file in the Prometheus container for the targets. |
(Appears on: TidbMonitorSpec)
ThanosSpec is the desired state of thanos sidecar
| Field | Description |
|---|---|
MonitorContainerMonitorContainer |
(Members of |
objectStorageConfigKubernetes core/v1.SecretKeySelector |
ObjectStorageConfig configures object storage in Thanos. Alternative to ObjectStorageConfigFile, and lower order priority. |
objectStorageConfigFilestring |
ObjectStorageConfigFile specifies the path of the object storage configuration file. When used alongside with ObjectStorageConfig, ObjectStorageConfigFile takes precedence. |
listenLocalbool |
ListenLocal makes the Thanos sidecar listen on loopback, so that it does not bind against the Pod IP. |
tracingConfigKubernetes core/v1.SecretKeySelector |
TracingConfig configures tracing in Thanos. This is an experimental feature, it may change in any upcoming release in a breaking way. |
tracingConfigFilestring |
TracingConfig specifies the path of the tracing configuration file. When used alongside with TracingConfig, TracingConfigFile takes precedence. |
grpcServerTlsConfigTLSConfig |
GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads recorded rule data. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the ‘–grpc-server-tls-*’ CLI args. |
logLevelstring |
LogLevel for Thanos sidecar to be configured with. |
logFormatstring |
LogFormat for Thanos sidecar to be configured with. |
minTimestring |
MinTime for Thanos sidecar to be configured with. Option can be a constant time in RFC3339 format or time duration relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y. |
routePrefixstring |
RoutePrefix is prometheus prefix url |
(Appears on: TiCDCStatus)
TiCDCCapture is TiCDC Capture status
| Field | Description |
|---|---|
podNamestring |
|
idstring |
(Appears on: TiCDCSpec)
TiCDCConfig is the configuration of tidbcdc
| Field | Description |
|---|---|
timezonestring |
(Optional)
Time zone of TiCDC Optional: Defaults to UTC |
gcTTLint32 |
(Optional)
CDC GC safepoint TTL duration, specified in seconds Optional: Defaults to 86400 |
logLevelstring |
(Optional)
LogLevel is the log level Optional: Defaults to info |
logFilestring |
(Optional)
LogFile is the log file Optional: Defaults to /dev/stderr |
(Appears on: TidbClusterSpec)
TiCDCSpec contains details of TiCDC members
| Field | Description |
|---|---|
ComponentSpecComponentSpec |
(Members of |
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
serviceAccountstring |
Specify a Service Account for TiCDC |
replicasint32 |
The desired ready replicas |
baseImagestring |
(Optional)
Base image of the component, image tag is now allowed during validation |
configTiCDCConfig |
(Optional)
Config is the Configuration of tidbcdc servers |
(Appears on: TidbClusterStatus)
TiCDCStatus is TiCDC status
| Field | Description |
|---|---|
syncedbool |
|
phaseMemberPhase |
|
statefulSetKubernetes apps/v1.StatefulSetStatus |
|
capturesmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiCDCCapture |
(Appears on: BackupSpec, RestoreSpec)
TiDBAccessConfig defines the configuration for access tidb cluster
| Field | Description |
|---|---|
hoststring |
Host is the tidb cluster access address |
portint32 |
Port is the port number to use for connecting tidb cluster |
userstring |
User is the user for login tidb cluster |
secretNamestring |
SecretName is the name of secret which stores tidb cluster’s password. |
tlsClientSecretNamestring |
(Optional)
TLSClientSecretName is the name of secret which stores tidb server client certificate Optional: Defaults to nil |
TiDBConfig is the configuration of tidb-server For more detail, refer to https://pingcap.com/docs/stable/reference/configuration/tidb-server/configuration/
| Field | Description |
|---|---|
corsstring |
(Optional) |
socketstring |
(Optional) |
leasestring |
(Optional)
Optional: Defaults to 45s |
run-ddlbool |
(Optional)
Optional: Defaults to true |
split-tablebool |
(Optional)
Optional: Defaults to true |
token-limituint |
(Optional)
Optional: Defaults to 1000 |
oom-use-tmp-storagebool |
(Optional) |
tmp-storage-pathstring |
(Optional) |
oom-actionstring |
(Optional)
Optional: Defaults to log |
max-index-lengthint64 |
(Optional)
Optional: Defaults to 3072 |
mem-quota-queryint64 |
(Optional)
Optional: Defaults to 34359738368 |
tmp-storage-quotaint64 |
(Optional)
TempStorageQuota describe the temporary storage Quota during query exector when OOMUseTmpStorage is enabled If the quota exceed the capacity of the TempStoragePath, the tidb-server would exit with fatal error |
enable-streamingbool |
(Optional)
Optional: Defaults to false |
enable-batch-dmlbool |
(Optional)
Optional: Defaults to false |
txn-local-latchesTxnLocalLatches |
(Optional)
Deprecated in v4.0.0 |
lower-case-table-namesint |
(Optional) |
logLog |
(Optional) |
securitySecurity |
(Optional) |
statusStatus |
(Optional) |
performancePerformance |
(Optional) |
prepared-plan-cachePreparedPlanCache |
(Optional) |
opentracingOpenTracing |
(Optional) |
proxy-protocolProxyProtocol |
(Optional) |
tikv-clientTiKVClient |
(Optional) |
binlogBinlog |
(Optional) |
compatible-kill-querybool |
(Optional) |
pluginPlugin |
(Optional) |
pessimistic-txnPessimisticTxn |
(Optional) |
check-mb4-value-in-utf8bool |
(Optional)
Optional: Defaults to true |
alter-primary-keybool |
(Optional)
Optional: Defaults to false |
treat-old-version-utf8-as-utf8mb4bool |
(Optional)
Optional: Defaults to true |
split-region-max-numuint64 |
(Optional)
Optional: Defaults to 1000 |
stmt-summaryStmtSummary |
(Optional) |
repair-modebool |
(Optional)
RepairMode indicates that the TiDB is in the repair mode for table meta. |
repair-table-list[]string |
(Optional) |
isolation-readIsolationRead |
(Optional)
IsolationRead indicates that the TiDB reads data from which isolation level(engine and label). |
max-server-connectionsuint32 |
(Optional)
MaxServerConnections is the maximum permitted number of simultaneous client connections. |
new_collations_enabled_on_first_bootstrapbool |
(Optional)
NewCollationsEnabledOnFirstBootstrap indicates if the new collations are enabled, it effects only when a TiDB cluster bootstrapped on the first time. |
experimentalExperimental |
(Optional)
Experimental contains parameters for experimental features. |
enable-dynamic-configbool |
(Optional)
EnableDynamicConfig enables the TiDB to fetch configs from PD and update itself during runtime. see pingcap/tidb#13660 for more details. |
enable-table-lockbool |
(Optional)
imported from v3.1.0 |
delay-clean-table-lockuint64 |
(Optional)
imported from v3.1.0 |
skip-register-to-dashboardbool |
(Optional)
imported from v4.0.5 SkipRegisterToDashboard tells TiDB don’t register itself to the dashboard. |
enable-telemetrybool |
(Optional)
When enabled, usage data (for example, instance versions) will be reported to PingCAP periodically for user experience analytics.
If this config is set to |
labelsmap[string]string |
(Optional)
Labels are labels for TiDB server |
(Appears on: TiDBSpec)
TiDBConfigWraper simply wrapps a GenericConfig
| Field | Description |
|---|---|
GenericConfiggithub.com/pingcap/tidb-operator/pkg/util/config.GenericConfig |
(Appears on: TiDBStatus)
TiDBFailureMember is the tidb failure member information
| Field | Description |
|---|---|
podNamestring |
|
createdAtKubernetes meta/v1.Time |
(Appears on: TiDBStatus)
TiDBMember is TiDB member
| Field | Description |
|---|---|
namestring |
|
healthbool |
|
lastTransitionTimeKubernetes meta/v1.Time |
Last time the health transitioned from one to another. |
nodestring |
Node hosting pod of this TiDB member. |
(Appears on: TiDBSpec)
TiDBProbe contains details of probing tidb. default probe by TCPPort on 4000.
| Field | Description |
|---|---|
typestring |
(Optional)
“tcp” will use TCP socket to connetct port 4000 “command” will probe the status api of tidb. This will use curl command to request tidb, before v4.0.9 there is no curl in the image, So do not use this before v4.0.9. |
(Appears on: TiDBSpec)
TiDBServiceSpec defines .tidb.service field of TidbCluster.spec.
| Field | Description |
|---|---|
ServiceSpecServiceSpec |
|
externalTrafficPolicyKubernetes core/v1.ServiceExternalTrafficPolicyType |
(Optional)
ExternalTrafficPolicy of the service Optional: Defaults to omitted |
exposeStatusbool |
(Optional)
Whether expose the status port Optional: Defaults to true |
mysqlNodePortint |
(Optional)
Expose the tidb cluster mysql port to MySQLNodePort Optional: Defaults to 0 |
statusNodePortint |
(Optional)
Expose the tidb status node port to StatusNodePort Optional: Defaults to 0 |
additionalPorts[]Kubernetes core/v1.ServicePort |
(Optional)
Expose additional ports for TiDB Optional: Defaults to omitted |
(Appears on: TiDBSpec)
TiDBSlowLogTailerSpec represents an optional log tailer sidecar with TiDB
| Field | Description |
|---|---|
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
imagestring |
(Deprecated) Image used for slowlog tailer.
Use |
imagePullPolicyKubernetes core/v1.PullPolicy |
(Deprecated) ImagePullPolicy of the component. Override the cluster-level imagePullPolicy if present
Use |
(Appears on: TidbClusterSpec)
TiDBSpec contains details of TiDB members
| Field | Description |
|---|---|
ComponentSpecComponentSpec |
(Members of |
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
serviceAccountstring |
Specify a Service Account for tidb |
replicasint32 |
The desired ready replicas |
baseImagestring |
(Optional)
Base image of the component, image tag is now allowed during validation |
serviceTiDBServiceSpec |
(Optional)
Service defines a Kubernetes service of TiDB cluster. Optional: No kubernetes service will be created by default. |
binlogEnabledbool |
(Optional)
Whether enable TiDB Binlog, it is encouraged to not set this field and rely on the default behavior Optional: Defaults to true if PumpSpec is non-nil, otherwise false |
maxFailoverCountint32 |
(Optional)
MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover Optional: Defaults to 3 |
separateSlowLogbool |
(Optional)
Whether output the slow log in an separate sidecar container Optional: Defaults to true |
slowLogVolumeNamestring |
(Optional)
Optional volume name configuration for slow query log. |
slowLogTailerTiDBSlowLogTailerSpec |
(Optional)
The specification of the slow log tailer sidecar |
tlsClientTiDBTLSClient |
(Optional)
Whether enable the TLS connection between the SQL client and TiDB server Optional: Defaults to nil |
plugins[]string |
(Optional)
Plugins is a list of plugins that are loaded by TiDB server, empty means plugin disabled |
configTiDBConfigWraper |
(Optional)
Config is the Configuration of tidb-servers |
lifecycleKubernetes core/v1.Lifecycle |
(Optional)
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. |
storageVolumes[]StorageVolume |
(Optional)
StorageVolumes configure additional storage for TiDB pods. |
storageClassNamestring |
(Optional)
The storageClassName of the persistent volume for TiDB data storage. Defaults to Kubernetes default storage class. |
readinessProbeTiDBProbe |
(Optional)
ReadinessProbe describes actions that probe the tidb’s readiness. the default behavior is like setting type as “tcp” |
(Appears on: TidbClusterStatus)
TiDBStatus is TiDB status
| Field | Description |
|---|---|
phaseMemberPhase |
|
statefulSetKubernetes apps/v1.StatefulSetStatus |
|
membersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiDBMember |
|
failureMembersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiDBFailureMember |
|
resignDDLOwnerRetryCountint32 |
|
imagestring |
(Appears on: TiDBSpec)
TiDBTLSClient can enable TLS connection between TiDB server and MySQL client
| Field | Description |
|---|---|
enabledbool |
(Optional)
When enabled, TiDB will accept TLS encrypted connections from MySQL client
The steps to enable this feature:
1. Generate a TiDB server-side certificate and a client-side certifiacete for the TiDB cluster.
There are multiple ways to generate certificates:
- user-provided certificates: https://pingcap.com/docs/stable/how-to/secure/enable-tls-clients/
- use the K8s built-in certificate signing system signed certificates: https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/
- or use cert-manager signed certificates: https://cert-manager.io/
2. Create a K8s Secret object which contains the TiDB server-side certificate created above.
The name of this Secret must be: -tidb-server-secret.
kubectl create secret generic -tidb-server-secret –namespace= –from-file=tls.crt= –from-file=tls.key= –from-file=ca.crt=
3. Create a K8s Secret object which contains the TiDB client-side certificate created above which will be used by TiDB Operator.
The name of this Secret must be: -tidb-client-secret.
kubectl create secret generic -tidb-client-secret –namespace= –from-file=tls.crt= –from-file=tls.key= –from-file=ca.crt=
4. Set Enabled to |
(Appears on: TiFlashConfigWraper)
| Field | Description |
|---|---|
GenericConfiggithub.com/pingcap/tidb-operator/pkg/util/config.GenericConfig |
TiFlashConfig is the configuration of TiFlash.
| Field | Description |
|---|---|
configCommonConfig |
(Optional)
commonConfig is the Configuration of TiFlash process |
proxyProxyConfig |
(Optional)
proxyConfig is the Configuration of proxy process |
(Appears on: TiFlashSpec)
| Field | Description |
|---|---|
configTiFlashCommonConfigWraper |
|
proxyTiFlashProxyConfigWraper |
(Appears on: TiFlashConfigWraper)
| Field | Description |
|---|---|
GenericConfiggithub.com/pingcap/tidb-operator/pkg/util/config.GenericConfig |
(Appears on: TidbClusterSpec)
TiFlashSpec contains details of TiFlash members
| Field | Description |
|---|---|
ComponentSpecComponentSpec |
(Members of |
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
serviceAccountstring |
Specify a Service Account for TiFlash |
replicasint32 |
The desired ready replicas |
baseImagestring |
(Optional)
Base image of the component, image tag is now allowed during validation |
privilegedbool |
(Optional)
Whether create the TiFlash container in privileged mode, it is highly discouraged to enable this in critical environment. Optional: defaults to false |
maxFailoverCountint32 |
(Optional)
MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover Optional: Defaults to 3 |
storageClaims[]StorageClaim |
The persistent volume claims of the TiFlash data storages. TiFlash supports multiple disks. |
configTiFlashConfigWraper |
(Optional)
Config is the Configuration of TiFlash |
logTailerLogTailerSpec |
(Optional)
LogTailer is the configurations of the log tailers for TiFlash |
recoverFailoverbool |
(Optional)
RecoverFailover indicates that Operator can recover the failover Pods |
(Appears on: TiKVConfig)
| Field | Description |
|---|---|
num-threadsint64 |
(Optional) |
(Appears on: TiKVStorageConfig)
TiKVBlockCacheConfig is the config of a block cache
| Field | Description |
|---|---|
sharedbool |
(Optional)
Optional: Defaults to true |
capacitystring |
(Optional) |
num-shard-bitsint64 |
(Optional) |
strict-capacity-limitbool |
(Optional) |
high-pri-pool-ratiofloat64 |
(Optional) |
memory-allocatorstring |
(Optional) |
(Appears on: TiKVDbConfig, TiKVRaftDBConfig)
TiKVCfConfig is the config of a cf
| Field | Description |
|---|---|
block-sizestring |
(Optional) |
block-cache-sizestring |
(Optional) |
disable-block-cachebool |
(Optional) |
cache-index-and-filter-blocksbool |
(Optional) |
pin-l0-filter-and-index-blocksbool |
(Optional) |
use-bloom-filterbool |
(Optional) |
optimize-filters-for-hitsbool |
(Optional) |
whole-key-filteringbool |
(Optional) |
bloom-filter-bits-per-keyint64 |
(Optional) |
block-based-bloom-filterbool |
(Optional) |
read-amp-bytes-per-bitint64 |
(Optional) |
compression-per-level[]string |
(Optional) |
write-buffer-sizestring |
(Optional) |
max-write-buffer-numberint64 |
(Optional) |
min-write-buffer-number-to-mergeint64 |
(Optional) |
max-bytes-for-level-basestring |
(Optional) |
target-file-size-basestring |
(Optional) |
level0-file-num-compaction-triggerint64 |
(Optional) |
level0-slowdown-writes-triggerint64 |
(Optional) |
level0-stop-writes-triggerint64 |
(Optional) |
max-compaction-bytesstring |
(Optional) |
compaction-priint64 |
(Optional) |
dynamic-level-bytesbool |
(Optional) |
num-levelsint64 |
(Optional) |
max-bytes-for-level-multiplierint64 |
(Optional) |
compaction-styleint64 |
(Optional) |
disable-auto-compactionsbool |
(Optional) |
soft-pending-compaction-bytes-limitstring |
(Optional) |
hard-pending-compaction-bytes-limitstring |
(Optional) |
force-consistency-checksbool |
(Optional) |
prop-size-index-distanceint64 |
(Optional) |
prop-keys-index-distanceint64 |
(Optional) |
enable-doubly-skiplistbool |
(Optional) |
titanTiKVTitanCfConfig |
(Optional) |
(Appears on: TiDBConfig)
TiKVClient is the config for tikv client.
| Field | Description |
|---|---|
grpc-connection-countuint |
(Optional)
GrpcConnectionCount is the max gRPC connections that will be established with each tikv-server. Optional: Defaults to 16 |
grpc-keepalive-timeuint |
(Optional)
After a duration of this time in seconds if the client doesn’t see any activity it pings the server to see if the transport is still alive. Optional: Defaults to 10 |
grpc-keepalive-timeoutuint |
(Optional)
After having pinged for keepalive check, the client waits for a duration of Timeout in seconds and if no activity is seen even after that the connection is closed. Optional: Defaults to 3 |
commit-timeoutstring |
(Optional)
CommitTimeout is the max time which command ‘commit’ will wait. Optional: Defaults to 41s |
max-txn-time-useuint |
(Optional)
Deprecated in v4.0.0 MaxTxnTimeUse is the max time a Txn may use (in seconds) from its startTS to commitTS. Optional: Defaults to 590 |
max-batch-sizeuint |
(Optional)
MaxBatchSize is the max batch size when calling batch commands API. Optional: Defaults to 128 |
overload-thresholduint |
(Optional)
If TiKV load is greater than this, TiDB will wait for a while to avoid little batch. Optional: Defaults to 200 |
max-batch-wait-timetime.Duration |
(Optional)
MaxBatchWaitTime in nanosecond is the max wait time for batch. Optional: Defaults to 0 |
batch-wait-sizeuint |
(Optional)
BatchWaitSize is the max wait size for batch. Optional: Defaults to 8 |
region-cache-ttluint |
(Optional)
If a Region has not been accessed for more than the given duration (in seconds), it will be reloaded from the PD. Optional: Defaults to 600 |
store-limitint64 |
(Optional)
If a store has been up to the limit, it will return error for successive request to prevent the store occupying too much token in dispatching level. Optional: Defaults to 0 |
store-liveness-timeoutstring |
(Optional)
StoreLivenessTimeout is the timeout for store liveness check request. |
copr-cacheCoprocessorCache |
(Optional) |
TiKVConfig is the configuration of TiKV.
| Field | Description |
|---|---|
log-levelstring |
(Optional)
Optional: Defaults to info |
log-filestring |
(Optional) |
log-formatstring |
(Optional) |
slow-log-filestring |
(Optional) |
slow-log-thresholdstring |
(Optional) |
log-rotation-timespanstring |
(Optional)
Optional: Defaults to 24h |
log-rotation-sizestring |
(Optional) |
refresh-config-intervalstring |
(Optional) |
panic-when-unexpected-key-or-databool |
(Optional) |
serverTiKVServerConfig |
(Optional) |
storageTiKVStorageConfig |
(Optional) |
raftstoreTiKVRaftstoreConfig |
(Optional) |
rocksdbTiKVDbConfig |
(Optional) |
coprocessorTiKVCoprocessorConfig |
(Optional) |
readpoolTiKVReadPoolConfig |
(Optional) |
raftdbTiKVRaftDBConfig |
(Optional) |
importTiKVImportConfig |
(Optional) |
gcTiKVGCConfig |
(Optional) |
pdTiKVPDConfig |
(Optional) |
securityTiKVSecurityConfig |
(Optional) |
pessimistic-txnTiKVPessimisticTxn |
(Optional) |
backupTiKVBackupConfig |
(Optional) |
(Appears on: TiKVSpec)
| Field | Description |
|---|---|
GenericConfiggithub.com/pingcap/tidb-operator/pkg/util/config.GenericConfig |
(Appears on: ProxyConfig, TiKVConfig)
TiKVCoprocessorConfig is the configuration of TiKV Coprocessor component.
| Field | Description |
|---|---|
split-region-on-tablebool |
When it is set to |
batch-split-limitint64 |
One split check produces several split keys in batch. This config limits the number of produced split keys in one batch. optional |
region-max-sizestring |
When Region [a,e) size exceeds |
region-split-sizestring |
When Region [a,e) size exceeds |
region-max-keysint64 |
When the number of keys in Region [a,e) exceeds the |
region-split-keysint64 |
When the number of keys in Region [a,e) exceeds the |
(Appears on: TiKVReadPoolConfig)
| Field | Description |
|---|---|
high-concurrencyint64 |
(Optional)
Optional: Defaults to 8 |
normal-concurrencyint64 |
(Optional)
Optional: Defaults to 8 |
low-concurrencyint64 |
(Optional)
Optional: Defaults to 8 |
max-tasks-per-worker-highint64 |
(Optional)
Optional: Defaults to 2000 |
max-tasks-per-worker-normalint64 |
(Optional)
Optional: Defaults to 2000 |
max-tasks-per-worker-lowint64 |
(Optional)
Optional: Defaults to 2000 |
stack-sizestring |
(Optional)
Optional: Defaults to 10MB |
use-unified-poolbool |
(Optional)
Optional: Defaults to true |
(Appears on: ProxyConfig, TiKVConfig)
TiKVDbConfig is the rocksdb config.
| Field | Description |
|---|---|
wal-recovery-modeint64 |
(Optional)
Optional: Defaults to 2 |
wal-ttl-secondsint64 |
(Optional) |
wal-size-limitstring |
(Optional) |
max-total-wal-sizestring |
(Optional)
Optional: Defaults to 4GB |
max-background-jobsint64 |
(Optional)
Optional: Defaults to 8 |
max-manifest-file-sizestring |
(Optional)
Optional: Defaults to 128MB |
create-if-missingbool |
(Optional)
Optional: Defaults to true |
max-open-filesint64 |
(Optional)
Optional: Defaults to 40960 |
enable-statisticsbool |
(Optional)
Optional: Defaults to true |
stats-dump-periodstring |
(Optional)
Optional: Defaults to 10m |
compaction-readahead-sizestring |
(Optional)
Optional: Defaults to 0 |
info-log-max-sizestring |
(Optional) |
info-log-roll-timestring |
(Optional) |
info-log-keep-log-file-numint64 |
(Optional) |
info-log-dirstring |
(Optional) |
rate-bytes-per-secstring |
(Optional) |
rate-limiter-modeint64 |
(Optional) |
auto-tunedbool |
(Optional) |
bytes-per-syncstring |
(Optional) |
wal-bytes-per-syncstring |
(Optional) |
max-sub-compactionsint64 |
(Optional)
Optional: Defaults to 3 |
writable-file-max-buffer-sizestring |
(Optional) |
use-direct-io-for-flush-and-compactionbool |
(Optional) |
enable-pipelined-writebool |
(Optional) |
defaultcfTiKVCfConfig |
(Optional) |
writecfTiKVCfConfig |
(Optional) |
lockcfTiKVCfConfig |
(Optional) |
raftcfTiKVCfConfig |
(Optional) |
titanTiKVTitanDBConfig |
(Optional) |
| Field | Description |
|---|---|
data-encryption-methodstring |
Encrypyion method, use data key encryption raw rocksdb data Possible values: plaintext, aes128-ctr, aes192-ctr, aes256-ctr Optional: Default to plaintext optional |
data-key-rotation-periodstring |
The frequency of datakey rotation, It managered by tikv Optional: default to 7d optional |
master-keyTiKVMasterKeyConfig |
Master key config |
previous-master-keyTiKVMasterKeyConfig |
Previous master key config It used in master key rotation, the data key should decryption by previous master key and then encrypytion by new master key |
(Appears on: TiKVStatus)
TiKVFailureStore is the tikv failure store information
| Field | Description |
|---|---|
podNamestring |
|
storeIDstring |
|
createdAtKubernetes meta/v1.Time |
(Appears on: ProxyConfig, TiKVConfig)
| Field | Description |
|---|---|
batch-keysint64 |
(Optional)
Optional: Defaults to 512 |
max-write-bytes-per-secstring |
(Optional) |
enable-compaction-filterbool |
(Optional) |
compaction-filter-skip-version-checkbool |
(Optional) |
(Appears on: ProxyConfig, TiKVConfig)
| Field | Description |
|---|---|
import-dirstring |
(Optional) |
num-threadsint64 |
(Optional) |
num-import-jobsint64 |
(Optional) |
num-import-sst-jobsint64 |
(Optional) |
max-prepare-durationstring |
(Optional) |
region-split-sizestring |
(Optional) |
stream-channel-windowint64 |
(Optional) |
max-open-enginesint64 |
(Optional) |
upload-speed-limitstring |
(Optional) |
(Appears on: TiKVEncryptionConfig)
| Field | Description |
|---|---|
typestring |
Use KMS encryption or use file encryption, possible values: kms, file If set to kms, kms MasterKeyKMSConfig should be filled, if set to file MasterKeyFileConfig should be filled optional |
MasterKeyFileConfigMasterKeyFileConfig |
(Members of Master key file config If the type set to file, this config should be filled |
MasterKeyKMSConfigMasterKeyKMSConfig |
(Members of Master key KMS config If the type set to kms, this config should be filled |
(Appears on: ProxyConfig, TiKVConfig)
| Field | Description |
|---|---|
endpoints[]string |
(Optional)
The PD endpoints for the client. Default is empty. |
retry-intervalstring |
(Optional)
The interval at which to retry a PD connection initialization. Default is 300ms. Optional: Defaults to 300ms |
retry-max-countint64 |
(Optional)
The maximum number of times to retry a PD connection initialization. Default is isize::MAX, represented by -1. Optional: Defaults to -1 |
retry-log-everyint64 |
(Optional)
If the client observes the same error message on retry, it can repeat the message only
every Default is 10. Set to 1 to disable this feature. Optional: Defaults to 10 |
(Appears on: TiKVConfig)
| Field | Description |
|---|---|
enabledbool |
(Optional) |
wait-for-lock-timeoutstring |
(Optional)
The default and maximum delay before responding to TiDB when pessimistic transactions encounter locks |
wake-up-delay-durationstring |
(Optional)
If more than one transaction is waiting for the same lock, only the one with smallest
start timestamp will be waked up immediately when the lock is released. Others will
be waked up after |
pipelinedbool |
(Optional) |
(Appears on: ProxyConfig, TiKVConfig)
| Field | Description |
|---|---|
wal-recovery-modestring |
(Optional) |
wal-dirstring |
(Optional) |
wal-ttl-secondsint64 |
(Optional) |
wal-size-limitstring |
(Optional) |
max-total-wal-sizestring |
(Optional) |
max-background-jobsint64 |
(Optional) |
max-manifest-file-sizestring |
(Optional) |
create-if-missingbool |
(Optional) |
max-open-filesint64 |
(Optional) |
enable-statisticsbool |
(Optional) |
stats-dump-periodstring |
(Optional) |
compaction-readahead-sizestring |
(Optional) |
info-log-max-sizestring |
(Optional) |
info-log-roll-timestring |
(Optional) |
info-log-keep-log-file-numint64 |
(Optional) |
info-log-dirstring |
(Optional) |
max-sub-compactionsint64 |
(Optional) |
writable-file-max-buffer-sizestring |
(Optional) |
use-direct-io-for-flush-and-compactionbool |
(Optional) |
enable-pipelined-writebool |
(Optional) |
allow-concurrent-memtable-writebool |
(Optional) |
bytes-per-syncstring |
(Optional) |
wal-bytes-per-syncstring |
(Optional) |
defaultcfTiKVCfConfig |
(Optional) |
(Appears on: ProxyConfig, TiKVConfig)
TiKVRaftstoreConfig is the configuration of TiKV raftstore component.
| Field | Description |
|---|---|
sync-logbool |
(Optional)
true for high reliability, prevent data loss when power failure. Optional: Defaults to true |
prevotebool |
(Optional)
Optional: Defaults to true |
raft-base-tick-intervalstring |
(Optional)
raft-base-tick-interval is a base tick interval (ms). |
raft-heartbeat-ticksint64 |
(Optional) |
raft-election-timeout-ticksint64 |
(Optional) |
raft-entry-max-sizestring |
(Optional)
When the entry exceed the max size, reject to propose it. Optional: Defaults to 8MB |
raft-max-size-per-msgstring |
(Optional)
Limit the max size of each append message. Optional: Defaults to 1MB |
raft-max-inflight-msgsint64 |
(Optional)
Limit the max number of in-flight append messages during optimistic replication phase. Optional: Defaults to 256 |
raft-log-gc-tick-intervalstring |
(Optional)
Interval to gc unnecessary raft log (ms). Optional: Defaults to 10s |
raft-log-gc-thresholdint64 |
(Optional)
A threshold to gc stale raft log, must >= 1. Optional: Defaults to 50 |
raft-log-gc-count-limitint64 |
(Optional)
When entry count exceed this value, gc will be forced trigger. Optional: Defaults to 72000 |
raft-log-gc-size-limitstring |
(Optional)
When the approximate size of raft log entries exceed this value gc will be forced trigger. Optional: Defaults to 72MB |
raft-entry-cache-life-timestring |
(Optional)
When a peer is not responding for this time, leader will not keep entry cache for it. |
raft-reject-transfer-leader-durationstring |
(Optional)
When a peer is newly added, reject transferring leader to the peer for a while. |
split-region-check-tick-intervalstring |
(Optional)
Interval (ms) to check region whether need to be split or not. Optional: Defaults to 10s |
region-split-check-diffstring |
(Optional)
/ When size change of region exceed the diff since last check, it / will be checked again whether it should be split. Optional: Defaults to 6MB |
region-compact-check-intervalstring |
(Optional)
/ Interval (ms) to check whether start compaction for a region. Optional: Defaults to 5m |
clean-stale-peer-delaystring |
(Optional)
delay time before deleting a stale peer Optional: Defaults to 10m |
region-compact-check-stepint64 |
(Optional)
/ Number of regions for each time checking. Optional: Defaults to 100 |
region-compact-min-tombstonesint64 |
(Optional)
/ Minimum number of tombstones to trigger manual compaction. Optional: Defaults to 10000 |
region-compact-tombstones-percentint64 |
(Optional)
/ Minimum percentage of tombstones to trigger manual compaction. / Should between 1 and 100. Optional: Defaults to 30 |
pd-heartbeat-tick-intervalstring |
(Optional)
Optional: Defaults to 60s |
pd-store-heartbeat-tick-intervalstring |
(Optional)
Optional: Defaults to 10s |
snap-mgr-gc-tick-intervalstring |
(Optional) |
snap-gc-timeoutstring |
(Optional) |
lock-cf-compact-intervalstring |
(Optional)
Optional: Defaults to 10m |
lock-cf-compact-bytes-thresholdstring |
(Optional)
Optional: Defaults to 256MB |
notify-capacityint64 |
(Optional) |
messages-per-tickint64 |
(Optional) |
max-peer-down-durationstring |
(Optional)
/ When a peer is not active for max-peer-down-duration / the peer is considered to be down and is reported to PD. Optional: Defaults to 5m |
max-leader-missing-durationstring |
(Optional)
/ If the leader of a peer is missing for longer than max-leader-missing-duration / the peer would ask pd to confirm whether it is valid in any region. / If the peer is stale and is not valid in any region, it will destroy itself. |
abnormal-leader-missing-durationstring |
(Optional)
/ Similar to the max-leader-missing-duration, instead it will log warnings and / try to alert monitoring systems, if there is any. |
peer-stale-state-check-intervalstring |
(Optional) |
leader-transfer-max-log-lagint64 |
(Optional) |
snap-apply-batch-sizestring |
(Optional) |
consistency-check-intervalstring |
(Optional)
Interval (ms) to check region whether the data is consistent. Optional: Defaults to 0 |
report-region-flow-intervalstring |
(Optional) |
raft-store-max-leader-leasestring |
(Optional)
The lease provided by a successfully proposed and applied entry. |
right-derive-when-splitbool |
(Optional)
Right region derive origin region id when split. |
allow-remove-leaderbool |
(Optional) |
merge-max-log-gapint64 |
(Optional)
/ Max log gap allowed to propose merge. |
merge-check-tick-intervalstring |
(Optional)
/ Interval to re-propose merge. |
use-delete-rangebool |
(Optional) |
cleanup-import-sst-intervalstring |
(Optional)
Optional: Defaults to 10m |
apply-max-batch-sizeint64 |
(Optional) |
apply-pool-sizeint64 |
(Optional)
Optional: Defaults to 2 |
store-max-batch-sizeint64 |
(Optional) |
store-pool-sizeint64 |
(Optional)
Optional: Defaults to 2 |
store-reschedule-durationstring |
(Optional)
Optional: Defaults to 3s |
apply-yield-durationstring |
(Optional)
Optional: Defaults to 500ms |
hibernate-regionsbool |
(Optional) |
apply-earlybool |
(Optional)
Optional: Defaults to false |
perf-levelint64 |
(Optional)
Optional: Defaults to 0 |
dev-assertbool |
(Optional)
Optional: Defaults to false |
(Appears on: ProxyConfig, TiKVConfig)
| Field | Description |
|---|---|
unifiedTiKVUnifiedReadPoolConfig |
(Optional) |
coprocessorTiKVCoprocessorReadPoolConfig |
(Optional) |
storageTiKVStorageReadPoolConfig |
(Optional) |
(Appears on: ProxyConfig, TiKVConfig)
| Field | Description |
|---|---|
ca-pathstring |
(Optional) |
cert-pathstring |
(Optional) |
key-pathstring |
(Optional) |
cert-allowed-cn[]string |
(Optional)
CertAllowedCN is the Common Name that allowed |
override-ssl-targetstring |
(Optional) |
cipher-filestring |
(Optional) |
encryptionTiKVSecurityConfigEncryption |
(Optional) |
(Appears on: TiKVSecurityConfig)
| Field | Description |
|---|---|
data-encryption-methodstring |
(Optional)
Encryption method to use for data files. Possible values are “plaintext”, “aes128-ctr”, “aes192-ctr” and “aes256-ctr”. Value other than “plaintext” means encryption is enabled, in which case master key must be specified. |
data-key-rotation-periodstring |
(Optional)
Specifies how often TiKV rotates data encryption key. |
master-keyTiKVSecurityConfigEncryptionMasterKey |
(Optional)
Specifies master key if encryption is enabled. There are three types of master key:
|
previous-master-keyTiKVSecurityConfigEncryptionPreviousMasterKey |
(Optional)
Specifies the old master key when rotating master key. Same config format as master-key. The key is only access once during TiKV startup, after that TiKV do not need access to the key. And it is okay to leave the stale previous-master-key config after master key rotation. |
(Appears on: TiKVSecurityConfigEncryption)
| Field | Description |
|---|---|
typestring |
(Optional) |
MasterKeyFileConfigMasterKeyFileConfig |
(Members of Master key file config If the type set to file, this config should be filled |
MasterKeyKMSConfigMasterKeyKMSConfig |
(Members of Master key KMS config If the type set to kms, this config should be filled |
(Appears on: TiKVSecurityConfigEncryption)
| Field | Description |
|---|---|
typestring |
(Optional) |
MasterKeyFileConfigMasterKeyFileConfig |
(Members of Master key file config If the type set to file, this config should be filled |
MasterKeyKMSConfigMasterKeyKMSConfig |
(Members of Master key KMS config If the type set to kms, this config should be filled |
(Appears on: FlashServerConfig, TiKVConfig)
TiKVServerConfig is the configuration of TiKV server.
| Field | Description |
|---|---|
status-thread-pool-sizestring |
(Optional)
Optional: Defaults to 1 |
max-grpc-send-msg-lenuint |
(Optional)
Optional: Defaults to 10485760 |
grpc-compression-typestring |
(Optional)
Optional: Defaults to none |
grpc-concurrencyuint |
(Optional)
Optional: Defaults to 4 |
grpc-concurrent-streamuint |
(Optional)
Optional: Defaults to 1024 |
grpc-memory-pool-quotastring |
(Optional)
Optional: Defaults to 32G |
grpc-raft-conn-numuint |
(Optional)
Optional: Defaults to 10 |
grpc-stream-initial-window-sizestring |
(Optional)
Optional: Defaults to 2MB |
grpc-keepalive-timestring |
(Optional)
Optional: Defaults to 10s |
grpc-keepalive-timeoutstring |
(Optional)
Optional: Defaults to 3s |
concurrent-send-snap-limituint |
(Optional)
Optional: Defaults to 32 |
concurrent-recv-snap-limituint |
(Optional)
Optional: Defaults to 32 |
end-point-recursion-limituint |
(Optional)
Optional: Defaults to 1000 |
end-point-stream-channel-sizeuint |
(Optional) |
end-point-batch-row-limituint |
(Optional) |
end-point-stream-batch-row-limituint |
(Optional) |
end-point-enable-batch-if-possibleuint |
(Optional) |
end-point-request-max-handle-durationstring |
(Optional) |
snap-max-write-bytes-per-secstring |
(Optional)
Optional: Defaults to 100MB |
snap-max-total-sizestring |
(Optional) |
stats-concurrencyuint |
(Optional) |
heavy-load-thresholduint |
(Optional) |
heavy-load-wait-durationstring |
(Optional)
Optional: Defaults to 60s |
labelsmap[string]string |
(Optional) |
enable-request-batchbool |
(Optional) |
request-batch-enable-cross-commandbool |
(Optional) |
request-batch-wait-durationstring |
(Optional) |
(Appears on: TidbClusterSpec)
TiKVSpec contains details of TiKV members
| Field | Description |
|---|---|
ComponentSpecComponentSpec |
(Members of |
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
serviceAccountstring |
Specify a Service Account for tikv |
replicasint32 |
The desired ready replicas |
baseImagestring |
(Optional)
Base image of the component, image tag is now allowed during validation |
privilegedbool |
(Optional)
Whether create the TiKV container in privileged mode, it is highly discouraged to enable this in critical environment. Optional: defaults to false |
maxFailoverCountint32 |
(Optional)
MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover Optional: Defaults to 3 |
separateRocksDBLogbool |
(Optional)
Whether output the RocksDB log in a separate sidecar container Optional: Defaults to false |
separateRaftLogbool |
(Optional)
Whether output the Raft log in a separate sidecar container Optional: Defaults to false |
logTailerLogTailerSpec |
(Optional)
LogTailer is the configurations of the log tailers for TiKV |
storageClassNamestring |
(Optional)
The storageClassName of the persistent volume for TiKV data storage. Defaults to Kubernetes default storage class. |
dataSubDirstring |
(Optional)
Subdirectory within the volume to store TiKV Data. By default, the data is stored in the root directory of volume which is mounted at /var/lib/tikv. Specifying this will change the data directory to a subdirectory, e.g. /var/lib/tikv/data if you set the value to “data”. It’s dangerous to change this value for a running cluster as it will upgrade your cluster to use a new storage directory. Defaults to “” (volume’s root). |
configTiKVConfigWraper |
(Optional)
Config is the Configuration of tikv-servers |
recoverFailoverbool |
(Optional)
RecoverFailover indicates that Operator can recover the failed Pods |
mountClusterClientSecretbool |
(Optional)
MountClusterClientSecret indicates whether to mount |
evictLeaderTimeoutstring |
(Optional)
EvictLeaderTimeout indicates the timeout to evict tikv leader, in the format of Go Duration. Defaults to 10m |
storageVolumes[]StorageVolume |
(Optional)
StorageVolumes configure additional storage for TiKV pods. |
storeLabels[]string |
(Optional)
StoreLabels configures additional labels for TiKV stores. |
(Appears on: TidbClusterStatus)
TiKVStatus is TiKV status
| Field | Description |
|---|---|
syncedbool |
|
phaseMemberPhase |
|
bootStrappedbool |
|
statefulSetKubernetes apps/v1.StatefulSetStatus |
|
storesmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVStore |
|
peerStoresmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVStore |
|
tombstoneStoresmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVStore |
|
failureStoresmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVFailureStore |
|
imagestring |
(Appears on: ProxyConfig, TiKVConfig)
TiKVStorageConfig is the config of storage
| Field | Description |
|---|---|
max-key-sizeint64 |
(Optional) |
scheduler-notify-capacityint64 |
(Optional)
Deprecated in v4.0.0 |
scheduler-concurrencyint64 |
(Optional)
Optional: Defaults to 2048000 |
scheduler-worker-pool-sizeint64 |
(Optional)
Optional: Defaults to 4 |
scheduler-pending-write-thresholdstring |
(Optional)
Optional: Defaults to 100MB |
block-cacheTiKVBlockCacheConfig |
(Optional) |
reserve-spacestring |
(Optional)
The size of the temporary file that preoccupies the extra space when
TiKV is started. The name of temporary file is |
(Appears on: TiKVReadPoolConfig)
| Field | Description |
|---|---|
high-concurrencyint64 |
(Optional)
Optional: Defaults to 4 |
normal-concurrencyint64 |
(Optional)
Optional: Defaults to 4 |
low-concurrencyint64 |
(Optional)
Optional: Defaults to 4 |
max-tasks-per-worker-highint64 |
(Optional)
Optional: Defaults to 2000 |
max-tasks-per-worker-normalint64 |
(Optional)
Optional: Defaults to 2000 |
max-tasks-per-worker-lowint64 |
(Optional)
Optional: Defaults to 2000 |
stack-sizestring |
(Optional)
Optional: Defaults to 10MB |
use-unified-poolbool |
(Optional)
Optional: Defaults to true |
(Appears on: TiKVStatus)
TiKVStores is either Up/Down/Offline/Tombstone
| Field | Description |
|---|---|
idstring |
store id is also uint64, due to the same reason as pd id, we store id as string |
podNamestring |
|
ipstring |
|
leaderCountint32 |
|
statestring |
|
lastHeartbeatTimeKubernetes meta/v1.Time |
|
lastTransitionTimeKubernetes meta/v1.Time |
Last time the health transitioned from one to another. |
(Appears on: TiKVCfConfig)
TiKVTitanCfConfig is the titian config.
| Field | Description |
|---|---|
min-blob-sizestring |
(Optional) |
blob-file-compressionstring |
(Optional) |
blob-cache-sizestring |
(Optional) |
min-gc-batch-sizestring |
(Optional) |
max-gc-batch-sizestring |
(Optional) |
discardable-ratiofloat64 |
(Optional) |
sample-ratiofloat64 |
(Optional) |
merge-small-file-thresholdstring |
(Optional) |
blob-run-modestring |
(Optional) |
level_mergebool |
optional |
gc-merge-rewritebool |
optional |
(Appears on: TiKVDbConfig)
TiKVTitanDBConfig is the config a titian db.
| Field | Description |
|---|---|
enabledbool |
(Optional) |
dirnamestring |
(Optional) |
disable-gcbool |
(Optional) |
max-background-gcint64 |
(Optional) |
purge-obsolete-files-periodstring |
(Optional)
The value of this field will be truncated to seconds. |
(Appears on: TiKVReadPoolConfig)
| Field | Description |
|---|---|
min-thread-countint32 |
(Optional) |
max-thread-countint32 |
(Optional) |
stack-sizestring |
(Optional)
Deprecated in v4.0.0 |
max-tasks-per-workerint32 |
(Optional) |
(Appears on: TidbClusterAutoScalerSpec)
TidbAutoScalerSpec describes the spec for tidb auto-scaling
| Field | Description |
|---|---|
BasicAutoScalerSpecBasicAutoScalerSpec |
(Members of |
(Appears on: TidbClusterAutoScalerStatus)
TidbAutoScalerStatus describe the auto-scaling status of tidb
| Field | Description |
|---|---|
BasicAutoScalerStatusBasicAutoScalerStatus |
(Members of |
(Appears on: TidbClusterStatus)
TidbClusterAutoScalerRef indicates to the target auto-scaler ref
| Field | Description |
|---|---|
namestring |
|
namespacestring |
(Appears on: TidbClusterAutoScaler)
TidbAutoScalerSpec describes the state of the TidbClusterAutoScaler
| Field | Description |
|---|---|
clusterTidbClusterRef |
TidbClusterRef describe the target TidbCluster |
tikvTikvAutoScalerSpec |
(Optional)
TiKV represents the auto-scaling spec for tikv |
tidbTidbAutoScalerSpec |
(Optional)
TiDB represents the auto-scaling spec for tidb |
(Appears on: TidbClusterAutoScaler)
TidbClusterAutoScalerStatus describe the whole status
| Field | Description |
|---|---|
tikvmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TikvAutoScalerStatus |
(Optional)
Tikv describes the status of each group for the tikv in the last auto-scaling reconciliation |
tidbmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TidbAutoScalerStatus |
(Optional)
Tidb describes the status of each group for the tidb in the last auto-scaling reconciliation |
(Appears on: TidbClusterStatus)
TidbClusterCondition describes the state of a tidb cluster at a certain point.
| Field | Description |
|---|---|
typeTidbClusterConditionType |
Type of the condition. |
statusKubernetes core/v1.ConditionStatus |
Status of the condition, one of True, False, Unknown. |
lastUpdateTimeKubernetes meta/v1.Time |
The last time this condition was updated. |
lastTransitionTimeKubernetes meta/v1.Time |
(Optional)
Last time the condition transitioned from one status to another. |
reasonstring |
(Optional)
The reason for the condition’s last transition. |
messagestring |
(Optional)
A human readable message indicating details about the transition. |
(Appears on: TidbClusterCondition)
TidbClusterConditionType represents a tidb cluster condition value.
(Appears on: TidbClusterAutoScalerSpec, TidbClusterSpec, TidbInitializerSpec, TidbMonitorSpec)
TidbClusterRef reference to a TidbCluster
| Field | Description |
|---|---|
namespacestring |
(Optional)
Namespace is the namespace that TidbCluster object locates, default to the same namespace with TidbMonitor |
namestring |
Name is the name of TidbCluster object |
clusterDomainstring |
(Optional)
ClusterDomain is the domain of TidbCluster object |
(Appears on: TidbCluster)
TidbClusterSpec describes the attributes that a user creates on a tidb cluster
| Field | Description |
|---|---|
discoveryDiscoverySpec |
Discovery spec |
serviceAccountstring |
Specify a Service Account |
pdPDSpec |
(Optional)
PD cluster spec |
tidbTiDBSpec |
(Optional)
TiDB cluster spec |
tikvTiKVSpec |
(Optional)
TiKV cluster spec |
tiflashTiFlashSpec |
(Optional)
TiFlash cluster spec |
ticdcTiCDCSpec |
(Optional)
TiCDC cluster spec |
pumpPumpSpec |
(Optional)
Pump cluster spec |
helperHelperSpec |
(Optional)
Helper spec |
pausedbool |
(Optional)
Indicates that the tidb cluster is paused and will not be processed by the controller. |
versionstring |
(Optional)
TiDB cluster version |
schedulerNamestring |
SchedulerName of TiDB cluster Pods |
pvReclaimPolicyKubernetes core/v1.PersistentVolumeReclaimPolicy |
Persistent volume reclaim policy applied to the PVs that consumed by TiDB cluster |
imagePullPolicyKubernetes core/v1.PullPolicy |
ImagePullPolicy of TiDB cluster Pods |
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference |
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. |
configUpdateStrategyConfigUpdateStrategy |
ConfigUpdateStrategy determines how the configuration change is applied to the cluster. UpdateStrategyInPlace will update the ConfigMap of configuration in-place and an extra rolling-update of the cluster component is needed to reload the configuration change. UpdateStrategyRollingUpdate will create a new ConfigMap with the new configuration and rolling-update the related components to use the new ConfigMap, that is, the new configuration will be applied automatically. |
enablePVReclaimbool |
(Optional)
Whether enable PVC reclaim for orphan PVC left by statefulset scale-in Optional: Defaults to false |
tlsClusterTLSCluster |
(Optional)
Whether enable the TLS connection between TiDB server components Optional: Defaults to nil |
hostNetworkbool |
(Optional)
Whether Hostnetwork is enabled for TiDB cluster Pods Optional: Defaults to false |
affinityKubernetes core/v1.Affinity |
(Optional)
Affinity of TiDB cluster Pods.
Will be overwritten by each cluster component’s specific affinity setting, e.g. |
priorityClassNamestring |
(Optional)
PriorityClassName of TiDB cluster Pods Optional: Defaults to omitted |
nodeSelectormap[string]string |
(Optional)
Base node selectors of TiDB cluster Pods, components may add or override selectors upon this respectively |
annotationsmap[string]string |
(Optional)
Base annotations of TiDB cluster Pods, components may add or override selectors upon this respectively |
tolerations[]Kubernetes core/v1.Toleration |
(Optional)
Base tolerations of TiDB cluster Pods, components may add more tolerations upon this respectively |
timezonestring |
(Optional)
Time zone of TiDB cluster Pods Optional: Defaults to UTC |
services[]Service |
(Deprecated) Services list non-headless services type used in TidbCluster |
enableDynamicConfigurationbool |
(Optional)
EnableDynamicConfiguration indicates whether to append |
clusterDomainstring |
(Optional)
ClusterDomain is the Kubernetes Cluster Domain of TiDB cluster Optional: Defaults to “” |
clusterTidbClusterRef |
(Optional)
Cluster is the external cluster, if configured, the components in this TidbCluster will join to this configured cluster. |
pdAddresses[]string |
(Optional)
PDAddresses are the external PD addresses, if configured, the PDs in this TidbCluster will join to the configured PD cluster. |
statefulSetUpdateStrategyKubernetes apps/v1.StatefulSetUpdateStrategyType |
(Optional)
StatefulSetUpdateStrategy of TiDB cluster StatefulSets |
(Appears on: TidbCluster)
TidbClusterStatus represents the current status of a tidb cluster.
| Field | Description |
|---|---|
clusterIDstring |
|
pdPDStatus |
|
tikvTiKVStatus |
|
tidbTiDBStatus |
|
pumpPumpStatus |
|
tiflashTiFlashStatus |
|
ticdcTiCDCStatus |
|
monitorTidbMonitorRef |
|
auto-scalerTidbClusterAutoScalerRef |
|
conditions[]TidbClusterCondition |
(Optional)
Represents the latest available observations of a tidb cluster’s state. |
(Appears on: TidbInitializer)
TidbInitializer spec encode the desired state of tidb initializer Job
| Field | Description |
|---|---|
imagestring |
|
clusterTidbClusterRef |
|
imagePullPolicyKubernetes core/v1.PullPolicy |
(Optional) |
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference |
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. |
permitHoststring |
(Optional)
permitHost is the host which will only be allowed to connect to the TiDB. |
initSqlstring |
(Optional)
InitSql is the SQL statements executed after the TiDB cluster is bootstrapped. |
initSqlConfigMapstring |
(Optional)
InitSqlConfigMapName reference a configmap that provide init-sql, take high precedence than initSql if set |
passwordSecretstring |
(Optional) |
resourcesKubernetes core/v1.ResourceRequirements |
(Optional) |
timezonestring |
(Optional)
Time zone of TiDB initializer Pods |
tlsClientSecretNamestring |
(Optional)
TLSClientSecretName is the name of secret which stores tidb server client certificate Optional: Defaults to nil |
(Appears on: TidbInitializer)
| Field | Description |
|---|---|
JobStatusKubernetes batch/v1.JobStatus |
(Members of |
phaseInitializePhase |
Phase is a user readable state inferred from the underlying Job status and TidbCluster status |
(Appears on: TidbClusterStatus)
TidbMonitorRef reference to a TidbMonitor
| Field | Description |
|---|---|
namespacestring |
(Optional)
Namespace is the namespace that TidbMonitor object locates, default to the same namespace with TidbClusterAutoScaler |
namestring |
Name is the name of TidbMonitor object |
grafanaEnabledbool |
(Optional)
GrafanaEnabled indicate whether the grafana is enabled for this target tidbmonitor |
(Appears on: TidbMonitor)
TidbMonitor spec encode the desired state of tidb monitoring component
| Field | Description |
|---|---|
clusters[]TidbClusterRef |
|
prometheusPrometheusSpec |
|
grafanaGrafanaSpec |
(Optional) |
reloaderReloaderSpec |
|
initializerInitializerSpec |
|
dmDMMonitorSpec |
|
thanosThanosSpec |
(Optional) |
pvReclaimPolicyKubernetes core/v1.PersistentVolumeReclaimPolicy |
Persistent volume reclaim policy applied to the PVs that consumed by TiDB cluster |
imagePullPolicyKubernetes core/v1.PullPolicy |
|
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference |
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images. |
persistentbool |
(Optional) |
storageClassNamestring |
(Optional) |
storagestring |
(Optional) |
nodeSelectormap[string]string |
(Optional) |
annotationsmap[string]string |
(Optional) |
tolerations[]Kubernetes core/v1.Toleration |
(Optional) |
kubePrometheusURLstring |
(Optional)
kubePrometheusURL is where tidb-monitoring get the common metrics of kube-prometheus. Ref: https://github.com/coreos/kube-prometheus |
alertmanagerURLstring |
(Optional)
alertmanagerURL is where tidb-monitoring push alerts to. Ref: https://prometheus.io/docs/alerting/alertmanager/ |
alertManagerRulesVersionstring |
(Optional)
alertManagerRulesVersion is the version of the tidb cluster that used for alert rules. default to current tidb cluster version, for example: v3.0.15 |
additionalContainers[]Kubernetes core/v1.Container |
(Optional) |
clusterScopedbool |
ClusterScoped indicates whether this monitor should manage Kubernetes cluster-wide TiDB clusters |
externalLabelsmap[string]string |
The labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). |
replicaExternalLabelNamestring |
Name of Prometheus external label used to denote replica name.
Defaults to the value of |
(Appears on: TidbMonitor)
| Field | Description |
|---|---|
deploymentStorageStatusDeploymentStorageStatus |
Storage status for deployment |
(Appears on: TidbClusterAutoScalerSpec)
TikvAutoScalerSpec describes the spec for tikv auto-scaling
| Field | Description |
|---|---|
BasicAutoScalerSpecBasicAutoScalerSpec |
(Members of |
(Appears on: TidbClusterAutoScalerStatus)
TikvAutoScalerStatus describe the auto-scaling status of tikv
| Field | Description |
|---|---|
BasicAutoScalerStatusBasicAutoScalerStatus |
(Members of |
(Appears on: TiDBConfig)
TxnLocalLatches is the TxnLocalLatches section of the config.
| Field | Description |
|---|---|
enabledbool |
(Optional) |
capacityuint |
(Optional) |
(Appears on: MasterStatus, PDStatus)
UnjoinedMember is the pd unjoin cluster member information
| Field | Description |
|---|---|
podNamestring |
|
pvcUIDk8s.io/apimachinery/pkg/types.UID |
|
createdAtKubernetes meta/v1.Time |
User is the configuration of users.
| Field | Description |
|---|---|
passwordstring |
(Optional) |
profilestring |
(Optional) |
quotastring |
(Optional) |
networksNetworks |
(Optional) |
(Appears on: WorkerSpec)
WorkerConfig is the configuration of dm-worker-server
| Field | Description |
|---|---|
log-levelstring |
(Optional)
Log level. Optional: Defaults to info |
log-filestring |
(Optional)
File log config. |
log-formatstring |
(Optional)
Log format. one of json or text. |
keepalive-ttlint64 |
(Optional)
KeepAliveTTL is the keepalive TTL when dm-worker writes to the embedded etcd of dm-master Optional: Defaults to 10 |
DMSecurityConfigDMSecurityConfig |
(Members of dm-worker’s security config |
(Appears on: WorkerStatus)
WorkerFailureMember is the dm-worker failure member information
| Field | Description |
|---|---|
podNamestring |
|
createdAtKubernetes meta/v1.Time |
(Appears on: WorkerStatus)
WorkerMember is dm-worker member status
| Field | Description |
|---|---|
namestring |
|
addrstring |
|
stagestring |
|
lastTransitionTimeKubernetes meta/v1.Time |
Last time the health transitioned from one to another. |
(Appears on: DMClusterSpec)
WorkerSpec contains details of dm-worker members
| Field | Description |
|---|---|
ComponentSpecComponentSpec |
(Members of |
ResourceRequirementsKubernetes core/v1.ResourceRequirements |
(Members of |
replicasint32 |
The desired ready replicas |
baseImagestring |
(Optional)
Base image of the component, image tag is now allowed during validation |
maxFailoverCountint32 |
(Optional)
MaxFailoverCount limit the max replicas could be added in failover, 0 means no failover. Optional: Defaults to 3 |
storageClassNamestring |
(Optional)
The storageClassName of the persistent volume for dm-worker data storage. Defaults to Kubernetes default storage class. |
storageSizestring |
(Optional)
StorageSize is the request storage size for dm-worker. Defaults to “10Gi”. |
dataSubDirstring |
(Optional)
Subdirectory within the volume to store dm-worker Data. By default, the data is stored in the root directory of volume which is mounted at /var/lib/dm-worker. Specifying this will change the data directory to a subdirectory, e.g. /var/lib/dm-worker/data if you set the value to “data”. It’s dangerous to change this value for a running cluster as it will upgrade your cluster to use a new storage directory. Defaults to “” (volume’s root). |
configWorkerConfig |
(Optional)
Config is the Configuration of dm-worker-servers |
recoverFailoverbool |
(Optional)
RecoverFailover indicates that Operator can recover the failover Pods |
(Appears on: DMClusterStatus)
WorkerStatus is dm-worker status
| Field | Description |
|---|---|
syncedbool |
|
phaseMemberPhase |
|
statefulSetKubernetes apps/v1.StatefulSetStatus |
|
membersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.WorkerMember |
|
failureMembersmap[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.WorkerFailureMember |
|
imagestring |
Generated with gen-crd-api-reference-docs