lib/service/cmd.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: Apache-2.0
   4
   5 // Package service provides a cmd.Handler that brings up a system service.
   6 package service
   7
   8 import (
   9         "context"
  10         "flag"
  11         "fmt"
  12         "io"
  13         "net"
  14         "net/http"
  15         "net/http/httptest"
  16         _ "net/http/pprof"
  17         "net/url"
  18         "os"
  19         "regexp"
  20         "strings"
  21         "time"
  22
  23         "git.arvados.org/arvados.git/lib/cmd"
  24         "git.arvados.org/arvados.git/lib/config"
  25         "git.arvados.org/arvados.git/sdk/go/arvados"
  26         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  27         "git.arvados.org/arvados.git/sdk/go/health"
  28         "git.arvados.org/arvados.git/sdk/go/httpserver"
  29         "github.com/coreos/go-systemd/daemon"
  30         "github.com/julienschmidt/httprouter"
  31         "github.com/prometheus/client_golang/prometheus"
  32         "github.com/sirupsen/logrus"
  33 )
  34
  35 type Handler interface {
  36         http.Handler
  37         CheckHealth() error
  38         // Done returns a channel that closes when the handler shuts
  39         // itself down, or nil if this never happens.
  40         Done() <-chan struct{}
  41 }
  42
  43 type NewHandlerFunc func(_ context.Context, _ *arvados.Cluster, token string, registry *prometheus.Registry) Handler
  44
  45 type command struct {
  46         newHandler NewHandlerFunc
  47         svcName    arvados.ServiceName
  48         ctx        context.Context // enables tests to shutdown service; no public API yet
  49 }
  50
  51 var requestQueueDumpCheckInterval = time.Minute
  52
  53 // Command returns a cmd.Handler that loads site config, calls
  54 // newHandler with the current cluster and node configs, and brings up
  55 // an http server with the returned handler.
  56 //
  57 // The handler is wrapped with server middleware (adding X-Request-ID
  58 // headers, logging requests/responses, etc).
  59 func Command(svcName arvados.ServiceName, newHandler NewHandlerFunc) cmd.Handler {
  60         return &command{
  61                 newHandler: newHandler,
  62                 svcName:    svcName,
  63                 ctx:        context.Background(),
  64         }
  65 }
  66
  67 func (c *command) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  68         log := ctxlog.New(stderr, "json", "info")
  69
  70         var err error
  71         defer func() {
  72                 if err != nil {
  73                         log.WithError(err).Error("exiting")
  74                 }
  75         }()
  76
  77         flags := flag.NewFlagSet("", flag.ContinueOnError)
  78         flags.SetOutput(stderr)
  79
  80         loader := config.NewLoader(stdin, log)
  81         loader.SetupFlags(flags)
  82
  83         // prog is [keepstore, keep-web, ...]  but the
  84         // legacy config flags are [-legacy-keepstore-config,
  85         // -legacy-keepweb-config, ...]
  86         legacyFlag := "-legacy-" + strings.Replace(prog, "keep-", "keep", 1) + "-config"
  87         args = loader.MungeLegacyConfigArgs(log, args, legacyFlag)
  88
  89         versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
  90         pprofAddr := flags.String("pprof", "", "Serve Go profile data at `[addr]:port`")
  91         if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok {
  92                 return code
  93         } else if *versionFlag {
  94                 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
  95         }
  96
  97         if *pprofAddr != "" {
  98                 go func() {
  99                         log.Println(http.ListenAndServe(*pprofAddr, nil))
 100                 }()
 101         }
 102
 103         if strings.HasSuffix(prog, "controller") {
 104                 // Some config-loader checks try to make API calls via
 105                 // controller. Those can't be expected to work if this
 106                 // process _is_ the controller: we haven't started an
 107                 // http server yet.
 108                 loader.SkipAPICalls = true
 109         }
 110
 111         cfg, err := loader.Load()
 112         if err != nil {
 113                 return 1
 114         }
 115         cluster, err := cfg.GetCluster("")
 116         if err != nil {
 117                 return 1
 118         }
 119
 120         // Now that we've read the config, replace the bootstrap
 121         // logger with a new one according to the logging config.
 122         log = ctxlog.New(stderr, cluster.SystemLogs.Format, cluster.SystemLogs.LogLevel)
 123         logger := log.WithFields(logrus.Fields{
 124                 "PID":       os.Getpid(),
 125                 "ClusterID": cluster.ClusterID,
 126         })
 127         ctx := ctxlog.Context(c.ctx, logger)
 128
 129         // Check whether the caller is attempting to use environment
 130         // variables to override cluster configuration, and advise
 131         // that won't work.
 132         {
 133                 envhost := os.Getenv("ARVADOS_API_HOST")
 134                 if envhost != "" && envhost != cluster.Services.Controller.ExternalURL.Host {
 135                         logger.Warn("ARVADOS_API_HOST environment variable is present, but will not be used")
 136                 }
 137                 envins := os.Getenv("ARVADOS_API_HOST_INSECURE")
 138                 if envins != "" && (envins != "0") != cluster.TLS.Insecure {
 139                         logger.Warn("ARVADOS_API_HOST_INSECURE environment variable is present, but will not be used")
 140                 }
 141                 envtoken := os.Getenv("ARVADOS_API_TOKEN")
 142                 if envtoken != "" && envtoken != cluster.SystemRootToken {
 143                         logger.Warn("ARVADOS_API_TOKEN environment variable is present, but will not be used")
 144                 }
 145         }
 146
 147         listenURL, internalURL, err := getListenAddr(cluster.Services, c.svcName, log)
 148         if err != nil {
 149                 return 1
 150         }
 151         ctx = context.WithValue(ctx, contextKeyURL{}, internalURL)
 152
 153         reg := prometheus.NewRegistry()
 154         loader.RegisterMetrics(reg)
 155
 156         // arvados_version_running{version="1.2.3~4"} 1.0
 157         mVersion := prometheus.NewGaugeVec(prometheus.GaugeOpts{
 158                 Namespace: "arvados",
 159                 Name:      "version_running",
 160                 Help:      "Indicated version is running.",
 161         }, []string{"version"})
 162         mVersion.WithLabelValues(cmd.Version.String()).Set(1)
 163         reg.MustRegister(mVersion)
 164
 165         handler := c.newHandler(ctx, cluster, cluster.SystemRootToken, reg)
 166         if err = handler.CheckHealth(); err != nil {
 167                 return 1
 168         }
 169
 170         instrumented := httpserver.Instrument(reg, log,
 171                 httpserver.HandlerWithDeadline(cluster.API.RequestTimeout.Duration(),
 172                         httpserver.AddRequestIDs(
 173                                 httpserver.Inspect(reg, cluster.ManagementToken,
 174                                         httpserver.LogRequests(
 175                                                 interceptHealthReqs(cluster.ManagementToken, handler.CheckHealth,
 176                                                         c.requestLimiter(handler, cluster, reg)))))))
 177         srv := &httpserver.Server{
 178                 Server: http.Server{
 179                         Handler:     ifCollectionInHost(instrumented, instrumented.ServeAPI(cluster.ManagementToken, instrumented)),
 180                         BaseContext: func(net.Listener) context.Context { return ctx },
 181                 },
 182                 Addr: listenURL.Host,
 183         }
 184         if listenURL.Scheme == "https" || listenURL.Scheme == "wss" {
 185                 tlsconfig, err := makeTLSConfig(cluster, logger)
 186                 if err != nil {
 187                         logger.WithError(err).Errorf("cannot start %s service on %s", c.svcName, listenURL.String())
 188                         return 1
 189                 }
 190                 srv.TLSConfig = tlsconfig
 191         }
 192         err = srv.Start()
 193         if err != nil {
 194                 return 1
 195         }
 196         logger.WithFields(logrus.Fields{
 197                 "URL":     listenURL,
 198                 "Listen":  srv.Addr,
 199                 "Service": c.svcName,
 200                 "Version": cmd.Version.String(),
 201         }).Info("listening")
 202         if _, err := daemon.SdNotify(false, "READY=1"); err != nil {
 203                 logger.WithError(err).Errorf("error notifying init daemon")
 204         }
 205         go func() {
 206                 // Shut down server if caller cancels context
 207                 <-ctx.Done()
 208                 srv.Close()
 209         }()
 210         go func() {
 211                 // Shut down server if handler dies
 212                 <-handler.Done()
 213                 srv.Close()
 214         }()
 215         go c.requestQueueDumpCheck(cluster, prog, reg, &srv.Server, logger)
 216         err = srv.Wait()
 217         if err != nil {
 218                 return 1
 219         }
 220         return 0
 221 }
 222
 223 // If SystemLogs.RequestQueueDumpDirectory is set, monitor the
 224 // server's incoming HTTP request limiters. When the number of
 225 // concurrent requests in any queue ("api" or "tunnel") exceeds 90% of
 226 // its maximum slots, write the /_inspect/requests data to a JSON file
 227 // in the specified directory.
 228 func (c *command) requestQueueDumpCheck(cluster *arvados.Cluster, prog string, reg *prometheus.Registry, srv *http.Server, logger logrus.FieldLogger) {
 229         outdir := cluster.SystemLogs.RequestQueueDumpDirectory
 230         if outdir == "" || cluster.ManagementToken == "" {
 231                 return
 232         }
 233         logger = logger.WithField("worker", "RequestQueueDump")
 234         outfile := outdir + "/" + prog + "-requests.json"
 235         for range time.NewTicker(requestQueueDumpCheckInterval).C {
 236                 mfs, err := reg.Gather()
 237                 if err != nil {
 238                         logger.WithError(err).Warn("error getting metrics")
 239                         continue
 240                 }
 241                 cur := map[string]int{} // queue label => current
 242                 max := map[string]int{} // queue label => max
 243                 for _, mf := range mfs {
 244                         for _, m := range mf.GetMetric() {
 245                                 for _, ml := range m.GetLabel() {
 246                                         if ml.GetName() == "queue" {
 247                                                 n := int(m.GetGauge().GetValue())
 248                                                 if name := mf.GetName(); name == "arvados_concurrent_requests" {
 249                                                         cur[*ml.Value] = n
 250                                                 } else if name == "arvados_max_concurrent_requests" {
 251                                                         max[*ml.Value] = n
 252                                                 }
 253                                         }
 254                                 }
 255                         }
 256                 }
 257                 dump := false
 258                 for queue, n := range cur {
 259                         if n > 0 && max[queue] > 0 && n >= max[queue]*9/10 {
 260                                 dump = true
 261                                 break
 262                         }
 263                 }
 264                 if dump {
 265                         req, err := http.NewRequest("GET", "/_inspect/requests", nil)
 266                         if err != nil {
 267                                 logger.WithError(err).Warn("error in http.NewRequest")
 268                                 continue
 269                         }
 270                         req.Header.Set("Authorization", "Bearer "+cluster.ManagementToken)
 271                         resp := httptest.NewRecorder()
 272                         srv.Handler.ServeHTTP(resp, req)
 273                         if code := resp.Result().StatusCode; code != http.StatusOK {
 274                                 logger.WithField("StatusCode", code).Warn("error getting /_inspect/requests")
 275                                 continue
 276                         }
 277                         err = os.WriteFile(outfile, resp.Body.Bytes(), 0777)
 278                         if err != nil {
 279                                 logger.WithError(err).Warn("error writing file")
 280                                 continue
 281                         }
 282                 }
 283         }
 284 }
 285
 286 // Set up a httpserver.RequestLimiter with separate queues/streams for
 287 // API requests (obeying MaxConcurrentRequests etc) and gateway tunnel
 288 // requests (obeying MaxGatewayTunnels).
 289 func (c *command) requestLimiter(handler http.Handler, cluster *arvados.Cluster, reg *prometheus.Registry) http.Handler {
 290         maxReqs := cluster.API.MaxConcurrentRequests
 291         if maxRails := cluster.API.MaxConcurrentRailsRequests; maxRails > 0 &&
 292                 (maxRails < maxReqs || maxReqs == 0) &&
 293                 c.svcName == arvados.ServiceNameController {
 294                 // Ideally, we would accept up to
 295                 // MaxConcurrentRequests, and apply the
 296                 // MaxConcurrentRailsRequests limit only for requests
 297                 // that require calling upstream to RailsAPI. But for
 298                 // now we make the simplifying assumption that every
 299                 // controller request causes an upstream RailsAPI
 300                 // request.
 301                 maxReqs = maxRails
 302         }
 303         rqAPI := &httpserver.RequestQueue{
 304                 Label:                      "api",
 305                 MaxConcurrent:              maxReqs,
 306                 MaxQueue:                   cluster.API.MaxQueuedRequests,
 307                 MaxQueueTimeForMinPriority: cluster.API.MaxQueueTimeForLockRequests.Duration(),
 308         }
 309         rqTunnel := &httpserver.RequestQueue{
 310                 Label:         "tunnel",
 311                 MaxConcurrent: cluster.API.MaxGatewayTunnels,
 312                 MaxQueue:      0,
 313         }
 314         return &httpserver.RequestLimiter{
 315                 Handler:  handler,
 316                 Priority: c.requestPriority,
 317                 Registry: reg,
 318                 Queue: func(req *http.Request) *httpserver.RequestQueue {
 319                         if req.Method == http.MethodPost && reTunnelPath.MatchString(req.URL.Path) {
 320                                 return rqTunnel
 321                         } else {
 322                                 return rqAPI
 323                         }
 324                 },
 325         }
 326 }
 327
 328 // reTunnelPath matches paths of API endpoints that go in the "tunnel"
 329 // queue.
 330 var reTunnelPath = regexp.MustCompile(func() string {
 331         rePathVar := regexp.MustCompile(`{.*?}`)
 332         out := ""
 333         for _, endpoint := range []arvados.APIEndpoint{
 334                 arvados.EndpointContainerGatewayTunnel,
 335                 arvados.EndpointContainerGatewayTunnelCompat,
 336                 arvados.EndpointContainerSSH,
 337                 arvados.EndpointContainerSSHCompat,
 338         } {
 339                 if out != "" {
 340                         out += "|"
 341                 }
 342                 out += `\Q/` + rePathVar.ReplaceAllString(endpoint.Path, `\E[^/]*\Q`) + `\E`
 343         }
 344         return "^(" + out + ")$"
 345 }())
 346
 347 func (c *command) requestPriority(req *http.Request, queued time.Time) int64 {
 348         switch {
 349         case req.Method == http.MethodPost && strings.HasPrefix(req.URL.Path, "/arvados/v1/containers/") && strings.HasSuffix(req.URL.Path, "/lock"):
 350                 // Return 503 immediately instead of queueing. We want
 351                 // to send feedback to dispatchcloud ASAP to stop
 352                 // bringing up new containers.
 353                 return httpserver.MinPriority
 354         case req.Header.Get("Origin") != "":
 355                 // Handle interactive requests first. Positive
 356                 // priority is called "high" in aggregate metrics.
 357                 return 1
 358         default:
 359                 // Zero priority is called "normal" in aggregate
 360                 // metrics.
 361                 return 0
 362         }
 363 }
 364
 365 // If an incoming request's target vhost has an embedded collection
 366 // UUID or PDH, handle it with hTrue, otherwise handle it with
 367 // hFalse.
 368 //
 369 // Facilitates routing "http://collections.example/metrics" to metrics
 370 // and "http://{uuid}.collections.example/metrics" to a file in a
 371 // collection.
 372 func ifCollectionInHost(hTrue, hFalse http.Handler) http.Handler {
 373         return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 374                 if arvados.CollectionIDFromDNSName(r.Host) != "" {
 375                         hTrue.ServeHTTP(w, r)
 376                 } else {
 377                         hFalse.ServeHTTP(w, r)
 378                 }
 379         })
 380 }
 381
 382 func interceptHealthReqs(mgtToken string, checkHealth func() error, next http.Handler) http.Handler {
 383         mux := httprouter.New()
 384         mux.Handler("GET", "/_health/ping", &health.Handler{
 385                 Token:  mgtToken,
 386                 Prefix: "/_health/",
 387                 Routes: health.Routes{"ping": checkHealth},
 388         })
 389         mux.NotFound = next
 390         return ifCollectionInHost(next, mux)
 391 }
 392
 393 // Determine listenURL (addr:port where server should bind) and
 394 // internalURL (target url that client should connect to) for a
 395 // service.
 396 //
 397 // If the config does not specify ListenURL, we check all of the
 398 // configured InternalURLs. If there is exactly one that matches our
 399 // hostname, or exactly one that matches a local interface address,
 400 // then we use that as listenURL.
 401 //
 402 // Note that listenURL and internalURL may use different protocols
 403 // (e.g., listenURL is http, but the service sits behind a proxy, so
 404 // clients connect using https).
 405 func getListenAddr(svcs arvados.Services, prog arvados.ServiceName, log logrus.FieldLogger) (arvados.URL, arvados.URL, error) {
 406         svc, ok := svcs.Map()[prog]
 407         if !ok {
 408                 return arvados.URL{}, arvados.URL{}, fmt.Errorf("unknown service name %q", prog)
 409         }
 410
 411         if want := os.Getenv("ARVADOS_SERVICE_INTERNAL_URL"); want != "" {
 412                 url, err := url.Parse(want)
 413                 if err != nil {
 414                         return arvados.URL{}, arvados.URL{}, fmt.Errorf("$ARVADOS_SERVICE_INTERNAL_URL (%q): %s", want, err)
 415                 }
 416                 if url.Path == "" {
 417                         url.Path = "/"
 418                 }
 419                 for internalURL, conf := range svc.InternalURLs {
 420                         if internalURL.String() == url.String() {
 421                                 listenURL := conf.ListenURL
 422                                 if listenURL.Host == "" {
 423                                         listenURL = internalURL
 424                                 }
 425                                 return listenURL, internalURL, nil
 426                         }
 427                 }
 428                 log.Warnf("possible configuration error: listening on %s (from $ARVADOS_SERVICE_INTERNAL_URL) even though configuration does not have a matching InternalURLs entry", url)
 429                 internalURL := arvados.URL(*url)
 430                 return internalURL, internalURL, nil
 431         }
 432
 433         errors := []string{}
 434         for internalURL, conf := range svc.InternalURLs {
 435                 listenURL := conf.ListenURL
 436                 if listenURL.Host == "" {
 437                         // If ListenURL is not specified, assume
 438                         // InternalURL is also usable as the listening
 439                         // proto/addr/port (i.e., simple case with no
 440                         // intermediate proxy/routing)
 441                         listenURL = internalURL
 442                 }
 443                 listenAddr := listenURL.Host
 444                 if _, _, err := net.SplitHostPort(listenAddr); err != nil {
 445                         // url "https://foo.example/" (with no
 446                         // explicit port name/number) means listen on
 447                         // the well-known port for the specified
 448                         // protocol, "foo.example:https".
 449                         port := listenURL.Scheme
 450                         if port == "ws" || port == "wss" {
 451                                 port = "http" + port[2:]
 452                         }
 453                         listenAddr = net.JoinHostPort(listenAddr, port)
 454                 }
 455                 listener, err := net.Listen("tcp", listenAddr)
 456                 if err == nil {
 457                         listener.Close()
 458                         return listenURL, internalURL, nil
 459                 } else if strings.Contains(err.Error(), "cannot assign requested address") {
 460                         // If 'Host' specifies a different server than
 461                         // the current one, it'll resolve the hostname
 462                         // to IP address, and then fail because it
 463                         // can't bind an IP address it doesn't own.
 464                         continue
 465                 } else {
 466                         errors = append(errors, fmt.Sprintf("%s: %s", listenURL, err))
 467                 }
 468         }
 469         if len(errors) > 0 {
 470                 return arvados.URL{}, arvados.URL{}, fmt.Errorf("could not enable the %q service on this host: %s", prog, strings.Join(errors, "; "))
 471         }
 472         return arvados.URL{}, arvados.URL{}, fmt.Errorf("configuration does not enable the %q service on this host", prog)
 473 }
 474
 475 type contextKeyURL struct{}
 476
 477 func URLFromContext(ctx context.Context) (arvados.URL, bool) {
 478         u, ok := ctx.Value(contextKeyURL{}).(arvados.URL)
 479         return u, ok
 480 }