TidbCluster

TidbCluster is the control script’s spec

FieldDescription
apiVersion
string		pingcap.com/v1alpha1
kind
string		TidbCluster
metadata
Kubernetes meta/v1.ObjectMeta		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TidbClusterSpec

Spec defines the behavior of a tidb cluster



pd
PDSpec

PD cluster spec

tidb
TiDBSpec

TiDB cluster spec

tikv
TiKVSpec

TiKV cluster spec

tiflash
TiFlashSpec		(Optional)

TiFlash cluster spec

pump
PumpSpec		(Optional)

Pump cluster spec

helper
HelperSpec		(Optional)

Helper spec

paused
bool		(Optional)

Indicates that the tidb cluster is paused and will not be processed by the controller.

version
string		(Optional)

TODO: remove optional after defaulting logic introduced TiDB cluster version

schedulerName
string

SchedulerName of TiDB cluster Pods

pvReclaimPolicy
Kubernetes core/v1.PersistentVolumeReclaimPolicy

Persistent volume reclaim policy applied to the PVs that consumed by TiDB cluster

imagePullPolicy
Kubernetes core/v1.PullPolicy

ImagePullPolicy of TiDB cluster Pods

configUpdateStrategy
ConfigUpdateStrategy

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.

enablePVReclaim
bool		(Optional)

Whether enable PVC reclaim for orphan PVC left by statefulset scale-in Optional: Defaults to false

tlsCluster
TLSCluster		(Optional)

Whether enable the TLS connection between TiDB server components Optional: Defaults to nil

hostNetwork
bool		(Optional)

Whether Hostnetwork is enabled for TiDB cluster Pods Optional: Defaults to false

affinity
Kubernetes core/v1.Affinity		(Optional)

Affinity of TiDB cluster Pods

priorityClassName
string		(Optional)

PriorityClassName of TiDB cluster Pods Optional: Defaults to omitted

nodeSelector
map[string]string		(Optional)

Base node selectors of TiDB cluster Pods, components may add or override selectors upon this respectively

annotations
map[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

timezone
string		(Optional)

Time zone of TiDB cluster Pods Optional: Defaults to UTC

services
[]Service

Services list non-headless services type used in TidbCluster Deprecated

status
TidbClusterStatus

Most recently observed status of the tidb cluster