15954: Merge branch 'master'
[arvados.git] / lib / boot / cmd.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package boot
6
7 import (
8         "bytes"
9         "context"
10         "crypto/rand"
11         "encoding/json"
12         "flag"
13         "fmt"
14         "io"
15         "io/ioutil"
16         "net"
17         "os"
18         "os/exec"
19         "os/signal"
20         "path/filepath"
21         "strings"
22         "sync"
23         "syscall"
24         "time"
25
26         "git.arvados.org/arvados.git/lib/cmd"
27         "git.arvados.org/arvados.git/lib/config"
28         "git.arvados.org/arvados.git/sdk/go/arvados"
29         "git.arvados.org/arvados.git/sdk/go/ctxlog"
30         "git.arvados.org/arvados.git/sdk/go/health"
31         "github.com/sirupsen/logrus"
32 )
33
34 var Command cmd.Handler = bootCommand{}
35
36 type bootTask interface {
37         // Execute the task. Run should return nil when the task is
38         // done enough to satisfy a dependency relationship (e.g., the
39         // service is running and ready). If the task starts a
40         // goroutine that fails after Run returns (e.g., the service
41         // shuts down), it should call cancel.
42         Run(ctx context.Context, fail func(error), boot *Booter) error
43         String() string
44 }
45
46 type bootCommand struct{}
47
48 func (bootCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
49         boot := &Booter{
50                 Stderr: stderr,
51                 logger: ctxlog.New(stderr, "json", "info"),
52         }
53
54         ctx := ctxlog.Context(context.Background(), boot.logger)
55         ctx, cancel := context.WithCancel(ctx)
56         defer cancel()
57
58         ch := make(chan os.Signal)
59         signal.Notify(ch, syscall.SIGINT, syscall.SIGTERM)
60         go func() {
61                 for sig := range ch {
62                         boot.logger.WithField("signal", sig).Info("caught signal")
63                         cancel()
64                 }
65         }()
66
67         var err error
68         defer func() {
69                 if err != nil {
70                         boot.logger.WithError(err).Info("exiting")
71                 }
72         }()
73
74         flags := flag.NewFlagSet(prog, flag.ContinueOnError)
75         flags.SetOutput(stderr)
76         loader := config.NewLoader(stdin, boot.logger)
77         loader.SetupFlags(flags)
78         versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
79         flags.StringVar(&boot.SourcePath, "source", ".", "arvados source tree `directory`")
80         flags.StringVar(&boot.LibPath, "lib", "/var/lib/arvados", "`directory` to install dependencies and library files")
81         flags.StringVar(&boot.ClusterType, "type", "production", "cluster `type`: development, test, or production")
82         flags.StringVar(&boot.ListenHost, "listen-host", "localhost", "host name or interface address for service listeners")
83         flags.StringVar(&boot.ControllerAddr, "controller-address", ":0", "desired controller address, `host:port` or `:port`")
84         flags.BoolVar(&boot.OwnTemporaryDatabase, "own-temporary-database", false, "bring up a postgres server and create a temporary database")
85         err = flags.Parse(args)
86         if err == flag.ErrHelp {
87                 err = nil
88                 return 0
89         } else if err != nil {
90                 return 2
91         } else if *versionFlag {
92                 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
93         } else if boot.ClusterType != "development" && boot.ClusterType != "test" && boot.ClusterType != "production" {
94                 err = fmt.Errorf("cluster type must be 'development', 'test', or 'production'")
95                 return 2
96         }
97
98         boot.Start(ctx, loader)
99         defer boot.Stop()
100         if boot.WaitReady() {
101                 fmt.Fprintln(stdout, boot.cluster.Services.Controller.ExternalURL)
102                 <-ctx.Done() // wait for signal
103                 return 0
104         } else {
105                 return 1
106         }
107 }
108
109 type Booter struct {
110         SourcePath           string // e.g., /home/username/src/arvados
111         LibPath              string // e.g., /var/lib/arvados
112         ClusterType          string // e.g., production
113         ListenHost           string // e.g., localhost
114         ControllerAddr       string // e.g., 127.0.0.1:8000
115         OwnTemporaryDatabase bool
116         Stderr               io.Writer
117
118         logger  logrus.FieldLogger
119         cluster *arvados.Cluster
120
121         ctx           context.Context
122         cancel        context.CancelFunc
123         done          chan struct{}
124         healthChecker *health.Aggregator
125         tasksReady    map[string]chan bool
126
127         tempdir    string
128         configfile string
129         environ    []string // for child processes
130
131         setupRubyOnce sync.Once
132         setupRubyErr  error
133         goMutex       sync.Mutex
134 }
135
136 func (boot *Booter) Start(ctx context.Context, loader *config.Loader) {
137         boot.ctx, boot.cancel = context.WithCancel(ctx)
138         boot.done = make(chan struct{})
139         go func() {
140                 err := boot.run(loader)
141                 if err != nil {
142                         fmt.Fprintln(boot.Stderr, err)
143                 }
144                 close(boot.done)
145         }()
146 }
147
148 func (boot *Booter) run(loader *config.Loader) error {
149         cwd, err := os.Getwd()
150         if err != nil {
151                 return err
152         }
153         if !strings.HasPrefix(boot.SourcePath, "/") {
154                 boot.SourcePath = filepath.Join(cwd, boot.SourcePath)
155         }
156         boot.SourcePath, err = filepath.EvalSymlinks(boot.SourcePath)
157         if err != nil {
158                 return err
159         }
160
161         boot.tempdir, err = ioutil.TempDir("", "arvados-server-boot-")
162         if err != nil {
163                 return err
164         }
165         defer os.RemoveAll(boot.tempdir)
166
167         loader.SkipAPICalls = true
168         cfg, err := loader.Load()
169         if err != nil {
170                 return err
171         }
172
173         // Fill in any missing config keys, and write the resulting
174         // config in the temp dir for child services to use.
175         err = boot.autofillConfig(cfg, boot.logger)
176         if err != nil {
177                 return err
178         }
179         conffile, err := os.OpenFile(filepath.Join(boot.tempdir, "config.yml"), os.O_CREATE|os.O_WRONLY, 0777)
180         if err != nil {
181                 return err
182         }
183         defer conffile.Close()
184         err = json.NewEncoder(conffile).Encode(cfg)
185         if err != nil {
186                 return err
187         }
188         err = conffile.Close()
189         if err != nil {
190                 return err
191         }
192         boot.configfile = conffile.Name()
193
194         boot.environ = os.Environ()
195         boot.setEnv("ARVADOS_CONFIG", boot.configfile)
196         boot.setEnv("RAILS_ENV", boot.ClusterType)
197         boot.prependEnv("PATH", filepath.Join(boot.LibPath, "bin")+":")
198
199         boot.cluster, err = cfg.GetCluster("")
200         if err != nil {
201                 return err
202         }
203         // Now that we have the config, replace the bootstrap logger
204         // with a new one according to the logging config.
205         loglevel := boot.cluster.SystemLogs.LogLevel
206         if s := os.Getenv("ARVADOS_DEBUG"); s != "" && s != "0" {
207                 loglevel = "debug"
208         }
209         boot.logger = ctxlog.New(boot.Stderr, boot.cluster.SystemLogs.Format, loglevel).WithFields(logrus.Fields{
210                 "PID": os.Getpid(),
211         })
212         boot.healthChecker = &health.Aggregator{Cluster: boot.cluster}
213
214         for _, dir := range []string{boot.LibPath, filepath.Join(boot.LibPath, "bin")} {
215                 if _, err = os.Stat(filepath.Join(dir, ".")); os.IsNotExist(err) {
216                         err = os.Mkdir(dir, 0755)
217                         if err != nil {
218                                 return err
219                         }
220                 } else if err != nil {
221                         return err
222                 }
223         }
224         err = boot.installGoProgram(boot.ctx, "cmd/arvados-server")
225         if err != nil {
226                 return err
227         }
228         err = boot.setupRubyEnv()
229         if err != nil {
230                 return err
231         }
232
233         tasks := []bootTask{
234                 createCertificates{},
235                 runPostgreSQL{},
236                 runNginx{},
237                 runServiceCommand{name: "controller", svc: boot.cluster.Services.Controller, depends: []bootTask{runPostgreSQL{}}},
238                 runGoProgram{src: "services/arv-git-httpd"},
239                 runGoProgram{src: "services/health"},
240                 runGoProgram{src: "services/keepproxy", depends: []bootTask{runPassenger{src: "services/api"}}},
241                 runGoProgram{src: "services/keepstore", svc: boot.cluster.Services.Keepstore},
242                 runGoProgram{src: "services/keep-web"},
243                 runGoProgram{src: "services/ws", depends: []bootTask{runPostgreSQL{}}},
244                 installPassenger{src: "services/api"},
245                 runPassenger{src: "services/api", svc: boot.cluster.Services.RailsAPI, depends: []bootTask{createCertificates{}, runPostgreSQL{}, installPassenger{src: "services/api"}}},
246                 installPassenger{src: "apps/workbench", depends: []bootTask{installPassenger{src: "services/api"}}}, // dependency ensures workbench doesn't delay api startup
247                 runPassenger{src: "apps/workbench", svc: boot.cluster.Services.Workbench1, depends: []bootTask{installPassenger{src: "apps/workbench"}}},
248                 seedDatabase{},
249         }
250         if boot.ClusterType != "test" {
251                 tasks = append(tasks,
252                         runServiceCommand{name: "dispatch-cloud", svc: boot.cluster.Services.Controller},
253                         runGoProgram{src: "services/keep-balance"},
254                 )
255         }
256         boot.tasksReady = map[string]chan bool{}
257         for _, task := range tasks {
258                 boot.tasksReady[task.String()] = make(chan bool)
259         }
260         for _, task := range tasks {
261                 task := task
262                 fail := func(err error) {
263                         if boot.ctx.Err() != nil {
264                                 return
265                         }
266                         boot.cancel()
267                         boot.logger.WithField("task", task.String()).WithError(err).Error("task failed")
268                 }
269                 go func() {
270                         boot.logger.WithField("task", task.String()).Info("starting")
271                         err := task.Run(boot.ctx, fail, boot)
272                         if err != nil {
273                                 fail(err)
274                                 return
275                         }
276                         close(boot.tasksReady[task.String()])
277                 }()
278         }
279         err = boot.wait(boot.ctx, tasks...)
280         if err != nil {
281                 return err
282         }
283         <-boot.ctx.Done()
284         return boot.ctx.Err()
285 }
286
287 func (boot *Booter) wait(ctx context.Context, tasks ...bootTask) error {
288         for _, task := range tasks {
289                 ch, ok := boot.tasksReady[task.String()]
290                 if !ok {
291                         return fmt.Errorf("no such task: %s", task)
292                 }
293                 boot.logger.WithField("task", task.String()).Info("waiting")
294                 select {
295                 case <-ch:
296                 case <-ctx.Done():
297                         return ctx.Err()
298                 }
299         }
300         return nil
301 }
302
303 func (boot *Booter) Stop() {
304         boot.cancel()
305         <-boot.done
306 }
307
308 func (boot *Booter) WaitReady() bool {
309         for waiting := true; waiting; {
310                 time.Sleep(time.Second)
311                 if boot.ctx.Err() != nil {
312                         return false
313                 }
314                 if boot.healthChecker == nil {
315                         // not set up yet
316                         continue
317                 }
318                 resp := boot.healthChecker.ClusterHealth()
319                 // The overall health check (resp.Health=="OK") might
320                 // never pass due to missing components (like
321                 // arvados-dispatch-cloud in a test cluster), so
322                 // instead we wait for all configured components to
323                 // pass.
324                 waiting = false
325                 for target, check := range resp.Checks {
326                         if check.Health != "OK" {
327                                 waiting = true
328                                 boot.logger.WithField("target", target).Debug("waiting")
329                         }
330                 }
331         }
332         return true
333 }
334
335 func (boot *Booter) prependEnv(key, prepend string) {
336         for i, s := range boot.environ {
337                 if strings.HasPrefix(s, key+"=") {
338                         boot.environ[i] = key + "=" + prepend + s[len(key)+1:]
339                         return
340                 }
341         }
342         boot.environ = append(boot.environ, key+"="+prepend)
343 }
344
345 func (boot *Booter) setEnv(key, val string) {
346         for i, s := range boot.environ {
347                 if strings.HasPrefix(s, key+"=") {
348                         boot.environ[i] = key + "=" + val
349                         return
350                 }
351         }
352         boot.environ = append(boot.environ, key+"="+val)
353 }
354
355 func (boot *Booter) installGoProgram(ctx context.Context, srcpath string) error {
356         boot.goMutex.Lock()
357         defer boot.goMutex.Unlock()
358         return boot.RunProgram(ctx, filepath.Join(boot.SourcePath, srcpath), nil, []string{"GOPATH=" + boot.LibPath}, "go", "install")
359 }
360
361 func (boot *Booter) setupRubyEnv() error {
362         buf, err := exec.Command("gem", "env", "gempath").Output() // /var/lib/arvados/.gem/ruby/2.5.0/bin:...
363         if err != nil || len(buf) == 0 {
364                 return fmt.Errorf("gem env gempath: %v", err)
365         }
366         gempath := string(bytes.Split(buf, []byte{':'})[0])
367         boot.prependEnv("PATH", gempath+"/bin:")
368         boot.setEnv("GEM_HOME", gempath)
369         boot.setEnv("GEM_PATH", gempath)
370         return nil
371 }
372
373 func (boot *Booter) lookPath(prog string) string {
374         for _, val := range boot.environ {
375                 if strings.HasPrefix(val, "PATH=") {
376                         for _, dir := range filepath.SplitList(val[5:]) {
377                                 path := filepath.Join(dir, prog)
378                                 if fi, err := os.Stat(path); err == nil && fi.Mode()&0111 != 0 {
379                                         return path
380                                 }
381                         }
382                 }
383         }
384         return prog
385 }
386
387 // Run prog with args, using dir as working directory. If ctx is
388 // cancelled while the child is running, RunProgram terminates the
389 // child, waits for it to exit, then returns.
390 //
391 // Child's environment will have our env vars, plus any given in env.
392 //
393 // Child's stdout will be written to output if non-nil, otherwise the
394 // boot command's stderr.
395 func (boot *Booter) RunProgram(ctx context.Context, dir string, output io.Writer, env []string, prog string, args ...string) error {
396         cmdline := fmt.Sprintf("%s", append([]string{prog}, args...))
397         fmt.Fprintf(boot.Stderr, "%s executing in %s\n", cmdline, dir)
398
399         logprefix := prog
400         if prog == "bundle" && len(args) > 2 && args[0] == "exec" {
401                 logprefix = args[1]
402         }
403         if !strings.HasPrefix(dir, "/") {
404                 logprefix = dir + ": " + logprefix
405         }
406         stderr := &logPrefixer{Writer: boot.Stderr, Prefix: []byte("[" + logprefix + "] ")}
407
408         cmd := exec.Command(boot.lookPath(prog), args...)
409         if output == nil {
410                 cmd.Stdout = stderr
411         } else {
412                 cmd.Stdout = output
413         }
414         cmd.Stderr = stderr
415         if strings.HasPrefix(dir, "/") {
416                 cmd.Dir = dir
417         } else {
418                 cmd.Dir = filepath.Join(boot.SourcePath, dir)
419         }
420         cmd.Env = append(env, boot.environ...)
421
422         exited := false
423         defer func() { exited = true }()
424         go func() {
425                 <-ctx.Done()
426                 log := ctxlog.FromContext(ctx).WithFields(logrus.Fields{"dir": dir, "cmdline": cmdline})
427                 for !exited {
428                         if cmd.Process == nil {
429                                 log.Debug("waiting for child process to start")
430                                 time.Sleep(time.Second / 2)
431                         } else {
432                                 log.WithField("PID", cmd.Process.Pid).Debug("sending SIGTERM")
433                                 cmd.Process.Signal(syscall.SIGTERM)
434                                 time.Sleep(5 * time.Second)
435                                 if !exited {
436                                         log.WithField("PID", cmd.Process.Pid).Warn("still waiting for child process to exit 5s after SIGTERM")
437                                 }
438                         }
439                 }
440         }()
441
442         err := cmd.Run()
443         if err != nil && ctx.Err() == nil {
444                 // Only report errors that happen before the context ends.
445                 return fmt.Errorf("%s: error: %v", cmdline, err)
446         }
447         return nil
448 }
449
450 func (boot *Booter) autofillConfig(cfg *arvados.Config, log logrus.FieldLogger) error {
451         cluster, err := cfg.GetCluster("")
452         if err != nil {
453                 return err
454         }
455         usedPort := map[string]bool{}
456         nextPort := func() string {
457                 for {
458                         port, err := availablePort(":0")
459                         if err != nil {
460                                 panic(err)
461                         }
462                         if usedPort[port] {
463                                 continue
464                         }
465                         usedPort[port] = true
466                         return port
467                 }
468         }
469         if cluster.Services.Controller.ExternalURL.Host == "" {
470                 h, p, err := net.SplitHostPort(boot.ControllerAddr)
471                 if err != nil {
472                         return err
473                 }
474                 if h == "" {
475                         h = boot.ListenHost
476                 }
477                 if p == "0" {
478                         p, err = availablePort(":0")
479                         if err != nil {
480                                 return err
481                         }
482                         usedPort[p] = true
483                 }
484                 cluster.Services.Controller.ExternalURL = arvados.URL{Scheme: "https", Host: net.JoinHostPort(h, p)}
485         }
486         for _, svc := range []*arvados.Service{
487                 &cluster.Services.Controller,
488                 &cluster.Services.DispatchCloud,
489                 &cluster.Services.GitHTTP,
490                 &cluster.Services.Health,
491                 &cluster.Services.Keepproxy,
492                 &cluster.Services.Keepstore,
493                 &cluster.Services.RailsAPI,
494                 &cluster.Services.WebDAV,
495                 &cluster.Services.WebDAVDownload,
496                 &cluster.Services.Websocket,
497                 &cluster.Services.Workbench1,
498         } {
499                 if svc == &cluster.Services.DispatchCloud && boot.ClusterType == "test" {
500                         continue
501                 }
502                 if svc.ExternalURL.Host == "" && (svc == &cluster.Services.Controller ||
503                         svc == &cluster.Services.GitHTTP ||
504                         svc == &cluster.Services.Keepproxy ||
505                         svc == &cluster.Services.WebDAV ||
506                         svc == &cluster.Services.WebDAVDownload ||
507                         svc == &cluster.Services.Websocket ||
508                         svc == &cluster.Services.Workbench1) {
509                         svc.ExternalURL = arvados.URL{Scheme: "https", Host: fmt.Sprintf("%s:%s", boot.ListenHost, nextPort())}
510                 }
511                 if len(svc.InternalURLs) == 0 {
512                         svc.InternalURLs = map[arvados.URL]arvados.ServiceInstance{
513                                 arvados.URL{Scheme: "http", Host: fmt.Sprintf("%s:%s", boot.ListenHost, nextPort())}: arvados.ServiceInstance{},
514                         }
515                 }
516         }
517         if cluster.SystemRootToken == "" {
518                 cluster.SystemRootToken = randomHexString(64)
519         }
520         if cluster.ManagementToken == "" {
521                 cluster.ManagementToken = randomHexString(64)
522         }
523         if cluster.API.RailsSessionSecretToken == "" {
524                 cluster.API.RailsSessionSecretToken = randomHexString(64)
525         }
526         if cluster.Collections.BlobSigningKey == "" {
527                 cluster.Collections.BlobSigningKey = randomHexString(64)
528         }
529         if boot.ClusterType != "production" && cluster.Containers.DispatchPrivateKey == "" {
530                 buf, err := ioutil.ReadFile(filepath.Join(boot.SourcePath, "lib", "dispatchcloud", "test", "sshkey_dispatch"))
531                 if err != nil {
532                         return err
533                 }
534                 cluster.Containers.DispatchPrivateKey = string(buf)
535         }
536         if boot.ClusterType != "production" {
537                 cluster.TLS.Insecure = true
538         }
539         if boot.ClusterType == "test" {
540                 // Add a second keepstore process.
541                 cluster.Services.Keepstore.InternalURLs[arvados.URL{Scheme: "http", Host: fmt.Sprintf("%s:%s", boot.ListenHost, nextPort())}] = arvados.ServiceInstance{}
542
543                 // Create a directory-backed volume for each keepstore
544                 // process.
545                 cluster.Volumes = map[string]arvados.Volume{}
546                 for url := range cluster.Services.Keepstore.InternalURLs {
547                         volnum := len(cluster.Volumes)
548                         datadir := fmt.Sprintf("%s/keep%d.data", boot.tempdir, volnum)
549                         if _, err = os.Stat(datadir + "/."); err == nil {
550                         } else if !os.IsNotExist(err) {
551                                 return err
552                         } else if err = os.Mkdir(datadir, 0777); err != nil {
553                                 return err
554                         }
555                         cluster.Volumes[fmt.Sprintf(cluster.ClusterID+"-nyw5e-%015d", volnum)] = arvados.Volume{
556                                 Driver:           "Directory",
557                                 DriverParameters: json.RawMessage(fmt.Sprintf(`{"Root":%q}`, datadir)),
558                                 AccessViaHosts: map[arvados.URL]arvados.VolumeAccess{
559                                         url: {},
560                                 },
561                         }
562                 }
563         }
564         if boot.OwnTemporaryDatabase {
565                 cluster.PostgreSQL.Connection = arvados.PostgreSQLConnection{
566                         "client_encoding": "utf8",
567                         "host":            "localhost",
568                         "port":            nextPort(),
569                         "dbname":          "arvados_test",
570                         "user":            "arvados",
571                         "password":        "insecure_arvados_test",
572                 }
573         }
574
575         cfg.Clusters[cluster.ClusterID] = *cluster
576         return nil
577 }
578
579 func randomHexString(chars int) string {
580         b := make([]byte, chars/2)
581         _, err := rand.Read(b)
582         if err != nil {
583                 panic(err)
584         }
585         return fmt.Sprintf("%x", b)
586 }
587
588 func internalPort(svc arvados.Service) (string, error) {
589         for u := range svc.InternalURLs {
590                 if _, p, err := net.SplitHostPort(u.Host); err != nil {
591                         return "", err
592                 } else if p != "" {
593                         return p, nil
594                 } else if u.Scheme == "https" {
595                         return "443", nil
596                 } else {
597                         return "80", nil
598                 }
599         }
600         return "", fmt.Errorf("service has no InternalURLs")
601 }
602
603 func externalPort(svc arvados.Service) (string, error) {
604         if _, p, err := net.SplitHostPort(svc.ExternalURL.Host); err != nil {
605                 return "", err
606         } else if p != "" {
607                 return p, nil
608         } else if svc.ExternalURL.Scheme == "https" {
609                 return "443", nil
610         } else {
611                 return "80", nil
612         }
613 }
614
615 func availablePort(addr string) (string, error) {
616         ln, err := net.Listen("tcp", addr)
617         if err != nil {
618                 return "", err
619         }
620         defer ln.Close()
621         _, port, err := net.SplitHostPort(ln.Addr().String())
622         if err != nil {
623                 return "", err
624         }
625         return port, nil
626 }
627
628 // Try to connect to addr until it works, then close ch. Give up if
629 // ctx cancels.
630 func waitForConnect(ctx context.Context, addr string) error {
631         dialer := net.Dialer{Timeout: time.Second}
632         for ctx.Err() == nil {
633                 conn, err := dialer.DialContext(ctx, "tcp", addr)
634                 if err != nil {
635                         time.Sleep(time.Second / 10)
636                         continue
637                 }
638                 conn.Close()
639                 return nil
640         }
641         return ctx.Err()
642 }