v1alpha1

type CAReference struct {
	// +optional
	Name string `json:"name,omitempty"`
}

type CertKeyPairReference struct {
	// +optional
	Name string `json:"name,omitempty"`
}

type ClientAuthType string

type ClientTLS struct {
	// Enabled means whether enable tls
	Enabled bool `json:"enabled"`

	// Defaults to true
	// +kubebuilder:default=true
	// +optional
	Mutual bool `json:"mutual,omitempty"`

	// If true, we will skip CA verification, it means CA can be omitted
	// Defaults to false
	// +optional
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`

	// TLSSecret defines secret references for tls config
	TLSSecret `json:",inline"`
}

type Cluster struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ClusterSpec   `json:"spec,omitempty"`
	Status ClusterStatus `json:"status,omitempty"`
}

type ClusterList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Cluster `json:"items"`
}

type ClusterReference struct {
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="cluster name is immutable"
	// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
	Name string `json:"name"`
}

type ClusterSecurity struct {
	// TLS defines tls configs for the whole cluster
	TLS *ClusterTLSConfig `json:"tls,omitempty"`
	// SessionTokenSigningCertKeyPair is the name of the K8s secret, where stores certificates for signing the TiDB session token,
	// which is used by TiProxy for session migration.
	// You can generate certificates and create a secret by: kubectl create secret generic <secret-name> --namespace=<namespace> --from-file=tls.crt=<path/to/tls.crt> --from-file=tls.key=<path/to/tls.key>
	// Note: this field will only be used when the feature gate `SessionTokenSigning` is enabled.
	SessionTokenSigningCertKeyPair *corev1.LocalObjectReference `json:"sessionTokenSigningCertKeyPair,omitempty"`
}

type ClusterSpec struct {
	// SuspendAction defines the suspend actions for the cluster.
	SuspendAction *SuspendAction `json:"suspendAction,omitempty"`

	// Whether enable the TLS connection between TiDB cluster components.
	TLSCluster *TLSCluster `json:"tlsCluster,omitempty"`

	// BootstrapSQL refers to a configmap which contains the bootstrap SQL file with the key `bootstrap-sql`,
	// which will only be executed when a TiDB cluster bootstrap on the first time.
	// Only v6.5.1+ supports this feature.
	BootstrapSQL *corev1.LocalObjectReference `json:"bootstrapSQL,omitempty"`

	// UpgradePolicy defines the upgrade policy for the cluster.
	UpgradePolicy UpgradePolicy `json:"upgradePolicy,omitempty"`

	// Paused specifies whether to pause the reconciliation loop for all components of the cluster.
	Paused bool `json:"paused,omitempty"`

	// RevisionHistoryLimit is the maximum number of revisions that will
	// be maintained in each Group's revision history.
	// The revision history consists of all revisions not represented by a currently applied version.
	// The default value is 10.
	// +kubebuilder:validation:Minimum=0
	RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty"`

	// +kubebuilder:validation:XValidation:rule="oldSelf.exists(fg, fg.name == 'FeatureModification') || self.filter(fg, fg.name != 'FeatureModification') == oldSelf",message="can only enable FeatureModification if it's not enabled"
	// +kubebuilder:validation:XValidation:rule="self.exists(fg, fg.name == 'FeatureModification') || !oldSelf.exists(fg, fg.name == 'FeatureModification')",message="cannot disable FeatureModification"
	// +listType=map
	// +listMapKey=name
	FeatureGates []meta.FeatureGate `json:"featureGates,omitempty"`

	// CustomizedPDServiceName is the internal pd service name which will be created by the cluster.
	// If MultiPDGroup feature is not enabled, this field doesn't work.
	// If MultiPDGroup feature is enabled, the default service name is ${clusterName}-pd.
	// This field is useful to keep use legacy pd service name when enable MultiPDGroup.
	CustomizedPDServiceName *string `json:"customizedPDServiceName,omitempty"`

	// DNS defines the dns names used by components
	DNS *DNS `json:"dns,omitempty"`

	// Security defines the security config of the whole cluster
	Security *ClusterSecurity `json:"security,omitempty"`
}

type ClusterStatus struct {
	// observedGeneration is the most recent generation observed for this Cluster. It corresponds to the
	// Cluster's generation, which is updated on mutation by the API Server.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,1,opt,name=observedGeneration"`

	// Components is the status of each component in the cluster.
	// +patchMergeKey=kind
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=kind
	Components []ComponentStatus `json:"components,omitempty" patchStrategy:"merge" patchMergeKey:"kind" protobuf:"bytes,1,rep,name=components"`

	// Conditions contains the current status of the cluster.
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=type
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`

	// ID is the cluster id.
	ID string `json:"id"`

	// PD means url of the pd service, it's prepared for internal use
	// e.g. https://pd:2379
	PD string `json:"pd,omitempty"`

	// FeatureGates of this cluster
	// +listType=map
	// +listMapKey=name
	FeatureGates []meta.FeatureGateStatus `json:"featureGates,omitempty"`
}

type ClusterTLSConfig struct {
	// Client defines the client tls for the tidb operator to visit components
	Client *InternalClientTLS `json:"client,omitempty"`
}

type CommonStatus struct {
	// Conditions contain details of the current state.
	// +listType=map
	// +listMapKey=type
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// ObservedGeneration is the most recent generation observed by the controller.
	// It's used to determine whether the controller has reconciled the latest spec.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// CurrentRevision is the revision of the Controller that created the resource.
	CurrentRevision string `json:"currentRevision,omitempty"`

	// UpdateRevision is the revision of the Controller that should modify the resource.
	UpdateRevision string `json:"updateRevision,omitempty"`

	// CollisionCount is the count of hash collisions. The controller
	// uses this field as a collision avoidance mechanism when it needs to create the name for the
	// newest ControllerRevision.
	// +optional
	CollisionCount *int32 `json:"collisionCount,omitempty"`
}

type CompactorReference corev1.LocalObjectReference

type ComponentKind string

type ComponentStatus struct {
	// Kind is the kind of the component, e.g., PD, TiKV, TiDB, TiFlash.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=PD;TiKV;TiDB;TiFlash;TiCDC;TiProxy;TiKVWorker
	Kind ComponentKind `json:"kind"`

	// Replicas is the number of desired replicas of the component.
	// +kubebuilder:validation:Required
	Replicas int32 `json:"replicas"`
}

type ComponentTLSConfig struct {
	Cluster *InternalTLS `json:"cluster,omitempty"`
}

type ConfigFile string

type ConfigUpdateStrategy string

type CoprocessorReference corev1.LocalObjectReference

type DNS struct {
	// Mode is the dns mode, it determines the dns format used by the tidb cluster
	// +kubebuilder:default="InCluster"
	// +default="InCluster"
	Mode DNSMode `json:"mode"`

	// ClusterDomain is the domain suffix of the dns
	// It only works when the mode is FQDN
	// +kubebuilder:default="cluster.local"
	// +default="cluster.local"
	ClusterDomain string `json:"clusterDomain,omitempty"`
}

type DNSMode string

type GroupStatus struct {
	// Version is the version of all instances in the group.
	// It will be same as the `spec.version` only when all instances are upgraded to the desired version.
	Version string `json:"version,omitempty"`

	// Selector is the label selector for scale subresource.
	Selector string `json:"selector"`

	// Replicas is the number of Instance created by the controller.
	Replicas int32 `json:"replicas"`

	// ReadyReplicas is the number of Instances created for this ComponentGroup with a Ready Condition.
	ReadyReplicas int32 `json:"readyReplicas"`

	// CurrentReplicas is the number of Instances created by the Group controller from the Group version
	// indicated by currentRevision.
	CurrentReplicas int32 `json:"currentReplicas"`

	// UpdatedReplicas is the number of Instances created by the Group controller from the Group version
	// indicated by updateRevision.
	UpdatedReplicas int32 `json:"updatedReplicas"`
}

type InternalClientTLS struct {
	// If true, we will skip CA verification, it means CA can be omitted
	// Defaults to false
	// +optional
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
	// TLSSecret defines the secret references.
	// Now we have to ensure all client CAs(except tiproxy) are same because now all internal tls certs are for both client auth and server auth.
	// NOTE: if CN verification is specified in the config file, users should ensure that CN of this CertKeyPair is verfied.
	TLSSecret `json:",inline"`
}

type InternalTLS struct {
	// TLSSecret defines the secret references.
	// Now we have to ensure all CAs are same because all internal
	// components use a same CA to authenticate all servers. (e.g. TiDB uses a same CA to visit PD and TiKV)
	TLSSecret `json:",inline"`
}

type NamedPersistentVolumeClaimOverlay struct {
	Name                  string                       `json:"name"`
	PersistentVolumeClaim PersistentVolumeClaimOverlay `json:"volumeClaim"`
}

type ObjectMeta struct {
	// Name must be unique within a namespace. Is required when creating resources, although
	// some resources may allow a client to request the generation of an appropriate name
	// automatically. Name is primarily intended for creation idempotence and configuration
	// definition.
	// Cannot be updated.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#names
	// +optional
	Name string `json:"name,omitempty"`
	// Map of string keys and values that can be used to organize and categorize
	// (scope and select) objects. May match selectors of replication controllers
	// and services.
	// More info: http://kubernetes.io/docs/user-guide/labels
	// +optional
	// +kubebuilder:validation:MaxProperties=512
	Labels map[string]string `json:"labels,omitempty"`

	// Annotations is an unstructured key value map stored with a resource that may be
	// set by external tools to store and retrieve arbitrary metadata. They are not
	// queryable and should be preserved when modifying objects.
	// More info: http://kubernetes.io/docs/user-guide/annotations
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
}

type Overlay struct {
	Pod *PodOverlay `json:"pod,omitempty"`
	// +listType=map
	// +listMapKey=name
	// +kubebuilder:validation:MaxItems=256
	PersistentVolumeClaims []NamedPersistentVolumeClaimOverlay `json:"volumeClaims,omitempty"`
}

type PD struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PDSpec   `json:"spec,omitempty"`
	Status PDStatus `json:"status,omitempty"`
}

type PDGroup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PDGroupSpec   `json:"spec,omitempty"`
	Status PDGroupStatus `json:"status,omitempty"`
}

type PDGroupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []PDGroup `json:"items"`
}

type PDGroupSpec struct {
	Cluster ClusterReference `json:"cluster"`

	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// +kubebuilder:validation:Minimum=0
	Replicas *int32 `json:"replicas"`

	// Bootstrapped means that pd cluster has been bootstrapped,
	// and there is no need to initialize a new cluster.
	// In other words, this PD group will just join an existing cluster.
	// Normally, this field is automatically changed by operator.
	// If it's true, it cannot be set to false for security
	// +kubebuilder:validation:XValidation:rule="!oldSelf || self",message="bootstrapped cannot be changed from true to false"
	Bootstrapped bool `json:"bootstrapped,omitempty"`

	// +listType=map
	// +listMapKey=type
	SchedulePolicies []SchedulePolicy `json:"schedulePolicies,omitempty"`

	// MinReadySeconds specifies the minimum number of seconds for which a newly created pod
	// be ready without any of its containers crashing, for it to be considered available.
	// +kubebuilder:validation:Minimum=0
	// +optional
	MinReadySeconds *int64 `json:"minReadySeconds,omitempty"`

	Template PDTemplate `json:"template"`
}

type PDGroupStatus struct {
	CommonStatus `json:",inline"`
	GroupStatus  `json:",inline"`
}

type PDList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []PD `json:"items"`
}

type PDMode string

type PDPorts struct {
	// Client defines port for pd's api service
	Client *Port `json:"client,omitempty"`
	// Peer defines port for peer communication
	Peer *Port `json:"peer,omitempty"`
}

type PDServer struct {
	// Ports defines all ports listened by pd
	Ports PDPorts `json:"ports,omitempty"`
}

type PDSpec struct {
	// Cluster is a reference of tidb cluster
	Cluster ClusterReference `json:"cluster"`

	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// Topology defines the topology domain of this pd instance
	// It will be translated into a node affinity config
	// Topology cannot be changed
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="topology is immutable"
	Topology Topology `json:"topology,omitempty"`

	// Subdomain means the subdomain of the exported pd dns.
	// A same pd cluster will use a same subdomain
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="subdomain is immutable"
	Subdomain string `json:"subdomain"`

	// PDTemplateSpec embedded some fields managed by PDGroup
	PDTemplateSpec `json:",inline"`
}

type PDStatus struct {
	CommonStatus `json:",inline"`

	// ID is the member id of this pd instance
	ID string `json:"id"`

	// IsLeader indicates whether this pd is the leader
	// NOTE: it's a snapshot from PD, not always up to date
	// TODO(liubo02): change to use condition
	IsLeader bool `json:"isLeader"`
}

type PDTemplate struct {
	ObjectMeta `json:"metadata,omitempty"`
	Spec       PDTemplateSpec `json:"spec"`
}

type PDTemplateSpec struct {
	// Version must be a semantic version.
	// It can has a v prefix or not.
	// +kubebuilder:validation:Pattern=`^(v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$`
	Version string `json:"version"`
	// Image is pd's image
	// If tag is omitted, version will be used as the image tag.
	// Default is pingcap/pd
	Image *string `json:"image,omitempty"`

	// Mode of pd, default is normal
	// Now it cannot be changed after creation. It may be supported in the future.
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="pd mode is immutable now, it may be supported later"
	Mode PDMode `json:"mode,omitempty"`
	// Server defines server config for PD
	Server         PDServer             `json:"server,omitempty"`
	Resources      ResourceRequirements `json:"resources,omitempty"`
	UpdateStrategy UpdateStrategy       `json:"updateStrategy,omitempty"`

	// Config defines config file of PD
	Config ConfigFile `json:"config,omitempty"`

	// Security defines security config
	Security *Security `json:"security,omitempty"`

	// Volumes defines persistent volumes of PD
	// +listType=map
	// +listMapKey=name
	// +kubebuilder:validation:MaxItems=256
	Volumes []Volume `json:"volumes"`
	// Overlay defines a k8s native resource template patch
	// All resources(pod, pvcs, ...) managed by PD can be overlaid by this field
	Overlay *Overlay `json:"overlay,omitempty"`
}

type PersistentVolumeClaimOverlay struct {
	ObjectMeta `json:"metadata,omitempty"`
	Spec       *corev1.PersistentVolumeClaimSpec `json:"spec,omitempty"`
}

type PodOverlay struct {
	// +kubebuilder:validation:XValidation:rule="!has(self.labels) || self.labels.all(key, !key.startsWith('pingcap.com/'))",message="cannot overlay pod labels starting with 'pingcap.com/'"
	ObjectMeta `json:"metadata,omitempty"`
	Spec       *corev1.PodSpec `json:"spec,omitempty"`
}

type Port struct {
	Port int32 `json:"port"`
}

type ResourceManager struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ResourceManagerSpec   `json:"spec,omitempty"`
	Status ResourceManagerStatus `json:"status,omitempty"`
}

type ResourceManagerGroup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ResourceManagerGroupSpec   `json:"spec,omitempty"`
	Status ResourceManagerGroupStatus `json:"status,omitempty"`
}

type ResourceManagerGroupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []ResourceManagerGroup `json:"items"`
}

type ResourceManagerGroupSpec struct {
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// +kubebuilder:validation:Minimum=0
	Replicas *int32 `json:"replicas"`

	// +listType=map
	// +listMapKey=type
	SchedulePolicies []SchedulePolicy `json:"schedulePolicies,omitempty"`

	// MinReadySeconds specifies the minimum number of seconds for which a newly created pod be ready without any of its containers crashing, for it to be considered available.
	// +kubebuilder:validation:Minimum=0
	// +optional
	MinReadySeconds *int64 `json:"minReadySeconds,omitempty"`

	Template ResourceManagerTemplate `json:"template"`
}

type ResourceManagerGroupStatus struct {
	CommonStatus `json:",inline"`
	GroupStatus  `json:",inline"`
}

type ResourceManagerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []ResourceManager `json:"items"`
}

type ResourceManagerPorts struct {
	// Client defines port for ResourceManager's api service
	Client *Port `json:"client,omitempty"`
}

type ResourceManagerServer struct {
	// Ports defines all ports listened by ResourceManager
	Ports ResourceManagerPorts `json:"ports,omitempty"`
}

type ResourceManagerSpec struct {
	// Cluster is a reference of tidb cluster
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// Topology defines the topology domain of this ResourceManager instance
	// It will be translated into a node affinity config
	// Topology cannot be changed
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="topology is immutable"
	Topology Topology `json:"topology,omitempty"`

	// Subdomain means the subdomain of the exported ResourceManager dns.
	// A same ResourceManager cluster will use a same subdomain
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="subdomain is immutable"
	Subdomain string `json:"subdomain"`

	// ResourceManagerTemplateSpec embedded some fields managed by ResourceManagerGroup
	ResourceManagerTemplateSpec `json:",inline"`
}

type ResourceManagerStatus struct {
	CommonStatus `json:",inline"`
}

type ResourceManagerTemplate struct {
	ObjectMeta `json:"metadata,omitempty"`
	Spec       ResourceManagerTemplateSpec `json:"spec"`
}

type ResourceManagerTemplateSpec struct {
	// Version must be a semantic version.
	// It can has a v prefix or not.
	// +kubebuilder:validation:Pattern=`^(v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$`
	Version string `json:"version"`

	// Image is pd's image
	// If tag is omitted, version will be used as the image tag.
	// Default is pingcap/pd
	Image *string `json:"image,omitempty"`

	// Server defines server config for ResourceManager
	Server ResourceManagerServer `json:"server,omitempty"`

	Resources ResourceRequirements `json:"resources,omitempty"`

	UpdateStrategy UpdateStrategy `json:"updateStrategy,omitempty"`

	// Config defines config file of ResourceManager
	Config ConfigFile `json:"config,omitempty"`

	// Security defines security config
	Security *Security `json:"security,omitempty"`

	// Volumes defines persistent volumes of ResourceManager
	// +listType=map
	// +listMapKey=name
	// +kubebuilder:validation:MaxItems=256
	Volumes []Volume `json:"volumes,omitempty"`

	// Overlay defines a k8s native resource template patch
	// All resources(pod, pvcs, ...) managed by ResourceManager can be overlayed by this field
	Overlay *Overlay `json:"overlay,omitempty"`
}

type ResourceRequirements struct {
	CPU    *resource.Quantity `json:"cpu,omitempty"`
	Memory *resource.Quantity `json:"memory,omitempty"`
}

type Router struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   RouterSpec   `json:"spec,omitempty"`
	Status RouterStatus `json:"status,omitempty"`
}

type RouterGroup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   RouterGroupSpec   `json:"spec,omitempty"`
	Status RouterGroupStatus `json:"status,omitempty"`
}

type RouterGroupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []RouterGroup `json:"items"`
}

type RouterGroupSpec struct {
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// +kubebuilder:validation:Minimum=0
	Replicas *int32 `json:"replicas"`

	// +listType=map
	// +listMapKey=type
	SchedulePolicies []SchedulePolicy `json:"schedulePolicies,omitempty"`

	// MinReadySeconds specifies the minimum number of seconds for which a newly created pod be ready without any of its containers crashing, for it to be considered available.
	// +kubebuilder:validation:Minimum=0
	// +optional
	MinReadySeconds *int64 `json:"minReadySeconds,omitempty"`

	Template RouterTemplate `json:"template"`
}

type RouterGroupStatus struct {
	CommonStatus `json:",inline"`
	GroupStatus  `json:",inline"`
}

type RouterList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Router `json:"items"`
}

type RouterPorts struct {
	// Client defines port for Router's api service
	Client *Port `json:"client,omitempty"`
}

type RouterServer struct {
	// Ports defines all ports listened by Router
	Ports RouterPorts `json:"ports,omitempty"`
}

type RouterSpec struct {
	// Cluster is a reference of tidb cluster
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// Topology defines the topology domain of this Router instance
	// It will be translated into a node affinity config
	// Topology cannot be changed
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="topology is immutable"
	Topology Topology `json:"topology,omitempty"`

	// Subdomain means the subdomain of the exported Router dns.
	// A same Router cluster will use a same subdomain
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="subdomain is immutable"
	Subdomain string `json:"subdomain"`

	// RouterTemplateSpec embedded some fields managed by RouterGroup
	RouterTemplateSpec `json:",inline"`
}

type RouterStatus struct {
	CommonStatus `json:",inline"`
}

type RouterTemplate struct {
	ObjectMeta `json:"metadata,omitempty"`
	Spec       RouterTemplateSpec `json:"spec"`
}

type RouterTemplateSpec struct {
	// Version must be a semantic version.
	// It can has a v prefix or not.
	// +kubebuilder:validation:Pattern=`^(v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$`
	Version string `json:"version"`

	// Image is pd's image
	// If tag is omitted, version will be used as the image tag.
	// Default is pingcap/pd
	Image *string `json:"image,omitempty"`

	// Server defines server config for Router
	Server RouterServer `json:"server,omitempty"`

	Resources ResourceRequirements `json:"resources,omitempty"`

	UpdateStrategy UpdateStrategy `json:"updateStrategy,omitempty"`

	// Config defines config file of Router
	Config ConfigFile `json:"config,omitempty"`

	// Security defines security config
	Security *Security `json:"security,omitempty"`

	// Volumes defines persistent volumes of Router
	// +listType=map
	// +listMapKey=name
	// +kubebuilder:validation:MaxItems=256
	Volumes []Volume `json:"volumes,omitempty"`

	// Overlay defines a k8s native resource template patch
	// All resources(pod, pvcs, ...) managed by Router can be overlayed by this field
	Overlay *Overlay `json:"overlay,omitempty"`
}

type SEM struct {
	// Config defines the configmap reference of the sem config
	// By default, we use the 'sem.json' as the file key of configmap
	Config corev1.LocalObjectReference `json:"config"`
}

type SchedulePolicy struct {
	Type         SchedulePolicyType          `json:"type"`
	EvenlySpread *SchedulePolicyEvenlySpread `json:"evenlySpread,omitempty"`
}

type SchedulePolicyEvenlySpread struct {
	// All instances of a group will evenly spread in different topologies
	Topologies []ScheduleTopology `json:"topologies"`
}

type SchedulePolicyType string

type ScheduleTopology struct {
	// Topology means the topo for scheduling
	Topology Topology `json:"topology"`
	// Weight defines how many pods will be scheduled to this topo
	// default is 1
	// +kubebuilder:validation:Minimum=1
	Weight *int32 `json:"weight,omitempty"`
}

type Scheduler struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SchedulerSpec   `json:"spec,omitempty"`
	Status SchedulerStatus `json:"status,omitempty"`
}

type SchedulerGroup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SchedulerGroupSpec   `json:"spec,omitempty"`
	Status SchedulerGroupStatus `json:"status,omitempty"`
}

type SchedulerGroupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []SchedulerGroup `json:"items"`
}

type SchedulerGroupSpec struct {
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// +kubebuilder:validation:Minimum=0
	Replicas *int32 `json:"replicas"`

	// +listType=map
	// +listMapKey=type
	SchedulePolicies []SchedulePolicy `json:"schedulePolicies,omitempty"`

	// MinReadySeconds specifies the minimum number of seconds for which a newly created pod be ready without any of its containers crashing, for it to be considered available.
	// +kubebuilder:validation:Minimum=0
	// +optional
	MinReadySeconds *int64 `json:"minReadySeconds,omitempty"`

	Template SchedulerTemplate `json:"template"`
}

type SchedulerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Scheduler `json:"items"`
}

type SchedulerSpec struct {
	// Cluster is a reference of tidb cluster
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// Topology defines the topology domain of this Scheduler instance
	// It will be translated into a node affinity config
	// Topology cannot be changed
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="topology is immutable"
	Topology Topology `json:"topology,omitempty"`

	// Subdomain means the subdomain of the exported Scheduler dns.
	// A same Scheduler cluster will use a same subdomain
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="subdomain is immutable"
	Subdomain string `json:"subdomain"`

	// SchedulerTemplateSpec embedded some fields managed by SchedulerGroup
	SchedulerTemplateSpec `json:",inline"`
}

type SchedulerTemplate struct {
	ObjectMeta `json:"metadata,omitempty"`
	Spec       SchedulerTemplateSpec `json:"spec"`
}

type SchedulerTemplateSpec struct {
	// Version must be a semantic version.
	// It can has a v prefix or not.
	// +kubebuilder:validation:Pattern=`^(v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$`
	Version string `json:"version"`

	// Image is scheduler's image
	// If tag is omitted, version will be used as the image tag.
	// Default is pingcap/pd
	Image *string `json:"image,omitempty"`

	// Server defines server config for Scheduler
	Server SchedulerServer `json:"server,omitempty"`

	Resources ResourceRequirements `json:"resources,omitempty"`

	UpdateStrategy UpdateStrategy `json:"updateStrategy,omitempty"`

	// Config defines config file of Scheduler
	// See https://docs.pingcap.com/tidb/stable/scheduling-configuration-file/
	Config ConfigFile `json:"config,omitempty"`

	// Security defines security config
	Security *Security `json:"security,omitempty"`

	// Volumes defines persistent volumes of Scheduler
	// +listType=map
	// +listMapKey=name
	// +kubebuilder:validation:MaxItems=256
	Volumes []Volume `json:"volumes,omitempty"`

	// Overlay defines a k8s native resource template patch
	// All resources(pod, pvcs, ...) managed by Scheduler can be overlayed by this field
	Overlay *Overlay `json:"overlay,omitempty"`
}

type Scheduling struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SchedulingSpec   `json:"spec,omitempty"`
	Status SchedulingStatus `json:"status,omitempty"`
}

type SchedulingGroup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SchedulingGroupSpec   `json:"spec,omitempty"`
	Status SchedulingGroupStatus `json:"status,omitempty"`
}

type SchedulingGroupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []SchedulingGroup `json:"items"`
}

type SchedulingGroupSpec struct {
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// +kubebuilder:validation:Minimum=0
	Replicas *int32 `json:"replicas"`

	// +listType=map
	// +listMapKey=type
	SchedulePolicies []SchedulePolicy `json:"schedulePolicies,omitempty"`

	// MinReadySeconds specifies the minimum number of seconds for which a newly created pod be ready without any of its containers crashing, for it to be considered available.
	// +kubebuilder:validation:Minimum=0
	// +optional
	MinReadySeconds *int64 `json:"minReadySeconds,omitempty"`

	Template SchedulingTemplate `json:"template"`
}

type SchedulingGroupStatus struct {
	CommonStatus `json:",inline"`
	GroupStatus  `json:",inline"`
}

type SchedulingList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Scheduling `json:"items"`
}

type SchedulingPorts struct {
	// Client defines port for Scheduling's api service
	Client *Port `json:"client,omitempty"`
}

type SchedulingServer struct {
	// Ports defines all ports listened by Scheduling
	Ports SchedulingPorts `json:"ports,omitempty"`
}

type SchedulingSpec struct {
	// Cluster is a reference of tidb cluster
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// Topology defines the topology domain of this Scheduling instance
	// It will be translated into a node affinity config
	// Topology cannot be changed
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="topology is immutable"
	Topology Topology `json:"topology,omitempty"`

	// Subdomain means the subdomain of the exported Scheduling dns.
	// A same Scheduling cluster will use a same subdomain
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="subdomain is immutable"
	Subdomain string `json:"subdomain"`

	// SchedulingTemplateSpec embedded some fields managed by SchedulingGroup
	SchedulingTemplateSpec `json:",inline"`
}

type SchedulingStatus struct {
	CommonStatus `json:",inline"`
}

type SchedulingTemplate struct {
	ObjectMeta `json:"metadata,omitempty"`
	Spec       SchedulingTemplateSpec `json:"spec"`
}

type SchedulingTemplateSpec struct {
	// Version must be a semantic version.
	// It can has a v prefix or not.
	// +kubebuilder:validation:Pattern=`^(v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$`
	Version string `json:"version"`

	// Image is pd's image
	// If tag is omitted, version will be used as the image tag.
	// Default is pingcap/pd
	Image *string `json:"image,omitempty"`

	// Server defines server config for Scheduling
	Server SchedulingServer `json:"server,omitempty"`

	Resources ResourceRequirements `json:"resources,omitempty"`

	UpdateStrategy UpdateStrategy `json:"updateStrategy,omitempty"`

	// Config defines config file of Scheduling
	// See https://docs.pingcap.com/tidb/stable/scheduling-configuration-file/
	Config ConfigFile `json:"config,omitempty"`

	// Security defines security config
	Security *Security `json:"security,omitempty"`

	// Volumes defines persistent volumes of Scheduling
	// +listType=map
	// +listMapKey=name
	// +kubebuilder:validation:MaxItems=256
	Volumes []Volume `json:"volumes,omitempty"`

	// Overlay defines a k8s native resource template patch
	// All resources(pod, pvcs, ...) managed by Scheduling can be overlayed by this field
	Overlay *Overlay `json:"overlay,omitempty"`
}

type Security struct {
	// TLS defines the tls configs of components
	TLS *ComponentTLSConfig `json:"tls,omitempty"`
}

type StoreStatus struct {
	// ID is the store id.
	ID string `json:"id,omitempty"`

	// State is the store state.
	State string `json:"state,omitempty"`
}

type SuspendAction struct {
	// SuspendCompute indicates delete the pods but keep the PVCs.
	SuspendCompute bool `json:"suspendCompute,omitempty"`
}

type TLS struct {
	// Enabled means whether enable tls
	Enabled bool `json:"enabled"`

	// Defaults to VerifyClientCertIfNeed
	// +optional
	ClientAuth ClientAuthType `json:"clientAuth,omitempty"`

	// TLSSecret defines secret references for tls config
	TLSSecret `json:",inline"`
}

type TLSCluster struct {
	// Enable mutual TLS connection between TiDB cluster components.
	// Once enabled, the mutual authentication applies to all components,
	// and it does not support applying to only part of the components.
	// The steps to enable this feature:
	//   1. Generate TiDB cluster components certificates and a client-side certifiacete for them.
	//      There are multiple ways to generate these certificates:
	//        - user-provided certificates: https://docs.pingcap.com/tidb/stable/generate-self-signed-certificates
	//        - use the K8s built-in certificate signing system signed certificates: https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/
	//        - or use cert-manager signed certificates: https://cert-manager.io/
	//   2. Create one secret object for one component group which contains the certificates created above.
	//      The name of this Secret must be: <groupName>-<componentName>-cluster-secret.
	//        For PD: kubectl create secret generic <groupName>-pd-cluster-secret --namespace=<namespace> --from-file=tls.crt=<path/to/tls.crt> --from-file=tls.key=<path/to/tls.key> --from-file=ca.crt=<path/to/ca.crt>
	//        For TiKV: kubectl create secret generic <groupName>-tikv-cluster-secret --namespace=<namespace> --from-file=tls.crt=<path/to/tls.crt> --from-file=tls.key=<path/to/tls.key> --from-file=ca.crt=<path/to/ca.crt>
	//        For TiDB: kubectl create secret generic <groupName>-tidb-cluster-secret --namespace=<namespace> --from-file=tls.crt=<path/to/tls.crt> --from-file=tls.key=<path/to/tls.key> --from-file=ca.crt=<path/to/ca.crt>
	//        For TiBR: kubectl create secret generic <tibrName>-tibr-cluster-secret --namespace=<namespace> --from-file=tls.crt=<path/to/tls.crt> --from-file=tls.key=<path/to/tls.key> --from-file=ca.crt=<path/to/ca.crt>
	//        For TiBRGC: kubectl create secret generic <tibrgcName>-tibrgc-cluster-secret --namespace=<namespace> --from-file=tls.crt=<path/to/tls.crt> --from-file=tls.key=<path/to/tls.key> --from-file=ca.crt=<path/to/ca.crt>
	//        For Client: kubectl create secret generic <clusterName>-cluster-client-secret --namespace=<namespace> --from-file=tls.crt=<path/to/tls.crt> --from-file=tls.key=<path/to/tls.key> --from-file=ca.crt=<path/to/ca.crt>
	//        Same for other components.
	// +optional
	Enabled bool `json:"enabled,omitempty"`
}

type TLSSecret struct {
	// CA defines the ref of the secret which contains ca.crt
	// +optional
	CA *CAReference `json:"ca,omitempty"`
	// CertKeyPair defines the ref of the secret which contains tls.crt and tls.key
	// +optional
	CertKeyPair *CertKeyPairReference `json:"certKeyPair,omitempty"`
}

type TSO struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   TSOSpec   `json:"spec,omitempty"`
	Status TSOStatus `json:"status,omitempty"`
}

type TSOGroup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   TSOGroupSpec   `json:"spec,omitempty"`
	Status TSOGroupStatus `json:"status,omitempty"`
}

type TSOGroupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []TSOGroup `json:"items"`
}

type TSOGroupSpec struct {
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`
	// +kubebuilder:validation:Minimum=0
	Replicas *int32 `json:"replicas"`

	// +listType=map
	// +listMapKey=type
	SchedulePolicies []SchedulePolicy `json:"schedulePolicies,omitempty"`

	// MinReadySeconds specifies the minimum number of seconds for which a newly created pod be ready without any of its containers crashing, for it to be considered available.
	// +kubebuilder:validation:Minimum=0
	// +optional
	MinReadySeconds *int64 `json:"minReadySeconds,omitempty"`

	Template TSOTemplate `json:"template"`
}

type TSOGroupStatus struct {
	CommonStatus `json:",inline"`
	GroupStatus  `json:",inline"`
}

type TSOList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []TSO `json:"items"`
}

type TSOPorts struct {
	// Client defines port for tso's api service
	Client *Port `json:"client,omitempty"`
}

type TSOServer struct {
	// Ports defines all ports listened by tso
	Ports TSOPorts `json:"ports,omitempty"`
}

type TSOSpec struct {
	// Cluster is a reference of tidb cluster
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// Topology defines the topology domain of this tso instance
	// It will be translated into a node affinity config
	// Topology cannot be changed
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="topology is immutable"
	Topology Topology `json:"topology,omitempty"`

	// Subdomain means the subdomain of the exported tso dns.
	// A same tso cluster will use a same subdomain
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="subdomain is immutable"
	Subdomain string `json:"subdomain"`

	// TSOTemplateSpec embedded some fields managed by TSOGroup
	TSOTemplateSpec `json:",inline"`
}

type TSOStatus struct {
	CommonStatus `json:",inline"`

	// IsDefaultPrimary indicates whether this TSO instance is the primary for the default keyspace group.
	IsDefaultPrimary bool `json:"isDefaultPrimary"`
}

type TSOTemplate struct {
	ObjectMeta `json:"metadata,omitempty"`
	Spec       TSOTemplateSpec `json:"spec"`
}

type TSOTemplateSpec struct {
	// Version must be a semantic version.
	// It can has a v prefix or not.
	// +kubebuilder:validation:Pattern=`^(v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$`
	Version string `json:"version"`

	// Image is pd's image
	// If tag is omitted, version will be used as the image tag.
	// Default is pingcap/pd
	Image *string `json:"image,omitempty"`

	// Server defines server config for TSO
	Server TSOServer `json:"server,omitempty"`

	Resources ResourceRequirements `json:"resources,omitempty"`

	// Config defines config file of TSO
	// See https://docs.pingcap.com/tidb/stable/tso-configuration-file/
	Config         ConfigFile     `json:"config,omitempty"`
	UpdateStrategy UpdateStrategy `json:"updateStrategy,omitempty"`

	// Security defines security config
	Security *Security `json:"security,omitempty"`

	// Volumes defines persistent volumes of TSO
	// +listType=map
	// +listMapKey=name
	// +kubebuilder:validation:MaxItems=256
	Volumes []Volume `json:"volumes,omitempty"`

	// Overlay defines a k8s native resource template patch
	// All resources(pod, pvcs, ...) managed by TSO can be overlayed by this field
	Overlay *Overlay `json:"overlay,omitempty"`
}

type TiCDC struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   TiCDCSpec   `json:"spec,omitempty"`
	Status TiCDCStatus `json:"status,omitempty"`
}

type TiCDCGroup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   TiCDCGroupSpec   `json:"spec,omitempty"`
	Status TiCDCGroupStatus `json:"status,omitempty"`
}

type TiCDCGroupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []TiCDCGroup `json:"items"`
}

type TiCDCGroupSpec struct {
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// +kubebuilder:validation:Minimum=0
	Replicas *int32 `json:"replicas"`

	// +listType=map
	// +listMapKey=type
	SchedulePolicies []SchedulePolicy `json:"schedulePolicies,omitempty"`

	// MinReadySeconds specifies the minimum number of seconds for which a newly created pod be ready without any of its containers crashing, for it to be considered available.
	// +kubebuilder:validation:Minimum=0
	// +optional
	MinReadySeconds *int64 `json:"minReadySeconds,omitempty"`

	Template TiCDCTemplate `json:"template"`
}

type TiCDCGroupStatus struct {
	CommonStatus `json:",inline"`
	GroupStatus  `json:",inline"`
}

type TiCDCList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []TiCDC `json:"items"`
}

type TiCDCPorts struct {
	// Port defines main port for TiCDC.
	Port *Port `json:"port,omitempty"`
}

type TiCDCPreStop struct {
	// Image of pre stop checker
	// Default is pingcap/prestop-checker:latest
	Image *string `json:"image,omitempty"`
}

type TiCDCServer struct {
	// Ports defines all ports listened by TiCDC
	Ports TiCDCPorts `json:"ports,omitempty"`
}

type TiCDCSpec struct {
	// Cluster is a reference of tidb cluster
	Cluster ClusterReference `json:"cluster"`
	// Features are enabled feature
	Features []meta.Feature `json:"features,omitempty"`

	// Topology defines the topology domain of this TiCDC instance
	// It will be translated into a node affinity config
	// Topology cannot be changed
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="topology is immutable"
	Topology Topology `json:"topology,omitempty"`

	// Subdomain means the subdomain of the exported TiCDC DNS.
	// A same TiCDC cluster will use a same subdomain
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="subdomain is immutable"
	Subdomain string `json:"subdomain"`

	// TiCDCTemplateSpec embedded some fields managed by TiCDCGroup
	TiCDCTemplateSpec `json:",inline"`
}

type TiCDCStatus struct {
	CommonStatus `json:",inline"`

	// ID is the member id of this TiCDC instance
	ID string `json:"id"`

	// should we need to save IsOwner in status?
	// but this value may be changed when scaling in or rolling update
	// TODO(liubo02): change to use condition
	IsOwner bool `json:"isOwner"`
}

type TiCDCSyncer struct {
	// Image of resource syncer
	// Default is pingcap/tidb-operator-resource-syncer
	Image *string `json:"image,omitempty"`

	// Additional labels to select.
	// Only resources with these labels will be synced into pods
	// - pingcap.com/managed-by: tidb-operator
	// - pingcap.com/component: ticdc
	// - pingcap.com/cluster: ${cluster}
	// - additional labels
	Labels map[string]string `json:"labels,omitempty"`
}

type TiCDCTemplate struct {
	ObjectMeta `json:"metadata,omitempty"`
	Spec       TiCDCTemplateSpec `json:"spec"`
}

type TiCDCTemplateSpec struct {
	// Version must be a semantic version.
	// It can has a v prefix or not.
	// +kubebuilder:validation:Pattern=`^(v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$`
	Version string `json:"version"`
	// Image is TiCDC's image
	// If tag is omitted, version will be used as the image tag.
	// Default is pingcap/ticdc
	Image *string `json:"image,omitempty"`
	// Server defines server config for TiCDC
	Server         TiCDCServer          `json:"server,omitempty"`
	Resources      ResourceRequirements `json:"resources,omitempty"`
	UpdateStrategy UpdateStrategy       `json:"updateStrategy,omitempty"`
	// Config defines config file of TiCDC
	Config ConfigFile `json:"config,omitempty"`

	// Security defines security config
	Security *Security `json:"security,omitempty"`

	// Volumes defines persistent volumes of TiCDC, it is optional.
	// If you want to use ephemeral storage or mount sink TLS certs, you can use "overlay" instead.
	// +listType=map
	// +listMapKey=name
	// +kubebuilder:validation:MaxItems=256
	Volumes []Volume `json:"volumes,omitempty"`
	// Overlay defines a k8s native resource template patch
	// All resources(pod, pvcs, ...) managed by TiCDC can be overlayed by this field
	Overlay *Overlay `json:"overlay,omitempty"`

	// PreStop defines preStop config
	PreStop *TiCDCPreStop `json:"preStop,omitempty"`

	// Syncer defines syncer config
	Syncer *TiCDCSyncer `json:"syncer,omitempty"`
}