1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
26 "git.arvados.org/arvados.git/lib/cmd"
27 "git.arvados.org/arvados.git/lib/config"
28 "git.arvados.org/arvados.git/lib/controller"
29 "git.arvados.org/arvados.git/lib/dispatchcloud"
30 "git.arvados.org/arvados.git/sdk/go/arvados"
31 "git.arvados.org/arvados.git/sdk/go/ctxlog"
32 "github.com/sirupsen/logrus"
35 var Command cmd.Handler = &bootCommand{}
37 type bootCommand struct {
38 sourcePath string // e.g., /home/username/src/arvados
39 libPath string // e.g., /var/lib/arvados
40 clusterType string // e.g., production
42 cluster *arvados.Cluster
48 setupRubyOnce sync.Once
53 func (boot *bootCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
56 log := ctxlog.New(stderr, "json", "info")
61 log.WithError(err).Info("exiting")
65 flags := flag.NewFlagSet(prog, flag.ContinueOnError)
66 flags.SetOutput(stderr)
67 loader := config.NewLoader(stdin, log)
68 loader.SetupFlags(flags)
69 versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
70 flags.StringVar(&boot.sourcePath, "source", ".", "arvados source tree `directory`")
71 flags.StringVar(&boot.libPath, "lib", "/var/lib/arvados", "`directory` to install dependencies and library files")
72 flags.StringVar(&boot.clusterType, "type", "production", "cluster `type`: development, test, or production")
73 err = flags.Parse(args)
74 if err == flag.ErrHelp {
77 } else if err != nil {
79 } else if *versionFlag {
80 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
81 } else if boot.clusterType != "development" && boot.clusterType != "test" && boot.clusterType != "production" {
82 err = fmt.Errorf("cluster type must be 'development', 'test', or 'production'")
86 cwd, err := os.Getwd()
90 if !strings.HasPrefix(boot.sourcePath, "/") {
91 boot.sourcePath = filepath.Join(cwd, boot.sourcePath)
93 boot.sourcePath, err = filepath.EvalSymlinks(boot.sourcePath)
98 loader.SkipAPICalls = true
99 cfg, err := loader.Load()
104 boot.tempdir, err = ioutil.TempDir("", "arvados-server-boot-")
108 defer os.RemoveAll(boot.tempdir)
110 // Fill in any missing config keys, and write the resulting
111 // config in the temp dir for child services to use.
112 err = boot.autofillConfig(cfg, log)
116 conffile, err := os.OpenFile(filepath.Join(boot.tempdir, "config.yml"), os.O_CREATE|os.O_WRONLY, 0777)
120 defer conffile.Close()
121 err = json.NewEncoder(conffile).Encode(cfg)
125 err = conffile.Close()
129 os.Setenv("ARVADOS_CONFIG", conffile.Name())
130 arvados.DefaultConfigFile = conffile.Name()
131 os.Setenv("RAILS_ENV", boot.clusterType)
133 // Now that we have the config, replace the bootstrap logger
134 // with a new one according to the logging config.
135 boot.cluster, err = cfg.GetCluster("")
139 log = ctxlog.New(stderr, boot.cluster.SystemLogs.Format, boot.cluster.SystemLogs.LogLevel)
140 logger := log.WithFields(logrus.Fields{
143 ctx := ctxlog.Context(context.Background(), logger)
144 ctx, cancel := context.WithCancel(ctx)
147 ch := make(chan os.Signal)
148 signal.Notify(ch, syscall.SIGINT)
150 for sig := range ch {
151 logger.WithField("signal", sig).Info("caught signal")
156 for _, dir := range []string{boot.libPath, filepath.Join(boot.libPath, "bin")} {
157 if _, err = os.Stat(filepath.Join(dir, ".")); os.IsNotExist(err) {
158 err = os.Mkdir(dir, 0755)
162 } else if err != nil {
166 os.Setenv("PATH", filepath.Join(boot.libPath, "bin")+":"+os.Getenv("PATH"))
168 err = boot.installGoProgram(ctx, "cmd/arvados-server")
173 var wg sync.WaitGroup
174 for _, cmpt := range []component{
175 {name: "nginx", runFunc: runNginx},
176 {name: "controller", cmdHandler: controller.Command},
177 {name: "dispatchcloud", cmdHandler: dispatchcloud.Command, notIfTest: true},
178 {name: "git-httpd", goProg: "services/arv-git-httpd"},
179 {name: "health", goProg: "services/health"},
180 {name: "keep-balance", goProg: "services/keep-balance", notIfTest: true},
181 {name: "keepproxy", goProg: "services/keepproxy"},
182 {name: "keep-web", goProg: "services/keep-web"},
183 {name: "railsAPI", svc: boot.cluster.Services.RailsAPI, railsApp: "services/api"},
190 logger.WithField("component", cmpt.name).Info("starting")
191 err := cmpt.Run(ctx, boot, stdout, stderr)
193 logger.WithError(err).WithField("component", cmpt.name).Info("exited")
202 func (boot *bootCommand) installGoProgram(ctx context.Context, srcpath string) error {
204 defer boot.goMutex.Unlock()
205 env := append([]string{"GOPATH=" + boot.libPath}, os.Environ()...)
206 return boot.RunProgram(ctx, filepath.Join(boot.sourcePath, srcpath), nil, env, "go", "install")
209 func (boot *bootCommand) setupRubyEnv() error {
210 boot.setupRubyOnce.Do(func() {
211 buf, err := exec.Command("gem", "env", "gempath").Output() // /var/lib/arvados/.gem/ruby/2.5.0/bin:...
212 if err != nil || len(buf) == 0 {
213 boot.setupRubyErr = fmt.Errorf("gem env gempath: %v", err)
215 gempath := string(bytes.Split(buf, []byte{':'})[0])
216 os.Setenv("PATH", gempath+"/bin:"+os.Getenv("PATH"))
217 os.Setenv("GEM_HOME", gempath)
218 os.Setenv("GEM_PATH", gempath)
220 return boot.setupRubyErr
223 func (boot *bootCommand) RunProgram(ctx context.Context, dir string, output io.Writer, env []string, prog string, args ...string) error {
224 cmdline := fmt.Sprintf("%s", append([]string{prog}, args...))
225 fmt.Fprintf(boot.stderr, "%s executing in %s\n", cmdline, dir)
226 cmd := exec.Command(prog, args...)
228 cmd.Stdout = boot.stderr
232 cmd.Stderr = boot.stderr
233 if strings.HasPrefix(dir, "/") {
236 cmd.Dir = filepath.Join(boot.sourcePath, dir)
243 log := ctxlog.FromContext(ctx).WithFields(logrus.Fields{"dir": dir, "cmdline": cmdline})
244 for cmd.ProcessState == nil {
245 if cmd.Process == nil {
246 log.Infof("waiting for child process to start")
247 time.Sleep(time.Second)
249 cmd.Process.Signal(syscall.SIGTERM)
250 log.WithField("PID", cmd.Process.Pid).Infof("waiting for child process to exit after SIGTERM")
251 time.Sleep(5 * time.Second)
257 return fmt.Errorf("%s: error: %v", cmdline, err)
262 type component struct {
265 cmdHandler cmd.Handler
266 runFunc func(ctx context.Context, boot *bootCommand, stdout, stderr io.Writer) error
267 railsApp string // source dir in arvados tree, e.g., "services/api"
268 goProg string // source dir in arvados tree, e.g., "services/keepstore"
269 notIfTest bool // don't run this component on a test cluster
272 func (cmpt *component) Run(ctx context.Context, boot *bootCommand, stdout, stderr io.Writer) error {
273 if cmpt.notIfTest && boot.clusterType == "test" {
274 fmt.Fprintf(stderr, "skipping component %q in %s mode\n", cmpt.name, boot.clusterType)
278 fmt.Fprintf(stderr, "starting component %q\n", cmpt.name)
279 if cmpt.cmdHandler != nil {
280 errs := make(chan error, 1)
283 exitcode := cmpt.cmdHandler.RunCommand(cmpt.name, nil, bytes.NewBuffer(nil), stdout, stderr)
285 errs <- fmt.Errorf("exit code %d", exitcode)
292 // cmpt.cmdHandler.RunCommand() doesn't have
293 // access to our context, so it won't shut
294 // down by itself. We just abandon it.
298 if cmpt.goProg != "" {
299 return boot.RunProgram(ctx, cmpt.goProg, nil, nil, "go", "run", ".")
301 if cmpt.runFunc != nil {
302 return cmpt.runFunc(ctx, boot, stdout, stderr)
304 if cmpt.railsApp != "" {
305 port, err := internalPort(cmpt.svc)
307 return fmt.Errorf("bug: no InternalURLs for component %q: %v", cmpt.name, cmpt.svc.InternalURLs)
309 err = boot.setupRubyEnv()
314 err = boot.RunProgram(ctx, cmpt.railsApp, &buf, nil, "gem", "list", "--details", "bundler")
318 for _, version := range []string{"1.11.0", "1.17.3", "2.0.2"} {
319 if !strings.Contains(buf.String(), "("+version+")") {
320 err = boot.RunProgram(ctx, cmpt.railsApp, nil, nil, "gem", "install", "--user", "bundler:1.11", "bundler:1.17.3", "bundler:2.0.2")
327 err = boot.RunProgram(ctx, cmpt.railsApp, nil, nil, "bundle", "install", "--jobs", "4", "--path", filepath.Join(os.Getenv("HOME"), ".gem"))
331 err = boot.RunProgram(ctx, cmpt.railsApp, nil, nil, "bundle", "exec", "passenger-config", "build-native-support")
335 err = boot.RunProgram(ctx, cmpt.railsApp, nil, nil, "bundle", "exec", "passenger-config", "install-standalone-runtime")
339 err = boot.RunProgram(ctx, cmpt.railsApp, nil, nil, "bundle", "exec", "passenger-config", "validate-install")
343 err = boot.RunProgram(ctx, cmpt.railsApp, nil, nil, "bundle", "exec", "passenger", "start", "-p", port)
348 return fmt.Errorf("bug: component %q has nothing to run", cmpt.name)
351 func (boot *bootCommand) autofillConfig(cfg *arvados.Config, log logrus.FieldLogger) error {
352 cluster, err := cfg.GetCluster("")
357 for _, svc := range []*arvados.Service{
358 &cluster.Services.Controller,
359 &cluster.Services.DispatchCloud,
360 &cluster.Services.GitHTTP,
361 &cluster.Services.Health,
362 &cluster.Services.Keepproxy,
363 &cluster.Services.Keepstore,
364 &cluster.Services.RailsAPI,
365 &cluster.Services.WebDAV,
366 &cluster.Services.WebDAVDownload,
367 &cluster.Services.Websocket,
369 if len(svc.InternalURLs) == 0 {
371 svc.InternalURLs = map[arvados.URL]arvados.ServiceInstance{
372 arvados.URL{Scheme: "http", Host: fmt.Sprintf("localhost:%d", port)}: arvados.ServiceInstance{},
375 if svc.ExternalURL.Host == "" && (svc == &cluster.Services.Controller ||
376 svc == &cluster.Services.GitHTTP ||
377 svc == &cluster.Services.Keepproxy ||
378 svc == &cluster.Services.WebDAV ||
379 svc == &cluster.Services.WebDAVDownload ||
380 svc == &cluster.Services.Websocket) {
382 svc.ExternalURL = arvados.URL{Scheme: "https", Host: fmt.Sprintf("localhost:%d", port)}
385 if cluster.SystemRootToken == "" {
386 cluster.SystemRootToken = randomHexString(64)
388 if cluster.ManagementToken == "" {
389 cluster.ManagementToken = randomHexString(64)
391 if cluster.API.RailsSessionSecretToken == "" {
392 cluster.API.RailsSessionSecretToken = randomHexString(64)
394 if cluster.Collections.BlobSigningKey == "" {
395 cluster.Collections.BlobSigningKey = randomHexString(64)
397 if boot.clusterType != "production" && cluster.Containers.DispatchPrivateKey == "" {
398 buf, err := ioutil.ReadFile(filepath.Join(boot.sourcePath, "lib", "dispatchcloud", "test", "sshkey_dispatch"))
402 cluster.Containers.DispatchPrivateKey = string(buf)
404 if boot.clusterType != "production" {
405 cluster.TLS.Insecure = true
407 if boot.clusterType == "test" && len(cluster.Volumes) == 0 {
408 cluster.Volumes = map[string]arvados.Volume{
409 "zzzzz-nyw5e-000000000000000": arvados.Volume{
411 DriverParameters: json.RawMessage(fmt.Sprintf(`{"Root":%q}`, boot.tempdir+"/keep0")),
415 cfg.Clusters[cluster.ClusterID] = *cluster
419 func randomHexString(chars int) string {
420 b := make([]byte, chars/2)
421 _, err := rand.Read(b)
425 return fmt.Sprintf("%x", b)
428 func internalPort(svc arvados.Service) (string, error) {
429 for u := range svc.InternalURLs {
430 if _, p, err := net.SplitHostPort(u.Host); err != nil {
434 } else if u.Scheme == "https" {
440 return "", fmt.Errorf("service has no InternalURLs")
443 func externalPort(svc arvados.Service) (string, error) {
444 if _, p, err := net.SplitHostPort(svc.ExternalURL.Host); err != nil {
448 } else if svc.ExternalURL.Scheme == "https" {