From f4464ffc37e4bc7fbea2cbca0e52d4f5c9fbd6dc Mon Sep 17 00:00:00 2001 From: xhe Date: Wed, 2 Aug 2023 18:21:14 +0800 Subject: [PATCH] fix Signed-off-by: xhe --- docs/api-references/docs.md | 2001 ++++++++++++------------ docs/api-references/federation-docs.md | 158 +- 2 files changed, 1068 insertions(+), 1091 deletions(-) diff --git a/docs/api-references/docs.md b/docs/api-references/docs.md index 80e06f2293c..486eeb5ec3b 100644 --- a/docs/api-references/docs.md +++ b/docs/api-references/docs.md @@ -10,23 +10,23 @@ category: how-to

Resource Types: -

Backup

+

Backup

Backup is a backup of tidb cluster.

@@ -73,7 +73,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + BackupSpec @@ -128,7 +128,7 @@ Note that the following builtin env vars will be overwritten by values set here from
- + TiDBAccessConfig @@ -141,7 +141,7 @@ TiDBAccessConfig backupType
- + BackupType @@ -154,7 +154,7 @@ BackupType backupMode
- + BackupMode @@ -180,7 +180,7 @@ When a GC happens, the current time minus this value is the safe point.

StorageProvider
- + StorageProvider @@ -220,7 +220,7 @@ string br
- + BRConfig @@ -284,7 +284,7 @@ string federalVolumeBackupPhase
- + FederalVolumeBackupPhase @@ -298,7 +298,7 @@ FederalVolumeBackupPhase dumpling
- + DumplingConfig @@ -400,7 +400,7 @@ string cleanPolicy
- + CleanPolicyType @@ -413,7 +413,7 @@ CleanPolicyType cleanOption
- + CleanOption @@ -451,7 +451,7 @@ string backoffRetryPolicy
- + BackoffRetryPolicy @@ -467,7 +467,7 @@ BackoffRetryPolicy status
- + BackupStatus @@ -477,7 +477,7 @@ BackupStatus -

BackupSchedule

+

BackupSchedule

BackupSchedule is a backup schedule of tidb cluster.

@@ -524,7 +524,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + BackupScheduleSpec @@ -584,7 +584,7 @@ string backupTemplate
- + BackupSpec @@ -597,7 +597,7 @@ BackupSpec logBackupTemplate
- + BackupSpec @@ -652,7 +652,7 @@ string status
- + BackupScheduleStatus @@ -662,7 +662,7 @@ BackupScheduleStatus -

DMCluster

+

DMCluster

DMCluster is the control script’s spec

@@ -709,7 +709,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + DMClusterSpec @@ -723,7 +723,7 @@ DMClusterSpec discovery
- + DMDiscoverySpec @@ -736,7 +736,7 @@ DMDiscoverySpec master
- + MasterSpec @@ -750,7 +750,7 @@ MasterSpec worker
- + WorkerSpec @@ -840,7 +840,7 @@ Kubernetes core/v1.PullPolicy configUpdateStrategy
- + ConfigUpdateStrategy @@ -870,7 +870,7 @@ Optional: Defaults to false

tlsCluster
- + TLSCluster @@ -1073,7 +1073,7 @@ Kubernetes apps/v1.PodManagementPolicyType topologySpreadConstraints
- + []TopologySpreadConstraint @@ -1090,7 +1090,7 @@ All topologySpreadConstraints are ANDed.

suspendAction
- + SuspendAction @@ -1118,7 +1118,7 @@ bool status
- + DMClusterStatus @@ -1129,7 +1129,7 @@ DMClusterStatus -

Restore

+

Restore

Restore represents the restoration of backup of a tidb cluster.

@@ -1176,7 +1176,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + RestoreSpec @@ -1231,7 +1231,7 @@ Note that the following builtin env vars will be overwritten by values set here to
- + TiDBAccessConfig @@ -1244,7 +1244,7 @@ TiDBAccessConfig backupType
- + BackupType @@ -1257,7 +1257,7 @@ BackupType restoreMode
- + RestoreMode @@ -1292,7 +1292,7 @@ string federalVolumeRestorePhase
- + FederalVolumeRestorePhase @@ -1332,7 +1332,7 @@ When a GC happens, the current time minus this value is the safe point.

StorageProvider
- + StorageProvider @@ -1348,7 +1348,7 @@ StorageProvider pitrFullBackupStorageProvider
- + StorageProvider @@ -1385,7 +1385,7 @@ string br
- + BRConfig @@ -1515,7 +1515,7 @@ string status
- + RestoreStatus @@ -1525,7 +1525,7 @@ RestoreStatus -

TidbCluster

+

TidbCluster

TidbCluster is the control script’s spec

@@ -1572,7 +1572,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + TidbClusterSpec @@ -1586,7 +1586,7 @@ TidbClusterSpec discovery
- + DiscoverySpec @@ -1610,7 +1610,7 @@ string pd
- + PDSpec @@ -1624,7 +1624,7 @@ PDSpec tidb
- + TiDBSpec @@ -1638,7 +1638,7 @@ TiDBSpec tikv
- + TiKVSpec @@ -1652,7 +1652,7 @@ TiKVSpec tiflash
- + TiFlashSpec @@ -1666,7 +1666,7 @@ TiFlashSpec ticdc
- + TiCDCSpec @@ -1680,7 +1680,7 @@ TiCDCSpec tiproxy
- + TiProxySpec @@ -1694,7 +1694,7 @@ TiProxySpec pump
- + PumpSpec @@ -1708,7 +1708,7 @@ PumpSpec helper
- + HelperSpec @@ -1811,7 +1811,7 @@ Kubernetes core/v1.PullPolicy configUpdateStrategy
- + ConfigUpdateStrategy @@ -1841,7 +1841,7 @@ Optional: Defaults to false

tlsCluster
- + TLSCluster @@ -1990,7 +1990,7 @@ Optional: Defaults to UTC

services
- + []Service @@ -2040,7 +2040,7 @@ bool cluster
- + TidbClusterRef @@ -2108,7 +2108,7 @@ Kubernetes core/v1.PodSecurityContext topologySpreadConstraints
- + []TopologySpreadConstraint @@ -2125,7 +2125,7 @@ All topologySpreadConstraints are ANDed.

startScriptVersion
- + StartScriptVersion @@ -2140,7 +2140,7 @@ StartScriptVersion suspendAction
- + SuspendAction @@ -2168,7 +2168,7 @@ bool status
- + TidbClusterStatus @@ -2179,7 +2179,7 @@ TidbClusterStatus -

TidbClusterAutoScaler

+

TidbClusterAutoScaler

TidbClusterAutoScaler is the control script’s spec

@@ -2226,7 +2226,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + TidbClusterAutoScalerSpec @@ -2240,7 +2240,7 @@ TidbClusterAutoScalerSpec cluster
- + TidbClusterRef @@ -2253,7 +2253,7 @@ TidbClusterRef tikv
- + TikvAutoScalerSpec @@ -2267,7 +2267,7 @@ TikvAutoScalerSpec tidb
- + TidbAutoScalerSpec @@ -2284,7 +2284,7 @@ TidbAutoScalerSpec status
- + TidbClusterAutoScalerStatus @@ -2295,7 +2295,7 @@ TidbClusterAutoScalerStatus -

TidbInitializer

+

TidbInitializer

TidbInitializer is a TiDB cluster initializing job

@@ -2342,7 +2342,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + TidbInitializerSpec @@ -2366,7 +2366,7 @@ string cluster
- + TidbClusterRef @@ -2521,7 +2521,7 @@ Optional: Defaults to nil

status
- + TidbInitializerStatus @@ -2532,7 +2532,7 @@ TidbInitializerStatus -

TidbMonitor

+

TidbMonitor

TidbMonitor encode the spec and status of the monitoring component of a TiDB cluster

@@ -2579,7 +2579,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + TidbMonitorSpec @@ -2593,7 +2593,7 @@ TidbMonitorSpec clusters
- + []TidbClusterRef @@ -2607,7 +2607,7 @@ TidbMonitorSpec prometheus
- + PrometheusSpec @@ -2620,7 +2620,7 @@ PrometheusSpec grafana
- + GrafanaSpec @@ -2634,7 +2634,7 @@ GrafanaSpec reloader
- + ReloaderSpec @@ -2647,7 +2647,7 @@ ReloaderSpec initializer
- + InitializerSpec @@ -2660,7 +2660,7 @@ InitializerSpec dm
- + DMMonitorSpec @@ -2674,7 +2674,7 @@ DMMonitorSpec thanos
- + ThanosSpec @@ -2688,7 +2688,7 @@ ThanosSpec prometheusReloader
- + PrometheusReloaderSpec @@ -3019,7 +3019,7 @@ bool status
- + TidbMonitorStatus @@ -3030,10 +3030,10 @@ TidbMonitorStatus -

AutoResource

+

AutoResource

(Appears on: -BasicAutoScalerSpec) +BasicAutoScalerSpec)

AutoResource describes the resource type definitions

@@ -3092,10 +3092,10 @@ int32 -

AutoRule

+

AutoRule

(Appears on: -BasicAutoScalerSpec) +BasicAutoScalerSpec)

AutoRule describes the rules for auto-scaling with PD API

@@ -3143,10 +3143,10 @@ float64 -

AzblobStorageProvider

+

AzblobStorageProvider

(Appears on: -StorageProvider) +StorageProvider)

AzblobStorageProvider represents the azure blob storage for storing backups.

@@ -3218,11 +3218,11 @@ string -

BRConfig

+

BRConfig

(Appears on: -BackupSpec, -RestoreSpec) +BackupSpec, +RestoreSpec)

BRConfig contains config for BR

@@ -3391,10 +3391,10 @@ bool -

BackoffRetryPolicy

+

BackoffRetryPolicy

(Appears on: -BackupSpec) +BackupSpec)

BackoffRetryPolicy is the backoff retry policy, currently only valid for snapshot backup. @@ -3452,10 +3452,10 @@ format reference, https://g -

BackoffRetryRecord

+

BackoffRetryRecord

(Appears on: -BackupStatus) +BackupStatus)

BackoffRetryRecord is the record of backoff retry

@@ -3542,11 +3542,11 @@ string -

BackupCondition

+

BackupCondition

(Appears on: -BackupStatus, -LogSubCommandStatus) +BackupStatus, +LogSubCommandStatus)

BackupCondition describes the observed state of a Backup at a certain point.

@@ -3563,7 +3563,7 @@ string command
- + LogSubCommandType @@ -3575,7 +3575,7 @@ LogSubCommandType type
- + BackupConditionType @@ -3629,28 +3629,28 @@ string -

BackupConditionType

+

BackupConditionType

(Appears on: -BackupCondition, -BackupStatus, -LogSubCommandStatus) +BackupCondition, +BackupStatus, +LogSubCommandStatus)

BackupConditionType represents a valid condition of a Backup.

-

BackupMode

+

BackupMode

(Appears on: -BackupSpec) +BackupSpec)

BackupType represents the backup mode, such as snapshot backup or log backup.

-

BackupScheduleSpec

+

BackupScheduleSpec

(Appears on: -BackupSchedule) +BackupSchedule)

BackupScheduleSpec contains the backup schedule specification for a tidb cluster.

@@ -3714,7 +3714,7 @@ string backupTemplate
- + BackupSpec @@ -3727,7 +3727,7 @@ BackupSpec logBackupTemplate
- + BackupSpec @@ -3777,10 +3777,10 @@ string -

BackupScheduleStatus

+

BackupScheduleStatus

(Appears on: -BackupSchedule) +BackupSchedule)

BackupScheduleStatus represents the current state of a BackupSchedule.

@@ -3843,11 +3843,11 @@ Kubernetes meta/v1.Time -

BackupSpec

+

BackupSpec

(Appears on: -Backup, -BackupScheduleSpec) +Backup, +BackupScheduleSpec)

BackupSpec contains the backup specification for a tidb cluster.

@@ -3906,7 +3906,7 @@ Note that the following builtin env vars will be overwritten by values set here from
- + TiDBAccessConfig @@ -3919,7 +3919,7 @@ TiDBAccessConfig backupType
- + BackupType @@ -3932,7 +3932,7 @@ BackupType backupMode
- + BackupMode @@ -3958,7 +3958,7 @@ When a GC happens, the current time minus this value is the safe point.

StorageProvider
- + StorageProvider @@ -3998,7 +3998,7 @@ string br
- + BRConfig @@ -4062,7 +4062,7 @@ string federalVolumeBackupPhase
- + FederalVolumeBackupPhase @@ -4076,7 +4076,7 @@ FederalVolumeBackupPhase dumpling
- + DumplingConfig @@ -4178,7 +4178,7 @@ string cleanPolicy
- + CleanPolicyType @@ -4191,7 +4191,7 @@ CleanPolicyType cleanOption
- + CleanOption @@ -4229,7 +4229,7 @@ string backoffRetryPolicy
- + BackoffRetryPolicy @@ -4240,10 +4240,10 @@ BackoffRetryPolicy -

BackupStatus

+

BackupStatus

(Appears on: -Backup) +Backup)

BackupStatus represents the current status of a backup.

@@ -4389,7 +4389,7 @@ string phase
- + BackupConditionType @@ -4402,7 +4402,7 @@ BackupConditionType conditions
- + []BackupCondition @@ -4414,7 +4414,7 @@ BackupConditionType logSubCommandStatuses
- + map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.LogSubCommandType]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.LogSubCommandStatus @@ -4427,7 +4427,7 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.LogSubCommandType progresses
- + []Progress @@ -4440,7 +4440,7 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.LogSubCommandType backoffRetryStatus
- + []BackoffRetryRecord @@ -4451,23 +4451,23 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.LogSubCommandType -

BackupStorageType

+

BackupStorageType

BackupStorageType represents the backend storage type of backup.

-

BackupType

+

BackupType

(Appears on: -BackupSpec, -RestoreSpec) +BackupSpec, +RestoreSpec)

BackupType represents the backup type.

-

BasicAuth

+

BasicAuth

(Appears on: -RemoteWriteSpec) +RemoteWriteSpec)

BasicAuth allow an endpoint to authenticate over basic authentication @@ -4511,11 +4511,11 @@ for authentication.

-

BasicAutoScalerSpec

+

BasicAutoScalerSpec

(Appears on: -TidbAutoScalerSpec, -TikvAutoScalerSpec) +TidbAutoScalerSpec, +TikvAutoScalerSpec)

BasicAutoScalerSpec describes the basic spec for auto-scaling

@@ -4532,7 +4532,7 @@ for authentication.

rules
- + map[k8s.io/api/core/v1.ResourceName]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.AutoRule @@ -4571,7 +4571,7 @@ If not set, the default ScaleOutIntervalSeconds will be set to 300

external
- + ExternalConfig @@ -4586,7 +4586,7 @@ to fetch the recommended replicas for TiKV/TiDB

resources
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.AutoResource @@ -4599,11 +4599,11 @@ The key is resource_type name of the resource

-

BasicAutoScalerStatus

+

BasicAutoScalerStatus

(Appears on: -TidbAutoScalerStatus, -TikvAutoScalerStatus) +TidbAutoScalerStatus, +TikvAutoScalerStatus)

BasicAutoScalerStatus describe the basic auto-scaling status

@@ -4632,10 +4632,10 @@ Kubernetes meta/v1.Time -

BatchDeleteOption

+

BatchDeleteOption

(Appears on: -CleanOption) +CleanOption)

BatchDeleteOption controls the options to delete the objects in batches during the cleanup of backups

@@ -4686,10 +4686,10 @@ default is 100

-

Binlog

+

Binlog

(Appears on: -TiDBConfig) +TiDBConfig)

Binlog is the config for binlog.

@@ -4765,10 +4765,10 @@ Optional: Defaults to range

-

CDCConfigWraper

+

CDCConfigWraper

(Appears on: -TiCDCSpec) +TiCDCSpec)

CDCConfigWraper simply wrapps a GenericConfig

@@ -4796,10 +4796,10 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

CleanOption

+

CleanOption

(Appears on: -BackupSpec) +BackupSpec)

CleanOption defines the configuration for cleanup backup

@@ -4851,7 +4851,7 @@ It is useful when the deletion API is rate limited.

BatchDeleteOption
- + BatchDeleteOption @@ -4864,21 +4864,21 @@ BatchDeleteOption -

CleanPolicyType

+

CleanPolicyType

(Appears on: -BackupSpec) +BackupSpec)

CleanPolicyType represents the clean policy of backup data in remote storage

-

Cluster

+

Cluster

-

ClusterRef

+

ClusterRef

(Appears on: -DMMonitorSpec) +DMMonitorSpec)

ClusterRef reference to a TidbCluster

@@ -4929,10 +4929,10 @@ string -

CommonConfig

+

CommonConfig

(Appears on: -TiFlashConfig) +TiFlashConfig)

CommonConfig is the configuration of TiFlash process.

@@ -4997,7 +4997,7 @@ int64 flash
- + Flash @@ -5010,7 +5010,7 @@ Flash logger
- + FlashLogger @@ -5023,7 +5023,7 @@ FlashLogger security
- + FlashSecurity @@ -5034,28 +5034,28 @@ FlashSecurity -

ComponentAccessor

+

ComponentAccessor

ComponentAccessor is the interface to access component details, which respects the cluster-level properties and component-level overrides

-

ComponentSpec

+

ComponentSpec

(Appears on: -DMDiscoverySpec, -DiscoverySpec, -MasterSpec, -NGMonitoringSpec, -PDSpec, -PumpSpec, -TiCDCSpec, -TiDBSpec, -TiFlashSpec, -TiKVSpec, -TiProxySpec, -TidbDashboardSpec, -TidbNGMonitoringSpec, -WorkerSpec) +DMDiscoverySpec, +DiscoverySpec, +MasterSpec, +NGMonitoringSpec, +PDSpec, +PumpSpec, +TiCDCSpec, +TiDBSpec, +TiFlashSpec, +TiKVSpec, +TiProxySpec, +TidbDashboardSpec, +TidbNGMonitoringSpec, +WorkerSpec)

ComponentSpec is the base spec of each component, the fields should always accessed by the BasicSpec() method to respect the cluster-level properties

@@ -5248,7 +5248,7 @@ Kubernetes core/v1.PodSecurityContext configUpdateStrategy
- + ConfigUpdateStrategy @@ -5440,7 +5440,7 @@ Kubernetes apps/v1.PodManagementPolicyType topologySpreadConstraints
- + []TopologySpreadConstraint @@ -5457,7 +5457,7 @@ All topologySpreadConstraints are ANDed.

suspendAction
- + SuspendAction @@ -5471,7 +5471,7 @@ SuspendAction readinessProbe
- + Probe @@ -5484,13 +5484,13 @@ the default behavior is like setting type as “tcp”

-

ComponentStatus

+

ComponentStatus

-

ConfigMapRef

+

ConfigMapRef

(Appears on: -PrometheusConfiguration) +PrometheusConfiguration)

ConfigMapRef is the external configMap

@@ -5527,23 +5527,23 @@ string -

ConfigUpdateStrategy

+

ConfigUpdateStrategy

(Appears on: -ComponentSpec, -DMClusterSpec, -TidbClusterSpec) +ComponentSpec, +DMClusterSpec, +TidbClusterSpec)

ConfigUpdateStrategy represents the strategy to update configuration

-

ContainerName

+

ContainerName

-

CoprocessorCache

+

CoprocessorCache

(Appears on: -TiKVClient) +TiKVClient)

CoprocessorCache is the config for coprocessor cache.

@@ -5607,10 +5607,10 @@ uint64 -

CrdKind

+

CrdKind

(Appears on: -CrdKinds) +CrdKinds)

@@ -5674,7 +5674,7 @@ string -

CrdKinds

+

CrdKinds

@@ -5699,7 +5699,7 @@ string
TiDBCluster
- + CrdKind @@ -5711,7 +5711,7 @@ CrdKind 		DMCluster
- + CrdKind @@ -5723,7 +5723,7 @@ CrdKind 		Backup
- + CrdKind @@ -5735,7 +5735,7 @@ CrdKind 		Restore
- + CrdKind @@ -5747,7 +5747,7 @@ CrdKind 		BackupSchedule
- + CrdKind @@ -5759,7 +5759,7 @@ CrdKind 		TiDBMonitor
- + CrdKind @@ -5771,7 +5771,7 @@ CrdKind 		TiDBInitializer
- + CrdKind @@ -5783,7 +5783,7 @@ CrdKind 		TidbClusterAutoScaler
- + CrdKind @@ -5795,7 +5795,7 @@ CrdKind 		TiDBNGMonitoring
- + CrdKind @@ -5805,10 +5805,10 @@ CrdKind
-

DMClusterCondition

+

DMClusterCondition

(Appears on: -DMClusterStatus) +DMClusterStatus)

DMClusterCondition is dm cluster condition

@@ -5825,7 +5825,7 @@ CrdKind type
- + DMClusterConditionType @@ -5900,18 +5900,18 @@ string -

DMClusterConditionType

+

DMClusterConditionType

(Appears on: -DMClusterCondition) +DMClusterCondition)

DMClusterConditionType represents a dm cluster condition value.

-

DMClusterSpec

+

DMClusterSpec

(Appears on: -DMCluster) +DMCluster)

DMClusterSpec describes the attributes that a user creates on a dm cluster

@@ -5928,7 +5928,7 @@ string discovery
- + DMDiscoverySpec @@ -5941,7 +5941,7 @@ DMDiscoverySpec master
- + MasterSpec @@ -5955,7 +5955,7 @@ MasterSpec worker
- + WorkerSpec @@ -6045,7 +6045,7 @@ Kubernetes core/v1.PullPolicy configUpdateStrategy
- + ConfigUpdateStrategy @@ -6075,7 +6075,7 @@ Optional: Defaults to false

tlsCluster
- + TLSCluster @@ -6278,7 +6278,7 @@ Kubernetes apps/v1.PodManagementPolicyType topologySpreadConstraints
- + []TopologySpreadConstraint @@ -6295,7 +6295,7 @@ All topologySpreadConstraints are ANDed.

suspendAction
- + SuspendAction @@ -6318,10 +6318,10 @@ bool -

DMClusterStatus

+

DMClusterStatus

(Appears on: -DMCluster) +DMCluster)

DMClusterStatus represents the current status of a dm cluster.

@@ -6338,7 +6338,7 @@ bool master
- + MasterStatus @@ -6350,7 +6350,7 @@ MasterStatus worker
- + WorkerStatus @@ -6362,7 +6362,7 @@ WorkerStatus conditions
- + []DMClusterCondition @@ -6374,10 +6374,10 @@ WorkerStatus -

DMDiscoverySpec

+

DMDiscoverySpec

(Appears on: -DMClusterSpec) +DMClusterSpec)

DMDiscoverySpec contains details of Discovery members for dm

@@ -6394,7 +6394,7 @@ WorkerStatus ComponentSpec
- + ComponentSpec @@ -6433,10 +6433,10 @@ string -

DMExperimental

+

DMExperimental

(Appears on: -MasterConfig) +MasterConfig)

DM experimental config

@@ -6462,10 +6462,10 @@ bool -

DMMonitorSpec

+

DMMonitorSpec

(Appears on: -TidbMonitorSpec) +TidbMonitorSpec)

@@ -6481,7 +6481,7 @@ bool clusters
- + []ClusterRef @@ -6493,7 +6493,7 @@ bool initializer
- + InitializerSpec @@ -6503,11 +6503,11 @@ InitializerSpec -

DMSecurityConfig

+

DMSecurityConfig

(Appears on: -MasterConfig, -WorkerConfig) +MasterConfig, +WorkerConfig)

DM common security config

@@ -6570,10 +6570,10 @@ string -

DashboardConfig

+

DashboardConfig

(Appears on: -PDConfig) +PDConfig)

DashboardConfig is the configuration for tidb-dashboard.

@@ -6685,10 +6685,10 @@ Optional: Defaults to false

-

DeploymentStorageStatus

+

DeploymentStorageStatus

(Appears on: -TidbMonitorStatus) +TidbMonitorStatus)

DeploymentStorageStatus is the storage information of the deployment

@@ -6714,10 +6714,10 @@ string -

DiscoverySpec

+

DiscoverySpec

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

DiscoverySpec contains details of Discovery members

@@ -6734,7 +6734,7 @@ string ComponentSpec
- + ComponentSpec @@ -6762,10 +6762,10 @@ Kubernetes core/v1.ResourceRequirements -

DumplingConfig

+

DumplingConfig

(Appears on: -BackupSpec) +BackupSpec)

DumplingConfig contains config for dumpling

@@ -6802,22 +6802,18 @@ Kubernetes core/v1.ResourceRequirements -

EmptyStruct

+

EmptyStruct

(Appears on: -PDFailureMember, -TiKVFailureStore, -UnjoinedMember) +PDFailureMember, +TiKVFailureStore, +UnjoinedMember)

EmptyStruct is defined to delight controller-gen tools Only named struct is allowed by controller-gen

-

EvictLeaderStatus

-

-(Appears on: -TiKVStatus) -

+

EvictLeaderStatus

@@ -6864,10 +6860,10 @@ string
-

Experimental

+

Experimental

(Appears on: -TiDBConfig) +TiDBConfig)

Experimental controls the features that are still experimental: their semantics, interfaces are subject to change. @@ -6909,10 +6905,10 @@ bool -

ExternalConfig

+

ExternalConfig

(Appears on: -BasicAutoScalerSpec) +BasicAutoScalerSpec)

ExternalConfig represents the external config.

@@ -6929,7 +6925,7 @@ bool endpoint
- + ExternalEndpoint @@ -6953,10 +6949,10 @@ int32 -

ExternalEndpoint

+

ExternalEndpoint

(Appears on: -ExternalConfig) +ExternalConfig)

ExternalEndpoint describes the external service endpoint @@ -7007,7 +7003,7 @@ string tlsSecret
- + SecretRef @@ -7020,12 +7016,12 @@ to communicate to the external service

-

Failover

+

Failover

(Appears on: -TiFlashSpec, -TiKVSpec, -WorkerSpec) +TiFlashSpec, +TiKVSpec, +WorkerSpec)

Failover contains the failover specification.

@@ -7053,27 +7049,27 @@ it takes effect only when set spec.recoverFailover=false

-

FederalVolumeBackupPhase

+

FederalVolumeBackupPhase

(Appears on: -BackupSpec) +BackupSpec)

FederalVolumeBackupPhase represents a phase to execute in federal volume backup

-

FederalVolumeRestorePhase

+

FederalVolumeRestorePhase

(Appears on: -RestoreSpec) +RestoreSpec)

FederalVolumeRestorePhase represents a phase to execute in federal volume restore

-

FileLogConfig

+

FileLogConfig

(Appears on: -Log, -PDLogConfig) +Log, +PDLogConfig)

@@ -7148,10 +7144,10 @@ int -

Flash

+

Flash

(Appears on: -CommonConfig) +CommonConfig)

Flash is the configuration of [flash] section.

@@ -7192,7 +7188,7 @@ int32 flash_cluster
- + FlashCluster @@ -7205,7 +7201,7 @@ FlashCluster proxy
- + FlashProxy @@ -7216,10 +7212,10 @@ FlashProxy -

FlashCluster

+

FlashCluster

(Appears on: -Flash) +Flash)

FlashCluster is the configuration of [flash.flash_cluster] section.

@@ -7282,10 +7278,10 @@ int32 -

FlashLogger

+

FlashLogger

(Appears on: -CommonConfig) +CommonConfig)

FlashLogger is the configuration of [logger] section.

@@ -7360,10 +7356,10 @@ int32 -

FlashProxy

+

FlashProxy

(Appears on: -Flash) +Flash)

FlashProxy is the configuration of [flash.proxy] section.

@@ -7438,10 +7434,10 @@ string -

FlashSecurity

+

FlashSecurity

(Appears on: -CommonConfig) +CommonConfig)

@@ -7503,10 +7499,10 @@ string -

FlashServerConfig

+

FlashServerConfig

(Appears on: -ProxyConfig) +ProxyConfig)

FlashServerConfig is the configuration of Proxy server.

@@ -7559,7 +7555,7 @@ string TiKVServerConfig
- + TiKVServerConfig @@ -7572,10 +7568,10 @@ TiKVServerConfig -

GcsStorageProvider

+

GcsStorageProvider

(Appears on: -StorageProvider) +StorageProvider)

GcsStorageProvider represents the google cloud storage for storing backups.

@@ -7691,10 +7687,10 @@ string -

GrafanaSpec

+

GrafanaSpec

(Appears on: -TidbMonitorSpec) +TidbMonitorSpec)

GrafanaSpec is the desired state of grafana

@@ -7711,7 +7707,7 @@ string MonitorContainer
- + MonitorContainer @@ -7737,7 +7733,7 @@ string service
- + ServiceSpec @@ -7813,7 +7809,7 @@ map[string]string ingress
- + IngressSpec @@ -7838,10 +7834,10 @@ IngressSpec -

HelperSpec

+

HelperSpec

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

HelperSpec contains details of helper component

@@ -7884,11 +7880,11 @@ Optional: Defaults to the cluster-level setting

-

IngressSpec

+

IngressSpec

(Appears on: -GrafanaSpec, -PrometheusSpec) +GrafanaSpec, +PrometheusSpec)

IngressSpec describe the ingress desired state for the target component

@@ -7944,10 +7940,10 @@ ingress supports SNI.

-

InitContainerSpec

+

InitContainerSpec

(Appears on: -TiFlashSpec) +TiFlashSpec)

InitContainerSpec contains basic spec about a init container

@@ -7977,18 +7973,18 @@ Kubernetes core/v1.ResourceRequirements -

InitializePhase

+

InitializePhase

(Appears on: -TidbInitializerStatus) +TidbInitializerStatus)

-

InitializerSpec

+

InitializerSpec

(Appears on: -DMMonitorSpec, -TidbMonitorSpec) +DMMonitorSpec, +TidbMonitorSpec)

InitializerSpec is the desired state of initializer

@@ -8005,7 +8001,7 @@ Kubernetes core/v1.ResourceRequirements MonitorContainer
- + MonitorContainer @@ -8029,10 +8025,10 @@ map[string]string -

Interval

+

Interval

(Appears on: -Quota) +Quota)

Interval is the configuration of [quotas.default.interval] section.

@@ -8119,10 +8115,10 @@ int32 -

IsolationRead

+

IsolationRead

(Appears on: -TiDBConfig) +TiDBConfig)

IsolationRead is the config for isolation read.

@@ -8150,10 +8146,10 @@ imported from v3.1.0

-

LocalStorageProvider

+

LocalStorageProvider

(Appears on: -StorageProvider) +StorageProvider)

LocalStorageProvider defines local storage options, which can be any k8s supported mounted volume

@@ -8202,10 +8198,10 @@ string -

Log

+

Log

(Appears on: -TiDBConfig) +TiDBConfig)

Log is the log section of config.

@@ -8286,7 +8282,7 @@ message.

file
- + FileLogConfig @@ -8368,10 +8364,10 @@ uint32 -

LogSubCommandStatus

+

LogSubCommandStatus

(Appears on: -BackupStatus) +BackupStatus)

LogSubCommandStatus is the log backup subcommand’s status.

@@ -8388,7 +8384,7 @@ uint32 command
- + LogSubCommandType @@ -8440,7 +8436,7 @@ string phase
- + BackupConditionType @@ -8453,7 +8449,7 @@ BackupConditionType conditions
- + []BackupCondition @@ -8463,20 +8459,20 @@ BackupConditionType -

LogSubCommandType

+

LogSubCommandType

(Appears on: -BackupCondition, -LogSubCommandStatus) +BackupCondition, +LogSubCommandStatus)

LogSubCommandType is the log backup subcommand type.

-

LogTailerSpec

+

LogTailerSpec

(Appears on: -TiFlashSpec, -TiKVSpec) +TiFlashSpec, +TiKVSpec)

LogTailerSpec represents an optional log tailer sidecar container

@@ -8506,7 +8502,7 @@ Kubernetes core/v1.ResourceRequirements -

MasterConfig

+

MasterConfig

MasterConfig is the configuration of dm-master-server

@@ -8598,7 +8594,7 @@ Optional: Defaults to 40

DMSecurityConfig
- + DMSecurityConfig @@ -8615,7 +8611,7 @@ DMSecurityConfig experimental
- + DMExperimental @@ -8627,10 +8623,10 @@ DMExperimental -

MasterConfigWraper

+

MasterConfigWraper

(Appears on: -MasterSpec) +MasterSpec)

@@ -8657,10 +8653,10 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

MasterFailureMember

+

MasterFailureMember

(Appears on: -MasterStatus) +MasterStatus)

MasterFailureMember is the dm-master failure member information

@@ -8727,12 +8723,12 @@ Kubernetes meta/v1.Time -

MasterKeyFileConfig

+

MasterKeyFileConfig

(Appears on: -TiKVMasterKeyConfig, -TiKVSecurityConfigEncryptionMasterKey, -TiKVSecurityConfigEncryptionPreviousMasterKey) +TiKVMasterKeyConfig, +TiKVSecurityConfigEncryptionMasterKey, +TiKVSecurityConfigEncryptionPreviousMasterKey)

@@ -8771,12 +8767,12 @@ string -

MasterKeyKMSConfig

+

MasterKeyKMSConfig

(Appears on: -TiKVMasterKeyConfig, -TiKVSecurityConfigEncryptionMasterKey, -TiKVSecurityConfigEncryptionPreviousMasterKey) +TiKVMasterKeyConfig, +TiKVSecurityConfigEncryptionMasterKey, +TiKVSecurityConfigEncryptionPreviousMasterKey)

@@ -8851,10 +8847,10 @@ optional

-

MasterMember

+

MasterMember

(Appears on: -MasterStatus) +MasterStatus)

MasterMember is dm-master member status

@@ -8924,10 +8920,10 @@ Kubernetes meta/v1.Time -

MasterServiceSpec

+

MasterServiceSpec

(Appears on: -MasterSpec) +MasterSpec)

@@ -8943,7 +8939,7 @@ Kubernetes meta/v1.Time ServiceSpec
- + ServiceSpec @@ -8983,10 +8979,10 @@ int -

MasterSpec

+

MasterSpec

(Appears on: -DMClusterSpec) +DMClusterSpec)

MasterSpec contains details of dm-master members

@@ -9003,7 +8999,7 @@ int ComponentSpec
- + ComponentSpec @@ -9056,7 +9052,7 @@ string service
- + MasterServiceSpec @@ -9129,7 +9125,7 @@ Defaults to “” (volume’s root).

config
- + MasterConfigWraper @@ -9153,10 +9149,10 @@ string -

MasterStatus

+

MasterStatus

(Appears on: -DMClusterStatus) +DMClusterStatus)

MasterStatus is dm-master status

@@ -9183,7 +9179,7 @@ bool phase
- + MemberPhase @@ -9207,7 +9203,7 @@ Kubernetes apps/v1.StatefulSetStatus members
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.MasterMember @@ -9219,7 +9215,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.MasterMemb leader
- + MasterMember @@ -9231,7 +9227,7 @@ MasterMember failureMembers
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.MasterFailureMember @@ -9243,7 +9239,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.MasterFail unjoinedMembers
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.UnjoinedMember @@ -9265,7 +9261,7 @@ string volumes
- + map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeStatus @@ -9290,31 +9286,31 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName -

MemberPhase

+

MemberPhase

(Appears on: -MasterStatus, -NGMonitoringStatus, -PDStatus, -PumpStatus, -TiCDCStatus, -TiDBStatus, -TiKVStatus, -TiProxyStatus, -TidbDashboardStatus, -WorkerStatus) +MasterStatus, +NGMonitoringStatus, +PDStatus, +PumpStatus, +TiCDCStatus, +TiDBStatus, +TiKVStatus, +TiProxyStatus, +TidbDashboardStatus, +WorkerStatus)

MemberPhase is the current state of member

-

MemberType

+

MemberType

MemberType represents member type

-

MetadataConfig

+

MetadataConfig

(Appears on: -RemoteWriteSpec) +RemoteWriteSpec)

Configures the sending of series metadata to remote storage.

@@ -9351,18 +9347,18 @@ string -

MonitorComponentAccessor

+

MonitorComponentAccessor

-

MonitorContainer

+

MonitorContainer

(Appears on: -GrafanaSpec, -InitializerSpec, -PrometheusReloaderSpec, -PrometheusSpec, -ReloaderSpec, -ThanosSpec) +GrafanaSpec, +InitializerSpec, +PrometheusReloaderSpec, +PrometheusSpec, +ReloaderSpec, +ThanosSpec)

MonitorContainer is the common attributes of the container of monitoring

@@ -9425,10 +9421,10 @@ Kubernetes core/v1.PullPolicy -

NGMonitoringSpec

+

NGMonitoringSpec

(Appears on: -TidbNGMonitoringSpec) +TidbNGMonitoringSpec)

NGMonitoringSpec is spec of ng monitoring

@@ -9445,7 +9441,7 @@ Kubernetes core/v1.PullPolicy ComponentSpec
- + ComponentSpec @@ -9498,7 +9494,7 @@ Defaults to Kubernetes default storage class.

storageVolumes
- + []StorageVolume @@ -9520,10 +9516,10 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

NGMonitoringStatus

+

NGMonitoringStatus

(Appears on: -TidbNGMonitoringStatus) +TidbNGMonitoringStatus)

NGMonitoringStatus is latest status of ng monitoring

@@ -9550,7 +9546,7 @@ bool phase
- + MemberPhase @@ -9572,10 +9568,10 @@ Kubernetes apps/v1.StatefulSetStatus -

Networks

+

Networks

(Appears on: -User) +User)

Networks is the configuration of [users.readonly.networks] section.

@@ -9601,10 +9597,10 @@ string -

ObservedStorageVolumeStatus

+

ObservedStorageVolumeStatus

(Appears on: -StorageVolumeStatus) +StorageVolumeStatus)

@@ -9728,10 +9724,10 @@ int -

OpenTracing

+

OpenTracing

(Appears on: -TiDBConfig) +TiDBConfig)

OpenTracing is the opentracing section of the config.

@@ -9760,7 +9756,7 @@ bool sampler
- + OpenTracingSampler @@ -9773,7 +9769,7 @@ OpenTracingSampler reporter
- + OpenTracingReporter @@ -9795,10 +9791,10 @@ bool -

OpenTracingReporter

+

OpenTracingReporter

(Appears on: -OpenTracing) +OpenTracing)

OpenTracingReporter is the config for opentracing reporter. @@ -9858,10 +9854,10 @@ string -

OpenTracingSampler

+

OpenTracingSampler

(Appears on: -OpenTracing) +OpenTracing)

OpenTracingSampler is the config for opentracing sampler. @@ -9932,7 +9928,7 @@ time.Duration -

PDConfig

+

PDConfig

PDConfig is the configuration of pd-server

@@ -9999,7 +9995,7 @@ Optional: Defaults to 3

log
- + PDLogConfig @@ -10049,7 +10045,7 @@ Optional: Defaults to 3s

metric
- + PDMetricConfig @@ -10062,7 +10058,7 @@ PDMetricConfig schedule
- + PDScheduleConfig @@ -10076,7 +10072,7 @@ PDScheduleConfig replication
- + PDReplicationConfig @@ -10090,7 +10086,7 @@ PDReplicationConfig namespace
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDNamespaceConfig @@ -10103,7 +10099,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDNamespac pd-server
- + PDServerConfig @@ -10209,7 +10205,7 @@ Optional: Defaults to true

security
- + PDSecurityConfig @@ -10222,7 +10218,7 @@ PDSecurityConfig label-property
- + PDLabelPropertyConfig @@ -10250,7 +10246,7 @@ Optional: Defaults to true

dashboard
- + DashboardConfig @@ -10261,10 +10257,10 @@ DashboardConfig -

PDConfigWraper

+

PDConfigWraper

(Appears on: -PDSpec) +PDSpec)

@@ -10291,10 +10287,10 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

PDFailureMember

+

PDFailureMember

(Appears on: -PDStatus) +PDStatus)

PDFailureMember is the pd failure member information

@@ -10341,7 +10337,7 @@ k8s.io/apimachinery/pkg/types.UID pvcUIDSet
- + map[k8s.io/apimachinery/pkg/types.UID]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.EmptyStruct @@ -10383,17 +10379,17 @@ Kubernetes meta/v1.Time -

PDLabelPropertyConfig

+

PDLabelPropertyConfig

(Appears on: -PDConfig) +PDConfig)

-

PDLogConfig

+

PDLogConfig

(Appears on: -PDConfig) +PDConfig)

PDLogConfig serializes log related config in toml/json.

@@ -10447,7 +10443,7 @@ bool file
- + FileLogConfig @@ -10512,10 +10508,10 @@ message.

-

PDMember

+

PDMember

(Appears on: -PDStatus) +PDStatus)

PDMember is PD member

@@ -10586,10 +10582,10 @@ TODO: remove nullable, PDMetricConfig +

PDMetricConfig

(Appears on: -PDConfig) +PDConfig)

@@ -10636,10 +10632,10 @@ string -

PDNamespaceConfig

+

PDNamespaceConfig

(Appears on: -PDConfig) +PDConfig)

PDNamespaceConfig is to overwrite the global setting for specific namespace

@@ -10726,10 +10722,10 @@ uint64 -

PDReplicationConfig

+

PDReplicationConfig

(Appears on: -PDConfig) +PDConfig)

PDReplicationConfig is the replication configuration.

@@ -10800,10 +10796,10 @@ bool -

PDScheduleConfig

+

PDScheduleConfig

(Appears on: -PDConfig) +PDConfig)

ScheduleConfig is the schedule configuration.

@@ -11149,7 +11145,7 @@ Immutable, change should be made through pd-ctl after cluster creation

schedulers-v2
- + PDSchedulerConfigs @@ -11201,7 +11197,7 @@ Imported from v3.1.0

-

PDSchedulerConfig

+

PDSchedulerConfig

PDSchedulerConfig is customized scheduler configuration

@@ -11251,17 +11247,17 @@ bool -

PDSchedulerConfigs

+

PDSchedulerConfigs

(Appears on: -PDScheduleConfig) +PDScheduleConfig)

-

PDSecurityConfig

+

PDSecurityConfig

(Appears on: -PDConfig) +PDConfig)

PDSecurityConfig is the configuration for supporting tls.

@@ -11324,10 +11320,10 @@ string -

PDServerConfig

+

PDServerConfig

(Appears on: -PDConfig) +PDConfig)

PDServerConfig is the configuration for pd server.

@@ -11368,10 +11364,10 @@ Imported from v3.1.0

-

PDSpec

+

PDSpec

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

PDSpec contains details of PD members

@@ -11388,7 +11384,7 @@ Imported from v3.1.0

ComponentSpec
- + ComponentSpec @@ -11452,7 +11448,7 @@ string service
- + ServiceSpec @@ -11493,7 +11489,7 @@ Defaults to Kubernetes default storage class.

storageVolumes
- + []StorageVolume @@ -11526,7 +11522,7 @@ Defaults to “” (volume’s root).

config
- + PDConfigWraper @@ -11599,10 +11595,10 @@ int -

PDStatus

+

PDStatus

(Appears on: -TidbClusterStatus) +TidbClusterStatus)

PDStatus is PD status

@@ -11630,7 +11626,7 @@ bool phase
- + MemberPhase @@ -11654,7 +11650,7 @@ Kubernetes apps/v1.StatefulSetStatus members
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDMember @@ -11667,7 +11663,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDMember peerMembers
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDMember @@ -11680,7 +11676,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDMember leader
- + PDMember @@ -11692,7 +11688,7 @@ PDMember failureMembers
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDFailureMember @@ -11704,7 +11700,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PDFailureM unjoinedMembers
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.UnjoinedMember @@ -11726,7 +11722,7 @@ string volumes
- + map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeStatus @@ -11751,7 +11747,7 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName -

PDStoreLabel

+

PDStoreLabel

PDStoreLabel is the config item of LabelPropertyConfig.

@@ -11787,13 +11783,13 @@ string -

PDStoreLabels

+

PDStoreLabels

-

Performance

+

Performance

(Appears on: -TiDBConfig) +TiDBConfig)

Performance is the performance section of the config.

@@ -12009,10 +12005,10 @@ Optional: Defaults to 300000

-

PessimisticTxn

+

PessimisticTxn

(Appears on: -TiDBConfig) +TiDBConfig)

PessimisticTxn is the config for pessimistic transaction.

@@ -12053,7 +12049,7 @@ Optional: Defaults to 256

-

PlanCache

+

PlanCache

PlanCache is the PlanCache section of the config.

@@ -12100,10 +12096,10 @@ uint -

Plugin

+

Plugin

(Appears on: -TiDBConfig) +TiDBConfig)

Plugin is the config for plugin

@@ -12140,10 +12136,10 @@ string -

PreparedPlanCache

+

PreparedPlanCache

(Appears on: -TiDBConfig) +TiDBConfig)

PreparedPlanCache is the PreparedPlanCache section of the config.

@@ -12194,10 +12190,10 @@ float64 -

Probe

+

Probe

(Appears on: -ComponentSpec) +ComponentSpec)

Probe contains details of probing tidb. @@ -12254,7 +12250,7 @@ Default to Kubernetes default (10 seconds). Minimum value is 1.

-

Profile

+

Profile

Profile is the configuration profiles.

@@ -12312,11 +12308,11 @@ string -

Progress

+

Progress

(Appears on: -BackupStatus, -RestoreStatus) +BackupStatus, +RestoreStatus)

@@ -12365,10 +12361,10 @@ Kubernetes meta/v1.Time -

PrometheusConfiguration

+

PrometheusConfiguration

(Appears on: -PrometheusSpec) +PrometheusSpec)

Config is the the desired state of Prometheus Configuration

@@ -12385,7 +12381,7 @@ Kubernetes meta/v1.Time configMapRef
- + ConfigMapRef @@ -12409,7 +12405,7 @@ ConfigMapRef ruleConfigRef
- + ConfigMapRef @@ -12420,10 +12416,10 @@ ConfigMapRef -

PrometheusReloaderSpec

+

PrometheusReloaderSpec

(Appears on: -TidbMonitorSpec) +TidbMonitorSpec)

PrometheusReloaderSpec is the desired state of prometheus configuration reloader

@@ -12440,7 +12436,7 @@ ConfigMapRef MonitorContainer
- + MonitorContainer @@ -12453,10 +12449,10 @@ MonitorContainer -

PrometheusSpec

+

PrometheusSpec

(Appears on: -TidbMonitorSpec) +TidbMonitorSpec)

PrometheusSpec is the desired state of prometheus

@@ -12473,7 +12469,7 @@ MonitorContainer MonitorContainer
- + MonitorContainer @@ -12499,7 +12495,7 @@ string service
- + ServiceSpec @@ -12538,7 +12534,7 @@ If set to non empty values, it will override the value of ReserveDays ingress
- + IngressSpec @@ -12552,7 +12548,7 @@ IngressSpec config
- + PrometheusConfiguration @@ -12578,8 +12574,8 @@ Defaults to false.

remoteWrite
- -[]RemoteWriteSpec + +[]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.RemoteWriteSpec @@ -12602,10 +12598,10 @@ Defaults to false.

-

ProxyConfig

+

ProxyConfig

(Appears on: -TiFlashConfig) +TiFlashConfig)

ProxyConfig is the configuration of TiFlash proxy process. @@ -12669,7 +12665,7 @@ bool server
- + FlashServerConfig @@ -12682,7 +12678,7 @@ FlashServerConfig storage
- + TiKVStorageConfig @@ -12695,7 +12691,7 @@ TiKVStorageConfig raftstore
- + TiKVRaftstoreConfig @@ -12708,7 +12704,7 @@ TiKVRaftstoreConfig rocksdb
- + TiKVDbConfig @@ -12721,7 +12717,7 @@ TiKVDbConfig coprocessor
- + TiKVCoprocessorConfig @@ -12734,7 +12730,7 @@ TiKVCoprocessorConfig readpool
- + TiKVReadPoolConfig @@ -12747,7 +12743,7 @@ TiKVReadPoolConfig raftdb
- + TiKVRaftDBConfig @@ -12760,7 +12756,7 @@ TiKVRaftDBConfig import
- + TiKVImportConfig @@ -12773,7 +12769,7 @@ TiKVImportConfig gc
- + TiKVGCConfig @@ -12786,7 +12782,7 @@ TiKVGCConfig pd
- + TiKVPDConfig @@ -12799,7 +12795,7 @@ TiKVPDConfig security
- + TiKVSecurityConfig @@ -12810,10 +12806,10 @@ TiKVSecurityConfig -

ProxyProtocol

+

ProxyProtocol

(Appears on: -TiDBConfig) +TiDBConfig)

ProxyProtocol is the PROXY protocol section of the config.

@@ -12854,11 +12850,7 @@ uint -

PumpNodeStatus

-

-(Appears on: -PumpStatus) -

+

PumpNodeStatus

PumpNodeStatus represents the status saved in etcd.

@@ -12902,10 +12894,10 @@ string -

PumpSpec

+

PumpSpec

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

PumpSpec contains details of Pump members

@@ -12922,7 +12914,7 @@ string ComponentSpec
- + ComponentSpec @@ -13020,10 +13012,10 @@ bool -

PumpStatus

+

PumpStatus

(Appears on: -TidbClusterStatus) +TidbClusterStatus)

PumpStatus is Pump status

@@ -13040,7 +13032,7 @@ bool phase
- + MemberPhase @@ -13064,8 +13056,8 @@ Kubernetes apps/v1.StatefulSetStatus members
- -[]PumpNodeStatus + +[]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.PumpNodeStatus @@ -13076,7 +13068,7 @@ Kubernetes apps/v1.StatefulSetStatus volumes
- + map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeStatus @@ -13101,10 +13093,10 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName -

QueueConfig

+

QueueConfig

(Appears on: -RemoteWriteSpec) +RemoteWriteSpec)

QueueConfig allows the tuning of remote_write queue_config parameters. This object @@ -13208,7 +13200,7 @@ time.Duration -

Quota

+

Quota

Quota is the configuration of [quotas.default] section.

@@ -13224,7 +13216,7 @@ time.Duration interval
- + Interval @@ -13235,10 +13227,10 @@ Interval -

RelabelConfig

+

RelabelConfig

(Appears on: -RemoteWriteSpec) +RemoteWriteSpec)

RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. @@ -13334,10 +13326,10 @@ github.com/prometheus/prometheus/config.RelabelAction -

ReloaderSpec

+

ReloaderSpec

(Appears on: -TidbMonitorSpec) +TidbMonitorSpec)

ReloaderSpec is the desired state of reloader

@@ -13354,7 +13346,7 @@ github.com/prometheus/prometheus/config.RelabelAction MonitorContainer
- + MonitorContainer @@ -13369,7 +13361,7 @@ MonitorContainer service
- + ServiceSpec @@ -13379,11 +13371,7 @@ ServiceSpec -

RemoteWriteSpec

-

-(Appears on: -PrometheusSpec) -

+

RemoteWriteSpec

RemoteWriteSpec defines the remote_write configuration for prometheus.

@@ -13435,7 +13423,7 @@ github.com/prometheus/common/model.Duration writeRelabelConfigs
- + []RelabelConfig @@ -13449,7 +13437,7 @@ github.com/prometheus/common/model.Duration basicAuth
- + BasicAuth @@ -13487,7 +13475,7 @@ string tlsConfig
- + TLSConfig @@ -13513,7 +13501,7 @@ string queueConfig
- + QueueConfig @@ -13526,7 +13514,7 @@ QueueConfig metadataConfig
- + MetadataConfig @@ -13552,10 +13540,10 @@ Only valid in Prometheus versions 2.25.0 and newer.

-

RestoreCondition

+

RestoreCondition

(Appears on: -RestoreStatus) +RestoreStatus)

RestoreCondition describes the observed state of a Restore at a certain point.

@@ -13572,7 +13560,7 @@ Only valid in Prometheus versions 2.25.0 and newer.

type
- + RestoreConditionType @@ -13626,27 +13614,27 @@ string -

RestoreConditionType

+

RestoreConditionType

(Appears on: -RestoreCondition, -RestoreStatus) +RestoreCondition, +RestoreStatus)

RestoreConditionType represents a valid condition of a Restore.

-

RestoreMode

+

RestoreMode

(Appears on: -RestoreSpec) +RestoreSpec)

RestoreMode represents the restore mode, such as snapshot or pitr.

-

RestoreSpec

+

RestoreSpec

(Appears on: -Restore) +Restore)

RestoreSpec contains the specification for a restore of a tidb cluster backup.

@@ -13705,7 +13693,7 @@ Note that the following builtin env vars will be overwritten by values set here to
- + TiDBAccessConfig @@ -13718,7 +13706,7 @@ TiDBAccessConfig backupType
- + BackupType @@ -13731,7 +13719,7 @@ BackupType restoreMode
- + RestoreMode @@ -13766,7 +13754,7 @@ string federalVolumeRestorePhase
- + FederalVolumeRestorePhase @@ -13806,7 +13794,7 @@ When a GC happens, the current time minus this value is the safe point.

StorageProvider
- + StorageProvider @@ -13822,7 +13810,7 @@ StorageProvider pitrFullBackupStorageProvider
- + StorageProvider @@ -13859,7 +13847,7 @@ string br
- + BRConfig @@ -13984,10 +13972,10 @@ string -

RestoreStatus

+

RestoreStatus

(Appears on: -Restore) +Restore)

RestoreStatus represents the current status of a tidb cluster restore.

@@ -14052,7 +14040,7 @@ string phase
- + RestoreConditionType @@ -14065,7 +14053,7 @@ RestoreConditionType conditions
- + []RestoreCondition @@ -14077,7 +14065,7 @@ RestoreConditionType progresses
- + []Progress @@ -14088,10 +14076,10 @@ RestoreConditionType -

S3StorageProvider

+

S3StorageProvider

(Appears on: -StorageProvider) +StorageProvider)

S3StorageProvider represents a S3 compliant storage for storing backups.

@@ -14108,7 +14096,7 @@ RestoreConditionType provider
- + S3StorageProviderType @@ -14231,18 +14219,18 @@ string -

S3StorageProviderType

+

S3StorageProviderType

(Appears on: -S3StorageProvider) +S3StorageProvider)

S3StorageProviderType represents the specific storage provider that implements the S3 interface

-

SafeTLSConfig

+

SafeTLSConfig

(Appears on: -TLSConfig) +TLSConfig)

SafeTLSConfig specifies safe TLS configuration parameters.

@@ -14259,7 +14247,7 @@ string ca
- + SecretOrConfigMap @@ -14272,7 +14260,7 @@ SecretOrConfigMap cert
- + SecretOrConfigMap @@ -14318,11 +14306,11 @@ bool -

ScalePolicy

+

ScalePolicy

(Appears on: -TiFlashSpec, -TiKVSpec) +TiFlashSpec, +TiKVSpec)

@@ -14360,10 +14348,10 @@ int32 -

SecretOrConfigMap

+

SecretOrConfigMap

(Appears on: -SafeTLSConfig) +SafeTLSConfig)

SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive.

@@ -14404,10 +14392,10 @@ Kubernetes core/v1.ConfigMapKeySelector -

SecretRef

+

SecretRef

(Appears on: -ExternalEndpoint) +ExternalEndpoint)

SecretRef indicates to secret ref

@@ -14442,10 +14430,10 @@ string -

Security

+

Security

(Appears on: -TiDBConfig) +TiDBConfig)

Security is the security section of the config.

@@ -14549,10 +14537,10 @@ string -

Service

+

Service

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

(Deprecated) Service represent service type used in TidbCluster

@@ -14587,16 +14575,16 @@ string -

ServiceSpec

+

ServiceSpec

(Appears on: -GrafanaSpec, -MasterServiceSpec, -PDSpec, -PrometheusSpec, -ReloaderSpec, -TiDBServiceSpec, -TidbDashboardSpec) +GrafanaSpec, +MasterServiceSpec, +PDSpec, +PrometheusSpec, +ReloaderSpec, +TiDBServiceSpec, +TidbDashboardSpec)

ServiceSpec specifies the service object in k8s

@@ -14715,17 +14703,17 @@ Optional: Defaults to omitted

-

StartScriptVersion

+

StartScriptVersion

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

-

Status

+

Status

(Appears on: -TiDBConfig) +TiDBConfig)

Status is the status section of the config.

@@ -14787,10 +14775,10 @@ bool -

StmtSummary

+

StmtSummary

(Appears on: -TiDBConfig) +TiDBConfig)

StmtSummary is the config for statement summary.

@@ -14879,10 +14867,10 @@ int -

StorageClaim

+

StorageClaim

(Appears on: -TiFlashSpec) +TiFlashSpec)

StorageClaim contains details of TiFlash storages

@@ -14925,11 +14913,11 @@ More info: StorageProvider +

StorageProvider

(Appears on: -BackupSpec, -RestoreSpec) +BackupSpec, +RestoreSpec)

StorageProvider defines the configuration for storing a backup in backend storage.

@@ -14946,7 +14934,7 @@ More info: + S3StorageProvider @@ -14958,7 +14946,7 @@ S3StorageProvider gcs
- + GcsStorageProvider @@ -14970,7 +14958,7 @@ GcsStorageProvider azblob
- + AzblobStorageProvider @@ -14982,7 +14970,7 @@ AzblobStorageProvider local
- + LocalStorageProvider @@ -14992,16 +14980,16 @@ LocalStorageProvider -

StorageVolume

+

StorageVolume

(Appears on: -NGMonitoringSpec, -PDSpec, -TiCDCSpec, -TiDBSpec, -TiKVSpec, -TiProxySpec, -TidbDashboardSpec) +NGMonitoringSpec, +PDSpec, +TiCDCSpec, +TiDBSpec, +TiKVSpec, +TiProxySpec, +TidbDashboardSpec)

StorageVolume configures additional PVC template for StatefulSets and volumeMount for pods that mount this PVC. @@ -15060,26 +15048,15 @@ string -

StorageVolumeName

+

StorageVolumeName

(Appears on: -StorageVolumeStatus) +StorageVolumeStatus)

StorageVolumeName is the volume name which is same as volumes.name in Pod spec.

-

StorageVolumeStatus

-

-(Appears on: -MasterStatus, -PDStatus, -PumpStatus, -TiCDCStatus, -TiDBStatus, -TiKVStatus, -TiProxyStatus, -WorkerStatus) -

+

StorageVolumeStatus

StorageVolumeStatus is the actual status for a storage

@@ -15095,7 +15072,7 @@ string ObservedStorageVolumeStatus
- + ObservedStorageVolumeStatus @@ -15110,7 +15087,7 @@ ObservedStorageVolumeStatus name
- + StorageVolumeName @@ -15121,12 +15098,12 @@ StorageVolumeName -

SuspendAction

+

SuspendAction

(Appears on: -ComponentSpec, -DMClusterSpec, -TidbClusterSpec) +ComponentSpec, +DMClusterSpec, +TidbClusterSpec)

SuspendAction defines the suspend actions for a component.

@@ -15151,11 +15128,11 @@ bool -

TLSCluster

+

TLSCluster

(Appears on: -DMClusterSpec, -TidbClusterSpec) +DMClusterSpec, +TidbClusterSpec)

TLSCluster can enable mutual TLS connection between TiDB cluster components @@ -15198,11 +15175,11 @@ Same for other components.

-

TLSConfig

+

TLSConfig

(Appears on: -RemoteWriteSpec, -ThanosSpec) +RemoteWriteSpec, +ThanosSpec)

TLSConfig extends the safe TLS configuration with file parameters.

@@ -15219,7 +15196,7 @@ Same for other components.

SafeTLSConfig
- + SafeTLSConfig @@ -15265,10 +15242,10 @@ string -

ThanosSpec

+

ThanosSpec

(Appears on: -TidbMonitorSpec) +TidbMonitorSpec)

ThanosSpec is the desired state of thanos sidecar

@@ -15285,7 +15262,7 @@ string MonitorContainer
- + MonitorContainer @@ -15363,7 +15340,7 @@ When used alongside with TracingConfig, TracingConfigFile takes precedence.

grpcServerTlsConfig
- + TLSConfig @@ -15434,10 +15411,10 @@ string -

TiCDCCapture

+

TiCDCCapture

(Appears on: -TiCDCStatus) +TiCDCStatus)

TiCDCCapture is TiCDC Capture status

@@ -15502,7 +15479,7 @@ bool -

TiCDCConfig

+

TiCDCConfig

TiCDCConfig is the configuration of tidbcdc ref https://github.com/pingcap/ticdc/blob/a28d9e43532edc4a0380f0ef87314631bf18d866/pkg/config/config.go#L176

@@ -15569,10 +15546,10 @@ Optional: Defaults to /dev/stderr

-

TiCDCSpec

+

TiCDCSpec

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

TiCDCSpec contains details of TiCDC members

@@ -15589,7 +15566,7 @@ Optional: Defaults to /dev/stderr

ComponentSpec
- + ComponentSpec @@ -15666,7 +15643,7 @@ string config
- + CDCConfigWraper @@ -15680,7 +15657,7 @@ CDCConfigWraper storageVolumes
- + []StorageVolume @@ -15721,10 +15698,10 @@ Defaults to 10m

-

TiCDCStatus

+

TiCDCStatus

(Appears on: -TidbClusterStatus) +TidbClusterStatus)

TiCDCStatus is TiCDC status

@@ -15751,7 +15728,7 @@ bool phase
- + MemberPhase @@ -15775,7 +15752,7 @@ Kubernetes apps/v1.StatefulSetStatus captures
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiCDCCapture @@ -15787,7 +15764,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiCDCCaptu volumes
- + map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeStatus @@ -15812,11 +15789,11 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName -

TiDBAccessConfig

+

TiDBAccessConfig

(Appears on: -BackupSpec, -RestoreSpec) +BackupSpec, +RestoreSpec)

TiDBAccessConfig defines the configuration for access tidb cluster

@@ -15888,7 +15865,7 @@ Optional: Defaults to nil

-

TiDBConfig

+

TiDBConfig

TiDBConfig is the configuration of tidb-server For more detail, refer to https://pingcap.com/docs/stable/reference/configuration/tidb-server/configuration/

@@ -16070,7 +16047,7 @@ bool txn-local-latches
- + TxnLocalLatches @@ -16095,7 +16072,7 @@ int log
- + Log @@ -16108,7 +16085,7 @@ Log security
- + Security @@ -16121,7 +16098,7 @@ Security status
- + Status @@ -16134,7 +16111,7 @@ Status performance
- + Performance @@ -16147,7 +16124,7 @@ Performance prepared-plan-cache
- + PreparedPlanCache @@ -16160,7 +16137,7 @@ PreparedPlanCache opentracing
- + OpenTracing @@ -16173,7 +16150,7 @@ OpenTracing proxy-protocol
- + ProxyProtocol @@ -16186,7 +16163,7 @@ ProxyProtocol tikv-client
- + TiKVClient @@ -16199,7 +16176,7 @@ TiKVClient binlog
- + Binlog @@ -16223,7 +16200,7 @@ bool plugin
- + Plugin @@ -16236,7 +16213,7 @@ Plugin pessimistic-txn
- + PessimisticTxn @@ -16297,7 +16274,7 @@ uint64 stmt-summary
- + StmtSummary @@ -16333,7 +16310,7 @@ bool isolation-read
- + IsolationRead @@ -16371,7 +16348,7 @@ bool experimental
- + Experimental @@ -16461,10 +16438,10 @@ map[string]string -

TiDBConfigWraper

+

TiDBConfigWraper

(Appears on: -TiDBSpec) +TiDBSpec)

TiDBConfigWraper simply wrapps a GenericConfig

@@ -16492,10 +16469,10 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

TiDBFailureMember

+

TiDBFailureMember

(Appears on: -TiDBStatus) +TiDBStatus)

TiDBFailureMember is the tidb failure member information

@@ -16532,10 +16509,10 @@ Kubernetes meta/v1.Time -

TiDBInitializer

+

TiDBInitializer

(Appears on: -TiDBSpec) +TiDBSpec)

@@ -16559,10 +16536,10 @@ bool -

TiDBMember

+

TiDBMember

(Appears on: -TiDBStatus) +TiDBStatus)

TiDBMember is TiDB member

@@ -16621,10 +16598,10 @@ string -

TiDBServiceSpec

+

TiDBServiceSpec

(Appears on: -TiDBSpec) +TiDBSpec)

TiDBServiceSpec defines .tidb.service field of TidbCluster.spec.

@@ -16641,7 +16618,7 @@ string ServiceSpec
- + ServiceSpec @@ -16723,10 +16700,10 @@ Optional: Defaults to omitted

-

TiDBSlowLogTailerSpec

+

TiDBSlowLogTailerSpec

(Appears on: -TiDBSpec) +TiDBSpec)

TiDBSlowLogTailerSpec represents an optional log tailer sidecar with TiDB

@@ -16782,10 +16759,10 @@ Use spec.helper.imagePullPolicy instead

-

TiDBSpec

+

TiDBSpec

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

TiDBSpec contains details of TiDB members

@@ -16802,7 +16779,7 @@ Use spec.helper.imagePullPolicy instead

ComponentSpec
- + ComponentSpec @@ -16866,7 +16843,7 @@ string service
- + TiDBServiceSpec @@ -16932,7 +16909,7 @@ string slowLogTailer
- + TiDBSlowLogTailerSpec @@ -16946,7 +16923,7 @@ TiDBSlowLogTailerSpec tlsClient
- + TiDBTLSClient @@ -16986,7 +16963,7 @@ Optional: Defaults to false

config
- + TiDBConfigWraper @@ -17016,7 +16993,7 @@ until the action is complete, unless the container process fails, in which case storageVolumes
- + []StorageVolume @@ -17043,7 +17020,7 @@ Defaults to Kubernetes default storage class.

initializer
- + TiDBInitializer @@ -17070,10 +17047,10 @@ Only v6.5.1+ supports this feature.

-

TiDBStatus

+

TiDBStatus

(Appears on: -TidbClusterStatus) +TidbClusterStatus)

TiDBStatus is TiDB status

@@ -17090,7 +17067,7 @@ Only v6.5.1+ supports this feature.

phase
- + MemberPhase @@ -17114,7 +17091,7 @@ Kubernetes apps/v1.StatefulSetStatus members
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiDBMember @@ -17126,7 +17103,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiDBMember failureMembers
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiDBFailureMember @@ -17168,7 +17145,7 @@ bool volumes
- + map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeStatus @@ -17193,10 +17170,10 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName -

TiDBTLSClient

+

TiDBTLSClient

(Appears on: -TiDBSpec) +TiDBSpec)

TiDBTLSClient can enable TLS connection between TiDB server and MySQL client

@@ -17262,10 +17239,10 @@ Optional: defaults to false

-

TiFlashCommonConfigWraper

+

TiFlashCommonConfigWraper

(Appears on: -TiFlashConfigWraper) +TiFlashConfigWraper)

@@ -17292,7 +17269,7 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

TiFlashConfig

+

TiFlashConfig

TiFlashConfig is the configuration of TiFlash.

@@ -17308,7 +17285,7 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig config
- + CommonConfig @@ -17322,7 +17299,7 @@ CommonConfig proxy
- + ProxyConfig @@ -17334,10 +17311,10 @@ ProxyConfig -

TiFlashConfigWraper

+

TiFlashConfigWraper

(Appears on: -TiFlashSpec) +TiFlashSpec)

@@ -17353,7 +17330,7 @@ ProxyConfig config
- + TiFlashCommonConfigWraper @@ -17365,7 +17342,7 @@ TiFlashCommonConfigWraper proxy
- + TiFlashProxyConfigWraper @@ -17375,10 +17352,10 @@ TiFlashProxyConfigWraper -

TiFlashProxyConfigWraper

+

TiFlashProxyConfigWraper

(Appears on: -TiFlashConfigWraper) +TiFlashConfigWraper)

@@ -17405,10 +17382,10 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

TiFlashSpec

+

TiFlashSpec

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

TiFlashSpec contains details of TiFlash members

@@ -17425,7 +17402,7 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig ComponentSpec
- + ComponentSpec @@ -17516,7 +17493,7 @@ Optional: Defaults to 3

storageClaims
- + []StorageClaim @@ -17530,7 +17507,7 @@ TiFlash supports multiple disks.

config
- + TiFlashConfigWraper @@ -17544,7 +17521,7 @@ TiFlashConfigWraper initializer
- + InitContainerSpec @@ -17558,7 +17535,7 @@ InitContainerSpec logTailer
- + LogTailerSpec @@ -17584,7 +17561,7 @@ bool failover
- + Failover @@ -17598,7 +17575,7 @@ Failover scalePolicy
- + ScalePolicy @@ -17610,10 +17587,10 @@ ScalePolicy -

TiKVBackupConfig

+

TiKVBackupConfig

(Appears on: -TiKVConfig) +TiKVConfig)

@@ -17638,10 +17615,10 @@ int64 -

TiKVBlockCacheConfig

+

TiKVBlockCacheConfig

(Appears on: -TiKVStorageConfig) +TiKVStorageConfig)

TiKVBlockCacheConfig is the config of a block cache

@@ -17723,11 +17700,11 @@ string -

TiKVCfConfig

+

TiKVCfConfig

(Appears on: -TiKVDbConfig, -TiKVRaftDBConfig) +TiKVDbConfig, +TiKVRaftDBConfig)

TiKVCfConfig is the config of a cf

@@ -18107,7 +18084,7 @@ bool titan
- + TiKVTitanCfConfig @@ -18118,10 +18095,10 @@ TiKVTitanCfConfig -

TiKVClient

+

TiKVClient

(Appears on: -TiDBConfig) +TiDBConfig)

TiKVClient is the config for tikv client.

@@ -18299,7 +18276,7 @@ string copr-cache
- + CoprocessorCache @@ -18310,7 +18287,7 @@ CoprocessorCache -

TiKVConfig

+

TiKVConfig

TiKVConfig is the configuration of TiKV.

@@ -18427,7 +18404,7 @@ bool server
- + TiKVServerConfig @@ -18440,7 +18417,7 @@ TiKVServerConfig storage
- + TiKVStorageConfig @@ -18453,7 +18430,7 @@ TiKVStorageConfig raftstore
- + TiKVRaftstoreConfig @@ -18466,7 +18443,7 @@ TiKVRaftstoreConfig rocksdb
- + TiKVDbConfig @@ -18479,7 +18456,7 @@ TiKVDbConfig coprocessor
- + TiKVCoprocessorConfig @@ -18492,7 +18469,7 @@ TiKVCoprocessorConfig readpool
- + TiKVReadPoolConfig @@ -18505,7 +18482,7 @@ TiKVReadPoolConfig raftdb
- + TiKVRaftDBConfig @@ -18518,7 +18495,7 @@ TiKVRaftDBConfig import
- + TiKVImportConfig @@ -18531,7 +18508,7 @@ TiKVImportConfig gc
- + TiKVGCConfig @@ -18544,7 +18521,7 @@ TiKVGCConfig pd
- + TiKVPDConfig @@ -18557,7 +18534,7 @@ TiKVPDConfig security
- + TiKVSecurityConfig @@ -18570,7 +18547,7 @@ TiKVSecurityConfig pessimistic-txn
- + TiKVPessimisticTxn @@ -18583,7 +18560,7 @@ TiKVPessimisticTxn backup
- + TiKVBackupConfig @@ -18594,10 +18571,10 @@ TiKVBackupConfig -

TiKVConfigWraper

+

TiKVConfigWraper

(Appears on: -TiKVSpec) +TiKVSpec)

@@ -18624,11 +18601,11 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

TiKVCoprocessorConfig

+

TiKVCoprocessorConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

TiKVCoprocessorConfig is the configuration of TiKV Coprocessor component.

@@ -18731,10 +18708,10 @@ optional

-

TiKVCoprocessorReadPoolConfig

+

TiKVCoprocessorReadPoolConfig

(Appears on: -TiKVReadPoolConfig) +TiKVReadPoolConfig)

@@ -18844,11 +18821,11 @@ bool -

TiKVDbConfig

+

TiKVDbConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

TiKVDbConfig is the rocksdb config.

@@ -19139,7 +19116,7 @@ bool defaultcf
- + TiKVCfConfig @@ -19152,7 +19129,7 @@ TiKVCfConfig writecf
- + TiKVCfConfig @@ -19165,7 +19142,7 @@ TiKVCfConfig lockcf
- + TiKVCfConfig @@ -19178,7 +19155,7 @@ TiKVCfConfig raftcf
- + TiKVCfConfig @@ -19191,7 +19168,7 @@ TiKVCfConfig titan
- + TiKVTitanDBConfig @@ -19202,7 +19179,7 @@ TiKVTitanDBConfig -

TiKVEncryptionConfig

+

TiKVEncryptionConfig

@@ -19244,7 +19221,7 @@ optional

master-key
- + TiKVMasterKeyConfig @@ -19257,7 +19234,7 @@ TiKVMasterKeyConfig 		previous-master-key
- + TiKVMasterKeyConfig @@ -19269,10 +19246,10 @@ It used in master key rotation, the data key should decryption by previous maste
-

TiKVFailureStore

+

TiKVFailureStore

(Appears on: -TiKVStatus) +TiKVStatus)

TiKVFailureStore is the tikv failure store information

@@ -19309,7 +19286,7 @@ string pvcUIDSet
- + map[k8s.io/apimachinery/pkg/types.UID]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.EmptyStruct @@ -19351,11 +19328,11 @@ Kubernetes meta/v1.Time -

TiKVGCConfig

+

TiKVGCConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

@@ -19414,11 +19391,11 @@ bool -

TiKVImportConfig

+

TiKVImportConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

@@ -19531,10 +19508,10 @@ string -

TiKVMasterKeyConfig

+

TiKVMasterKeyConfig

(Appears on: -TiKVEncryptionConfig) +TiKVEncryptionConfig)

@@ -19563,7 +19540,7 @@ optional

MasterKeyFileConfig
- + MasterKeyFileConfig @@ -19580,7 +19557,7 @@ If the type set to file, this config should be filled

MasterKeyKMSConfig
- + MasterKeyKMSConfig @@ -19595,11 +19572,11 @@ If the type set to kms, this config should be filled

-

TiKVPDConfig

+

TiKVPDConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

@@ -19669,10 +19646,10 @@ Optional: Defaults to 10

-

TiKVPessimisticTxn

+

TiKVPessimisticTxn

(Appears on: -TiKVConfig) +TiKVConfig)

@@ -19736,11 +19713,11 @@ bool -

TiKVRaftDBConfig

+

TiKVRaftDBConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

@@ -20009,7 +19986,7 @@ string defaultcf
- + TiKVCfConfig @@ -20020,11 +19997,11 @@ TiKVCfConfig -

TiKVRaftstoreConfig

+

TiKVRaftstoreConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

TiKVRaftstoreConfig is the configuration of TiKV raftstore component.

@@ -20697,11 +20674,11 @@ bool -

TiKVReadPoolConfig

+

TiKVReadPoolConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

@@ -20717,7 +20694,7 @@ bool unified
- + TiKVUnifiedReadPoolConfig @@ -20730,7 +20707,7 @@ TiKVUnifiedReadPoolConfig coprocessor
- + TiKVCoprocessorReadPoolConfig @@ -20743,7 +20720,7 @@ TiKVCoprocessorReadPoolConfig storage
- + TiKVStorageReadPoolConfig @@ -20754,11 +20731,11 @@ TiKVStorageReadPoolConfig -

TiKVSecurityConfig

+

TiKVSecurityConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

@@ -20841,7 +20818,7 @@ string encryption
- + TiKVSecurityConfigEncryption @@ -20852,10 +20829,10 @@ TiKVSecurityConfigEncryption -

TiKVSecurityConfigEncryption

+

TiKVSecurityConfigEncryption

(Appears on: -TiKVSecurityConfig) +TiKVSecurityConfig)

@@ -20897,7 +20874,7 @@ string master-key
- + TiKVSecurityConfigEncryptionMasterKey @@ -20940,7 +20917,7 @@ path = “/path/to/master/key/file”

previous-master-key
- + TiKVSecurityConfigEncryptionPreviousMasterKey @@ -20954,10 +20931,10 @@ And it is okay to leave the stale previous-master-key config after master key ro -

TiKVSecurityConfigEncryptionMasterKey

+

TiKVSecurityConfigEncryptionMasterKey

(Appears on: -TiKVSecurityConfigEncryption) +TiKVSecurityConfigEncryption)

@@ -20984,7 +20961,7 @@ string MasterKeyFileConfig
- + MasterKeyFileConfig @@ -21001,7 +20978,7 @@ If the type set to file, this config should be filled

MasterKeyKMSConfig
- + MasterKeyKMSConfig @@ -21016,10 +20993,10 @@ If the type set to kms, this config should be filled

-

TiKVSecurityConfigEncryptionPreviousMasterKey

+

TiKVSecurityConfigEncryptionPreviousMasterKey

(Appears on: -TiKVSecurityConfigEncryption) +TiKVSecurityConfigEncryption)

@@ -21046,7 +21023,7 @@ string MasterKeyFileConfig
- + MasterKeyFileConfig @@ -21063,7 +21040,7 @@ If the type set to file, this config should be filled

MasterKeyKMSConfig
- + MasterKeyKMSConfig @@ -21078,11 +21055,11 @@ If the type set to kms, this config should be filled

-

TiKVServerConfig

+

TiKVServerConfig

(Appears on: -FlashServerConfig, -TiKVConfig) +FlashServerConfig, +TiKVConfig)

TiKVServerConfig is the configuration of TiKV server.

@@ -21409,10 +21386,10 @@ string -

TiKVSpec

+

TiKVSpec

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

TiKVSpec contains details of TiKV members

@@ -21429,7 +21406,7 @@ string ComponentSpec
- + ComponentSpec @@ -21570,7 +21547,7 @@ string logTailer
- + LogTailerSpec @@ -21616,7 +21593,7 @@ Defaults to “” (volume’s root).

config
- + TiKVConfigWraper @@ -21642,7 +21619,7 @@ bool failover
- + Failover @@ -21697,7 +21674,7 @@ the next tikv upgrade.

storageVolumes
- + []StorageVolume @@ -21735,7 +21712,7 @@ If you set it to true for an existing cluster, the TiKV cluster wil scalePolicy
- + ScalePolicy @@ -21747,10 +21724,10 @@ ScalePolicy -

TiKVStatus

+

TiKVStatus

(Appears on: -TidbClusterStatus) +TidbClusterStatus)

TiKVStatus is TiKV status

@@ -21777,7 +21754,7 @@ bool phase
- + MemberPhase @@ -21811,7 +21788,7 @@ Kubernetes apps/v1.StatefulSetStatus stores
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVStore @@ -21823,7 +21800,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVStore peerStores
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVStore @@ -21836,7 +21813,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVStore tombstoneStores
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVStore @@ -21848,7 +21825,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVStore failureStores
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiKVFailureStore @@ -21880,7 +21857,7 @@ string evictLeader
- + map[string]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.EvictLeaderStatus @@ -21892,7 +21869,7 @@ map[string]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.EvictLead volumes
- + map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeStatus @@ -21917,11 +21894,11 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName -

TiKVStorageConfig

+

TiKVStorageConfig

(Appears on: -ProxyConfig, -TiKVConfig) +ProxyConfig, +TiKVConfig)

TiKVStorageConfig is the config of storage

@@ -21997,7 +21974,7 @@ string block-cache
- + TiKVBlockCacheConfig @@ -22024,10 +22001,10 @@ emergency intervention and set it to 0MB. Default value is 2GB.

-

TiKVStorageReadPoolConfig

+

TiKVStorageReadPoolConfig

(Appears on: -TiKVReadPoolConfig) +TiKVReadPoolConfig)

@@ -22137,10 +22114,10 @@ bool -

TiKVStore

+

TiKVStore

(Appears on: -TiKVStatus) +TiKVStatus)

TiKVStores is either Up/Down/Offline/Tombstone

@@ -22233,10 +22210,10 @@ It is unset after leader transfer is completed.

-

TiKVTitanCfConfig

+

TiKVTitanCfConfig

(Appears on: -TiKVCfConfig) +TiKVCfConfig)

TiKVTitanCfConfig is the titian config.

@@ -22372,10 +22349,10 @@ bool -

TiKVTitanDBConfig

+

TiKVTitanDBConfig

(Appears on: -TiKVDbConfig) +TiKVDbConfig)

TiKVTitanDBConfig is the config a titian db.

@@ -22446,10 +22423,10 @@ string -

TiKVUnifiedReadPoolConfig

+

TiKVUnifiedReadPoolConfig

(Appears on: -TiKVReadPoolConfig) +TiKVReadPoolConfig)

@@ -22508,10 +22485,10 @@ int32 -

TiProxyConfigWraper

+

TiProxyConfigWraper

(Appears on: -TiProxySpec) +TiProxySpec)

@@ -22538,10 +22515,10 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

TiProxyMember

+

TiProxyMember

(Appears on: -TiProxyStatus) +TiProxyStatus)

TiProxyMember is TiProxy member

@@ -22602,10 +22579,10 @@ TODO: remove nullable, TiProxySpec +

TiProxySpec

(Appears on: -TidbClusterSpec) +TidbClusterSpec)

TiProxySpec contains details of TiProxy members

@@ -22622,7 +22599,7 @@ TODO: remove nullable, + ComponentSpec @@ -22710,7 +22687,7 @@ string config
- + TiProxyConfigWraper @@ -22724,7 +22701,7 @@ TiProxyConfigWraper storageVolumes
- + []StorageVolume @@ -22749,10 +22726,10 @@ Defaults to Kubernetes default storage class.

-

TiProxyStatus

+

TiProxyStatus

(Appears on: -TidbClusterStatus) +TidbClusterStatus)

TiProxyStatus is TiProxy status

@@ -22779,7 +22756,7 @@ bool phase
- + MemberPhase @@ -22791,7 +22768,7 @@ MemberPhase members
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TiProxyMember @@ -22815,7 +22792,7 @@ Kubernetes apps/v1.StatefulSetStatus volumes
- + map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeStatus @@ -22839,10 +22816,10 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName -

TidbAutoScalerSpec

+

TidbAutoScalerSpec

(Appears on: -TidbClusterAutoScalerSpec) +TidbClusterAutoScalerSpec)

TidbAutoScalerSpec describes the spec for tidb auto-scaling

@@ -22859,7 +22836,7 @@ map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName BasicAutoScalerSpec
- + BasicAutoScalerSpec @@ -22872,10 +22849,10 @@ BasicAutoScalerSpec -

TidbAutoScalerStatus

+

TidbAutoScalerStatus

(Appears on: -TidbClusterAutoScalerStatus) +TidbClusterAutoScalerStatus)

TidbAutoScalerStatus describe the auto-scaling status of tidb

@@ -22892,7 +22869,7 @@ BasicAutoScalerSpec BasicAutoScalerStatus
- + BasicAutoScalerStatus @@ -22905,10 +22882,10 @@ BasicAutoScalerStatus -

TidbClusterAutoScalerRef

+

TidbClusterAutoScalerRef

(Appears on: -TidbClusterStatus) +TidbClusterStatus)

TidbClusterAutoScalerRef indicates to the target auto-scaler ref

@@ -22943,10 +22920,10 @@ string -

TidbClusterAutoScalerSpec

+

TidbClusterAutoScalerSpec

(Appears on: -TidbClusterAutoScaler) +TidbClusterAutoScaler)

TidbAutoScalerSpec describes the state of the TidbClusterAutoScaler

@@ -22963,7 +22940,7 @@ string cluster
- + TidbClusterRef @@ -22976,7 +22953,7 @@ TidbClusterRef tikv
- + TikvAutoScalerSpec @@ -22990,7 +22967,7 @@ TikvAutoScalerSpec tidb
- + TidbAutoScalerSpec @@ -23002,10 +22979,10 @@ TidbAutoScalerSpec -

TidbClusterAutoScalerStatus

+

TidbClusterAutoScalerStatus

(Appears on: -TidbClusterAutoScaler) +TidbClusterAutoScaler)

TidbClusterAutoScalerStatus describe the whole status

@@ -23022,7 +22999,7 @@ TidbAutoScalerSpec tikv
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TikvAutoScalerStatus @@ -23036,7 +23013,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TikvAutoSc tidb
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TidbAutoScalerStatus @@ -23048,10 +23025,10 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TidbAutoSc -

TidbClusterCondition

+

TidbClusterCondition

(Appears on: -TidbClusterStatus) +TidbClusterStatus)

TidbClusterCondition describes the state of a tidb cluster at a certain point.

@@ -23068,7 +23045,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.TidbAutoSc type
- + TidbClusterConditionType @@ -23143,23 +23120,23 @@ string -

TidbClusterConditionType

+

TidbClusterConditionType

(Appears on: -TidbClusterCondition) +TidbClusterCondition)

TidbClusterConditionType represents a tidb cluster condition value.

-

TidbClusterRef

+

TidbClusterRef

(Appears on: -TidbClusterAutoScalerSpec, -TidbClusterSpec, -TidbDashboardSpec, -TidbInitializerSpec, -TidbMonitorSpec, -TidbNGMonitoringSpec) +TidbClusterAutoScalerSpec, +TidbClusterSpec, +TidbDashboardSpec, +TidbInitializerSpec, +TidbMonitorSpec, +TidbNGMonitoringSpec)

TidbClusterRef reference to a TidbCluster

@@ -23210,10 +23187,10 @@ string -

TidbClusterSpec

+

TidbClusterSpec

(Appears on: -TidbCluster) +TidbCluster)

TidbClusterSpec describes the attributes that a user creates on a tidb cluster

@@ -23230,7 +23207,7 @@ string discovery
- + DiscoverySpec @@ -23254,7 +23231,7 @@ string pd
- + PDSpec @@ -23268,7 +23245,7 @@ PDSpec tidb
- + TiDBSpec @@ -23282,7 +23259,7 @@ TiDBSpec tikv
- + TiKVSpec @@ -23296,7 +23273,7 @@ TiKVSpec tiflash
- + TiFlashSpec @@ -23310,7 +23287,7 @@ TiFlashSpec ticdc
- + TiCDCSpec @@ -23324,7 +23301,7 @@ TiCDCSpec tiproxy
- + TiProxySpec @@ -23338,7 +23315,7 @@ TiProxySpec pump
- + PumpSpec @@ -23352,7 +23329,7 @@ PumpSpec helper
- + HelperSpec @@ -23455,7 +23432,7 @@ Kubernetes core/v1.PullPolicy configUpdateStrategy
- + ConfigUpdateStrategy @@ -23485,7 +23462,7 @@ Optional: Defaults to false

tlsCluster
- + TLSCluster @@ -23634,7 +23611,7 @@ Optional: Defaults to UTC

services
- + []Service @@ -23684,7 +23661,7 @@ bool cluster
- + TidbClusterRef @@ -23752,7 +23729,7 @@ Kubernetes core/v1.PodSecurityContext topologySpreadConstraints
- + []TopologySpreadConstraint @@ -23769,7 +23746,7 @@ All topologySpreadConstraints are ANDed.

startScriptVersion
- + StartScriptVersion @@ -23784,7 +23761,7 @@ StartScriptVersion suspendAction
- + SuspendAction @@ -23807,10 +23784,10 @@ bool -

TidbClusterStatus

+

TidbClusterStatus

(Appears on: -TidbCluster) +TidbCluster)

TidbClusterStatus represents the current status of a tidb cluster.

@@ -23837,7 +23814,7 @@ string pd
- + PDStatus @@ -23849,7 +23826,7 @@ PDStatus tikv
- + TiKVStatus @@ -23861,7 +23838,7 @@ TiKVStatus tidb
- + TiDBStatus @@ -23873,7 +23850,7 @@ TiDBStatus pump
- + PumpStatus @@ -23885,7 +23862,7 @@ PumpStatus tiflash
- + TiFlashStatus @@ -23897,7 +23874,7 @@ TiFlashStatus tiproxy
- + TiProxyStatus @@ -23909,7 +23886,7 @@ TiProxyStatus ticdc
- + TiCDCStatus @@ -23921,7 +23898,7 @@ TiCDCStatus auto-scaler
- + TidbClusterAutoScalerRef @@ -23933,7 +23910,7 @@ TidbClusterAutoScalerRef conditions
- + []TidbClusterCondition @@ -23945,7 +23922,7 @@ TidbClusterAutoScalerRef -

TidbDashboard

+

TidbDashboard

TidbDashboard contains the spec and status of tidb dashboard.

@@ -23975,7 +23952,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + TidbDashboardSpec @@ -23989,7 +23966,7 @@ TidbDashboardSpec ComponentSpec
- + ComponentSpec @@ -24020,7 +23997,7 @@ Kubernetes core/v1.ResourceRequirements clusters
- + []TidbClusterRef @@ -24069,7 +24046,7 @@ Defaults to Kubernetes default storage class.

storageVolumes
- + []StorageVolume @@ -24093,7 +24070,7 @@ string service
- + ServiceSpec @@ -24150,7 +24127,7 @@ bool status
- + TidbDashboardStatus @@ -24161,10 +24138,10 @@ TidbDashboardStatus -

TidbDashboardSpec

+

TidbDashboardSpec

(Appears on: -TidbDashboard) +TidbDashboard)

TidbDashboardSpec is spec of tidb dashboard.

@@ -24181,7 +24158,7 @@ TidbDashboardStatus ComponentSpec
- + ComponentSpec @@ -24212,7 +24189,7 @@ Kubernetes core/v1.ResourceRequirements clusters
- + []TidbClusterRef @@ -24261,7 +24238,7 @@ Defaults to Kubernetes default storage class.

storageVolumes
- + []StorageVolume @@ -24285,7 +24262,7 @@ string service
- + ServiceSpec @@ -24337,10 +24314,10 @@ bool -

TidbDashboardStatus

+

TidbDashboardStatus

(Appears on: -TidbDashboard) +TidbDashboard)

TidbDashboardStatus is status of tidb dashboard.

@@ -24367,7 +24344,7 @@ bool phase
- + MemberPhase @@ -24389,10 +24366,10 @@ Kubernetes apps/v1.StatefulSetStatus -

TidbInitializerSpec

+

TidbInitializerSpec

(Appears on: -TidbInitializer) +TidbInitializer)

TidbInitializer spec encode the desired state of tidb initializer Job

@@ -24419,7 +24396,7 @@ string cluster
- + TidbClusterRef @@ -24569,10 +24546,10 @@ Optional: Defaults to nil

-

TidbInitializerStatus

+

TidbInitializerStatus

(Appears on: -TidbInitializer) +TidbInitializer)

@@ -24603,7 +24580,7 @@ Kubernetes batch/v1.JobStatus phase
- + InitializePhase @@ -24614,7 +24591,7 @@ InitializePhase -

TidbMonitorRef

+

TidbMonitorRef

TidbMonitorRef reference to a TidbMonitor

@@ -24664,10 +24641,10 @@ bool -

TidbMonitorSpec

+

TidbMonitorSpec

(Appears on: -TidbMonitor) +TidbMonitor)

TidbMonitor spec encode the desired state of tidb monitoring component

@@ -24684,7 +24661,7 @@ bool clusters
- + []TidbClusterRef @@ -24698,7 +24675,7 @@ bool prometheus
- + PrometheusSpec @@ -24711,7 +24688,7 @@ PrometheusSpec grafana
- + GrafanaSpec @@ -24725,7 +24702,7 @@ GrafanaSpec reloader
- + ReloaderSpec @@ -24738,7 +24715,7 @@ ReloaderSpec initializer
- + InitializerSpec @@ -24751,7 +24728,7 @@ InitializerSpec dm
- + DMMonitorSpec @@ -24765,7 +24742,7 @@ DMMonitorSpec thanos
- + ThanosSpec @@ -24779,7 +24756,7 @@ ThanosSpec prometheusReloader
- + PrometheusReloaderSpec @@ -25105,10 +25082,10 @@ bool -

TidbMonitorStatus

+

TidbMonitorStatus

(Appears on: -TidbMonitor) +TidbMonitor)

@@ -25124,7 +25101,7 @@ bool deploymentStorageStatus
- + DeploymentStorageStatus @@ -25147,7 +25124,7 @@ Kubernetes apps/v1.StatefulSetStatus -

TidbNGMonitoring

+

TidbNGMonitoring

TidbNGMonitoring contains the spec and status of tidb ng monitor

@@ -25177,7 +25154,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + TidbNGMonitoringSpec @@ -25191,7 +25168,7 @@ TidbNGMonitoringSpec ComponentSpec
- + ComponentSpec @@ -25208,7 +25185,7 @@ NOTE: the same field will be overridden by component’s spec.

clusters
- + []TidbClusterRef @@ -25256,7 +25233,7 @@ string ngMonitoring
- + NGMonitoringSpec @@ -25283,7 +25260,7 @@ bool status
- + TidbNGMonitoringStatus @@ -25294,10 +25271,10 @@ TidbNGMonitoringStatus -

TidbNGMonitoringSpec

+

TidbNGMonitoringSpec

(Appears on: -TidbNGMonitoring) +TidbNGMonitoring)

TidbNGMonitoringSpec is spec of tidb ng monitoring

@@ -25314,7 +25291,7 @@ TidbNGMonitoringStatus ComponentSpec
- + ComponentSpec @@ -25331,7 +25308,7 @@ NOTE: the same field will be overridden by component’s spec.

clusters
- + []TidbClusterRef @@ -25379,7 +25356,7 @@ string ngMonitoring
- + NGMonitoringSpec @@ -25401,10 +25378,10 @@ bool -

TidbNGMonitoringStatus

+

TidbNGMonitoringStatus

(Appears on: -TidbNGMonitoring) +TidbNGMonitoring)

TidbNGMonitoringStatus is status of tidb ng monitoring

@@ -25421,7 +25398,7 @@ bool ngMonitoring
- + NGMonitoringStatus @@ -25432,10 +25409,10 @@ NGMonitoringStatus -

TikvAutoScalerSpec

+

TikvAutoScalerSpec

(Appears on: -TidbClusterAutoScalerSpec) +TidbClusterAutoScalerSpec)

TikvAutoScalerSpec describes the spec for tikv auto-scaling

@@ -25452,7 +25429,7 @@ NGMonitoringStatus BasicAutoScalerSpec
- + BasicAutoScalerSpec @@ -25465,10 +25442,10 @@ BasicAutoScalerSpec -

TikvAutoScalerStatus

+

TikvAutoScalerStatus

(Appears on: -TidbClusterAutoScalerStatus) +TidbClusterAutoScalerStatus)

TikvAutoScalerStatus describe the auto-scaling status of tikv

@@ -25485,7 +25462,7 @@ BasicAutoScalerSpec BasicAutoScalerStatus
- + BasicAutoScalerStatus @@ -25498,12 +25475,12 @@ BasicAutoScalerStatus -

TopologySpreadConstraint

+

TopologySpreadConstraint

(Appears on: -ComponentSpec, -DMClusterSpec, -TidbClusterSpec) +ComponentSpec, +DMClusterSpec, +TidbClusterSpec)

TopologySpreadConstraint specifies how to spread matching pods among the given topology. @@ -25554,10 +25531,10 @@ MatchLabels to keep l[“comp”] = “” for old clusters with -

TxnLocalLatches

+

TxnLocalLatches

(Appears on: -TiDBConfig) +TiDBConfig)

TxnLocalLatches is the TxnLocalLatches section of the config.

@@ -25594,11 +25571,11 @@ uint -

UnjoinedMember

+

UnjoinedMember

(Appears on: -MasterStatus, -PDStatus) +MasterStatus, +PDStatus)

UnjoinedMember is the pd unjoin cluster member information

@@ -25635,7 +25612,7 @@ k8s.io/apimachinery/pkg/types.UID pvcUIDSet
- + map[k8s.io/apimachinery/pkg/types.UID]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.EmptyStruct @@ -25657,7 +25634,7 @@ Kubernetes meta/v1.Time -

User

+

User

User is the configuration of users.

@@ -25706,7 +25683,7 @@ string networks
- + Networks @@ -25717,7 +25694,7 @@ Networks -

WorkerConfig

+

WorkerConfig

WorkerConfig is the configuration of dm-worker-server

@@ -25783,7 +25760,7 @@ Optional: Defaults to 10

DMSecurityConfig
- + DMSecurityConfig @@ -25798,10 +25775,10 @@ DMSecurityConfig -

WorkerConfigWraper

+

WorkerConfigWraper

(Appears on: -WorkerSpec) +WorkerSpec)

@@ -25828,10 +25805,10 @@ github.com/pingcap/tidb-operator/pkg/apis/util/config.GenericConfig -

WorkerFailureMember

+

WorkerFailureMember

(Appears on: -WorkerStatus) +WorkerStatus)

WorkerFailureMember is the dm-worker failure member information

@@ -25868,10 +25845,10 @@ Kubernetes meta/v1.Time -

WorkerMember

+

WorkerMember

(Appears on: -WorkerStatus) +WorkerStatus)

WorkerMember is dm-worker member status

@@ -25929,10 +25906,10 @@ Kubernetes meta/v1.Time -

WorkerSpec

+

WorkerSpec

(Appears on: -DMClusterSpec) +DMClusterSpec)

WorkerSpec contains details of dm-worker members

@@ -25949,7 +25926,7 @@ Kubernetes meta/v1.Time ComponentSpec
- + ComponentSpec @@ -26060,7 +26037,7 @@ Defaults to “” (volume’s root).

config
- + WorkerConfigWraper @@ -26086,7 +26063,7 @@ bool failover
- + Failover @@ -26098,10 +26075,10 @@ Failover -

WorkerStatus

+

WorkerStatus

(Appears on: -DMClusterStatus) +DMClusterStatus)

WorkerStatus is dm-worker status

@@ -26128,7 +26105,7 @@ bool phase
- + MemberPhase @@ -26152,7 +26129,7 @@ Kubernetes apps/v1.StatefulSetStatus members
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.WorkerMember @@ -26164,7 +26141,7 @@ map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.WorkerMemb failureMembers
- + map[string]github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.WorkerFailureMember @@ -26196,7 +26173,7 @@ string volumes
- + map[github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeName]*github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageVolumeStatus diff --git a/docs/api-references/federation-docs.md b/docs/api-references/federation-docs.md index 30976b8eb85..fb7c5330c02 100644 --- a/docs/api-references/federation-docs.md +++ b/docs/api-references/federation-docs.md @@ -7,13 +7,13 @@ category: how-to

federation.pingcap.com/v1alpha1

Resource Types: -

VolumeBackup

+

VolumeBackup

VolumeBackup is the control script’s spec

@@ -60,7 +60,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + VolumeBackupSpec @@ -73,7 +73,7 @@ VolumeBackupSpec clusters
- + []VolumeBackupMemberCluster @@ -85,7 +85,7 @@ VolumeBackupSpec template
- + VolumeBackupMemberSpec @@ -100,7 +100,7 @@ VolumeBackupMemberSpec status
- + VolumeBackupStatus @@ -110,7 +110,7 @@ VolumeBackupStatus -

VolumeBackupSchedule

+

VolumeBackupSchedule

VolumeBackupSchedule is the control script’s spec

@@ -157,7 +157,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + VolumeBackupScheduleSpec @@ -217,7 +217,7 @@ string backupTemplate
- + VolumeBackupSpec @@ -233,7 +233,7 @@ VolumeBackupSpec status
- + VolumeBackupScheduleStatus @@ -243,7 +243,7 @@ VolumeBackupScheduleStatus -

VolumeRestore

+

VolumeRestore

VolumeRestore is the control script’s spec

@@ -290,7 +290,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + VolumeRestoreSpec @@ -303,7 +303,7 @@ VolumeRestoreSpec clusters
- + []VolumeRestoreMemberCluster @@ -315,7 +315,7 @@ VolumeRestoreSpec template
- + VolumeRestoreMemberSpec @@ -330,7 +330,7 @@ VolumeRestoreMemberSpec status
- + VolumeRestoreStatus @@ -340,11 +340,11 @@ VolumeRestoreStatus -

BRConfig

+

BRConfig

(Appears on: -VolumeBackupMemberSpec, -VolumeRestoreMemberSpec) +VolumeBackupMemberSpec, +VolumeRestoreMemberSpec)

BRConfig contains config for BR

@@ -403,10 +403,10 @@ bool -

VolumeBackupCondition

+

VolumeBackupCondition

(Appears on: -VolumeBackupStatus) +VolumeBackupStatus)

VolumeBackupCondition describes the observed state of a VolumeBackup at a certain point.

@@ -435,7 +435,7 @@ Kubernetes core/v1.ConditionStatus type
- + VolumeBackupConditionType @@ -477,19 +477,19 @@ string -

VolumeBackupConditionType

+

VolumeBackupConditionType

(Appears on: -VolumeBackupCondition, -VolumeBackupStatus) +VolumeBackupCondition, +VolumeBackupStatus)

VolumeBackupConditionType represents a valid condition of a VolumeBackup.

-

VolumeBackupMemberCluster

+

VolumeBackupMemberCluster

(Appears on: -VolumeBackupSpec) +VolumeBackupSpec)

VolumeBackupMemberCluster contains the TiDB cluster which need to execute volume backup

@@ -537,10 +537,10 @@ string -

VolumeBackupMemberSpec

+

VolumeBackupMemberSpec

(Appears on: -VolumeBackupSpec) +VolumeBackupSpec)

VolumeBackupMemberSpec contains the backup specification for one tidb cluster

@@ -599,7 +599,7 @@ Note that the following builtin env vars will be overwritten by values set here br
- + BRConfig @@ -709,10 +709,10 @@ string -

VolumeBackupMemberStatus

+

VolumeBackupMemberStatus

(Appears on: -VolumeBackupStatus) +VolumeBackupStatus)

@@ -836,10 +836,10 @@ string -

VolumeBackupScheduleSpec

+

VolumeBackupScheduleSpec

(Appears on: -VolumeBackupSchedule) +VolumeBackupSchedule)

VolumeBackupScheduleSpec describes the attributes that a user creates on a volume backup schedule.

@@ -903,7 +903,7 @@ string backupTemplate
- + VolumeBackupSpec @@ -914,10 +914,10 @@ VolumeBackupSpec -

VolumeBackupScheduleStatus

+

VolumeBackupScheduleStatus

(Appears on: -VolumeBackupSchedule) +VolumeBackupSchedule)

VolumeBackupScheduleStatus represents the current status of a volume backup schedule.

@@ -969,11 +969,11 @@ Kubernetes meta/v1.Time -

VolumeBackupSpec

+

VolumeBackupSpec

(Appears on: -VolumeBackup, -VolumeBackupScheduleSpec) +VolumeBackup, +VolumeBackupScheduleSpec)

VolumeBackupSpec describes the attributes that a user creates on a volume backup.

@@ -990,7 +990,7 @@ Kubernetes meta/v1.Time clusters
- + []VolumeBackupMemberCluster @@ -1002,7 +1002,7 @@ Kubernetes meta/v1.Time template
- + VolumeBackupMemberSpec @@ -1012,10 +1012,10 @@ VolumeBackupMemberSpec -

VolumeBackupStatus

+

VolumeBackupStatus

(Appears on: -VolumeBackup) +VolumeBackup)

VolumeBackupStatus represents the current status of a volume backup.

@@ -1032,7 +1032,7 @@ VolumeBackupMemberSpec backups
- + []VolumeBackupMemberStatus @@ -1116,7 +1116,7 @@ string phase
- + VolumeBackupConditionType @@ -1129,7 +1129,7 @@ VolumeBackupConditionType conditions
- + []VolumeBackupCondition @@ -1139,10 +1139,10 @@ VolumeBackupConditionType -

VolumeRestoreCondition

+

VolumeRestoreCondition

(Appears on: -VolumeRestoreStatus) +VolumeRestoreStatus)

VolumeRestoreCondition describes the observed state of a VolumeRestore at a certain point.

@@ -1171,7 +1171,7 @@ Kubernetes core/v1.ConditionStatus type
- + VolumeRestoreConditionType @@ -1213,18 +1213,18 @@ string -

VolumeRestoreConditionType

+

VolumeRestoreConditionType

(Appears on: -VolumeRestoreCondition, -VolumeRestoreStatus) +VolumeRestoreCondition, +VolumeRestoreStatus)

-

VolumeRestoreMemberBackupInfo

+

VolumeRestoreMemberBackupInfo

(Appears on: -VolumeRestoreMemberCluster) +VolumeRestoreMemberCluster)

@@ -1251,10 +1251,10 @@ github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1.StorageProvider -

VolumeRestoreMemberCluster

+

VolumeRestoreMemberCluster

(Appears on: -VolumeRestoreSpec) +VolumeRestoreSpec)

VolumeRestoreMemberCluster contains the TiDB cluster which need to execute volume restore

@@ -1315,7 +1315,7 @@ string backup
- + VolumeRestoreMemberBackupInfo @@ -1326,10 +1326,10 @@ VolumeRestoreMemberBackupInfo -

VolumeRestoreMemberSpec

+

VolumeRestoreMemberSpec

(Appears on: -VolumeRestoreSpec) +VolumeRestoreSpec)

VolumeRestoreMemberSpec contains the restore specification for one tidb cluster

@@ -1388,7 +1388,7 @@ Note that the following builtin env vars will be overwritten by values set here br
- + BRConfig @@ -1461,10 +1461,10 @@ string -

VolumeRestoreMemberStatus

+

VolumeRestoreMemberStatus

(Appears on: -VolumeRestoreStatus) +VolumeRestoreStatus)

@@ -1566,10 +1566,10 @@ string -

VolumeRestoreSpec

+

VolumeRestoreSpec

(Appears on: -VolumeRestore) +VolumeRestore)

VolumeRestoreSpec describes the attributes that a user creates on a volume restore.

@@ -1586,7 +1586,7 @@ string clusters
- + []VolumeRestoreMemberCluster @@ -1598,7 +1598,7 @@ string template
- + VolumeRestoreMemberSpec @@ -1608,10 +1608,10 @@ VolumeRestoreMemberSpec -

VolumeRestoreStatus

+

VolumeRestoreStatus

(Appears on: -VolumeRestore) +VolumeRestore)

VolumeRestoreStatus represents the current status of a volume restore.

@@ -1628,7 +1628,7 @@ VolumeRestoreMemberSpec restores
- + []VolumeRestoreMemberStatus @@ -1641,7 +1641,7 @@ VolumeRestoreMemberSpec steps
- + []VolumeRestoreStep @@ -1702,7 +1702,7 @@ string phase
- + VolumeRestoreConditionType @@ -1715,7 +1715,7 @@ VolumeRestoreConditionType conditions
- + []VolumeRestoreCondition @@ -1725,10 +1725,10 @@ VolumeRestoreConditionType -

VolumeRestoreStep

+

VolumeRestoreStep

(Appears on: -VolumeRestoreStatus) +VolumeRestoreStatus)

@@ -1744,7 +1744,7 @@ VolumeRestoreConditionType stepName
- + VolumeRestoreStepType @@ -1792,10 +1792,10 @@ string -

VolumeRestoreStepType

+

VolumeRestoreStepType

(Appears on: -VolumeRestoreStep) +VolumeRestoreStep)