more restricted subCommand check

pingcap · Sep 25, 2024 · a31daf1 · a31daf1
1 parent 90cf8f2
commit a31daf1
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 7 deletions.
diff --git a/cmd/backup-manager/app/backup/manager.go b/cmd/backup-manager/app/backup/manager.go
@@ -616,7 +616,7 @@ func (bm *Manager) stopLogBackup(ctx context.Context, backup *v1alpha1.Backup) (
 	return updateStatus, "", nil
 }
 
-// pauseLogBackup stops log backup.
+// pauseLogBackup pauses log backup.
 func (bm *Manager) pauseLogBackup(ctx context.Context, backup *v1alpha1.Backup) (*controller.BackupUpdateStatus, string, error) {
 	started := time.Now()
 

diff --git a/docs/api-references/docs.md b/docs/api-references/docs.md
@@ -247,7 +247,9 @@ Default is current timestamp.</p>
 <td>
 <code>logSubcommand</code></br>
 <em>
-string
+<a href="#logsubcommandtype">
+LogSubCommandType
+</a>
 </em>
 </td>
 <td>
@@ -4248,7 +4250,9 @@ Default is current timestamp.</p>
 <td>
 <code>logSubcommand</code></br>
 <em>
-string
+<a href="#logsubcommandtype">
+LogSubCommandType
+</a>
 </em>
 </td>
 <td>
@@ -8914,6 +8918,7 @@ BackupConditionType
 <p>
 (<em>Appears on:</em>
 <a href="#backupcondition">BackupCondition</a>, 
+<a href="#backupspec">BackupSpec</a>, 
 <a href="#logsubcommandstatus">LogSubCommandStatus</a>)
 </p>
 <p>

diff --git a/manifests/crd.yaml b/manifests/crd.yaml
@@ -2114,6 +2114,11 @@ spec:
                   logStop:
                     type: boolean
                   logSubcommand:
+                    enum:
+                    - ""
+                    - log-start
+                    - log-stop
+                    - log-pause
                     type: string
                   logTruncateUntil:
                     type: string
@@ -4356,6 +4361,11 @@ spec:
                   logStop:
                     type: boolean
                   logSubcommand:
+                    enum:
+                    - ""
+                    - log-start
+                    - log-stop
+                    - log-pause
                     type: string
                   logTruncateUntil:
                     type: string
@@ -6708,6 +6718,11 @@ spec:
               logStop:
                 type: boolean
               logSubcommand:
+                enum:
+                - ""
+                - log-start
+                - log-stop
+                - log-pause
                 type: string
               logTruncateUntil:
                 type: string

diff --git a/manifests/crd/v1/pingcap.com_backups.yaml b/manifests/crd/v1/pingcap.com_backups.yaml
@@ -2139,6 +2139,11 @@ spec:
               logStop:
                 type: boolean
               logSubcommand:
+                enum:
+                - ""
+                - log-start
+                - log-stop
+                - log-pause
                 type: string
               logTruncateUntil:
                 type: string

diff --git a/manifests/crd/v1/pingcap.com_backupschedules.yaml b/manifests/crd/v1/pingcap.com_backupschedules.yaml
@@ -2114,6 +2114,11 @@ spec:
                   logStop:
                     type: boolean
                   logSubcommand:
+                    enum:
+                    - ""
+                    - log-start
+                    - log-stop
+                    - log-pause
                     type: string
                   logTruncateUntil:
                     type: string
@@ -4356,6 +4361,11 @@ spec:
                   logStop:
                     type: boolean
                   logSubcommand:
+                    enum:
+                    - ""
+                    - log-start
+                    - log-stop
+                    - log-pause
                     type: string
                   logTruncateUntil:
                     type: string

diff --git a/pkg/apis/pingcap/v1alpha1/backup.go b/pkg/apis/pingcap/v1alpha1/backup.go
@@ -330,15 +330,15 @@ func ParseLogBackupSubcommand(backup *Backup) LogSubCommandType {
 	switch backup.Spec.LogSubcommand {
 	case "":
 		fallthrough
-	case "log-start":
+	case LogStartCommand:
 		if IsLogBackupAlreadyPaused(backup) {
 			subCommand = LogResumeCommand
 		} else {
 			subCommand = LogStartCommand
 		}
-	case "log-stop":
+	case LogStopCommand:
 		subCommand = LogStopCommand
-	case "log-pause":
+	case LogPauseCommand:
 		subCommand = LogPauseCommand
 	default:
 		return LogUnknownCommand

diff --git a/pkg/apis/pingcap/v1alpha1/types.go b/pkg/apis/pingcap/v1alpha1/types.go
@@ -2181,7 +2181,8 @@ type BackupSpec struct {
 	CommitTs string `json:"commitTs,omitempty"`
 	// Subcommand is the subcommand for BR, such as start, stop, pause etc.
 	// +optional
-	LogSubcommand string `json:"logSubcommand,omitempty"`
+	// +kubebuilder:validation:Enum:="";"log-start";"log-stop";"log-pause"
+	LogSubcommand LogSubCommandType `json:"logSubcommand,omitempty"`
 	// LogTruncateUntil is log backup truncate until timestamp.
 	// Format supports TSO or datetime, e.g. '400036290571534337', '2018-05-11 01:42:23'.
 	// +optional