services/keepstore/command.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package keepstore
   6
   7 import (
   8         "context"
   9         "errors"
  10         "flag"
  11         "fmt"
  12         "io"
  13         "math/rand"
  14         "net/http"
  15         "os"
  16         "sync"
  17
  18         "git.arvados.org/arvados.git/lib/config"
  19         "git.arvados.org/arvados.git/lib/service"
  20         "git.arvados.org/arvados.git/sdk/go/arvados"
  21         "git.arvados.org/arvados.git/sdk/go/arvadosclient"
  22         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  23         "git.arvados.org/arvados.git/sdk/go/keepclient"
  24         "github.com/prometheus/client_golang/prometheus"
  25         "github.com/sirupsen/logrus"
  26 )
  27
  28 var (
  29         version = "dev"
  30         Command = service.Command(arvados.ServiceNameKeepstore, newHandlerOrErrorHandler)
  31 )
  32
  33 func runCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  34         args, ok := convertKeepstoreFlagsToServiceFlags(args, ctxlog.FromContext(context.Background()))
  35         if !ok {
  36                 return 2
  37         }
  38         return Command.RunCommand(prog, args, stdin, stdout, stderr)
  39 }
  40
  41 // Parse keepstore command line flags, and return equivalent
  42 // service.Command flags. The second return value ("ok") is true if
  43 // all provided flags were successfully converted.
  44 func convertKeepstoreFlagsToServiceFlags(args []string, lgr logrus.FieldLogger) ([]string, bool) {
  45         flags := flag.NewFlagSet("", flag.ContinueOnError)
  46         flags.String("listen", "", "Services.Keepstore.InternalURLs")
  47         flags.Int("max-buffers", 0, "API.MaxKeepBlobBuffers")
  48         flags.Int("max-requests", 0, "API.MaxConcurrentRequests")
  49         flags.Bool("never-delete", false, "Collections.BlobTrash")
  50         flags.Bool("enforce-permissions", false, "Collections.BlobSigning")
  51         flags.String("permission-key-file", "", "Collections.BlobSigningKey")
  52         flags.String("blob-signing-key-file", "", "Collections.BlobSigningKey")
  53         flags.String("data-manager-token-file", "", "SystemRootToken")
  54         flags.Int("permission-ttl", 0, "Collections.BlobSigningTTL")
  55         flags.Int("blob-signature-ttl", 0, "Collections.BlobSigningTTL")
  56         flags.String("trash-lifetime", "", "Collections.BlobTrashLifetime")
  57         flags.Bool("serialize", false, "Volumes.*.DriverParameters.Serialize")
  58         flags.Bool("readonly", false, "Volumes.*.ReadOnly")
  59         flags.String("pid", "", "-")
  60         flags.String("trash-check-interval", "", "Collections.BlobTrashCheckInterval")
  61
  62         flags.String("azure-storage-container-volume", "", "Volumes.*.Driver")
  63         flags.String("azure-storage-account-name", "", "Volumes.*.DriverParameters.StorageAccountName")
  64         flags.String("azure-storage-account-key-file", "", "Volumes.*.DriverParameters.StorageAccountKey")
  65         flags.String("azure-storage-replication", "", "Volumes.*.Replication")
  66         flags.String("azure-max-get-bytes", "", "Volumes.*.DriverParameters.MaxDataReadSize")
  67
  68         flags.String("s3-bucket-volume", "", "Volumes.*.DriverParameters.Bucket")
  69         flags.String("s3-region", "", "Volumes.*.DriverParameters.Region")
  70         flags.String("s3-endpoint", "", "Volumes.*.DriverParameters.Endpoint")
  71         flags.String("s3-access-key-file", "", "Volumes.*.DriverParameters.AccessKeyID")
  72         flags.String("s3-secret-key-file", "", "Volumes.*.DriverParameters.SecretAccessKey")
  73         flags.String("s3-race-window", "", "Volumes.*.DriverParameters.RaceWindow")
  74         flags.String("s3-replication", "", "Volumes.*.Replication")
  75         flags.String("s3-unsafe-delete", "", "Volumes.*.DriverParameters.UnsafeDelete")
  76
  77         flags.String("volume", "", "Volumes")
  78
  79         flags.Bool("version", false, "")
  80         flags.String("config", "", "")
  81         flags.String("legacy-keepstore-config", "", "")
  82
  83         err := flags.Parse(args)
  84         if err == flag.ErrHelp {
  85                 return []string{"-help"}, true
  86         } else if err != nil {
  87                 return nil, false
  88         }
  89
  90         args = nil
  91         ok := true
  92         flags.Visit(func(f *flag.Flag) {
  93                 if f.Name == "config" || f.Name == "legacy-keepstore-config" || f.Name == "version" {
  94                         args = append(args, "-"+f.Name, f.Value.String())
  95                 } else if f.Usage == "-" {
  96                         ok = false
  97                         lgr.Errorf("command line flag -%s is no longer supported", f.Name)
  98                 } else {
  99                         ok = false
 100                         lgr.Errorf("command line flag -%s is no longer supported -- use Clusters.*.%s in cluster config file instead", f.Name, f.Usage)
 101                 }
 102         })
 103         if !ok {
 104                 return nil, false
 105         }
 106
 107         flags = flag.NewFlagSet("", flag.ExitOnError)
 108         loader := config.NewLoader(nil, lgr)
 109         loader.SetupFlags(flags)
 110         return loader.MungeLegacyConfigArgs(lgr, args, "-legacy-keepstore-config"), true
 111 }
 112
 113 type handler struct {
 114         http.Handler
 115         Cluster *arvados.Cluster
 116         Logger  logrus.FieldLogger
 117
 118         pullq      *WorkQueue
 119         trashq     *WorkQueue
 120         volmgr     *RRVolumeManager
 121         keepClient *keepclient.KeepClient
 122
 123         err       error
 124         setupOnce sync.Once
 125 }
 126
 127 func (h *handler) CheckHealth() error {
 128         return h.err
 129 }
 130
 131 func (h *handler) Done() <-chan struct{} {
 132         return nil
 133 }
 134
 135 func newHandlerOrErrorHandler(ctx context.Context, cluster *arvados.Cluster, token string, reg *prometheus.Registry) service.Handler {
 136         var h handler
 137         serviceURL, ok := service.URLFromContext(ctx)
 138         if !ok {
 139                 return service.ErrorHandler(ctx, cluster, errors.New("BUG: no URL from service.URLFromContext"))
 140         }
 141         err := h.setup(ctx, cluster, token, reg, serviceURL)
 142         if err != nil {
 143                 return service.ErrorHandler(ctx, cluster, err)
 144         }
 145         return &h
 146 }
 147
 148 func (h *handler) setup(ctx context.Context, cluster *arvados.Cluster, token string, reg *prometheus.Registry, serviceURL arvados.URL) error {
 149         h.Cluster = cluster
 150         h.Logger = ctxlog.FromContext(ctx)
 151         if h.Cluster.API.MaxKeepBlobBuffers <= 0 {
 152                 return fmt.Errorf("API.MaxKeepBlobBuffers must be greater than zero")
 153         }
 154         bufs = newBufferPool(h.Logger, h.Cluster.API.MaxKeepBlobBuffers, BlockSize)
 155
 156         if h.Cluster.API.MaxConcurrentRequests > 0 && h.Cluster.API.MaxConcurrentRequests < h.Cluster.API.MaxKeepBlobBuffers {
 157                 h.Logger.Warnf("Possible configuration mistake: not useful to set API.MaxKeepBlobBuffers (%d) higher than API.MaxConcurrentRequests (%d)", h.Cluster.API.MaxKeepBlobBuffers, h.Cluster.API.MaxConcurrentRequests)
 158         }
 159
 160         if h.Cluster.Collections.BlobSigningKey != "" {
 161         } else if h.Cluster.Collections.BlobSigning {
 162                 return errors.New("cannot enable Collections.BlobSigning with no Collections.BlobSigningKey")
 163         } else {
 164                 h.Logger.Warn("Running without a blob signing key. Block locators returned by this server will not be signed, and will be rejected by a server that enforces permissions. To fix this, configure Collections.BlobSigning and Collections.BlobSigningKey.")
 165         }
 166
 167         if len(h.Cluster.Volumes) == 0 {
 168                 return errors.New("no volumes configured")
 169         }
 170
 171         h.Logger.Printf("keepstore %s starting, pid %d", version, os.Getpid())
 172
 173         // Start a round-robin VolumeManager with the configured volumes.
 174         vm, err := makeRRVolumeManager(h.Logger, h.Cluster, serviceURL, newVolumeMetricsVecs(reg))
 175         if err != nil {
 176                 return err
 177         }
 178         if len(vm.readables) == 0 {
 179                 return fmt.Errorf("no volumes configured for %s", serviceURL)
 180         }
 181         h.volmgr = vm
 182
 183         // Initialize the pullq and workers
 184         h.pullq = NewWorkQueue()
 185         for i := 0; i < 1 || i < h.Cluster.Collections.BlobReplicateConcurrency; i++ {
 186                 go h.runPullWorker(h.pullq)
 187         }
 188
 189         // Initialize the trashq and workers
 190         h.trashq = NewWorkQueue()
 191         for i := 0; i < 1 || i < h.Cluster.Collections.BlobTrashConcurrency; i++ {
 192                 go RunTrashWorker(h.volmgr, h.Logger, h.Cluster, h.trashq)
 193         }
 194
 195         // Set up routes and metrics
 196         h.Handler = MakeRESTRouter(ctx, cluster, reg, vm, h.pullq, h.trashq)
 197
 198         // Initialize keepclient for pull workers
 199         c, err := arvados.NewClientFromConfig(cluster)
 200         if err != nil {
 201                 return err
 202         }
 203         ac, err := arvadosclient.New(c)
 204         if err != nil {
 205                 return err
 206         }
 207         h.keepClient = &keepclient.KeepClient{
 208                 Arvados:       ac,
 209                 Want_replicas: 1,
 210         }
 211         h.keepClient.Arvados.ApiToken = fmt.Sprintf("%x", rand.Int63())
 212
 213         if d := h.Cluster.Collections.BlobTrashCheckInterval.Duration(); d > 0 {
 214                 go emptyTrash(h.volmgr.writables, d)
 215         }
 216
 217         return nil
 218 }