feat(crd): add missing listType

api/core/v1alpha1/cluster_types.go

@@ -77,6 +77,8 @@ type ClusterSpec struct {
 	// +kubebuilder:validation:Minimum=0
 	RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty"`
 
+	// +listType=map
+	// +listMapKey=name
 	FeatureGates []meta.FeatureGate `json:"featureGates,omitempty"`
 }
 
@@ -148,6 +150,8 @@ type ClusterStatus struct {
 	PD string `json:"pd,omitempty"`
 
 	// FeatureGates of this cluster
+	// +listType=map
+	// +listMapKey=name
 	FeatureGates []meta.FeatureGateStatus `json:"featureGates,omitempty"`
 }
 

api/core/v1alpha1/common_types.go

@@ -158,15 +158,22 @@ type Topology map[string]string
 // Overlay defines some templates of k8s native resources.
 // Users can specify this field to overlay the spec of managed resources(pod, pvcs, ...).
 type Overlay struct {
-	Pod                    *PodOverlay                    `json:"pod,omitempty"`
-	PersistentVolumeClaims []PersistentVolumeClaimOverlay `json:"volumeClaims,omitempty"`
+	Pod *PodOverlay `json:"pod,omitempty"`
+	// +listType=map
+	// +listMapKey=name
+	PersistentVolumeClaims []NamedPersistentVolumeClaimOverlay `json:"volumeClaims,omitempty"`
 }
 
 type PodOverlay struct {
 	ObjectMeta `json:"metadata,omitempty"`
 	Spec       *corev1.PodSpec `json:"spec,omitempty"`
 }
 
+type NamedPersistentVolumeClaimOverlay struct {
+	Name                  string                       `json:"name"`
+	PersistentVolumeClaim PersistentVolumeClaimOverlay `json:"volumeClaim"`
+}
+
 type PersistentVolumeClaimOverlay struct {
 	ObjectMeta `json:"metadata,omitempty"`
 	Spec       *corev1.PersistentVolumeClaimSpec `json:"spec,omitempty"`
@@ -179,10 +186,11 @@ type ConfigFile string
 // For example, a volume can be mounted for both data and raft log.
 type Volume struct {
 	// Name is volume name.
-	// If not specified, the PVC name will be "{component}-{podName}"
-	Name string `json:"name,omitempty"`
+	Name string `json:"name"`
 
 	// Mounts defines mount infos of this volume
+	// NOTE(liubo02): it cannot be a list map because the key is "type" or "mountPath" which is not supported
+	// +listType=atomic
 	Mounts []VolumeMount `json:"mounts"`
 
 	// Storage defines the request size of this volume
@@ -257,6 +265,8 @@ type ResourceRequirements struct {
 // CommonStatus defines common status fields for instances and groups managed by TiDB Operator.
 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.

api/core/v1alpha1/pd_types.go

@@ -144,6 +144,8 @@ type PDTemplateSpec struct {
 	// Config defines config file of PD
 	Config ConfigFile `json:"config"`
 	// Volumes defines persistent volumes of PD
+	// +listType=map
+	// +listMapKey=name
 	Volumes []Volume `json:"volumes"`
 	// Overlay defines a k8s native resource template patch
 	// All resources(pod, pvcs, ...) managed by PD can be overlayed by this field

api/core/v1alpha1/ticdc_types.go

@@ -123,6 +123,8 @@ type TiCDCTemplateSpec struct {
 
 	// 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
 	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

api/core/v1alpha1/tidb_types.go

@@ -148,6 +148,8 @@ type TiDBTemplateSpec struct {
 
 	Security *TiDBSecurity `json:"security,omitempty"`
 	// Volumes defines data volume of TiDB, it is optional.
+	// +listType=map
+	// +listMapKey=name
 	Volumes []Volume `json:"volumes,omitempty"`
 
 	// SlowLog defines the separate slow log configuration for TiDB.

api/core/v1alpha1/tiflash_types.go

@@ -137,6 +137,8 @@ type TiFlashTemplateSpec struct {
 	ProxyConfig ConfigFile `json:"proxyConfig,omitempty"`
 
 	// Volumes defines data volume of TiFlash
+	// +listType=map
+	// +listMapKey=name
 	Volumes []Volume `json:"volumes"`
 
 	// LogTailer defines the sidercar log tailer config of TiFlash.

api/core/v1alpha1/tikv_types.go

@@ -145,6 +145,8 @@ type TiKVTemplateSpec struct {
 	Config         ConfigFile     `json:"config"`
 	UpdateStrategy UpdateStrategy `json:"updateStrategy,omitempty"`
 	// Volumes defines data volume of TiKV
+	// +listType=map
+	// +listMapKey=name
 	Volumes []Volume `json:"volumes"`
 
 	// PreStop defines preStop config

manifests/crd/core.pingcap.com_clusters.yaml

@@ -85,6 +85,9 @@ spec:
                   - name
                   type: object
                 type: array
+                x-kubernetes-list-map-keys:
+                - name
+                x-kubernetes-list-type: map
               paused:
                 description: Paused specifies whether to pause the reconciliation
                   loop for all components of the cluster.
@@ -238,6 +241,9 @@ spec:
                   - stage
                   type: object
                 type: array
+                x-kubernetes-list-map-keys:
+                - name
+                x-kubernetes-list-type: map
               id:
                 description: ID is the cluster id.
                 type: string