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         "io/ioutil"
  14         "net"
  15         "net/http"
  16         "net/url"
  17         "os"
  18         "strings"
  19
  20         "git.curoverse.com/arvados.git/lib/cmd"
  21         "git.curoverse.com/arvados.git/lib/config"
  22         "git.curoverse.com/arvados.git/sdk/go/arvados"
  23         "git.curoverse.com/arvados.git/sdk/go/ctxlog"
  24         "git.curoverse.com/arvados.git/sdk/go/httpserver"
  25         "github.com/coreos/go-systemd/daemon"
  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) 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).Info("exiting")
  63                 }
  64         }()
  65         flags := flag.NewFlagSet("", flag.ContinueOnError)
  66         flags.SetOutput(stderr)
  67         configFile := flags.String("config", arvados.DefaultConfigFile, "Site configuration `file`")
  68         err = flags.Parse(args)
  69         if err == flag.ErrHelp {
  70                 err = nil
  71                 return 0
  72         } else if err != nil {
  73                 return 2
  74         }
  75         // Logged warnings are discarded for now: the config template
  76         // is incomplete, which causes extra warnings about keys that
  77         // are really OK.
  78         cfg, err := config.LoadFile(*configFile, ctxlog.New(ioutil.Discard, "json", "error"))
  79         if err != nil {
  80                 return 1
  81         }
  82         cluster, err := cfg.GetCluster("")
  83         if err != nil {
  84                 return 1
  85         }
  86         log = ctxlog.New(stderr, cluster.SystemLogs.Format, cluster.SystemLogs.LogLevel).WithFields(logrus.Fields{
  87                 "PID": os.Getpid(),
  88         })
  89         ctx := ctxlog.Context(c.ctx, log)
  90
  91         listen, err := getListenAddr(cluster.Services, c.svcName)
  92         if err != nil {
  93                 return 1
  94         }
  95
  96         if cluster.SystemRootToken == "" {
  97                 log.Warn("SystemRootToken missing from cluster config, falling back to ARVADOS_API_TOKEN environment variable")
  98                 cluster.SystemRootToken = os.Getenv("ARVADOS_API_TOKEN")
  99         }
 100         if cluster.Services.Controller.ExternalURL.Host == "" {
 101                 log.Warn("Services.Controller.ExternalURL missing from cluster config, falling back to ARVADOS_API_HOST(_INSECURE) environment variables")
 102                 u, err := url.Parse("https://" + os.Getenv("ARVADOS_API_HOST"))
 103                 if err != nil {
 104                         err = fmt.Errorf("ARVADOS_API_HOST: %s", err)
 105                         return 1
 106                 }
 107                 cluster.Services.Controller.ExternalURL = arvados.URL(*u)
 108                 if i := os.Getenv("ARVADOS_API_HOST_INSECURE"); i != "" && i != "0" {
 109                         cluster.TLS.Insecure = true
 110                 }
 111         }
 112
 113         handler := c.newHandler(ctx, cluster, cluster.SystemRootToken)
 114         if err = handler.CheckHealth(); err != nil {
 115                 return 1
 116         }
 117         srv := &httpserver.Server{
 118                 Server: http.Server{
 119                         Handler: httpserver.HandlerWithContext(ctx,
 120                                 httpserver.AddRequestIDs(httpserver.LogRequests(handler))),
 121                 },
 122                 Addr: listen,
 123         }
 124         err = srv.Start()
 125         if err != nil {
 126                 return 1
 127         }
 128         log.WithFields(logrus.Fields{
 129                 "Listen":  srv.Addr,
 130                 "Service": c.svcName,
 131         }).Info("listening")
 132         if _, err := daemon.SdNotify(false, "READY=1"); err != nil {
 133                 log.WithError(err).Errorf("error notifying init daemon")
 134         }
 135         go func() {
 136                 <-ctx.Done()
 137                 srv.Close()
 138         }()
 139         err = srv.Wait()
 140         if err != nil {
 141                 return 1
 142         }
 143         return 0
 144 }
 145
 146 const rfc3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00"
 147
 148 func getListenAddr(svcs arvados.Services, prog arvados.ServiceName) (string, error) {
 149         svc, ok := svcs.Map()[prog]
 150         if !ok {
 151                 return "", fmt.Errorf("unknown service name %q", prog)
 152         }
 153         for url := range svc.InternalURLs {
 154                 if strings.HasPrefix(url.Host, "localhost:") {
 155                         return url.Host, nil
 156                 }
 157                 listener, err := net.Listen("tcp", url.Host)
 158                 if err == nil {
 159                         listener.Close()
 160                         return url.Host, nil
 161                 }
 162         }
 163         return "", fmt.Errorf("configuration does not enable the %s service on this host", prog)
 164 }