X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/70c7c9f19692ea7275541006e720c3ea56ba32e1..10440ac12d6771ab80469adf551d2cac8d3461e6:/tools/keep-rsync/keep-rsync.go diff --git a/tools/keep-rsync/keep-rsync.go b/tools/keep-rsync/keep-rsync.go index e848de8b8d..7e519f775b 100644 --- a/tools/keep-rsync/keep-rsync.go +++ b/tools/keep-rsync/keep-rsync.go @@ -1,121 +1,149 @@ +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: AGPL-3.0 + package main import ( "bufio" + "crypto/tls" "errors" "flag" "fmt" - "git.curoverse.com/arvados.git/sdk/go/arvadosclient" - "git.curoverse.com/arvados.git/sdk/go/keepclient" "io/ioutil" "log" - "regexp" + "net/http" + "os" "strings" "time" -) -// keep-rsync arguments -var ( - blobSigningKey string + "git.arvados.org/arvados.git/lib/cmd" + "git.arvados.org/arvados.git/sdk/go/arvadosclient" + "git.arvados.org/arvados.git/sdk/go/keepclient" ) +var version = "dev" + func main() { - var srcConfigFile, dstConfigFile, srcKeepServicesJSON, dstKeepServicesJSON, prefix string - var replications int + err := doMain() + if err != nil { + log.Fatalf("%v", err) + } +} + +func doMain() error { + flags := flag.NewFlagSet("keep-rsync", flag.ExitOnError) - flag.StringVar( - &srcConfigFile, - "src-config-file", + srcConfigFile := flags.String( + "src", "", - "Source configuration filename with full path that contains "+ - "an ARVADOS_API_TOKEN which is a valid datamanager token recognized by the source keep servers, "+ - "ARVADOS_API_HOST, ARVADOS_API_HOST_INSECURE, ARVADOS_EXTERNAL_CLIENT and ARVADOS_BLOB_SIGNING_KEY.") + "Source configuration filename. May be either a pathname to a config file, or (for example) 'foo' as shorthand for $HOME/.config/arvados/foo.conf file. This file is expected to specify the values for ARVADOS_API_TOKEN, ARVADOS_API_HOST, ARVADOS_API_HOST_INSECURE, and ARVADOS_BLOB_SIGNING_KEY for the source.") - flag.StringVar( - &dstConfigFile, - "dst-config-file", + dstConfigFile := flags.String( + "dst", "", - "Destination configuration filename with full path that contains "+ - "an ARVADOS_API_TOKEN which is a valid datamanager token recognized by the destination keep servers, "+ - "ARVADOS_API_HOST, ARVADOS_API_HOST_INSECURE, ARVADOS_EXTERNAL_CLIENT and ARVADOS_BLOB_SIGNING_KEY.") + "Destination configuration filename. May be either a pathname to a config file, or (for example) 'foo' as shorthand for $HOME/.config/arvados/foo.conf file. This file is expected to specify the values for ARVADOS_API_TOKEN, ARVADOS_API_HOST, and ARVADOS_API_HOST_INSECURE for the destination.") - flag.StringVar( - &srcKeepServicesJSON, + srcKeepServicesJSON := flags.String( "src-keep-services-json", "", "An optional list of available source keepservices. "+ "If not provided, this list is obtained from api server configured in src-config-file.") - flag.StringVar( - &dstKeepServicesJSON, + dstKeepServicesJSON := flags.String( "dst-keep-services-json", "", "An optional list of available destination keepservices. "+ "If not provided, this list is obtained from api server configured in dst-config-file.") - flag.IntVar( - &replications, + replications := flags.Int( "replications", 0, - "Number of replications to write to the destination.") + "Number of replications to write to the destination. If replications not specified, "+ + "default replication level configured on destination server will be used.") - flag.StringVar( - &prefix, + prefix := flags.String( "prefix", "", "Index prefix") - flag.Parse() + srcBlobSignatureTTLFlag := flags.Duration( + "src-blob-signature-ttl", + 0, + "Lifetime of blob permission signatures on source keepservers. If not provided, this will be retrieved from the API server's discovery document.") + + getVersion := flags.Bool( + "version", + false, + "Print version information and exit.") + + if ok, code := cmd.ParseFlags(flags, os.Args[0], os.Args[1:], "", os.Stderr); !ok { + os.Exit(code) + } else if *getVersion { + fmt.Printf("%s %s\n", os.Args[0], version) + os.Exit(0) + } - srcConfig, dstConfig, err := loadConfig(srcConfigFile, dstConfigFile) + srcConfig, srcBlobSigningKey, err := loadConfig(*srcConfigFile) if err != nil { - log.Fatalf("Error loading configuration from files: %s", err.Error()) + return fmt.Errorf("Error loading src configuration from file: %s", err.Error()) } - // setup src and dst keepclients - kcSrc, kcDst, err := setupKeepClients(srcConfig, dstConfig, srcKeepServicesJSON, dstKeepServicesJSON, replications) + dstConfig, _, err := loadConfig(*dstConfigFile) if err != nil { - log.Fatalf("Error configuring keep-rsync: %s", err.Error()) + return fmt.Errorf("Error loading dst configuration from file: %s", err.Error()) } - // Copy blocks not found in dst from src - err = performKeepRsync(kcSrc, kcDst, prefix) + // setup src and dst keepclients + kcSrc, srcBlobSignatureTTL, err := setupKeepClient(srcConfig, *srcKeepServicesJSON, false, 0, *srcBlobSignatureTTLFlag) if err != nil { - log.Fatalf("Error while syncing data: %s", err.Error()) + return fmt.Errorf("Error configuring src keepclient: %s", err.Error()) } -} -// Load src and dst config from given files -func loadConfig(srcConfigFile, dstConfigFile string) (srcConfig, dstConfig arvadosclient.APIConfig, err error) { - if srcConfigFile == "" { - return srcConfig, dstConfig, errors.New("-src-config-file must be specified") + kcDst, _, err := setupKeepClient(dstConfig, *dstKeepServicesJSON, true, *replications, 0) + if err != nil { + return fmt.Errorf("Error configuring dst keepclient: %s", err.Error()) } - srcConfig, err = readConfigFromFile(srcConfigFile) + // Copy blocks not found in dst from src + err = performKeepRsync(kcSrc, kcDst, srcBlobSignatureTTL, srcBlobSigningKey, *prefix) if err != nil { - return srcConfig, dstConfig, fmt.Errorf("Error reading source configuration: %v", err) + return fmt.Errorf("Error while syncing data: %s", err.Error()) } - if dstConfigFile == "" { - return srcConfig, dstConfig, errors.New("-dst-config-file must be specified") + return nil +} + +type apiConfig struct { + APIToken string + APIHost string + APIHostInsecure bool +} + +// Load src and dst config from given files +func loadConfig(configFile string) (config apiConfig, blobSigningKey string, err error) { + if configFile == "" { + return config, blobSigningKey, errors.New("config file not specified") } - dstConfig, err = readConfigFromFile(dstConfigFile) + + config, blobSigningKey, err = readConfigFromFile(configFile) if err != nil { - return srcConfig, dstConfig, fmt.Errorf("Error reading destination configuration: %v", err) + return config, blobSigningKey, fmt.Errorf("Error reading config file: %v", err) } - return srcConfig, dstConfig, err + return } -var matchTrue = regexp.MustCompile("^(?i:1|yes|true)$") - // Read config from file -func readConfigFromFile(filename string) (arvadosclient.APIConfig, error) { - var config arvadosclient.APIConfig +func readConfigFromFile(filename string) (config apiConfig, blobSigningKey string, err error) { + if !strings.Contains(filename, "/") { + filename = os.Getenv("HOME") + "/.config/arvados/" + filename + ".conf" + } content, err := ioutil.ReadFile(filename) + if err != nil { - return config, err + return config, "", err } lines := strings.Split(string(content), "\n") @@ -134,73 +162,69 @@ func readConfigFromFile(filename string) (arvadosclient.APIConfig, error) { case "ARVADOS_API_HOST": config.APIHost = value case "ARVADOS_API_HOST_INSECURE": - config.APIHostInsecure = matchTrue.MatchString(value) - case "ARVADOS_EXTERNAL_CLIENT": - config.ExternalClient = matchTrue.MatchString(value) + config.APIHostInsecure = arvadosclient.StringBool(value) case "ARVADOS_BLOB_SIGNING_KEY": blobSigningKey = value } } - return config, nil + return } -// Initializes keep-rsync using the config provided -func setupKeepClients(srcConfig, dstConfig arvadosclient.APIConfig, srcKeepServicesJSON, dstKeepServicesJSON string, replications int) (kcSrc, kcDst *keepclient.KeepClient, err error) { - // arvSrc from srcConfig - arvSrc, err := arvadosclient.New(srcConfig) - if err != nil { - return kcSrc, kcDst, err - } - - // arvDst from dstConfig - arvDst, err := arvadosclient.New(dstConfig) - if err != nil { - return kcSrc, kcDst, err - } - - // Get default replications value from destination, if it is not already provided - if replications == 0 { - value, err := arvDst.Discovery("defaultCollectionReplication") - if err == nil { - replications = int(value.(float64)) - } else { - replications = 2 - } +// setup keepclient using the config provided +func setupKeepClient(config apiConfig, keepServicesJSON string, isDst bool, replications int, srcBlobSignatureTTL time.Duration) (kc *keepclient.KeepClient, blobSignatureTTL time.Duration, err error) { + arv := arvadosclient.ArvadosClient{ + ApiToken: config.APIToken, + ApiServer: config.APIHost, + ApiInsecure: config.APIHostInsecure, + Client: &http.Client{Transport: &http.Transport{ + TLSClientConfig: &tls.Config{InsecureSkipVerify: config.APIHostInsecure}}}, } - // if srcKeepServicesJSON is provided, use it to load services; else, use DiscoverKeepServers - if srcKeepServicesJSON == "" { - kcSrc, err = keepclient.MakeKeepClient(&arvSrc) + // If keepServicesJSON is provided, use it instead of service discovery + if keepServicesJSON == "" { + kc, err = keepclient.MakeKeepClient(&arv) if err != nil { - return nil, nil, err + return nil, 0, err } } else { - kcSrc, err = keepclient.MakeKeepClientFromJSON(&arvSrc, srcKeepServicesJSON) + kc = keepclient.New(&arv) + err = kc.LoadKeepServicesFromJSON(keepServicesJSON) if err != nil { - return kcSrc, kcDst, err + return kc, 0, err } } - // if dstKeepServicesJSON is provided, use it to load services; else, use DiscoverKeepServers - if dstKeepServicesJSON == "" { - kcDst, err = keepclient.MakeKeepClient(&arvDst) - if err != nil { - return kcSrc, kcDst, err + if isDst { + // Get default replications value from destination, if it is not already provided + if replications == 0 { + value, err := arv.Discovery("defaultCollectionReplication") + if err == nil { + replications = int(value.(float64)) + } else { + return nil, 0, err + } } - } else { - kcDst, err = keepclient.MakeKeepClientFromJSON(&arvDst, dstKeepServicesJSON) - if err != nil { - return kcSrc, kcDst, err + + kc.Want_replicas = replications + } + + // If srcBlobSignatureTTL is not provided, get it from API server discovery doc + blobSignatureTTL = srcBlobSignatureTTL + if !isDst && srcBlobSignatureTTL == 0 { + value, err := arv.Discovery("blobSignatureTtl") + if err == nil { + blobSignatureTTL = time.Duration(int(value.(float64))) * time.Second + } else { + return nil, 0, err } } - kcDst.Want_replicas = replications - return kcSrc, kcDst, nil + return kc, blobSignatureTTL, nil } // Get unique block locators from src and dst // Copy any blocks missing in dst -func performKeepRsync(kcSrc, kcDst *keepclient.KeepClient, prefix string) error { +func performKeepRsync(kcSrc, kcDst *keepclient.KeepClient, srcBlobSignatureTTL time.Duration, blobSigningKey, prefix string) error { // Get unique locators from src srcIndex, err := getUniqueLocators(kcSrc, prefix) if err != nil { @@ -217,7 +241,10 @@ func performKeepRsync(kcSrc, kcDst *keepclient.KeepClient, prefix string) error toBeCopied := getMissingLocators(srcIndex, dstIndex) // Copy each missing block to dst - err = copyBlocksToDst(toBeCopied, kcSrc, kcDst) + log.Printf("Before keep-rsync, there are %d blocks in src and %d blocks in dst. Start copying %d blocks from src not found in dst.", + len(srcIndex), len(dstIndex), len(toBeCopied)) + + err = copyBlocksToDst(toBeCopied, kcSrc, kcDst, srcBlobSignatureTTL, blobSigningKey) return err } @@ -253,36 +280,35 @@ func getMissingLocators(srcLocators, dstLocators map[string]bool) []string { } // Copy blocks from src to dst; only those that are missing in dst are copied -func copyBlocksToDst(toBeCopied []string, kcSrc, kcDst *keepclient.KeepClient) error { - done := 0 +func copyBlocksToDst(toBeCopied []string, kcSrc, kcDst *keepclient.KeepClient, srcBlobSignatureTTL time.Duration, blobSigningKey string) error { total := len(toBeCopied) - for _, locator := range toBeCopied { - log.Printf("Getting block %d of %d: %v", done+1, total, locator) + startedAt := time.Now() + for done, locator := range toBeCopied { + if done == 0 { + log.Printf("Copying data block %d of %d (%.2f%% done): %v", done+1, total, + float64(done)/float64(total)*100, locator) + } else { + timePerBlock := time.Since(startedAt) / time.Duration(done) + log.Printf("Copying data block %d of %d (%.2f%% done, %v est. time remaining): %v", done+1, total, + float64(done)/float64(total)*100, timePerBlock*time.Duration(total-done), locator) + } getLocator := locator expiresAt := time.Now().AddDate(0, 0, 1) if blobSigningKey != "" { - getLocator = keepclient.SignLocator(getLocator, kcSrc.Arvados.ApiToken, expiresAt, []byte(blobSigningKey)) + getLocator = keepclient.SignLocator(getLocator, kcSrc.Arvados.ApiToken, expiresAt, srcBlobSignatureTTL, []byte(blobSigningKey)) } - reader, _, _, err := kcSrc.Get(getLocator) + reader, len, _, err := kcSrc.Get(getLocator) if err != nil { return fmt.Errorf("Error getting block: %v %v", locator, err) } - data, err := ioutil.ReadAll(reader) - if err != nil { - return fmt.Errorf("Error reading block data: %v %v", locator, err) - } - log.Printf("Writing block%d of %d: %v", locator) - _, _, err = kcDst.PutB(data) + _, _, err = kcDst.PutHR(getLocator[:32], reader, len) if err != nil { - return fmt.Errorf("Error putting block data: %v %v", locator, err) + return fmt.Errorf("Error copying data block: %v %v", locator, err) } - - done++ - log.Printf("%.2f%% done", float64(done)/float64(total)*100) } log.Printf("Successfully copied to destination %d blocks.", total)