Add commit ts to restore status

cmd/backup-manager/app/backup/backup.go

@@ -23,9 +23,6 @@ import (
 	"path"
 	"strings"
 
-	"github.com/gogo/protobuf/proto"
-	kvbackup "github.com/pingcap/kvproto/pkg/backup"
-	"github.com/pingcap/tidb-operator/cmd/backup-manager/app/constants"
 	backupUtil "github.com/pingcap/tidb-operator/cmd/backup-manager/app/util"
 	"github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1"
 	"github.com/pingcap/tidb-operator/pkg/util"
@@ -108,35 +105,6 @@ func (bo *Options) backupData(backup *v1alpha1.Backup) error {
 	return nil
 }
 
-// getCommitTs get backup position from `EndVersion` in BR backup meta
-func getCommitTs(backup *v1alpha1.Backup) (uint64, error) {
-	var commitTs uint64
-	s, err := backupUtil.NewRemoteStorage(backup)
-	if err != nil {
-		return commitTs, err
-	}
-	defer s.Close()
-	ctx := context.Background()
-	exist, err := s.Exists(ctx, constants.MetaFile)
-	if err != nil {
-		return commitTs, err
-	}
-	if !exist {
-		return commitTs, fmt.Errorf("%s not exist", constants.MetaFile)
-
-	}
-	metaData, err := s.ReadAll(ctx, constants.MetaFile)
-	if err != nil {
-		return commitTs, err
-	}
-	backupMeta := &kvbackup.BackupMeta{}
-	err = proto.Unmarshal(metaData, backupMeta)
-	if err != nil {
-		return commitTs, err
-	}
-	return backupMeta.EndVersion, nil
-}
-
 // constructOptions constructs options for BR and also return the remote path
 func constructOptions(backup *v1alpha1.Backup) ([]string, error) {
 	args, err := backupUtil.ConstructBRGlobalOptionsForBackup(backup)
@@ -162,7 +130,7 @@ func constructOptions(backup *v1alpha1.Backup) ([]string, error) {
 // getBackupSize get the backup data size from remote
 func getBackupSize(backup *v1alpha1.Backup) (int64, error) {
 	var size int64
-	s, err := backupUtil.NewRemoteStorage(backup)
+	s, err := backupUtil.NewRemoteStorage(backup.Spec.StorageProvider, true)
 	if err != nil {
 		return size, err
 	}

cmd/backup-manager/app/backup/manager.go

@@ -296,7 +296,7 @@ func (bm *Manager) performBackup(backup *v1alpha1.Backup, db *sql.DB) error {
 	}
 	klog.Infof("Get size %d for backup files in %s of cluster %s success", size, backupFullPath, bm)
 
-	commitTs, err := getCommitTs(backup)
+	commitTs, err := util.GetCommitTsFromBRMetaData(backup.Spec.StorageProvider, true)
 	if err != nil {
 		errs = append(errs, err)
 		klog.Errorf("get cluster %s commitTs failed, err: %s", bm, err)

cmd/backup-manager/app/clean/clean.go

@@ -38,7 +38,7 @@ func (bo *Options) String() string {
 
 // cleanBRRemoteBackupData clean the backup data from remote
 func (bo *Options) cleanBRRemoteBackupData(backup *v1alpha1.Backup) error {
-	s, err := util.NewRemoteStorage(backup)
+	s, err := util.NewRemoteStorage(backup.Spec.StorageProvider, true)
 	if err != nil {
 		return err
 	}

cmd/backup-manager/app/export/export.go

@@ -15,7 +15,6 @@ package export
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os/exec"
 	"path/filepath"
 	"strconv"
@@ -100,45 +99,6 @@ func (bo *Options) backupDataToRemote(source, bucketURI string, opts []string) e
 	return nil
 }
 
-/*
-	getCommitTsFromMetadata get commitTs from mydumper's metadata file
-
-	metadata file format is as follows:
-
-		Started dump at: 2019-06-13 10:00:04
-		SHOW MASTER STATUS:
-			Log: tidb-binlog
-			Pos: 409054741514944513
-			GTID:
-
-		Finished dump at: 2019-06-13 10:00:04
-*/
-func getCommitTsFromMetadata(backupPath string) (string, error) {
-	var commitTs string
-
-	metaFile := filepath.Join(backupPath, constants.MetaDataFile)
-	if exist := util.IsFileExist(metaFile); !exist {
-		return commitTs, fmt.Errorf("file %s does not exist or is not regular file", metaFile)
-	}
-	contents, err := ioutil.ReadFile(metaFile)
-	if err != nil {
-		return commitTs, fmt.Errorf("read metadata file %s failed, err: %v", metaFile, err)
-	}
-
-	for _, lineStr := range strings.Split(string(contents), "\n") {
-		if !strings.Contains(lineStr, "Pos") {
-			continue
-		}
-		lineStrSlice := strings.Split(lineStr, ":")
-		if len(lineStrSlice) != 2 {
-			return commitTs, fmt.Errorf("parse mydumper's metadata file %s failed, str: %s", metaFile, lineStr)
-		}
-		commitTs = strings.TrimSpace(lineStrSlice[1])
-		break
-	}
-	return commitTs, nil
-}
-
 // getBackupSize get the backup data size
 func getBackupSize(backupPath string, opts []string) (int64, error) {
 	var size int64

cmd/backup-manager/app/export/manager.go

@@ -299,7 +299,7 @@ func (bm *BackupManager) performBackup(backup *v1alpha1.Backup, db *sql.DB) erro
 	}
 	klog.Infof("get cluster %s archived backup file %s size %d success", bm, archiveBackupPath, size)
 
-	commitTs, err := getCommitTsFromMetadata(backupFullPath)
+	commitTs, err := util.GetCommitTsFromMetadata(backupFullPath)
 	if err != nil {
 		errs = append(errs, err)
 		klog.Errorf("get cluster %s commitTs failed, err: %s", bm, err)

cmd/backup-manager/app/import/manager.go

@@ -167,6 +167,21 @@ func (rm *RestoreManager) performRestore(restore *v1alpha1.Restore) error {
 	}
 	klog.Infof("unarchive cluster %s backup %s data success", rm, restoreDataPath)
 
+	commitTs, err := util.GetCommitTsFromMetadata(unarchiveDataPath)
+	if err != nil {
+		errs = append(errs, err)
+		klog.Errorf("get cluster %s commitTs failed, err: %s", rm, err)
+		uerr := rm.StatusUpdater.Update(restore, &v1alpha1.RestoreCondition{
+			Type:    v1alpha1.RestoreFailed,
+			Status:  corev1.ConditionTrue,
+			Reason:  "GetCommitTsFailed",
+			Message: err.Error(),
+		})
+		errs = append(errs, uerr)
+		return errorutils.NewAggregate(errs)
+	}
+	klog.Infof("get cluster %s commitTs %s success", rm, commitTs)
+
 	err = rm.loadTidbClusterData(unarchiveDataPath)
 	if err != nil {
 		errs = append(errs, err)
@@ -186,6 +201,7 @@ func (rm *RestoreManager) performRestore(restore *v1alpha1.Restore) error {
 
 	restore.Status.TimeStarted = metav1.Time{Time: started}
 	restore.Status.TimeCompleted = metav1.Time{Time: finish}
+	restore.Status.CommitTs = commitTs
 
 	return rm.StatusUpdater.Update(restore, &v1alpha1.RestoreCondition{
 		Type:   v1alpha1.RestoreComplete,

cmd/backup-manager/app/restore/manager.go

@@ -247,9 +247,24 @@ func (rm *Manager) performRestore(restore *v1alpha1.Restore, db *sql.DB) error {
 	}
 	klog.Infof("restore cluster %s from %s succeed", rm, restore.Spec.Type)
 
+	commitTs, err := util.GetCommitTsFromBRMetaData(restore.Spec.StorageProvider, false)
+	if err != nil {
+		errs = append(errs, err)
+		klog.Errorf("get cluster %s commitTs failed, err: %s", rm, err)
+		uerr := rm.StatusUpdater.Update(restore, &v1alpha1.RestoreCondition{
+			Type:    v1alpha1.RestoreFailed,
+			Status:  corev1.ConditionTrue,
+			Reason:  "GetCommitTsFailed",
+			Message: err.Error(),
+		})
+		errs = append(errs, uerr)
+		return errorutils.NewAggregate(errs)
+	}
+
 	finish := time.Now()
 	restore.Status.TimeStarted = metav1.Time{Time: started}
 	restore.Status.TimeCompleted = metav1.Time{Time: finish}
+	restore.Status.CommitTs = fmt.Sprintf("%d", commitTs)
 
 	return rm.StatusUpdater.Update(restore, &v1alpha1.RestoreCondition{
 		Type:   v1alpha1.RestoreComplete,

cmd/backup-manager/app/util/remote.go

@@ -58,18 +58,18 @@ type gcsQuery struct {
 }
 
 // NewRemoteStorage creates new remote storage
-func NewRemoteStorage(backup *v1alpha1.Backup) (*blob.Bucket, error) {
-	st := util.GetStorageType(backup.Spec.StorageProvider)
+func NewRemoteStorage(provider v1alpha1.StorageProvider, fakeRegion bool) (*blob.Bucket, error) {
+	st := util.GetStorageType(provider)
 	switch st {
 	case v1alpha1.BackupStorageTypeS3:
-		qs := checkS3Config(backup.Spec.S3, true)
+		qs := checkS3Config(provider.S3, fakeRegion)
 		bucket, err := newS3Storage(qs)
 		if err != nil {
 			return nil, err
 		}
 		return bucket, nil
 	case v1alpha1.BackupStorageTypeGcs:
-		qs := checkGcsConfig(backup.Spec.Gcs, true)
+		qs := checkGcsConfig(provider.Gcs, fakeRegion)
 		bucket, err := newGcsStorage(qs)
 		if err != nil {
 			return nil, err

cmd/backup-manager/app/util/util.go

@@ -14,12 +14,17 @@
 package util
 
 import (
+	"context"
 	"database/sql"
 	"fmt"
+	"io/ioutil"
 	"os"
+	"path/filepath"
 	"strings"
 
 	"github.com/Masterminds/semver"
+	"github.com/gogo/protobuf/proto"
+	kvbackup "github.com/pingcap/kvproto/pkg/backup"
 	"github.com/pingcap/tidb-operator/cmd/backup-manager/app/constants"
 	"github.com/pingcap/tidb-operator/pkg/apis/pingcap/v1alpha1"
 	"github.com/pingcap/tidb-operator/pkg/backup/util"
@@ -268,6 +273,74 @@ func GetOptions(provider v1alpha1.StorageProvider) []string {
 	}
 }
 
+/*
+	GetCommitTsFromMetadata get commitTs from mydumper's metadata file
+
+	metadata file format is as follows:
+
+		Started dump at: 2019-06-13 10:00:04
+		SHOW MASTER STATUS:
+			Log: tidb-binlog
+			Pos: 409054741514944513
+			GTID:
+
+		Finished dump at: 2019-06-13 10:00:04
+*/
+func GetCommitTsFromMetadata(backupPath string) (string, error) {
+	var commitTs string
+
+	metaFile := filepath.Join(backupPath, constants.MetaDataFile)
+	if exist := IsFileExist(metaFile); !exist {
+		return commitTs, fmt.Errorf("file %s does not exist or is not regular file", metaFile)
+	}
+	contents, err := ioutil.ReadFile(metaFile)
+	if err != nil {
+		return commitTs, fmt.Errorf("read metadata file %s failed, err: %v", metaFile, err)
+	}
+
+	for _, lineStr := range strings.Split(string(contents), "\n") {
+		if !strings.Contains(lineStr, "Pos") {
+			continue
+		}
+		lineStrSlice := strings.Split(lineStr, ":")
+		if len(lineStrSlice) != 2 {
+			return commitTs, fmt.Errorf("parse mydumper's metadata file %s failed, str: %s", metaFile, lineStr)
+		}
+		commitTs = strings.TrimSpace(lineStrSlice[1])
+		break
+	}
+	return commitTs, nil
+}
+
+// GetCommitTsFromBRMetaData get backup position from `EndVersion` in BR backup meta
+func GetCommitTsFromBRMetaData(provider v1alpha1.StorageProvider, fakeRegion bool) (uint64, error) {
+	var commitTs uint64
+	s, err := NewRemoteStorage(provider, fakeRegion)
+	if err != nil {
+		return commitTs, err
+	}
+	defer s.Close()
+	ctx := context.Background()
+	exist, err := s.Exists(ctx, constants.MetaFile)
+	if err != nil {
+		return commitTs, err
+	}
+	if !exist {
+		return commitTs, fmt.Errorf("%s not exist", constants.MetaFile)
+
+	}
+	metaData, err := s.ReadAll(ctx, constants.MetaFile)
+	if err != nil {
+		return commitTs, err
+	}
+	backupMeta := &kvbackup.BackupMeta{}
+	err = proto.Unmarshal(metaData, backupMeta)
+	if err != nil {
+		return commitTs, err
+	}
+	return backupMeta.EndVersion, nil
+}
+
 // ConstructArgs constructs the rclone args
 func ConstructArgs(conf string, opts []string, command, source, dest string) []string {
 	var args []string

docs/api-references/docs.md

@@ -8163,6 +8163,17 @@ Kubernetes meta/v1.Time
 </tr>
 <tr>
 <td>
+<code>commitTs</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>CommitTs is the snapshot time point of tidb cluster.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>conditions</code></br>
 <em>
 <a href="#restorecondition">

pkg/apis/pingcap/v1alpha1/types.go

@@ -1386,8 +1386,10 @@ type RestoreStatus struct {
 	// TimeStarted is the time at which the restore was started.
 	TimeStarted metav1.Time `json:"timeStarted"`
 	// TimeCompleted is the time at which the restore was completed.
-	TimeCompleted metav1.Time        `json:"timeCompleted"`
-	Conditions    []RestoreCondition `json:"conditions"`
+	TimeCompleted metav1.Time `json:"timeCompleted"`
+	// CommitTs is the snapshot time point of tidb cluster.
+	CommitTs   string             `json:"commitTs"`
+	Conditions []RestoreCondition `json:"conditions"`
 }
 
 // +k8s:openapi-gen=true