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         "log"
  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         cfg, err := config.LoadFile(*configFile, log)
  76         if err != nil {
  77                 return 1
  78         }
  79         cluster, err := cfg.GetCluster("")
  80         if err != nil {
  81                 return 1
  82         }
  83         log = ctxlog.New(stderr, cluster.SystemLogs.Format, cluster.SystemLogs.LogLevel).WithFields(logrus.Fields{
  84                 "PID": os.Getpid(),
  85         })
  86         ctx := ctxlog.Context(c.ctx, log)
  87
  88         listen, err := getListenAddr(cluster.Services, c.svcName)
  89         if err != nil {
  90                 return 1
  91         }
  92
  93         if cluster.SystemRootToken == "" {
  94                 log.Warn("SystemRootToken missing from cluster config, falling back to ARVADOS_API_TOKEN environment variable")
  95                 cluster.SystemRootToken = os.Getenv("ARVADOS_API_TOKEN")
  96         }
  97         if cluster.Services.Controller.ExternalURL.Host == "" {
  98                 log.Warn("Services.Controller.ExternalURL missing from cluster config, falling back to ARVADOS_API_HOST(_INSECURE) environment variables")
  99                 u, err := url.Parse("https://" + os.Getenv("ARVADOS_API_HOST"))
 100                 if err != nil {
 101                         err = fmt.Errorf("ARVADOS_API_HOST: %s", err)
 102                         return 1
 103                 }
 104                 cluster.Services.Controller.ExternalURL = arvados.URL(*u)
 105                 if i := os.Getenv("ARVADOS_API_HOST_INSECURE"); i != "" && i != "0" {
 106                         cluster.TLS.Insecure = true
 107                 }
 108         }
 109
 110         handler := c.newHandler(ctx, cluster, cluster.SystemRootToken)
 111         if err = handler.CheckHealth(); err != nil {
 112                 return 1
 113         }
 114         srv := &httpserver.Server{
 115                 Server: http.Server{
 116                         Handler: httpserver.AddRequestIDs(httpserver.LogRequests(log, handler)),
 117                 },
 118                 Addr: listen,
 119         }
 120         err = srv.Start()
 121         if err != nil {
 122                 return 1
 123         }
 124         log.WithFields(logrus.Fields{
 125                 "Listen":  srv.Addr,
 126                 "Service": c.svcName,
 127         }).Info("listening")
 128         if _, err := daemon.SdNotify(false, "READY=1"); err != nil {
 129                 log.WithError(err).Errorf("error notifying init daemon")
 130         }
 131         go func() {
 132                 <-ctx.Done()
 133                 srv.Close()
 134         }()
 135         err = srv.Wait()
 136         if err != nil {
 137                 return 1
 138         }
 139         return 0
 140 }
 141
 142 const rfc3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00"
 143
 144 func getListenAddr(svcs arvados.Services, prog arvados.ServiceName) (string, error) {
 145         svc, ok := map[arvados.ServiceName]arvados.Service{
 146                 arvados.ServiceNameController:    svcs.Controller,
 147                 arvados.ServiceNameDispatchCloud: svcs.DispatchCloud,
 148                 arvados.ServiceNameHealth:        svcs.Health,
 149                 arvados.ServiceNameKeepbalance:   svcs.Keepbalance,
 150                 arvados.ServiceNameKeepproxy:     svcs.Keepproxy,
 151                 arvados.ServiceNameKeepstore:     svcs.Keepstore,
 152                 arvados.ServiceNameKeepweb:       svcs.WebDAV,
 153                 arvados.ServiceNameWebsocket:     svcs.Websocket,
 154         }[prog]
 155         if !ok {
 156                 return "", fmt.Errorf("unknown service name %q", prog)
 157         }
 158         for url := range svc.InternalURLs {
 159                 if strings.HasPrefix(url.Host, "localhost:") {
 160                         return url.Host, nil
 161                 }
 162                 listener, err := net.Listen("tcp", url.Host)
 163                 if err == nil {
 164                         listener.Close()
 165                         return url.Host, nil
 166                 }
 167                 log.Print(err)
 168
 169         }
 170         return "", fmt.Errorf("configuration does not enable the %s service on this host", prog)
 171 }