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.curoverse.com/arvados.git/lib/cmd"
  20         "git.curoverse.com/arvados.git/lib/config"
  21         "git.curoverse.com/arvados.git/sdk/go/arvados"
  22         "git.curoverse.com/arvados.git/sdk/go/ctxlog"
  23         "git.curoverse.com/arvados.git/sdk/go/httpserver"
  24         "github.com/coreos/go-systemd/daemon"
  25         "github.com/sirupsen/logrus"
  26 )
  27
  28 type Handler interface {
  29         http.Handler
  30         CheckHealth() error
  31 }
  32
  33 type NewHandlerFunc func(_ context.Context, _ *arvados.Cluster, token string) Handler
  34
  35 type command struct {
  36         newHandler NewHandlerFunc
  37         svcName    arvados.ServiceName
  38         ctx        context.Context // enables tests to shutdown service; no public API yet
  39 }
  40
  41 // Command returns a cmd.Handler that loads site config, calls
  42 // newHandler with the current cluster and node configs, and brings up
  43 // an http server with the returned handler.
  44 //
  45 // The handler is wrapped with server middleware (adding X-Request-ID
  46 // headers, logging requests/responses, etc).
  47 func Command(svcName arvados.ServiceName, newHandler NewHandlerFunc) cmd.Handler {
  48         return &command{
  49                 newHandler: newHandler,
  50                 svcName:    svcName,
  51                 ctx:        context.Background(),
  52         }
  53 }
  54
  55 func (c *command) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  56         log := ctxlog.New(stderr, "json", "info")
  57
  58         var err error
  59         defer func() {
  60                 if err != nil {
  61                         log.WithError(err).Info("exiting")
  62                 }
  63         }()
  64
  65         flags := flag.NewFlagSet("", flag.ContinueOnError)
  66         flags.SetOutput(stderr)
  67
  68         loader := config.NewLoader(stdin, log)
  69         loader.SetupFlags(flags)
  70         versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
  71
  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         cfg, err := loader.Load()
  83         if err != nil {
  84                 return 1
  85         }
  86         cluster, err := cfg.GetCluster("")
  87         if err != nil {
  88                 return 1
  89         }
  90         log = ctxlog.New(stderr, cluster.SystemLogs.Format, cluster.SystemLogs.LogLevel).WithFields(logrus.Fields{
  91                 "PID": os.Getpid(),
  92         })
  93         ctx := ctxlog.Context(c.ctx, log)
  94
  95         listen, err := getListenAddr(cluster.Services, c.svcName)
  96         if err != nil {
  97                 return 1
  98         }
  99
 100         if cluster.SystemRootToken == "" {
 101                 log.Warn("SystemRootToken missing from cluster config, falling back to ARVADOS_API_TOKEN environment variable")
 102                 cluster.SystemRootToken = os.Getenv("ARVADOS_API_TOKEN")
 103         }
 104         if cluster.Services.Controller.ExternalURL.Host == "" {
 105                 log.Warn("Services.Controller.ExternalURL missing from cluster config, falling back to ARVADOS_API_HOST(_INSECURE) environment variables")
 106                 u, err := url.Parse("https://" + os.Getenv("ARVADOS_API_HOST"))
 107                 if err != nil {
 108                         err = fmt.Errorf("ARVADOS_API_HOST: %s", err)
 109                         return 1
 110                 }
 111                 cluster.Services.Controller.ExternalURL = arvados.URL(*u)
 112                 if i := os.Getenv("ARVADOS_API_HOST_INSECURE"); i != "" && i != "0" {
 113                         cluster.TLS.Insecure = true
 114                 }
 115         }
 116
 117         handler := c.newHandler(ctx, cluster, cluster.SystemRootToken)
 118         if err = handler.CheckHealth(); err != nil {
 119                 return 1
 120         }
 121         srv := &httpserver.Server{
 122                 Server: http.Server{
 123                         Handler: httpserver.HandlerWithContext(ctx,
 124                                 httpserver.AddRequestIDs(httpserver.LogRequests(handler))),
 125                 },
 126                 Addr: listen,
 127         }
 128         err = srv.Start()
 129         if err != nil {
 130                 return 1
 131         }
 132         log.WithFields(logrus.Fields{
 133                 "Listen":  srv.Addr,
 134                 "Service": c.svcName,
 135         }).Info("listening")
 136         if _, err := daemon.SdNotify(false, "READY=1"); err != nil {
 137                 log.WithError(err).Errorf("error notifying init daemon")
 138         }
 139         go func() {
 140                 <-ctx.Done()
 141                 srv.Close()
 142         }()
 143         err = srv.Wait()
 144         if err != nil {
 145                 return 1
 146         }
 147         return 0
 148 }
 149
 150 const rfc3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00"
 151
 152 func getListenAddr(svcs arvados.Services, prog arvados.ServiceName) (string, error) {
 153         svc, ok := svcs.Map()[prog]
 154         if !ok {
 155                 return "", fmt.Errorf("unknown service name %q", prog)
 156         }
 157         for url := range svc.InternalURLs {
 158                 if strings.HasPrefix(url.Host, "localhost:") {
 159                         return url.Host, nil
 160                 }
 161                 listener, err := net.Listen("tcp", url.Host)
 162                 if err == nil {
 163                         listener.Close()
 164                         return url.Host, nil
 165                 }
 166         }
 167         return "", fmt.Errorf("configuration does not enable the %s service on this host", prog)
 168 }