Allow for specifying a specific MySQL shutdown timeout (vitessio#17923)

Signed-off-by: Dirkjan Bussink <[email protected]>

Author: dbussink

go/cmd/vtctldclient/command/backups.go

@@ -79,11 +79,12 @@ If no replica-type tablet can be found, the backup can be taken on the primary i
 )
 
 var backupOptions = struct {
-	AllowPrimary       bool
-	BackupEngine       string
-	Concurrency        int32
-	IncrementalFromPos string
-	UpgradeSafe        bool
+	AllowPrimary         bool
+	BackupEngine         string
+	Concurrency          int32
+	IncrementalFromPos   string
+	UpgradeSafe          bool
+	MysqlShutdownTimeout time.Duration
 }{}
 
 func commandBackup(cmd *cobra.Command, args []string) error {
@@ -95,11 +96,12 @@ func commandBackup(cmd *cobra.Command, args []string) error {
 	cli.FinishedParsing(cmd)
 
 	req := &vtctldatapb.BackupRequest{
-		TabletAlias:        tabletAlias,
-		AllowPrimary:       backupOptions.AllowPrimary,
-		Concurrency:        backupOptions.Concurrency,
-		IncrementalFromPos: backupOptions.IncrementalFromPos,
-		UpgradeSafe:        backupOptions.UpgradeSafe,
+		TabletAlias:          tabletAlias,
+		AllowPrimary:         backupOptions.AllowPrimary,
+		Concurrency:          backupOptions.Concurrency,
+		IncrementalFromPos:   backupOptions.IncrementalFromPos,
+		UpgradeSafe:          backupOptions.UpgradeSafe,
+		MysqlShutdownTimeout: protoutil.DurationToProto(backupOptions.MysqlShutdownTimeout),
 	}
 
 	if backupOptions.BackupEngine != "" {
@@ -125,10 +127,11 @@ func commandBackup(cmd *cobra.Command, args []string) error {
 }
 
 var backupShardOptions = struct {
-	AllowPrimary       bool
-	Concurrency        int32
-	IncrementalFromPos string
-	UpgradeSafe        bool
+	AllowPrimary         bool
+	Concurrency          int32
+	IncrementalFromPos   string
+	UpgradeSafe          bool
+	MysqlShutdownTimeout time.Duration
 }{}
 
 func commandBackupShard(cmd *cobra.Command, args []string) error {
@@ -140,12 +143,13 @@ func commandBackupShard(cmd *cobra.Command, args []string) error {
 	cli.FinishedParsing(cmd)
 
 	stream, err := client.BackupShard(commandCtx, &vtctldatapb.BackupShardRequest{
-		Keyspace:           keyspace,
-		Shard:              shard,
-		AllowPrimary:       backupShardOptions.AllowPrimary,
-		Concurrency:        backupShardOptions.Concurrency,
-		IncrementalFromPos: backupShardOptions.IncrementalFromPos,
-		UpgradeSafe:        backupShardOptions.UpgradeSafe,
+		Keyspace:             keyspace,
+		Shard:                shard,
+		AllowPrimary:         backupShardOptions.AllowPrimary,
+		Concurrency:          backupShardOptions.Concurrency,
+		IncrementalFromPos:   backupShardOptions.IncrementalFromPos,
+		UpgradeSafe:          backupShardOptions.UpgradeSafe,
+		MysqlShutdownTimeout: protoutil.DurationToProto(backupShardOptions.MysqlShutdownTimeout),
 	})
 	if err != nil {
 		return err
@@ -294,12 +298,14 @@ func init() {
 	Backup.Flags().StringVar(&backupOptions.BackupEngine, "backup-engine", "", "Request a specific backup engine for this backup request. Defaults to the preferred backup engine of the target vttablet")
 
 	Backup.Flags().BoolVar(&backupOptions.UpgradeSafe, "upgrade-safe", false, "Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades.")
+	Backup.Flags().DurationVar(&backupOptions.MysqlShutdownTimeout, "mysql-shutdown-timeout", mysqlctl.DefaultShutdownTimeout, "Timeout to use when MySQL is being shut down.")
 	Root.AddCommand(Backup)
 
 	BackupShard.Flags().BoolVar(&backupShardOptions.AllowPrimary, "allow-primary", false, "Allow the primary of a shard to be used for the backup. WARNING: If using the builtin backup engine, this will shutdown mysqld on the primary and stop writes for the duration of the backup.")
 	BackupShard.Flags().Int32Var(&backupShardOptions.Concurrency, "concurrency", 4, "Specifies the number of compression/checksum jobs to run simultaneously.")
 	BackupShard.Flags().StringVar(&backupShardOptions.IncrementalFromPos, "incremental-from-pos", "", "Position, or name of backup from which to create an incremental backup. Default: empty. If given, then this backup becomes an incremental backup from given position or given backup. If value is 'auto', this backup will be taken from the last successful backup position.")
-	BackupShard.Flags().BoolVar(&backupOptions.UpgradeSafe, "upgrade-safe", false, "Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades.")
+	BackupShard.Flags().BoolVar(&backupShardOptions.UpgradeSafe, "upgrade-safe", false, "Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades.")
+	BackupShard.Flags().DurationVar(&backupShardOptions.MysqlShutdownTimeout, "mysql-shutdown-timeout", mysqlctl.DefaultShutdownTimeout, "Timeout to use when MySQL is being shut down.")
 	Root.AddCommand(BackupShard)
 
 	GetBackups.Flags().Uint32VarP(&getBackupsOptions.Limit, "limit", "l", 0, "Retrieve only the most recent N backups.")

go/flags/endtoend/vtcombo.txt

@@ -226,7 +226,7 @@ Flags:
       --mysql-shell-load-flags string                                    flags to pass to mysql shell load utility. This should be a JSON string (default "{\"threads\": 4, \"loadUsers\": true, \"updateGtidSet\": \"replace\", \"skipBinlog\": true, \"progressFile\": \"\"}")
       --mysql-shell-should-drain                                         decide if we should drain while taking a backup or continue to serving traffic
       --mysql-shell-speedup-restore                                      speed up restore by disabling redo logging and double write buffer during the restore process
-      --mysql-shutdown-timeout duration                                  timeout to use when MySQL is being shut down. (default 5m0s)
+      --mysql-shutdown-timeout duration                                  Timeout to use when MySQL is being shut down. (default 5m0s)
       --mysql_allow_clear_text_without_tls                               If set, the server will allow the use of a clear text password over non-SSL connections.
       --mysql_auth_server_impl string                                    Which auth server implementation to use. Options: none, ldap, clientcert, static, vault. (default "static")
       --mysql_default_workload string                                    Default session workload (OLTP, OLAP, DBA) (default "OLTP")

go/flags/endtoend/vttablet.txt

@@ -246,7 +246,7 @@ Flags:
       --mysql-shell-load-flags string                                    flags to pass to mysql shell load utility. This should be a JSON string (default "{\"threads\": 4, \"loadUsers\": true, \"updateGtidSet\": \"replace\", \"skipBinlog\": true, \"progressFile\": \"\"}")
       --mysql-shell-should-drain                                         decide if we should drain while taking a backup or continue to serving traffic
       --mysql-shell-speedup-restore                                      speed up restore by disabling redo logging and double write buffer during the restore process
-      --mysql-shutdown-timeout duration                                  timeout to use when MySQL is being shut down. (default 5m0s)
+      --mysql-shutdown-timeout duration                                  Timeout to use when MySQL is being shut down. (default 5m0s)
       --mysql_server_version string                                      MySQL server version to advertise. (default "8.0.40-Vitess")
       --mysqlctl_mycnf_template string                                   template file to use for generating the my.cnf file during server init
       --mysqlctl_socket string                                           socket file to use for remote mysqlctl actions (empty for local actions)