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/url"
  16         "os"
  17         "strings"
  18
  19         "git.arvados.org/arvados.git/lib/cmd"
  20         "git.arvados.org/arvados.git/lib/config"
  21         "git.arvados.org/arvados.git/sdk/go/arvados"
  22         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  23         "git.arvados.org/arvados.git/sdk/go/httpserver"
  24         "github.com/coreos/go-systemd/daemon"
  25         "github.com/prometheus/client_golang/prometheus"
  26         "github.com/sirupsen/logrus"
  27 )
  28
  29 type Handler interface {
  30         http.Handler
  31         CheckHealth() error
  32 }
  33
  34 type NewHandlerFunc func(_ context.Context, _ *arvados.Cluster, token string, registry *prometheus.Registry) Handler
  35
  36 type command struct {
  37         newHandler NewHandlerFunc
  38         svcName    arvados.ServiceName
  39         ctx        context.Context // enables tests to shutdown service; no public API yet
  40 }
  41
  42 // Command returns a cmd.Handler that loads site config, calls
  43 // newHandler with the current cluster and node configs, and brings up
  44 // an http server with the returned handler.
  45 //
  46 // The handler is wrapped with server middleware (adding X-Request-ID
  47 // headers, logging requests/responses, etc).
  48 func Command(svcName arvados.ServiceName, newHandler NewHandlerFunc) cmd.Handler {
  49         return &command{
  50                 newHandler: newHandler,
  51                 svcName:    svcName,
  52                 ctx:        context.Background(),
  53         }
  54 }
  55
  56 func (c *command) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  57         log := ctxlog.New(stderr, "json", "info")
  58
  59         var err error
  60         defer func() {
  61                 if err != nil {
  62                         log.WithError(err).Error("exiting")
  63                 }
  64         }()
  65
  66         flags := flag.NewFlagSet("", flag.ContinueOnError)
  67         flags.SetOutput(stderr)
  68
  69         loader := config.NewLoader(stdin, log)
  70         loader.SetupFlags(flags)
  71         versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
  72         err = flags.Parse(args)
  73         if err == flag.ErrHelp {
  74                 err = nil
  75                 return 0
  76         } else if err != nil {
  77                 return 2
  78         } else if *versionFlag {
  79                 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
  80         }
  81
  82         if strings.HasSuffix(prog, "controller") {
  83                 // Some config-loader checks try to make API calls via
  84                 // controller. Those can't be expected to work if this
  85                 // process _is_ the controller: we haven't started an
  86                 // http server yet.
  87                 loader.SkipAPICalls = true
  88         }
  89
  90         cfg, err := loader.Load()
  91         if err != nil {
  92                 return 1
  93         }
  94         cluster, err := cfg.GetCluster("")
  95         if err != nil {
  96                 return 1
  97         }
  98
  99         // Now that we've read the config, replace the bootstrap
 100         // logger with a new one according to the logging config.
 101         log = ctxlog.New(stderr, cluster.SystemLogs.Format, cluster.SystemLogs.LogLevel)
 102         logger := log.WithFields(logrus.Fields{
 103                 "PID": os.Getpid(),
 104         })
 105         ctx := ctxlog.Context(c.ctx, logger)
 106
 107         listenURL, err := getListenAddr(cluster.Services, c.svcName, log)
 108         if err != nil {
 109                 return 1
 110         }
 111         ctx = context.WithValue(ctx, contextKeyURL{}, listenURL)
 112
 113         reg := prometheus.NewRegistry()
 114         handler := c.newHandler(ctx, cluster, cluster.SystemRootToken, reg)
 115         if err = handler.CheckHealth(); err != nil {
 116                 return 1
 117         }
 118
 119         instrumented := httpserver.Instrument(reg, log,
 120                 httpserver.HandlerWithContext(ctx,
 121                         httpserver.AddRequestIDs(
 122                                 httpserver.LogRequests(
 123                                         httpserver.NewRequestLimiter(cluster.API.MaxConcurrentRequests, handler, reg)))))
 124         srv := &httpserver.Server{
 125                 Server: http.Server{
 126                         Handler: instrumented.ServeAPI(cluster.ManagementToken, instrumented),
 127                 },
 128                 Addr: listenURL.Host,
 129         }
 130         if listenURL.Scheme == "https" {
 131                 tlsconfig, err := tlsConfigWithCertUpdater(cluster, logger)
 132                 if err != nil {
 133                         logger.WithError(err).Errorf("cannot start %s service on %s", c.svcName, listenURL.String())
 134                         return 1
 135                 }
 136                 srv.TLSConfig = tlsconfig
 137         }
 138         err = srv.Start()
 139         if err != nil {
 140                 return 1
 141         }
 142         logger.WithFields(logrus.Fields{
 143                 "URL":     listenURL,
 144                 "Listen":  srv.Addr,
 145                 "Service": c.svcName,
 146         }).Info("listening")
 147         if _, err := daemon.SdNotify(false, "READY=1"); err != nil {
 148                 logger.WithError(err).Errorf("error notifying init daemon")
 149         }
 150         go func() {
 151                 <-ctx.Done()
 152                 srv.Close()
 153         }()
 154         err = srv.Wait()
 155         if err != nil {
 156                 return 1
 157         }
 158         return 0
 159 }
 160
 161 const rfc3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00"
 162
 163 func getListenAddr(svcs arvados.Services, prog arvados.ServiceName, log logrus.FieldLogger) (arvados.URL, error) {
 164         svc, ok := svcs.Map()[prog]
 165         if !ok {
 166                 return arvados.URL{}, fmt.Errorf("unknown service name %q", prog)
 167         }
 168
 169         if want := os.Getenv("ARVADOS_SERVICE_INTERNAL_URL"); want == "" {
 170         } else if url, err := url.Parse(want); err != nil {
 171                 return arvados.URL{}, fmt.Errorf("$ARVADOS_SERVICE_INTERNAL_URL (%q): %s", want, err)
 172         } else {
 173                 return arvados.URL(*url), nil
 174         }
 175
 176         errors := []string{}
 177         for url := range svc.InternalURLs {
 178                 listener, err := net.Listen("tcp", url.Host)
 179                 if err == nil {
 180                         listener.Close()
 181                         return url, nil
 182                 } else if strings.Contains(err.Error(), "cannot assign requested address") {
 183                         // If 'Host' specifies a different server than
 184                         // the current one, it'll resolve the hostname
 185                         // to IP address, and then fail because it
 186                         // can't bind an IP address it doesn't own.
 187                         continue
 188                 } else {
 189                         errors = append(errors, fmt.Sprintf("tried %v, got %v", url, err))
 190                 }
 191         }
 192         if len(errors) > 0 {
 193                 return arvados.URL{}, fmt.Errorf("could not enable the %q service on this host: %s", prog, strings.Join(errors, "; "))
 194         }
 195         return arvados.URL{}, fmt.Errorf("configuration does not enable the %q service on this host", prog)
 196 }
 197
 198 type contextKeyURL struct{}
 199
 200 func URLFromContext(ctx context.Context) (arvados.URL, bool) {
 201         u, ok := ctx.Value(contextKeyURL{}).(arvados.URL)
 202         return u, ok
 203 }