Able to omit storageClassName to use the default storage class of Kub…

…ernetes (#1581)

* Able to omit storageClassName

Signed-off-by: Yecheng Fu <fuyecheng@pingcap.com>

* remove -default-storage-class-name and -default-backup-storage-class
flags

Signed-off-by: Yecheng Fu <fuyecheng@pingcap.com>

Co-authored-by: Song Gao <disxiaofei@163.com>

charts/tidb-operator/templates/controller-manager-deployment.yaml

@@ -33,14 +33,10 @@ spec:
 {{ toYaml .Values.controllerManager.resources | indent 12 }}
         command:
           - /usr/local/bin/tidb-controller-manager
-          - -default-storage-class-name={{ .Values.defaultStorageClassName }}
           {{- if .Values.tidbBackupManagerImage }}
           - -tidb-backup-manager-image={{ .Values.tidbBackupManagerImage }}
           - -tidb-discovery-image={{ .Values.operatorImage }}
           {{- end }}
-          {{- if .Values.defaultBackupStorageClassName }}
-          - -default-backup-storage-class-name={{ .Values.defaultBackupStorageClassName }}
-          {{- end }}
           - -cluster-scoped={{ .Values.clusterScoped }}
           - -auto-failover={{ .Values.controllerManager.autoFailover | default true }}
           - -pd-failover-period={{ .Values.controllerManager.pdFailoverPeriod | default "5m" }}

charts/tidb-operator/values.yaml

@@ -15,11 +15,8 @@ timezone: UTC
 operatorImage: pingcap/tidb-operator:v1.1.0-beta.1
 imagePullPolicy: IfNotPresent
 
-defaultStorageClassName: local-storage
-
 # tidbBackupManagerImage is tidb backup manager image
 # tidbBackupManagerImage: pingcap/tidb-backup-manager:latest
-# defaultBackupStorageClassName: local-storage
 
 #
 # Enable or disable tidb-operator features:

cmd/controller-manager/main.go

@@ -67,8 +67,6 @@ func init() {
 	flag.BoolVar(&printVersion, "version", false, "Show version and quit")
 	flag.IntVar(&workers, "workers", 5, "The number of workers that are allowed to sync concurrently. Larger number = more responsive management, but more CPU (and network) load")
 	flag.BoolVar(&controller.ClusterScoped, "cluster-scoped", true, "Whether tidb-operator should manage kubernetes cluster wide TiDB Clusters")
-	flag.StringVar(&controller.DefaultStorageClassName, "default-storage-class-name", "standard", "Default storage class name")
-	flag.StringVar(&controller.DefaultBackupStorageClassName, "default-backup-storage-class-name", "standard", "Default storage class name for backup and restore")
 	flag.BoolVar(&autoFailover, "auto-failover", true, "Auto failover")
 	flag.DurationVar(&pdFailoverPeriod, "pd-failover-period", time.Duration(5*time.Minute), "PD failover period default(5m)")
 	flag.DurationVar(&tikvFailoverPeriod, "tikv-failover-period", time.Duration(5*time.Minute), "TiKV failover period default(5m)")

manifests/crd.yaml

@@ -1853,10 +1853,8 @@ spec:
                       type: string
                   type: object
                 storageClassName:
-                  description: 'The storageClassName of the persistent volume for
-                    PD data storage, empty string means not explicitly set and use
-                    the cluster default set by admission controller. Optionals: Defaults
-                    to the default-storage-class-name set in the tidb-operator'
+                  description: The storageClassName of the persistent volume for PD
+                    data storage. Defaults to Kubernetes default storage class.
                   type: string
                 tolerations:
                   description: 'Tolerations of the component. Override the cluster-level
@@ -2693,10 +2691,8 @@ spec:
                     one if present Optional: Defaults to cluster-level setting'
                   type: string
                 storageClassName:
-                  description: 'The storageClassName of the persistent volume for
-                    Pump data storage, empty string means not explicitly set and use
-                    the cluster default set by admission controller. Optionals: Defaults
-                    to the default-storage-class-name set in the tidb-operator'
+                  description: The storageClassName of the persistent volume for Pump
+                    data storage. Defaults to Kubernetes default storage class.
                   type: string
                 tolerations:
                   description: 'Tolerations of the component. Override the cluster-level
@@ -6001,10 +5997,8 @@ spec:
                     one if present Optional: Defaults to cluster-level setting'
                   type: string
                 storageClassName:
-                  description: 'The storageClassName of the persistent volume for
-                    TiKV data storage, empty string means not explicitly set and use
-                    the cluster default set by admission controller. Optionals: Defaults
-                    to the default-storage-class-name set in the tidb-operator'
+                  description: The storageClassName of the persistent volume for TiKV
+                    data storage. Defaults to Kubernetes default storage class.
                   type: string
                 tolerations:
                   description: 'Tolerations of the component. Override the cluster-level
@@ -6316,8 +6310,8 @@ spec:
               - secretName
               type: object
             storageClassName:
-              description: StorageClassName is the storage class for backup job's
-                PV.
+              description: The storageClassName of the persistent volume for Backup
+                data storage. Defaults to Kubernetes default storage class.
               type: string
             storageSize:
               description: StorageSize is the request storage size for backup job
@@ -6448,8 +6442,8 @@ spec:
               - secretName
               type: object
             storageClassName:
-              description: StorageClassName is the storage class for backup job's
-                PV.
+              description: The storageClassName of the persistent volume for Restore
+                data storage. Defaults to Kubernetes default storage class.
               type: string
             storageSize:
               description: StorageSize is the request storage size for backup job
@@ -6479,7 +6473,6 @@ spec:
               type: object
           required:
           - to
-          - storageClassName
           - storageSize
           type: object
       type: object
@@ -6694,8 +6687,8 @@ spec:
                   - secretName
                   type: object
                 storageClassName:
-                  description: StorageClassName is the storage class for backup job's
-                    PV.
+                  description: The storageClassName of the persistent volume for Backup
+                    data storage. Defaults to Kubernetes default storage class.
                   type: string
                 storageSize:
                   description: StorageSize is the request storage size for backup
@@ -6718,8 +6711,9 @@ spec:
               description: Schedule specifies the cron string used for backup scheduling.
               type: string
             storageClassName:
-              description: StorageClassName is the storage class for backup job's
-                PV.
+              description: The storageClassName of the persistent volume for Backup
+                data storage if not storage class name set in BackupSpec. Defaults
+                to Kubernetes default storage class.
               type: string
             storageSize:
               description: StorageSize is the request storage size for backup job

pkg/apis/pingcap/v1alpha1/types.go

@@ -222,9 +222,8 @@ type PDSpec struct {
 	// +optional
 	Service *ServiceSpec `json:"service,omitempty"`
 
-	// The storageClassName of the persistent volume for PD data storage, empty string means not explicitly set
-	// and use the cluster default set by admission controller.
-	// Optionals: Defaults to the default-storage-class-name set in the tidb-operator
+	// The storageClassName of the persistent volume for PD data storage.
+	// Defaults to Kubernetes default storage class.
 	// +optional
 	StorageClassName *string `json:"storageClassName,omitempty"`
 
@@ -261,9 +260,8 @@ type TiKVSpec struct {
 	// +optional
 	MaxFailoverCount *int32 `json:"maxFailoverCount,omitempty"`
 
-	// The storageClassName of the persistent volume for TiKV data storage, empty string means not explicitly set
-	// and use the cluster default set by admission controller.
-	// Optionals: Defaults to the default-storage-class-name set in the tidb-operator
+	// The storageClassName of the persistent volume for TiKV data storage.
+	// Defaults to Kubernetes default storage class.
 	// +optional
 	StorageClassName *string `json:"storageClassName,omitempty"`
 
@@ -343,9 +341,8 @@ type PumpSpec struct {
 	// +optional
 	BaseImage string `json:"baseImage"`
 
-	// The storageClassName of the persistent volume for Pump data storage, empty string means not explicitly set
-	// and use the cluster default set by admission controller.
-	// Optionals: Defaults to the default-storage-class-name set in the tidb-operator
+	// The storageClassName of the persistent volume for Pump data storage.
+	// Defaults to Kubernetes default storage class.
 	// +optional
 	StorageClassName *string `json:"storageClassName,omitempty"`
 
@@ -744,8 +741,10 @@ type BackupSpec struct {
 	Type BackupType `json:"backupType,omitempty"`
 	// StorageProvider configures where and how backups should be stored.
 	StorageProvider `json:",inline"`
-	// StorageClassName is the storage class for backup job's PV.
-	StorageClassName string `json:"storageClassName,omitempty"`
+	// The storageClassName of the persistent volume for Backup data storage.
+	// Defaults to Kubernetes default storage class.
+	// +optional
+	StorageClassName *string `json:"storageClassName,omitempty"`
 	// StorageSize is the request storage size for backup job
 	StorageSize string `json:"storageSize,omitempty"`
 	// BRConfig is the configs for BR
@@ -866,8 +865,10 @@ type BackupScheduleSpec struct {
 	MaxReservedTime *string `json:"maxReservedTime,omitempty"`
 	// BackupTemplate is the specification of the backup structure to get scheduled.
 	BackupTemplate BackupSpec `json:"backupTemplate"`
-	// StorageClassName is the storage class for backup job's PV.
-	StorageClassName string `json:"storageClassName,omitempty"`
+	// The storageClassName of the persistent volume for Backup data storage if not storage class name set in BackupSpec.
+	// Defaults to Kubernetes default storage class.
+	// +optional
+	StorageClassName *string `json:"storageClassName,omitempty"`
 	// StorageSize is the request storage size for backup job
 	StorageSize string `json:"storageSize,omitempty"`
 }
@@ -944,8 +945,10 @@ type RestoreSpec struct {
 	Type BackupType `json:"backupType,omitempty"`
 	// StorageProvider configures where and how backups should be stored.
 	StorageProvider `json:",inline"`
-	// StorageClassName is the storage class for backup job's PV.
-	StorageClassName string `json:"storageClassName"`
+	// The storageClassName of the persistent volume for Restore data storage.
+	// Defaults to Kubernetes default storage class.
+	// +optional
+	StorageClassName *string `json:"storageClassName,omitempty"`
 	// StorageSize is the request storage size for backup job
 	StorageSize string `json:"storageSize"`
 }

pkg/backup/backup/backup_manager.go

@@ -327,18 +327,13 @@ func (bm *backupManager) ensureBackupPVCExist(backup *v1alpha1.Backup) (string,
 	}
 
 	// not found PVC, so we need to create PVC for backup job
-	storageClassName := controller.DefaultBackupStorageClassName
-	if backup.Spec.StorageClassName != "" {
-		storageClassName = backup.Spec.StorageClassName
-	}
 	pvc := &corev1.PersistentVolumeClaim{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      backupPVCName,
 			Namespace: ns,
 			Labels:    label.NewBackup().Instance(backup.GetInstanceName()),
 		},
 		Spec: corev1.PersistentVolumeClaimSpec{
-			StorageClassName: &storageClassName,
 			AccessModes: []corev1.PersistentVolumeAccessMode{
 				corev1.ReadWriteOnce,
 			},
@@ -347,6 +342,7 @@ func (bm *backupManager) ensureBackupPVCExist(backup *v1alpha1.Backup) (string,
 					corev1.ResourceStorage: rs,
 				},
 			},
+			StorageClassName: backup.Spec.StorageClassName,
 		},
 	}
 

pkg/backup/backupschedule/backup_schedule_manager.go

@@ -203,12 +203,8 @@ func (bm *backupScheduleManager) createBackup(bs *v1alpha1.BackupSchedule, times
 
 	backupSpec := *bs.Spec.BackupTemplate.DeepCopy()
 	if backupSpec.BR == nil {
-		if backupSpec.StorageClassName == "" {
-			if bs.Spec.StorageClassName != "" {
-				backupSpec.StorageClassName = bs.Spec.StorageClassName
-			} else {
-				backupSpec.StorageClassName = controller.DefaultBackupStorageClassName
-			}
+		if backupSpec.StorageClassName == nil || *backupSpec.StorageClassName == "" {
+			backupSpec.StorageClassName = bs.Spec.StorageClassName
 		}
 
 		if backupSpec.StorageSize == "" {

pkg/backup/restore/restore_manager.go

@@ -222,18 +222,13 @@ func (rm *restoreManager) ensureRestorePVCExist(restore *v1alpha1.Restore) (stri
 	if err != nil {
 		// get the object from the local cache, the error can only be IsNotFound,
 		// so we need to create PVC for restore job
-		storageClassName := controller.DefaultBackupStorageClassName
-		if restore.Spec.StorageClassName != "" {
-			storageClassName = restore.Spec.StorageClassName
-		}
 		pvc := &corev1.PersistentVolumeClaim{
 			ObjectMeta: metav1.ObjectMeta{
 				Name:      restorePVCName,
 				Namespace: ns,
 				Labels:    label.NewRestore().Instance(restore.GetInstanceName()),
 			},
 			Spec: corev1.PersistentVolumeClaimSpec{
-				StorageClassName: &storageClassName,
 				AccessModes: []corev1.PersistentVolumeAccessMode{
 					corev1.ReadWriteOnce,
 				},
@@ -242,6 +237,7 @@ func (rm *restoreManager) ensureRestorePVCExist(restore *v1alpha1.Restore) (stri
 						corev1.ResourceStorage: rs,
 					},
 				},
+				StorageClassName: restore.Spec.StorageClassName,
 			},
 		}
 		if err := rm.pvcControl.CreatePVC(restore, pvc); err != nil {

pkg/backup/util/util.go

@@ -294,9 +294,6 @@ func ValidateBackup(backup *v1alpha1.Backup) error {
 		if backup.Spec.From.SecretName == "" {
 			return fmt.Errorf("missing tidbSecretName config in spec of %s/%s", ns, name)
 		}
-		if backup.Spec.StorageClassName == "" {
-			return fmt.Errorf("missing storageClassName config in spec of %s/%s", ns, name)
-		}
 		if backup.Spec.StorageSize == "" {
 			return fmt.Errorf("missing StorageSize config in spec of %s/%s", ns, name)
 		}